cuke_modeler 3.27.0 → 3.28.0

data/lib/cuke_modeler/models/tag.rb

@@ -1,75 +1,75 @@
-module CukeModeler
-
-  # A class modeling a tag.
-  class Tag < Model
-
-    include Parsing
-    include Parsed
-    include Sourceable
-    include Named
-
-
-    # Creates a new Tag object and, if *source_text* is provided, populates the
-    # object.
-    #
-    # @example
-    #   Tag.new
-    #   Tag.new('@a_tag')
-    #
-    # @param source_text [String] The Gherkin text that will be used to populate the model
-    # @raise [ArgumentError] If *source_text* is not a String
-    # @return [Tag] A new Tag instance
-    def initialize(source_text = nil)
-      super
-    end
-
-    # Returns a string representation of this model. For a Tag model,
-    # this will be Gherkin text that is equivalent to the tag being modeled.
-    #
-    # @example
-    #   tag.to_s
-    #
-    # @return [String] A string representation of this model
-    def to_s
-      name || ''
-    end
-
-    # See `Object#inspect`. Returns some basic information about the
-    # object, including its class, object ID, and its most meaningful
-    # attribute. For a Tag model, this will be the name of the tag. If
-    # *verbose* is true, provides default Ruby inspection behavior instead.
-    #
-    # @example
-    #   tag.inspect
-    #   tag.inspect(verbose: true)
-    #
-    # @param verbose [Boolean] Whether or not to return the full details of
-    #   the object. Defaults to false.
-    # @return [String] A string representation of this model
-    def inspect(verbose: false)
-      return super if verbose
-
-      "#{super.chop} @name: #{@name.inspect}>"
-    end
-
-
-    private
-
-
-    def process_source(source_text)
-      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['feature']['tags'].first
-    end
-
-    def populate_model(processed_tag_data)
-      populate_name(processed_tag_data)
-      populate_parsing_data(processed_tag_data)
-      populate_source_location(processed_tag_data)
-    end
-
-  end
-end
+module CukeModeler
+
+  # A class modeling a tag.
+  class Tag < Model
+
+    include Parsing
+    include Parsed
+    include Sourceable
+    include Named
+
+
+    # Creates a new Tag object and, if *source_text* is provided, populates the
+    # object.
+    #
+    # @example
+    #   Tag.new
+    #   Tag.new('@a_tag')
+    #
+    # @param source_text [String] The Gherkin text that will be used to populate the model
+    # @raise [ArgumentError] If *source_text* is not a String
+    # @return [Tag] A new Tag instance
+    def initialize(source_text = nil)
+      super
+    end
+
+    # Returns a string representation of this model. For a Tag model,
+    # this will be Gherkin text that is equivalent to the tag being modeled.
+    #
+    # @example
+    #   tag.to_s
+    #
+    # @return [String] A string representation of this model
+    def to_s
+      name || ''
+    end
+
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a Tag model, this will be the name of the tag. If
+    # *verbose* is true, provides default Ruby inspection behavior instead.
+    #
+    # @example
+    #   tag.inspect
+    #   tag.inspect(verbose: true)
+    #
+    # @param verbose [Boolean] Whether or not to return the full details of
+    #   the object. Defaults to false.
+    # @return [String] A string representation of this model
+    def inspect(verbose: false)
+      return super if verbose
+
+      "#{super.chop} @name: #{@name.inspect}>"
+    end
+
+
+    private
+
+
+    def process_source(source_text)
+      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['feature']['tags'].first
+    end
+
+    def populate_model(processed_tag_data)
+      populate_name(processed_tag_data)
+      populate_parsing_data(processed_tag_data)
+      populate_source_location(processed_tag_data)
+    end
+
+  end
+end

data/lib/cuke_modeler/named.rb

@@ -1,26 +1,26 @@
-module CukeModeler
-
-  # @api private
-  #
-  # A mix-in module containing methods used by models that represent an element that has a name. Internal helper class.
-  module Named
-
-    # @api
-    #
-    # The name of the element
-    attr_accessor :name
-
-
-    private
-
-
-    def name_output_string
-      name.nil? || name.empty? ? '' : " #{name}"
-    end
-
-    def populate_name(parsed_model_data)
-      @name = parsed_model_data['name']
-    end
-
-  end
-end
+module CukeModeler
+
+  # @api private
+  #
+  # A mix-in module containing methods used by models that represent an element that has a name. Internal helper class.
+  module Named
+
+    # @api
+    #
+    # The name of the element
+    attr_accessor :name
+
+
+    private
+
+
+    def name_output_string
+      name.nil? || name.empty? ? '' : " #{name}"
+    end
+
+    def populate_name(parsed_model_data)
+      @name = parsed_model_data['name']
+    end
+
+  end
+end

data/lib/cuke_modeler/nested.rb

@@ -1,61 +1,61 @@
-module CukeModeler
-
-  # @api private
-  #
-  # A mix-in module containing methods used by models that are nested inside
-  # of other models. Internal helper class.
-  module Nested
-
-    # @api
-    #
-    # The parent model that contains this model
-    attr_accessor :parent_model
-
-    # TODO: Use an Enum type instead of symbols as arguments?
-
-    # @api
-    #
-    # Returns the ancestor model of this model that matches the given type. Available
-    # types are simply snake_case versions of the model Class names. Additionally, a
-    # special type *:test* will return either a Scenario or an Outline model.
-    #
-    # @example
-    #   model.get_ancestor(:directory)
-    #
-    # @param ancestor_type [Symbol] The ancestor type to get
-    # @raise [ArgumentError] If the passed type is not a valid model type
-    # @return [Model, nil] The ancestor model, if one is found
-    def get_ancestor(ancestor_type)
-      target_classes = classes_for_type(ancestor_type)
-
-      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
-    end
-
-
-    private
-
-
-    def classes_for_type(type)
-      {
-        directory: [Directory],
-        feature_file: [FeatureFile],
-        feature: [Feature],
-        rule: [Rule],
-        test: [Scenario, Outline, Background],
-        background: [Background],
-        scenario: [Scenario],
-        outline: [Outline],
-        step: [Step],
-        table: [Table],
-        example: [Example],
-        row: [Row]
-      }[type]
-    end
-
-  end
-end
+module CukeModeler
+
+  # @api private
+  #
+  # A mix-in module containing methods used by models that are nested inside
+  # of other models. Internal helper class.
+  module Nested
+
+    # @api
+    #
+    # The parent model that contains this model
+    attr_accessor :parent_model
+
+    # TODO: Use an Enum type instead of symbols as arguments?
+
+    # @api
+    #
+    # Returns the ancestor model of this model that matches the given type. Available
+    # types are simply snake_case versions of the model Class names. Additionally, a
+    # special type *:test* will return either a Scenario or an Outline model.
+    #
+    # @example
+    #   model.get_ancestor(:directory)
+    #
+    # @param ancestor_type [Symbol] The ancestor type to get
+    # @raise [ArgumentError] If the passed type is not a valid model type
+    # @return [Model, nil] The ancestor model, if one is found
+    def get_ancestor(ancestor_type)
+      target_classes = classes_for_type(ancestor_type)
+
+      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
+    end
+
+
+    private
+
+
+    def classes_for_type(type)
+      {
+        directory: [Directory],
+        feature_file: [FeatureFile],
+        feature: [Feature],
+        rule: [Rule],
+        test: [Scenario, Outline, Background],
+        background: [Background],
+        scenario: [Scenario],
+        outline: [Outline],
+        step: [Step],
+        table: [Table],
+        example: [Example],
+        row: [Row]
+      }[type]
+    end
+
+  end
+end

data/lib/cuke_modeler/parsed.rb

@@ -1,24 +1,24 @@
-module CukeModeler
-
-  # @api private
-  #
-  # A mix-in module containing methods used by models that are parsed from
-  # source text. Internal helper class.
-  module Parsed
-
-    # @api
-    #
-    # The parsing data for this element that was generated by
-    # the parsing engine (i.e. the *cucumber-gherkin* gem)
-    attr_accessor :parsing_data
-
-
-    private
-
-
-    def populate_parsing_data(parsed_model_data)
-      @parsing_data = parsed_model_data['cuke_modeler_parsing_data']
-    end
-
-  end
-end
+module CukeModeler
+
+  # @api private
+  #
+  # A mix-in module containing methods used by models that are parsed from
+  # source text. Internal helper class.
+  module Parsed
+
+    # @api
+    #
+    # The parsing data for this element that was generated by
+    # the parsing engine (i.e. the *cucumber-gherkin* gem)
+    attr_accessor :parsing_data
+
+
+    private
+
+
+    def populate_parsing_data(parsed_model_data)
+      @parsing_data = parsed_model_data['cuke_modeler_parsing_data']
+    end
+
+  end
+end