cucumber_lint 0.0.4 → 0.1.0

data/lib/cucumber_lint/linted_file.rb

@@ -0,0 +1,77 @@
+module CucumberLint
+  # A class that represents a file being linted
+  class LintedFile
+
+    attr_reader :content, :errors, :lines
+
+    def initialize path
+      @path = Pathname.new path
+      @content = IO.read path
+      @lines = @content.lines
+
+      @errors = []
+      @fixes = {}
+      @marked_for_deletion = false
+    end
+
+
+    def add_error error
+      @errors << "#{@path}:#{error}"
+    end
+
+
+    def add_fix line_number, fix
+      @fixes[line_number] ||= []
+      @fixes[line_number] += Array(fix)
+    end
+
+
+    def mark_for_deletion
+      @marked_for_deletion = true
+    end
+
+
+    def resolve
+      if @marked_for_deletion
+        delete
+        :deleted
+      elsif !errors.empty? || fixable?
+        fix
+        errors.empty? ? :written : :failed
+      else
+        :passed
+      end
+    end
+
+
+    private
+
+
+    def apply_fixes
+      lines.each_with_index.map do |line, index|
+        line_number = index + 1
+
+        @fixes.fetch(line_number, []).each do |fix|
+          line = fix.call(line)
+        end
+
+        line
+      end
+    end
+
+
+    def delete
+      @path.delete
+    end
+
+
+    def fix
+      IO.write @path, apply_fixes.join
+    end
+
+    def fixable?
+      !@fixes.empty?
+    end
+
+  end
+end

data/lib/cucumber_lint/linter/feature_empty_lines_linter.rb

@@ -0,0 +1,125 @@
+module CucumberLint
+  # A linter for a given feature's empty lines
+  class FeatureEmptyLinesLinter < Linter
+
+    def initialize config:, feature:, linted_file:
+      super config: config, linted_file: linted_file
+
+      @feature = feature
+      @description = feature.description
+    end
+
+
+    def lint
+      lint_description
+      lint_elements
+    end
+
+
+    private
+
+
+    def expected_first_element_start
+      spacing = if @description == ''
+                  get_config(:between_feature_and_element)
+                else
+                  get_config(:between_feature_and_description) +
+                  @description.count("\n") +
+                  get_config(:between_description_and_element) +
+                  1
+                end
+
+      @feature.line + spacing + 1
+    end
+
+
+    def extra_empty_line line_number, count
+      if @config.fix
+        count.times do |i|
+          add_fix line_number + i, -> (line) { line.sub("\n", '') }
+        end
+      else
+        add_error "#{line_number}: Remove#{" #{count}" if count > 1} empty line#{'s' if count > 1}"
+      end
+    end
+
+
+    def get_config key
+      @config.consistent_empty_lines.send(key)
+    end
+
+
+    def get_element_end element
+      if element.type == 'scenario_outline'
+        element.examples.last.rows.last.line
+      else
+        step_end element.steps.last
+      end
+    end
+
+
+    def lint_description
+      return if @description == ''
+
+      shared_lines = @feature.line + 1
+      expected_start = shared_lines + get_config(:between_feature_and_description)
+      actual_start = shared_lines + @description.match(/\n*/)[0].length
+      resolve_empty_line_difference actual_start, expected_start
+    end
+
+
+    def lint_elements
+      return unless @feature.elements
+
+      expected_element_start = expected_first_element_start
+      @feature.elements.each do |element|
+        resolve_empty_line_difference element.line, expected_element_start
+        lint_scenario_outline_and_examples element if element.type == 'scenario_outline'
+        element_end = get_element_end element
+        expected_element_start = element_end + get_config(:between_elements) + 1
+      end
+    end
+
+
+    def lint_scenario_outline_and_examples element
+      expected_start = step_end(element.steps.last) +
+                       get_config(:between_scenario_outline_and_examples) +
+                       1
+      actual_start = element.examples.first.line
+      resolve_empty_line_difference actual_start, expected_start
+    end
+
+
+    def missing_empty_line line_number, count
+      if @config.fix
+        add_fix line_number, -> (line) { "\n" * count + line }
+      else
+        add_error "#{line_number}: Add#{" #{count}" if count > 1} empty line#{'s' if count > 1}"
+      end
+    end
+
+
+    def resolve_empty_line_difference actual, expected
+      if actual < expected
+        missing_empty_line actual, expected - actual
+      elsif actual > expected
+        extra_empty_line expected, actual - expected
+      end
+    end
+
+
+    def step_end step
+      rows = step.rows
+      doc_string = step.doc_string
+
+      if rows && rows.is_a?(Array)
+        rows.last.line
+      elsif doc_string
+        doc_string.line + doc_string.value.count("\n") + 2
+      else
+        step.line
+      end
+    end
+
+  end
+end

data/lib/cucumber_lint/linter/feature_linter.rb

@@ -1,3 +1,5 @@
+require 'core_ext/array'
+require 'core_ext/basic_object'
 require 'core_ext/hash'
 require 'gherkin/formatter/json_formatter'
 require 'gherkin/parser/parser'
@@ -7,29 +9,38 @@ module CucumberLint
   # A linter for a given feature (represented by a filename)
   class FeatureLinter < Linter
 
-    attr_reader :errors, :fix_list
+    def lint
+      features = parse_content
 
-    def initialize path, fix:
-      super(fix: fix)
+      features.each do |feature|
+        lint_feature_empty_lines feature if @config.consistent_empty_lines.enabled
+        lint_elements feature
+      end
 
-      @path = path
-      @content = IO.read(path)
-      @file_lines = @content.lines
+      empty_feature if features.count == 0
     end
 
+    private
+
 
-    def can_fix?
-      !fix_list.empty?
+    def empty_feature
+      return unless @config.no_empty_features.enabled
+
+      if @config.fix
+        @linted_file.mark_for_deletion
+      else
+        add_error ' Remove file with no feature'
+      end
     end
 
 
-    def errors?
-      !errors.empty?
+    def lint_examples examples
+      examples.each { |example| lint_table example.rows }
     end
 
 
-    def lint
-      feature = parse_content
+    def lint_elements feature
+      return unless feature.elements
 
       feature.elements.each do |element|
         lint_steps element.steps
@@ -39,25 +50,12 @@ module CucumberLint
           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 }
+    def lint_feature_empty_lines feature
+      linter = FeatureEmptyLinesLinter.new linter_options.merge(feature: feature)
+      linter.lint
     end
 
 
@@ -79,13 +77,18 @@ module CucumberLint
     end
 
 
+    def linter_options
+      { config: @config, linted_file: @linted_file }
+    end
+
+
     def parse_content
       io = StringIO.new
       formatter = Gherkin::Formatter::JSONFormatter.new(io)
       parser = Gherkin::Parser::Parser.new(formatter)
-      parser.parse(@content, @path, 0)
+      parser.parse(@linted_file.content, '', 0)
       formatter.done
-      MultiJson.load(io.string)[0].to_open_struct
+      MultiJson.load(io.string).to_open_struct
     end
 
   end

data/lib/cucumber_lint/linter/scenario_outline_linter.rb

@@ -1,19 +1,21 @@
+require 'core_ext/string'
+
 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)
+    def initialize steps:, config:, linted_file:
+      super config: config, linted_file: linted_file
 
       @steps = steps
-      @file_lines = file_lines
+      @header_style = @config.consistent_table_headers.enforced_style.to_sym
     end
 
 
     def lint
       @steps.each do |step|
         step.name.scan(/<.+?>/).each do |placeholder|
-          bad_placeholder step.line, placeholder unless placeholder == placeholder.upcase
+          inconsistent_placeholder step.line, placeholder if bad_placeholder? placeholder
         end
       end
     end
@@ -22,11 +24,18 @@ module CucumberLint
     private
 
 
-    def bad_placeholder line_number, placeholder
-      if @fix
-        fix_list.add line_number, -> (line) { line.sub(placeholder, placeholder.upcase) }
+    def bad_placeholder? str
+      str != str.public_send(@header_style)
+    end
+
+
+    def inconsistent_placeholder line_number, str
+      return unless @config.consistent_table_headers.enabled
+
+      if @config.fix
+        add_fix line_number, -> (line) { line.sub(str, str.public_send(@header_style)) }
       else
-        errors << "#{line_number}: Make \"#{placeholder}\" uppercase"
+        add_error "#{line_number}: #{@header_style} \"#{str}\""
       end
     end
 

data/lib/cucumber_lint/linter/steps_linter.rb

@@ -2,11 +2,10 @@ 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)
+    def initialize steps:, config:, linted_file:
+      super config: config, linted_file: linted_file
 
       @steps = steps
-      @file_lines = file_lines
     end
 
 
@@ -32,17 +31,19 @@ module CucumberLint
     STEP_TYPES = %w(Given When Then)
 
     def repeated_keyword line_number, keyword
-      if @fix
-        fix_list.add line_number, -> (line) { line.sub(keyword, 'And') }
+      return unless @config.no_repeating_keywords.enabled
+
+      if @config.fix
+        add_fix line_number, -> (line) { line.sub(keyword, 'And') }
       else
-        errors << "#{line_number}: Use \"And\" instead of repeating \"#{keyword}\""
+        add_error "#{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
+      linter = TableLinter.new rows: rows, config: @config, linted_file: @linted_file
+      linter.lint
     end
 
   end

data/lib/cucumber_lint/linter/table_linter.rb

@@ -1,53 +1,64 @@
+require 'core_ext/string'
 require 'gherkin/formatter/pretty_formatter'
 
 module CucumberLint
   # A linter for a series of table rows (as parsed by Gherkin)
   class TableLinter < Linter
 
-    def initialize rows:, file_lines:, fix:, parent:
-      super(fix: fix, parent: parent)
+    def initialize rows:, config:, linted_file:
+      super config: config, linted_file: linted_file
 
       @rows = rows
-      @file_lines = file_lines
+      @header_style = @config.consistent_table_headers.enforced_style.to_sym
     end
 
 
     def lint
-      bad_whitespace unless actual_table_lines == expected_table_lines
-      bad_table_headers unless actual_table_lines[0] == actual_table_lines[0].upcase
+      inconsistent_table_whitespace unless actual_table_lines == expected_table_lines
+      inconsistent_table_headers if inconsistent_table_headers?
     end
 
 
     private
 
 
-    def bad_table_headers
-      if @fix
-        fix_list.add @rows[0].line, -> (line) { line.upcase }
+    def inconsistent_table_headers
+      return unless @config.consistent_table_headers.enabled
+
+      if @config.fix
+        add_fix @rows[0].line, -> (line) { line.split('|', -1).map(&@header_style).join('|') }
       else
-        errors << "#{@rows[0].line}: Make table headers uppercase"
+        add_error "#{@rows[0].line}: #{@header_style} table headers"
       end
     end
 
 
+    def inconsistent_table_headers?
+      headers = actual_table_lines[0].split('|')
+      headers != headers.map(&@header_style)
+    end
+
+
     def actual_table_lines
       @actual_table_lines ||= determine_actual_table_lines
     end
 
 
-    def bad_whitespace
-      if @fix
+    def inconsistent_table_whitespace
+      return unless @config.consistent_table_whitespace.enabled
+
+      if @config.fix
         @rows.each_with_index.map do |row, index|
-          fix_list.add row.line, -> (line) { line.gsub(/\|.+?\n/, expected_table_lines[index]) }
+          add_fix row.line, -> (line) { line.gsub(/\|.*\|/, expected_table_lines[index]) }
         end
       else
-        errors << "#{@rows[0].line}: Fix table whitespace"
+        add_error "#{@rows[0].line}: Fix table whitespace"
       end
     end
 
 
     def determine_actual_table_lines
-      @rows.map { |row| @file_lines[row.line - 1].lstrip }
+      @rows.map { |row| @linted_file.lines[row.line - 1].strip }
     end
 
 
@@ -58,7 +69,7 @@ module CucumberLint
       formatter = Gherkin::Formatter::PrettyFormatter.new(io, false, false)
       formatter.table(@rows)
       formatter.done
-      io.string.lines.map(&:lstrip)
+      io.string.lines.map(&:strip)
     end
 
 

data/lib/cucumber_lint/linter.rb

@@ -2,19 +2,19 @@ module CucumberLint
   # A base linter, not meant to be instantiated
   class Linter
 
-    attr_reader :errors, :fix_list
+    def initialize config:, linted_file:
+      @config = config
+      @linted_file = linted_file
+    end
+
 
+    def add_error *args
+      @linted_file.add_error(*args)
+    end
 
-    def initialize fix:, parent: nil
-      @fix = fix
 
-      if parent
-        @errors = parent.errors
-        @fix_list = parent.fix_list
-      else
-        @errors = []
-        @fix_list = FixList.new
-      end
+    def add_fix *args
+      @linted_file.add_fix(*args)
     end
 
   end

data/lib/cucumber_lint/version.rb

@@ -1,3 +1,3 @@
 module CucumberLint # rubocop:disable Style/Documentation
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/lib/cucumber_lint.rb

@@ -1,6 +1,9 @@
 require 'cucumber_lint/cli'
-require 'cucumber_lint/fix_list'
+require 'cucumber_lint/config'
+require 'cucumber_lint/errors/unsupported_style'
+require 'cucumber_lint/linted_file'
 require 'cucumber_lint/linter'
+require 'cucumber_lint/linter/feature_empty_lines_linter'
 require 'cucumber_lint/linter/feature_linter'
 require 'cucumber_lint/linter/scenario_outline_linter'
 require 'cucumber_lint/linter/steps_linter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - charlierudolph
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.7.7
 - !ruby/object:Gem::Dependency
   name: gherkin
   requirement: !ruby/object:Gem::Requirement
@@ -31,9 +31,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.2
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,29 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.12.2
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.12.2
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.11.2
 description: 
 email:
 - charles.w.rudolph@gmail.com
@@ -74,38 +62,49 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/cucumber_lint
+- circle.yml
+- config/default.yml
 - cucumber.yml
 - cucumber_lint.gemspec
-- features/cucumber_lint/fix/nothing.feature
-- features/cucumber_lint/fix/repeating_steps.feature
-- features/cucumber_lint/fix/table_whitespace.feature
-- features/cucumber_lint/fix/uppercase_table_headers.feature
-- features/cucumber_lint/lint/nothing.feature
-- features/cucumber_lint/lint/repeating_steps.feature
-- features/cucumber_lint/lint/table_whitespace.feature
-- features/cucumber_lint/lint/uppercase_table_headers.feature
+- features/cucumber_lint/consistent_empty_lines/between_description_and_scenario.feature
+- features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_docstring.feature
+- features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_examples.feature
+- features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_step.feature
+- features/cucumber_lint/consistent_empty_lines/between_elements/ending_with_table.feature
+- features/cucumber_lint/consistent_empty_lines/between_feature_and_description.feature
+- features/cucumber_lint/consistent_empty_lines/between_feature_and_scenario.feature
+- features/cucumber_lint/consistent_table_headers/examples_table.feature
+- features/cucumber_lint/consistent_table_headers/step_table.feature
+- features/cucumber_lint/consistent_table_headers/unsupported_style.feature
+- features/cucumber_lint/consistent_table_whitespace/examples_table.feature
+- features/cucumber_lint/consistent_table_whitespace/step_table.feature
+- features/cucumber_lint/no_empty_features.feature
+- features/cucumber_lint/no_files.feature
+- features/cucumber_lint/no_repeating_keywords.feature
+- features/cucumber_lint/unsupported_options.feature
 - features/step_definitions/cli_steps.rb
 - features/step_definitions/env.rb
-- features/step_definitions/feature_formatter_steps.rb
-- features/step_definitions/fixtures/repeating_steps/bad.feature.example
-- features/step_definitions/fixtures/repeating_steps/good.feature.example
-- features/step_definitions/fixtures/table_whitespace/bad.feature.example
-- features/step_definitions/fixtures/table_whitespace/good.feature.example
-- features/step_definitions/fixtures/uppercase_table_headers/bad.feature.example
-- features/step_definitions/fixtures/uppercase_table_headers/good.feature.example
+- features/step_definitions/fixtures/config/disabled.yml
+- features/step_definitions/support/file_helpers.rb
 - features/step_definitions/support/run_helpers.rb
+- lib/core_ext/array.rb
+- lib/core_ext/basic_object.rb
 - lib/core_ext/hash.rb
+- lib/core_ext/string.rb
 - lib/cucumber_lint.rb
 - lib/cucumber_lint/cli.rb
-- lib/cucumber_lint/fix_list.rb
+- lib/cucumber_lint/config.rb
+- lib/cucumber_lint/errors/unsupported_style.rb
+- lib/cucumber_lint/linted_file.rb
 - lib/cucumber_lint/linter.rb
+- lib/cucumber_lint/linter/feature_empty_lines_linter.rb
 - lib/cucumber_lint/linter/feature_linter.rb
 - lib/cucumber_lint/linter/scenario_outline_linter.rb
 - lib/cucumber_lint/linter/steps_linter.rb
@@ -131,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A command line interface for linting and formatting cucumber features