Merge pull request #71 from MehdiK/jquery-config-point

mwhelan · mwhelan · commit d0746afac9ce · 2014-03-23T13:04:19.000Z
config point for resolving jquery thru CDN or embedding it
diff --git a/Samples/TestStack.BDDfy.Samples/Atm/AtmHtmlReportConfig.cs b/Samples/TestStack.BDDfy.Samples/Atm/AtmHtmlReportConfig.cs
@@ -1,16 +1,16 @@
-﻿using TestStack.BDDfy.Processors;
+﻿using System;
 using TestStack.BDDfy.Reporters.Html;
 
 namespace TestStack.BDDfy.Samples.Atm
 {
     /// <summary>
     /// This overrides the default html report setting
     /// </summary>
-    public class HtmlReportConfig : DefaultHtmlReportConfiguration
+    public class AtmHtmlReportConfig : DefaultHtmlReportConfiguration
     {
         public override bool RunsOn(Story story)
         {
-            return story.Metadata.Type.Namespace != null && story.Metadata.Type.Namespace.EndsWith("Atm");
+            return story.Namespace.EndsWith("Atm", StringComparison.OrdinalIgnoreCase);
         }
 
         /// <summary>
@@ -45,5 +45,13 @@ public override string ReportDescription
                 return "A reliable solution for your offline banking needs";
             }
         }
+
+        /// <summary>
+        /// For ATM report I want to embed jQuery in the report so people can see it with no internet connectivity
+        /// </summary>
+        public override bool ResolveJqueryFromCdn
+        {
+            get { return false; }
+        }
     }
 }
diff --git a/Samples/TestStack.BDDfy.Samples/BDDfyConfiguration.cs b/Samples/TestStack.BDDfy.Samples/BDDfyConfiguration.cs
@@ -1,6 +1,5 @@
 ﻿using NUnit.Framework;
 using TestStack.BDDfy.Configuration;
-using TestStack.BDDfy.Processors;
 using TestStack.BDDfy.Reporters.Html;
 using TestStack.BDDfy.Samples.Atm;
 
@@ -15,7 +14,7 @@ public void Config()
             Configurator.Processors.Add(() => new CustomTextReporter());
             Configurator.BatchProcessors.MarkDownReport.Enable();
             Configurator.BatchProcessors.DiagnosticsReport.Enable();
-            Configurator.BatchProcessors.Add(new HtmlReporter(new HtmlReportConfig()));
+            Configurator.BatchProcessors.Add(new HtmlReporter(new AtmHtmlReportConfig()));
         }
     }
 }
diff --git a/Samples/TestStack.BDDfy.Samples/TestStack.BDDfy.Samples.csproj b/Samples/TestStack.BDDfy.Samples/TestStack.BDDfy.Samples.csproj
@@ -48,7 +48,7 @@
     <Compile Include="Atm\AccountHasInsufficientFund.cs" />
     <Compile Include="Atm\Atm.cs" />
     <Compile Include="Atm\AccountHolderWithdrawsCash.cs" />
-    <Compile Include="Atm\HtmlReportConfig.cs" />
+    <Compile Include="Atm\AtmHtmlReportConfig.cs" />
     <Compile Include="BDDfyConfiguration.cs" />
     <Compile Include="BDDfy_Rocks.cs" />
     <Compile Include="CanWorkWithoutAStory.cs" />
diff --git a/TestStack.BDDfy/Reporters/Html/DefaultHtmlReportConfiguration.cs b/TestStack.BDDfy/Reporters/Html/DefaultHtmlReportConfiguration.cs
@@ -6,25 +6,39 @@ namespace TestStack.BDDfy.Reporters.Html
 {
     public class DefaultHtmlReportConfiguration : IHtmlReportConfiguration
     {
+        private string _reportHeader = "BDDfy";
         public virtual string ReportHeader
         {
-            get { return "BDDfy"; }
+            get { return _reportHeader; }
+            set { _reportHeader = value; }
         }
 
+        private string _reportDescription = "A simple BDD framework for .Net developers";
         public virtual string ReportDescription
         {
-            get { return "A simple BDD framework for .Net developers"; }
+            get { return _reportDescription; } 
+            set { _reportDescription = value; }
         }
 
+        private string _outputPath = AssemblyDirectory;
         public virtual string OutputPath
         {
-            get { return AssemblyDirectory; }
+            get { return _outputPath; }
+            set { _outputPath = value; }
         }
 
         private string _outputFileName = "BDDfy.html";
         public virtual string OutputFileName
         {
             get { return _outputFileName; }
+            set { _outputFileName = value; }
+        }
+
+        private bool _resolveJqueryFromCdn = true;
+        public virtual bool ResolveJqueryFromCdn
+        {
+            get { return _resolveJqueryFromCdn; }
+            set { _resolveJqueryFromCdn = value; }
         }
 
         public virtual bool RunsOn(Story story)
diff --git a/TestStack.BDDfy/Reporters/Html/HtmlReportBuilder.cs b/TestStack.BDDfy/Reporters/Html/HtmlReportBuilder.cs
@@ -135,8 +135,12 @@ private void ResultDetails()
         private void Footer()
         {
             AddLine("<div class='footer'>Powered by <a href='https://github.com/TestStack/TestStack.BDDfy'>BDDfy</a> framework</div>");
-            
-            AddLine("<script type='text/javascript' src='https://code.jquery.com/jquery-1.11.0.min.js'></script>");
+
+            if (_viewModel.Configuration.ResolveJqueryFromCdn)
+                AddLine("<script type='text/javascript' src='http://code.jquery.com/jquery-2.1.0.min.js'></script>");
+            else
+                EmbedJavascriptFile(HtmlReportResources.jquery_2_1_0_min);
+
             EmbedJavascriptFile(HtmlReportResources.BDDfy_js);
             EmbedJavascriptFile(_viewModel.CustomJavascript, HtmlReportResources.CustomJavascriptComment);
         }
diff --git a/TestStack.BDDfy/Reporters/Html/HtmlReportResources.Designer.cs b/TestStack.BDDfy/Reporters/Html/HtmlReportResources.Designer.cs
diff --git a/TestStack.BDDfy/Reporters/Html/HtmlReportResources.resx b/TestStack.BDDfy/Reporters/Html/HtmlReportResources.resx
@@ -130,4 +130,7 @@
   <data name="CustomStylesheetComment" xml:space="preserve">
     <value>If you drop a custom stylesheet named BDDfyCustom.css in your output folder it gets embedded here. This way you can apply some custom styles over your html report.</value>
   </data>
+  <data name="jquery_2_1_0_min" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>jquery-2.1.0.min.js;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;Windows-1252</value>
+  </data>
 </root>
diff --git a/TestStack.BDDfy/Reporters/Html/IHtmlReportConfiguration.cs b/TestStack.BDDfy/Reporters/Html/IHtmlReportConfiguration.cs
@@ -6,6 +6,7 @@ public interface IHtmlReportConfiguration
         string ReportDescription { get; }
         string OutputPath { get; }
         string OutputFileName { get; }
+        bool ResolveJqueryFromCdn { get; }
         bool RunsOn(Story story);
     }
 }
diff --git a/TestStack.BDDfy/Reporters/Html/jquery-2.1.0.min.js b/TestStack.BDDfy/Reporters/Html/jquery-2.1.0.min.js
diff --git a/TestStack.BDDfy/TestStack.BDDfy.csproj b/TestStack.BDDfy/TestStack.BDDfy.csproj
@@ -160,6 +160,7 @@
   <ItemGroup>
     <Content Include="Reporters\Html\BDDfy.css" />
     <Content Include="Reporters\Html\BDDfy.js" />
+    <Content Include="Reporters\Html\jquery-2.1.0.min.js" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="Reporters\Html\HtmlReportResources.resx">

Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,16 @@`
`1`		`-using TestStack.BDDfy.Processors;`
	`1`	`+using System;`
`2`	`2`	`using TestStack.BDDfy.Reporters.Html;`
`3`	`3`
`4`	`4`	`namespace TestStack.BDDfy.Samples.Atm`
`5`	`5`	`{`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// This overrides the default html report setting`
`8`	`8`	`/// </summary>`
`9`		`- public class HtmlReportConfig : DefaultHtmlReportConfiguration`
	`9`	`+ public class AtmHtmlReportConfig : DefaultHtmlReportConfiguration`
`10`	`10`	`{`
`11`	`11`	`public override bool RunsOn(Story story)`
`12`	`12`	`{`
`13`		`- return story.Metadata.Type.Namespace != null && story.Metadata.Type.Namespace.EndsWith("Atm");`
	`13`	`+ return story.Namespace.EndsWith("Atm", StringComparison.OrdinalIgnoreCase);`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`/// <summary>`
`@@ -45,5 +45,13 @@ public override string ReportDescription`
`45`	`45`	`return "A reliable solution for your offline banking needs";`
`46`	`46`	`}`
`47`	`47`	`}`
	`48`	`+`
	`49`	`+ /// <summary>`
	`50`	`+ /// For ATM report I want to embed jQuery in the report so people can see it with no internet connectivity`
	`51`	`+ /// </summary>`
	`52`	`+ public override bool ResolveJqueryFromCdn`
	`53`	`+ {`
	`54`	`+ get { return false; }`
	`55`	`+ }`
`48`	`56`	`}`
`49`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`using NUnit.Framework;`
`2`	`2`	`using TestStack.BDDfy.Configuration;`
`3`		`-using TestStack.BDDfy.Processors;`
`4`	`3`	`using TestStack.BDDfy.Reporters.Html;`
`5`	`4`	`using TestStack.BDDfy.Samples.Atm;`
`6`	`5`
`@@ -15,7 +14,7 @@ public void Config()`
`15`	`14`	`Configurator.Processors.Add(() => new CustomTextReporter());`
`16`	`15`	`Configurator.BatchProcessors.MarkDownReport.Enable();`
`17`	`16`	`Configurator.BatchProcessors.DiagnosticsReport.Enable();`
`18`		`- Configurator.BatchProcessors.Add(new HtmlReporter(new HtmlReportConfig()));`
	`17`	`+ Configurator.BatchProcessors.Add(new HtmlReporter(new AtmHtmlReportConfig()));`
`19`	`18`	`}`
`20`	`19`	`}`
`21`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,25 +6,39 @@ namespace TestStack.BDDfy.Reporters.Html`
`6`	`6`	`{`
`7`	`7`	`public class DefaultHtmlReportConfiguration : IHtmlReportConfiguration`
`8`	`8`	`{`
	`9`	`+ private string _reportHeader = "BDDfy";`
`9`	`10`	`public virtual string ReportHeader`
`10`	`11`	`{`
`11`		`- get { return "BDDfy"; }`
	`12`	`+ get { return _reportHeader; }`
	`13`	`+ set { _reportHeader = value; }`
`12`	`14`	`}`
`13`	`15`
	`16`	`+ private string _reportDescription = "A simple BDD framework for .Net developers";`
`14`	`17`	`public virtual string ReportDescription`
`15`	`18`	`{`
`16`		`- get { return "A simple BDD framework for .Net developers"; }`
	`19`	`+ get { return _reportDescription; }`
	`20`	`+ set { _reportDescription = value; }`
`17`	`21`	`}`
`18`	`22`
	`23`	`+ private string _outputPath = AssemblyDirectory;`
`19`	`24`	`public virtual string OutputPath`
`20`	`25`	`{`
`21`		`- get { return AssemblyDirectory; }`
	`26`	`+ get { return _outputPath; }`
	`27`	`+ set { _outputPath = value; }`
`22`	`28`	`}`
`23`	`29`
`24`	`30`	`private string _outputFileName = "BDDfy.html";`
`25`	`31`	`public virtual string OutputFileName`
`26`	`32`	`{`
`27`	`33`	`get { return _outputFileName; }`
	`34`	`+ set { _outputFileName = value; }`
	`35`	`+ }`
	`36`	`+`
	`37`	`+ private bool _resolveJqueryFromCdn = true;`
	`38`	`+ public virtual bool ResolveJqueryFromCdn`
	`39`	`+ {`
	`40`	`+ get { return _resolveJqueryFromCdn; }`
	`41`	`+ set { _resolveJqueryFromCdn = value; }`
`28`	`42`	`}`
`29`	`43`
`30`	`44`	`public virtual bool RunsOn(Story story)`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ public interface IHtmlReportConfiguration`
`6`	`6`	`string ReportDescription { get; }`
`7`	`7`	`string OutputPath { get; }`
`8`	`8`	`string OutputFileName { get; }`
	`9`	`+ bool ResolveJqueryFromCdn { get; }`
`9`	`10`	`bool RunsOn(Story story);`
`10`	`11`	`}`
`11`	`12`	`}`