Change "assembly version to be used" to also respect AssemblyInformat…

…ionalVersionAttribute fixes #99
Fody · Nov 12, 2019 · 24a8755 · 24a8755
1 parent deb74f5
commit 24a8755
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 23 deletions.
diff --git a/AssemblyToProcess/AssemblyToProcess.csproj b/AssemblyToProcess/AssemblyToProcess.csproj
@@ -3,7 +3,8 @@
   <PropertyGroup>
     <TargetFrameworks>net452;netcoreapp2.0</TargetFrameworks>
     <DisableFody>true</DisableFody>
-    <Version>1.0.0</Version>
+    <Version>1.0.1-x</Version>
+    <AssemblyVersion>1.0</AssemblyVersion>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\Obsolete\Obsolete.csproj" />

diff --git a/AssemblyToProcess/ClassWithIsErrorFromInformationalVersion.cs b/AssemblyToProcess/ClassWithIsErrorFromInformationalVersion.cs
@@ -0,0 +1,6 @@
+[ObsoleteEx(
+    TreatAsErrorFromVersion = "1.0.1",
+    RemoveInVersion = "1.1")]
+public class ClassWithIsErrorFromInformationalVersion
+{
+}
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -2,7 +2,7 @@
 <Project>
   <PropertyGroup>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>5.1.0</Version>
+    <Version>5.2.0</Version>
     <LangVersion>latest</LangVersion>
     <NoWarn>NU5118</NoWarn>
   </PropertyGroup>

diff --git a/Obsolete.Fody/ModuleWeaver.cs b/Obsolete.Fody/ModuleWeaver.cs
@@ -11,13 +11,7 @@ public override void Execute()
         FindEditorBrowsableTypes();
         FindObsoleteType();
 
-        var version = ModuleDefinition.Assembly.Name.Version;
-        assemblyVersion = new SemanticVersion
-        {
-            Major = version.Major.OrZero(),
-            Minor = version.Minor.OrZero(),
-            Patch = version.Build.OrZero()
-        };
+        assemblyVersion = VersionReader.Read(ModuleDefinition.Assembly);
 
         ProcessAssembly();
     }

diff --git a/Obsolete.Fody/VersionReader.cs b/Obsolete.Fody/VersionReader.cs
@@ -0,0 +1,48 @@
+using System;
+using System.Linq;
+using Mono.Cecil;
+
+static class VersionReader
+{
+    public static SemanticVersion Read(AssemblyDefinition assembly)
+    {
+        var informationalAttribute = assembly.CustomAttributes
+            .SingleOrDefault(x => x.AttributeType.FullName == "System.Reflection.AssemblyInformationalVersionAttribute");
+        if (informationalAttribute != null)
+        {
+            var value = (string)informationalAttribute.ConstructorArguments.Single().Value;
+            var indexOf = value.IndexOf(x => x != '.' && !char.IsNumber(x));
+            if (indexOf != -1)
+            {
+                var substring = value.Substring(0, indexOf);
+                if (SemanticVersion.TryParse(substring, out var versionFromInformational))
+                {
+                    return versionFromInformational;
+                }
+            }
+        }
+
+        var version = assembly.Name.Version;
+        var semanticVersion = new SemanticVersion
+        {
+            Major = version.Major.OrZero(),
+            Minor = version.Minor.OrZero(),
+            Patch = version.Build.OrZero()
+        };
+        return semanticVersion;
+    }
+
+    static int IndexOf(this string source, Func<char, bool> predicate)
+    {
+        for (var index = 0; index < source.Length; index++)
+        {
+            var item = source[index];
+            if (predicate.Invoke(item))
+            {
+                return index;
+            }
+        }
+
+        return -1;
+    }
+}
diff --git a/Tests/IntegrationTests.cs b/Tests/IntegrationTests.cs
@@ -116,6 +116,13 @@ public void ClassWithIsError()
         ValidateIsError(type);
     }
 
+    [Fact]
+    public void ClassWithIsErrorFromInformationalVersion()
+    {
+        var type = assembly.GetType("ClassWithIsErrorFromInformationalVersion");
+        ValidateIsError(type);
+    }
+
     [Fact]
     public void Enum()
     {

diff --git a/readme.md b/readme.md
@@ -40,10 +40,10 @@ Add `<Obsolete/>` to [FodyWeavers.xml](https://github.com/Fody/Home/blob/master/
 
 ```csharp
 [ObsoleteEx(
-            Message = "Custom message.", 
-            TreatAsErrorFromVersion = "2.0", 
-            RemoveInVersion = "4.0", 
-            ReplacementTypeOrMember = "NewClass")]
+    Message = "Custom message.", 
+    TreatAsErrorFromVersion = "2.0", 
+    RemoveInVersion = "4.0", 
+    ReplacementTypeOrMember = "NewClass")]
 public class ClassToMark {}
 ```
 
@@ -93,7 +93,12 @@ So given the above example when the assembly version is 5.0 a compile error will
 > Cannot process 'ClassToMark'. The assembly version 5.0.0 is higher than version specified in RemoveInVersion 4.0.0. The member should be removed or RemoveInVersion increased.
 
 
-## The Message property 
+## Version convention
+
+By default the prefix of [AssemblyInformationalVersionAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.reflection.assemblyinformationalversionattribute) will be used, if it can be parsed to a version. Otherwise the [assembly version](https://docs.microsoft.com/en-us/dotnet/standard/assembly/versioning) is used.
+
+
+## The Message property
 
 The message property should only be used for useful information. The fact that it is obsoleted does not need to be reiterated in the message.
 
@@ -105,12 +110,12 @@ The message property should only be used for useful information. The fact that i
  * "The replacement method is"
 
 
-# Configuration Options
+## Configuration Options
 
 All configuration options are access by modifying the `Obsolete` node in `FodyWeavers.xml`
 
 
-## HideObsoleteMembers
+### HideObsoleteMembers
 
 When this is `true` obsolete members will also have `[EditorBrowsable(EditorBrowsableState.Advanced)]` added to them.
 
@@ -121,7 +126,7 @@ When this is `true` obsolete members will also have `[EditorBrowsable(EditorBrow
 ```
 
 
-## TreatAsErrorFormat
+### TreatAsErrorFormat
 
 The string used when informing the user what version the member will be treated as an error.
 
@@ -132,7 +137,7 @@ The string used when informing the user what version the member will be treated
 ```
 
 
-## ThrowsNotImplementedText
+### ThrowsNotImplementedText
 
 The string used when informing the user when the member currently throws a [NotImplementedException](https://msdn.microsoft.com/en-us/library/system.notimplementedexception.aspx).
 
@@ -143,7 +148,7 @@ The string used when informing the user when the member currently throws a [NotI
 ```
 
 
-## RemoveInVersionFormat
+### RemoveInVersionFormat
 
 The string used when informing the user what version the member will be removed it.
 
@@ -154,7 +159,7 @@ The string used when informing the user what version the member will be removed
 ```
 
 
-## ReplacementFormat
+### ReplacementFormat
 
 The string used when informing the user of an alternative member to use instead of the obsolete member.
 
@@ -165,12 +170,12 @@ The string used when informing the user of an alternative member to use instead
 ```
 
 
-## StepType
+### StepType
 
 Used in two cases
 
  * To derive `TreatAsErrorFromVersion` if `RemoveInVersion` is not defined.
- * To derive `RemoveInVersion` if `TreatAsErrorFromVersion` is not defined.   
+ * To derive `RemoveInVersion` if `TreatAsErrorFromVersion` is not defined.
 
 *Defaults to  `Major`. Other options are `Minor` and `Patch`*
 
@@ -179,7 +184,7 @@ Used in two cases
 ```
 
 
-## Mute warnings about Obsolete usage
+### Mute warnings about Obsolete usage
 
 For `ObsoleteAttribute` is used and should not be replaced, use `DoNotWarnAboutObsoleteUsageAttribute` to mute Fody warnings during build time.