cuke_modeler 3.19.0 → 3.20.1

data/testing/cucumber/features/modeling/directory_output.feature

@@ -1,16 +1,33 @@
 Feature: Directory output
 
-  A directory model's string output is simply the file path of the directory that it models. As such, output from a directory model can be used as input for the same kind of model.
+  A directory model's string output is simply the file path of the directory that it models and its
+  most relevant attribute for inspection is the path of the directory that it models.
 
 
-  Scenario: Outputting a directory model
+  Background:
     Given a directory model based on "some_directory"
-    When it is outputted
+
+
+  Scenario: Stringify a directory model
+    When the model is output as a string
+      """
+      @model.to_s
+      """
     Then the following text is provided:
       """
       <path_to>/some_directory
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Directory.new(@model.to_s)
+      CukeModeler::Directory.new(@model.to_s)
+      """
+
+  Scenario: Inspect a directory model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Directory:<object_id> @path: "<path_to>/some_directory">
       """

data/testing/cucumber/features/modeling/doc_string_output.feature

@@ -1,9 +1,10 @@
 Feature: Doc string output
 
-  A doc string model's string output is a Gherkin representation of itself. As such, output from a doc string model can be used as input for the same kind of model.
+  A doc string model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the content of the doc string that it models.
 
 
-  Scenario: Outputting a doc string model
+  Background:
     Given the following gherkin:
       """
       \"\"\" type foo
@@ -15,11 +16,14 @@ Feature: Doc string output
       """
     And a doc string model based on that gherkin
       """
-        @model = CukeModeler::DocString.new(<source_text>)
+      @model = CukeModeler::DocString.new(<source_text>)
       """
+
+
+  Scenario: Stringify a doc string model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -32,5 +36,15 @@ Feature: Doc string output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::DocString.new(@model.to_s)
+      CukeModeler::DocString.new(@model.to_s)
+      """
+
+  Scenario: Inspect a doc string model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::DocString:<object_id> @content: "Some text\n\n  some more text\n">
       """

data/testing/cucumber/features/modeling/example_output.feature

@@ -1,14 +1,15 @@
 Feature: Example output
 
-  An example model's string output is a Gherkin representation of itself. As such, output from an example model can be used as input for the same kind of model.
+  An example model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the name of the example that it models.
 
 
-  Scenario: Outputting an example model
+  Background:
     Given the following gherkin:
       """
       @tag1
       @tag2 @tag3
-      Examples: an example with everything that it could have
+      Examples: An example with everything that it could have
 
       Some description.
       Some more description.
@@ -19,16 +20,19 @@ Feature: Example output
       """
     And an example model based on that gherkin
       """
-        @model = CukeModeler::Example.new(<source_text>)
+      @model = CukeModeler::Example.new(<source_text>)
       """
+
+
+  Scenario: Stringify an example model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
       @tag1 @tag2 @tag3
-      Examples: an example with everything that it could have
+      Examples: An example with everything that it could have
 
       Some description.
       Some more description.
@@ -39,5 +43,15 @@ Feature: Example output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Example.new(@model.to_s)
+      CukeModeler::Example.new(@model.to_s)
+      """
+
+  Scenario: Inspect an example model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Example:<object_id> @name: "An example with everything that it could have">
       """

data/testing/cucumber/features/modeling/feature_file_output.feature

@@ -1,16 +1,33 @@
 Feature: Feature file output
 
-  A feature file model's string output is simply the file path of the feature file that it models. As such, output from a feature file model can be used as input for the same kind of model.
+  A feature file model's string output is simply the file path of the feature file that it models and its
+  most relevant attribute for inspection is the path of the feature file that it models.
 
 
-  Scenario: Outputting a feature file model
+  Background:
     Given a feature file model based on "some_feature_file.feature"
-    When it is outputted
+
+
+  Scenario: Stringify a feature file model
+    When the model is output as a string
+      """
+      @model.to_s
+      """
     Then the following text is provided:
       """
       <path_to>/some_feature_file.feature
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::FeatureFile.new(@model.to_s)
+      CukeModeler::FeatureFile.new(@model.to_s)
+      """
+
+  Scenario: Inspect a feature file model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::FeatureFile:<object_id> @path: "<path_to>/some_feature_file.feature">
       """

data/testing/cucumber/features/modeling/feature_output.feature

@@ -1,9 +1,10 @@
 Feature: Feature output
 
-  A feature model's string output is a Gherkin representation of itself. As such, output from a feature model can be used as input for the same kind of model.
+  A feature model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the name of the feature that it models.
 
 
-  Scenario: Outputting a feature model
+  Background:
     Given the following gherkin:
       """
       @tag1@tag2
@@ -28,7 +29,7 @@ Feature: Feature output
         some text
       \"\"\"
       Rule: a rule
-      Rule description 
+      Rule description
       Background: nested background
       * a step
       @outline_tag
@@ -53,11 +54,14 @@ Feature: Feature output
       """
     And a feature model based on that gherkin
       """
-        @model = CukeModeler::Feature.new(<source_text>)
+      @model = CukeModeler::Feature.new(<source_text>)
       """
+
+
+  Scenario: Stringify a feature model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -126,5 +130,15 @@ Feature: Feature output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Feature.new(@model.to_s)
+      CukeModeler::Feature.new(@model.to_s)
+      """
+
+  Scenario: Inspect a feature model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Feature:<object_id> @name: "A feature with everything it could have">
       """

data/testing/cucumber/features/modeling/model_output.feature

@@ -1,13 +1,61 @@
 Feature: Model output
 
-  All models can be output in text form. For models that represent parts of the file structure, this text will be a path and for models that represent parts of a feature file, this text will be Gherkin (see the model output documentation for specific models for details).
+  All models can be output in text form via `#to_s`. For models that represent parts of the file structure, this text
+  usually is a path. For models that represent parts of a feature file, this text usually is Gherkin. In any case, the
+  output is in a format that can be used to create the same kind of model.
 
+  Due to the nested nature of model relationships, the default output of `#inspect` can get...lengthy. For this reason,
+  all models override `#inspect` to make it provide a minimal but useful amount of information on the model object.
+  Switching between the minimal and the verbose (i.e. default Ruby behavior) version is controlled by a flag.
 
-  Scenario: Outputting a model
+  See the model output documentation for specific models for details.
+
+
+  Scenario: Stringify a model
     Given the models provided by CukeModeler
-    Then  all of them can be output as text appropriate to the model type
+    Then all of them can be output as text appropriate to the model type
       """
-        model = <model_class>.new
+      model = <model_class>.new
         
-        model.to_s
+      model.to_s
+      """
+
+  Scenario: Inspect a model
+
+  Note: The base model class, `CukeModeler::Model` lacks any "meaningful attributes"
+
+    Given the models provided by CukeModeler
+    Then all of them can provide a custom inspection output
+      """
+      model = <model_class>.new
+
+      model.inspect
+      """
+    And the inspection values are of the form:
       """
+      #<CukeModeler::<model_class>:<object_id> <some_meaningful_attribute>: <attribute_value>>
+      """
+    But the base model class inspection value is of the form:
+      """
+      #<CukeModeler::<model_class>:<object_id>>
+      """
+
+  Scenario: Controlling inspection output
+
+  Note: Non-verbose inspection is the default behavior for models
+
+    Given the models provided by CukeModeler
+    When using non-verbose inspection
+    """
+    model = <model_class>.new
+
+    model.inspect(verbose: false)
+    """
+    Then the custom model inspection is used
+    When using verbose inspection
+    """
+    model = <model_class>.new
+
+    model.inspect(verbose: true)
+    """
+    Then the default Ruby inspection is used

data/testing/cucumber/features/modeling/outline_output.feature

@@ -1,9 +1,10 @@
 Feature: Outline output
 
-  An outline model's string output is a Gherkin representation of itself. As such, output from an outline model can be used as input for the same kind of model.
+  An outline model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the name of the outline that it models.
 
 
-  Scenario: Outputting an outline model
+  Background:
     Given the following gherkin:
       """
       @tag1@tag2
@@ -33,11 +34,14 @@ Feature: Outline output
       """
     And an outline model based on that gherkin
       """
-        @model = CukeModeler::Outline.new(<source_text>)
+      @model = CukeModeler::Outline.new(<source_text>)
       """
+
+
+  Scenario: Stringify an outline model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -69,5 +73,15 @@ Feature: Outline output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Outline.new(@model.to_s)
+      CukeModeler::Outline.new(@model.to_s)
+      """
+
+  Scenario: Inspect an outline model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Outline:<object_id> @name: "An outline with everything that it could have">
       """

data/testing/cucumber/features/modeling/row_output.feature

@@ -1,20 +1,24 @@
 Feature: Row output
 
-  A row model's string output is a Gherkin representation of itself. As such, output from a row model can be used as input for the same kind of model.
+  A row model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the collection of cells of the row that it models.
 
 
-  Scenario: Outputting a row model
+  Background:
     Given the following gherkin:
       """
       |foo|bar|
       """
     And a row model based on that gherkin
       """
-        @model = CukeModeler::Row.new(<source_text>)
+      @model = CukeModeler::Row.new(<source_text>)
       """
+
+
+  Scenario: Stringify a row model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -22,5 +26,15 @@ Feature: Row output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Row.new(@model.to_s)
+      CukeModeler::Row.new(@model.to_s)
+      """
+
+  Scenario: Inspect a row model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Row:<object_id> @cells: ["foo", "bar"]>
       """

data/testing/cucumber/features/modeling/rule_output.feature

@@ -1,11 +1,11 @@
 Feature: Rule output
 
-  A rule model's string output is a Gherkin representation of itself. As such, output from a rule model can be used as
-  input for the same kind of model.
+  A rule model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the name of the rule that it models.
 
 
   @gherkin_min_version_18
-  Scenario: Outputting a rule model
+  Scenario: Stringify a rule model
     Given the following gherkin:
       """
       @tag1@tag2
@@ -49,11 +49,11 @@ Feature: Rule output
       """
     And a rule model based on that gherkin
       """
-        @model = CukeModeler::Rule.new(<source_text>)
+      @model = CukeModeler::Rule.new(<source_text>)
       """
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -111,5 +111,26 @@ Feature: Rule output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Rule.new(@model.to_s)
+      CukeModeler::Rule.new(@model.to_s)
+      """
+
+  Scenario: Inspect a rule model
+    Given the following gherkin:
+      """
+      Rule: some rule
+
+        Scenario: a scenario
+          * a step
+      """
+    And a rule model based on that gherkin
+      """
+      @model = CukeModeler::Rule.new(<source_text>)
+      """
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Rule:<object_id> @name: "some rule">
       """

data/testing/cucumber/features/modeling/scenario_output.feature

@@ -1,9 +1,10 @@
 Feature: Scenario output
 
-  A scenario model's string output is a Gherkin representation of itself. As such, output from a scenario model can be used as input for the same kind of model.
+  A scenario model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the name of the scenario that it models.
 
 
-  Scenario: Outputting a scenario model
+  Background:
     Given the following gherkin:
       """
       @tag1@tag2
@@ -22,11 +23,14 @@ Feature: Scenario output
       """
     And a scenario model based on that gherkin
       """
-        @model = CukeModeler::Scenario.new(<source_text>)
+      @model = CukeModeler::Scenario.new(<source_text>)
       """
+
+
+  Scenario: Stringify a scenario model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -45,5 +49,15 @@ Feature: Scenario output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Scenario.new(@model.to_s)
+      CukeModeler::Scenario.new(@model.to_s)
+      """
+
+  Scenario: Inspect a scenario model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Scenario:<object_id> @name: "A scenario with everything that it could have">
       """

data/testing/cucumber/features/modeling/step_output.feature

@@ -1,9 +1,10 @@
 Feature: Step output
 
-  A step model's string output is a Gherkin representation of itself. As such, output from a step model can be used as input for the same kind of model.
+  A step model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the text of the step that it models.
 
 
-  Scenario: Outputting a step model
+  Background:
 
   Note: Outputting a step that has a doc string is accomplished in the same manner
 
@@ -15,11 +16,14 @@ Feature: Step output
       """
     And a step model based on that gherkin
       """
-        @model = CukeModeler::Step.new(<source_text>)
+      @model = CukeModeler::Step.new(<source_text>)
       """
+
+
+  Scenario: Stringify a step model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -29,5 +33,15 @@ Feature: Step output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Step.new(@model.to_s)
+      CukeModeler::Step.new(@model.to_s)
+      """
+
+  Scenario: Inspect a step model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Step:<object_id> @text: "a step">
       """

data/testing/cucumber/features/modeling/table_output.feature

@@ -1,9 +1,10 @@
 Feature: Table output
 
-  A table model's string output is a Gherkin representation of itself. As such, output from a table model can be used as input for the same kind of model.
+  A table model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the collection of rows of the table that it models.
 
 
-  Scenario: Outputting a table model
+  Background:
     Given the following gherkin:
       """
       |value1|value2|
@@ -11,8 +12,11 @@ Feature: Table output
       """
     And a table model based on that gherkin
       """
-        @model = CukeModeler::Table.new(<source_text>)
+      @model = CukeModeler::Table.new(<source_text>)
       """
+
+
+  Scenario: Stringify a table model
     When the model is output as a string
       """
         @model.to_s
@@ -24,5 +28,15 @@ Feature: Table output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Table.new(@model.to_s)
+      CukeModeler::Table.new(@model.to_s)
+      """
+
+  Scenario: Inspect a table model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Table:<object_id> @rows: [["value1", "value2"], ["value3", "value4"]]>
       """

data/testing/cucumber/features/modeling/tag_output.feature

@@ -1,20 +1,24 @@
 Feature: Tag output
 
-  A tag model's string output is a Gherkin representation of itself. As such, output from a tag model can be used as input for the same kind of model.
+  A tag model's string output is a Gherkin representation of itself and its most relevant attribute for
+  inspection is the name of the tag that it models.
 
 
-  Scenario: Outputting a tag model
+  Background:
     Given the following gherkin:
       """
       @a_tag
       """
     And a tag model based on that gherkin
       """
-        @model = CukeModeler::Tag.new(<source_text>)
+      @model = CukeModeler::Tag.new(<source_text>)
       """
+
+
+  Scenario: Stringify a tag model
     When the model is output as a string
       """
-        @model.to_s
+      @model.to_s
       """
     Then the following text is provided:
       """
@@ -22,5 +26,15 @@ Feature: Tag output
       """
     And the output can be used to make an equivalent model
       """
-        CukeModeler::Tag.new(@model.to_s)
+      CukeModeler::Tag.new(@model.to_s)
+      """
+
+  Scenario: Inspect a tag model
+    When the model is inspected
+      """
+      @model.inspect
+      """
+    Then the following text is provided:
+      """
+      #<CukeModeler::Tag:<object_id> @name: "@a_tag">
       """