Merge branch 'release-2.5.0'

.gitignore

@@ -30,12 +30,16 @@ obj/
 [Dd]ebug*/
 [Rr]elease*/
 Ankh.NoLoad
+.vscode/
 
 #MonoDevelop files
 *.userprefs
 *.pidb
 *~
 
+#Webstorm files
+.idea/
+
 #Tooling
 _ReSharper*/
 *.resharper
@@ -82,3 +86,4 @@ packages/Chocolatey/
 # Fody
 !src/Pickles/packages/Fody*/build/*
 src/Pickles/.vs/config/applicationhost.config
+src/Pickles/Pickles/PortabilityAnalysis.html

CHANGELOG.md

@@ -10,8 +10,23 @@ This project adheres to [Semantic Versioning](http://semver.org). We consider th
   - The settings file of the GUI runner
   - The JSON output of the JSON format
 
+Features in Experimental are subject to change and removal without being considered breaking.
+
 This document is formatted according to the principles of [Keep A CHANGELOG](http://keepachangelog.com).
 
+
+## [2.5.0] - 2016-03-21
+
+### Added
+
+- Experimental features - see the [documentation](http://docs.picklesdoc.com/en/latest/ExperimentalFeatures/) (by [@dirkrombauts](https://github.com/dirkrombauts)).
+
+### Experimental
+
+- Using a different MarkDown component. Warning: it is not entirely compatible with the static HTML version. ([#269](https://github.com/picklesdoc/pickles/issues/269)) (by [@dirkrombauts](https://github.com/dirkrombauts)).
+- Enabling mathematics in the description elements in the DHTML version. Warning: requires internet connectivity. ([#281](https://github.com/picklesdoc/pickles/issues/281)) (by [@dirkrombauts](https://github.com/dirkrombauts)).
+- Overview Dashboard on DHTML Pickles Site with Summary Charts by Namespace and Tags ([#295](https://github.com/picklesdoc/pickles/pull/295)) (by [@ocsurfnut](https://github.com/ocsurfnut))
+
 ## [2.4.1] - 2016-03-01
 
 ### Fixed

DeployArtifacts.cmd

@@ -0,0 +1,4 @@
+@ECHO OFF
+call DeployOutput.cmd %1
+call DeployToChocolatey.cmd %1
+call DeployToNuget.cmd %1

build.bat

@@ -1,5 +1,5 @@
 @echo off
-set "picklesVersion=2.4.1"
+set "picklesVersion=2.5.0"
 
 cls
 

build.cmd

@@ -0,0 +1 @@
+call build.bat

chocolatey.fsx

@@ -33,6 +33,9 @@ Target "CreatePackage CMD" (fun _ ->
         cmdDir + "PicklesDoc.Pickles.ObjectModel.dll";
         cmdDir + "PicklesDoc.Pickles.TestFrameworks.dll";
         cmdDir + "System.IO.Abstractions.dll";
+        cmdDir + "FeatureSwitcher.dll";
+        cmdDir + "Strike.Jint.dll";
+        cmdDir + "Jint.dll";
         cmdDir + "pickles.exe";
         cmdDir + "NLog.config" ]
 
@@ -70,6 +73,9 @@ Target "CreatePackage GUI" (fun _ ->
         guiDir + "PicklesDoc.Pickles.ObjectModel.dll";
         guiDir + "PicklesDoc.Pickles.TestFrameworks.dll";
         guiDir + "System.IO.Abstractions.dll";
+        guiDir + "FeatureSwitcher.dll";
+        guiDir + "Strike.Jint.dll";
+        guiDir + "Jint.dll";
         guiDir + "System.Windows.Interactivity.dll";
         guiDir + "picklesui.exe";
         guiDir + "NLog.config";

chocolatey/pickles.nuspec

@@ -50,6 +50,9 @@ Optionally, *Pickles* can **integrate test results**, so that your stakeholders
         <file src="PicklesDoc.Pickles.ObjectModel.dll" target="tools" />
         <file src="PicklesDoc.Pickles.TestFrameworks.dll" target="tools" />
         <file src="System.IO.Abstractions.dll" target="tools" />
+        <file src="FeatureSwitcher.dll" target="tools" />
+        <file src="Strike.Jint.dll" target="tools" />
+        <file src="Jint.dll" target="tools" />
         <file src="pickles.exe" target="tools" />
     </files>
 </package>

chocolatey/picklesui.nuspec

@@ -57,6 +57,9 @@ Optionally, *Pickles* can **integrate test results**, so that your stakeholders
         <file src="PicklesDoc.Pickles.ObjectModel.dll" target="tools" />
         <file src="PicklesDoc.Pickles.TestFrameworks.dll" target="tools" />
         <file src="System.IO.Abstractions.dll" target="tools" />
+        <file src="FeatureSwitcher.dll" target="tools" />
+        <file src="Strike.Jint.dll" target="tools" />
+        <file src="Jint.dll" target="tools" />
         <file src="System.Windows.Interactivity.dll" target="tools" />
         <file src="picklesui.exe" target="tools" />
         <file src="picklesui.exe.gui" target="tools" />

nuget.fsx

@@ -35,6 +35,9 @@ Target "CreatePackageCommandLine" (fun _ ->
         cmdDir + "PicklesDoc.Pickles.ObjectModel.dll";
         cmdDir + "PicklesDoc.Pickles.TestFrameworks.dll";
         cmdDir + "System.IO.Abstractions.dll";
+        cmdDir + "FeatureSwitcher.dll";
+        cmdDir + "Strike.Jint.dll";
+        cmdDir + "Jint.dll";
         cmdDir + "pickles.exe";
         cmdDir + "NLog.config" ]
 
@@ -64,6 +67,9 @@ Target "CreatePackageMsBuild" (fun _ ->
         msBuildDir + "PicklesDoc.Pickles.ObjectModel.dll";
         msBuildDir + "PicklesDoc.Pickles.TestFrameworks.dll";
         msBuildDir + "System.IO.Abstractions.dll";
+        msBuildDir + "FeatureSwitcher.dll";
+        msBuildDir + "Strike.Jint.dll";
+        msBuildDir + "Jint.dll";
         msBuildDir + "PicklesDoc.Pickles.MSBuild.Tasks.dll";
         msBuildDir + "build/Pickles.MSBuild.targets";]
 
@@ -94,6 +100,9 @@ Target "CreatePackagePowerShell" (fun _ ->
         powerShellDir + "PicklesDoc.Pickles.TestFrameworks.dll";
         powerShellDir + "PicklesDoc.Pickles.PowerShell.dll";
         powerShellDir + "System.IO.Abstractions.dll";
+        powerShellDir + "FeatureSwitcher.dll";
+        powerShellDir + "Strike.Jint.dll";
+        powerShellDir + "Jint.dll";
         "src/Pickles/Pickles.PowerShell/init.ps1"  ]
 
     NuGet (fun p ->

src/Pickles/Examples/Features/Arithmetic.feature

@@ -1,7 +1,10 @@
 Feature: Arithmetic
-	In order to avoid silly mistakes
-	As a math idiot
-	I want to be able to perform arithmetic on the calculator
+In order to avoid silly mistakes  
+As a math idiot  
+I want to be able to perform arithmetic on the calculator
+
+When $a \ne 0$, there are two solutions to $\(ax^2 + bx + c = 0\)$ and they are
+$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$
 
 	@arithmetic @fast
 	Scenario: Add two numbers

src/Pickles/Pickles.BaseDhtmlFiles/Index.html

@@ -14,9 +14,10 @@
     <!--[if lt IE 9]>
       <script src="js/html5.js"></script>
     <![endif]-->
+    #### EMBED EXPERIMENTALS ####
 </head>
 
-<body>
+<body data-bind="style: { overflow: overviewVisible() ? 'hidden' : 'auto' }">
     <div id="progress" style="width:100%;height:100%;position: absolute;left:0;top:0;background:#ffffff;z-index:100">
         <span style="position: absolute;left:50%;top:50%;font-weight:bold">Loading...</span>
     </div>
@@ -82,15 +83,25 @@
     <div class="navbar navbar-inverse navbar-fixed-top" id="TopNav">
         <div class="navbar-inner">
             <div class="container-fluid">
+                <!-- ko ifnot: overviewVisible -->
                 <a class="brand" href="#" data-bind="text: configuration().SutName != null ? configuration().SutName : 'Features'"></a>
                 <div class="navbar-search pull-left">
-                    <input type="text" id="TypeAheadSearchBox" class="search-query" data-bind="value: whatToSearchFor" style="width: 300px" placeholder="@tag or feature name" />
+                    <input type="text" id="TypeAheadSearchBox" class="search-query" data-bind="value: whatToSearchFor" style="width: 300px" placeholder="@tag or feature name"/>
                     <a id="SearchButton" data-bind="click: search" class="btn">Search</a>
                     <a id="ClearSearchButton" data-bind="click: clearSearch" class="btn">Clear</a>
                 </div>
+                <!-- /ko -->
+                <!-- ko if: overviewVisible -->
+                <div class="pull-left">
+                    <span class="brand">Overview and Summary</span>
+                </div>
+                <!-- /ko -->
+                <div class="overview pull-right">
+                    <a id="OverviewButton" class="btn" data-bind="text: overviewVisible() ? 'Hide Overview' : 'Show Overview', click: toggleOverview"></a>
+                </div>
             </div>
         </div>
-        <div class="navbar-below">
+        <div class="navbar-below" data-bind="style: { height: overviewVisible() ? '0px' : '22px' }">
             <div data-bind="click: $root.hideShowNavigation"><i class="icon-white" data-bind="css: { 'icon-minus-sign': $root.navIsShown(), 'icon-plus-sign': !$root.navIsShown() }"></i> Navigation</div>
             <div data-bind="click: $root.hideShowNavigationTree"><i class="icon-white" data-bind="css: { 'icon-minus-sign': $root.ShowAllLinks(), 'icon-plus-sign': !$root.ShowAllLinks() }"></i> Links</div>
         </div>
@@ -183,7 +194,6 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
             </div>
         </div>
         <!--/row-->
-
         <!--<hr>
 
         <footer>
@@ -192,7 +202,41 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
 
     </div>
     <!--/.fluid-container-->
-    <!-- Le javascript
+
+    <div class="modal-host">
+        <div class="modal-overlay" data-bind="css: { 'modal-overlay-visible': overviewVisible }">
+            <div class="modal-box">
+                <div class="clearfix">
+                    <div id="overallCompleteCanvas-container" class="pull-left">
+                        <canvas id="overallCompleteCanvas"></canvas>
+                    </div>
+                    <aside id="overallCompleteSummary" class="pull-right">
+                        <h3>Scenario Summary by Result</h3>
+                        <ul data-bind="foreach: totals">
+                            <li>
+                                <span class="color-key" data-bind="text: value, style: { backgroundColor: color }"></span>
+                                <span data-bind="text: label"></span>
+                            </li>
+                        </ul>
+                    </aside>
+                </div>
+                <div>
+                    <h3 class="header">Scenario Summary by Root Namespace</h3>
+                    <canvas id="byRootFolderCanvas"></canvas>
+                </div>
+                <div>
+                    <h3 class="header">Scenario Summary by Top 20 Tags</h3>
+                    <canvas id="byTagCanvas"></canvas>
+                </div>
+                <div>
+                    <h3 class="header">@NotTested Scenario Summary by Root Namespace</h3>
+                    <canvas id="notTestedbyRootFolderCanvas"></canvas>
+                </div>
+            </div>
+        </div>
+    </div>
+
+<!-- Le javascript
             ================================================== -->
     <!-- Placed at the end of the document so the pages load faster -->
     <script src="js/jquery-1.8.3.min.js" type="text/javascript"></script>
@@ -201,6 +245,8 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
     <script src="js/knockout.mapping-latest.js" type="text/javascript"></script>
     <script src="js/underscore-min.js" type="text/javascript"></script>
     <script src="js/jquery.highlight-4.closure.js"></script>
+    <script src="js/Chart.min.js"></script>
+    <script src="js/Chart.StackedBar.js"></script>
     <script src="js/Markdown.Converter.js" type="text/javascript"></script>
     <script src="js/Markdown.Extra.js" type="text/javascript"></script>
     <script src="js/featuresModel.js" type="text/javascript"></script>
@@ -209,8 +255,9 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
     <script src="js/heirarchyBuilder.js" type="text/javascript"></script>
     <script src="js/typeaheadList.js" type="text/javascript"></script>
     <script src="js/featureSearch.js" type="text/javascript"></script>
+    <script src="js/picklesOverview.js" type="text/javascript"></script>
     <script type="text/javascript">
-        function ViewModel(features, configuration) {
+        function ViewModel(features, configuration, summary) {
             var self = this;
 
             features = $.map(features, function (el, i) { return new FeatureParent(el); });
@@ -219,8 +266,11 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
             self.featuresByFolder = ko.observable(buildFullHierarchy(getFeaturesFromScenariosList(features)));
             self.currentFeature = ko.observable();
             self.configuration = ko.observable(configuration);
+            self.totals = ko.observable([]);
+
             self.ShowAllLinks = ko.observable(false);
-
+            self.overviewVisible = ko.observable(false);
+
             self.setCurrentFeature = function () {
                 if (window.location.hash != '') {
                     var featureFromHashLocation = findFeatureByRelativeFolder(removeBeginningHash(window.location.hash), features);
@@ -230,6 +280,29 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
                 }
             };
 
+            self.toggleOverview = function() {
+                if (!self.overviewVisible()) {
+                    // scroll to top to support fixed overlay
+                    window.scrollTo(0, 0);
+                }
+
+                self.overviewVisible(!self.overviewVisible());
+
+                if (self.overviewVisible()) {
+                    if (!self.overview) {
+                        // build charts first time overview becomes visible
+                        self.overview = PicklesOverview(summary);
+                        self.overview.createOverallTotalsChart($('#overallCompleteCanvas').get(0).getContext('2d'));
+                        self.overview.createByTagChart($('#byTagCanvas').get(0).getContext('2d'));
+                        self.overview.createByRootFolderChart($('#byRootFolderCanvas').get(0).getContext('2d'));
+                        self.overview.createNotTestedByRootFolderChart($('#notTestedbyRootFolderCanvas').get(0).getContext('2d'));
+                        self.totals(self.overview.getTotalsData());
+                    } else {
+                        $('.modal-overlay').scrollTop(0);
+                    }
+                }
+            };
+
             self.whatToSearchFor = ko.observable("");
 
             self.clearSearch = function () {
@@ -317,7 +390,7 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
         function jsonPWrapper(data) {
             data.Features.reverse();
 
-            var viewModel = new window.ViewModel(data.Features, data.Configuration);
+            var viewModel = new window.ViewModel(data.Features, data.Configuration, data.Summary);
             viewModel.setCurrentFeature();
 
             window.ko.applyBindings(viewModel);
@@ -328,11 +401,14 @@ <h4 data-bind="text: Name, click: $root.toggleDetail" class="canHighlight, click
             });
 
             $('#progress').hide();
+            $('#TopNav').show();
         }
 
         var navShown = true;
 
         $(document).ready(function () {
+            $('#TopNav').hide();
+
             function chromeSOPHack_LoadJsonPFileAndCreateDynamicScriptTag() {
                 var url = "pickledFeatures.js"; // URL of the external script