cuke_sniffer 0.0.3 → 0.0.5

data/lib/cuke_sniffer/rule_config.rb

@@ -1,173 +1,256 @@
 module CukeSniffer
+
+  # Contains the rules and various scores used in evaluating objects
   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
+    # Will prevent suite from executing properly
+    FATAL = 100
 
-    RULES = {
-        :too_many_tags => {
+    # Will cause problem with debugging
+    ERROR = 25
+
+    # Readability/misuse of cucumber
+    WARNING = 10
+
+    # Small improvements that can be made
+    INFO = 1
+
+    fatal_rules = {
+        :no_examples => {
             :enabled => true,
-            :phrase => "{class} has too many tags.",
-            :score => INFO,
-            :max => 8
+            :phrase => "Scenario Outline with no examples.",
+            :score => FATAL
         },
+        :no_examples_table => {
+            :enabled => true,
+            :phrase => "Scenario Outline with no examples table.",
+            :score => FATAL
+        },
+        :recursive_nested_step => {
+            :enabled => true,
+            :phrase => "Recursive nested step call.",
+            :score => FATAL
+        },
+        :background_with_tag => {
+            :enabled => true,
+            :phrase => "There is a background with a tag. This feature file cannot run!",
+            :score => FATAL
+        },
+        :comment_after_tag => {
+            :enabled => true,
+            :phrase => "Comment comes between tag and properly executing line. This feature file cannot run!",
+            :score => FATAL
+        }
+    }
+
+    error_rules = {
         :no_description => {
             :enabled => true,
             :phrase => "{class} has no description.",
-            :score => ERROR,
+            :score => ERROR
         },
-        :numbers_in_description => {
+        :no_scenarios => {
             :enabled => true,
-            :phrase => "{class} has numbers in the description.",
-            :score => WARNING,
+            :phrase => "Feature with no scenarios.",
+            :score => ERROR
         },
-        :long_name => {
+        :commented_step => {
             :enabled => true,
-            :phrase => "{class} has a long description.",
-            :score => INFO,
-            :max => 180
+            :phrase => "Commented step.",
+            :score => ERROR
         },
-        :implementation_word => {
+        :commented_example => {
             :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"]
+            :phrase => "Commented example.",
+            :score => ERROR
+        },
+        :no_steps => {
+            :enabled => true,
+            :phrase => "No steps in Scenario.",
+            :score => ERROR
+        },
+        :one_word_step => {
+            :enabled => true,
+            :phrase => "Step that is only one word long.",
+            :score => ERROR
+        },
+        :no_code => {
+            :enabled => true,
+            :phrase => "No code in Step Definition.",
+            :score => ERROR
+        },
+        :around_hook_without_2_parameters => {
+            :enabled => true,
+            :phrase => "Around hook without 2 parameters for Scenario and Block.",
+            :score => ERROR
+        },
+        :around_hook_no_block_call => {
+            :enabled => true,
+            :phrase => "Around hook does not call its block.",
+            :score => ERROR
+        },
+        :hook_no_debugging => {
+            :enabled => true,
+            :phrase => "Hook without a begin/rescue. Reduced visibility when debugging.",
+            :score => ERROR
+        },
+        :hook_conflicting_tags => {
+            :enabled => true,
+            :phrase => "Hook that both expects and ignores the same tag. This hook will not function as expected.",
+            :score => ERROR
+        },
+    }
+
+    warning_rules = {
+        :numbers_in_description => {
+            :enabled => true,
+            :phrase => "{class} has numbers in the description.",
+            :score => WARNING
         },
         :empty_feature => {
             :enabled => true,
             :phrase => "Feature file has no content.",
-            :score => WARNING,
+            :score => WARNING
         },
         :background_with_no_scenarios => {
             :enabled => true,
             :phrase => "Feature has a background with no scenarios.",
-            :score => WARNING,
+            :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,
+            :score => WARNING
         },
         :too_many_steps => {
             :enabled => true,
-            :phrase => "Scenario with too many steps.",
+            :phrase => "{class} with too many steps.",
             :score => WARNING,
-            :max => 7,
+            :max => 7
         },
         :out_of_order_steps => {
             :enabled => true,
             :phrase => "Scenario steps out of Given/When/Then order.",
-            :score => WARNING,
+            :score => WARNING
         },
         :invalid_first_step => {
             :enabled => true,
             :phrase => "Invalid first step. Began with And/But.",
-            :score => WARNING,
+            :score => WARNING
         },
         :asterisk_step => {
             :enabled => true,
             :phrase => "Step includes a * instead of Given/When/Then/And/But.",
-            :score => WARNING,
+            :score => WARNING
         },
-        :commented_step => {
+        :one_example => {
             :enabled => true,
-            :phrase => "Commented step.",
-            :score => ERROR,
+            :phrase => "Scenario Outline with only one example.",
+            :score => WARNING
         },
-        :commented_example => {
+        :too_many_examples => {
             :enabled => true,
-            :phrase => "Commented example.",
-            :score => ERROR,
+            :phrase => "Scenario Outline with too many examples.",
+            :score => WARNING,
+            :max => 10
         },
-        :no_examples => {
+        :multiple_given_when_then => {
             :enabled => true,
-            :phrase => "Scenario Outline with no examples.",
-            :score => FATAL,
+            :phrase => "Given/When/Then used multiple times in the same {class}.",
+            :score => WARNING
         },
-        :one_example => {
+        :too_many_parameters => {
             :enabled => true,
-            :phrase => "Scenario Outline with only one example.",
+            :phrase => "Too many parameters in Step Definition.",
             :score => WARNING,
+            :max => 4
         },
-        :no_examples_table => {
+        :lazy_debugging => {
             :enabled => true,
-            :phrase => "Scenario Outline with no examples table.",
-            :score => FATAL,
+            :phrase => "Lazy Debugging through puts, p, or print",
+            :score => WARNING
         },
-        :too_many_examples => {
+        :pending => {
             :enabled => true,
-            :phrase => "Scenario Outline with too many examples.",
-            :score => WARNING,
-            :max => 10
+            :phrase => "Pending step definition. Implement or remove.",
+            :score => WARNING
         },
-        :date_used => {
+        :feature_same_tag => {
             :enabled => true,
-            :phrase => "Date used.",
-            :score => INFO,
+            :phrase => "Same tag appears on Feature.",
+            :score => WARNING
         },
-        :no_steps => {
+        :scenario_same_tag => {
             :enabled => true,
-            :phrase => "No steps in Scenario.",
-            :score => ERROR,
+            :phrase => "Tag appears on all scenarios.",
+            :score => WARNING
         },
-        :one_word_step => {
+        :commas_in_description => {
             :enabled => true,
-            :phrase => "Step that is only one word long.",
-            :score => ERROR,
+            :phrase => "There are commas in the description, creating possible multirunning scenarios or features.",
+            :score => WARNING
         },
-        :multiple_given_when_then => {
+        :commented_tag => {
             :enabled => true,
-            :phrase => "Given/When/Then used multiple times in the same scenario.",
-            :score => WARNING,
+            :phrase => "{class} has a commented out tag",
+            :score => WARNING
         },
-        :no_code => {
+        :empty_hook => {
             :enabled => true,
-            :phrase => "No code in Step Definition.",
-            :score => ERROR,
+            :phrase => "Hook with no content.",
+            :score => WARNING
         },
-        :too_many_parameters => {
+        :hook_all_comments => {
             :enabled => true,
-            :phrase => "Too many parameters in Step Definition.",
-            :score => WARNING,
-            :max => 4
+            :phrase => "Hook is only comments.",
+            :score => WARNING
         },
-        :nested_step => {
+        :hook_duplicate_tags => {
             :enabled => true,
-            :phrase => "Nested step call.",
+            :phrase => "Hook has duplicate tags.",
+            :score => WARNING
+        }
+    }
+
+    info_rules = {
+        :too_many_tags => {
+            :enabled => true,
+            :phrase => "{class} has too many tags.",
             :score => INFO,
+            :max => 8
         },
-        :recursive_nested_step => {
+        :long_name => {
             :enabled => true,
-            :phrase => "Recursive nested step call.",
-            :score => FATAL,
+            :phrase => "{class} has a long description.",
+            :score => INFO,
+            :max => 180
         },
-        :commented_code => {
+        :implementation_word => {
             :enabled => true,
-            :phrase => "Commented code in Step Definition.",
+            :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"]
         },
-        :lazy_debugging => {
+        :too_many_scenarios => {
             :enabled => true,
-            :phrase => "Lazy Debugging through puts, p, or print",
-            :score => WARNING,
+            :phrase => "Feature with too many scenarios.",
+            :score => INFO,
+            :max => 10
         },
-        :pending => {
+        :date_used => {
             :enabled => true,
-            :phrase => "Pending step definition. Implement or remove.",
-            :score => WARNING,
+            :phrase => "Date used.",
+            :score => INFO
+        },
+        :nested_step => {
+            :enabled => true,
+            :phrase => "Nested step call.",
+            :score => INFO
+        },
+        :commented_code => {
+            :enabled => true,
+            :phrase => "Commented code in Step Definition.",
+            :score => INFO
         },
         :small_sleep => {
             :enabled => true,
@@ -176,17 +259,32 @@ module CukeSniffer
             :max => 2
         },
         :large_sleep => {
-        :enabled => true,
-        :phrase => "Large sleeps used. Use a wait_until like method.",
-        :score => INFO,
-        :min => 2
+            :enabled => true,
+            :phrase => "Large sleeps used. Use a wait_until like method.",
+            :score => INFO,
+            :min => 2
         },
         :todo => {
             :enabled => true,
             :phrase => "Todo found. Resolve it.",
+            :score => INFO
+        },
+        :hook_not_in_hooks_file => {
+            :enabled => true,
+            :phrase => "Hook found outside of the designated hooks file",
             :score => INFO,
+            :file => "hooks.rb"
         },
     }
 
+    # Master hash used for rule data
+    # * +:enabled+
+    # * +:phrase+
+    # * +:score+
+    # Optional:
+    # * +:words+
+    # * +:max+
+    # * +:min+
+    RULES = {}.merge fatal_rules.merge error_rules.merge warning_rules.merge info_rules
   end
 end

data/lib/cuke_sniffer/rules_evaluator.rb

@@ -1,53 +1,70 @@
-require 'roxml'
-module CukeSniffer
-  class RulesEvaluator
-    include ROXML
-    xml_accessor :score, :location
-    xml_accessor :rules_hash, :as => {:key => "phrase", :value => "score"}, :in => "rules", :from => "rule"
-
-    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
+require 'roxml'
+module CukeSniffer
+
+  # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
+  # Copyright:: Copyright (C) 2013 Robert Cochran
+  # License::   Distributes under the MIT License
+  # Parent class for all objects that have rules executed against it
+  # Mixins: CukeSniffer::Constants, CukeSniffer::RuleConfig, ROXML
+  class RulesEvaluator
+    include CukeSniffer::Constants
+    include CukeSniffer::RuleConfig
+    include ROXML
+
+    xml_accessor :score, :location
+    xml_accessor :rules_hash, :as => {:key => "phrase", :value => "score"}, :in => "rules", :from => "rule"
+
+    # int: Sum of the rules fired
+    attr_accessor :score
+
+    # string: Location in which the object was found
+    attr_accessor :location
+
+    # hash: Contains the phrase every rule fired against the object and times it fired
+    # * Key: string
+    # * Value: int
+    attr_accessor :rules_hash
+
+    # Location must be in the format of "file_path\file_name.rb:line_number"
+    def initialize(location)
+      @location = location
+      @score = 0
+      @rules_hash = {}
+      @class_type = self.class.to_s.gsub(/.*::/, "")
+    end
+
+    # Compares the score against the objects threshold
+    # If a score is below the threshold it is good and returns true
+    # Return: Boolean
+    def good?
+      score <= Constants::THRESHOLDS[@class_type]
+    end
+
+    # Calculates the score to threshold percentage of an object
+    # Return: Float
+    def problem_percentage
+      score.to_f / Constants::THRESHOLDS[@class_type].to_f
+    end
+
+    def == (comparison_object) # :nodoc:
+      comparison_object.location == location &&
+      comparison_object.score == score &&
+      comparison_object.rules_hash == rules_hash
+    end
+
+    def store_rule(rule, phrase = rule[:phrase])
+      if rule[:enabled]
+        @score += rule[:score]
+        @rules_hash[phrase] ||= 0
+        @rules_hash[phrase] += 1
+      end
+    end
+
+    private
+
+    #TODO Abstraction needed for this regex matcher (constants?)
+    def is_comment?(line)
+      true if line =~ /^\#.*$/
+    end
+  end
+end