cuke_sniffer 0.0.1 → 0.0.2

data/lib/cuke_sniffer/rule_config.rb

@@ -1,161 +1,161 @@
-
-
-module CukeSniffer
-  module RuleConfig
-
-    FATAL = 100       #will prevent suite from executing properly
-    ERROR = 25        #will cause problem with debugging
-    WARNING = 10  #readibility/misuse of cucumber
-    INFO = 1            #Small improvements that can be made
-
-    SHARED_RULES = {
-      :too_many_tags => {
-        :enabled => true,
-        :phrase => "{class} has too many tags.",
-        :score => INFO,
-        :max => 8
-      },
-      :no_description => {
-        :enabled => true,
-        :phrase => "{class} has no description.",
-        :score => ERROR,
-      },
-      :numbers_in_description => {
-        :enabled => true,
-        :phrase => "{class} has numbers in the description.",
-        :score => WARNING,
-      },
-      :long_name => {
-        :enabled => true,
-        :phrase => "{class} has a long description.",
-        :score => INFO,
-        :max => 180
-      },
-      :implementation_word => {
-        :enabled => true,
-        :phrase => "Implementation word used: {word}.",
-        :score => INFO,
-        :words => ["page", "site", "url", "button", "drop down", "dropdown", "select list", "click", "text box", "radio button", "check box", "xml", "window", "pop up", "pop-up", "screen"]
-      }
-    }
-
-    FEATURE_RULES = {
-      :background_with_no_scenarios => {
-        :enabled => true,
-        :phrase => "Feature has a background with no scenarios.",
-        :score => WARNING,
-      },
-      :background_with_one_scenario => {
-        :enabled => true,
-        :phrase => "Feature has a background with one scenario.",
-        :score => WARNING,
-      },
-      :no_scenarios => {
-        :enabled => true,
-        :phrase => "Feature with no scenarios.",
-        :score => ERROR,
-      },
-      :too_many_scenarios => {
-        :enabled => true,
-        :phrase => "Feature with too many scenarios.",
-        :score => INFO,
-        :max => 10,
-      },
-    }
-
-    SCENARIO_RULES = {
-      :too_many_steps => {
-        :enabled => true,
-        :phrase => "Scenario with too many steps.",
-        :score => WARNING,
-        :max => 7,
-      },
-      :out_of_order_steps  => {
-        :enabled => true,
-        :phrase => "Scenario steps out of Given/When/Then order.",
-        :score => WARNING,
-      },
-      :invalid_first_step  => {
-        :enabled => true,
-        :phrase => "Invalid first step. Began with And/But.",
-        :score => WARNING,
-      },
-      :asterisk_step => {
-        :enabled => true,
-        :phrase => "Step includes a * instead of Given/When/Then/And/But.",
-        :score => WARNING,
-      },
-      :commented_step => {
-        :enabled => true,
-        :phrase => "Commented step.",
-        :score => ERROR,
-      },
-      :commented_example => {
-        :enabled => true,
-        :phrase => "Commented example.",
-        :score => ERROR,
-      },
-      :no_examples => {
-        :enabled => true,
-        :phrase => "Scenario Outline with no examples.",
-        :score => FATAL,
-      },
-      :one_example => {
-        :enabled => true,
-        :phrase => "Scenario Outline with only one example.",
-        :score => WARNING,
-      },
-      :no_examples_table => {
-        :enabled => true,
-        :phrase => "Scenario Outline with no examples table.",
-        :score => FATAL,
-      },
-      :too_many_examples => {
-        :enabled => true,
-        :phrase => "Scenario Outline with too many examples.",
-        :score => WARNING,
-        :max => 10
-      },
-      :date_used => {
-        :enabled => true,
-        :phrase => "Date used.",
-        :score => INFO,
-      },
-      :no_steps => {
-        :enabled => true,
-        :phrase => "No steps in Scenario.",
-        :score => ERROR,
-      },
-    }
-
-    STEP_DEFINITION_RULES = {
-      :no_code => {
-        :enabled => true,
-        :phrase => "No code in Step Definition.",
-        :score => ERROR,
-      },
-      :too_many_parameters => {
-        :enabled => true,
-        :phrase => "Too many parameters in Step Definition.",
-        :score => WARNING,
-        :max => 4
-      },
-      :nested_step => {
-        :enabled => true,
-        :phrase => "Nested step call.",
-        :score => INFO,
-      },
-      :recursive_nested_step => {
-        :enabled => true,
-        :phrase => "Recursive nested step call.",
-        :score => FATAL,
-      },
-      :commented_code => {
-        :enabled => true,
-        :phrase => "Commented code in Step Definition.",
-        :score => INFO,
-      },
-    }
-
-  end
-end
+
+
+module CukeSniffer
+  module RuleConfig
+
+    FATAL = 100       #will prevent suite from executing properly
+    ERROR = 25        #will cause problem with debugging
+    WARNING = 10      #readibility/misuse of cucumber
+    INFO = 1          #Small improvements that can be made
+
+    SHARED_RULES = {
+      :too_many_tags => {
+        :enabled => true,
+        :phrase => "{class} has too many tags.",
+        :score => INFO,
+        :max => 8
+      },
+      :no_description => {
+        :enabled => true,
+        :phrase => "{class} has no description.",
+        :score => ERROR,
+      },
+      :numbers_in_description => {
+        :enabled => true,
+        :phrase => "{class} has numbers in the description.",
+        :score => WARNING,
+      },
+      :long_name => {
+        :enabled => true,
+        :phrase => "{class} has a long description.",
+        :score => INFO,
+        :max => 180
+      },
+      :implementation_word => {
+        :enabled => true,
+        :phrase => "Implementation word used: {word}.",
+        :score => INFO,
+        :words => ["page", "site", "url", "button", "drop down", "dropdown", "select list", "click", "text box", "radio button", "check box", "xml", "window", "pop up", "pop-up", "screen"]
+      }
+    }
+
+    FEATURE_RULES = {
+      :background_with_no_scenarios => {
+        :enabled => true,
+        :phrase => "Feature has a background with no scenarios.",
+        :score => WARNING,
+      },
+      :background_with_one_scenario => {
+        :enabled => true,
+        :phrase => "Feature has a background with one scenario.",
+        :score => WARNING,
+      },
+      :no_scenarios => {
+        :enabled => true,
+        :phrase => "Feature with no scenarios.",
+        :score => ERROR,
+      },
+      :too_many_scenarios => {
+        :enabled => true,
+        :phrase => "Feature with too many scenarios.",
+        :score => INFO,
+        :max => 10,
+      },
+    }
+
+    SCENARIO_RULES = {
+      :too_many_steps => {
+        :enabled => true,
+        :phrase => "Scenario with too many steps.",
+        :score => WARNING,
+        :max => 7,
+      },
+      :out_of_order_steps  => {
+        :enabled => true,
+        :phrase => "Scenario steps out of Given/When/Then order.",
+        :score => WARNING,
+      },
+      :invalid_first_step  => {
+        :enabled => true,
+        :phrase => "Invalid first step. Began with And/But.",
+        :score => WARNING,
+      },
+      :asterisk_step => {
+        :enabled => true,
+        :phrase => "Step includes a * instead of Given/When/Then/And/But.",
+        :score => WARNING,
+      },
+      :commented_step => {
+        :enabled => true,
+        :phrase => "Commented step.",
+        :score => ERROR,
+      },
+      :commented_example => {
+        :enabled => true,
+        :phrase => "Commented example.",
+        :score => ERROR,
+      },
+      :no_examples => {
+        :enabled => true,
+        :phrase => "Scenario Outline with no examples.",
+        :score => FATAL,
+      },
+      :one_example => {
+        :enabled => true,
+        :phrase => "Scenario Outline with only one example.",
+        :score => WARNING,
+      },
+      :no_examples_table => {
+        :enabled => true,
+        :phrase => "Scenario Outline with no examples table.",
+        :score => FATAL,
+      },
+      :too_many_examples => {
+        :enabled => true,
+        :phrase => "Scenario Outline with too many examples.",
+        :score => WARNING,
+        :max => 10
+      },
+      :date_used => {
+        :enabled => true,
+        :phrase => "Date used.",
+        :score => INFO,
+      },
+      :no_steps => {
+        :enabled => true,
+        :phrase => "No steps in Scenario.",
+        :score => ERROR,
+      },
+    }
+
+    STEP_DEFINITION_RULES = {
+      :no_code => {
+        :enabled => true,
+        :phrase => "No code in Step Definition.",
+        :score => ERROR,
+      },
+      :too_many_parameters => {
+        :enabled => true,
+        :phrase => "Too many parameters in Step Definition.",
+        :score => WARNING,
+        :max => 4
+      },
+      :nested_step => {
+        :enabled => true,
+        :phrase => "Nested step call.",
+        :score => INFO,
+      },
+      :recursive_nested_step => {
+        :enabled => true,
+        :phrase => "Recursive nested step call.",
+        :score => FATAL,
+      },
+      :commented_code => {
+        :enabled => true,
+        :phrase => "Commented code in Step Definition.",
+        :score => INFO,
+      },
+    }
+
+  end
+end

data/lib/cuke_sniffer/rules_evaluator.rb

@@ -1,41 +1,50 @@
-module CukeSniffer
-  class RulesEvaluator
-    attr_accessor :location, :score, :rules_hash
-
-    def initialize(location)
-      @location = location
-      @score = 0
-      @rules_hash = {}
-    end
-
-    def evaluate_score
-    end
-
-    def store_rule(rule)
-      if rule[:enabled]
-        @score += rule[:score]
-        @rules_hash[rule[:phrase]] ||= 0
-        @rules_hash[rule[:phrase]] += 1
-      end
-    end
-
-    def store_updated_rule(rule, phrase)
-      store_rule({:enabled => rule[:enabled], :score => rule[:score], :phrase => phrase})
-    end
-
-
-    def is_comment?(line)
-      if line =~ /^\#.*$/
-        true
-      else
-        false
-      end
-    end
-
-    def == (comparison_object)
-      comparison_object.location == location
-      comparison_object.score == score
-      comparison_object.rules_hash == rules_hash
-    end
-  end
-end
+module CukeSniffer
+  class RulesEvaluator
+    attr_accessor :location, :score, :rules_hash
+
+    def initialize(location)
+      @location = location
+      @score = 0
+      @rules_hash = {}
+      @class_type = self.class.to_s.gsub(/.*::/, "")
+    end
+
+    def evaluate_score
+    end
+
+    def good?
+      score <= Constants::THRESHOLDS[@class_type]
+    end
+
+    def problem_percentage
+      score.to_f / Constants::THRESHOLDS[@class_type].to_f
+    end
+
+    def store_rule(rule)
+      if rule[:enabled]
+        @score += rule[:score]
+        @rules_hash[rule[:phrase]] ||= 0
+        @rules_hash[rule[:phrase]] += 1
+      end
+    end
+
+    def store_updated_rule(rule, phrase)
+      store_rule({:enabled => rule[:enabled], :score => rule[:score], :phrase => phrase})
+    end
+
+
+    def is_comment?(line)
+      if line =~ /^\#.*$/
+        true
+      else
+        false
+      end
+    end
+
+    def == (comparison_object)
+      comparison_object.location == location
+      comparison_object.score == score
+      comparison_object.rules_hash == rules_hash
+    end
+  end
+end

data/lib/cuke_sniffer/scenario.rb

@@ -1,163 +1,164 @@
-require 'cuke_sniffer/constants'
-require 'cuke_sniffer/rule_config'
-
-module CukeSniffer
-  class Scenario < FeatureRulesEvaluator
-    include CukeSniffer::Constants
-    include CukeSniffer::RuleConfig
-    
-    attr_accessor :start_line, :type, :steps, :inline_tables, :examples_table
-
-    def initialize(location, scenario)
-      super(location)
-      @start_line = location.match(/:(?<line>\d*)$/)[:line].to_i
-      @steps = []
-      @inline_tables = {}
-      @examples_table = []
-      split_scenario(scenario)
-      evaluate_score
-    end
-
-    def split_scenario(scenario)
-      index = 0
-      until index >= scenario.length or scenario[index] =~ SCENARIO_TITLE_STYLES
-        update_tag_list(scenario[index])
-        index += 1
-      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
-      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
-            @inline_tables[step] << scenario[index]
-            index += 1
-          end
-          index += 1
-        else
-          @steps << scenario[index] if scenario[index] =~ STEP_REGEX
-          index += 1
-        end
-      end
-
-      if index < scenario.length and scenario[index].include?("Examples:")
-        index += 1
-        until index >= scenario.length
-          @examples_table << scenario[index] unless scenario[index].empty?
-          index += 1
-        end
-      end
-    end
-
-    def ==(comparison_object)
-      super(comparison_object)
-      comparison_object.steps == steps
-      comparison_object.examples_table == examples_table
-    end
-
-    def get_step_order
-      order = []
-      @steps.each { |line|
-        match = line.match(STEP_REGEX)
-        order << match[:style] unless match.nil?
-      }
-      order
-    end
-
-    def evaluate_score
-      super
-      rule_empty_scenario
-      rule_too_many_steps
-      rule_step_order
-      rule_invalid_first_step
-      rule_asterisk_step
-      rule_commented_step
-      rule_implementation_words
-      rule_date_used_in_step
-      evaluate_outline_scores if type == "Scenario Outline"
-    end
-
-    def evaluate_outline_scores
-      rule_no_examples_table
-      rule_no_examples
-      rule_one_example
-      rule_too_many_examples
-      rule_commented_example
-    end
-
-    def rule_empty_scenario
-      store_rule(SCENARIO_RULES[:no_steps]) if @steps.empty?
-    end
-
-    def rule_too_many_steps
-      rule = SCENARIO_RULES[:too_many_steps]
-      store_rule(rule) if @steps.size >= rule[:max]
-    end
-
-    def rule_step_order
-      step_order = get_step_order.uniq
-      %w(But * And).each { |type| step_order.delete(type) }
-      store_rule(SCENARIO_RULES[:out_of_order_steps]) unless step_order == %w(Given When Then) or step_order == %w(When Then)
-    end
-
-    def rule_invalid_first_step
-      first_step = get_step_order.first
-      store_rule(SCENARIO_RULES[:invalid_first_step]) if %w(And But).include?(first_step)
-    end
-
-    def rule_asterisk_step
-      get_step_order.count('*').times { store_rule(SCENARIO_RULES[:asterisk_step]) }
-    end
-
-    def rule_commented_step
-      @steps.each do |step|
-        store_rule(SCENARIO_RULES[:commented_step]) if is_comment?(step)
-      end
-    end
-
-    def rule_implementation_words
-      rule = SHARED_RULES[:implementation_word]
-      @steps.each do |step|
-        rule[:words].each do |word|
-          store_updated_rule(rule, rule[:phrase].gsub(/{.*}/, word)) if step.include?(word)
-        end
-      end
-    end
-
-    def rule_date_used_in_step
-      @steps.each do |step|
-        store_rule(SCENARIO_RULES[:date_used]) if step =~ DATE_REGEX
-      end
-    end
-
-    def rule_no_examples_table
-      store_rule(SCENARIO_RULES[:no_examples_table]) if @examples_table.empty?
-    end
-
-    def rule_no_examples
-      store_rule(SCENARIO_RULES[:no_examples]) if @examples_table.size == 1
-    end
-
-    def rule_one_example
-      store_rule(SCENARIO_RULES[:one_example]) if @examples_table.size == 2 and !is_comment?(@examples_table[1])
-    end
-
-    def rule_too_many_examples
-      store_rule(SCENARIO_RULES[:too_many_examples]) if (@examples_table.size - 1) >= 8
-    end
-
-    def rule_commented_example
-      @examples_table.each do |example|
-        store_rule(SCENARIO_RULES[:commented_example]) if is_comment?(example)
-      end
-    end
-
-  end
-end
+require 'cuke_sniffer/constants'
+require 'cuke_sniffer/rule_config'
+
+module CukeSniffer
+  class Scenario < FeatureRulesEvaluator
+    include CukeSniffer::Constants
+    include CukeSniffer::RuleConfig
+    
+    attr_accessor :start_line, :type, :steps, :inline_tables, :examples_table
+
+    def initialize(location, scenario)
+      super(location)
+      @start_line = location.match(/:(?<line>\d*)$/)[:line].to_i
+      @steps = []
+      @inline_tables = {}
+      @examples_table = []
+      split_scenario(scenario)
+      evaluate_score
+    end
+
+    def split_scenario(scenario)
+      index = 0
+      until index >= scenario.length or scenario[index] =~ SCENARIO_TITLE_STYLES
+        update_tag_list(scenario[index])
+        index += 1
+      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
+      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
+            @inline_tables[step] << scenario[index]
+            index += 1
+          end
+        else
+          @steps << scenario[index] if scenario[index] =~ STEP_REGEX
+          index += 1
+        end
+      end
+
+      if index < scenario.length and scenario[index].include?("Examples:")
+        index += 1
+        until index >= scenario.length
+          @examples_table << scenario[index] unless scenario[index].empty?
+          index += 1
+        end
+      end
+    end
+
+    def ==(comparison_object)
+      super(comparison_object)
+      comparison_object.steps == steps
+      comparison_object.examples_table == examples_table
+    end
+
+    def get_step_order
+      order = []
+      @steps.each { |line|
+        next if is_comment?(line)
+        match = line.match(STEP_REGEX)
+        order << match[:style] unless match.nil?
+      }
+      order
+    end
+
+    def evaluate_score
+      super
+      rule_empty_scenario
+      rule_too_many_steps
+      rule_step_order
+      rule_invalid_first_step
+      rule_asterisk_step
+      rule_commented_step
+      rule_implementation_words
+      rule_date_used_in_step
+      evaluate_outline_scores if type == "Scenario Outline"
+    end
+
+    def evaluate_outline_scores
+      rule_no_examples_table
+      rule_no_examples
+      rule_one_example
+      rule_too_many_examples
+      rule_commented_example
+    end
+
+    def rule_empty_scenario
+      store_rule(SCENARIO_RULES[:no_steps]) if @steps.empty?
+    end
+
+    def rule_too_many_steps
+      rule = SCENARIO_RULES[:too_many_steps]
+      store_rule(rule) if @steps.size >= rule[:max]
+    end
+
+    def rule_step_order
+      step_order = get_step_order.uniq
+      %w(But * And).each { |type| step_order.delete(type) }
+      store_rule(SCENARIO_RULES[:out_of_order_steps]) unless step_order == %w(Given When Then) or step_order == %w(When Then)
+    end
+
+    def rule_invalid_first_step
+      first_step = get_step_order.first
+      store_rule(SCENARIO_RULES[:invalid_first_step]) if %w(And But).include?(first_step)
+    end
+
+    def rule_asterisk_step
+      get_step_order.count('*').times { store_rule(SCENARIO_RULES[:asterisk_step]) }
+    end
+
+    def rule_commented_step
+      @steps.each do |step|
+        store_rule(SCENARIO_RULES[:commented_step]) if is_comment?(step)
+      end
+    end
+
+    def rule_implementation_words
+      rule = SHARED_RULES[:implementation_word]
+      @steps.each do |step|
+        next if is_comment?(step)
+        rule[:words].each do |word|
+          store_updated_rule(rule, rule[:phrase].gsub(/{.*}/, word)) if step.include?(word)
+        end
+      end
+    end
+
+    def rule_date_used_in_step
+      @steps.each do |step|
+        store_rule(SCENARIO_RULES[:date_used]) if step =~ DATE_REGEX
+      end
+    end
+
+    def rule_no_examples_table
+      store_rule(SCENARIO_RULES[:no_examples_table]) if @examples_table.empty?
+    end
+
+    def rule_no_examples
+      store_rule(SCENARIO_RULES[:no_examples]) if @examples_table.size == 1
+    end
+
+    def rule_one_example
+      store_rule(SCENARIO_RULES[:one_example]) if @examples_table.size == 2 and !is_comment?(@examples_table[1])
+    end
+
+    def rule_too_many_examples
+      store_rule(SCENARIO_RULES[:too_many_examples]) if (@examples_table.size - 1) >= 8
+    end
+
+    def rule_commented_example
+      @examples_table.each do |example|
+        store_rule(SCENARIO_RULES[:commented_example]) if is_comment?(example)
+      end
+    end
+
+  end
+end