Release 2.6.0 (#324)

* Fix failing tests by removing overspecification * Untabify * Ensure description of feature is never null, fixes crashes of word and excel generation * Unit test * SpecFlow conformant name mapping * Implement name mapping in nunit signature builder more conformant to SpecFlows name generation logic wrt. to special characters * Unit tests for special character handling * Basic comments handling (#311) * basic comment handling * add excel handling * cleanup * clean up * fix tests * handle comments after the last step of a scenario * clean up * codestyle clean up * codestyle clean up * add test for mapper on comments * clean up * adding mapper tests on comments and location + more clean up * Update Nuget packages (and small fixes) (#310) * Update-Package SpecFlow * Update-Package Nunit * ExpectedException is obsolete in nunit3 * Update-Package System.IO.Abstractions.* * Refactor CurrentScenarioContext to be instance-based and to be injected * Update-Package MahApps.Metro * Update-Package AutoMapper * Update-Package Newtonsoft.Json * Remove IKVM assembly binding redirects * Do not use ScenarioContext.Current * tweak gitignore * Update GhostDoc file * Downgrade Automapper to last known good version * Exclude test project from test coverage * Edit applicationhost.config * Added support for multiple tags when searching (issue #283) (#319) * Use Gherkin 4 parser (#322) * Update-Package Gherkin * tweak applicationhost.config * Factory creates a GherkinDocument now * The parser now returns a GherkinDocument * Map a GherkinDocument to a Feature * Use new icon (#323) * Use new icon * Use a big png file with the new logo * Use the new .png file in the .nuspec files * Use visual studio 2015 * Version bump to 2.6.0 * Update change log
picklesdoc · Apr 12, 2016 · 988404a · 988404a
1 parent a887ebb
commit 988404a
Show file tree

Hide file tree

Showing 82 changed files with 1,185 additions and 225 deletions.
diff --git a/.gitignore b/.gitignore
@@ -87,3 +87,4 @@ packages/Chocolatey/
 !src/Pickles/packages/Fody*/build/*
 src/Pickles/.vs/config/applicationhost.config
 src/Pickles/Pickles/PortabilityAnalysis.html
+src/Pickles/.vs/config/applicationhost.config
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,24 @@ Features in Experimental are subject to change and removal without being conside
 
 This document is formatted according to the principles of [Keep A CHANGELOG](http://keepachangelog.com).
 
+## [2.6.0] - 2016-04-12
+
+### Added
+
+- Support for multiple tags in DHTML version ([#283](https://github.com/picklesdoc/pickles/issues/283)) (by [@aaronjrich](https://github.com/aaronjrich)).
+- Output commented lines ([#271](https://github.com/picklesdoc/pickles/issues/271)) (by [@ludwigjossieaux](https://github.com/ludwigjossieaux)).
+
+### Changed
+
+- Use version 4 of the Gherkin parser ([#322](https://github.com/picklesdoc/pickles/issues/322)) (by [@dirkrombauts](https://github.com/dirkrombauts)).
+- Use new logo as icon and in nuget packages ([#323](https://github.com/picklesdoc/pickles/issues/323)) (by [@dirkrombauts](https://github.com/dirkrombauts)).
+- Update external libraries ([#310](https://github.com/picklesdoc/pickles/issues/310)) (by [@dirkrombauts](https://github.com/dirkrombauts)).
+
+### Fixed
+
+- SpecFlow conformant name mapping in nUnit test result provider ([#315](https://github.com/picklesdoc/pickles/issues/315)) (by [@danielpullwitt](https://github.com/danielpullwitt)).
+- Prevent crash when no Description is provided ([#314](https://github.com/picklesdoc/pickles/issues/314)) (by [@danielpullwitt](https://github.com/danielpullwitt)).
+
 
 ## [2.5.0] - 2016-03-21
 

diff --git a/build.bat b/build.bat
@@ -1,5 +1,5 @@
 @echo off
-set "picklesVersion=2.5.0"
+set "picklesVersion=2.6.0"
 
 cls
 

diff --git a/chocolatey/pickles.nuspec b/chocolatey/pickles.nuspec
@@ -32,7 +32,7 @@ Optionally, *Pickles* can **integrate test results**, so that your stakeholders
         <copyright>Copyright © 2010-2012 Jeffrey Cameron, Copyright © 2013-present PicklesDoc and contributors</copyright>
         <licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
         <requireLicenseAcceptance>false</requireLicenseAcceptance>
-        <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.jpeg</iconUrl>
+        <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.png</iconUrl>
         <releaseNotes>https://github.com/picklesdoc/pickles/blob/master/CHANGELOG.md</releaseNotes>
     </metadata>
     <files>

diff --git a/chocolatey/picklesui.nuspec b/chocolatey/picklesui.nuspec
@@ -32,7 +32,7 @@ Optionally, *Pickles* can **integrate test results**, so that your stakeholders
         <copyright>Copyright © 2010-2012 Jeffrey Cameron, Copyright © 2013-present PicklesDoc and contributors</copyright>
         <licenseUrl>http://apache.org/licenses/LICENSE-2.0.html</licenseUrl>
         <requireLicenseAcceptance>false</requireLicenseAcceptance>
-        <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.jpeg</iconUrl>
+        <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.png</iconUrl>
         <releaseNotes>https://github.com/picklesdoc/pickles/blob/master/CHANGELOG.md</releaseNotes>
     </metadata>
     <files>

diff --git a/pickles.jpeg b/pickles.jpeg
diff --git a/pickles.png b/pickles.png
diff --git a/src/Pickles/.vs/config/applicationhost.config b/src/Pickles/.vs/config/applicationhost.config
@@ -163,7 +163,15 @@
             </site>
             <site name="Pickles.BaseDhtmlFiles" id="2">
                 <application path="/" applicationPool="Clr4IntegratedAppPool">
-                    <virtualDirectory path="/" physicalPath="C:\Dev\Code\GitHub\DirkRombauts\pickles\src\Pickles\Pickles.BaseDhtmlFiles" />
+                    <virtualDirectory path="/" physicalPath="C:\Dev\Code\GitHub\DirkRombauts\Pickles\src\Pickles\Pickles.BaseDhtmlFiles" />
+                </application>
+                <bindings>
+                    <binding protocol="http" bindingInformation="*:52000:localhost" />
+                </bindings>
+            </site>
+            <site name="Pickles.BaseDhtmlFiles(1)" id="3">
+                <application path="/" applicationPool="Clr4IntegratedAppPool">
+                    <virtualDirectory path="/" physicalPath="C:\Dev\PasteAsGherkinTable\Code\GitHub\DirkRombauts\Pickles\pickles\src\Pickles\Pickles.BaseDhtmlFiles" />
                 </application>
                 <bindings>
                     <binding protocol="http" bindingInformation="*:52000:localhost" />

diff --git a/src/Pickles/Pickles.BaseDhtmlFiles/Index.html b/src/Pickles/Pickles.BaseDhtmlFiles/Index.html
@@ -50,11 +50,27 @@
 
     <script type="text/html" id="steps-template">
         <li class="step">
+            <!-- ko if: StepComments != null && StepComments.length > 0 -->
+            <span class="comment">
+                    <!-- ko foreach: StepComments -->
+                        <span data-bind="text: Text"></span>
+                        <br data-bind="visible : $index() != ($parent.length-1)" />
+                    <!-- /ko -->
+            </span>
+            <!-- /ko -->
             <span class="keyword" data-bind="text: NativeKeyword"></span><span data-bind="text: Name"></span>
             <div data-bind="if: DocStringArgument != ''">
                 <div data-bind="text: DocStringArgument" class="pre"></div>
             </div>
             <div data-bind="template: { name: 'table-template', data: $data.TableArgument }"></div>
+            <!-- ko if: AfterLastStepComments != null && AfterLastStepComments.length > 0 -->
+            <span class="comment">
+                <!-- ko foreach: AfterLastStepComments -->
+                    <span data-bind="text: Text"></span>
+                    <br data-bind="visible : $index() != ($parent.length-1)" />
+                <!-- /ko -->
+            </span>
+            <!-- /ko -->
         </li>
     </script>
 

diff --git a/src/Pickles/Pickles.BaseDhtmlFiles/css/styles.css b/src/Pickles/Pickles.BaseDhtmlFiles/css/styles.css
@@ -72,6 +72,11 @@ li.step {
     padding: 0;
 }
 
+.comment {
+    font-weight: bold;
+    color: #0088CC;
+}
+
 .keyword {
     font-weight: bold;
     color: #0000FF;

diff --git a/src/Pickles/Pickles.BaseDhtmlFiles/js/featureSearch.js b/src/Pickles/Pickles.BaseDhtmlFiles/js/featureSearch.js
@@ -16,7 +16,7 @@
 
 function findFeatureByRelativeFolder(path, features) {
     var feature = _.find(features, function(featureTesting) {
-         return featureTesting.RelativeFolder == path;
+        return featureTesting.RelativeFolder == path;
     });
     return feature ? feature : null;
 }
@@ -27,13 +27,20 @@ function matchesFeatureName(searchString, feature) {
 }
 
 function matchesFeatureTag(searchString, feature) {
-    var foundMatch = false;    
-    $.each(feature.Feature.Tags, function (key, scenarioTag) {
-        var lowerCasedTag = scenarioTag.toLowerCase();
-        if (lowerCasedTag.indexOf(searchString) > -1) {
-            foundMatch = true;
+    var foundMatch = false;
+    var tags = searchString.split(" ");
+    $.each(tags, function (index, tag) {
+        tag = tag.toLowerCase();
+        if (tag.indexOf("@") > -1) {
+            $.each(feature.Feature.Tags, function (key, scenarioTag) {
+                var lowerCasedTag = scenarioTag.toLowerCase();
+                if (lowerCasedTag.indexOf(tag) > -1) {
+                    foundMatch = true;
+                }
+            });
         }
     });
+
     return foundMatch;
 }
 
@@ -48,15 +55,21 @@ function matchesScenarioName(searchString, feature) {
 }
 
 function matchesScenarioTag(searchString, feature) {
-    for (var i = 0; i < feature.Feature.FeatureElements.length; i++) {
-        var foundMatch = false;
-        $.each(feature.Feature.FeatureElements[i].Tags, function (key, scenarioTag) {
-            var lowerCasedTag = scenarioTag.toLowerCase();
-            if (lowerCasedTag.indexOf(searchString) > -1) {
-                foundMatch = true;
+    var foundMatch = false;
+    var tags = searchString.split(" ");
+    $.each(tags, function (index, tag) {
+        tag = tag.toLowerCase();
+        if (tag.indexOf("@") > -1) {
+            for (var i = 0; i < feature.Feature.FeatureElements.length; i++) {
+                $.each(feature.Feature.FeatureElements[i].Tags, function (key, scenarioTag) {
+                    var lowerCasedTag = scenarioTag.toLowerCase();
+                    if (lowerCasedTag.indexOf(tag) > -1) {
+                        foundMatch = true;
+                    }
+                });
+                if (foundMatch) { break; }
             }
-        });
-        if (foundMatch) return true;
-    }
-    return false;
+        }
+    });
+    return foundMatch;
 }
diff --git a/src/Pickles/Pickles.BaseDhtmlFiles/js/featuresModel.js b/src/Pickles/Pickles.BaseDhtmlFiles/js/featuresModel.js
@@ -28,6 +28,12 @@ function Step(data) {
     this.NativeKeyword = data.NativeKeyword || '';
     this.DocStringArgument = data.DocStringArgument || '';
     this.TableArgument = data.TableArgument == null ? null : new TableArgument(data.TableArgument.HeaderRow, data.TableArgument.DataRows);
+    this.StepComments = data.StepComments == null ? null : $.map(data.StepComments, function (c) { return new Comment(c); });
+    this.AfterLastStepComments = data.AfterLastStepComments == null ? null : $.map(data.AfterLastStepComments, function (c) { return new Comment(c); });
+}
+
+function Comment(data) {
+    this.Text = data.Text || '';
 }
 
 function TableArgument(headerRow, dataRows) {

diff --git a/src/Pickles/Pickles.BaseDhtmlFiles/tests/tests.js b/src/Pickles/Pickles.BaseDhtmlFiles/tests/tests.js
@@ -494,13 +494,15 @@ test("Can search for tags and feature/scenarios names", function () {
         "Feature level level tag search - across multiple features");
     deepEqual(getFeaturesMatching('@doesnotexist', sampleJSONForSearch), [],
         "Neither a tag or feature in list.");
+    deepEqual(getFeaturesMatching('@clearing @nestedFolder', sampleJSONForSearch), sampleJSONForSearch,
+        "Can search using multiple tags - will or them");
 
 });
 
 test("Can find feature by RelativeFolder", function () {
 
     deepEqual(findFeatureByRelativeFolder('Workflow\\ClearingScreen.feature', sampleJSONForSearch), sampleJSONForSearch[0],
-        "Feature exists");
+         "Feature exists");
     deepEqual(findFeatureByRelativeFolder('Workflow\\ClearingScreen2.feature', sampleJSONForSearch), null,
         "Feature does not exist");
 

diff --git a/src/Pickles/Pickles.CommandLine/Pickles.CommandLine.csproj b/src/Pickles/Pickles.CommandLine/Pickles.CommandLine.csproj
@@ -55,8 +55,8 @@
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
-    <Reference Include="System.IO.Abstractions, Version=2.0.0.123, Culture=neutral, PublicKeyToken=d480b5b72fb413da, processorArchitecture=MSIL">
-      <HintPath>..\packages\System.IO.Abstractions.2.0.0.123\lib\net40\System.IO.Abstractions.dll</HintPath>
+    <Reference Include="System.IO.Abstractions, Version=2.0.0.124, Culture=neutral, PublicKeyToken=d480b5b72fb413da, processorArchitecture=MSIL">
+      <HintPath>..\packages\System.IO.Abstractions.2.0.0.124\lib\net40\System.IO.Abstractions.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System.Xml.Linq" />

diff --git a/src/Pickles/Pickles.CommandLine/Pickles.CommandLine.nuspec b/src/Pickles/Pickles.CommandLine/Pickles.CommandLine.nuspec
@@ -33,7 +33,7 @@
     <summary>A documentation generator for features written in the Gherkin language</summary>
     <copyright>Copyright © 2010-2012 Jeffrey Cameron, Copyright © 2013-present PicklesDoc and contributors</copyright>
     <tags>SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation</tags>
-    <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.jpeg</iconUrl>
+    <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.png</iconUrl>
     <releaseNotes>https://github.com/picklesdoc/pickles/blob/master/CHANGELOG.md</releaseNotes>
   </metadata>
   <files>

diff --git a/src/Pickles/Pickles.CommandLine/packages.config b/src/Pickles/Pickles.CommandLine/packages.config
@@ -5,5 +5,5 @@
   <package id="NLog" version="4.2.3" targetFramework="net45" />
   <package id="NLog.Config" version="4.2.3" targetFramework="net45" />
   <package id="NLog.Schema" version="4.2.3" targetFramework="net45" />
-  <package id="System.IO.Abstractions" version="2.0.0.123" targetFramework="net45" />
+  <package id="System.IO.Abstractions" version="2.0.0.124" targetFramework="net45" />
 </packages>
diff --git a/src/Pickles/Pickles.MSBuild/Pickles.MSBuild.csproj b/src/Pickles/Pickles.MSBuild/Pickles.MSBuild.csproj
@@ -46,8 +46,8 @@
     <Reference Include="Microsoft.Build.Utilities.v3.5" />
     <Reference Include="System" />
     <Reference Include="System.Core" />
-    <Reference Include="System.IO.Abstractions, Version=2.0.0.123, Culture=neutral, PublicKeyToken=d480b5b72fb413da, processorArchitecture=MSIL">
-      <HintPath>..\packages\System.IO.Abstractions.2.0.0.123\lib\net40\System.IO.Abstractions.dll</HintPath>
+    <Reference Include="System.IO.Abstractions, Version=2.0.0.124, Culture=neutral, PublicKeyToken=d480b5b72fb413da, processorArchitecture=MSIL">
+      <HintPath>..\packages\System.IO.Abstractions.2.0.0.124\lib\net40\System.IO.Abstractions.dll</HintPath>
       <Private>True</Private>
     </Reference>
     <Reference Include="System.Xml.Linq" />

diff --git a/src/Pickles/Pickles.MSBuild/Pickles.MSBuild.nuspec b/src/Pickles/Pickles.MSBuild/Pickles.MSBuild.nuspec
@@ -33,7 +33,7 @@
     <summary>A documentation generator for features written in the Gherkin language</summary>
     <copyright>Copyright © 2010-2012 Jeffrey Cameron, Copyright © 2013-present PicklesDoc and contributors</copyright>
     <tags>SpecificationByExample BDD SpecFlow Gherkin Cucumber SpecByEx LivingDocumentation Documentation</tags>
-    <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.jpeg</iconUrl>
+    <iconUrl>https://cdn.rawgit.com/picklesdoc/pickles/master/pickles.png</iconUrl>
     <releaseNotes>https://github.com/picklesdoc/pickles/blob/master/CHANGELOG.md</releaseNotes>
   </metadata>
   <files>

diff --git a/src/Pickles/Pickles.MSBuild/packages.config b/src/Pickles/Pickles.MSBuild/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Autofac" version="3.5.2" targetFramework="net45" />
-  <package id="System.IO.Abstractions" version="2.0.0.123" targetFramework="net45" />
+  <package id="System.IO.Abstractions" version="2.0.0.124" targetFramework="net45" />
 </packages>
diff --git a/src/Pickles/Pickles.ObjectModel/ObjectModel/Comment.cs b/src/Pickles/Pickles.ObjectModel/ObjectModel/Comment.cs
@@ -0,0 +1,44 @@
+//  --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="Table.cs" company="PicklesDoc">
+//  Copyright 2011 Jeffrey Cameron
+//  Copyright 2012-present PicklesDoc team and community contributors
+//
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//  </copyright>
+//  --------------------------------------------------------------------------------------------------------------------
+
+namespace PicklesDoc.Pickles.ObjectModel
+{
+    public enum CommentType
+    {
+        Normal,
+        StepComment,
+        AfterLastStepComment
+    }
+
+    public class Comment
+    {
+        public Comment()
+        {
+            // Set default
+            this.Type = CommentType.Normal;
+        }
+
+        public string Text { get; set; }
+
+        public Location Location { get; set; }
+
+        public CommentType Type { get; set; }
+    }
+}
diff --git a/src/Pickles/Pickles.ObjectModel/ObjectModel/Feature.cs b/src/Pickles/Pickles.ObjectModel/ObjectModel/Feature.cs
@@ -27,6 +27,7 @@ public class Feature
         public Feature()
         {
             this.FeatureElements = new List<IFeatureElement>();
+            this.Comments = new List<Comment>();
             this.Tags = new List<string>();
         }
 
@@ -36,6 +37,8 @@ public Feature()
 
         public List<IFeatureElement> FeatureElements { get; }
 
+        public List<Comment> Comments { get; }
+
         public Scenario Background { get; private set; }
 
         public TestResult Result { get; set; }

diff --git a/src/Pickles/Pickles.ObjectModel/ObjectModel/IFeatureElement.cs b/src/Pickles/Pickles.ObjectModel/ObjectModel/IFeatureElement.cs
@@ -35,5 +35,7 @@ public interface IFeatureElement
         List<string> Tags { get; set; }
 
         TestResult Result { get; set; }
+
+        Location Location { get; set; }
     }
 }
diff --git a/src/Pickles/Pickles.ObjectModel/ObjectModel/Location.cs b/src/Pickles/Pickles.ObjectModel/ObjectModel/Location.cs
@@ -0,0 +1,29 @@
+//  --------------------------------------------------------------------------------------------------------------------
+//  <copyright file="Table.cs" company="PicklesDoc">
+//  Copyright 2011 Jeffrey Cameron
+//  Copyright 2012-present PicklesDoc team and community contributors
+//
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//  </copyright>
+//  --------------------------------------------------------------------------------------------------------------------
+
+namespace PicklesDoc.Pickles.ObjectModel
+{
+    public class Location
+    {
+        public int Column { get; set; }
+
+        public int Line { get; set; }
+    }
+}
diff --git a/src/Pickles/Pickles.ObjectModel/ObjectModel/Scenario.cs b/src/Pickles/Pickles.ObjectModel/ObjectModel/Scenario.cs
@@ -30,8 +30,6 @@ public Scenario()
             this.Tags = new List<string>();
         }
 
-        #region IFeatureElement Members
-
         public string Name { get; set; }
 
         public string Description { get; set; }
@@ -44,6 +42,6 @@ public Scenario()
 
         public Feature Feature { get; set; }
 
-        #endregion
+        public Location Location { get; set; }
     }
 }
diff --git a/src/Pickles/Pickles.ObjectModel/ObjectModel/ScenarioOutline.cs b/src/Pickles/Pickles.ObjectModel/ObjectModel/ScenarioOutline.cs
@@ -43,5 +43,7 @@ public ScenarioOutline()
         public TestResult Result { get; set; }
 
         public Feature Feature { get; set; }
+
+        public Location Location { get; set; }
     }
 }