cuke_modeler 3.3.0 → 3.4.0

data/lib/cuke_modeler/models/tag.rb

@@ -18,10 +18,10 @@ module CukeModeler
     def initialize(source_text = nil)
       super(source_text)
 
-      if source_text
-        parsed_tag_data = parse_source(source_text)
-        populate_tag(self, parsed_tag_data)
-      end
+      return unless source_text
+
+      parsed_tag_data = parse_source(source_text)
+      populate_tag(self, parsed_tag_data)
     end
 
     # Returns a string representation of this model. For a tag model,
@@ -38,10 +38,14 @@ module CukeModeler
       base_file_string = "\n#{dialect_feature_keyword}: Fake feature to parse"
       source_text = "# language: #{Parsing.dialect}\n" + source_text + base_file_string
 
-      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_tag.feature')
+      parsed_file = Parsing.parse_text(source_text, 'cuke_modeler_stand_alone_tag.feature')
 
       parsed_file['feature']['tags'].first
     end
 
+    def populate_name(model, parsed_model_data)
+      model.name = parsed_model_data['name']
+    end
+
   end
 end

data/lib/cuke_modeler/named.rb

@@ -13,7 +13,11 @@ module CukeModeler
 
 
     def name_output_string
-      (name.nil? || name.empty?) ? '' : " #{name}"
+      name.nil? || name.empty? ? '' : " #{name}"
+    end
+
+    def populate_name(model, parsed_model_data)
+      model.name = parsed_model_data['name']
     end
 
   end

data/lib/cuke_modeler/nested.rb

@@ -12,30 +12,34 @@ module CukeModeler
 
     # Returns the ancestor model of this model that matches the given type.
     def get_ancestor(ancestor_type)
-      target_type = {:directory => [Directory],
-                     :feature_file => [FeatureFile],
-                     :feature => [Feature],
-                     :test => [Scenario, Outline, Background],
-                     :background => [Background],
-                     :scenario => [Scenario],
-                     :outline => [Outline],
-                     :step => [Step],
-                     :table => [Table],
-                     :example => [Example],
-                     :row => [Row]
-      }[ancestor_type]
+      target_classes = classes_for_type(ancestor_type)
 
-      raise(ArgumentError, "Unknown ancestor type '#{ancestor_type}'.") if target_type.nil?
+      raise(ArgumentError, "Unknown ancestor type '#{ancestor_type}'.") if target_classes.nil?
 
+      ancestor = parent_model
+      ancestor = ancestor.parent_model until target_classes.include?(ancestor.class) || ancestor.nil?
 
-      ancestor = self.parent_model
+      ancestor
+    end
 
-      until target_type.include?(ancestor.class) || ancestor.nil?
-        ancestor = ancestor.parent_model
-      end
 
+    private
 
-      ancestor
+
+    def classes_for_type(type)
+      {
+        directory: [Directory],
+        feature_file: [FeatureFile],
+        feature: [Feature],
+        test: [Scenario, Outline, Background],
+        background: [Background],
+        scenario: [Scenario],
+        outline: [Outline],
+        step: [Step],
+        table: [Table],
+        example: [Example],
+        row: [Row]
+      }[type]
     end
 
   end

data/lib/cuke_modeler/parsed.rb

@@ -8,5 +8,13 @@ module CukeModeler
     # The parsing data for this element that was generated by the parsing engine (i.e. the *gherkin* gem)
     attr_accessor :parsing_data
 
+
+    private
+
+
+    def populate_parsing_data(model, parsed_model_data)
+      model.parsing_data = parsed_model_data['cuke_modeler_parsing_data']
+    end
+
   end
 end

data/lib/cuke_modeler/parsing.rb

@@ -1,13 +1,6 @@
 # Have to at least load some version of the gem before which version of the gem has been loaded can
-# be determined and the rest of the needed files can be loaded. The entry points vary across versions,
-# so try them all until one of them works.
-begin
-  # Gherkin 9.x
-  require 'gherkin'
-rescue LoadError => e
-  # Add other entry points again if things change again
-  raise e
-end
+# be determined and the rest of the needed files can be loaded.
+require 'gherkin'
 
 
 # The *cucumber-gherkin* gem loads differently and has different grammar rules across major versions. Parsing
@@ -16,12 +9,16 @@ end
 gherkin_version = Gem.loaded_specs['cucumber-gherkin'].version.version
 gherkin_major_version = gherkin_version.match(/^(\d+)\./)[1].to_i
 
+# Previous versions of the gem did not use the conventional entry point, so I'm leaving this here in case it
+# changes again
+# rubocop:disable Lint/EmptyWhen
 case gherkin_major_version
   when 9, 10, 11, 12, 13, 14, 15
     # Currently nothing else to load beyond the entry point to the gem
   else
     raise("Unknown Gherkin version: '#{gherkin_version}'")
 end
+# rubocop:enable Lint/EmptyWhen
 
 require "cuke_modeler/adapters/gherkin_#{gherkin_major_version}_adapter"
 
@@ -45,18 +42,16 @@ module CukeModeler
 
       # The dialects currently known by the gherkin gem
       def dialects
-        unless @dialects
-          @dialects = Gherkin::DIALECTS
-        end
-
-        @dialects
+        @dialects ||= Gherkin::DIALECTS
       end
 
       # Parses the Cucumber feature given in *source_text* and returns a hash representation of
       # its logical structure. This is a standardized AST that should remain consistent across
       # different versions of `cucumber-gherkin`
       def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
-        raise(ArgumentError, "Text to parse must be a String but got #{source_text.class}") unless source_text.is_a?(String)
+        unless source_text.is_a?(String)
+          raise(ArgumentError, "Text to parse must be a String but got #{source_text.class}")
+        end
 
         begin
           parsed_result = parsing_method(source_text.encode('UTF-8'), filename)
@@ -71,13 +66,20 @@ module CukeModeler
       gherkin_version = Gem.loaded_specs['cucumber-gherkin'].version.version
       gherkin_major_version = gherkin_version.match(/^(\d+)\./)[1].to_i
 
+      # Previous versions of the gem had more variation between their parsing methods and so it was more
+      # understandable to have different methods instead of a single method with lots of conditional statements
+      # inside of it, so I'm leaving this here in case it changes again
+      # rubocop:disable Lint/DuplicateMethods
       case gherkin_major_version
         when 13, 14, 15
-          # todo - make these methods private?
+          # TODO: make these methods private?
           # NOT A PART OF THE PUBLIC API
           # The method to use for parsing Gherkin text
           def parsing_method(source_text, filename)
-            messages = Gherkin.from_source(filename, source_text, { :include_gherkin_document => true }).to_a.map(&:to_hash)
+            messages = Gherkin.from_source(filename,
+                                           source_text,
+                                           { include_gherkin_document: true })
+                              .to_a.map(&:to_hash)
 
             error_message = messages.find { |message| message[:parse_error] }
             gherkin_ast_message = messages.find { |message| message[:gherkin_document] }
@@ -87,33 +89,39 @@ module CukeModeler
             gherkin_ast_message[:gherkin_document]
           end
         when 12
-          # todo - make these methods private?
+          # TODO: make these methods private?
           # NOT A PART OF THE PUBLIC API
           # The method to use for parsing Gherkin text
           def parsing_method(source_text, filename)
-            messages = Gherkin.from_source(filename, source_text, { :include_gherkin_document => true }).to_a.map(&:to_hash)
+            messages = Gherkin.from_source(filename,
+                                           source_text,
+                                           { include_gherkin_document: true })
+                              .to_a.map(&:to_hash)
 
             potential_error_message = messages.find { |message| message[:attachment] }
             gherkin_ast_message = messages.find { |message| message[:gherkin_document] }
 
-            if potential_error_message
-              raise potential_error_message[:attachment][:body] if potential_error_message[:attachment][:body] =~ /expected.*got/
+            if potential_error_message && potential_error_message[:attachment][:body] =~ /expected.*got/
+              raise potential_error_message[:attachment][:body]
             end
 
             gherkin_ast_message[:gherkin_document]
           end
         when 9, 10, 11
-          # todo - make these methods private?
+          # TODO: make these methods private?
           # NOT A PART OF THE PUBLIC API
           # The method to use for parsing Gherkin text
           def parsing_method(source_text, filename)
-            messages = Gherkin.from_source(filename, source_text, { :include_gherkin_document => true }).to_a.map(&:to_hash)
+            messages = Gherkin.from_source(filename,
+                                           source_text,
+                                           { include_gherkin_document: true })
+                              .to_a.map(&:to_hash)
 
             potential_error_message = messages.find { |message| message[:attachment] }
             gherkin_ast_message = messages.find { |message| message[:gherkin_document] }
 
-            if potential_error_message
-              raise potential_error_message[:attachment][:text] if potential_error_message[:attachment][:text] =~ /expected.*got/
+            if potential_error_message && potential_error_message[:attachment][:text] =~ /expected.*got/
+              raise potential_error_message[:attachment][:text]
             end
 
             gherkin_ast_message[:gherkin_document]
@@ -121,6 +129,7 @@ module CukeModeler
         else
           raise("Unknown Gherkin version: '#{gherkin_version}'")
       end
+      # rubocop:enable Lint/DuplicateMethods
 
       # NOT A PART OF THE PUBLIC API
       # The adapter to use when converting an AST to a standard internal shape
@@ -143,7 +152,8 @@ module CukeModeler
     end
 
     def dialect_outline_keyword
-      get_word(Parsing.dialects[Parsing.dialect]['scenarioOutline'] || Parsing.dialects[Parsing.dialect]['scenario_outline'])
+      get_word(Parsing.dialects[Parsing.dialect]['scenarioOutline'] ||
+                 Parsing.dialects[Parsing.dialect]['scenario_outline'])
     end
 
     def dialect_step_keyword

data/lib/cuke_modeler/sourceable.rb

@@ -9,5 +9,13 @@ module CukeModeler
     # The line number where the element began in the source code
     attr_accessor :source_line
 
+
+    private
+
+
+    def populate_source_line(model, parsed_model_data)
+      model.source_line = parsed_model_data['line']
+    end
+
   end
 end

data/lib/cuke_modeler/stepped.rb

@@ -21,5 +21,13 @@ module CukeModeler
       step.to_s.split("\n").collect { |line| "  #{line}" }.join("\n")
     end
 
+    def populate_steps(model, parsed_model_data)
+      return unless parsed_model_data['steps']
+
+      parsed_model_data['steps'].each do |step_data|
+        model.steps << build_child_model(Step, step_data)
+      end
+    end
+
   end
 end

data/lib/cuke_modeler/taggable.rb

@@ -25,7 +25,15 @@ module CukeModeler
 
 
     def tag_output_string
-      tags.collect { |tag| tag.name }.join(' ')
+      tags.map(&:name).join(' ')
+    end
+
+    def populate_tags(model, parsed_model_data)
+      return unless parsed_model_data['tags']
+
+      parsed_model_data['tags'].each do |tag|
+        model.tags << build_child_model(Tag, tag)
+      end
     end
 
   end

data/lib/cuke_modeler/version.rb

@@ -1,4 +1,4 @@
 module CukeModeler
   # The gem version
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_modeler
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2020-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-gherkin
@@ -39,103 +39,123 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: racatt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: racatt
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 14.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 14.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.82.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.82.0
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -150,13 +170,13 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
-description: This gem facilitates modeling a test suite that is written in Gherkin
-  (e.g. Cucumber, SpecFlow, Lettuce, etc.). It does this by providing an abstraction
-  layer on top of the Abstract Syntax Tree that the 'cucumber-gherkin' gem generates
-  when parsing features, as well as providing models for feature files and directories
-  in order to be able to have a fully traversable model tree of a test suite's structure.
-  These models can then be analyzed or manipulated more easily than the underlying
-  AST layer.
+description: "This gem facilitates modeling a test suite that is written in Gherkin
+  (e.g. Cucumber, \nSpecFlow, Lettuce, etc.). It does this by providing an abstraction
+  layer on top of the \nAbstract Syntax Tree that the 'cucumber-gherkin' gem generates
+  when parsing features, \nas well as providing models for feature files and directories
+  in order to be able to \nhave a fully traversable model tree of a test suite's structure.
+  These models can then \nbe analyzed or manipulated more easily than the underlying
+  AST layer."
 email:
 - morrow748@gmail.com
 executables: []