cuke_sniffer 0.0.5 → 0.0.6

data/lib/cuke_sniffer/summary_node.rb

@@ -0,0 +1,19 @@
+require 'roxml'
+module CukeSniffer
+
+  # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
+  # Copyright:: Copyright (C) 2013 Robert Cochran
+  # License::   Distributes under the MIT License
+  # Single Summary Node object used for passing around results data and serializing out to xml
+  # Mixins: ROXML
+  class SummaryNode
+    include ROXML
+    xml_accessor :score
+    xml_accessor :count
+    xml_accessor :average
+    xml_accessor :good
+    xml_accessor :bad
+    xml_accessor :threshold
+  end # :nodoc:
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuke_sniffer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roxml
@@ -36,20 +36,38 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/cuke_sniffer/report/dead_steps.html.erb
+- lib/cuke_sniffer/report/features.html.erb
+- lib/cuke_sniffer/report/hooks.html.erb
+- lib/cuke_sniffer/report/improvement_list.html.erb
+- lib/cuke_sniffer/report/min_template.html.erb
+- lib/cuke_sniffer/report/standard_template.html.erb
+- lib/cuke_sniffer/report/rules.html.erb
+- lib/cuke_sniffer/report/sub_rules.html.erb
+- lib/cuke_sniffer/report/step_definitions.html.erb
+- lib/cuke_sniffer/report/summary.html.erb
+- lib/cuke_sniffer/report/legend.html.erb
 - lib/cuke_sniffer.rb
 - lib/cuke_sniffer/constants.rb
 - lib/cuke_sniffer/feature.rb
 - lib/cuke_sniffer/feature_rules_evaluator.rb
-- lib/cuke_sniffer/rules_evaluator.rb
+- lib/cuke_sniffer/rule_target.rb
 - lib/cuke_sniffer/rule_config.rb
 - lib/cuke_sniffer/scenario.rb
 - lib/cuke_sniffer/step_definition.rb
-- lib/cuke_sniffer/report/markup.rhtml
+- lib/cuke_sniffer/rule.rb
+- lib/cuke_sniffer/formatter.rb
+- lib/cuke_sniffer/summary_node.rb
+- lib/cuke_sniffer/rules_evaluator.rb
+- lib/cuke_sniffer/cuke_sniffer_helper.rb
+- lib/cuke_sniffer/summary_helper.rb
+- lib/cuke_sniffer/dead_steps_helper.rb
 - lib/cuke_sniffer/cli.rb
 - lib/cuke_sniffer/hook.rb
 - bin/cuke_sniffer
 homepage: https://github.com/r-cochran/cuke_sniffer
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/cuke_sniffer/report/markup.rhtml

@@ -1,353 +0,0 @@
-<script>
-    function toggleById(item, link) {
-        updateDisplayStatus(document.getElementById(item));
-        toggleText(link)
-    }
-    function updateDisplayStatus(object) {
-        object.style.display = (object.style.display == "block") ? 'none' : "block";
-    }
-    function toggleText(link) {
-        var char_result = link.innerHTML.indexOf("+") > -1 ? "-" : "+";
-        link.innerHTML = link.innerHTML.replace(/(\+|\-)/, char_result)
-    }
-</script>
-<style>
-    .title {
-        padding-left: 1%;
-        width: 25%;
-        background-color: green;
-        color: white;
-        border-top: 0;
-        border-bottom: 0;
-        font-weight: bold;
-        font-size: 21pt;
-        cursor: hand;
-    }
-
-    .shrink_section {
-        border: 2px solid #90ee90;
-        display: none;
-    }
-
-    .table_top {
-        width: 20%;
-        font-size: 14pt;
-        padding: 0;
-    }
-
-    .divide_row {
-        border-bottom: 1px solid black;
-    }
-
-    .red_number {
-        width: 3%;
-        color: red;
-        text-indent: 1%;
-        font-weight: bold;
-    }
-
-    .notes {
-        text-indent: 1%;
-        font-weight: bold;
-    }
-
-    .sub_section {
-        display: none;
-        margin-left: 1%;
-        margin-right: 1%;
-        border-top: 2px solid #add8e6;
-    }
-</style>
-
-
-<div style="float: left; color: green; font-size: 20px; font-weight: bold; padding-bottom: 1px;">
-  Cuke Sniffer
-</div>
-<br style="clear:both">
-<div style="border-top: 2px solid lightgreen; text-align: right;">
-  <div style="float: right; background-color:green;border-right:2px solid #fff; color:white;padding:4px; padding-left:40px;font-size:11pt;font-weight:bold;padding-right:10px;">
-    Score: <%= cuke_sniffer.summary[:total_score] %></div>
-</div>
-<br style="clear:both">
-
-<div class="title" onclick="toggleById('summary_data', this)">
-  Summary -
-</div>
-<div class="shrink_section" style="display: block;" id="summary_data">
-  <% data_symbols = [:features, :scenarios, :step_definitions, :hooks] %>
-  <table style="width: 100%;" class="notes">
-    <tr class="divide_row">
-      <td class="table_top"></td>
-      <td class="table_top">Features</td>
-      <td class="table_top">Scenarios</td>
-      <td class="table_top">Step Definitions</td>
-      <td class="table_top">Hooks</td>
-    </tr>
-    <tr>
-      <td>Total Score</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:total_score] %></td>
-      <% end %>
-    </tr>
-    <tr>
-      <td>Count</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:total].inspect %></td>
-      <% end %>
-    </tr>
-    <tr/>
-    <tr>
-      <td>Lowest Score</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:min] %></td>
-      <% end %>
-    </tr>
-    <tr>
-      <td>Highest Score</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:max] %></td>
-      <% end %>
-    </tr>
-    <tr>
-      <td>Average Score</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:average] %></td>
-      <% end %>
-    </tr>
-    <tr/>
-
-    <tr>
-      <td>Threshold</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:threshold] %></td>
-      <% end %>
-    </tr>
-    <tr>
-      <td>Good</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= ((cuke_sniffer.summary[symbol][:good].to_f/cuke_sniffer.summary[symbol][:total].to_f) * 100).round(2) %>
-            %
-          </td>
-      <% end %>
-    </tr>
-    <tr>
-      <td>Bad</td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= ((cuke_sniffer.summary[symbol][:bad].to_f/cuke_sniffer.summary[symbol][:total].to_f) * 100).round(2) %>
-            %
-          </td>
-      <% end %>
-    </tr>
-  </table>
-</div>
-<br style="clear:both">
-
-<div class="title" onclick="toggleById('improvement_list_data', this)">
-  Improvement List +
-</div>
-<div class="shrink_section" id="improvement_list_data">
-  <% if cuke_sniffer.summary[:improvement_list].empty? %>
-      <div class="notes">No Improvements to make!</div>
-  <% end %>
-  <table style="width: 100%">
-    <% cuke_sniffer.summary[:improvement_list].each do |improvement, count| %>
-        <tr>
-          <td class="red_number"><%= count %></td>
-          <td class="notes"><%= improvement %></td>
-        </tr>
-    <% end %>
-  </table>
-</div>
-<br style="clear:both">
-
-<div class="title" onclick="toggleById('dead_steps_data', this)">
-  Dead Steps +
-</div>
-<div class="shrink_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 dead_step_count == 0 %>
-      <div class="notes">No dead steps found!</div>
-  <% elsif dead_step_count == 1 %>
-      <div class="notes" style="color: red"><%= dead_step_count %> Dead Step found.</div>
-  <% else %>
-      <div class="notes" style="color: red"><%= dead_step_count %> Dead Steps found.</div>
-  <% end %>
-
-  <table style="width: 100%">
-    <% dead_steps.each_key do |file_name| %>
-        <tr>
-          <td>
-            <div style="text-indent: 2%;font-weight: bold;"><%= file_name.gsub(cuke_sniffer.step_definitions_location, "") %>
-              .rb
-            </div>
-            <table style="width: 100%; padding-left: 3%;">
-              <% dead_steps[file_name].each do |regex| %>
-                  <tr>
-                    <td style="width: 3%"><%= regex.match(/(?<line>\d+):/)[:line] %></td>
-                    <td><%= regex.match(/:(?<regex>.*)/)[:regex] %></td>
-                  </tr>
-              <% end %>
-            </table>
-          </td>
-        </tr>
-    <% end %>
-  </table>
-</div>
-<br style="clear:both">
-
-<div class="title" onclick="toggleById('features_data', this)">
-  Features +
-</div>
-<div class="shrink_section" id="features_data">
-  <% if cuke_sniffer.features.count == 0 %>
-      <div class="notes">No Feature/Scenario smells!</div>
-  <% end %>
-  <% index = 0 %>
-  <% cuke_sniffer.features.each do |feature| %>
-      <% next if feature.total_score <= 0 %>
-      <div style="cursor: hand; padding-top: 3px" onclick="updateDisplayStatus(document.getElementById('feature_<%=index%>'))">
-        <div class="red_number" style="float:left"><%= feature.total_score + feature.scenarios_score %></div>
-        <div class="notes"><%= feature.name %></div>
-      </div>
-      <div id="feature_<%= index %>" class="sub_section">
-        <div style="text-indent: 4%; float: left; width: 45%; border-right: 2px solid #add8e6; padding-bottom: 4px">
-          <% if feature.rules_hash.empty? %>
-              <pre style="margin: 0;">      </pre>
-          <% end %>
-          <% feature.rules_hash.each_key do |rule| %>
-              <pre style="margin: 0;"><%= rule %></pre>
-          <% end %>
-        </div>
-        <div style="text-indent: 1%; padding-bottom: 4px">
-          <%= feature.location.gsub(cuke_sniffer.features_location, "") %>
-        </div>
-        <br style="clear:both">
-
-        <div>
-          <% unless feature.background.nil? or feature.background.score > 0 %>
-              <div class="red_number" style="float:left; padding-left: 1%"><%= feature.background.score %></div>
-              <div style="float: left; width: 45%;"><%= feature.background.type + ": " + feature.background.name %></div>
-              <div style="margin-left:1%;float: left; border-left: 2px solid #90ee90; border-top: 2px solid #90ee90;text-indent: 1%;">
-                <% feature.background.rules_hash.each_key do |rule| %>
-                    <pre style="margin: 0; text_indent: 3%;"><%= rule %></pre>
-                <% end %>
-              </div>
-              <br style="clear:both">
-          <% end %>
-        </div>
-        <div>
-          <% feature.scenarios.each do |scenario| %>
-              <% next if scenario.score <= 0 %>
-              <div class="red_number" style="float:left; padding-left: 1%"><%= scenario.score %></div>
-              <div style="float: left; width: 45%;"><%= scenario.type + ": " + scenario.name %></div>
-              <div style="margin-left:1%;float: left; border-left: 2px solid #90ee90; border-top: 2px solid #90ee90; text-indent: 1%">
-                <% scenario.rules_hash.each_key do |rule| %>
-                    <pre style="margin: 0; text_indent: 3%;"><%= rule %></pre>
-                <% end %>
-              </div>
-              <br style="clear:both">
-          <% end %>
-        </div>
-      </div>
-      <% index += 1 %>
-  <% end %>
-</div>
-<br style="clear:both">
-
-<div class="title" onclick="toggleById('step_definitions_data', this)">
-  Step Definitions +
-</div>
-<div class="shrink_section" id="step_definitions_data">
-  <% if cuke_sniffer.step_definitions.count == 0 %>
-      <div class="notes">No Step Definition smells!</div>
-  <% end %>
-  <% index = 0 %>
-  <% cuke_sniffer.step_definitions.each do |step_definition| %>
-      <% next if step_definition.score <= 0 %>
-      <div style="cursor: hand; padding-top: 3px" onclick="updateDisplayStatus(document.getElementById('step_definition_<%=index%>'))">
-        <div class="red_number" style="float:left"><%= step_definition.score %></div>
-        <% parameters = "" %>
-        <% step_definition.parameters.each do |param| %>
-            <% if param == step_definition.parameters.first %>
-                <% parameters << "| " %>
-            <% end %>
-            <% parameters << param %>
-
-            <% if param == step_definition.parameters.last %>
-                <% parameters << " |" %>
-            <% else %>
-                <% parameters << ", " %>
-            <% end %>
-        <% end %>
-        <div style="float: left" class="notes"><%= "/" + step_definition.regex.to_s.match(/\(\?\-mix\:(?<regex>.*)\)/)[:regex] + "/ do " + parameters %></div>
-        <div style="float: right; padding-right:1%" class="notes"><%= step_definition.calls.keys.count %> Call(s)</div>
-      </div>
-      <div id="step_definition_<%= index %>" style="display:none;">
-        <br style="clear:both">
-
-        <div class="sub_section" style="display:block">
-          <div style="text-indent: 4%; float: left; width: 45%; border-right: 2px solid #add8e6;">
-            <% step_definition.rules_hash.each_key do |rule| %>
-                <pre style="margin: 0;"><%= rule %></pre>
-            <% end %>
-          </div>
-          <div style="text-indent: 1%">
-            <p style="margin:0"><%= step_definition.location.gsub(cuke_sniffer.step_definitions_location, "") %></p>
-          </div>
-        </div>
-      </div>
-      <br style="clear:both">
-      <% index += 1 %>
-  <% end %>
-</div>
-<br style="clear:both">
-
-<div class="title" onclick="toggleById('hooks_data', this)">
-  Hooks +
-</div>
-<div class="shrink_section" id="hooks_data">
-  <% if cuke_sniffer.hooks.count == 0 %>
-      <div class="notes">No Hook smells!</div>
-  <% end %>
-  <% index = 0 %>
-  <% cuke_sniffer.hooks.each do |hook| %>
-      <% next if hook.score <= 0 %>
-      <div style="cursor: hand; padding-top: 3px" onclick="updateDisplayStatus(document.getElementById('hook_<%=index%>'))">
-        <div class="red_number" style="float:left"><%= hook.score %></div>
-        <% tags = "(" %>
-        <% hook.tags.each do |tag| %>
-            <% tags << tag %>
-            <% tags << ", " unless tag == hook.tags.last %>
-        <% end %>
-        <% tags += ")" %>
-        <% parameters = "| " %>
-        <% hook.parameters.each do |parameter| %>
-            <% parameters << parameter %>
-            <% parameters << ", " unless parameter == hook.parameters.last %>
-        <% end %>
-        <% parameters += " |" %>
-        <% name = hook.type %>
-        <% name += tags unless tags == "()" %>
-        <% name += " do " %>
-        <% name += parameters unless parameters == "|  |" %>
-        <div class="notes"><%= name %></div>
-      </div>
-      <div id="hook_<%= index %>" style="display:none;">
-        <div class="sub_section" style="display:block;">
-          <div style="text-indent: 4%; float: left; width: 45%; border-right: 2px solid #add8e6;">
-            <% hook.rules_hash.each_key do |rule| %>
-                <pre style="margin: 0;"><%= rule %></pre>
-            <% end %>
-          </div>
-          <div style="text-indent: 1%">
-            <%= hook.location.gsub(cuke_sniffer.hooks_location, "") %>
-          </div>
-          <br style="clear:both">
-        </div>
-      </div>
-      <% index += 1 %>
-  <% end %>
-</div>
-<br style="clear:both">