cuke_sniffer 0.0.7 → 0.0.8

data/lib/cuke_sniffer/step_definition.rb

@@ -1,163 +1,176 @@
-require 'roxml'
-module CukeSniffer
-
-  # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
-  # Copyright:: Copyright (C) 2013 Robert Cochran
-  # License::   Distributes under the MIT License
-  # Translates and evaluates Cucumber step definitions
-  # Extends CukeSniffer::RulesEvaluator
-  class StepDefinition < RuleTarget
-
-    xml_accessor :start_line
-    xml_accessor :regex
-    xml_accessor :parameters, :as => [], :in => "parameters"
-    xml_accessor :nested_steps, :as => {:key => 'location', :value => 'call'}, :in => "nested_steps"
-    xml_accessor :calls, :as => {:key => 'location', :value => 'call'}, :in => "calls"
-    xml_accessor :code, :as => [], :in => "code"
-
-    # int: Line on which a step definition starts
-    attr_accessor :start_line
-
-    # Regex: Regex that cucumber uses to match step calls
-    attr_accessor :regex
-
-    # string array: List of the parameters a step definition has
-    attr_accessor :parameters
-
-    # hash: Contains each nested step call a step definition has
-    # * Key: location:line of the nested step
-    # * Value: The step call that appears on the line
-    attr_accessor :nested_steps
-
-    # hash: Contains each call that is made to a step definition
-    # * Key: Location in which the step definition is called from
-    # * Value: The step string that matched the regex
-    # In the case of a fuzzy match it will be a regex of the
-    # step call that was the inverse match of the regex translated
-    # into a string.
-    attr_accessor :calls
-
-    # string array: List of all of the content between the regex and the end of the step definition.
-    attr_accessor :code
-
-    # location must be in the format of "file_path\file_name.rb:line_number"
-    # step_definition_block is an array of strings that represents the step definition
-    # must contain the regex line and its pairing end
-    def initialize(location, step_definition_block)
-      @parameters = []
-      @calls = {}
-      @nested_steps = {}
-      super(location)
-      extract_start_line(location)
-      extract_code(step_definition_block)
-      extract_step_definition_signature(step_definition_block)
-
-      detect_nested_steps
-    end
-
-    # Adds new location => step_string pairs to the calls hash
-    def add_call(location, step_string)
-      @calls[location] = step_string
-    end
-
-    def ==(comparison_object) # :nodoc:
-      comparison_object.regex == regex && comparison_object.parameters == parameters
-    end
-
-    def condensed_call_list
-      condensed_list = {}
-      @calls.each do |call, step_string|
-        condensed_list[step_string] ||= []
-        condensed_list[step_string] << call
-      end
-      condensed_list
-    end
-
-    private
-
-    SIMPLE_NESTED_STEP_REGEX = /steps?\s"#{STEP_STYLES}(?<step_string>.*)"$/ # :nodoc:
-    START_COMPLEX_STEP_REGEX = /^steps?\s%(q|Q)?\{\s*/ # :nodoc:
-    SAME_LINE_COMPLEX_STEP_REGEX = /#{START_COMPLEX_STEP_REGEX}#{STEP_STYLES}(?<step_string>.*)}$/ # :nodoc:
-    END_COMPLEX_STEP_REGEX = /}$/ # :nodoc:
-    START_COMPLEX_WITH_STEP_REGEX = /#{START_COMPLEX_STEP_REGEX}#{STEP_STYLES}(?<step_string>.*)$/ # :nodoc:
-    END_COMPLEX_WITH_STEP_REGEX = /#{STEP_STYLES}(?<step_string>.*)}$/ # :nodoc:
-
-    def detect_nested_steps
-      multi_line_step_flag = false
-      counter = 1
-      @code.each do |line|
-        regex = nil
-        case line
-          when SIMPLE_NESTED_STEP_REGEX
-            regex = SIMPLE_NESTED_STEP_REGEX
-          when SAME_LINE_COMPLEX_STEP_REGEX
-            regex = SAME_LINE_COMPLEX_STEP_REGEX
-          when START_COMPLEX_WITH_STEP_REGEX
-            if line =~ /\}$/
-              if line.include?('#{')
-                reversed_line = line.reverse
-                last_capture = reversed_line[0..reversed_line.index('#')].reverse
-                if last_capture =~ /{.*}$/
-                  multi_line_step_flag = true
-                  regex = START_COMPLEX_WITH_STEP_REGEX
-                else
-                  regex = SAME_LINE_COMPLEX_STEP_REGEX
-                end
-              else
-                regex = SAME_LINE_COMPLEX_STEP_REGEX
-              end
-            else
-              multi_line_step_flag = true
-              regex = START_COMPLEX_WITH_STEP_REGEX
-            end
-          when END_COMPLEX_WITH_STEP_REGEX
-            if line =~ /[#]{.*}$/ && multi_line_step_flag
-              regex = STEP_REGEX
-            else
-              regex = END_COMPLEX_WITH_STEP_REGEX
-              multi_line_step_flag = false
-            end
-          when START_COMPLEX_STEP_REGEX
-            multi_line_step_flag = true
-          when STEP_REGEX
-            regex = STEP_REGEX if multi_line_step_flag
-          when END_COMPLEX_STEP_REGEX
-            multi_line_step_flag = false
-          else
-        end
-
-        if regex and !is_comment?(line)
-          match = regex.match(line)
-          nested_step_line = (@start_line + counter)
-          @nested_steps[location.gsub(/:\d*$/, ":" + nested_step_line.to_s)] = match[:step_string].gsub("\\", "")
-        end
-        counter += 1
-      end
-    end
-
-    def extract_step_definition_signature(step_definition_block)
-      regex_line = find_regex_line(step_definition_block)
-      unless regex_line.nil?
-        matches = STEP_DEFINITION_REGEX.match(regex_line)
-        @regex = Regexp.new(matches[:step])
-        @parameters = matches[:parameters].split(/,\s*/).collect { |param| param.strip } if matches[:parameters]
-      end
-    end
-
-    def extract_start_line(location)
-      @start_line = location.match(/:(?<line>\d*)$/)[:line].to_i
-    end
-
-    def extract_code(step_definition_block)
-      end_match_index = (step_definition_block.size - 1) - step_definition_block.reverse.index("end")
-      @code = step_definition_block[1...end_match_index]
-    end
-
-    def find_regex_line(step_definition_block)
-      step_definition_block.each do |line|
-        return line if line =~ STEP_DEFINITION_REGEX
-      end
-      nil
-    end
-  end
-end
+module CukeSniffer
+
+  # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
+  # Copyright:: Copyright (C) 2014 Robert Cochran
+  # License::   Distributes under the MIT License
+  # Translates and evaluates Cucumber step definitions
+  # Extends CukeSniffer::RulesEvaluator
+  class StepDefinition < RuleTarget
+
+    xml_accessor :start_line
+    xml_accessor :regex
+    xml_accessor :parameters, :as => [], :in => "parameters"
+    xml_accessor :nested_steps, :as => {:key => 'location', :value => 'call'}, :in => "nested_steps"
+    xml_accessor :calls, :as => {:key => 'location', :value => 'call'}, :in => "calls"
+    xml_accessor :code, :as => [], :in => "code"
+
+    # int: Line on which a step definition starts
+    attr_accessor :start_line
+
+    # Regex: Regex that cucumber uses to match step calls
+    attr_accessor :regex
+
+    # string array: List of the parameters a step definition has
+    attr_accessor :parameters
+
+    # hash: Contains each nested step call a step definition has
+    # * Key: location:line of the nested step
+    # * Value: The step call that appears on the line
+    attr_accessor :nested_steps
+
+    # hash: Contains each call that is made to a step definition
+    # * Key: Location in which the step definition is called from
+    # * Value: The step string that matched the regex
+    # In the case of a fuzzy match it will be a regex of the
+    # step call that was the inverse match of the regex translated
+    # into a string.
+    attr_accessor :calls
+
+    # string array: List of all of the content between the regex and the end of the step definition.
+    attr_accessor :code
+
+    # location must be in the format of "file_path\file_name.rb:line_number"
+    # step_definition_block is an array of strings that represents the step definition
+    # must contain the regex line and its pairing end
+    def initialize(location, step_definition_block)
+      @parameters = []
+      @calls = {}
+      @nested_steps = {}
+      super(location)
+      extract_start_line(location)
+      extract_code(step_definition_block)
+      extract_step_definition_signature(step_definition_block)
+
+      detect_nested_steps
+    end
+
+    # Adds new location => step_string pairs to the calls hash
+    def add_call(location, step_string)
+      @calls[location] = step_string
+    end
+
+    def ==(comparison_object) # :nodoc:
+      comparison_object.regex == regex && comparison_object.parameters == parameters
+    end
+
+    def condensed_call_list
+      condensed_list = {}
+      @calls.each do |call, step_string|
+        condensed_list[step_string] ||= []
+        condensed_list[step_string] << call
+      end
+      condensed_list
+    end
+
+    def recursive_nested_steps
+      recursive_nested_steps_map = {}
+      @nested_steps.each{|location, nested_step|
+        if nested_step =~ @regex
+          recursive_nested_steps_map[location] = nested_step
+        end
+      }
+      recursive_nested_steps_map
+    end
+
+    def todo
+      @code.select {|line|line =~ /#(TODO|todo)/ }
+    end
+
+    private
+
+    SIMPLE_NESTED_STEP_REGEX = /steps?\s"#{STEP_STYLES}(?<step_string>.*)"$/ # :nodoc:
+    START_COMPLEX_STEP_REGEX = /^steps?\s%(q|Q)?\{\s*/ # :nodoc:
+    SAME_LINE_COMPLEX_STEP_REGEX = /#{START_COMPLEX_STEP_REGEX}#{STEP_STYLES}(?<step_string>.*)}$/ # :nodoc:
+    END_COMPLEX_STEP_REGEX = /}$/ # :nodoc:
+    START_COMPLEX_WITH_STEP_REGEX = /#{START_COMPLEX_STEP_REGEX}#{STEP_STYLES}(?<step_string>.*)$/ # :nodoc:
+    END_COMPLEX_WITH_STEP_REGEX = /#{STEP_STYLES}(?<step_string>.*)}$/ # :nodoc:
+
+    def detect_nested_steps
+      multi_line_step_flag = false
+      counter = 1
+      @code.each do |line|
+        regex = nil
+        case line
+          when SIMPLE_NESTED_STEP_REGEX
+            regex = SIMPLE_NESTED_STEP_REGEX
+          when SAME_LINE_COMPLEX_STEP_REGEX
+            regex = SAME_LINE_COMPLEX_STEP_REGEX
+          when START_COMPLEX_WITH_STEP_REGEX
+            if line =~ /\}$/
+              if line.include?('#{')
+                reversed_line = line.reverse
+                last_capture = reversed_line[0..reversed_line.index('#')].reverse
+                if last_capture =~ /{.*}$/
+                  multi_line_step_flag = true
+                  regex = START_COMPLEX_WITH_STEP_REGEX
+                else
+                  regex = SAME_LINE_COMPLEX_STEP_REGEX
+                end
+              else
+                regex = SAME_LINE_COMPLEX_STEP_REGEX
+              end
+            else
+              multi_line_step_flag = true
+              regex = START_COMPLEX_WITH_STEP_REGEX
+            end
+          when END_COMPLEX_WITH_STEP_REGEX
+            if line =~ /[#]{.*}$/ && multi_line_step_flag
+              regex = STEP_REGEX
+            else
+              regex = END_COMPLEX_WITH_STEP_REGEX
+              multi_line_step_flag = false
+            end
+          when START_COMPLEX_STEP_REGEX
+            multi_line_step_flag = true
+          when STEP_REGEX
+            regex = STEP_REGEX if multi_line_step_flag
+          when END_COMPLEX_STEP_REGEX
+            multi_line_step_flag = false
+          else
+        end
+
+        if regex and !is_comment?(line)
+          match = regex.match(line)
+          nested_step_line = (@start_line + counter)
+          @nested_steps[location.gsub(/:\d*$/, ":" + nested_step_line.to_s)] = match[:step_string].gsub("\\", "")
+        end
+        counter += 1
+      end
+    end
+
+    def extract_step_definition_signature(step_definition_block)
+      regex_line = find_regex_line(step_definition_block)
+      unless regex_line.nil?
+        matches = STEP_DEFINITION_REGEX.match(regex_line)
+        @regex = Regexp.new(matches[:step])
+        @parameters = matches[:parameters].split(/,\s*/).collect { |param| param.strip } if matches[:parameters]
+      end
+    end
+
+    def extract_start_line(location)
+      @start_line = location.match(/:(?<line>\d*)$/)[:line].to_i
+    end
+
+    def extract_code(step_definition_block)
+      end_match_index = (step_definition_block.size - 1) - step_definition_block.reverse.index("end")
+      @code = step_definition_block[1...end_match_index]
+    end
+
+    def find_regex_line(step_definition_block)
+      step_definition_block.each do |line|
+        return line if line =~ STEP_DEFINITION_REGEX
+      end
+      nil
+    end
+  end
+end

data/lib/cuke_sniffer/summary_helper.rb

@@ -1,6 +1,6 @@
 module CukeSniffer
   # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
-  # Copyright:: Copyright (C) 2013 Robert Cochran
+  # 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

data/lib/cuke_sniffer/summary_node.rb

@@ -1,19 +1,18 @@
-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:
-
+module CukeSniffer
+
+  # Author::    Robert Cochran  (mailto:cochrarj@miamioh.edu)
+  # Copyright:: Copyright (C) 2014 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.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roxml