cuke_modeler 1.3.0 → 2.1.0

data/History.md

@@ -1,186 +0,0 @@
-### Version 1.3.0 / 2017-10-19
-
-* Now compatible with Gherkin 5.x.
-
-
-### Version 1.2.1 / 2017-04-25
-
-* Now officially compatible with Rake 12.x.
-
-
-### Version 1.2.0 / 2016-11-23
-
-* The comments in a feature file are now a modeled element.
-
-
-### Version 1.1.1 / 2016-10-28
-
-* Bug fix - Abstract instantiation of models when using a non-default dialect 
-  now works correctly.
-
-
-### 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 
-  children collection if they did not have the relevant child object.
-
-
-### Version 1.0.3 / 2016-09-12
-
-* Fixed a gem dependency that was accidentally declared with '<=' instead of '<'.
-
-
-### Version 1.0.2 / 2016-09-12
-
-* A more detailed gem description and summary have been added to the gemspec.
-
-* The gem now declares version limits on its dependencies.
- 
-* Badges for the current status of the project have been added to the Readme.
-
-
-### Version 1.0.1 / 2016-09-10
-
-* In the Readme file, added a link to the published documentation.
-
-
-### Version 1.0.0 / 2016-09-08
-
-* All modeled elements of a Cucumber test suite are now modeled with actual 
-  classes. Previously, some elements (such as tags or rows in an example table) 
-  were modeled with simple strings.
-
-* A base model class has been added in order to simplify adding new element 
-  models. Other classes and modules used for organizing common model behavior 
-  have been created/removed/renamed.
-
-* Feature file models now only have a single feature model instead of a 
-  collection of them (that would only ever have one item in it).
-
-* Rows in an example table and rows in a step table no longer use two different 
-  classes for modeling.
-
-* Background models can now be compared to other models that have steps (i.e. 
-  scenarios and outlines).
-
-* All models for Gherkin elements now track the line number from which they 
-  originate in a source file.
-
-* The source line of a model is now a mutable attribute instead of being read 
-  only.
-
-* The file path of a feature file is now a mutable attribute instead of being 
-  read only.
-
-* Standardized the initial values of the attributes of abstractly created 
-  models so that they are consistent across model types.
-
-* Added specific ancestor types for scenario, outline, and background models as 
-  alternatives to the generic 'test' ancestor type.
-
-* Extra whitespace around parsed element descriptions is now trimmed away 
-  before being stored in a model.
-  
-* Adding rows to examples via hashes can now be done without regard to the 
-  order of the keys in the hash. The correct order can be determined by the 
-  model.
-
-* The saved parsing data that is generated by the 'gherkin' gem is no longer 
-  duplicated for each model, resulting in significantly less memory usage.
-
-* String output of models has been improved. More special characters in Gherkin 
-  (e.g. vertical bars in rows) are appropriately escaped in the string output 
-  of a model and several minor bugs related to using model string output as the 
-  input text for new models have been fixed.
-
-* Removed the backdoor used to pass around model data during the model creation 
-  process. Model input can now only be text.
-
-* Simple counting methods have been removed. Ruby's collection methods are just 
-  as easy to use directly when dealing with classes that contain collections 
-  and the removal of these counting methods simplifies the codebase.
-
-* The 'World' module has been removed. The scope of this gem is to model files 
-  written in Gherkin. Concepts like 'step definitions' and 'hooks' are better 
-  left to libraries that include (possibly programming language specific) test 
-  execution logic within their scope of concern.
-
-* Step models no longer have 'arguments' because they require the concept of 
-  step definitions, which are no longer within the scope of this gem.
-
-* Removed deprecated behavior
-    - Marked
-        - Doc strings no longer use an array of strings to model their content
-        - Tables no longer use nested arrays of strings to model their rows
-        - Models that have descriptions no longer use an array of strings to 
-          model their description
-        - The convenient (read: awkward) #step_text has been removed.
-    - Unmarked
-        - Examples no longer use an array of hashes to model their rows
-
-* Various methods have been renamed.
-
-
-### Version 0.4.1 / 2016-05-12
-
-* Increased the flexibility of input when adding rows to an Example object. Non-
-  string values can now be used as input and they will be converted into 
-  strings. Original input objects are not modified.
-
-* Added some error checking around adding value rows to an Example object 
-  without adding a parameter row as well.
-
-
-### Version 0.4.0 / 2016-05-01
-
-* The path of a Directory object is now a changeable attribute instead of only 
-  being populated if the instance was given a diretory to model.
-
-* Bug fix - Fixed a bug that occurred if a Directory object was asked for its 
-  \#name when it was created as 'abstract' instead of modeling an existing 
-  directory.
-
-
-### Version 0.3.0 / 2016-04-24
-
-* Support for version 4.x of the 'gherkin' gem added.
-
-* Bug fix - Fixed a bug that was preventing Example objects from being created 
-  from text if that text had less Gherkin structure than normal.
-
-
-### Version 0.2.0 / 2016-02-21
-
-* Better error feedback when parsing errors are encountered. It is now easier 
-  to tell which file contained invalid Gherkin.
-
-
-### Version 0.1.0 / 2016-02-10
-
-* Support for version 3.x of the 'gherkin' gem added.
-
-* Bug fix - The saved parsing data that is generated by the 'gherkin' gem is no 
-  longer modified by the rest of the model creation process.
-
-
-### Version 0.0.2 / 2015-11-22
-
-* Bug fix - Fixed a bug that was causing object comparison using #== to not 
-  work when comparing some models to other types of objects.
-
-
-### Version 0.0.1 / 2014-06-02
-
-* Initial release

data/testing/cucumber/support/transforms.rb

@@ -1,3 +0,0 @@
-Transform /^(-?\d+)$/ do |number|
-  number.to_i
-end

data/testing/rspec/spec/integration/step_integration_spec.rb

@@ -1,459 +0,0 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
-
-
-describe 'Step, Integration' do
-
-  let(:clazz) { CukeModeler::Step }
-
-
-  describe 'common behavior' do
-
-    it_should_behave_like 'a model, integration'
-
-  end
-
-  describe 'unique behavior' do
-
-    it 'can be instantiated with the minimum viable Gherkin' do
-      source = "#{@step_keyword} a step"
-
-      expect { clazz.new(source) }.to_not raise_error
-    end
-
-    it 'can parse text that uses a non-default dialect' do
-      original_dialect = CukeModeler::Parsing.dialect
-      CukeModeler::Parsing.dialect = 'en-au'
-
-      begin
-        source_text = "Y'know a step"
-
-        expect { @model = clazz.new(source_text) }.to_not raise_error
-
-        # Sanity check in case modeling failed in a non-explosive manner
-        expect(@model.keyword).to eq("Y'know")
-      ensure
-        # Making sure that our changes don't escape a test and ruin the rest of the suite
-        CukeModeler::Parsing.dialect = original_dialect
-      end
-    end
-
-    it 'provides a descriptive filename when being parsed from stand alone text' do
-      source = "bad step text\n And a step\n @foo"
-
-      expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_step\.feature'/)
-    end
-
-    it 'stores the original data generated by the parsing adapter (with a table)', :gherkin4 => true do
-      step = clazz.new("#{@step_keyword} test step\n|table|")
-      data = step.parsing_data
-
-      expect(data.keys).to match_array([:type, :location, :keyword, :text, :argument])
-      expect(data[:type]).to eq(:Step)
-    end
-
-    it 'stores the original data generated by the parsing adapter (with a doc string)', :gherkin4 => true do
-      step = clazz.new("#{@step_keyword} test step\n\"\"\"\na doc string\n\"\"\"")
-      data = step.parsing_data
-
-      expect(data.keys).to match_array([:type, :location, :keyword, :text, :argument])
-      expect(data[:type]).to eq(:Step)
-    end
-
-    it 'stores the original data generated by the parsing adapter (with a table)', :gherkin3 => true do
-      step = clazz.new("#{@step_keyword} test step\n|table|")
-      data = step.parsing_data
-
-      expect(data.keys).to match_array([:type, :location, :keyword, :text, :argument])
-      expect(data[:type]).to eq(:Step)
-    end
-
-    it 'stores the original data generated by the parsing adapter (with a doc string)', :gherkin3 => true do
-      step = clazz.new("#{@step_keyword} test step\n\"\"\"\na doc string\n\"\"\"")
-      data = step.parsing_data
-
-      expect(data.keys).to match_array([:type, :location, :keyword, :text, :argument])
-      expect(data[:type]).to eq(:Step)
-    end
-
-    it 'stores the original data generated by the parsing adapter (with a table)', :gherkin2 => true do
-      step = clazz.new("#{@step_keyword} test step\n|table|")
-      data = step.parsing_data
-
-      expect(data.keys).to match_array(['keyword', 'name', 'line', 'rows'])
-      expect(data['keyword']).to eq("#{@step_keyword} ")
-    end
-
-    it 'stores the original data generated by the parsing adapter (with a doc string)', :gherkin2 => true do
-      step = clazz.new("#{@step_keyword} test step\n\"\"\"\na doc string\n\"\"\"")
-      data = step.parsing_data
-
-      expect(data.keys).to match_array(['keyword', 'name', 'line', 'doc_string'])
-      expect(data['keyword']).to eq("#{@step_keyword} ")
-    end
-
-    describe 'model population' do
-
-      context 'from source text' do
-
-        let(:source_text) { "#{@step_keyword} a step" }
-        let(:step) { clazz.new(source_text) }
-
-
-        it "models the step's keyword" do
-          expect(step.keyword).to eq("#{@step_keyword}")
-        end
-
-        it "models the step's text" do
-          expect(step.text).to eq('a step')
-        end
-
-        it "models the step's source line" do
-          source_text = "#{@feature_keyword}:
-
-                           #{@scenario_keyword}: foo
-                             #{@step_keyword} step"
-          step = CukeModeler::Feature.new(source_text).tests.first.steps.first
-
-          expect(step.source_line).to eq(4)
-        end
-
-
-        context 'with no block' do
-
-          let(:source_text) { "#{@step_keyword} a step" }
-          let(:step) { clazz.new(source_text) }
-
-
-          it "models the step's block" do
-            expect(step.block).to be_nil
-          end
-
-        end
-
-        context 'a step with a table' do
-
-          let(:source_text) { "#{@step_keyword} a step
-                                 | value 1 |
-                                 | value 2 |" }
-          let(:step) { clazz.new(source_text) }
-
-
-          it "models the step's table" do
-            table_cell_values = step.block.rows.collect { |row| row.cells.collect { |cell| cell.value } }
-
-            expect(table_cell_values).to eq([['value 1'], ['value 2']])
-          end
-
-        end
-
-        context 'a step with a doc string' do
-
-          let(:source_text) { "#{@step_keyword} a step
-                                 \"\"\"
-                                 some text
-                                 \"\"\"" }
-          let(:step) { clazz.new(source_text) }
-
-
-          it "models the step's doc string" do
-            doc_string = step.block
-
-            expect(doc_string.content).to eq('some text')
-          end
-
-        end
-
-      end
-
-    end
-
-
-    it 'properly sets its child models' do
-      source_1 = "#{@step_keyword} a step
-                  \"\"\"
-                  a doc string
-                  \"\"\""
-      source_2 = "#{@step_keyword} a step
-                  | a block|"
-
-      step_1 = clazz.new(source_1)
-      step_2 = clazz.new(source_2)
-
-
-      doc_string = step_1.block
-      table = step_2.block
-
-      expect(doc_string.parent_model).to equal(step_1)
-      expect(table.parent_model).to equal(step_2)
-    end
-
-
-    describe 'step comparison' do
-
-      it 'is equal to another Step that has the same text' do
-        source_1 = "#{@step_keyword} a step"
-        source_2 = "#{@step_keyword} a step"
-        source_3 = "#{@step_keyword} a different step"
-
-        step_1 = clazz.new(source_1)
-        step_2 = clazz.new(source_2)
-        step_3 = clazz.new(source_3)
-
-
-        expect(step_1).to eq(step_2)
-        expect(step_1).to_not eq(step_3)
-      end
-
-      it 'ignores steps keywords when comparing steps' do
-        source_1 = "#{@given_keyword} a step"
-        source_2 = "#{@then_keyword}  a step"
-
-        step_1 = clazz.new(source_1)
-        step_2 = clazz.new(source_2)
-
-
-        expect(step_1).to eq(step_2)
-      end
-
-      it 'ignores step tables when comparing steps' do
-        source_1 = "#{@step_keyword} a step"
-        source_2 = "#{@step_keyword} a step\n|with a table|"
-
-        step_1 = clazz.new(source_1)
-        step_2 = clazz.new(source_2)
-
-
-        expect(step_1).to eq(step_2)
-      end
-
-      it 'ignores step doc strings when comparing steps' do
-        source_1 = "#{@step_keyword} a step"
-        source_2 = "#{@step_keyword} a step\n\"\"\"\nwith a doc string\n\"\"\""
-
-
-        step_1 = clazz.new(source_1)
-        step_2 = clazz.new(source_2)
-
-
-        expect(step_1).to eq(step_2)
-      end
-
-    end
-
-
-    describe 'getting ancestors' do
-
-      before(:each) do
-        CukeModeler::FileHelper.create_feature_file(:text => source_gherkin, :name => 'step_test_file', :directory => test_directory)
-      end
-
-
-      let(:test_directory) { CukeModeler::FileHelper.create_directory }
-      let(:source_gherkin) { "#{@feature_keyword}: Test feature
-
-                              #{@scenario_keyword}: Test test
-                                #{@step_keyword} a step:"
-      }
-
-      let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-      let(:step_model) { directory_model.feature_files.first.feature.tests.first.steps.first }
-
-
-      it 'can get its directory' do
-        ancestor = step_model.get_ancestor(:directory)
-
-        expect(ancestor).to equal(directory_model)
-      end
-
-      it 'can get its feature file' do
-        ancestor = step_model.get_ancestor(:feature_file)
-
-        expect(ancestor).to equal(directory_model.feature_files.first)
-      end
-
-      it 'can get its feature' do
-        ancestor = step_model.get_ancestor(:feature)
-
-        expect(ancestor).to equal(directory_model.feature_files.first.feature)
-      end
-
-
-      context 'a step that is part of a scenario' do
-
-        let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
-
-                                #{@scenario_keyword}: Test scenario
-                                  #{@step_keyword} a step"
-        }
-
-        let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-        let(:step_model) { directory_model.feature_files.first.feature.tests.first.steps.first }
-
-
-        it 'can get its scenario' do
-          ancestor = step_model.get_ancestor(:scenario)
-
-          expect(ancestor).to equal(directory_model.feature_files.first.feature.tests.first)
-        end
-
-      end
-
-      context 'a step that is part of an outline' do
-
-        let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
-
-                                #{@outline_keyword}: Test outline
-                                  #{@step_keyword} a step
-                                #{@example_keyword}:
-                                  | param |
-                                  | value |"
-        }
-
-        let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-        let(:step_model) { directory_model.feature_files.first.feature.tests.first.steps.first }
-
-
-        it 'can get its outline' do
-          ancestor = step_model.get_ancestor(:outline)
-
-          expect(ancestor).to equal(directory_model.feature_files.first.feature.tests.first)
-        end
-
-      end
-
-      context 'a step that is part of a background' do
-
-        let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
-
-                                #{@background_keyword}: Test background
-                                  #{@step_keyword} a step"
-        }
-
-        let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-        let(:step_model) { directory_model.feature_files.first.feature.background.steps.first }
-
-
-        it 'can get its background' do
-          ancestor = step_model.get_ancestor(:background)
-
-          expect(ancestor).to equal(directory_model.feature_files.first.feature.background)
-        end
-
-      end
-
-      it 'returns nil if it does not have the requested type of ancestor' do
-        ancestor = step_model.get_ancestor(:example)
-
-        expect(ancestor).to be_nil
-      end
-
-    end
-
-
-    describe 'step output' do
-
-      context 'from source text' do
-
-        context 'with no block' do
-
-          let(:source_text) { ["#{@step_keyword} a step"].join("\n") }
-          let(:step) { clazz.new(source_text) }
-
-          it 'can output a step' do
-            step_output = step.to_s.split("\n", -1)
-
-            expect(step_output).to eq(["#{@step_keyword} a step"])
-          end
-
-          it 'can be remade from its own output' do
-            step_output = step.to_s
-            remade_step_output = clazz.new(step_output).to_s
-
-            expect(remade_step_output).to eq(step_output)
-          end
-
-        end
-
-        context 'a step with a table' do
-
-          let(:source_text) { ["#{@step_keyword} a step",
-                               '  | value1 | value2 |',
-                               '  | value3 | value4 |'].join("\n") }
-          let(:step) { clazz.new(source_text) }
-
-
-          it 'can output a step that has a table' do
-            step_output = step.to_s.split("\n", -1)
-
-            expect(step_output).to eq(["#{@step_keyword} a step",
-                                       '  | value1 | value2 |',
-                                       '  | value3 | value4 |'])
-
-          end
-
-          it 'can be remade from its own output' do
-            step_output = step.to_s
-            remade_step_output = clazz.new(step_output).to_s
-
-            expect(remade_step_output).to eq(step_output)
-          end
-
-        end
-
-        context 'a step with a doc string' do
-
-          let(:source_text) { ["#{@step_keyword} a step",
-                               '  """',
-                               '  some text',
-                               '  """'].join("\n") }
-          let(:step) { clazz.new(source_text) }
-
-
-          it 'can output a step that has a doc string' do
-            step_output = step.to_s.split("\n", -1)
-
-            expect(step_output).to eq(["#{@step_keyword} a step",
-                                       '  """',
-                                       '  some text',
-                                       '  """'])
-          end
-
-          it 'can be remade from its own output' do
-            step_output = step.to_s
-            remade_step_output = clazz.new(step_output).to_s
-
-            expect(remade_step_output).to eq(step_output)
-          end
-
-        end
-
-      end
-
-
-      context 'from abstract instantiation' do
-
-        let(:step) { clazz.new }
-
-
-        it 'can output a step that has only a table' do
-          step.block = CukeModeler::Table.new
-
-          expect { step.to_s }.to_not raise_error
-        end
-
-        it 'can output a step that has only a doc string' do
-          step.block = CukeModeler::DocString.new
-
-          expect { step.to_s }.to_not raise_error
-        end
-
-      end
-
-    end
-
-  end
-
-end