Merge pull request #162 from JakeGinnivan/FluentCustomStepTitles

Allowed custom step title via attribute on Fluent

Author: JakeGinnivan

TestStack.BDDfy.Tests/Scanner/FluentScanner/StepTitleTests.cs

@@ -16,10 +16,18 @@ public void MethodCallInStepTitle()
             var story = this
                 .Given(_ => GivenWeMutateSomeState())
                 .When(_ => something.Sub.SomethingHappens())
+                .And(_ => something.Sub.SomethingWithDifferentTitle())
                 .Then(_ => ThenTitleHas(AMethodCall()))
+                .And(_ => something.Sub.SomethingWithArg("foo"))
+                .And(_ => something.Sub.SomethingWithArg2("foo"))
+                .And(_ => something.Sub.SomethingWithArg3("foo"))
                 .BDDfy();
 
-            story.Scenarios.Single().Steps.ElementAt(2).Title.ShouldBe("Then title has Mutated state");
+            story.Scenarios.Single().Steps.ElementAt(2).Title.ShouldBe("And different title");
+            story.Scenarios.Single().Steps.ElementAt(3).Title.ShouldBe("Then title has Mutated state");
+            story.Scenarios.Single().Steps.ElementAt(4).Title.ShouldBe("And with arg foo");
+            story.Scenarios.Single().Steps.ElementAt(5).Title.ShouldBe("And with arg");
+            story.Scenarios.Single().Steps.ElementAt(6).Title.ShouldBe("And with foo arg");
         }
 
         public class FooClass
@@ -38,6 +46,26 @@ public void SomethingHappens()
             {
 
             }
+
+            [StepTitle("Different title")]
+            public void SomethingWithDifferentTitle()
+            {
+            }
+
+            [StepTitle("With arg")]
+            public void SomethingWithArg(string arg)
+            {
+            }
+
+            [StepTitle("With arg", false)]
+            public void SomethingWithArg2(string arg)
+            {
+            }
+
+            [StepTitle("With {0} arg", false)]
+            public void SomethingWithArg3(string arg)
+            {
+            }
         }
 
         private string AMethodCall()

TestStack.BDDfy/Scanners/StepScanners/Fluent/FluentScanner.cs

@@ -151,7 +151,17 @@ private StepTitle CreateTitle(string stepTextTemplate, bool includeInputsInStepT
                 {
 
                     var flatInputArray = inputArguments.Select(o => o.Value).FlattenArrays();
-                    var stepTitle = AppendPrefix(Configurator.Scanners.Humanize(methodInfo.Name), stepPrefix);
+                    var name = methodInfo.Name;
+                    var stepTitleAttribute = methodInfo.GetCustomAttributes(typeof(StepTitleAttribute), true).SingleOrDefault();
+                    if (stepTitleAttribute != null)
+                    {
+                        var titleAttribute = ((StepTitleAttribute)stepTitleAttribute);
+                        name = string.Format(titleAttribute.StepTitle, flatInputArray);
+                        if (titleAttribute.IncludeInputsInStepTitle != null)
+                            includeInputsInStepTitle = titleAttribute.IncludeInputsInStepTitle.Value;
+                    }
+
+                    var stepTitle = AppendPrefix(Configurator.Scanners.Humanize(name), stepPrefix);
 
                     if (!string.IsNullOrEmpty(stepTextTemplate)) stepTitle = string.Format(stepTextTemplate, flatInputArray);
                     else if (includeInputsInStepTitle)

TestStack.BDDfy/StepTitleAttribute.cs

@@ -0,0 +1,23 @@
+using System;
+
+namespace TestStack.BDDfy
+{
+    [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
+    public class StepTitleAttribute : Attribute
+    {
+        public StepTitleAttribute(string stepTitle)
+        {
+            StepTitle = stepTitle;
+        }
+        
+        public StepTitleAttribute(string stepTitle, bool includeInputsInStepTitle)
+        {
+            IncludeInputsInStepTitle = includeInputsInStepTitle;
+            StepTitle = stepTitle;
+        }
+
+        public string StepTitle { get; private set; }
+
+        public bool? IncludeInputsInStepTitle { get; private set; }
+    }
+}

TestStack.BDDfy/TestStack.BDDfy.csproj

@@ -130,6 +130,7 @@
     <Compile Include="Scenario.cs" />
     <Compile Include="Engine.cs" />
     <Compile Include="StepTitle.cs" />
+    <Compile Include="StepTitleAttribute.cs" />
     <Compile Include="Story.cs" />
     <Compile Include="StoryAttribute.cs" />
     <Compile Include="Scanners\StoryMetadata.cs" />