cucumber_lint 0.0.3 → 0.0.4

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

@@ -0,0 +1,20 @@
+Feature: Test Feature
+
+  Scenario: Test Scenario
+    Given a table
+      |VEGETABLE|CODENAME|
+      |Asparagus|Alpha|
+      |Broccoli|Bravo|
+      |Carrot|Charlie|
+    Then my tests pass
+
+
+  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  |

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

@@ -0,0 +1,20 @@
+Feature: Test Feature
+
+  Scenario: Test Scenario
+    Given a table
+      | VEGETABLE | CODENAME |
+      | Asparagus | Alpha    |
+      | Broccoli  | Bravo    |
+      | Carrot    | Charlie  |
+    Then my tests pass
+
+
+  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  |

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

@@ -0,0 +1,20 @@
+Feature: Test Feature
+
+  Scenario: Test Scenario
+    Given a table
+      | vegetable | codename |
+      | Asparagus | Alpha    |
+      | Broccoli  | Bravo    |
+      | Carrot    | Charlie  |
+    Then my tests pass
+
+
+  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  |

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

@@ -0,0 +1,20 @@
+Feature: Test Feature
+
+  Scenario: Test Scenario
+    Given a table
+      | VEGETABLE | CODENAME |
+      | Asparagus | Alpha    |
+      | Broccoli  | Bravo    |
+      | Carrot    | Charlie  |
+    Then my tests pass
+
+
+  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  |

data/lib/core_ext/hash.rb

@@ -0,0 +1,29 @@
+# Monkey-patching Hash
+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
+    end
+  end
+
+
+  def array_to_open_struct array
+    array.map { |element| object_to_open_struct element }
+  end
+
+end

data/lib/cucumber_lint/cli.rb

@@ -13,72 +13,84 @@ module CucumberLint
 
     def initialize args, out: STDOUT
       @out = out
-      @lint = args[0] != '--fix'
-      @results = OpenStruct.new(formatted: 0, unformatted: 0, unformatted_files: [])
+      @fix = args[0] == '--fix'
+      @results = OpenStruct.new(total: 0, passed: 0, failed: 0, written: 0, errors: [])
     end
 
 
     def execute!
-      Dir.glob('./features/**/*.feature').each do |filename|
-        formatter = FeatureFormatter.new IO.read(filename)
-
-        if formatter.formatted?
-          file_formatted
-        else
-          file_unformatted filename, formatter.formatted_content
-        end
+      Dir.glob('./features/**/*.feature').sort.each do |filename|
+        lint_feature filename
       end
 
       output_results
-      exit 1 unless @results.unformatted_files.empty?
+      exit 1 unless @results.errors.empty?
     end
 
-    def output_results
-      output_failures if @lint && !@results.unformatted_files.empty?
-      total = @results.formatted + @results.unformatted
-      @out.print "\n\n#{total} file#{'s' if total != 1} inspected ("
-      if @lint
-        output_inspect_results
+    private
+
+    def lint_feature filename
+      linter = FeatureLinter.new filename, fix: @fix
+      linter.lint
+
+      if linter.errors?
+        @results.errors += linter.errors
+        file_failed
+      elsif linter.can_fix?
+        file_written
       else
-        output_write_results
+        file_passed
       end
-      @out.puts ')'
+
+      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(', ')})"
     end
 
 
-    def output_inspect_results
-      @out.print "#{@results.formatted} passed".green
-      @out.print ', ' + "#{@results.unformatted} failed".red if @results.unformatted > 0
+    def output_errors
+      @out.print "\n\n"
+      @out.print @results.errors.join("\n").red
     end
 
 
-    def output_write_results
-      @out.print "#{@results.unformatted} written".yellow
+    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 "\n"
     end
 
 
-    def output_failures
-      @out.puts "\n\nFiles with errors:".red
-      @out.print @results.unformatted_files.join("\n").red
+    def output_results
+      output_errors unless @results.errors.empty?
+      output_counts
     end
 
 
-    def file_formatted
-      @results.formatted += 1
+    def file_passed
+      @results.total += 1
+      @results.passed += 1
       @out.print '.'.green
     end
 
 
-    def file_unformatted filename, content
-      @results.unformatted += 1
+    def file_failed
+      @results.total += 1
+      @results.failed += 1
+      @out.print 'F'.red
+    end
 
-      if @lint
-        @results.unformatted_files << filename
-        @out.print 'F'.red
-      else
-        IO.write filename, content
-        @out.print 'W'.yellow
-      end
+
+    def file_written
+      @results.total += 1
+      @results.written += 1
+      @out.print 'W'.yellow
     end
 
   end

data/lib/cucumber_lint/fix_list.rb

@@ -0,0 +1,37 @@
+module CucumberLint
+  # A class that represents a list of fixes to apply to a feature
+  class FixList
+
+    attr_reader :list
+
+
+    def initialize
+      @list = {}
+    end
+
+
+    def add line_number, fix
+      @list[line_number] ||= []
+      @list[line_number] += Array(fix)
+    end
+
+
+    def apply lines
+      lines.each_with_index.map do |line, index|
+        line_number = index + 1
+
+        @list.fetch(line_number, []).each do |fix|
+          line = fix.call(line)
+        end
+
+        line
+      end
+    end
+
+
+    def empty?
+      @list.empty?
+    end
+
+  end
+end

data/lib/cucumber_lint/linter/feature_linter.rb

@@ -0,0 +1,92 @@
+require 'core_ext/hash'
+require 'gherkin/formatter/json_formatter'
+require 'gherkin/parser/parser'
+require 'multi_json'
+
+module CucumberLint
+  # A linter for a given feature (represented by a filename)
+  class FeatureLinter < Linter
+
+    attr_reader :errors, :fix_list
+
+    def initialize path, fix:
+      super(fix: fix)
+
+      @path = path
+      @content = IO.read(path)
+      @file_lines = @content.lines
+    end
+
+
+    def can_fix?
+      !fix_list.empty?
+    end
+
+
+    def errors?
+      !errors.empty?
+    end
+
+
+    def lint
+      feature = parse_content
+
+      feature.elements.each do |element|
+        lint_steps element.steps
+
+        if element.type == 'scenario_outline'
+          lint_scenario_outline element.steps
+          lint_examples element.examples
+        end
+      end
+
+      errors.map! { |error| "#{feature.uri}:#{error}" }
+    end
+
+    def write
+      fixed_content = fix_list.apply(@file_lines).join
+      IO.write(@path, fixed_content)
+    end
+
+    private
+
+
+    def linter_options
+      { file_lines: @file_lines, fix: @fix, parent: self }
+    end
+
+
+    def lint_examples examples
+      examples.each { |example| lint_table example.rows }
+    end
+
+
+    def lint_scenario_outline steps
+      linter = ScenarioOutlineLinter.new linter_options.merge(steps: steps)
+      linter.lint
+    end
+
+
+    def lint_steps steps
+      linter = StepsLinter.new linter_options.merge(steps: steps)
+      linter.lint
+    end
+
+
+    def lint_table rows
+      linter = TableLinter.new linter_options.merge(rows: rows)
+      linter.lint
+    end
+
+
+    def parse_content
+      io = StringIO.new
+      formatter = Gherkin::Formatter::JSONFormatter.new(io)
+      parser = Gherkin::Parser::Parser.new(formatter)
+      parser.parse(@content, @path, 0)
+      formatter.done
+      MultiJson.load(io.string)[0].to_open_struct
+    end
+
+  end
+end

data/lib/cucumber_lint/linter/scenario_outline_linter.rb

@@ -0,0 +1,34 @@
+module CucumberLint
+  # A linter for a series of steps in a scenario outline (as parsed by Gherkin)
+  class ScenarioOutlineLinter < Linter
+
+    def initialize steps:, file_lines:, fix:, parent:
+      super(fix: fix, parent: parent)
+
+      @steps = steps
+      @file_lines = file_lines
+    end
+
+
+    def lint
+      @steps.each do |step|
+        step.name.scan(/<.+?>/).each do |placeholder|
+          bad_placeholder step.line, placeholder unless placeholder == placeholder.upcase
+        end
+      end
+    end
+
+
+    private
+
+
+    def bad_placeholder line_number, placeholder
+      if @fix
+        fix_list.add line_number, -> (line) { line.sub(placeholder, placeholder.upcase) }
+      else
+        errors << "#{line_number}: Make \"#{placeholder}\" uppercase"
+      end
+    end
+
+  end
+end

data/lib/cucumber_lint/linter/steps_linter.rb

@@ -0,0 +1,49 @@
+module CucumberLint
+  # A linter for a series of steps (as parsed by Gherkin)
+  class StepsLinter < Linter
+
+    def initialize steps:, file_lines:, fix:, parent:
+      super(fix: fix, parent: parent)
+
+      @steps = steps
+      @file_lines = file_lines
+    end
+
+
+    def lint
+      previous_keyword = nil
+
+      @steps.each do |step|
+        current_keyword = step.keyword.strip
+
+        if STEP_TYPES.include?(current_keyword) && current_keyword == previous_keyword
+          repeated_keyword step.line, current_keyword
+        else
+          previous_keyword = current_keyword
+        end
+
+        lint_table(step.rows) if step.rows && step.rows.is_a?(Array)
+      end
+    end
+
+
+    private
+
+    STEP_TYPES = %w(Given When Then)
+
+    def repeated_keyword line_number, keyword
+      if @fix
+        fix_list.add line_number, -> (line) { line.sub(keyword, 'And') }
+      else
+        errors << "#{line_number}: Use \"And\" instead of repeating \"#{keyword}\""
+      end
+    end
+
+
+    def lint_table rows
+      table_linter = TableLinter.new rows: rows, file_lines: @file_lines, fix: @fix, parent: self
+      table_linter.lint
+    end
+
+  end
+end