Made story title prefix customisable.

mwhelan · mwhelan · commit 418483325343 · 2014-04-10T13:23:53.000+01:00
diff --git a/TestStack.BDDfy.Tests/Reporters/Html/HtmlReportBuilderTests.ShouldProduceExpectedHtml.approved.txt b/TestStack.BDDfy.Tests/Reporters/Html/HtmlReportBuilderTests.ShouldProduceExpectedHtml.approved.txt
@@ -70,7 +70,7 @@ body{max-width:100%;background-color:#fff;font-family:Verdana,Arial,Helvetica,sa
           <li>
             <div class='story NotExecuted'>
               <div class='storyMetadata'>
-                <div class='storyTitle'>Account holder withdraws cash</div>
+                <div class='storyTitle'>Story: Account holder withdraws cash</div>
                 <ul class='storyNarrative'>
                   <li>As an account holder</li>
                   <li>I want to withdraw cash</li>
@@ -112,7 +112,7 @@ body{max-width:100%;background-color:#fff;font-family:Verdana,Arial,Helvetica,sa
           <li>
             <div class='story NotExecuted'>
               <div class='storyMetadata'>
-                <div class='storyTitle'>Happiness</div>
+                <div class='storyTitle'>Story: Happiness</div>
                 <ul class='storyNarrative'>
                   <li>As a person</li>
                   <li>I want ice cream</li>
diff --git a/TestStack.BDDfy.Tests/Reporters/HtmlMetro/HtmlMetroReportBuilderTests.ShouldProduceExpectedHtml.approved.txt b/TestStack.BDDfy.Tests/Reporters/HtmlMetro/HtmlMetroReportBuilderTests.ShouldProduceExpectedHtml.approved.txt
@@ -87,7 +87,7 @@
 					<li>
 						<div class='story Failed'>
 							<div class='storyMetaData'>
-								<h3 class='storyTitle'>Account holder withdraws cash</h3>
+								<h3 class='storyTitle'>Story: Account holder withdraws cash</h3>
 								<ul class='storyNarrative'>
 									<li>As an account holder</li>
 									<li>I want to withdraw cash</li>
@@ -157,7 +157,7 @@
 					<li>
 						<div class='story Failed'>
 							<div class='storyMetaData'>
-								<h3 class='storyTitle'>Happiness</h3>
+								<h3 class='storyTitle'>Story: Happiness</h3>
 								<ul class='storyNarrative'>
 									<li>As a person</li>
 									<li>I want ice cream</li>
diff --git a/TestStack.BDDfy.Tests/Stories/StoryClassBase.cs b/TestStack.BDDfy.Tests/Stories/StoryClassBase.cs
@@ -2,12 +2,14 @@ namespace TestStack.BDDfy.Tests.Stories
 {
     [Story(
         Title = StoryTitle,
+        TitlePrefix = StoryTitlePrefix,
         AsA = "As a programmer",
         IWant = "I want BDDfy to inherit StoryAttribute",
         SoThat = "So that I can put some shared logic on a base story class")]
     public abstract class StoryClassBase
     {
         protected const string StoryTitle = "Story base class";
+        protected const string StoryTitlePrefix = "Specifications: ";
 
         protected void GivenTheStoryAttributeIsSetOnTheBaseClass()
         {
diff --git a/TestStack.BDDfy.Tests/Stories/StorySubclass.cs b/TestStack.BDDfy.Tests/Stories/StorySubclass.cs
@@ -12,6 +12,7 @@ public void Verify()
             _story = this.BDDfy();
             Assert.That(_story.Metadata, Is.Not.Null);
             Assert.That(_story.Metadata.Title, Is.EqualTo(StoryTitle));
+            Assert.That(_story.Metadata.TitlePrefix, Is.EqualTo(StoryTitlePrefix));
         }
 
         void WhenTheSubclassIsBddified()
diff --git a/TestStack.BDDfy/Reporters/ConsoleReporter.cs b/TestStack.BDDfy/Reporters/ConsoleReporter.cs
@@ -37,7 +37,7 @@ private static void ReportStoryHeader(Story story)
             if (story.Metadata == null || story.Metadata.Type == null)
                 return;
 
-            Console.WriteLine("Story: " + story.Metadata.Title);
+            Console.WriteLine(story.Metadata.TitlePrefix + story.Metadata.Title);
             if (!string.IsNullOrEmpty(story.Metadata.Narrative1))
                 Console.WriteLine("\t" + story.Metadata.Narrative1);
             if (!string.IsNullOrEmpty(story.Metadata.Narrative2))
diff --git a/TestStack.BDDfy/Reporters/Html/BDDfy.css b/TestStack.BDDfy/Reporters/Html/BDDfy.css
@@ -209,10 +209,6 @@ div.story {
     border-radius: 10px;
 }
 
-.storyTitle:before {
-    content: "Story: ";
-}
-
 .storyTitle {
     display: inline;
 }
diff --git a/TestStack.BDDfy/Reporters/Html/HtmlReportBuilder.cs b/TestStack.BDDfy/Reporters/Html/HtmlReportBuilder.cs
@@ -226,7 +226,7 @@ private void AddStoryMetadataAndNarrative(Story story)
                 }
                 else
                 {
-                    AddLine(string.Format("<div class='storyTitle'>{0}</div>", story.Metadata.Title));
+                    AddLine(string.Format("<div class='storyTitle'>{0}{1}</div>", story.Metadata.TitlePrefix, story.Metadata.Title));
                 }
 
                 if (story.Metadata != null && !string.IsNullOrEmpty(story.Metadata.Narrative1))
diff --git a/TestStack.BDDfy/Reporters/HtmlMetro/MetroHtmlReportTemplate.cs b/TestStack.BDDfy/Reporters/HtmlMetro/MetroHtmlReportTemplate.cs
diff --git a/TestStack.BDDfy/Reporters/HtmlMetro/MetroHtmlReportTemplate.tt b/TestStack.BDDfy/Reporters/HtmlMetro/MetroHtmlReportTemplate.tt
@@ -101,7 +101,7 @@
 <# }
 else
 { #>
-								<h3 class='storyTitle'><#= story.Metadata.Title #></h3>
+								<h3 class='storyTitle'><#= story.Metadata.TitlePrefix + story.Metadata.Title #></h3>
 <# } #>
 <# if (story.Metadata != null && !string.IsNullOrEmpty(story.Metadata.Narrative1))
 { #>
diff --git a/TestStack.BDDfy/Reporters/MarkDown/MarkDownReportBuilder.cs b/TestStack.BDDfy/Reporters/MarkDown/MarkDownReportBuilder.cs
@@ -12,7 +12,7 @@ public string CreateReport(FileReportModel model)
             {
                 if (story.Metadata != null)
                 {
-                    report.AppendLine(string.Format("## Story: {0}", story.Metadata.Title));
+                    report.AppendLine(string.Format("## {0}{1}", story.Metadata.TitlePrefix, story.Metadata.Title));
                     if (!string.IsNullOrEmpty(story.Metadata.Narrative1))
                         report.AppendLine(string.Format(" **{0}**  ", story.Metadata.Narrative1));
                     if (!string.IsNullOrEmpty(story.Metadata.Narrative2))
diff --git a/TestStack.BDDfy/Scanners/StoryMetadata.cs b/TestStack.BDDfy/Scanners/StoryMetadata.cs
@@ -5,13 +5,14 @@ namespace TestStack.BDDfy
     public class StoryMetadata
     {
         public StoryMetadata(Type storyType, StoryNarrativeAttribute narrative)
-            : this(storyType, narrative.Narrative1, narrative.Narrative2, narrative.Narrative3, narrative.Title)
+            : this(storyType, narrative.Narrative1, narrative.Narrative2, narrative.Narrative3, narrative.Title, narrative.TitlePrefix)
         {
         }
 
-        public StoryMetadata(Type storyType, string narrative1, string narrative2, string narrative3, string storyTitle = null)
+        public StoryMetadata(Type storyType, string narrative1, string narrative2, string narrative3, string title = null, string titlePrefix = null)
         {
-            Title = storyTitle ?? NetToString.Convert(storyType.Name);
+            Title = title ?? NetToString.Convert(storyType.Name);
+            TitlePrefix = titlePrefix ?? "Story: ";
             Type = storyType;
 
             Narrative1 = narrative1;
@@ -21,6 +22,7 @@ public StoryMetadata(Type storyType, string narrative1, string narrative2, strin
 
         public Type Type { get; private set; }
         public string Title { get; private set; }
+        public string TitlePrefix { get; private set; }
         public string Narrative1 { get; private set; }
         public string Narrative2 { get; private set; }
         public string Narrative3 { get; private set; }
diff --git a/TestStack.BDDfy/StoryNarrativeAttribute.cs b/TestStack.BDDfy/StoryNarrativeAttribute.cs
@@ -7,6 +7,7 @@ namespace TestStack.BDDfy
     public class StoryNarrativeAttribute : Attribute
     {
         public string Title { get; set; }
+        public string TitlePrefix { get; set; }
         public string Narrative1 { get; set; }
         public string Narrative2 { get; set; }
         public string Narrative3 { get; set; }

Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,14 @@ namespace TestStack.BDDfy.Tests.Stories`
`2`	`2`	`{`
`3`	`3`	`[Story(`
`4`	`4`	`Title = StoryTitle,`
	`5`	`+ TitlePrefix = StoryTitlePrefix,`
`5`	`6`	`AsA = "As a programmer",`
`6`	`7`	`IWant = "I want BDDfy to inherit StoryAttribute",`
`7`	`8`	`SoThat = "So that I can put some shared logic on a base story class")]`
`8`	`9`	`public abstract class StoryClassBase`
`9`	`10`	`{`
`10`	`11`	`protected const string StoryTitle = "Story base class";`
	`12`	`+ protected const string StoryTitlePrefix = "Specifications: ";`
`11`	`13`
`12`	`14`	`protected void GivenTheStoryAttributeIsSetOnTheBaseClass()`
`13`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ public void Verify()`
`12`	`12`	`_story = this.BDDfy();`
`13`	`13`	`Assert.That(_story.Metadata, Is.Not.Null);`
`14`	`14`	`Assert.That(_story.Metadata.Title, Is.EqualTo(StoryTitle));`
	`15`	`+ Assert.That(_story.Metadata.TitlePrefix, Is.EqualTo(StoryTitlePrefix));`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`void WhenTheSubclassIsBddified()`
Original file line number	Diff line number	Diff line change
`@@ -209,10 +209,6 @@ div.story {`
`209`	`209`	`border-radius: 10px;`
`210`	`210`	`}`
`211`	`211`
`212`		`-.storyTitle:before {`
`213`		`- content: "Story: ";`
`214`		`-}`
`215`		`-`
`216`	`212`	`.storyTitle {`
`217`	`213`	`display: inline;`
`218`	`214`	`}`
Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ private void AddStoryMetadataAndNarrative(Story story)`
`226`	`226`	`}`
`227`	`227`	`else`
`228`	`228`	`{`
`229`		`- AddLine(string.Format("<div class='storyTitle'>{0}</div>", story.Metadata.Title));`
	`229`	`+ AddLine(string.Format("<div class='storyTitle'>{0}{1}</div>", story.Metadata.TitlePrefix, story.Metadata.Title));`
`230`	`230`	`}`
`231`	`231`
`232`	`232`	`if (story.Metadata != null && !string.IsNullOrEmpty(story.Metadata.Narrative1))`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public string CreateReport(FileReportModel model)`
`12`	`12`	`{`
`13`	`13`	`if (story.Metadata != null)`
`14`	`14`	`{`
`15`		`- report.AppendLine(string.Format("## Story: {0}", story.Metadata.Title));`
	`15`	`+ report.AppendLine(string.Format("## {0}{1}", story.Metadata.TitlePrefix, story.Metadata.Title));`
`16`	`16`	`if (!string.IsNullOrEmpty(story.Metadata.Narrative1))`
`17`	`17`	`report.AppendLine(string.Format(" {0} ", story.Metadata.Narrative1));`
`18`	`18`	`if (!string.IsNullOrEmpty(story.Metadata.Narrative2))`