cuke_modeler 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aba3b67c01fe77623220706770527d9f418fda77
+  data.tar.gz: 1435b488abd5ab3dd950c15c1eca2fa9ae4ed667
+SHA512:
+  metadata.gz: 05804620e288fc68ebdc259cd87cfbd325bdb6dec0ecc9b6836e3ba25b510146435b58db17966495d1c61fc0beb1bea6ba7b85461ccb40bc5ce2405b812902b4
+  data.tar.gz: 98c6e9d3f981873da08d1fcec2cc6d3d7c1db79f749c192e8f6c08b757f43bb08795516488ecec58a63181420a1be27e9fbf72b7d046ceb32461ca9eb50b1b9f

data/.travis.yml

@@ -9,12 +9,15 @@ rvm:
 gemfile:
   - gemfiles/gherkin.gemfile
   - gemfiles/gherkin3.gemfile
+  - gemfiles/gherkin4.gemfile
 
 
 matrix:
   exclude:
   - rvm: 1.8.7
     gemfile: gemfiles/gherkin3.gemfile
+  - rvm: 1.8.7
+    gemfile: gemfiles/gherkin4.gemfile
 
 # todo - Remove this once TravisCI fixes their bundler issue (https://github.com/alphagov/govuk_template/pull/186)
 before_install:

data/Gemfile

@@ -9,12 +9,13 @@ if RUBY_VERSION =~ /^1\.8/
   gem 'gherkin', '<2.12.0'
   gem 'mime-types', '<2.0.0'
   gem 'rest-client', '<1.7.0'
+  gem 'rake', '< 11.0' # Rake dropped 1.8.x support after this version
 elsif RUBY_VERSION =~ /^1\./
   gem 'cucumber', '<2.0.0'
 end
 
 if RUBY_VERSION =~ /^2\./
-  gem 'gherkin', '>= 3.0.0'
+  gem 'gherkin', '~> 4.0'
 end
 
 if RUBY_VERSION =~ /^2\.[23456789]/

data/History.rdoc

@@ -1,11 +1,18 @@
-=== Version 0.1.0 / 2016-02-21
+=== 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.
 
 
 === Version 0.1.0 / 2016-02-10
 
-* Support for version 3.0 of the 'gherkin' gem added.
+* Support for version 3.x of the 'gherkin' gem added.
 
 
 === Version 0.0.2 / 2015-11-22

data/Rakefile

@@ -26,7 +26,16 @@ namespace 'cuke_modeler' do
   desc 'Test gem based on Ruby/dependency versions'
   task :smart_test do |t, args|
     rspec_args = ''
-    cucumber_args = Gem.loaded_specs['gherkin'].version.version[/^3/] ? '-t ~@gherkin' : '-t ~@gherkin3'
+
+    case
+      when Gem.loaded_specs['gherkin'].version.version[/^4/]
+        cucumber_args = '-t ~@gherkin -t ~@gherkin3'
+      when Gem.loaded_specs['gherkin'].version.version[/^3/]
+        cucumber_args = '-t ~@gherkin -t ~@gherkin4'
+      else
+        cucumber_args = '-t ~@gherkin3 -t ~@gherkin4'
+    end
+
     cucumber_args += ' -f progress'
 
     Rake::Task['cuke_modeler:test_everything'].invoke(rspec_args, cucumber_args)

data/cuke_modeler.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'gherkin', '< 4.0'
+  spec.add_runtime_dependency 'gherkin', '< 5.0'
   spec.add_runtime_dependency('json', '~> 1.0')
   spec.add_runtime_dependency('multi_json', '~> 1.0')
 

data/features/modeling/gherkin4/background_modeling.feature

@@ -0,0 +1,64 @@
+@gherkin4
+Feature: Background elements can be modeled.
+
+
+  Acceptance criteria
+
+  1. All conceptual pieces of a background can be modeled:
+  - the background's name
+  - the background's description
+  - the background's steps
+  - the background's source line
+  - the background's raw element
+
+  2. Backgrounds can be outputted in a convenient form
+
+
+  Background: Test file setup.
+    Given the following feature file:
+    """
+    Feature:
+
+      Background: Some general test setup stuff.
+            
+        Some background description.
+    
+      Some more.
+          Even more.
+
+        Given a setup step
+        And another setup step
+        When an action step
+    """
+    And parameter delimiters of "*" and "*"
+    When the file is read
+
+
+  Scenario: The raw background element is modeled.
+    Then the background correctly stores its underlying implementation
+
+  Scenario: The background source line is modeled.
+    Then the background is found to have the following properties:
+      | source_line | 3 |
+
+  Scenario: The background name is modeled.
+    Then the background is found to have the following properties:
+      | name | Some general test setup stuff. |
+
+  Scenario: The background description is modeled.
+    Then the background has the following description:
+      """
+          Some background description.
+
+        Some more.
+            Even more.
+      """
+
+  Scenario: The background steps are modeled.
+    Then the background's steps are as follows:
+      | a setup step       |
+      | another setup step |
+      | an action step     |
+
+  Scenario: Convenient output of a background
+    Then the background has convenient output

data/features/modeling/gherkin4/background_output.feature

@@ -0,0 +1,131 @@
+@gherkin4
+Feature: Outputting background elements
+
+  The output of an element model is a representation of the element as it would
+  appear in gherkin.
+
+
+  Scenario: Output of a background that does not have a name
+    Given a background element based on the following gherkin:
+    """
+    Background:
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Background:
+    """
+
+  Scenario: Output of a background that does have a name
+    Given a background element based on the following gherkin:
+    """
+    Background: with a name
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Background: with a name
+    """
+
+  Scenario: Output of a background that has a description, no first line buffer
+    Given a background element based on the following gherkin:
+    """
+    Background:
+    Some description.
+    Some more description.
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Background:
+      
+      Some description.
+      Some more description.
+    """
+
+  Scenario: Output of a background that has a description, first line is blank
+    Given a background element based on the following gherkin:
+    """
+    Background:
+
+    Some description.
+    Some more description.
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Background:
+      
+      Some description.
+      Some more description.
+    """
+
+  Scenario: Output of a background that has a description, first line is only whitespace
+    Given a background element based on the following gherkin:
+    """
+    Background:
+       
+    Some description.
+    Some more description.
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Background:
+      
+      Some description.
+      Some more description.
+    """
+
+  Scenario: Output of a background that has steps
+    Given a background element based on the following gherkin:
+    """
+    Background:
+     * a step
+    |value|
+    * another step
+    \"\"\"
+      some string
+    \"\"\"
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Background:
+      * a step
+        | value |
+      * another step
+        \"\"\"
+          some string
+        \"\"\"
+    """
+
+  Scenario: Output of a background that contains all possible parts
+    Given a background element based on the following gherkin:
+    """
+    Background: A background with everything it could have
+    Including a description
+    and then some.
+
+    * a step
+    |value|
+    * another step
+    \"\"\"
+      some string
+    \"\"\"
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Background: A background with everything it could have
+      
+      Including a description
+      and then some.
+
+      * a step
+        | value |
+      * another step
+        \"\"\"
+          some string
+        \"\"\"
+    """

data/features/modeling/gherkin4/directory_modeling.feature

@@ -0,0 +1,110 @@
+@gherkin4
+Feature: Directories can be modeled.
+
+
+  Acceptance criteria
+
+  1. Directories containing feature files can be modeled:
+  - the directory's name
+  - the directory's full path
+  - all feature files contained
+  - all directories contained
+
+  2. Directories can be outputted in a convenient form
+
+
+  Background: Setup test directories
+    Given a directory "feature_directory"
+    And the following feature file "test_file_1.feature":
+    """
+    Feature: The test feature 1.
+
+      Scenario: The first scenario's name.
+        Given the first step
+        When the second step
+        Then the third step
+    """
+    And the following feature file "test_file_2.feature":
+    """
+    Feature: The test feature 2.
+
+      Scenario: The first scenario's name.
+        Given the first step
+        When the second step
+        Then the third step
+    """
+    And the following feature file "test_file_3.feature":
+    """
+    Feature: The test feature 3.
+
+      Scenario: The first scenario's name.
+        Given the first step
+        When the second step
+        Then the third step
+    """
+    And the following file "random.file":
+    """
+    Not a .feature file.
+    """
+    Given a directory "feature_directory/nested_directory"
+    And the following feature file "test_file_4.feature":
+    """
+    Feature: The test feature 1.
+
+      Scenario: The first scenario's name.
+        Given the first step
+        When the second step
+        Then the third step
+    """
+    And the following feature file "test_file_5.feature":
+    """
+    Feature: The test feature 2.
+
+      Scenario: The first scenario's name.
+        Given the first step
+        When the second step
+        Then the third step
+    """
+    And the following file "another_random.file":
+    """
+    Not a .feature file.
+    """
+    When the directory "feature_directory" is read
+    And the directory "feature_directory/nested_directory" is read
+
+  Scenario: The directory's name is modeled.
+    Then directory "1" is found to have the following properties:
+      | name | feature_directory |
+    And directory "2" is found to have the following properties:
+      | name | nested_directory |
+
+  Scenario: The directory's full path is modeled.
+    Then directory "1" is found to have the following properties:
+      | path | path_to/feature_directory |
+    And directory "2" is found to have the following properties:
+      | path | path_to/feature_directory/nested_directory |
+
+  Scenario: The directory's feature files are modeled.
+    Then directory "1" is found to have the following properties:
+      | feature_file_count | 3 |
+    And directory "1" feature files are as follows:
+      | test_file_1.feature |
+      | test_file_2.feature |
+      | test_file_3.feature |
+    Then directory "2" is found to have the following properties:
+      | feature_file_count | 2 |
+    And directory "2" feature files are as follows:
+      | test_file_4.feature |
+      | test_file_5.feature |
+
+  Scenario: The directory's directories are modeled.
+    Then directory "1" is found to have the following properties:
+      | directory_count | 1 |
+    And directory "1" directories are as follows:
+      | nested_directory |
+    Then directory "2" is found to have the following properties:
+      | directory_count | 0 |
+    And directory "2" has no directories
+
+  Scenario: Convenient output of a directory
+    Then the directory has convenient output

data/features/modeling/gherkin4/directory_output.feature

@@ -0,0 +1,14 @@
+@gherkin4
+Feature: Outputting directory elements
+
+  The output of an element model is a representation of the element as it would
+  appear in gherkin.
+
+
+  Scenario: Output of a directory
+    Given a directory element based on "some_directory"
+    When it is outputted
+    Then the following text is provided:
+    """
+    path_to/some_directory
+    """

data/features/modeling/gherkin4/doc_string_modeling.feature

@@ -0,0 +1,53 @@
+@gherkin4
+Feature: Doc string elements can be modeled.
+
+
+  Acceptance criteria
+
+  1. All conceptual pieces of a doc string can be modeled:
+  - the doc string's content type
+  - the doc string's contents
+  - the doc string's raw element
+
+  2. Doc string can be outputted in a convenient form
+
+
+  Background: Test file setup.
+    Given the following feature file:
+    """
+    Feature:
+
+      Scenario:
+        * some wordy step:
+        \"\"\" content type
+      some text
+          
+            some more text
+        
+        \"\"\"
+        * some wordy step:
+        \"\"\"
+        \"\"\"
+    """
+    When the file is read
+
+
+  Scenario: The raw doc string element is modeled.
+    Then the doc string correctly stores its underlying implementation
+
+  Scenario: The doc string's content type is modeled.
+    Then the step "1" doc string content type is "content type"
+    And the step "2" doc string has no content type
+
+  Scenario: The doc string's contents are modeled.
+    Then the step "1" doc string has the following contents:
+      """
+      some text
+        
+          some more text
+      
+      """
+    And the step "2" doc string contents are empty
+
+  Scenario: Convenient output of an a doc string
+    Then the doc string has convenient output