cuke_modeler 3.2.0 → 3.7.0

data/lib/cuke_modeler/models/example.rb

@@ -1,7 +1,9 @@
+# I'll take extra class length due to extra helper methods over having fewer but more complex methods
+# rubocop:disable Metrics/ClassLength
+
 module CukeModeler
 
   # A class modeling an example table of an outline.
-
   class Example < Model
 
     include Parsing
@@ -27,10 +29,10 @@ module CukeModeler
 
       super(source_text)
 
-      if source_text
-        parsed_example_data = parse_source(source_text)
-        populate_example(self, parsed_example_data)
-      end
+      return unless source_text
+
+      parsed_example_data = parse_source(source_text)
+      populate_example(self, parsed_example_data)
     end
 
     # Adds a row to the example table. The row can be given as a Hash of
@@ -40,42 +42,39 @@ module CukeModeler
       raise('Cannot add a row. No parameters have been set.') if rows.empty?
 
       # A quick 'deep clone' so that the input isn't modified
-      row = Marshal::load(Marshal.dump(row))
-
-      case
-        when row.is_a?(Array)
-          # 'stringify' input
-          row.collect! { |value| value.to_s }
-
-          @rows << Row.new("|#{row.join('|')}|")
-        when row.is_a?(Hash)
-          # 'stringify' input
-          row = row.inject({}) { |hash, (key, value)| hash[key.to_s] = value.to_s; hash }
-
-          @rows << Row.new("|#{ordered_row_values(row).join('|')}|")
-        else
-          raise(ArgumentError, "Can only add row from a Hash or an Array but received #{row.class}")
-      end
+      row = Marshal.load(Marshal.dump(row))
+
+      values = if row.is_a?(Array)
+                 row
+               elsif row.is_a?(Hash)
+                 # There is no guarantee that the user built up their hash with the keys in the same order as
+                 # the parameter row and so the values have to be ordered by us. Additionally, the hash needs
+                 # to have string keys in order for #order_row_values to work
+                 ordered_row_values(stringify_keys(row))
+               else
+                 raise(ArgumentError, "Can only add row from a Hash or an Array but received #{row.class}")
+               end
+
+      @rows << Row.new("|#{values.join('|')}|")
     end
 
     # Removes a row from the example table. The row can be given as a Hash of
     # parameters and their corresponding values or as an Array of values
     # which will be assigned in order.
     def remove_row(row_removed)
-      return unless argument_rows
-
-      case
-        when row_removed.is_a?(Array)
-          location = argument_rows.index { |row| row.cells.collect { |cell| cell.value } == row_removed.collect { |value| value.strip } }
-        when row_removed.is_a?(Hash)
-          # Note: the hash value order has to be manually calculated because Ruby 1.8.7 does not have ordered 
-          # hash keys. Alternatively, the hash may have simply been built up 'willy nilly' by the user instead 
-          # of being built up in order according to the parameter order.
-          location = argument_rows.index { |row| row.cells.collect { |cell| cell.value } == ordered_row_values(row_removed.each_value { |value| value.strip! }) }
-        else
-          raise(ArgumentError, "Can only remove row from a Hash or an Array but received #{row_removed.class}")
-      end
-
+      return if argument_rows.empty?
+
+      values = if row_removed.is_a?(Array)
+                 row_removed
+               elsif row_removed.is_a?(Hash)
+                 # There is no guarantee that the user built up their hash with the keys in the same order as
+                 # the parameter row and so the values have to be ordered by us.
+                 ordered_row_values(row_removed)
+               else
+                 raise(ArgumentError, "Can only remove row from a Hash or an Array but received #{row_removed.class}")
+               end
+
+      location = index_for_values(values.map(&:to_s).map(&:strip))
       @rows.delete_at(location + 1) if location
     end
 
@@ -91,7 +90,7 @@ module CukeModeler
 
     # Returns the parameters of the example table
     def parameters
-      parameter_row ? parameter_row.cells.collect { |cell| cell.value } : []
+      parameter_row ? parameter_row.cells.map(&:value) : []
     end
 
     # Returns the model objects that belong to this model.
@@ -99,30 +98,38 @@ module CukeModeler
       rows + tags
     end
 
+    # Building strings just isn't pretty
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
     # Returns a string representation of this model. For an example model,
     # this will be Gherkin text that is equivalent to the example being modeled.
     def to_s
       text = ''
 
-      text << tag_output_string + "\n" unless tags.empty?
+      text << "#{tag_output_string}\n" unless tags.empty?
       text << "#{@keyword}:#{name_output_string}"
-      text << "\n" + description_output_string unless (description.nil? || description.empty?)
-      text << "\n" unless (rows.empty? || description.nil? || description.empty?)
-      text << "\n" + parameters_output_string if parameter_row
-      text << "\n" + rows_output_string unless argument_rows.empty?
+      text << "\n#{description_output_string}" unless no_description_to_output?
+      text << "\n" unless rows.empty? || no_description_to_output?
+      text << "\n#{parameters_output_string}" if parameter_row
+      text << "\n#{rows_output_string}" unless argument_rows.empty?
 
       text
     end
 
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
 
     private
 
 
     def parse_source(source_text)
-      base_file_string = "# language: #{Parsing.dialect}\n#{dialect_feature_keyword}: Fake feature to parse\n#{dialect_outline_keyword}:\n#{dialect_step_keyword} fake step\n"
+      base_file_string = "# language: #{Parsing.dialect}
+      #{dialect_feature_keyword}: Fake feature to parse
+                            #{dialect_outline_keyword}:
+                              #{dialect_step_keyword} fake step\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_example.feature')
+      parsed_file = Parsing.parse_text(source_text, 'cuke_modeler_stand_alone_example.feature')
 
       parsed_file['feature']['elements'].first['examples'].first
     end
@@ -135,7 +142,7 @@ module CukeModeler
       text = ''
 
       unless parameter_row.nil?
-        text << "  |"
+        text << '  |'
         parameter_row.cells.count.times { |index| text << " #{string_for(parameter_row.cells, index)} |" }
       end
 
@@ -148,7 +155,7 @@ module CukeModeler
       unless argument_rows.empty?
 
         argument_rows.each do |row|
-          text << "  |"
+          text << '  |'
           row.cells.count.times { |index| text << " #{string_for(row.cells, index)} |" }
           text << "\n"
         end
@@ -164,8 +171,18 @@ module CukeModeler
     end
 
     def ordered_row_values(row_hash)
-      parameter_row.cells.collect { |cell| cell.value }.collect { |parameter| row_hash[parameter] }
+      parameter_row.cells.map(&:value).collect { |parameter| row_hash[parameter] }
+    end
+
+    def stringify_keys(hash)
+      hash.each_with_object({}) { |(key, value), new_hash| new_hash[key.to_s] = value }
+    end
+
+    def index_for_values(values)
+      argument_rows.index { |row| row.cells.map(&:value) == values }
     end
 
   end
 end
+
+# rubocop:enable Metrics/ClassLength

data/lib/cuke_modeler/models/feature.rb

@@ -1,7 +1,6 @@
 module CukeModeler
 
   # A class modeling a feature in a Cucumber suite.
-
   class Feature < Model
 
     include Parsed
@@ -33,17 +32,19 @@ module CukeModeler
 
       super(source_text)
 
-      if source_text
-        parsed_feature_data = parse_source(source_text)
-        populate_feature(self, parsed_feature_data)
-      end
+      return unless source_text
+
+      parsed_feature_data = parse_source(source_text)
+      populate_feature(self, parsed_feature_data)
     end
 
     # Returns *true* if the feature contains a background, *false* otherwise.
-    def has_background?
+    def background?
       !@background.nil?
     end
 
+    alias has_background? background?
+
     # Returns the scenario models contained in the feature.
     def scenarios
       @tests.select { |test| test.is_a? Scenario }
@@ -60,11 +61,11 @@ module CukeModeler
     # single set of test values, such as an individual scenario or one example row
     # of an outline.
     def test_case_count
-      scenarios.count + outlines.reduce(0) { |outline_sum, outline|
-        outline_sum += outline.examples.reduce(0) { |example_sum, example|
-          example_sum += example.argument_rows.count
-        }
-      }
+      scenarios.count + outlines.reduce(0) do |outline_sum, outline|
+        outline_sum + outline.examples.reduce(0) do |example_sum, example|
+          example_sum + example.argument_rows.count
+        end
+      end
     end
 
     # Returns the model objects that belong to this model.
@@ -75,27 +76,32 @@ module CukeModeler
       models
     end
 
+    # Building strings just isn't pretty
+    # rubocop:disable Metrics/AbcSize
+
     # Returns a string representation of this model. For a feature model,
     # this will be Gherkin text that is equivalent to the feature being modeled.
     def to_s
       text = ''
 
-      text << tag_output_string + "\n" unless tags.empty?
+      text << "#{tag_output_string}\n" unless tags.empty?
       text << "#{@keyword}:#{name_output_string}"
-      text << "\n" + description_output_string unless (description.nil? || description.empty?)
-      text << "\n\n" + background_output_string if background
-      text << "\n\n" + tests_output_string unless tests.empty?
-      text << "\n\n" + rules_output_string unless rules.empty?
+      text << "\n#{description_output_string}" unless no_description_to_output?
+      text << "\n\n#{background_output_string}" if background
+      text << "\n\n#{tests_output_string}" unless tests.empty?
+      text << "\n\n#{rules_output_string}" unless rules.empty?
 
       text
     end
 
+    # rubocop:enable Metrics/AbcSize
+
 
     private
 
 
     def parse_source(source_text)
-      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_feature.feature')
+      parsed_file = Parsing.parse_text(source_text, 'cuke_modeler_stand_alone_feature.feature')
 
       parsed_file['feature']
     end

data/lib/cuke_modeler/models/feature_file.rb

@@ -1,7 +1,6 @@
 module CukeModeler
 
   # A class modeling a feature file in a Cucumber suite.
-
   class FeatureFile < Model
 
     include Parsed
@@ -25,13 +24,11 @@ module CukeModeler
 
       super(file_path)
 
-      if file_path
-        raise(ArgumentError, "Unknown file: #{file_path.inspect}") unless File.exists?(file_path)
-
-        processed_feature_file_data = process_feature_file(file_path)
-        populate_featurefile(self, processed_feature_file_data)
-      end
+      return unless file_path
+      raise(ArgumentError, "Unknown file: #{file_path.inspect}") unless File.exist?(file_path)
 
+      processed_feature_file_data = process_feature_file(file_path)
+      populate_featurefile(self, processed_feature_file_data)
     end
 
     # Returns the name of the modeled feature file.
@@ -57,7 +54,7 @@ module CukeModeler
     def process_feature_file(file_path)
       source_text = IO.read(file_path)
 
-      feature_file_data = Parsing::parse_text(source_text, file_path)
+      feature_file_data = Parsing.parse_text(source_text, file_path)
       feature_file_data = feature_file_data.merge({ 'path' => file_path })
 
       feature_file_data

data/lib/cuke_modeler/models/model.rb

@@ -1,7 +1,6 @@
 module CukeModeler
 
   # A class modeling an element of a Cucumber suite.
-
   class Model
 
     include Nested
@@ -11,7 +10,8 @@ module CukeModeler
     # Creates a new Model object and, if *source_text* is provided,
     # populates the object.
     def initialize(source_text = nil)
-      raise(ArgumentError, "Can only create models from Strings but was given a #{source_text.class}.") if source_text && !source_text.is_a?(String)
+      error_message = "Can only create models from Strings but was given a #{source_text.class}."
+      raise(ArgumentError, error_message) if source_text && !source_text.is_a?(String)
 
       # This should be overridden by a child class
     end
@@ -24,7 +24,6 @@ module CukeModeler
 
     # Returns the model objects that belong to this model.
     def children
-      # This should be overridden by a child class
       []
     end
 

data/lib/cuke_modeler/models/outline.rb

@@ -1,7 +1,6 @@
 module CukeModeler
 
   # A class modeling an individual outline in a Cucumber suite.
-
   class Outline < Model
 
     include Parsing
@@ -29,17 +28,17 @@ module CukeModeler
 
       super(source_text)
 
-      if source_text
-        parsed_outline_data = parse_source(source_text)
-        populate_outline(self, parsed_outline_data)
-      end
+      return unless source_text
+
+      parsed_outline_data = parse_source(source_text)
+      populate_outline(self, parsed_outline_data)
     end
 
     # Returns *true* if the two models have equivalent steps and *false* otherwise.
-    def ==(other_model)
-      return false unless other_model.respond_to?(:steps)
+    def ==(other)
+      return false unless other.respond_to?(:steps)
 
-      steps == other_model.steps
+      steps == other.steps
     end
 
     # Returns the model objects that belong to this model.
@@ -47,21 +46,26 @@ module CukeModeler
       examples + steps + tags
     end
 
+    # Building strings just isn't pretty
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
     # Returns a string representation of this model. For an outline model,
     # this will be Gherkin text that is equivalent to the outline being modeled.
     def to_s
       text = ''
 
-      text << tag_output_string + "\n" unless tags.empty?
+      text << "#{tag_output_string}\n" unless tags.empty?
       text << "#{@keyword}:#{name_output_string}"
-      text << "\n" + description_output_string unless (description.nil? || description.empty?)
-      text << "\n" unless (steps.empty? || description.nil? || description.empty?)
-      text << "\n" + steps_output_string unless steps.empty?
-      text << "\n\n" + examples_output_string unless examples.empty?
+      text << "\n#{description_output_string}" unless no_description_to_output?
+      text << "\n" unless steps.empty? || no_description_to_output?
+      text << "\n#{steps_output_string}" unless steps.empty?
+      text << "\n\n#{examples_output_string}" unless examples.empty?
 
       text
     end
 
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
 
     private
 
@@ -70,13 +74,13 @@ module CukeModeler
       base_file_string = "# language: #{Parsing.dialect}\n#{dialect_feature_keyword}: Fake feature to parse\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_outline.feature')
+      parsed_file = Parsing.parse_text(source_text, 'cuke_modeler_stand_alone_outline.feature')
 
       parsed_file['feature']['elements'].first
     end
 
     def examples_output_string
-      examples.empty? ? '' : examples.collect { |example| example.to_s }.join("\n\n")
+      examples.empty? ? '' : examples.join("\n\n")
     end
 
   end

data/lib/cuke_modeler/models/row.rb

@@ -1,7 +1,6 @@
 module CukeModeler
 
   # A class modeling a single row of a step table or example table.
-
   class Row < Model
 
     include Sourceable
@@ -19,16 +18,21 @@ module CukeModeler
 
       super(source_text)
 
-      if source_text
-        parsed_row_data = parse_source(source_text)
-        populate_row(self, parsed_row_data)
-      end
+      return unless source_text
+
+      parsed_row_data = parse_source(source_text)
+      populate_row(self, parsed_row_data)
+    end
+
+    # Returns the model objects that belong to this model.
+    def children
+      @cells
     end
 
     # Returns a string representation of this model. For a row model,
     # this will be Gherkin text that is equivalent to the row being modeled.
     def to_s
-      text_cells = cells.collect { |cell| cell.to_s }
+      text_cells = cells.map(&:to_s)
 
       "| #{text_cells.join(' | ')} |"
     end
@@ -38,10 +42,13 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "# language: #{Parsing.dialect}\n#{dialect_feature_keyword}: Fake feature to parse\n#{dialect_scenario_keyword}:\n#{dialect_step_keyword} fake step\n"
+      base_file_string = "# language: #{Parsing.dialect}
+      #{dialect_feature_keyword}: Fake feature to parse
+                            #{dialect_scenario_keyword}:
+                              #{dialect_step_keyword} fake step\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_row.feature')
+      parsed_file = Parsing.parse_text(source_text, 'cuke_modeler_stand_alone_row.feature')
 
       parsed_file['feature']['elements'].first['steps'].first['table']['rows'].first
     end