cucumber_lint 0.0.4 → 0.1.0

data/features/cucumber_lint/consistent_table_headers/step_table.feature

@@ -0,0 +1,64 @@
+Feature: consistent_table_headers for a step table
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given a table
+            | VEGETABLE | fruit  | Code Name |
+            | Asparagus | Apple  | Alpha     |
+            | Broccoli  | Banana | Bravo     |
+            | Carrot    | Cherry | Charlie   |
+          Then my tests pass
+      """
+
+  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                 |
+      | 5    | uppercase table headers |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given a table
+            | VEGETABLE | FRUIT  | CODE NAME |
+            | Asparagus | Apple  | Alpha     |
+            | Broccoli  | Banana | Bravo     |
+            | Carrot    | Cherry | Charlie   |
+          Then my tests pass
+      """
+    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                 |
+      | 5    | lowercase table headers |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given a table
+            | vegetable | fruit  | code name |
+            | Asparagus | Apple  | Alpha     |
+            | Broccoli  | Banana | Bravo     |
+            | Carrot    | Cherry | Charlie   |
+          Then my tests pass
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_table_headers/unsupported_style.feature

@@ -0,0 +1,20 @@
+Feature: consistent_table_headers enforcing an unsupported style
+
+  Background:
+    Given I have "consistent_table_headers" enabled with "enforced_style" as "invalid"
+
+  Scenario: lint
+    When I run `cucumber_lint`
+    Then I see the output
+      """
+      consistent_table_headers does not support invalid. Supported: lowercase, uppercase
+      """
+    And it exits with status 1
+
+  Scenario: fix
+    When I run `cucumber_lint --fix`
+    Then I see the output
+      """
+      consistent_table_headers does not support invalid. Supported: lowercase, uppercase
+      """
+    And it exits with status 1

data/features/cucumber_lint/consistent_table_whitespace/examples_table.feature

@@ -0,0 +1,46 @@
+Feature: consistent_table_whitespace 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 <CODENAME>
+
+          Examples:
+            |VEGETABLE| FRUIT  |    CODENAME   |
+            |Asparagus | Apple     | Alpha    |
+            |Broccoli  | Banana |  Bravo    |
+            | Carrot|   Cherry |   Charlie  |
+      """
+
+  Scenario: disabled
+    Given I have "consistent_table_whitespace" enabled
+    When I run `cucumber_lint --fix`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_table_whitespace" enabled
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE              |
+      | 8    | Fix table whitespace |
+    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 <CODENAME>
+
+          Examples:
+            | VEGETABLE | FRUIT  | CODENAME |
+            | Asparagus | Apple  | Alpha    |
+            | Broccoli  | Banana | Bravo    |
+            | Carrot    | Cherry | Charlie  |
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/consistent_table_whitespace/step_table.feature

@@ -0,0 +1,42 @@
+Feature: consistent_table_whitespace for a step table
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given a table
+            |VEGETABLE|CODENAME|
+            |Asparagus|Alpha|
+            |Broccoli|Bravo|
+            |Carrot|Charlie|
+          Then my tests pass
+      """
+
+  Scenario: disabled
+    Given I have "consistent_table_whitespace" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "consistent_table_whitespace" enabled
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE              |
+      | 5    | Fix table whitespace |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given a table
+            | VEGETABLE | CODENAME |
+            | Asparagus | Alpha    |
+            | Broccoli  | Bravo    |
+            | Carrot    | Charlie  |
+          Then my tests pass
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/no_empty_features.feature

@@ -0,0 +1,20 @@
+Feature: no_empty_features
+
+  Background:
+    Given I have a file without a feature
+
+  Scenario: disabled
+    Given I have "no_empty_features" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "no_empty_features" enabled
+    When I run `cucumber_lint`
+    Then it fails with
+      | MESSAGE                     |
+      | Remove file with no feature |
+    When I run `cucumber_lint --fix`
+    Then the file has been deleted
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/no_files.feature

@@ -0,0 +1,6 @@
+Feature: no files
+
+  Scenario: lint
+    Given I have no files
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/no_repeating_keywords.feature

@@ -0,0 +1,44 @@
+Feature: no_repeating_keywords enabled
+
+  Background:
+    Given I have a feature with content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given A
+          Given B
+          When C
+          When D
+          Then E
+          Then F
+      """
+
+  Scenario: disabled
+    Given I have "no_repeating_keywords" disabled
+    When I run `cucumber_lint`
+    Then it passes
+
+  Scenario: lint and fix
+    Given I have "no_repeating_keywords" enabled
+    When I run `cucumber_lint`
+    Then it fails with
+      | LINE | MESSAGE                                |
+      | 5    | Use "And" instead of repeating "Given" |
+      | 7    | Use "And" instead of repeating "When"  |
+      | 9    | Use "And" instead of repeating "Then"  |
+    When I run `cucumber_lint --fix`
+    Then my feature now has content
+      """
+      Feature: Test Feature
+
+        Scenario: Test Scenario
+          Given A
+          And B
+          When C
+          And D
+          Then E
+          And F
+      """
+    When I run `cucumber_lint`
+    Then it passes

data/features/cucumber_lint/unsupported_options.feature

@@ -0,0 +1,11 @@
+Feature: unsupported option
+
+  Scenario: passing an unsupported option
+    When I run `cucumber_lint --invalid`
+    Then I see the output
+      """
+      error: unsupported option(s): --invalid
+      usage: cucumber_lint
+         or: cucumber_lint --fix
+      """
+    And it exits with status 1

data/features/step_definitions/cli_steps.rb

@@ -1,21 +1,54 @@
+require 'yaml'
+
+
 Given(/^I have no files$/) do
   # Empty step for readability
 end
 
 
-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
+Given(/^I have "(.+?)" (enabled|disabled)$/) do |key, value|
+  update_config(key => { enabled: value == 'enabled' })
+end
+
+
+Given(/^I have "(.+?)" enabled with "(.+?)" as "(.+?)"$/) do |key, config_key, config_value|
+  config_value = config_value.to_i if config_value.match(/^\d*$/)
+  update_config(key => { enabled: true, config_key => config_value })
 end
 
 
+Given(/^I have a file without a feature$/) do
+  write_feature ''
+end
+
+Given(/^I have a feature with content$/) do |content|
+  write_feature content.to_s
+end
+
+
+
+
 When(/^I run `(.+?)`$/) do |command|
   @last_run = run command
 end
 
 
+Then(/^it passes$/) do
+  expect(@last_run.exit_status).to eql(0), @last_run.out.uncolorize
+end
+
+
+Then(/^it fails with$/) do |failureTable|
+  expected_text = failureTable.hashes.map do |row|
+    identifer = './features/test.feature'
+    identifer += ":#{row['LINE']}" if row['LINE']
+    "#{identifer}: #{row['MESSAGE']}"
+  end.join "\n"
+  expect(@last_run.out.uncolorize).to include expected_text
+  expect(@last_run.exit_status).to eql 1
+end
+
+
 Then(/^I see the output$/) do |output|
   expect(@last_run.out.uncolorize).to eql "#{output}\n"
 end
@@ -26,9 +59,13 @@ Then(/^it exits with status (\d+)$/) do |status|
 end
 
 
-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
+Then(/^my feature now has content$/) do |content|
+  actual = IO.read feature_path
+  expect(actual).to eql content.to_s
+end
+
+
+Then(/^the file has been deleted$/) do
+  exists = File.exist? feature_path
+  expect(exists).to be_falsy
 end

data/features/step_definitions/env.rb

@@ -1,20 +1,16 @@
+require 'active_support/core_ext/hash/deep_merge.rb'
 require 'cucumber_lint'
 require 'open4'
 require 'rspec'
 
 
 BIN_PATH = "#{File.dirname(__FILE__)}/../../bin"
-FIXTURES_PATH = "#{File.dirname(__FILE__)}/fixtures"
-TMP_DIR = '/tmp'
+CONFIG_PATH = "#{File.dirname(__FILE__)}/fixtures/config/disabled.yml"
 
 
 Before do
-  Dir.chdir TMP_DIR
-  FileUtils.rm_rf 'features'
+  @tmp_dir = Dir.mktmpdir
+  Dir.chdir @tmp_dir
+  IO.write 'cucumber_lint.yml', IO.read(CONFIG_PATH)
   Dir.mkdir 'features'
 end
-
-
-at_exit do
-  FileUtils.rm_rf TMP_DIR
-end

data/features/step_definitions/fixtures/config/disabled.yml

@@ -0,0 +1,18 @@
+consistent_empty_lines:
+  enabled: false
+
+
+consistent_table_headers:
+  enabled: false
+
+
+consistent_table_whitespace:
+  enabled: false
+
+
+no_empty_features:
+  enabled: false
+
+
+no_repeating_keywords:
+  enabled: false

data/features/step_definitions/support/file_helpers.rb

@@ -0,0 +1,20 @@
+def config_path
+  "#{@tmp_dir}/cucumber_lint.yml"
+end
+
+
+def feature_path
+  "#{@tmp_dir}/features/test.feature"
+end
+
+
+def update_config updates
+  config = YAML.load IO.read config_path
+  updated_config = config.deep_merge updates
+  IO.write config_path, updated_config.to_yaml
+end
+
+
+def write_feature content
+  IO.write feature_path, content
+end

data/lib/core_ext/array.rb

@@ -0,0 +1,8 @@
+# Monkey-patching Array
+class Array
+
+  def to_open_struct
+    map(&:to_open_struct)
+  end
+
+end

data/lib/core_ext/basic_object.rb

@@ -0,0 +1,8 @@
+# Monkey-patching BasicObject
+class BasicObject
+
+  def to_open_struct
+    self
+  end
+
+end

data/lib/core_ext/hash.rb

@@ -3,27 +3,12 @@ class Hash
 
   def to_open_struct
     out = OpenStruct.new self
-    out.each_pair { |k, v| out[k] = object_to_open_struct v }
-    out
-  end
-
-
-  private
 
-
-  def object_to_open_struct object
-    if object.is_a? Hash
-      object.to_open_struct
-    elsif object.is_a? Array
-      array_to_open_struct object
-    else
-      object
+    out.each_pair do |k, v|
+      out[k] = v.to_open_struct
     end
-  end
 
-
-  def array_to_open_struct array
-    array.map { |element| object_to_open_struct element }
+    out
   end
 
 end

data/lib/core_ext/string.rb

@@ -0,0 +1,7 @@
+# Monkey-patching String
+class String
+
+  alias_method :uppercase, :upcase
+  alias_method :lowercase, :downcase
+
+end

data/lib/cucumber_lint/cli.rb

@@ -13,8 +13,10 @@ module CucumberLint
 
     def initialize args, out: STDOUT
       @out = out
-      @fix = args[0] == '--fix'
-      @results = OpenStruct.new(total: 0, passed: 0, failed: 0, written: 0, errors: [])
+
+      opts = extract_args args
+      @config = load_config fix: opts[:fix]
+      @results = OpenStruct.new(total: 0, passed: 0, failed: 0, written: 0, deleted: 0, errors: [])
     end
 
 
@@ -27,29 +29,56 @@ module CucumberLint
       exit 1 unless @results.errors.empty?
     end
 
+
     private
 
+
+    def add_result status, errors
+      @results.total += 1
+      @results[status] += 1
+      @results.errors += errors
+      @out.print output_for_status(status)
+    end
+
+
     def lint_feature filename
-      linter = FeatureLinter.new filename, fix: @fix
+      linted_file = LintedFile.new filename
+
+      linter = FeatureLinter.new config: @config, linted_file: linted_file
       linter.lint
 
-      if linter.errors?
-        @results.errors += linter.errors
-        file_failed
-      elsif linter.can_fix?
-        file_written
+      add_result linted_file.resolve, linted_file.errors
+    end
+
+
+    def load_config fix:
+      Config.new dir: Pathname.new('.').realpath, fix: fix
+    rescue UnsupportedStyle => e
+      @out.puts e.message.red
+      exit 1
+    end
+
+
+    def extract_args args
+      valid_args = ['--fix']
+
+      if (args - valid_args).empty?
+        { fix: args.count == 1 }
       else
-        file_passed
+        @out.puts "error: unsupported option(s): #{args.join(' ')}".red
+        @out.puts 'usage: cucumber_lint'
+        @out.puts '   or: cucumber_lint --fix'
+        exit 1
       end
-
-      linter.write if linter.can_fix?
     end
 
+
     def file_counts
-      out = ["#{@results.passed} passed".green]
-      out << "#{@results.written} written".yellow if @results.written > 0
-      out << "#{@results.failed} failed".red if @results.failed > 0
-      "(#{out.join(', ')})"
+      [:passed, :written, :deleted, :failed].map do |status|
+        if status == :passed || @results[status] > 0
+          "#{@results[status]} #{status}".colorize(output_color_for status)
+        end
+      end.compact.join(', ')
     end
 
 
@@ -62,7 +91,7 @@ module CucumberLint
     def output_counts
       @out.print "\n\n"
       @out.print "#{@results.total} file#{'s' if @results.total != 1} inspected"
-      @out.print " #{file_counts}" if @results.total > 0
+      @out.print " (#{file_counts})" if @results.total > 0
       @out.print "\n"
     end
 
@@ -72,25 +101,25 @@ module CucumberLint
       output_counts
     end
 
-
-    def file_passed
-      @results.total += 1
-      @results.passed += 1
-      @out.print '.'.green
+    def output_color_for status
+      case status
+      when :passed then :green
+      when :failed then :red
+      else :yellow
+      end
     end
 
-
-    def file_failed
-      @results.total += 1
-      @results.failed += 1
-      @out.print 'F'.red
+    def output_letter_for status
+      case status
+      when :passed then '.'
+      when :failed then 'F'
+      when :written then 'W'
+      when :deleted then 'D'
+      end
     end
 
-
-    def file_written
-      @results.total += 1
-      @results.written += 1
-      @out.print 'W'.yellow
+    def output_for_status status
+      output_letter_for(status).colorize output_color_for(status)
     end
 
   end

data/lib/cucumber_lint/config.rb

@@ -0,0 +1,55 @@
+require 'yaml'
+
+module CucumberLint
+  # A configuration for executing cucumber_lint
+  class Config
+
+    attr_reader :fix
+
+    def initialize dir:, fix:
+      @dir = dir
+      @fix = fix
+      @options = parse_config
+    end
+
+
+    def method_missing method
+      @options.send(method)
+    end
+
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def parse_config
+      defaults = load_default_config
+      overrides = load_config "#{@dir}/cucumber_lint.yml"
+
+      overrides.each_pair do |style, style_overrides|
+        style_overrides.each_pair do |key, value|
+          if key == 'enforced_style'
+            supported = defaults[style]['supported_styles']
+            fail UnsupportedStyle.new style, supported, value unless supported.include?(value)
+          end
+
+          defaults[style][key] = value
+        end
+      end
+
+      defaults.to_open_struct
+    end
+    # rubocop:enable Metrics/MethodLength
+
+
+    def load_config path
+      return {} unless File.exist? path
+      YAML.load File.read path
+    end
+
+
+    def load_default_config
+      load_config "#{File.dirname(__FILE__)}/../../config/default.yml"
+    end
+
+  end
+end

data/lib/cucumber_lint/errors/unsupported_style.rb

@@ -0,0 +1,10 @@
+module CucumberLint
+  # A class representing a user configuration that tries to use an unsupported style
+  class UnsupportedStyle < StandardError
+
+    def initialize style, supported_styles, override
+      super("#{style} does not support #{override}. Supported: #{supported_styles.join(', ')}")
+    end
+
+  end
+end