cuke_modeler 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c92f8c24b0eb10a93381bc8c70e4afff4be3af22
-  data.tar.gz: 878358f86a7f812b4d2268e708155f1c34b31ce1
+  metadata.gz: 329eb638d9b52dada19e21e6753722e0400d3991
+  data.tar.gz: dfb9d2bd435da763e2d0f909c68e3b36e7f30a98
 SHA512:
-  metadata.gz: 3fd79be1950f2d569a4456aca2c5eca55e2243e4957a0d094c657224c1179709adb19b353d1a46da74e556e3ebafa551f4c3e97e7537f0072074e9c572ea3514
-  data.tar.gz: d9852037c1c5394afa1240fd3f2a3ddde314606a999fd6ab93360bffd70df27a1cc58d0a852acf9c85f33db9f6367daf0fd4e8f9985825008f167dc6f734fa82
+  metadata.gz: d5e6e71f9dd644940330211fda900bf879f6451c4965b7265f197740784342d26c6a26fac59d3ef77e7a02382fa61ddfc085a1b31641ead50ace3f473e98c64b
+  data.tar.gz: 67da157b4e93b31a719b60a3ab191c2eaca7b324bc64d6bfd5d3fa62d7f7fb32ff8391319b787fe0116fd89470287911fb8f1ac6d74714fdef328631d54b287c

data/History.md

@@ -1,3 +1,15 @@
+### Version 1.1.0 / 2016-10-28
+
+* Support added for non-English dialects. This gem should now be able to model 
+  feature files using any dialect supported by the 'gherkin' gem.
+
+* Models for elements of Gherkin that have keywords (e.g. 'Feature', 'Scenario', 
+  'Examples') now keep track of the keyword used by the element that they model.
+
+* Bug fix - Fixed a bug that was causing example models to output extra newline 
+  characters under certain circumstances. 
+
+
 ### Version 1.0.4 / 2016-10-07
 
 * Bug Fix - Fixed a bug that caused some models to include nil objects in their 

data/lib/cuke_modeler/adapters/gherkin_2_adapter.rb

@@ -200,15 +200,15 @@ module CukeModeler
     def adapt_child_elements!(parsed_feature)
       if parsed_feature['elements']
         parsed_feature['elements'].each do |element|
-          case element['keyword']
-            when 'Background'
+          case element['type']
+            when 'background'
               adapt_background!(element)
-            when 'Scenario'
+            when 'scenario'
               adapt_scenario!(element)
-            when 'Scenario Outline'
+            when 'scenario_outline'
               adapt_outline!(element)
             else
-              raise("Unknown element keyword: #{element['keyword']}")
+              raise("Unknown element type: #{element['type']}")
           end
         end
       end

data/lib/cuke_modeler/adapters/gherkin_3_adapter.rb

@@ -22,6 +22,7 @@ module CukeModeler
       parsed_feature['cuke_modeler_parsing_data'][:scenarioDefinitions] = nil
       parsed_feature['cuke_modeler_parsing_data'][:background] = nil
 
+      parsed_feature['keyword'] = parsed_feature.delete(:keyword)
       parsed_feature['name'] = parsed_feature.delete(:name)
       parsed_feature['description'] = parsed_feature.delete(:description) || ''
       parsed_feature['line'] = parsed_feature.delete(:location)[:line]
@@ -46,7 +47,8 @@ module CukeModeler
       # Removing parsed data for child elements in order to avoid duplicating data
       parsed_background['cuke_modeler_parsing_data'][:steps] = nil
 
-      parsed_background['keyword'] = parsed_background.delete(:type).to_s
+      parsed_background['type'] = parsed_background.delete(:type).to_s
+      parsed_background['keyword'] = parsed_background.delete(:keyword).to_s
       parsed_background['name'] = parsed_background.delete(:name)
       parsed_background['description'] = parsed_background.delete(:description) || ''
       parsed_background['line'] = parsed_background.delete(:location)[:line]
@@ -122,6 +124,7 @@ module CukeModeler
       parsed_example['cuke_modeler_parsing_data'][:tableHeader] = nil
       parsed_example['cuke_modeler_parsing_data'][:tableBody] = nil
 
+      parsed_example['keyword'] = parsed_example.delete(:keyword)
       parsed_example['name'] = parsed_example.delete(:name)
       parsed_example['line'] = parsed_example.delete(:location)[:line]
       parsed_example['description'] = parsed_example.delete(:description) || ''
@@ -252,16 +255,16 @@ module CukeModeler
       # Saving off the original data
       parsed_test['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_test))
 
-      parsed_test['keyword'] = parsed_test.delete(:type).to_s
+      parsed_test['keyword'] = parsed_test.delete(:keyword)
+      parsed_test['type'] = parsed_test.delete(:type).to_s
 
-      case parsed_test['keyword']
+      case parsed_test['type']
         when 'Scenario'
           adapt_scenario!(parsed_test)
         when 'ScenarioOutline'
-          parsed_test['keyword'] = 'Scenario Outline'
           adapt_outline!(parsed_test)
         else
-          raise(ArgumentError, "Unknown test type: #{parsed_test['keyword']}")
+          raise(ArgumentError, "Unknown test type: #{parsed_test['type']}")
       end
     end
 

data/lib/cuke_modeler/adapters/gherkin_4_adapter.rb

@@ -20,6 +20,7 @@ module CukeModeler
       parsed_feature['cuke_modeler_parsing_data'][:tags] = nil
       parsed_feature['cuke_modeler_parsing_data'][:children] = nil
 
+      parsed_feature['keyword'] = parsed_feature.delete(:keyword)
       parsed_feature['name'] = parsed_feature.delete(:name)
       parsed_feature['description'] = parsed_feature.delete(:description) || ''
       parsed_feature['line'] = parsed_feature.delete(:location)[:line]
@@ -43,7 +44,8 @@ module CukeModeler
       # Removing parsed data for child elements in order to avoid duplicating data
       parsed_background['cuke_modeler_parsing_data'][:steps] = nil
 
-      parsed_background['keyword'] = parsed_background.delete(:type).to_s
+      parsed_background['type'] = parsed_background.delete(:type).to_s
+      parsed_background['keyword'] = parsed_background.delete(:keyword).to_s
       parsed_background['name'] = parsed_background.delete(:name)
       parsed_background['description'] = parsed_background.delete(:description) || ''
       parsed_background['line'] = parsed_background.delete(:location)[:line]
@@ -118,6 +120,7 @@ module CukeModeler
       parsed_example['cuke_modeler_parsing_data'][:tableHeader] = nil
       parsed_example['cuke_modeler_parsing_data'][:tableBody] = nil
 
+      parsed_example['keyword'] = parsed_example.delete(:keyword)
       parsed_example['name'] = parsed_example.delete(:name)
       parsed_example['line'] = parsed_example.delete(:location)[:line]
       parsed_example['description'] = parsed_example.delete(:description) || ''
@@ -264,16 +267,16 @@ module CukeModeler
       # Saving off the original data
       parsed_test['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_test))
 
-      parsed_test['keyword'] = parsed_test.delete(:type).to_s
+      parsed_test['keyword'] = parsed_test.delete(:keyword)
+      parsed_test['type'] = parsed_test.delete(:type).to_s
 
-      case parsed_test['keyword']
+      case parsed_test['type']
         when 'Scenario'
           adapt_scenario!(parsed_test)
         when 'ScenarioOutline'
-          parsed_test['keyword'] = 'Scenario Outline'
           adapt_outline!(parsed_test)
         else
-          raise(ArgumentError, "Unknown test type: #{parsed_test['keyword']}")
+          raise(ArgumentError, "Unknown test type: #{parsed_test['type']}")
       end
     end
 

data/lib/cuke_modeler/containing.rb

@@ -23,6 +23,7 @@ module CukeModeler
     def populate_scenario(scenario_object, parsed_scenario_data)
       populate_parsing_data(scenario_object, parsed_scenario_data)
       populate_source_line(scenario_object, parsed_scenario_data)
+      populate_keyword(scenario_object, parsed_scenario_data)
       populate_name(scenario_object, parsed_scenario_data)
       populate_description(scenario_object, parsed_scenario_data)
       populate_steps(scenario_object, parsed_scenario_data)
@@ -32,6 +33,7 @@ module CukeModeler
     def populate_outline(outline_object, parsed_outline_data)
       populate_parsing_data(outline_object, parsed_outline_data)
       populate_source_line(outline_object, parsed_outline_data)
+      populate_keyword(outline_object, parsed_outline_data)
       populate_name(outline_object, parsed_outline_data)
       populate_description(outline_object, parsed_outline_data)
       populate_steps(outline_object, parsed_outline_data)
@@ -41,6 +43,7 @@ module CukeModeler
 
     def populate_background(background_object, parsed_background_data)
       populate_parsing_data(background_object, parsed_background_data)
+      populate_keyword(background_object, parsed_background_data)
       populate_name(background_object, parsed_background_data)
       populate_description(background_object, parsed_background_data)
       populate_source_line(background_object, parsed_background_data)
@@ -93,6 +96,7 @@ module CukeModeler
 
     def populate_example(example_object, parsed_example_data)
       populate_parsing_data(example_object, parsed_example_data)
+      populate_keyword(example_object, parsed_example_data)
       populate_source_line(example_object, parsed_example_data)
       populate_name(example_object, parsed_example_data)
       populate_description(example_object, parsed_example_data)
@@ -109,6 +113,7 @@ module CukeModeler
     def populate_feature(feature_object, parsed_feature_data)
       populate_parsing_data(feature_object, parsed_feature_data)
       populate_source_line(feature_object, parsed_feature_data)
+      populate_keyword(feature_object, parsed_feature_data)
       populate_name(feature_object, parsed_feature_data)
       populate_description(feature_object, parsed_feature_data)
       populate_tags(feature_object, parsed_feature_data)
@@ -143,8 +148,8 @@ module CukeModeler
       step_model.text = parsed_step_data['name']
     end
 
-    def populate_keyword(step_model, parsed_step_data)
-      step_model.keyword = parsed_step_data['keyword'].strip
+    def populate_keyword(model, parsed_model_data)
+      model.keyword = parsed_model_data['keyword'].strip
     end
 
     def populate_row_models(table_model, parsed_table_data)
@@ -188,15 +193,15 @@ module CukeModeler
 
       if elements
         elements.each do |element|
-          case element['keyword']
-            when 'Scenario'
+          case element['type']
+            when 'Scenario', 'scenario'
               feature_model.tests << build_child_model(Scenario, element)
-            when 'Scenario Outline'
+            when 'ScenarioOutline', 'scenario_outline'
               feature_model.tests << build_child_model(Outline, element)
-            when 'Background'
+            when 'Background', 'background'
               feature_model.background = build_child_model(Background, element)
             else
-              raise(ArgumentError, "Unknown keyword: #{element['keyword']}")
+              raise(ArgumentError, "Unknown element type: #{element['type']}")
           end
         end
       end

data/lib/cuke_modeler/models/background.rb

@@ -4,6 +4,7 @@ module CukeModeler
 
   class Background < Model
 
+    include Parsing
     include Parsed
     include Named
     include Described
@@ -11,6 +12,10 @@ module CukeModeler
     include Sourceable
 
 
+    # The background's keyword
+    attr_accessor :keyword
+
+
     # Creates a new Background object and, if *source_text* is provided, populates
     # the object.
     def initialize(source_text = nil)
@@ -41,7 +46,7 @@ module CukeModeler
     def to_s
       text = ''
 
-      text << "Background:#{name_output_string}"
+      text << "#{@keyword}:#{name_output_string}"
       text << "\n" + description_output_string unless (description.nil? || description.empty?)
       text << "\n" unless (steps.empty? || description.nil? || description.empty?)
       text << "\n" + steps_output_string unless steps.empty?
@@ -54,7 +59,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature: Fake feature to parse\n"
+      base_file_string = "#{dialect_feature_keyword}: Fake feature to parse\n"
       source_text = base_file_string + source_text
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_background.feature')

data/lib/cuke_modeler/models/cell.rb

@@ -5,6 +5,7 @@ module CukeModeler
   class Cell < Model
 
     include Sourceable
+    include Parsing
     include Parsed
 
 
@@ -35,7 +36,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature: Fake feature to parse\nScenario:\n* fake step\n"
+      base_file_string = "#{dialect_feature_keyword}: Fake feature to parse\n#{dialect_scenario_keyword}:\n#{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')

data/lib/cuke_modeler/models/doc_string.rb

@@ -4,6 +4,7 @@ module CukeModeler
 
   class DocString < Model
 
+    include Parsing
     include Parsed
     include Sourceable
 
@@ -39,7 +40,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_doc_string.feature')

data/lib/cuke_modeler/models/example.rb

@@ -4,6 +4,7 @@ module CukeModeler
 
   class Example < Model
 
+    include Parsing
     include Parsed
     include Named
     include Described
@@ -11,6 +12,9 @@ module CukeModeler
     include Taggable
 
 
+    # The example's keyword
+    attr_accessor :keyword
+
     # The row models in the example table
     attr_accessor :rows
 
@@ -101,10 +105,10 @@ module CukeModeler
       text = ''
 
       text << tag_output_string + "\n" unless tags.empty?
-      text << "Examples:#{name_output_string}"
+      text << "#{@keyword}:#{name_output_string}"
       text << "\n" + description_output_string unless (description.nil? || description.empty?)
-      text << "\n" unless (description.nil? || description.empty?)
-      text << "\n" + parameters_output_string
+      text << "\n" unless (rows.empty? || description.nil? || description.empty?)
+      text << "\n" + parameters_output_string if parameter_row
       text << "\n" + rows_output_string unless argument_rows.empty?
 
       text
@@ -115,7 +119,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature: Fake feature to parse\nScenario Outline:\n* fake step\n"
+      base_file_string = "#{dialect_feature_keyword}: Fake feature to parse\n#{dialect_outline_keyword}:\n#{dialect_step_keyword} fake step\n"
       source_text = base_file_string + source_text
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_example.feature')

data/lib/cuke_modeler/models/feature.rb

@@ -11,6 +11,9 @@ module CukeModeler
     include Sourceable
 
 
+    # The keyword for the feature
+    attr_accessor :keyword
+
     # The Background object contained by the Feature
     attr_accessor :background
 
@@ -72,7 +75,7 @@ module CukeModeler
       text = ''
 
       text << tag_output_string + "\n" unless tags.empty?
-      text << "Feature:#{name_output_string}"
+      text << "#{@keyword}:#{name_output_string}"
       text << "\n" + description_output_string unless (description.nil? || description.empty?)
       text << "\n\n" + background_output_string if background
       text << "\n\n" + tests_output_string unless tests.empty?

data/lib/cuke_modeler/models/outline.rb

@@ -4,6 +4,7 @@ module CukeModeler
 
   class Outline < Model
 
+    include Parsing
     include Parsed
     include Named
     include Described
@@ -12,6 +13,9 @@ module CukeModeler
     include Taggable
 
 
+    # The outline's keyword
+    attr_accessor :keyword
+
     # The Example objects contained by the Outline
     attr_accessor :examples
 
@@ -49,7 +53,7 @@ module CukeModeler
       text = ''
 
       text << tag_output_string + "\n" unless tags.empty?
-      text << "Scenario Outline:#{name_output_string}"
+      text << "#{@keyword}:#{name_output_string}"
       text << "\n" + description_output_string unless (description.nil? || description.empty?)
       text << "\n" unless (steps.empty? || description.nil? || description.empty?)
       text << "\n" + steps_output_string unless steps.empty?
@@ -63,7 +67,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature: Fake feature to parse\n"
+      base_file_string = "#{dialect_feature_keyword}: Fake feature to parse\n"
       source_text = base_file_string + source_text
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_outline.feature')

data/lib/cuke_modeler/models/row.rb

@@ -5,6 +5,7 @@ module CukeModeler
   class Row < Model
 
     include Sourceable
+    include Parsing
     include Parsed
 
     # The cell models that make up the row
@@ -37,7 +38,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature: Fake feature to parse\nScenario:\n* fake step\n"
+      base_file_string = "#{dialect_feature_keyword}: Fake feature to parse\n#{dialect_scenario_keyword}:\n#{dialect_step_keyword} fake step\n"
       source_text = base_file_string + source_text
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_row.feature')

data/lib/cuke_modeler/models/scenario.rb

@@ -4,6 +4,7 @@ module CukeModeler
 
   class Scenario < Model
 
+    include Parsing
     include Parsed
     include Named
     include Described
@@ -12,6 +13,10 @@ module CukeModeler
     include Taggable
 
 
+    # The scenario's keyword
+    attr_accessor :keyword
+
+
     # Creates a new Scenario object and, if *source_text* is provided, populates the
     # object.
     def initialize(source_text = nil)
@@ -44,7 +49,7 @@ module CukeModeler
       text = ''
 
       text << tag_output_string + "\n" unless tags.empty?
-      text << "Scenario:#{name_output_string}"
+      text << "#{@keyword}:#{name_output_string}"
       text << "\n" + description_output_string unless (description.nil? || description.empty?)
       text << "\n" unless (steps.empty? || description.nil? || description.empty?)
       text << "\n" + steps_output_string unless steps.empty?
@@ -57,7 +62,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature: Fake feature to parse\n"
+      base_file_string = "#{dialect_feature_keyword}: Fake feature to parse\n"
       source_text = base_file_string + source_text
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_scenario.feature')

data/lib/cuke_modeler/models/step.rb

@@ -5,6 +5,7 @@ module CukeModeler
   class Step < Model
 
     include Sourceable
+    include Parsing
     include Parsed
 
 
@@ -56,7 +57,7 @@ module CukeModeler
 
 
     def parse_source(source_text)
-      base_file_string = "Feature: Fake feature to parse\nScenario:\n"
+      base_file_string = "#{dialect_feature_keyword}: Fake feature to parse\n#{dialect_scenario_keyword}:\n"
       source_text = base_file_string + source_text
 
       parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_step.feature')