cuke_modeler 1.0.4 → 1.1.0

data/lib/cuke_modeler/models/table.rb

@@ -4,6 +4,7 @@ module CukeModeler
 
   class Table < Model
 
+    include Parsing
     include Parsed
     include Sourceable
 
@@ -41,7 +42,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature:\nScenario:\n* step\n"
+      base_file_string = "#{dialect_feature_keyword}:\n#{dialect_scenario_keyword}:\n#{dialect_step_keyword} step\n"
       source_text = base_file_string + source_text
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_table.feature')

data/lib/cuke_modeler/models/tag.rb

@@ -4,6 +4,7 @@ module CukeModeler
 
   class Tag < Model
 
+    include Parsing
     include Parsed
     include Sourceable
 
@@ -34,7 +35,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "\nFeature: Fake feature to parse"
+      base_file_string = "\n#{dialect_feature_keyword}: Fake feature to parse"
       source_text = source_text + base_file_string
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_tag.feature')

data/lib/cuke_modeler/parsing.rb

@@ -73,6 +73,24 @@ module CukeModeler
 
     class << self
 
+      # The dialect that will be used to parse snippets of Gherkin text
+      attr_writer :dialect
+
+
+      # The dialect that will be used to parse snippets of Gherkin text
+      def dialect
+        @dialect || 'en'
+      end
+
+      # The dialects currently known by the gherkin gem
+      def dialects
+        unless @dialects
+          @dialects = Gem.loaded_specs['gherkin'].version.version[/^2/] ? Gherkin::I18n::LANGUAGES : Gherkin::DIALECTS
+        end
+
+        @dialects
+      end
+
       # Parses the Cucumber feature given in *source_text* and returns an array
       # containing the hash representation of its logical structure.
       def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
@@ -92,5 +110,32 @@ module CukeModeler
       end
 
     end
+
+
+    private
+
+
+    def dialect_feature_keyword
+      get_word(Parsing.dialects[Parsing.dialect]['feature'])
+    end
+
+    def dialect_scenario_keyword
+      get_word(Parsing.dialects[Parsing.dialect]['scenario'])
+    end
+
+    def dialect_outline_keyword
+      get_word(Parsing.dialects[Parsing.dialect]['scenarioOutline'] || Parsing.dialects[Parsing.dialect]['scenario_outline'])
+    end
+
+    def dialect_step_keyword
+      get_word(Parsing.dialects[Parsing.dialect]['given'])
+    end
+
+    def get_word(word_set)
+      word_set = word_set.is_a?(Array) ? word_set : word_set.split('|')
+
+      word_set.first
+    end
+
   end
 end

data/lib/cuke_modeler/version.rb

@@ -1,4 +1,4 @@
 module CukeModeler
   # The gem version
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

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

@@ -24,6 +24,13 @@ Feature: Background modeling
       """
 
 
+  Scenario: Modeling a backgrounds's keyword
+    When the backgrounds's keyword is requested
+      """
+        @model.keyword
+      """
+    Then the model returns "Background"
+
   Scenario: Modeling a backgrounds's name
     When the background's name is requested
       """

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

@@ -1,6 +1,7 @@
 Feature: Background output
 
-  A background model's string output is a Gherkin representation of itself.
+  A background model's string output is a Gherkin representation of itself. As such, output from a background model can be used as
+  input for the same kind of model.
 
 
   Scenario: Outputting a background model
@@ -40,3 +41,7 @@ Feature: Background output
             some string
           \"\"\"
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Background.new(@model.to_s)
+      """

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

@@ -1,6 +1,7 @@
 Feature: Directory output
 
-  A directory model's string output is simply the file path of the directory that it models.
+  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.
 
 
   Scenario: Outputting a directory model
@@ -10,3 +11,7 @@ Feature: Directory output
       """
       <path_to>/some_directory
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Directory.new(@model.to_s)
+      """

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

@@ -1,6 +1,7 @@
 Feature: Doc string output
 
-  A doc string model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting a doc string model
@@ -30,3 +31,7 @@ Feature: Doc string output
 
       \"\"\"
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::DocString.new(@model.to_s)
+      """

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

@@ -25,6 +25,13 @@ Feature: Example modeling
       """
 
 
+  Scenario: Modeling an example's keyword
+    When the example's keyword is requested
+      """
+        @model.keyword
+      """
+    Then the model returns "Examples"
+
   Scenario: Modeling an example's name
     When the example's name is requested
       """

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

@@ -1,6 +1,7 @@
 Feature: Example output
 
-  An example model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting an example model
@@ -37,3 +38,7 @@ Feature: Example output
         | value1 | value2 |
         | value3 | value4 |
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Example.new(@model.to_s)
+      """

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

@@ -1,6 +1,7 @@
 Feature: Feature file output
 
-  A feature file model's string output is simply the file path of the feature file that it models.
+  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.
 
 
   Scenario: Outputting a feature file model
@@ -10,3 +11,7 @@ Feature: Feature file output
       """
       <path_to>/some_feature_file.feature
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::FeatureFile.new(@model.to_s)
+      """

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

@@ -43,6 +43,13 @@ present in that feature.
       """
 
 
+  Scenario: Modeling a feature's keyword
+    When the feature's keyword is requested
+      """
+        @model.keyword
+      """
+    Then the model returns "Feature"
+
   Scenario: Modeling a feature's name
     When the feature's name is requested
       """

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

@@ -1,6 +1,7 @@
 Feature: Feature output
 
-  A feature model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting a feature model
@@ -102,3 +103,7 @@ Feature: Feature output
           | param |
           | value |
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Feature.new(@model.to_s)
+      """

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

@@ -2,8 +2,7 @@ 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). As such, output from a model can be used as
-  input for the same kind of model.
+  model output documentation for specific models for details).
 
 
   Scenario: Outputting a model
@@ -14,9 +13,3 @@ Feature: Model output
         
         model.to_s
       """
-    And the output can be used to make an equivalent model
-      """
-        model = <model_class>.new
-
-        <model_class>.new(model.to_s)
-      """

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

@@ -32,6 +32,13 @@ Feature: Outline modeling
       """
 
 
+  Scenario: Modeling an outline's keyword
+    When the outline's keyword is requested
+      """
+        @model.keyword
+      """
+    Then the model returns "Scenario Outline"
+
   Scenario: Modeling an outline's name
     When the outline's name is requested
       """

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

@@ -1,6 +1,7 @@
 Feature: Outline output
 
-  An outline model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting an outline model
@@ -67,3 +68,7 @@ Feature: Outline output
         | value |
         | y     |
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Outline.new(@model.to_s)
+      """

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

@@ -1,6 +1,7 @@
 Feature: Row output
 
-  A row model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting a row model
@@ -20,3 +21,7 @@ Feature: Row output
       """
       | foo | bar |
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Row.new(@model.to_s)
+      """

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

@@ -24,6 +24,13 @@ Feature: Scenario modeling
       """
 
 
+  Scenario: Modeling a scenario's keyword
+    When the scenario's keyword is requested
+      """
+        @model.keyword
+      """
+    Then the model returns "Scenario"
+
   Scenario: Modeling a scenario's name
     When the scenario's name is requested
       """

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

@@ -1,6 +1,7 @@
 Feature: Scenario output
 
-  A scenario model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting a scenario model
@@ -43,3 +44,7 @@ Feature: Scenario output
             some string
           \"\"\"
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Scenario.new(@model.to_s)
+      """

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

@@ -1,6 +1,7 @@
 Feature: Step output
 
-  A step model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting a step model
@@ -27,3 +28,7 @@ Feature: Step output
         | value1 |
         | value2 |
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Step.new(@model.to_s)
+      """

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

@@ -1,6 +1,7 @@
 Feature: Table output
 
-  A table model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting a table model
@@ -22,3 +23,7 @@ Feature: Table output
       | value1 | value2 |
       | value3 | value4 |
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Table.new(@model.to_s)
+      """

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

@@ -1,6 +1,7 @@
 Feature: Tag output
 
-  A tag model's string output is a Gherkin representation of itself.
+  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.
 
 
   Scenario: Outputting a tag model
@@ -20,3 +21,7 @@ Feature: Tag output
       """
       @a_tag
       """
+    And the output can be used to make an equivalent model
+      """
+        CukeModeler::Tag.new(@model.to_s)
+      """

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -1,6 +1,8 @@
 Then(/^all of them can be output as text appropriate to the model type$/) do |code_text|
+  original_text = code_text
+
   @available_model_classes.each do |clazz|
-    code_text.gsub!('<model_class>', clazz.to_s)
+    code_text = original_text.gsub('<model_class>', clazz.to_s)
 
     expect(clazz.instance_method(:to_s).owner).to equal(clazz), "#{clazz} does not override #to_s"
 
@@ -16,8 +18,10 @@ Then(/^the following text is provided:$/) do |expected_text|
 end
 
 Then(/^all of them can be contained inside of another model$/) do |code_text|
+  original_text = code_text
+
   @available_model_classes.each do |clazz|
-    code_text.gsub!('<model_class>', clazz.to_s)
+    code_text = original_text.gsub('<model_class>', clazz.to_s)
 
     expect(clazz.new).to respond_to(:parent_model)
 
@@ -27,8 +31,10 @@ Then(/^all of them can be contained inside of another model$/) do |code_text|
 end
 
 And(/^all of them can contain other models$/) do |code_text|
+  original_text = code_text
+
   @available_model_classes.each do |clazz|
-    code_text.gsub!('<model_class>', clazz.to_s)
+    code_text = original_text.gsub('<model_class>', clazz.to_s)
 
     expect(clazz.new).to respond_to(:children)
 
@@ -38,8 +44,10 @@ And(/^all of them can contain other models$/) do |code_text|
 end
 
 Then(/^all of them can be created without further context$/) do |code_text|
+  original_text = code_text
+
   @available_model_classes.each do |clazz|
-    code_text.gsub!('<model_class>', clazz.to_s)
+    code_text = original_text.gsub('<model_class>', clazz.to_s)
 
     expect { clazz.new }.to_not raise_error
 
@@ -73,18 +81,19 @@ Then(/^the model returns models for the following directories:$/) do |directory_
 end
 
 And(/^the output can be used to make an equivalent model$/) do |code_text|
-  @available_model_classes.each do |clazz|
-    code_text.gsub!('<model_class>', clazz.to_s)
+  clazz = @model.class
 
-    # More specific verification can't be done for this step because every model has a different
-    # populated shape and abstract shape isn't enough to be useful input to the model again.
+  base_output = @model.to_s
+  remodeled_output = clazz.new(base_output).to_s
 
-    # Make sure that the example code is valid
-    expect { eval(code_text) }.to_not raise_error
-  end
+  expect(remodeled_output).to eq(base_output)
+
+  # Make sure that the example code is valid
+  expect { eval(code_text) }.to_not raise_error
 end
 
 Then(/^all of them provide access to the parsing data that was used to create them$/) do |code_text|
+  original_text = code_text
   unparsed_models = [CukeModeler::Model, CukeModeler::FeatureFile, CukeModeler::Directory]
 
   @available_model_classes.each do |clazz|
@@ -93,7 +102,7 @@ Then(/^all of them provide access to the parsing data that was used to create th
     expect(clazz.new).to respond_to(:parsing_data)
 
     # Make sure that the example code is valid
-    code_text.gsub!('<model_class>', clazz.to_s)
+    code_text = original_text.gsub('<model_class>', clazz.to_s)
     code_text.gsub!('<source_text>', '')
 
     expect { eval(code_text) }.to_not raise_error