cuke_sniffer 0.0.8 → 1.0.0

data/lib/cuke_sniffer/js/cuke_sniffer.js

@@ -0,0 +1,184 @@
+var CukeSniffer = {
+    init: function(){
+        CukeSniffer.actions.bind();
+        CukeSniffer.view._startTooltips();
+        CukeSniffer.view._updateRowColors();
+        CukeSniffer.view._disableRulesFromLocalStorage();
+    },
+    view: {
+        _disableRulesFromLocalStorage: function(){
+            $.each($("[data-rule-symbol]"), function(index, rule){
+                var $rule = $(rule),
+                    symbol = $rule.data("rule-symbol"),
+                    hasCookie = localStorage.getItem(symbol) != undefined;
+                if(hasCookie){
+                    $rule.find("input").click();
+                }
+            });
+        },
+        toggleDetails: function(){
+            $(this).closest(".deadStep, .feature, .stepDefinition, .hook").find(".row > .details").slideToggle();
+        },
+        _startTooltips: function(){
+            $("[title]").tooltip();
+        },
+        _updateRowColors: function(){
+            $(".rule:visible:even, .deadStep:even, .feature:even, .stepDefinition:even, .hook:even").addClass("blueRow");
+        },
+        _updateVisibleItems: function(){
+            $(".feature, .backgroundProblems, .scenario, .scenarios, .stepDefinition, .hook").hide();
+            CukeSniffer.view._updateVisibleFeatureIssues();
+            CukeSniffer.view._updateVisibleStepDefinitionIssues();
+            CukeSniffer.view._updateVisibleHookIssues();
+        },
+        _updateVisibleFeatureIssues: function(){
+            var $visibleFeatures = $(".feature:has([show])"),
+                $visibleBackground = $(".backgroundProblems:has([show])"),
+                $visibleScenarioBlocks = $(".scenarios:has([show])"),
+                $visibleScenarios = $(".scenario:has(.details [data-improvement-row][show])");
+
+            $visibleFeatures.show();
+            $visibleBackground.show();
+            $visibleScenarioBlocks.show();
+            $visibleScenarios.show();
+            $visibleScenarios.find(".details").show();
+        },
+        _updateVisibleStepDefinitionIssues: function(){
+            var $visibleStepDefinition = $(".stepDefinition:has([show])")
+            $visibleStepDefinition.show();
+        },
+        _updateVisibleHookIssues: function(){
+            var $visibleHooks = $(".hook:has([show])")
+            $visibleHooks.show();
+        }
+    },
+    actions: {
+        bind: function(){
+            CukeSniffer.actions._bindExpandAll();
+            CukeSniffer.actions._bindCollapseAll();
+            CukeSniffer.actions._bindShowDeadSteps()
+            CukeSniffer.actions._togglePanelHeaderIcons();
+            CukeSniffer.actions._viewRules();
+            CukeSniffer.actions._clickRow();
+            CukeSniffer.actions._ruleFilters();
+            CukeSniffer.actions.toggleDetails();
+            CukeSniffer.actions.enableAllRules();
+            CukeSniffer.actions.disableAllRules();
+            CukeSniffer.actions.changeRuleStatus();
+        },
+        _bindExpandAll: function(){
+            $(document).on("click", "[expand]", function(){
+                $(this).closest(".panel-body").find(".details").show();
+            });
+        },
+        _bindShowDeadSteps: function(){
+            $("#step_definitions .deadStep").hide();
+            $(document).on("click", "#showDeadSteps", function(){
+                $("#step_definitions .deadStep").toggle()
+            });
+        },
+        _bindCollapseAll: function(){
+            $(document).on("click", "[collapse]", function(){
+                $(this).closest(".panel-body").find(".details").hide();
+            });
+        },
+        _togglePanelHeaderIcons: function(){
+            $(document).on("click", ".panel-title", function(){
+                var $icon = $(this).find(".glyphicon");
+                $icon.toggleClass("glyphicon-menu-down");
+                $icon.toggleClass("glyphicon-menu-up");
+            });
+        },
+        _viewRules: function(){
+            $(document).on("click", "#rulesTab", CukeSniffer.view._updateRowColors);
+        },
+        _clickRow: function(){
+            $(document).on("click", ".rule", function(){
+                var $details = $(this).find(".details");
+                $details.toggle();
+            });
+            $(document).on("click", ".rule :checkbox", function(event){
+                event.stopPropagation();
+            });
+        },
+        _ruleFilters: function(){
+            $(document).on("click", "#ruleFilters .btn", function(){
+                var $clickedCheckbox = $(this).find(":checkbox");
+                $(".rule").hide().removeClass("blueRow");
+                $("#ruleFilters .btn").each(function(index, button){
+                    var $checkbox = $(button).find(":checkbox"),
+                        filterName = $checkbox.data("rule-type"),
+                    //hate this hack.
+                        checked = ($clickedCheckbox[0] == $checkbox[0]) ? !$checkbox.is(":checked") : $checkbox.is(":checked");
+                    if(checked){
+                        $("[rule-" + filterName + "]").show();
+                    }
+                });
+                CukeSniffer.view._updateRowColors();
+            });
+        },
+        toggleDetails: function(){
+            $(document).on("click", ".deadStep > .row > .title," +
+                " .feature > .row > .title, " +
+                ".stepDefinition > .row > .title, " +
+                ".hook .title", CukeSniffer.view.toggleDetails);
+        },
+        enableAllRules: function(){
+            $(document).on("click", "#enableAllRules", function(){
+                $(".rule input[type='checkbox']:not(:checked)").click();
+            });
+        },
+        disableAllRules: function(){
+            $(document).on("click", "#disableAllRules", function(){
+                $(".rule input[type='checkbox']:checked").click();
+            });
+        },
+        changeRuleStatus: function(){
+            $(document).on("click", ".rule input[type='checkbox']", function(){
+                var enabled = $(this).is(":checked"),
+                    $rule = $(this).closest(".rule"),
+                    phrase = $rule.find("[data-phrase]").html(),
+                    symbol = $rule.data("rule-symbol"),
+                    improvementPhraseList = [];
+                if(enabled){
+                    localStorage.removeItem(symbol);
+                } else {
+                    localStorage.setItem(symbol, true);
+                }
+                if(phrase.indexOf("{class}") != -1) {
+                    var targets = $(this).closest(".rule").find("[data-targets]").html().trim().split(", ");
+                    if(targets.indexOf("Scenario") != -1){
+                        targets.push("Scenario Outline");
+                    }
+                    $.each(targets, function (n, target) {
+                        improvementPhraseList.push(phrase.replace("{class}", target))
+                    });
+                } else if(phrase.indexOf("{word}") != -1){
+                    var targets = $(this).closest(".rule").find("[data-conditions]").html().trim().replace("[", "").replace("]", "").replace(/\"/g, "").split(", ");
+                    $.each(targets, function (n, target) {
+                        improvementPhraseList.push(phrase.replace("{word}", target))
+                    });
+                } else {
+                    improvementPhraseList.push(phrase)
+                }
+                (enabled) ? CukeSniffer.actions._enableRule(improvementPhraseList) : CukeSniffer.actions._disableRule(improvementPhraseList);
+            });
+        },
+        _enableRule: function(improvementPhraseList){
+            $.each(improvementPhraseList, function(n, phrase){
+                var $all = $("[data-improvement-row]:has([data-improvement='" + phrase +"'])");
+                $all.show();
+                $all.attr("show", true);
+            });
+            CukeSniffer.view._updateVisibleItems();
+        },
+        _disableRule: function(improvementPhraseList){
+            $.each(improvementPhraseList, function(n, phrase){
+                var $all = $("[data-improvement-row]:has([data-improvement='" + phrase +"'])");
+                $all.hide();
+                $all.removeAttr("show");
+            });
+            CukeSniffer.view._updateVisibleItems();
+        }
+    }
+};

data/lib/cuke_sniffer/report/css.html.erb

@@ -1,133 +1,123 @@
-<link rel="stylesheet" type="text/css">
-
-<style>
-    .new_sub_section {
-        border: 2px solid #509f50;
-        padding: 2px;
-        display: none;
-        overflow:auto;
-    }
-
-    .title {
-        padding-left: 1%;
-        width: 25%;
-        background-color: #509f50;
-        color: white;
-        border-top: 0;
-        border-bottom: 0;
-        font-weight: bold;
-        font-size: 21pt;
-        cursor: pointer;
-        font-family: Arial;
-        border-top-left-radius: 15px;
-        border-top-right-radius: 15px;
-    }
-
-    .function_bar {
-        background-color: #509f50;
-        display: none;
-    }
-
-    .help {
-        cursor: hand;
-    }
-
-    .disabled_title_row {
-        background-color:#aca8a5;
-        cursor: hand;
-        padding-left: 2px;
-    }
-
-    .white_title_row {
-        cursor: hand;
-        padding-left: 2px;
-    }
-
-    .blue_title_row {
-        background-color:#ccffff;
-        cursor: hand;
-        padding-left: 2px;
-    }
-
-    .white_row {
-        padding-left: 2px;
-    }
-
-    .blue_row {
-        background-color:#ccffff;
-        padding-left: 2px;
-    }
-
-    .colored_subsection {
-        width:100%;
-        padding-left: 8px;
-    }
-
-    .shrink_section {
-        border: 2px solid #509f50;
-        display: none;
-    }
-
-    .table_top {
-        width: 20%;
-        font-size: 14pt;
-        padding: 0;
-    }
-
-    .divide_row {
-        border-bottom: 1px solid black;
-    }
-
-    .red_number {
-        color: red;
-        font-weight: bold;
-        display: inline;
-    }
-
-    .notes {
-        font-weight: bold;
-    }
-
-    .sub_section {
-        display: none;
-        margin-left: 1%;
-        margin-right: 1%;
-        border-top: 2px solid #509f50;
-    }
-
-    .empty_set_message {
-        font-weight: bold;
-        margin-left: 1%;
-    }
-
-    .rule_notes {
-        margin-left: 1%;
-        border-left: 2px solid #90ee90;
-        border-top: 2px solid #90ee90;
-        display: block;
-        clear: left;
-        padding-bottom: 0%;
-        text-indent: 0%;
-        padding-left: 0.5%;
-        margin-bottom: 0.5%;
-    }
-
-    .rule_style {
-        margin: 0;
-        text_indent: 3%;
-
-    }
-
-    .rule_heading {
-        font-weight: bold;
-        margin: 0.25%;
-    }
-
-    ol {
-        list-style-type: none;
-        display: block;
-        padding-left: 1%
-
-    }
-
+<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous">
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-XdYbMnZ/QjLh6iI4ogqCTaIjrFk87ip+ekIjefZch0Y+PvJ8CDYtEs1ipDmPorQ+" crossorigin="anonymous">
+
+<style>
+
+    h1 small {
+        font-size: 16px;
+    }
+    .panel-default {
+        border-color: #509f50;
+    }
+
+    .panel-default>.panel-heading {
+        background-color: #509f50;
+        border-color: #3a753a;
+        color: white;
+    }
+
+
+    .table-striped>tbody>tr:nth-of-type(odd),
+    .improvement:nth-of-type(odd),
+    .blueRow {
+        background-color: #ccffff;
+    }
+
+    .glyphicon-question-sign:before {
+        color: #509f50;
+    }
+
+    .small {
+        display: none;
+    }
+
+    .panel-body {
+        padding:0px;
+    }
+
+    .panel-body>div>div {
+        padding: 8px;
+        font-size: 16px;
+        font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
+    }
+
+    .red {
+        color: rgba(208, 33, 33, 0.73);
+    }
+
+    .black {
+        color: black;
+    }
+
+    .button-bar {
+        padding: 10px;
+    }
+
+    .button-bar .btn {
+        margin-top: 10px;
+        margin-bottom: 10px
+    }
+    
+    .button-bar .btn-group {
+        margin-left: 10px;
+    }
+
+    .rule, .deadStep, .feature,
+    .stepDefinition, .hook {
+        cursor: pointer;
+    }
+
+    .details .well{
+        margin-bottom: 0px;
+        cursor: default;
+    }
+
+    .scenario > .title {
+        margin-top: 15px;
+    }
+
+    .well .well {
+        background-color: white;
+    }
+
+    .table.collapse.in {
+        display: inline-table;
+    }
+
+    .panel-heading {
+        cursor: pointer;
+    }
+
+    .filename {
+        text-overflow: ellipsis;
+        white-space: nowrap;
+        overflow: hidden;
+    }
+
+    .small-page {
+        display: none;
+    }
+
+    @media screen and (max-width: 993px){
+        #ruleFilters {
+            padding-left: 10px;
+        }
+    }
+
+    @media screen and (max-width: 480px){
+        .full-page {
+            display: none;
+        }
+        .small-page {
+            display: inline;
+        }
+
+        #rules_data .enable-bar {
+            padding-left: 10px;
+        }
+
+        .ruleFilters .small-page {
+            font-size: 20px;
+        }
+    }
 </style>

data/lib/cuke_sniffer/report/dead_steps.html.erb

@@ -1,63 +1,63 @@
-<div class="title" onclick="toggleById('dead_steps_data', this); updateDisplayStatus(document.getElementById('dead_steps_function_bar'));updateDivScroll('dead_steps_data', 'dead_steps_table');">
-  Dead Steps +
-</div>
-<div id="dead_steps_function_bar" class="function_bar">
-  <input type="button" class="function_button" value="Collapse All" onclick="collapseAll('dead_step_detail')" />
-  <input type="button" class="function_button" value="Expand All" onclick="expandAllShiftingRows('dead_step_detail')" />
-</div>
-<div class="new_sub_section" id="dead_steps_data">
-  <% dead_steps = cuke_sniffer.get_dead_steps %>
-  <% dead_steps.delete(:total) %>
-  <% dead_step_count = dead_steps.values.flatten.count %>
-  <% if !cuke_sniffer.cataloged? %>
-      <div class="notes">Steps were not cataloged.</div>
-  <% elsif dead_step_count == 0 %>
-      <div class="notes">No dead steps found!</div>
-  <% elsif dead_step_count == 1 %>
-      <div class="notes"><%= dead_step_count %> Dead Step found.</div>
-  <% else %>
-      <div class="notes"><%= dead_step_count %> Dead Steps found.</div>
-  <% end %>
-  <% unless dead_steps.empty? or !cuke_sniffer.cataloged? %>
-      <table id="dead_steps_table" style="width:100%; border-top: 2px solid #509f50" border="0" cellspacing="0">
-        <% index = 0 %>
-        <% dead_steps.each_key do |file_name| %>
-            <% if index.odd? %>
-                <tr class="notes blue_title_row" onclick="updateDisplayStatus(document.getElementById('dead_step_file_detail_<%=index%>')); updateDivScroll('dead_steps_data', 'dead_steps_table');">
+<div class="row">
+    <div class="panel panel-default">
+        <div class="panel-heading panel-title" data-toggle="collapse" data-target="#deadSteps" >
+          Dead Steps <span class="glyphicon glyphicon-menu-down"></span>
+        </div>
+        <div id="deadSteps" class="panel-body collapse">
+          <span class="button-bar">
+            <%= build_page(cuke_sniffer, "expand_and_collapse_buttons.html.erb") %>
+          </span>
+          <div>
+            <% dead_steps = cuke_sniffer.get_dead_steps %>
+            <% dead_steps.delete(:total) %>
+            <% dead_step_count = dead_steps.values.flatten.count %>
+            <% if !cuke_sniffer.cataloged? %>
+                <div class="notes">Steps were not cataloged.</div>
+            <% elsif dead_step_count == 0 %>
+                <div class="notes">No dead steps found!</div>
+            <% elsif dead_step_count == 1 %>
+                <div class="notes"><%= dead_step_count %> Dead Step found.</div>
             <% else %>
-                <tr class="notes white_title_row" onclick="updateDisplayStatus(document.getElementById('dead_step_file_detail_<%=index%>')); updateDivScroll('dead_steps_data', 'dead_steps_table');">
+                <div class="notes"><%= dead_step_count %> Dead Steps found.</div>
             <% end %>
-              <td class="red_number" style="width: 1%"><%= dead_steps[file_name].size %></td>
-              <td id="dead_step_file_<%= index %>">
-                <%= file_name.gsub(cuke_sniffer.step_definitions_location, "") %>
-              </td>
-              <td style="text-align: right; width:5%" valign="top">
-                <a href="file:///<%= file_name.gsub(/:\d+$/, "") %>.rb" title="Note: Links to file on system this report was generated.">
-                  (open file)
-                </a>
-              </td>
-            </tr>
-
-            <% if index.odd? %>
-                <tr class="blue_row dead_step_detail" id="dead_step_file_detail_<%= index %>" style="display: none;">
-            <% else %>
-                <tr class="white_row dead_step_detail" id="dead_step_file_detail_<%= index %>" style="display: none;">
-            <% end %>
-              <td colspan="3">
-                <table id="sub_detail_table_<%= index %>" style="width:100%;">
-                  <% dead_steps[file_name].each do |regex| %>
-                      <tr>
-                        <td style="text-indent: 8px;"><%= regex.match(/:(?<regex>.*)/)[:regex] %></td>
-                        <td style="text-align: right;">Line: <%= regex.match(/(?<line>\d+):/)[:line] %></td>
-                      </tr>
-                  <% end %>
-                </table>
-              </td>
-            </tr>
-
-            <% index += 1 %>
-        <% end %>
-      </table>
-  <% end %>
-</div>
-<br style="clear:both">
+          </div>
+          <% unless dead_steps.empty? or !cuke_sniffer.cataloged? %>
+              <% dead_steps.each_key do |file_name| %>
+                <div class="deadStep">
+                  <div class="row">
+                    <div class="title col-md-12">
+                        <div class="col-md-1">
+                          <span class="red" title="Total dead steps in file.">
+                            <%= dead_steps[file_name].size %>
+                          </span>
+                        </div>
+                        <div class="col-md-11 filename">
+                          <%= file_name.gsub(cuke_sniffer.step_definitions_location, "").gsub(cuke_sniffer.step_definitions_location, "") %>.rb
+                        </div>
+                    </div>
+                    <div class="details col-md-12" style="display:none;">
+                      <div class="well">
+                        <div class="row">
+                          <div class="col-md-12 filename">
+                            File: <a target="_blank" href="file:///<%= file_name %>.rb" title="Note: Links to file on system this report was generated.">
+                            <%= file_name.gsub(cuke_sniffer.step_definitions_location, "").gsub(cuke_sniffer.step_definitions_location, "") %>.rb
+                          </a>
+                          </div>
+                            <% dead_steps[file_name].each do |regex| %>
+                                <div class="col-md-11">
+                                  <%= regex.match(/:(?<regex>.*)/)[:regex] %>
+                                </div>
+                                <div class="col-md-1">
+                                  Line: <%= regex.match(/(?<line>\d+):/)[:line] %>
+                                </div>
+                            <% end %>
+                        </div>
+                      </div>
+                    </div>
+                  </div>
+                </div>
+              <% end %>
+          <% end %>
+        </div>
+    </div>
+</div>