Merge pull request #106 from mwhelan/master

MehdiK · MehdiK · commit bd45374d31dd · 2014-04-11T02:44:25.000+04:30
Made story title prefix customisable.
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/Html/HtmlReportBuilderTests.cs b/TestStack.BDDfy.Tests/Reporters/Html/HtmlReportBuilderTests.cs
@@ -1,8 +1,5 @@
 using System;
-using System.IO;
-using System.Reflection;
 using System.Runtime.CompilerServices;
-using System.Text.RegularExpressions;
 using ApprovalTests;
 using ApprovalTests.Reporters;
 using NUnit.Framework;
@@ -29,8 +26,9 @@ public void ShouldProduceExpectedHtml()
                 var model = new HtmlReportViewModel(
                     new DefaultHtmlReportConfiguration(),
                     new ReportTestData().CreateTwoStoriesEachWithTwoScenariosWithThreeStepsOfFiveMilliseconds());
+                model.RunDate = new DateTime(2014, 3, 25, 11, 30, 5);
 
-                var sut = new HtmlReportBuilder {DateProvider = () => new DateTime(2014, 3, 25, 11, 30, 5)};
+                var sut = new HtmlReportBuilder();
                 var result = sut.CreateReport(model);
                 Approvals.Verify(result);
             }
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/Reporters/HtmlMetro/HtmlMetroReportBuilderTests.cs b/TestStack.BDDfy.Tests/Reporters/HtmlMetro/HtmlMetroReportBuilderTests.cs
@@ -28,8 +28,9 @@ public void ShouldProduceExpectedHtml()
                 var model = new HtmlReportViewModel(
                     new DefaultHtmlReportConfiguration(),
                     new ReportTestData().CreateMixContainingEachTypeOfOutcome());
+                model.RunDate = new DateTime(2014, 3, 25, 11, 30, 5);
 
-                var sut = new HtmlMetroReportBuilder {DateProvider = () => new DateTime(2014, 3, 25, 11, 30, 5)};
+                var sut = new HtmlMetroReportBuilder();
                 var result = sut.CreateReport(model);
                 Approvals.Verify(result);
             }
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/FileReportModel.cs b/TestStack.BDDfy/Reporters/FileReportModel.cs
@@ -1,4 +1,5 @@
-﻿using System.Collections.Generic;
+﻿using System;
+using System.Collections.Generic;
 using System.Linq;
 
 namespace TestStack.BDDfy.Reporters
@@ -9,10 +10,12 @@ public FileReportModel(IEnumerable<Story> stories)
         {
             _stories = stories;
             Summary = new FileReportSummaryModel(stories);
+            RunDate = DateTime.Now;
         }
 
         readonly IEnumerable<Story> _stories;
         public FileReportSummaryModel Summary { get; private set; }
+        public DateTime RunDate { get; set; }
 
         public IEnumerable<Story> Stories
         {
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
@@ -6,7 +6,6 @@ namespace TestStack.BDDfy.Reporters.Html
 {
     public class HtmlReportBuilder : IReportBuilder
     {
-        private Func<DateTime> _dateProvider = () => DateTime.Now;
         private HtmlReportViewModel _viewModel;
         readonly StringBuilder _html;
         const int TabIndentation = 2;
@@ -43,7 +42,7 @@ private void HtmlHead()
                 EmbedCssFile(HtmlReportResources.BDDfy_css_min);
                 EmbedCssFile(_viewModel.CustomStylesheet, HtmlReportResources.CustomStylesheetComment);
 
-                AddLine(string.Format("<title>BDDfy Test Result {0}</title>", DateProvider().ToShortDateString()));
+                AddLine(string.Format("<title>BDDfy Test Result {0}</title>", _viewModel.RunDate.ToShortDateString()));
             }
         }
 
@@ -129,7 +128,7 @@ private void ResultDetails()
                     }
                 }
 
-                AddLine(string.Format("<p><span>Tested at: {0}</span></p>", _dateProvider()));
+                AddLine(string.Format("<p><span>Tested at: {0}</span></p>", _viewModel.RunDate));
             }
         }
 
@@ -226,7 +225,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))
@@ -296,11 +295,5 @@ private void AddHtmlComment(string htmlComment)
             _html.AppendFormat("/*{0}*/", htmlComment);
             _html.AppendLine();
         }
-
-        public Func<DateTime> DateProvider
-        {
-            get { return _dateProvider; } 
-            set { _dateProvider = value; }
-        }
     }
 }
diff --git a/TestStack.BDDfy/Reporters/HtmlMetro/HtmlMetroReportBuilder.cs b/TestStack.BDDfy/Reporters/HtmlMetro/HtmlMetroReportBuilder.cs
@@ -5,22 +5,14 @@ namespace TestStack.BDDfy.Reporters.HtmlMetro
 {
     public class HtmlMetroReportBuilder : IReportBuilder
     {
-        private Func<DateTime> _dateProvider = () => DateTime.Now;
-
         string IReportBuilder.CreateReport(FileReportModel model)
         {
             return CreateReport(model as HtmlReportViewModel);
         }
 
         public string CreateReport(HtmlReportViewModel model)
         {
-            return new MetroHtmlReportTemplate(model, DateProvider()).TransformText();
+            return new MetroHtmlReportTemplate(model).TransformText();
         }
-
-        public Func<DateTime> DateProvider
-        {
-            get { return _dateProvider; }
-            set { _dateProvider = value; }
-        }     
     }
 }
diff --git a/TestStack.BDDfy/Reporters/HtmlMetro/MetroHtmlReportTemplate.Model.cs b/TestStack.BDDfy/Reporters/HtmlMetro/MetroHtmlReportTemplate.Model.cs
@@ -11,12 +11,10 @@ namespace TestStack.BDDfy.Reporters.HtmlMetro
     partial class MetroHtmlReportTemplate
     {
         private readonly HtmlReportViewModel _model;      
-        public DateTime RunDate { get; set; }
 
-        public MetroHtmlReportTemplate(HtmlReportViewModel model, DateTime runDate)
+        public MetroHtmlReportTemplate(HtmlReportViewModel model)
         {
             _model = model;
-            RunDate = runDate;
         }
 
         public HtmlReportViewModel Model
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
diff --git a/TestStack.BDDfy/Reporters/MarkDown/MarkDownReportBuilder.cs b/TestStack.BDDfy/Reporters/MarkDown/MarkDownReportBuilder.cs
diff --git a/TestStack.BDDfy/Scanners/StoryMetadata.cs b/TestStack.BDDfy/Scanners/StoryMetadata.cs
diff --git a/TestStack.BDDfy/StoryNarrativeAttribute.cs b/TestStack.BDDfy/StoryNarrativeAttribute.cs

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
`@@ -1,4 +1,5 @@`
`1`		`-using System.Collections.Generic;`
	`1`	`+using System;`
	`2`	`+using System.Collections.Generic;`
`2`	`3`	`using System.Linq;`
`3`	`4`
`4`	`5`	`namespace TestStack.BDDfy.Reporters`
`@@ -9,10 +10,12 @@ public FileReportModel(IEnumerable<Story> stories)`
`9`	`10`	`{`
`10`	`11`	`_stories = stories;`
`11`	`12`	`Summary = new FileReportSummaryModel(stories);`
	`13`	`+ RunDate = DateTime.Now;`
`12`	`14`	`}`
`13`	`15`
`14`	`16`	`readonly IEnumerable<Story> _stories;`
`15`	`17`	`public FileReportSummaryModel Summary { get; private set; }`
	`18`	`+ public DateTime RunDate { get; set; }`
`16`	`19`
`17`	`20`	`public IEnumerable<Story> Stories`
`18`	`21`	`{`
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
`@@ -6,7 +6,6 @@ namespace TestStack.BDDfy.Reporters.Html`
`6`	`6`	`{`
`7`	`7`	`public class HtmlReportBuilder : IReportBuilder`
`8`	`8`	`{`
`9`		`- private Func<DateTime> _dateProvider = () => DateTime.Now;`
`10`	`9`	`private HtmlReportViewModel _viewModel;`
`11`	`10`	`readonly StringBuilder _html;`
`12`	`11`	`const int TabIndentation = 2;`
`@@ -43,7 +42,7 @@ private void HtmlHead()`
`43`	`42`	`EmbedCssFile(HtmlReportResources.BDDfy_css_min);`
`44`	`43`	`EmbedCssFile(_viewModel.CustomStylesheet, HtmlReportResources.CustomStylesheetComment);`
`45`	`44`
`46`		`- AddLine(string.Format("<title>BDDfy Test Result {0}</title>", DateProvider().ToShortDateString()));`
	`45`	`+ AddLine(string.Format("<title>BDDfy Test Result {0}</title>", _viewModel.RunDate.ToShortDateString()));`
`47`	`46`	`}`
`48`	`47`	`}`
`49`	`48`
`@@ -129,7 +128,7 @@ private void ResultDetails()`
`129`	`128`	`}`
`130`	`129`	`}`
`131`	`130`
`132`		`- AddLine(string.Format("<p><span>Tested at: {0}</span></p>", _dateProvider()));`
	`131`	`+ AddLine(string.Format("<p><span>Tested at: {0}</span></p>", _viewModel.RunDate));`
`133`	`132`	`}`
`134`	`133`	`}`
`135`	`134`
`@@ -226,7 +225,7 @@ private void AddStoryMetadataAndNarrative(Story story)`
`226`	`225`	`}`
`227`	`226`	`else`
`228`	`227`	`{`
`229`		`- AddLine(string.Format("<div class='storyTitle'>{0}</div>", story.Metadata.Title));`
	`228`	`+ AddLine(string.Format("<div class='storyTitle'>{0}{1}</div>", story.Metadata.TitlePrefix, story.Metadata.Title));`
`230`	`229`	`}`
`231`	`230`
`232`	`231`	`if (story.Metadata != null && !string.IsNullOrEmpty(story.Metadata.Narrative1))`
`@@ -296,11 +295,5 @@ private void AddHtmlComment(string htmlComment)`
`296`	`295`	`_html.AppendFormat("/{0}/", htmlComment);`
`297`	`296`	`_html.AppendLine();`
`298`	`297`	`}`
`299`		`-`
`300`		`- public Func<DateTime> DateProvider`
`301`		`- {`
`302`		`- get { return _dateProvider; }`
`303`		`- set { _dateProvider = value; }`
`304`		`- }`
`305`	`298`	`}`
`306`	`299`	`}`