cuke_modeler 1.4.0 → 3.0.0

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.idea/*

data/.simplecov

@@ -1,7 +0,0 @@
-SimpleCov.start do
-  root File.dirname(__FILE__)
-
-  add_filter '/testing/'
-
-  merge_timeout 300
-end

data/.travis.yml

@@ -1,54 +0,0 @@
-os:
-  - linux
-  - osx
-
-language: ruby
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - 2.3.3
-  - 2.4.0
-  - jruby-9.1.7.0
-
-gemfile:
-  - testing/gemfiles/gherkin2.gemfile
-  - testing/gemfiles/gherkin3.gemfile
-  - testing/gemfiles/gherkin4.gemfile
-  - testing/gemfiles/gherkin5.gemfile
-  - testing/gemfiles/gherkin6.gemfile
-
-matrix:
-  exclude:
-  # gherkin 3.x does not work with Ruby 1.8.x
-  - rvm: 1.8.7
-    gemfile: testing/gemfiles/gherkin3.gemfile
-  # gherkin 4.x does not work with Ruby 1.8.x
-  - rvm: 1.8.7
-    gemfile: testing/gemfiles/gherkin4.gemfile
-  # gherkin 5.x does not work with Ruby 1.8.x
-  - rvm: 1.8.7
-    gemfile: testing/gemfiles/gherkin5.gemfile
-  # gherkin 6.x does not work with Ruby 1.8.x
-  - rvm: 1.8.7
-    gemfile: testing/gemfiles/gherkin6.gemfile
-  # gherkin 6.x does not work with Ruby 1.9.x
-  - rvm: 1.9.3
-    gemfile: testing/gemfiles/gherkin6.gemfile
-
-  # TODO: turn this back on
-  # gherkin 6.x relies on 'google-protobuf', which does not currently work on JRuby (https://github.com/protocolbuffers/protobuf/issues/1594)
-  - rvm: jruby-9.1.7.0
-    gemfile: testing/gemfiles/gherkin6.gemfile
-
-  # Travis does not provide 1.8.7 on OSX
-  - rvm: 1.8.7
-    os: osx
-  # Travis does not provide 1.9.3 on OSX
-  - rvm: 1.9.3
-    os: osx
-
-# todo - Remove this once TravisCI fixes their bundler issue (https://github.com/alphagov/govuk_template/pull/186)
-before_install:
-  - gem install bundler -v 1.9.10
-
-script: bundle exec rake cuke_modeler:ci_build

data/Gemfile

@@ -1,36 +0,0 @@
-source 'http://rubygems.org'
-
-# Specify your gem's dependencies in cuke_modeler.gemspec
-gemspec
-
-# cuke_modeler can play with pretty much any version of these but they all play differently with Ruby
-
-if RUBY_VERSION =~ /^1\./
-
-  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
-    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
-  end
-
-  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
-  gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
-  gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
-  gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
-
-  if RUBY_VERSION =~ /^1\.8/
-    gem 'cucumber', '~> 1.0' # Ruby 1.8.x support dropped after this version
-    gem 'gherkin', '< 2.12.1' # Ruby 1.8.x support dropped after this version
-    gem 'rake', '< 11.0' # Ruby 1.8.x support dropped after this version
-  else
-    gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
-    gem 'cucumber', '< 3.0.0' # Ruby 1.9.x support dropped after this version
-  end
-
-elsif RUBY_VERSION =~ /^2\./
-
-  if RUBY_VERSION =~ /^2\.[23456789]/
-    gem 'test-unit'
-  end
-
-  gem 'gherkin', '~> 6.0'
-  gem 'cucumber', '~>4.0.rc'
-end

data/History.md

@@ -1,191 +0,0 @@
-### Version 1.4.0 / 2018-11-14
-
-* Now compatible with Gherkin 6.x.
-
-
-### 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/Rakefile

@@ -1,63 +0,0 @@
-require "bundler/gem_tasks"
-require 'coveralls/rake/task'
-
-require 'racatt'
-
-
-namespace 'cuke_modeler' do
-
-  task :clear_coverage do
-    code_coverage_directory = "#{File.dirname(__FILE__)}/coverage"
-
-    FileUtils.remove_dir(code_coverage_directory, true)
-  end
-
-
-  Racatt.create_tasks
-
-  # Redefining the task from 'racatt' in order to clear the code coverage results
-  task :test_everything => :clear_coverage
-
-
-  # The task that CI will use
-  Coveralls::RakeTask.new
-  task :ci_build => [:smart_test, 'coveralls:push']
-
-  desc 'Test gem based on Ruby/dependency versions'
-  task :smart_test do |t, args|
-    rspec_args = '--tag ~@wip --pattern testing/rspec/spec/**/*_spec.rb'
-
-    cucumber_version = Gem.loaded_specs['cucumber'].version.version
-
-    if cucumber_version =~ /^[123]\./
-      cucumber_args = 'testing/cucumber/features -r testing/cucumber/support -r testing/cucumber/step_definitions -f progress -t ~@wip'
-    else
-      cucumber_args = "testing/cucumber/features -r testing/cucumber/support -r testing/cucumber/step_definitions -f progress -t 'not @wip'"
-    end
-
-    Rake::Task['cuke_modeler:test_everything'].invoke(rspec_args, cucumber_args)
-  end
-
-
-  # The task used to publish the current feature file documentation to Relish
-  desc 'Publish feature files to Relish'
-  task :publish_features do
-    # Get existing versions
-    this_dir = File.dirname(__FILE__)
-    output = `relish versions enkessler/CukeModeler`
-
-    # Add the current version if it doesn't exist
-    unless output =~ /#{Regexp.escape(CukeModeler::VERSION)}/
-      output = `relish versions:add enkessler/CukeModeler:#{CukeModeler::VERSION}`
-      puts output
-    end
-
-    # Publish the features
-    output = `relish push enkessler/CukeModeler:#{CukeModeler::VERSION} path #{this_dir}/testing/cucumber`
-    puts output
-  end
-
-end
-
-
-task :default => 'cuke_modeler:smart_test'

data/appveyor.yml

@@ -1,43 +0,0 @@
-version: '1.0.{build}'
-
-environment:
-  matrix:
-
-      # Gherkin 2.x does not appear to support 32-bit Ruby 2.x and it's not worth it to investigate if this is true or not
-    - RUBY_VERSION: 23-x64
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin2.gemfile
-
-    - RUBY_VERSION: 23
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin3.gemfile
-    - RUBY_VERSION: 23-x64
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin3.gemfile
-
-    - RUBY_VERSION: 23
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin4.gemfile
-    - RUBY_VERSION: 23-x64
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin4.gemfile
-
-    - RUBY_VERSION: 23
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin5.gemfile
-    - RUBY_VERSION: 23-x64
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin5.gemfile
-
-      # Gherkin 6.x requires at least Ruby 2.2
-    - RUBY_VERSION: 23
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin6.gemfile
-    - RUBY_VERSION: 23-x64
-      BUNDLE_GEMFILE: testing/gemfiles/gherkin6.gemfile
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle install
-
-build: off
-
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-
-test_script:
-  - bundle exec rake

data/lib/cuke_modeler/adapters/gherkin_2_adapter.rb

@@ -1,273 +0,0 @@
-module CukeModeler
-
-  # An adapter that can convert the output of version 2.x of the *gherkin* gem into input that is consumable by this gem.
-
-  class Gherkin2Adapter
-
-    # Adapts the given AST into the shape that this gem expects
-    def adapt(parsed_ast)
-      parsed_data = {}
-
-      # The entire AST is just an array with one feature and we don't want to save any child data so...an empty array
-      parsed_data['cuke_modeler_parsing_data'] = []
-
-      # Comments are stored on child elements in gherkin 2.x
-      comments = []
-
-      # An AST is just one feature
-      adapt_feature!(parsed_ast.first, comments) if parsed_ast.first
-      parsed_data['feature'] = parsed_ast.first
-
-      # Adapt and store comments once they have all been gathered
-      comments.each do |comment|
-        adapt_comment!(comment)
-      end
-      parsed_data['comments'] = comments
-
-
-      [parsed_data]
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given feature node.
-    def adapt_feature!(parsed_feature, gathered_comments)
-      # Saving off the original data
-      parsed_feature['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_feature))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_feature['cuke_modeler_parsing_data']['tags'] = nil
-      parsed_feature['cuke_modeler_parsing_data']['elements'] = nil
-
-      if parsed_feature['comments']
-        parsed_feature['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_feature['comments'])
-      end
-
-      adapt_child_elements!(parsed_feature, gathered_comments)
-
-      if parsed_feature['tags']
-        parsed_feature['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given background node.
-    def adapt_background!(parsed_background, gathered_comments)
-      # Saving off the original data
-      parsed_background['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_background))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_background['cuke_modeler_parsing_data']['steps'] = nil
-
-      if parsed_background['comments']
-        parsed_background['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_background['comments'])
-      end
-
-      if parsed_background['steps']
-        parsed_background['steps'].each do |step|
-          adapt_step!(step, gathered_comments)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given scenario node.
-    def adapt_scenario!(parsed_scenario, gathered_comments)
-      # Saving off the original data
-      parsed_scenario['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_scenario))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_scenario['cuke_modeler_parsing_data']['tags'] = nil
-      parsed_scenario['cuke_modeler_parsing_data']['steps'] = nil
-
-      if parsed_scenario['comments']
-        parsed_scenario['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_scenario['comments'])
-      end
-
-      if parsed_scenario['tags']
-        parsed_scenario['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-
-      if parsed_scenario['steps']
-        parsed_scenario['steps'].each do |step|
-          adapt_step!(step, gathered_comments)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given outline node.
-    def adapt_outline!(parsed_outline, gathered_comments)
-      # Saving off the original data
-      parsed_outline['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_outline))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_outline['cuke_modeler_parsing_data']['tags'] = nil
-      parsed_outline['cuke_modeler_parsing_data']['steps'] = nil
-      parsed_outline['cuke_modeler_parsing_data']['examples'] = nil
-
-      if parsed_outline['comments']
-        parsed_outline['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_outline['comments'])
-      end
-
-      if parsed_outline['tags']
-        parsed_outline['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-
-      if parsed_outline['steps']
-        parsed_outline['steps'].each do |step|
-          adapt_step!(step, gathered_comments)
-        end
-      end
-
-      if parsed_outline['examples']
-        parsed_outline['examples'].each do |example|
-          adapt_example!(example, gathered_comments)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given example node.
-    def adapt_example!(parsed_example, gathered_comments)
-      # Saving off the original data
-      parsed_example['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_example))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_example['cuke_modeler_parsing_data']['tags'] = nil
-      parsed_example['cuke_modeler_parsing_data']['rows'] = nil
-
-      if parsed_example['comments']
-        parsed_example['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_example['comments'])
-      end
-
-      parsed_example['rows'].each do |row|
-        adapt_table_row!(row, gathered_comments)
-      end
-
-      if parsed_example['tags']
-        parsed_example['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given tag node.
-    def adapt_tag!(parsed_tag)
-      # Saving off the original data
-      parsed_tag['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_tag))
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given comment node.
-    def adapt_comment!(parsed_comment)
-      # Saving off the original data
-      parsed_comment['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_comment))
-
-      parsed_comment['text'] = parsed_comment.delete('value')
-      parsed_comment['line'] = parsed_comment.delete('line')
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given step node.
-    def adapt_step!(parsed_step, gathered_comments)
-      # Saving off the original data
-      parsed_step['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_step))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_step['cuke_modeler_parsing_data']['rows'] = nil if parsed_step['cuke_modeler_parsing_data']['rows']
-      parsed_step['cuke_modeler_parsing_data']['doc_string'] = nil if parsed_step['cuke_modeler_parsing_data']['doc_string']
-
-      if parsed_step['comments']
-        parsed_step['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_step['comments'])
-      end
-
-      adapt_doc_string!(parsed_step['doc_string']) if parsed_step['doc_string']
-
-      if parsed_step['rows']
-        parsed_step['table'] = {'rows' => parsed_step['rows']}
-        adapt_step_table!(parsed_step['table'], gathered_comments)
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given doc string node.
-    def adapt_doc_string!(parsed_doc_string)
-      # Saving off the original data
-      parsed_doc_string['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_doc_string))
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given table node.
-    def adapt_step_table!(parsed_step_table, gathered_comments)
-      # Saving off the original data
-      parsed_step_table['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_step_table['rows']))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_step_table['cuke_modeler_parsing_data'].clear
-
-
-      parsed_step_table['line'] = parsed_step_table['rows'].first['line']
-
-      parsed_step_table['rows'].each do |row|
-        adapt_table_row!(row, gathered_comments)
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given row node.
-    def adapt_table_row!(parsed_table_row, gathered_comments)
-      # Saving off the original data
-      parsed_table_row['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_table_row))
-
-      # Removing parsed data for child elements in order to avoid duplicating data which the child elements will themselves include
-      parsed_table_row['cuke_modeler_parsing_data']['cells'] = nil
-
-      if parsed_table_row['comments']
-        parsed_table_row['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_table_row['comments'])
-      end
-
-      parsed_table_row['cells'].collect! do |cell|
-        create_cell_for(cell, parsed_table_row['line'])
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given cell node.
-    def create_cell_for(parsed_cell, line_number)
-      cell = {}
-
-      # Saving off the original data
-      cell['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_cell))
-
-      cell['value'] = parsed_cell
-      cell['line'] = line_number
-
-
-      cell
-    end
-
-
-    private
-
-
-    def adapt_child_elements!(parsed_feature, gathered_comments)
-      if parsed_feature['elements']
-        parsed_feature['elements'].each do |element|
-          case element['type']
-            when 'background'
-              adapt_background!(element, gathered_comments)
-            when 'scenario'
-              adapt_scenario!(element, gathered_comments)
-            when 'scenario_outline'
-              adapt_outline!(element, gathered_comments)
-            else
-              raise(ArgumentError, "Unknown element type: #{element['type']}")
-          end
-        end
-      end
-    end
-
-  end
-end