cuke_sniffer 0.0.8 → 1.0.0

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

@@ -1,96 +1,131 @@
-<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="padding-left:2px; width: 100%;" class="notes" border="0" cellspacing="0">
-    <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 class="blue_row">
-      <td>
-        Total Score
-        <a title="Total Points for a section." class="help">(?)</a>
-      </td>
-      <% data_symbols.each do |symbol| %>
-          <td>
-            <%= cuke_sniffer.summary[symbol][:total_score] %>
-          </td>
-      <% end %>
-    </tr>
-    <tr>
-      <td>
-        Count
-        <a title="Total Number of objects found in the project." class="help" class="help">(?)</a>
-      </td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:total].inspect %></td>
-      <% end %>
-    </tr>
-    <tr/>
-    <tr class="blue_row">
-      <td>
-        Lowest Score
-        <a title="Score of the best object found." class="help">(?)</a>
-      </td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:min] %></td>
-      <% end %>
-    </tr>
-    <tr>
-      <td>
-        Highest Score
-        <a title="Score of the object with the most to improve on." class="help">(?)</a>
-      </td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:max] %></td>
-      <% end %>
-    </tr>
-    <tr class="blue_row">
-      <td>
-        Average Score
-        <a title="Average score of a section." class="help">(?)</a>
-      </td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:average] %></td>
-      <% end %>
-    </tr>
-    <tr/>
-    <tr>
-      <td>
-        Threshold
-        <a title="The maximum score an object can have to be considered good." class="help">(?)</a>
-      </td>
-      <% data_symbols.each do |symbol| %>
-          <td><%= cuke_sniffer.summary[symbol][:threshold] %></td>
-      <% end %>
-    </tr>
-    <tr class="blue_row">
-      <td>
-        Good
-        <a title="Percentage of the objects that can be considered good in the project." class="help">(?)</a>
-      </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
-        <a title="Percentage of the objects that can be considered bad in the project." class="help">(?)</a>
-      </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="row">
+  <div id="summaryPanel" class="panel panel-default">
+    <div class="panel-heading panel-title" data-toggle="collapse" data-target="#summaryTable">
+      Summary <span class="glyphicon glyphicon-menu-up"></span>
+    </div>
+    <% data_symbols = [:features, :scenarios, :step_definitions, :hooks] %>
+    <table id="summaryTable" class="table table-responsive table-striped collapse in">
+      <tr>
+        <td></td>
+        <td>
+          <span class="full-page">Features</span>
+          <span class="small-page" title="Features">F</span>
+        </td>
+        <td>
+          <span class="full-page">Scenarios</span>
+          <span class="small-page" title="Scenarios">S</span>
+        </td>
+        <td>
+          <span class="full-page">Step Definitions</span>
+          <span class="small-page" title="Step Definitions">S.D.</span>
+        </td>
+        <td>
+          <span class="full-page">Hooks</span>
+          <span class="small-page" title="Hooks">H</span>
+        </td>
+      </tr>
+      <tr>
+        <td>
+          Total Score
+          <span title="Total Points for a section." class="glyphicon glyphicon-question-sign"
+                data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td>
+              <%= cuke_sniffer.summary[symbol][:total_score] %>
+            </td>
+        <% end %>
+      </tr>
+      <tr>
+        <td>
+          Count
+          <span title="Total Number of objects found in the project." class="glyphicon glyphicon-question-sign"
+                data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td><%= cuke_sniffer.summary[symbol][:total].inspect %></td>
+        <% end %>
+      </tr>
+      <tr>
+        <td>
+          Lowest Score
+          <span title="Score of the best object found." class="glyphicon glyphicon-question-sign"
+                data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td><%= cuke_sniffer.summary[symbol][:min] %></td>
+        <% end %>
+      </tr>
+      <tr>
+        <td>
+          Highest Score
+          <span title="Score of the object with the most to improve on." class="glyphicon glyphicon-question-sign"
+                data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td><%= cuke_sniffer.summary[symbol][:max] %></td>
+        <% end %>
+      </tr>
+      <tr>
+        <td>
+          Average Score
+          <span title="Average score of a section." class="glyphicon glyphicon-question-sign"
+                data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td>
+              <% if cuke_sniffer.summary[symbol][:average].nan?%>
+                  0
+              <% else %>
+                  <%= cuke_sniffer.summary[symbol][:average] %>
+              <% end %>
+            </td>
+        <% end %>
+      </tr>
+      <tr>
+        <td>
+          Threshold
+          <span title="The maximum score an object can have to be considered good." class="glyphicon glyphicon-question-sign"
+                data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td><%= cuke_sniffer.summary[symbol][:threshold] %></td>
+        <% end %>
+      </tr>
+      <tr>
+        <td>
+          Good
+          <span title="Percentage of the objects that can be considered good in the project."
+                class="glyphicon glyphicon-question-sign" data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td>
+              <% if cuke_sniffer.summary[symbol][:good] == 0 %>
+                0
+              <% else %>
+                <%= ((cuke_sniffer.summary[symbol][:good].to_f/cuke_sniffer.summary[symbol][:total].to_f) * 100).round(2) %>
+              <% end %>
+              %
+            </td>
+        <% end %>
+      </tr>
+      <tr>
+        <td>
+          Bad
+          <span title="Percentage of the objects that can be considered bad in the project."
+                class="glyphicon glyphicon-question-sign" data-toggle="tooltip" data-placement="right"></span>
+        </td>
+        <% data_symbols.each do |symbol| %>
+            <td>
+              <% if cuke_sniffer.summary[symbol][:bad] == 0 %>
+                  0
+              <% else %>
+                  <%= ((cuke_sniffer.summary[symbol][:bad].to_f/cuke_sniffer.summary[symbol][:total].to_f) * 100).round(2) %>
+              <% end %>
+              %
+            </td>
+        <% end %>
+      </tr>
+    </table>
+  </div>
+</div>

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

@@ -1,9 +1,13 @@
-<div style="font-family: Arial; float: left; color: #509f50; font-size: 20px; font-weight: bold; padding-bottom: 1px;">
-  Cuke Sniffer
-</div>
-<br style="clear:both">
-<div style="border-top: 2px solid #509f50; text-align: right;">
-  <div style="font-family: Arial;border-bottom-left-radius: 15px; border-bottom-right-radius: 15px;float: right; background-color:#509f50; color:white;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="row">
+  <div class="page-header">
+    <h1>
+      Cuke Sniffer <a class="black" target="_blank" href="https://github.com/r-cochran/cuke_sniffer"><span class="fa fa-github"></span></a>
+      <% if Gem.loaded_specs["cuke_sniffer"] %>
+        <small><%= Gem.loaded_specs["cuke_sniffer"].version %></small>
+      <% end %>
+    </h1>
+    <div>Score:
+      <span class="score"><%= cuke_sniffer.summary[:total_score] %></span>
+    </div>
+  </div>
+</div>

data/lib/cuke_sniffer/rule.rb

@@ -7,6 +7,7 @@ module CukeSniffer
   # Mixins: ROXML
   class Rule
     include ROXML
+    xml_accessor :symbol
     xml_accessor :enabled
     xml_accessor :phrase
     xml_accessor :score

data/lib/cuke_sniffer/rule_config.rb

@@ -275,12 +275,12 @@ module CukeSniffer
         },
         :feature_same_tag => {
             :enabled => true,
-            :phrase => "Same tag appears on Feature.",
+            :phrase => "Same tag appears on both Feature and Scenario",
             :score => WARNING,
             :targets => ["Feature"],
             :reason => lambda { |feature, rule| if(feature.scenarios.count >= 2)
                           feature.scenarios[1..-1].each do |scenario|
-                            feature.scenarios.first.tags.each do |tag|
+                            feature.tags.each do |tag|
                               feature.store_rule(rule) if scenario.tags.include?(tag)
                             end
                           end

data/lib/cuke_sniffer/rules_evaluator.rb

@@ -29,8 +29,7 @@ module CukeSniffer
       judge_object(feature, "Feature")
       judge_object(feature.background, "Background") unless feature.background.nil?
       judge_objects(feature.scenarios, "Scenario")
-      feature.total_score += feature.update_score
-
+      feature.update_score
     end
 
     def judge_objects(objects, type)

data/lib/cuke_sniffer/scenario.rb

@@ -83,41 +83,85 @@ module CukeSniffer
     private
 
     def split_scenario(scenario)
+      ranges = define_ranges(scenario)
+      split_tag_list(ranges[:tags])
+      split_name_and_type(ranges[:name].join(" "))
+      split_scenario_body(ranges[:body])
+      split_examples(ranges[:examples]) unless ranges[:examples].nil?
+    end
+
+    def define_ranges(scenario)
+      ranges = {}
       index = 0
-      until index >= scenario.length or scenario[index] =~ SCENARIO_TITLE_STYLES
-        update_tag_list(scenario[index])
-        index += 1
+      index += 1 until index >= scenario.length or scenario[index] =~ SCENARIO_TITLE_STYLES
+      ranges[:tags] = scenario[0...index]
+
+      start_index = index
+      index += 1 until index >= scenario.length or scenario[index].match STEP_REGEX or scenario[index].include?("Examples:")
+      ranges[:name] = scenario[start_index...index]
+
+      start_index = index
+      index += 1 until index >= scenario.length or scenario[index].include?("Examples:")
+      ranges[:body] = scenario[start_index...index]
+
+      ranges[:examples] = scenario[index + 1..scenario.size] if index < scenario.length and scenario[index].include?("Examples:")
+      ranges
+    end
+
+    def split_tag_list(list_of_tag_lines)
+      list_of_tag_lines.each do |line|
+        update_tag_list(line)
       end
+    end
 
-      until index >= scenario.length or scenario[index].match STEP_REGEX or scenario[index].include?("Examples:")
-        match = scenario[index].match(SCENARIO_TITLE_STYLES)
-        @type = match[:type] unless match.nil?
-        create_name(scenario[index], SCENARIO_TITLE_STYLES)
-        index += 1
+    def split_name_and_type(name_section)
+      match = name_section.match(SCENARIO_TITLE_STYLES)
+      @type = match[:type] unless match.nil?
+      create_name(name_section, SCENARIO_TITLE_STYLES)
+    end
+
+    def split_scenario_body(scenario_body)
+      extract_steps(scenario_body)
+      extract_inline_tables(scenario_body)
+    end
+
+    def extract_steps(scenario_body)
+      scenario_body.each do |line|
+        next if line =~ /^\|.*\|/ or line.empty? or line.match(STEP_REGEX).nil?
+        @steps << line
       end
+    end
 
-      until index >= scenario.length or scenario[index].include?("Examples:")
-        if scenario[index] =~ /^\|.*\|/
-          step = scenario[index - 1]
-          @inline_tables[step] = []
-          until index >= scenario.length or scenario[index] =~ /(#{STEP_REGEX}|^\s*Examples:)/
-            @inline_tables[step] << scenario[index]
+    def extract_inline_tables(scenario_body)
+      index = 0
+      while index < scenario_body.size
+        if scenario_body[index] =~ /^\|.*\|/
+          start_index = index
+          while index < scenario_body.size and scenario_body[index] =~ /^\|.*\|/
             index += 1
           end
-        else
-          @steps << scenario[index] if scenario[index] =~ STEP_REGEX
-          index += 1
+          @inline_tables[scenario_body[start_index-1]] = scenario_body[start_index..index]
         end
+        index += 1
       end
+    end
 
-      if index < scenario.length and scenario[index].include?("Examples:")
+    def split_examples(examples_section)
+      remove_examples_declaration(examples_section).each do |line|
+        next if line.include?("Examples:")
+        @examples_table << line if line =~ /#{COMMENT_REGEX}\|.*\|/
+      end
+    end
+
+    def remove_examples_declaration(examples_section)
+      return_section = []
+      index = 0
+      while index < examples_section.size
+        index += 2 if(examples_section[index].include?("Examples:"))
+        return_section << examples_section[index]
         index += 1
-        until index >= scenario.length
-          index += 2 if scenario[index].include?("Examples:")
-          @examples_table << scenario[index] if scenario[index] =~ /#{COMMENT_REGEX}\|.*\|/
-          index += 1
-        end
       end
+      return_section
     end
   end
 end

data/lib/cuke_sniffer/summary_helper.rb

@@ -1,91 +1,91 @@
-module CukeSniffer
-  # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
-  # Copyright:: Copyright (C) 2014 Robert Cochran
-  # License::   Distributes under the MIT License
-  # Mixins: CukeSniffer::Constants
-  # A static class used to help with handling summary data for CukeSniffer::CLI
-  class SummaryHelper
-    include CukeSniffer::Constants
-
-    # Sorts the list of improvements in descending order of times found.
-    def self.sort_improvement_list(improvement_list)
-      sorted_array = improvement_list.sort_by { |improvement, occurrence| occurrence }.reverse
-      sorted_improvement_list = {}
-      sorted_array.each { |node|
-        sorted_improvement_list[node[0]] = node[1]
-      }
-      sorted_improvement_list
-    end
-
-    # Builds a default assessment hash.
-    def self.make_assessment_hash
-      {
-          :total => 0,
-          :total_score => 0,
-          :min => nil,
-          :min_file => nil,
-          :max => nil,
-          :max_file => nil,
-          :average => 0,
-          :threshold => nil,
-          :good => 0,
-          :bad => 0,
-          :improvement_list => {}
-      }
-    end
-
-    # Initializes an assessment hash for the rule target list
-    def self.initialize_assessment_hash(rule_target_list, type)
-      assessment_hash = make_assessment_hash
-      assessment_hash[:total] = rule_target_list.count
-      assessment_hash[:threshold] = THRESHOLDS[type]
-
-      unless rule_target_list.empty?
-        score = rule_target_list.first.score
-        location = rule_target_list.first.location
-        assessment_hash[:min] = score
-        assessment_hash[:min_file] = location
-        assessment_hash[:max] = score
-        assessment_hash[:max_file] = location
-      end
-      assessment_hash
-    end
-
-    # Returns a summary hash for the rule_target_list
-    def self.assess_rule_target_list(rule_target_list, type)
-      assessment_hash = initialize_assessment_hash(rule_target_list, type)
-      rule_target_list.each do |rule_target|
-        score = rule_target.score
-        assessment_hash[:total_score] += score
-        assessment_hash[rule_target.good? ? :good : :bad] += 1
-        if score < assessment_hash[:min]
-          assessment_hash[:min] = score
-          assessment_hash[:min_file] = rule_target.location
-        end
-        if score > assessment_hash[:max]
-          assessment_hash[:max] = score
-          assessment_hash[:max_file] = rule_target.location
-        end
-        rule_target.rules_hash.each_key do |key|
-          assessment_hash[:improvement_list][key] ||= 0
-          assessment_hash[:improvement_list][key] += rule_target.rules_hash[key]
-        end
-      end
-      assessment_hash[:average] = (assessment_hash[:total_score].to_f/rule_target_list.count.to_f).round(2)
-      assessment_hash
-    end
-
-    # Returns a CukeSniffer::SummaryNode object for the passed hash
-    def self.load_summary_data(summary_hash)
-      summary_node = SummaryNode.new
-      summary_node.count = summary_hash[:total]
-      summary_node.score = summary_hash[:total_score]
-      summary_node.average = summary_hash[:average]
-      summary_node.threshold = summary_hash[:threshold]
-      summary_node.good = summary_hash[:good]
-      summary_node.bad = summary_hash[:bad]
-      summary_node
-    end
-
-  end
+module CukeSniffer
+  # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
+  # Copyright:: Copyright (C) 2014 Robert Cochran
+  # License::   Distributes under the MIT License
+  # Mixins: CukeSniffer::Constants
+  # A static class used to help with handling summary data for CukeSniffer::CLI
+  class SummaryHelper
+    include CukeSniffer::Constants
+
+    # Sorts the list of improvements in descending order of times found.
+    def self.sort_improvement_list(improvement_list)
+      sorted_array = improvement_list.sort_by { |improvement, occurrence| occurrence }.reverse
+      sorted_improvement_list = {}
+      sorted_array.each { |node|
+        sorted_improvement_list[node[0]] = node[1]
+      }
+      sorted_improvement_list
+    end
+
+    # Builds a default assessment hash.
+    def self.make_assessment_hash
+      {
+          :total => 0,
+          :total_score => 0,
+          :min => nil,
+          :min_file => nil,
+          :max => nil,
+          :max_file => nil,
+          :average => 0,
+          :threshold => nil,
+          :good => 0,
+          :bad => 0,
+          :improvement_list => {}
+      }
+    end
+
+    # Initializes an assessment hash for the rule target list
+    def self.initialize_assessment_hash(rule_target_list, type)
+      assessment_hash = make_assessment_hash
+      assessment_hash[:total] = rule_target_list.count
+      assessment_hash[:threshold] = THRESHOLDS[type]
+
+      unless rule_target_list.empty?
+        score = rule_target_list.first.score
+        location = rule_target_list.first.location
+        assessment_hash[:min] = score
+        assessment_hash[:min_file] = location
+        assessment_hash[:max] = score
+        assessment_hash[:max_file] = location
+      end
+      assessment_hash
+    end
+
+    # Returns a summary hash for the rule_target_list
+    def self.assess_rule_target_list(rule_target_list, type)
+      assessment_hash = initialize_assessment_hash(rule_target_list, type)
+      rule_target_list.each do |rule_target|
+        score = rule_target.score
+        assessment_hash[:total_score] += score
+        assessment_hash[rule_target.good? ? :good : :bad] += 1
+        if score < assessment_hash[:min]
+          assessment_hash[:min] = score
+          assessment_hash[:min_file] = rule_target.location
+        end
+        if score > assessment_hash[:max]
+          assessment_hash[:max] = score
+          assessment_hash[:max_file] = rule_target.location
+        end
+        rule_target.rules_hash.each_key do |key|
+          assessment_hash[:improvement_list][key] ||= 0
+          assessment_hash[:improvement_list][key] += rule_target.rules_hash[key]
+        end
+      end
+      assessment_hash[:average] = (assessment_hash[:total_score].to_f/rule_target_list.count.to_f).round(2)
+      assessment_hash
+    end
+
+    # Returns a CukeSniffer::SummaryNode object for the passed hash
+    def self.load_summary_data(summary_hash)
+      summary_node = SummaryNode.new
+      summary_node.count = summary_hash[:total]
+      summary_node.score = summary_hash[:total_score]
+      summary_node.average = summary_hash[:average]
+      summary_node.threshold = summary_hash[:threshold]
+      summary_node.good = summary_hash[:good]
+      summary_node.bad = summary_hash[:bad]
+      summary_node
+    end
+
+  end
 end