cucumber_lint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d357226ed5d21c9e3b55736ba03019f023dce69e
-  data.tar.gz: 4b0998c48b5d3e4df9ac658b979ac543dc032811
+  metadata.gz: 59f628a63c86ef172e490dc170991ddef1985a98
+  data.tar.gz: e2d61829e08b5a7401c2956a10835600f9ea9721
 SHA512:
-  metadata.gz: 851e8c5aaa639c14fb2185cec529f03f29bce5b9ccaa8c6177da58257b93f85bf77d69ab54dfc4ed1c59645b4944961c844d736c3cad8008fa2742cf79febc65
-  data.tar.gz: c769b2952189beb4f574a01bfec1479f6716de886280ee239696b4d4328313dec4adc013d314d25606b9a5f2c737f2768ad8492d7303e730b01d1243725ce328
+  metadata.gz: f447e200f24df005c46b2a9902e40372e9f1e0b2b17d5f34a88fa1ac51b6f87383412f8023a9bcdc553193321b34c801c62c04b8187c8251fc174f701d8da52e
+  data.tar.gz: 8a7e79e55b286855daff422796482af173d987a2fe84c29b7d0b570aecf692414cbe5238bf0a576a93892f1548688a6826a17a65b0c2379e6f79cab927597742

data/.rubocop.yml

@@ -6,10 +6,6 @@ Metrics/MethodLength:
   Max: 11
 
 
-Style/Documentation:
-  Enabled: false
-
-
 Style/EmptyLines:
   Enabled: false
 

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.2.0
+
+cache: bundler
+
+script:
+  - rake

data/Gemfile

@@ -4,8 +4,10 @@ ruby '2.2.0'
 
 gemspec
 
-gem 'cucumber'
-gem 'open4'
-gem 'rake'
-gem 'rspec'
-gem 'rubocop'
+group :development do
+  gem 'cucumber'
+  gem 'open4'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    cucumber_lint (0.0.3)
+    cucumber_lint (0.0.4)
       colorize (~> 0.7.5)
+      gherkin (~> 2.12.2, >= 2.12.2)
+      multi_json (~> 1.10.1, >= 1.10.1)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -1,4 +1,8 @@
 # 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)
+[![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)
 
 A command line linter and formatter for cucumber features
 
@@ -15,48 +19,32 @@ cucumber_lint        # Lints (exits with status 1 on failure, 0 on success)
 cucumber_lint --fix  # Fixes all lint errors
 ```
 
-### Tables
-* requires at a space leading and trailing cell content
-* requires pipes to be aligned
-
-Bad
-````
-|header_column1|header_column2|
-|row1_column1|row1_column2|
-|row2_column1|row2_column2|
-|row3_column1|row3_column2|
-```
-Bad
-```
-| header_column1 | header_column2      |
-| row1_column1 | row1_column2           |
-| row2_column1      | row2_column2    |
-  | row3_column1 | row3_column2      |
-```
-Good
-```
-| header_column1 | header_column2 |
-| row1_column1   | row1_column2   |
-| row2_column1   | row2_column2   |
-| row3_column1   | row3_column2   |
-```
+### Features
 
-### Steps
+#### Repeating step keywords
 * Use `And` instead of repeating `Given`, `When`, or `Then`
 
-Bad
+```coffee
+# Bad            # Good
+Given A          Given A
+Given B          And B
+When C           When C
+Then D           Then D
+Then E           And E
 ```
-Given A
-Given B
-When C
-Then D
-Then E
-```
-Good
-```
-Given A
-And B
-When C
-Then D
-And E
+
+#### Table whitespace
+* requires leading and trailing space around the cell content
+* requires 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  |
 ```
+
+#### Table headers and scenario outline placeholders
+* required to be uppercase

data/Rakefile

@@ -1,17 +1,23 @@
 desc 'Run all linters and specs'
-task default: %w(lint spec features)
+task default: %w(lint features)
 
 
-desc 'Run linters'
-task :lint do
+desc 'Run all linters and specs'
+task lint: %w(lint:ruby lint:cucumber)
+
+
+desc 'Run ruby linters'
+task 'lint:ruby' do
   sh 'bundle exec rubocop'
 end
 
-desc 'Run specs'
-task :spec do
-  sh 'bundle exec rspec'
+
+desc 'Run cucumber linters'
+task 'lint:cucumber' do
+  sh 'bundle exec cucumber_lint'
 end
 
+
 desc 'Run features'
 task :features do
   sh 'bundle exec cucumber'

data/cucumber_lint.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   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.files         = `git ls-files`.split("\n")
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }

data/features/cucumber_lint/fix/nothing.feature

@@ -0,0 +1,12 @@
+Feature: fixing
+
+  Scenario: nothing
+    Given I have no files
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+
+
+      0 files inspected
+      """
+    And it exits with status 0

data/features/cucumber_lint/fix/repeating_steps.feature

@@ -0,0 +1,25 @@
+Feature: fixing
+
+  Scenario: a feature with unformatted repeating steps
+    Given I have a feature with unformatted repeating steps
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+      W
+
+      1 file inspected (0 passed, 1 written)
+      """
+    And it exits with status 0
+    And I now have a feature with formatted repeating steps
+
+
+  Scenario: a feature with formatted repeating steps
+    Given I have a feature with formatted repeating steps
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+      .
+
+      1 file inspected (1 passed)
+      """
+    And it exits with status 0

data/features/cucumber_lint/fix/table_whitespace.feature

@@ -0,0 +1,25 @@
+Feature: fixing
+
+  Scenario: a feature with unformatted table whitespace
+    Given I have a feature with unformatted table whitespace
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+      W
+
+      1 file inspected (0 passed, 1 written)
+      """
+    And it exits with status 0
+    And I now have a feature with formatted table whitespace
+
+
+  Scenario: a feature with formatted table whitespace
+    Given I have a feature with formatted table whitespace
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+      .
+
+      1 file inspected (1 passed)
+      """
+    And it exits with status 0

data/features/cucumber_lint/fix/uppercase_table_headers.feature

@@ -0,0 +1,25 @@
+Feature: fixing
+
+  Scenario: a feature with unformatted uppercase table headers
+    Given I have a feature with unformatted uppercase table headers
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+      W
+
+      1 file inspected (0 passed, 1 written)
+      """
+    And it exits with status 0
+    And I now have a feature with formatted uppercase table headers
+
+
+  Scenario: a feature with formatted uppercase table headers
+    Given I have a feature with formatted uppercase table headers
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+      .
+
+      1 file inspected (1 passed)
+      """
+    And it exits with status 0

data/features/cucumber_lint/lint/nothing.feature

@@ -0,0 +1,12 @@
+Feature: linting
+
+  Scenario: nothing
+    Given I have no files
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+
+
+      0 files inspected
+      """
+    And it exits with status 0

data/features/cucumber_lint/lint/repeating_steps.feature

@@ -0,0 +1,31 @@
+Feature: linting
+
+  Scenario: a feature with unformatted repeating steps
+    Given I have a feature with unformatted repeating steps
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+      F
+
+      ./features/repeating_steps.feature:5: Use "And" instead of repeating "Given"
+      ./features/repeating_steps.feature:6: Use "And" instead of repeating "Given"
+      ./features/repeating_steps.feature:8: Use "And" instead of repeating "When"
+      ./features/repeating_steps.feature:9: Use "And" instead of repeating "When"
+      ./features/repeating_steps.feature:11: Use "And" instead of repeating "Then"
+      ./features/repeating_steps.feature:12: Use "And" instead of repeating "Then"
+
+      1 file inspected (0 passed, 1 failed)
+      """
+    And it exits with status 1
+
+
+  Scenario: a feature with formatted repeating steps
+    Given I have a feature with formatted repeating steps
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+      .
+
+      1 file inspected (1 passed)
+      """
+    And it exits with status 0

data/features/cucumber_lint/lint/table_whitespace.feature

@@ -0,0 +1,27 @@
+Feature: linting
+
+  Scenario: a feature with unformatted table whitespace
+    Given I have a feature with unformatted table whitespace
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+      F
+
+      ./features/table_whitespace.feature:5: Fix table whitespace
+      ./features/table_whitespace.feature:17: Fix table whitespace
+
+      1 file inspected (0 passed, 1 failed)
+      """
+    And it exits with status 1
+
+
+  Scenario: a feature with formatted table whitespace
+    Given I have a feature with formatted table whitespace
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+      .
+
+      1 file inspected (1 passed)
+      """
+    And it exits with status 0

data/features/cucumber_lint/lint/uppercase_table_headers.feature

@@ -0,0 +1,30 @@
+Feature: fixing
+
+  Scenario: a feature with unformatted uppercase table headers
+    Given I have a feature with unformatted uppercase table headers
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+      F
+
+      ./features/uppercase_table_headers.feature:5: Make table headers uppercase
+      ./features/uppercase_table_headers.feature:13: Make "<vegetable>" uppercase
+      ./features/uppercase_table_headers.feature:13: Make "<fruit>" uppercase
+      ./features/uppercase_table_headers.feature:14: Make "<codename>" uppercase
+      ./features/uppercase_table_headers.feature:17: Make table headers uppercase
+
+      1 file inspected (0 passed, 1 failed)
+      """
+    And it exits with status 1
+
+
+  Scenario: a feature with formatted uppercase table headers
+    Given I have a feature with formatted uppercase table headers
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+      .
+
+      1 file inspected (1 passed)
+      """
+    And it exits with status 0

data/features/step_definitions/cli_steps.rb

@@ -3,9 +3,11 @@ Given(/^I have no files$/) do
 end
 
 
-Given(/^I have an? (.+?) file at "features\/(.+?)"$/) do |filetype, filename|
-  content = IO.read("#{FIXTURES_PATH}/#{filetype}.feature.example")
-  IO.write "#{TMP_DIR}/features/#{filename}", content
+Given(/^I have a feature with (unformatted|formatted) (.+?)$/) do |format, type|
+  feature_name = format == 'formatted' ? 'good' : 'bad'
+  feature_type = type.gsub(' ', '_')
+  content = IO.read("#{FIXTURES_PATH}/#{feature_type}/#{feature_name}.feature.example")
+  IO.write "#{TMP_DIR}/features/#{feature_type}.feature", content
 end
 
 
@@ -24,8 +26,9 @@ Then(/^it exits with status (\d+)$/) do |status|
 end
 
 
-Then(/^the file "features\/(.+?)" in now formatted$/) do |filename|
-  expected = IO.read "#{FIXTURES_PATH}/formatted.feature.example"
-  actual = IO.read "#{TMP_DIR}/features/#{filename}"
+Then(/^I now have a feature with formatted (.+?)$/) do |type|
+  feature_type = type.gsub(' ', '_')
+  expected = IO.read("#{FIXTURES_PATH}/#{feature_type}/good.feature.example")
+  actual = IO.read "#{TMP_DIR}/features/#{feature_type}.feature"
   expect(actual).to eql expected
 end

data/features/step_definitions/fixtures/repeating_steps/bad.feature.example

@@ -0,0 +1,12 @@
+Feature: Test Feature
+
+  Scenario: Test Scenario
+    Given A
+    Given B
+    Given C
+    When D
+    When E
+    When F
+    Then G
+    Then H
+    Then I

data/features/step_definitions/fixtures/repeating_steps/good.feature.example

@@ -0,0 +1,12 @@
+Feature: Test Feature
+
+  Scenario: Test Scenario
+    Given A
+    And B
+    And C
+    When D
+    And E
+    And F
+    Then G
+    And H
+    And I