cuke_modeler 3.27.0 → 3.28.0

data/lib/cuke_modeler/models/cell.rb

@@ -1,88 +1,88 @@
-module CukeModeler
-
-  # A class modeling a single cell of a row.
-  class Cell < Model
-
-    include Sourceable
-    include Parsing
-    include Parsed
-
-
-    # The value of the cell
-    attr_accessor :value
-
-
-    # Creates a new Cell object and, if *source_text* is provided, populates
-    # the object.
-    #
-    # @example
-    #   Cell.new
-    #   Cell.new('some value')
-    #
-    # @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 [Cell] A new Cell instance
-    def initialize(source_text = nil)
-      super
-    end
-
-    # Returns a string representation of this model. For a Cell model,
-    # this will be Gherkin text that is equivalent to the cell being modeled.
-    #
-    # @example
-    #   cell.to_s
-    #
-    # @return [String] A string representation of this model
-    def to_s
-      # Vertical bars and backslashes are special characters that need to be escaped
-      @value ? @value.gsub('\\', '\\\\\\').gsub('|', '\|') : ''
-    end
-
-    # See `Object#inspect`. Returns some basic information about the
-    # object, including its class, object ID, and its most meaningful
-    # attribute. For a Cell model, this will be the value of the
-    # cell. If *verbose* is true, provides default Ruby inspection
-    # behavior instead.
-    #
-    # @example
-    #   cell.inspect
-    #   cell.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} @value: #{value.inspect}>"
-    end
-
-
-    private
-
-
-    def process_source(source_text)
-      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_cell.feature')
-
-      parsed_file['feature']['elements'].first['steps'].first['table']['rows'].first['cells'].first
-    end
-
-    def populate_model(parsed_cell_data)
-      populate_cell_value(parsed_cell_data)
-      populate_source_location(parsed_cell_data)
-      populate_parsing_data(parsed_cell_data)
-    end
-
-    def populate_cell_value(parsed_cell_data)
-      @value = parsed_cell_data['value']
-    end
-
-  end
-
-end
+module CukeModeler
+
+  # A class modeling a single cell of a row.
+  class Cell < Model
+
+    include Sourceable
+    include Parsing
+    include Parsed
+
+
+    # The value of the cell
+    attr_accessor :value
+
+
+    # Creates a new Cell object and, if *source_text* is provided, populates
+    # the object.
+    #
+    # @example
+    #   Cell.new
+    #   Cell.new('some value')
+    #
+    # @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 [Cell] A new Cell instance
+    def initialize(source_text = nil)
+      super
+    end
+
+    # Returns a string representation of this model. For a Cell model,
+    # this will be Gherkin text that is equivalent to the cell being modeled.
+    #
+    # @example
+    #   cell.to_s
+    #
+    # @return [String] A string representation of this model
+    def to_s
+      # Vertical bars and backslashes are special characters that need to be escaped
+      @value ? @value.gsub('\\', '\\\\\\').gsub('|', '\|') : ''
+    end
+
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a Cell model, this will be the value of the
+    # cell. If *verbose* is true, provides default Ruby inspection
+    # behavior instead.
+    #
+    # @example
+    #   cell.inspect
+    #   cell.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} @value: #{value.inspect}>"
+    end
+
+
+    private
+
+
+    def process_source(source_text)
+      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_cell.feature')
+
+      parsed_file['feature']['elements'].first['steps'].first['table']['rows'].first['cells'].first
+    end
+
+    def populate_model(parsed_cell_data)
+      populate_cell_value(parsed_cell_data)
+      populate_source_location(parsed_cell_data)
+      populate_parsing_data(parsed_cell_data)
+    end
+
+    def populate_cell_value(parsed_cell_data)
+      @value = parsed_cell_data['value']
+    end
+
+  end
+
+end

data/lib/cuke_modeler/models/comment.rb

@@ -1,82 +1,82 @@
-module CukeModeler
-
-  # A class modeling a comment in a feature file.
-  class Comment < Model
-
-    include Parsing
-    include Parsed
-    include Sourceable
-
-
-    # The text of the comment
-    attr_accessor :text
-
-
-    # Creates a new Comment object and, if *source_text* is provided, populates the
-    # object.
-    #
-    # @example
-    #   Comment.new
-    #   Comment.new('# A comment')
-    #
-    # @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 [Comment] A new Comment instance
-    def initialize(source_text = nil)
-      super
-    end
-
-    # Returns a string representation of this model. For a Comment model,
-    # this will be Gherkin text that is equivalent to the comment being modeled.
-    #
-    # @example
-    #   comment.to_s
-    #
-    # @return [String] A string representation of this model
-    def to_s
-      text || ''
-    end
-
-    # See `Object#inspect`. Returns some basic information about the
-    # object, including its class, object ID, and its most meaningful
-    # attribute. For a Comment model, this will be the text of the comment.
-    # If *verbose* is true, provides default Ruby inspection behavior instead.
-    #
-    # @example
-    #   comment.inspect
-    #   comment.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} @text: #{text.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_comment.feature')
-
-      parsed_file['comments'].last
-    end
-
-    def populate_model(processed_comment_data)
-      populate_comment_text(processed_comment_data)
-      populate_parsing_data(processed_comment_data)
-      populate_source_location(processed_comment_data)
-    end
-
-    def populate_comment_text(parsed_comment_data)
-      @text = parsed_comment_data['text'].strip
-    end
-
-  end
-end
+module CukeModeler
+
+  # A class modeling a comment in a feature file.
+  class Comment < Model
+
+    include Parsing
+    include Parsed
+    include Sourceable
+
+
+    # The text of the comment
+    attr_accessor :text
+
+
+    # Creates a new Comment object and, if *source_text* is provided, populates the
+    # object.
+    #
+    # @example
+    #   Comment.new
+    #   Comment.new('# A comment')
+    #
+    # @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 [Comment] A new Comment instance
+    def initialize(source_text = nil)
+      super
+    end
+
+    # Returns a string representation of this model. For a Comment model,
+    # this will be Gherkin text that is equivalent to the comment being modeled.
+    #
+    # @example
+    #   comment.to_s
+    #
+    # @return [String] A string representation of this model
+    def to_s
+      text || ''
+    end
+
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a Comment model, this will be the text of the comment.
+    # If *verbose* is true, provides default Ruby inspection behavior instead.
+    #
+    # @example
+    #   comment.inspect
+    #   comment.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} @text: #{text.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_comment.feature')
+
+      parsed_file['comments'].last
+    end
+
+    def populate_model(processed_comment_data)
+      populate_comment_text(processed_comment_data)
+      populate_parsing_data(processed_comment_data)
+      populate_source_location(processed_comment_data)
+    end
+
+    def populate_comment_text(parsed_comment_data)
+      @text = parsed_comment_data['text'].strip
+    end
+
+  end
+end

data/lib/cuke_modeler/models/directory.rb

@@ -1,143 +1,143 @@
-module CukeModeler
-
-  # A class modeling a directory in a Cucumber suite.
-  class Directory < Model
-
-
-    # The feature file models contained by the modeled directory
-    attr_accessor :feature_files
-
-    # The directory models contained by the modeled directory
-    attr_accessor :directories
-
-    # The file path of the modeled directory
-    attr_accessor :path
-
-
-    # Creates a new Directory object and, if *directory_path* is provided,
-    # populates the object.
-    #
-    # @example
-    #   Directory.new
-    #   Directory.new('some/directory/path')
-    #
-    # @param directory_path [String] The directory path that will be used to populate the model
-    # @raise [ArgumentError] If *directory_path* is not a String
-    # @raise [ArgumentError] If the directory path does not exist
-    # @return [Directory] A new Directory instance
-    def initialize(directory_path = nil)
-      @path = directory_path
-      @feature_files = []
-      @directories = []
-
-      super
-    end
-
-    # Returns the name of the modeled directory.
-    #
-    # @example
-    #   d = Directory.new('some/directory/foo')
-    #   d.name  #=> 'foo'
-    #
-    # @return [String, nil] The name of the directory
-    def name
-      File.basename(@path.gsub('\\', '/')) if @path
-    end
-
-    # Returns the model objects that are children of this model. For a
-    # Directory model, these would be any associated Directory and FeatureFile
-    # models.
-    #
-    # @example
-    #   directory.children
-    #
-    # @return [Array<Directory, FeatureFile>] A collection of child models
-    def children
-      @feature_files + @directories
-    end
-
-    # Returns a string representation of this model. For a Directory
-    # model, this will be the path of the modeled directory.
-    #
-    # @example
-    #   directory.to_s #=> 'some/directory/path'
-    #
-    # @return [String] A string representation of this model
-    def to_s
-      path.to_s
-    end
-
-    # See `Object#inspect`. Returns some basic information about the
-    # object, including its class, object ID, and its most meaningful
-    # attribute. For a Directory model, this will be the path of the
-    # directory. If *verbose* is true, provides default Ruby inspection
-    # behavior instead.
-    #
-    # @example
-    #   directory.inspect
-    #   directory.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} @path: #{@path.inspect}>"
-    end
-
-
-    private
-
-
-    def process_source(directory_path)
-      raise(ArgumentError, "Unknown directory: #{directory_path.inspect}") unless File.exist?(directory_path)
-
-      process_directory(directory_path)
-    end
-
-    def process_directory(directory_path)
-      directory_data = { 'path'          => directory_path,
-                         'directories'   => [],
-                         'feature_files' => [] }
-
-      entries = Dir.entries(directory_path)
-      entries.delete '.'
-      entries.delete '..'
-
-      entries.each do |entry|
-        entry = "#{directory_path}/#{entry}"
-
-        # Ignore anything that isn't a directory or a feature file
-        if File.directory?(entry)
-          directory_data['directories'] << process_directory(entry)
-        elsif entry =~ /\.feature$/
-          directory_data['feature_files'] << process_feature_file(entry)
-        end
-      end
-
-
-      directory_data
-    end
-
-    def process_feature_file(file_path)
-      source_text = File.read(file_path)
-      feature_file_data = Parsing.parse_text(source_text, file_path)
-
-      feature_file_data.merge({ 'path' => file_path })
-    end
-
-    def populate_model(processed_directory_data)
-      @path = processed_directory_data['path']
-
-      processed_directory_data['directories'].each do |directory_data|
-        @directories << build_child_model(Directory, directory_data)
-      end
-
-      processed_directory_data['feature_files'].each do |feature_file_data|
-        @feature_files << build_child_model(FeatureFile, feature_file_data)
-      end
-    end
-
-  end
-end
+module CukeModeler
+
+  # A class modeling a directory in a Cucumber suite.
+  class Directory < Model
+
+
+    # The feature file models contained by the modeled directory
+    attr_accessor :feature_files
+
+    # The directory models contained by the modeled directory
+    attr_accessor :directories
+
+    # The file path of the modeled directory
+    attr_accessor :path
+
+
+    # Creates a new Directory object and, if *directory_path* is provided,
+    # populates the object.
+    #
+    # @example
+    #   Directory.new
+    #   Directory.new('some/directory/path')
+    #
+    # @param directory_path [String] The directory path that will be used to populate the model
+    # @raise [ArgumentError] If *directory_path* is not a String
+    # @raise [ArgumentError] If the directory path does not exist
+    # @return [Directory] A new Directory instance
+    def initialize(directory_path = nil)
+      @path = directory_path
+      @feature_files = []
+      @directories = []
+
+      super
+    end
+
+    # Returns the name of the modeled directory.
+    #
+    # @example
+    #   d = Directory.new('some/directory/foo')
+    #   d.name  #=> 'foo'
+    #
+    # @return [String, nil] The name of the directory
+    def name
+      File.basename(@path.gsub('\\', '/')) if @path
+    end
+
+    # Returns the model objects that are children of this model. For a
+    # Directory model, these would be any associated Directory and FeatureFile
+    # models.
+    #
+    # @example
+    #   directory.children
+    #
+    # @return [Array<Directory, FeatureFile>] A collection of child models
+    def children
+      @feature_files + @directories
+    end
+
+    # Returns a string representation of this model. For a Directory
+    # model, this will be the path of the modeled directory.
+    #
+    # @example
+    #   directory.to_s #=> 'some/directory/path'
+    #
+    # @return [String] A string representation of this model
+    def to_s
+      path.to_s
+    end
+
+    # See `Object#inspect`. Returns some basic information about the
+    # object, including its class, object ID, and its most meaningful
+    # attribute. For a Directory model, this will be the path of the
+    # directory. If *verbose* is true, provides default Ruby inspection
+    # behavior instead.
+    #
+    # @example
+    #   directory.inspect
+    #   directory.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} @path: #{@path.inspect}>"
+    end
+
+
+    private
+
+
+    def process_source(directory_path)
+      raise(ArgumentError, "Unknown directory: #{directory_path.inspect}") unless File.exist?(directory_path)
+
+      process_directory(directory_path)
+    end
+
+    def process_directory(directory_path)
+      directory_data = { 'path'          => directory_path,
+                         'directories'   => [],
+                         'feature_files' => [] }
+
+      entries = Dir.entries(directory_path)
+      entries.delete '.'
+      entries.delete '..'
+
+      entries.each do |entry|
+        entry = "#{directory_path}/#{entry}"
+
+        # Ignore anything that isn't a directory or a feature file
+        if File.directory?(entry)
+          directory_data['directories'] << process_directory(entry)
+        elsif entry =~ /\.feature$/
+          directory_data['feature_files'] << process_feature_file(entry)
+        end
+      end
+
+
+      directory_data
+    end
+
+    def process_feature_file(file_path)
+      source_text = File.read(file_path)
+      feature_file_data = Parsing.parse_text(source_text, file_path)
+
+      feature_file_data.merge({ 'path' => file_path })
+    end
+
+    def populate_model(processed_directory_data)
+      @path = processed_directory_data['path']
+
+      processed_directory_data['directories'].each do |directory_data|
+        @directories << build_child_model(Directory, directory_data)
+      end
+
+      processed_directory_data['feature_files'].each do |feature_file_data|
+        @feature_files << build_child_model(FeatureFile, feature_file_data)
+      end
+    end
+
+  end
+end