cucumber_lint 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59f628a63c86ef172e490dc170991ddef1985a98
-  data.tar.gz: e2d61829e08b5a7401c2956a10835600f9ea9721
+  metadata.gz: 4e04abaad578b72d7df4b49529bcdeceb3da0b0f
+  data.tar.gz: a13968b903cbf742e4a7d98b75c04900fb0859fa
 SHA512:
-  metadata.gz: f447e200f24df005c46b2a9902e40372e9f1e0b2b17d5f34a88fa1ac51b6f87383412f8023a9bcdc553193321b34c801c62c04b8187c8251fc174f701d8da52e
-  data.tar.gz: 8a7e79e55b286855daff422796482af173d987a2fe84c29b7d0b570aecf692414cbe5238bf0a576a93892f1548688a6826a17a65b0c2379e6f79cab927597742
+  metadata.gz: 831b6e7a3ef209caaa4c105dc9a079348a1c5fe7ddf59717c8811b2bf0d257654e9f1fc30941e4da263f5d4779873128b9ce77a51e67f120cd70d1765ca9d994
+  data.tar.gz: 22d26718f94e44ce99862b29c6ab7a30e194ed055210c5fb882dbc3af970befdf26c9f1a99a7c0ef4f47ff548f857e1b7c70ff82309bc335c199974fd12a27ae

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -1,10 +1,11 @@
 source 'http://rubygems.org'
 
-ruby '2.2.0'
+ruby '2.2.2'
 
 gemspec
 
 group :development do
+  gem 'activesupport'
   gem 'cucumber'
   gem 'open4'
   gem 'rake'

data/Gemfile.lock

@@ -2,64 +2,82 @@ PATH
   remote: .
   specs:
     cucumber_lint (0.0.4)
-      colorize (~> 0.7.5)
-      gherkin (~> 2.12.2, >= 2.12.2)
-      multi_json (~> 1.10.1, >= 1.10.1)
+      colorize (~> 0.7.7)
+      gherkin (~> 2.12.2)
+      multi_json (~> 1.11.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     builder (3.2.2)
-    colorize (0.7.5)
-    cucumber (1.3.18)
+    colorize (0.7.7)
+    cucumber (2.0.2)
       builder (>= 2.1.2)
+      cucumber-core (~> 1.2.0)
       diff-lcs (>= 1.1.3)
       gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.1)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.2.0)
+      gherkin (~> 2.12.0)
     diff-lcs (1.2.5)
     gherkin (2.12.2)
       multi_json (~> 1.3)
-    multi_json (1.10.1)
-    multi_test (0.1.1)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.0)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
     open4 (1.3.4)
-    parser (2.2.0.1)
+    parser (2.2.2.6)
       ast (>= 1.1, < 3.0)
-      slop (~> 3.4, >= 3.4.5)
-    powerpack (0.0.9)
+    powerpack (0.1.1)
     rainbow (2.0.0)
     rake (10.4.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    rubocop (0.28.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.33.0)
       astrolabe (~> 1.3)
-      parser (>= 2.2.0.pre.7, < 3.0)
-      powerpack (~> 0.0.6)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
-    ruby-progressbar (1.7.1)
-    slop (3.6.0)
+    ruby-progressbar (1.7.5)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   cucumber
   cucumber_lint!
   open4
   rake
   rspec
   rubocop
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -1,6 +1,6 @@
 # cucumber_lint
 [![Gem Version](https://badge.fury.io/rb/cucumber_lint.svg)](http://badge.fury.io/rb/cucumber_lint)
-[![Build Status](https://travis-ci.org/charlierudolph/cucumber_lint.svg)](https://travis-ci.org/charlierudolph/cucumber_lint)
+[![Build Status](https://travis-ci.org/charlierudolph/cucumber_lint.svg?branch=master)](https://travis-ci.org/charlierudolph/cucumber_lint)
 [![Dependency Status](https://gemnasium.com/charlierudolph/cucumber_lint.svg)](https://gemnasium.com/charlierudolph/cucumber_lint)
 [![Code Climate](https://codeclimate.com/github/charlierudolph/cucumber_lint/badges/gpa.svg)](https://codeclimate.com/github/charlierudolph/cucumber_lint)
 
@@ -19,32 +19,49 @@ cucumber_lint        # Lints (exits with status 1 on failure, 0 on success)
 cucumber_lint --fix  # Fixes all lint errors
 ```
 
-### Features
+### Configuration
 
-#### Repeating step keywords
-* Use `And` instead of repeating `Given`, `When`, or `Then`
+Create a `cucumber_lint.yml` file in the same folder that contains your `features` directory.
+Override the [default config](./config/default.yml) to disable a rule or change the enforced style.
 
-```coffee
-# Bad            # Good
-Given A          Given A
-Given B          And B
-When C           When C
-Then D           Then D
-Then E           And E
-```
+### Rules
 
-#### Table whitespace
-* requires leading and trailing space around the cell content
-* requires pipes to be aligned
+##### consistent_empty_lines
+* requires empty lines to be used consistently throughout features
 
 
-```coffee
-# Bad                         # Bad                                  # Good
-|VEGETABLE|CODENAME|          | VEGETABLE | CODENAME      |          | VEGETABLE | CODENAME |
-|Asparagus|Alpha|             |Asparagus | Alpha   |                 | Asparagus | Alpha    |
-|Broccoli|Bravo|              |Broccoli      | Bravo    |            | Broccoli  | Bravo    |
-|Carrot|Charlie|              |  Carrot| Charlie      |              | Carrot    | Charlie  |
-```
+##### consistent_table_headers
+* requires all table headers to have the same style
+  * supported styles: uppercase and lowercase
+  * scenario outline placeholders must share the same style
+
+
+##### consistent_table_whitespace
+* requires leading and trailing space around the cell content and the pipes to be aligned
+
+
+  ```coffee
+  # Bad                    # Bad                           # Good
+  |VEGETABLE|CODENAME|     | VEGETABLE | CODENAME   |      | VEGETABLE | CODENAME |
+  |Asparagus|Alpha|        |Asparagus | Alpha   |          | Asparagus | Alpha    |
+  |Broccoli|Bravo|         |Broccoli      | Bravo    |     | Broccoli  | Bravo    |
+  |Carrot|Charlie|         |  Carrot| Charlie      |       | Carrot    | Charlie  |
+  ```
+
+##### no_empty_features
+* empty `.feature` files are not allowed
+
+
+##### no_repeating_keywords
+* Use `And` instead of repeating `Given`, `When`, or `Then`
+
 
-#### Table headers and scenario outline placeholders
-* required to be uppercase
+  ```coffee
+  # Bad         # Good
+  Given A       Given A
+  Given B       And B
+  When C        When C
+  When D        And D
+  Then E        Then E
+  Then F        And F
+  ```

data/Rakefile

@@ -20,7 +20,7 @@ end
 
 desc 'Run features'
 task :features do
-  sh 'bundle exec cucumber'
+  sh 'bundle exec cucumber -f progress'
 end
 
 

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  override:
+    - bundle exec rake

data/config/default.yml

@@ -0,0 +1,27 @@
+consistent_empty_lines:
+  enabled: true
+  between_description_and_element: 1
+  between_elements: 1
+  between_feature_and_description: 0
+  between_feature_and_element: 1
+  between_scenario_outline_and_examples: 1
+
+
+consistent_table_headers:
+  enabled: true
+  enforced_style: uppercase
+  supported_styles:
+    - lowercase  # column header
+    - uppercase  # COLUMN HEADER
+
+
+consistent_table_whitespace:
+  enabled: true
+
+
+no_empty_features:
+  enabled: true
+
+
+no_repeating_keywords:
+  enabled: true

data/cucumber_lint.gemspec

@@ -12,11 +12,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/charlierudolph/cucumber_lint'
   spec.license       = 'MIT'
 
-  spec.add_runtime_dependency 'colorize', '~> 0.7.5'
-  spec.add_runtime_dependency 'gherkin', '~> 2.12.2', '>= 2.12.2'
-  spec.add_runtime_dependency 'multi_json', '~> 1.10.1', '>= 1.10.1'
+  spec.add_runtime_dependency 'colorize', '~> 0.7.7'
+  spec.add_runtime_dependency 'gherkin', '~> 2.12.2'
+  spec.add_runtime_dependency 'multi_json', '~> 1.11.2'
 
   spec.files         = `git ls-files`.split("\n")
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 end

data/features/cucumber_lint/consistent_empty_lines/between_description_and_scenario.feature

@@ -0,0 +1,39 @@
+Feature: consistent_empty_lines between description and scenario
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+        As a user
+        When I have this
+        I expect that
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+
+  Scenario: disabled
+    Given I have "consistent_empty_lines" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_empty_lines" enabled with "between_description_and_scenario" as "1"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE        |
+      | 5    | Add empty line |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+        As a user
+        When I have this
+        I expect that
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_docstring.feature

@@ -0,0 +1,47 @@
+Feature: consistent_empty_lines between elements (ending with docstring)
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+            \"\"\"
+            string
+            \"\"\"
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+
+  Scenario: disabled
+    Given I have "consistent_empty_lines" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_empty_lines" enabled with "between_elements" as "1"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE        |
+      | 9    | Add empty line |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+            \"\"\"
+            string
+            \"\"\"
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_examples.feature

@@ -0,0 +1,49 @@
+Feature: consistent_empty_lines between elements (ending with examples)
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario Outline: Test Scenario Outline
+          Given <a>
+          Then <b>
+
+          Examples:
+            | a    | b    |
+            | this | that |
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+
+  Scenario: disabled
+    Given I have "consistent_empty_lines" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_empty_lines" enabled with "between_elements" as "1"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE        |
+      | 10   | Add empty line |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario Outline: Test Scenario Outline
+          Given <a>
+          Then <b>
+
+          Examples:
+            | a    | b    |
+            | this | that |
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_step.feature

@@ -0,0 +1,41 @@
+Feature: consistent_empty_lines between elements (ending with step)
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+
+  Scenario: disabled
+    Given I have "consistent_empty_lines" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_empty_lines" enabled with "between_elements" as "1"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE        |
+      | 6    | Add empty line |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_table.feature

@@ -0,0 +1,43 @@
+Feature: consistent_empty_lines between elements (ending with table)
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+            | table |
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+
+  Scenario: disabled
+    Given I have "consistent_empty_lines" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_empty_lines" enabled with "elements" as "1"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE        |
+      | 7    | Add empty line |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+            | table |
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_empty_lines/between_feature_and_description.feature

@@ -0,0 +1,33 @@
+Feature: consistent_empty_lines between feature and description
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        As a user
+        When I have this
+        I expect that
+      """
+
+  Scenario: disabled
+    Given I have "consistent_empty_lines" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_empty_lines" enabled with "feature_and_description" as "1"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE           |
+      | 2    | Remove empty line |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+        As a user
+        When I have this
+        I expect that
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_empty_lines/between_feature_and_scenario.feature

@@ -0,0 +1,33 @@
+Feature: consistent_empty_lines between feature and scenario
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+
+  Scenario: disabled
+    Given I have "consistent_empty_lines" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_empty_lines" enabled with "between_feature_and_description" as "1"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE        |
+      | 2    | Add empty line |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given this
+          Then that
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_table_headers/examples_table.feature

@@ -0,0 +1,74 @@
+Feature: consistent_table_headers for an examples table
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario Outline: Test Scenario Outline
+          Given <VEGETABLE> and <fruit>
+          Then I expect <Code Name>
+
+          Examples:
+            | VEGETABLE | fruit  | Code Name |
+            | Asparagus | Apple  | Alpha     |
+            | Broccoli  | Banana | Bravo     |
+            | Carrot    | Cherry | Charlie   |
+      """
+
+  Scenario: disabled
+    Given I have "consistent_table_headers" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: uppercase - lint and fix
+    Given I have "consistent_table_headers" enabled with "enforced_style" as "uppercase"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE                 |
+      | 4    | uppercase "<fruit>"     |
+      | 5    | uppercase "<Code Name>" |
+      | 8    | uppercase table headers |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario Outline: Test Scenario Outline
+          Given <VEGETABLE> and <FRUIT>
+          Then I expect <CODE NAME>
+
+          Examples:
+            | VEGETABLE | FRUIT  | CODE NAME |
+            | Asparagus | Apple  | Alpha     |
+            | Broccoli  | Banana | Bravo     |
+            | Carrot    | Cherry | Charlie   |
+      """
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lowercase - lint and fix
+    Given I have "consistent_table_headers" enabled with "enforced_style" as "lowercase"
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE                 |
+      | 4    | lowercase "<VEGETABLE>" |
+      | 5    | lowercase "<Code Name>" |
+      | 8    | lowercase table headers |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario Outline: Test Scenario Outline
+          Given <vegetable> and <fruit>
+          Then I expect <code name>
+
+          Examples:
+            | vegetable | fruit  | code name |
+            | Asparagus | Apple  | Alpha     |
+            | Broccoli  | Banana | Bravo     |
+            | Carrot    | Cherry | Charlie   |
+      """
+    When I run `cucumber_lint`
+    Then it passes