chutney 2.1.0 → 3.0.0

data/lib/chutney/linter/too_many_different_tags.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for too many different tags
   class TooManyDifferentTags < Linter
     def lint
       tags = all_tags
       return if tags.length <= maxcount
-      
+
       add_issue(
-        I18n.t('linters.too_many_different_tags', count: tags.length, max: maxcount), 
+        I18n.t('linters.too_many_different_tags', count: tags.length, max: maxcount),
         feature
       )
     end
-    
-    def maxcount 
+
+    def maxcount
       configuration['MaxCount']&.to_i || 3
     end
-    
+
     def all_tags
-      return [] unless feature.include?(:children)
-      
-      tags_for(feature) + feature[:children].map { |scenario| tags_for(scenario) }.flatten
+      return [] unless feature&.scenarios
+
+      tags_for(feature) + feature.scenarios.map { |scenario| tags_for(scenario) }.flatten
     end
   end
 end

data/lib/chutney/linter/too_many_steps.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for too many steps
   class TooManySteps < Linter
     def lint
       filled_scenarios do |feature, scenario|
-        next if scenario[:steps].length <= maxcount
-        
+        next if scenario.steps.length <= maxcount
+
         add_issue(
-          I18n.t('linters.too_many_steps', count: scenario[:steps].length, max: maxcount), 
+          I18n.t('linters.too_many_steps', count: scenario.steps.length, max: maxcount),
           feature
         )
       end
     end
-    
+
     def maxcount
       configuration['MaxCount']&.to_i || 10
     end

data/lib/chutney/linter/too_many_tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for too many tags
   class TooManyTags < Linter
@@ -5,14 +7,14 @@ module Chutney
       scenarios do |feature, scenario|
         tags = tags_for(feature) + tags_for(scenario)
         next unless tags.length > maxcount
-        
+
         add_issue(
-          I18n.t('linters.too_many_tags', count: tags.length, max: maxcount), 
+          I18n.t('linters.too_many_tags', count: tags.length, max: maxcount),
           feature
         )
       end
     end
-    
+
     def maxcount
       configuration['MaxCount']&.to_i || 3
     end

data/lib/chutney/linter/unique_scenario_names.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for unique scenario names
   class UniqueScenarioNames < Linter
     def lint
       references_by_name = {}
       scenarios do |feature, scenario|
-        next unless scenario.key? :name
-
-        name = scenario[:name]
+        name = scenario.name
         if references_by_name[name]
           issue(name, references_by_name[name], scenario)
         else
@@ -14,13 +14,13 @@ module Chutney
         end
       end
     end
-    
+
     def issue(name, first_location, scenario)
       add_issue(
         I18n.t('linters.unique_scenario_names',
                name: name,
                line: first_location[:line],
-               column: first_location[:column]), 
+               column: first_location[:column]),
         feature, scenario
       )
     end

data/lib/chutney/linter/unknown_variable.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for unknown variables
   class UnknownVariable < Linter
     def lint
       filled_scenarios do |feature, scenario|
         known_vars = Set.new(known_variables(scenario))
-        scenario[:steps].each do |step|
+        scenario.steps.each do |step|
           step_vars(step).each do |used_var|
             next if known_vars.include? used_var
-            
+
             add_issue(
               I18n.t('linters.unknown_variable', variable: used_var), feature, scenario
             )
@@ -17,17 +19,17 @@ module Chutney
     end
 
     def step_vars(step)
-      vars = gather_vars step[:text]
-      return vars unless step.include? :argument
-      
-      vars + gather_vars_from_argument(step[:argument])
+      vars = gather_vars step.text
+      return vars unless step.block
+
+      vars + gather_vars_from_argument(step.block)
     end
 
     def gather_vars_from_argument(argument)
-      return gather_vars argument[:content] if argument[:type] == :DocString
-      
-      (argument[:rows] || []).map do |row|
-        row[:cells].map { |value| gather_vars value[:value] }.flatten
+      return gather_vars argument.content if argument.is_a? CukeModeler::DocString
+
+      argument.rows.map do |row|
+        row.cells.map { |cell| gather_vars cell.value }.flatten
       end.flatten
     end
 
@@ -36,11 +38,9 @@ module Chutney
     end
 
     def known_variables(scenario)
-      (scenario[:examples] || []).map do |example|
-        next unless example.key? :tableHeader
-        
-        example[:tableHeader][:cells].map { |cell| cell[:value].strip }
-      end.flatten
+      return [] unless scenario.is_a? CukeModeler::Outline
+
+      scenario.examples.map { |ex| ex.rows.first.cells.map(&:value) }.flatten
     end
   end
 end

data/lib/chutney/linter/unused_variable.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for unused variables
   class UnusedVariable < Linter
     def lint
       scenarios do |feature, scenario|
-        next unless scenario.key?(:examples)
-        
-        scenario[:examples].each do |example|
-          next unless example.key?(:tableHeader)
-          
-          example[:tableHeader][:cells].map { |cell| cell[:value] }.each do |variable|
+        next unless scenario.is_a? CukeModeler::Outline
+
+        scenario.examples.each do |example|
+          example.rows.first.cells.map(&:value).each do |variable|
             next if used?(variable, scenario)
 
             add_issue(I18n.t('linters.unused_variable', variable: variable), feature, scenario, example)
@@ -19,11 +19,10 @@ module Chutney
 
     def used?(variable, scenario)
       variable = "<#{variable}>"
-      return false unless scenario.key? :steps
-      
-      scenario[:steps].each do |step|
-        return true if step[:text].include? variable
-        next unless step.include? :argument
+
+      scenario.steps.each do |step|
+        return true if step.text.include? variable
+        next unless step.block
         return true if used_in_docstring?(variable, step)
         return true if used_in_table?(variable, step)
       end
@@ -31,14 +30,14 @@ module Chutney
     end
 
     def used_in_docstring?(variable, step)
-      step[:argument][:type] == :DocString && step[:argument][:content].include?(variable)
+      step.block.is_a?(CukeModeler::DocString) && step.block.content.include?(variable)
     end
 
     def used_in_table?(variable, step)
-      return false unless step[:argument][:type] == :DataTable
-      
-      step[:argument][:rows].each do |row|
-        row[:cells].each { |value| return true if value[:value].include?(variable) }
+      return false unless step.block.is_a?(CukeModeler::Table)
+
+      step.block.rows.each do |row|
+        row.cells.each { |cell| return true if cell.value.include?(variable) }
       end
       false
     end

data/lib/chutney/linter/use_background.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for using background
   class UseBackground < Linter
@@ -13,14 +15,13 @@ module Chutney
     end
 
     def gather_givens
-      return unless feature.include? :children
-      
+      return unless feature.children
+
       has_non_given_step = false
-      feature[:children].each do |scenario|
-        next unless scenario.include? :steps
-        next if scenario[:steps].empty?
-        
-        has_non_given_step = true unless given_word?(scenario[:steps].first[:keyword])
+      scenarios do |_feature, scenario|
+        next unless scenario.steps
+
+        has_non_given_step = true unless given_word?(scenario.steps.first.keyword)
       end
       return if has_non_given_step
 
@@ -29,15 +30,13 @@ module Chutney
       result
     end
 
-    def expanded_steps
-      feature[:children].each do |scenario|
-        next unless scenario[:type] != :Background
-        next unless scenario.include? :steps
-        next if scenario[:steps].empty?
-        
-        prototypes = [render_step(scenario[:steps].first)]
-        prototypes = expand_examples(scenario[:examples], prototypes) if scenario.key? :examples
-        prototypes.each { |prototype| yield prototype }
+    def expanded_steps(&block)
+      scenarios do |_feature, scenario|
+        next unless scenario.steps
+
+        prototypes = [render_step(scenario.steps.first)]
+        prototypes = expand_examples(scenario.examples, prototypes) if scenario.is_a? CukeModeler::Outline
+        prototypes.each(&block)
       end
     end
 
@@ -50,10 +49,12 @@ module Chutney
 
     def expand_outlines(sentence, example)
       result = []
-      headers = example[:tableHeader][:cells].map { |cell| cell[:value] }
-      example[:tableBody].each do |row| # .slice(1, example[:tableBody].length).each do |row|
+      headers = example.rows.first.cells.map(&:value)
+      example.rows.each_with_index do |row, idx|
+        next if idx.zero? # skip the header
+
         modified_sentence = sentence.dup
-        headers.zip(row[:cells].map { |cell| cell[:value] }).map do |key, value|
+        headers.zip(row.cells.map(&:value)).map do |key, value|
           modified_sentence.gsub!("<#{key}>", value)
         end
         result.push modified_sentence

data/lib/chutney/linter/use_outline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for using outline
   class UseOutline < Linter
@@ -9,18 +11,18 @@ module Chutney
       scenarios.product(scenarios) do |lhs, rhs|
         next if lhs == rhs
         next if lhs[:reference][:line] > rhs[:reference][:line]
-        
+
         similarity = determine_similarity(lhs[:text], rhs[:text])
         next unless similarity >= 0.95
-        
+
         similarity_pct = similarity.round(3) * 100
-        
+
         add_issue(lhs, rhs, similarity_pct)
       end
     end
-    
+
     def add_issue(lhs, rhs, pct)
-      super(I18n.t('linters.use_outline', 
+      super(I18n.t('linters.use_outline',
                    pct: pct,
                    lhs_name: lhs[:name],
                    lhs_line: lhs[:reference][:line],
@@ -36,13 +38,12 @@ module Chutney
 
     def gather_scenarios(feature)
       scenarios = []
-      return scenarios unless feature.include? :children
-      
-      feature[:children].each do |scenario|
-        next unless scenario[:type] == :Scenario
-        next unless scenario.include? :steps
-        next if scenario[:steps].empty?
-        
+      return scenarios if feature.nil? || !feature.tests
+
+      scenarios do |_feature, scenario|
+        next unless scenario.steps
+        next if scenario.steps.empty?
+
         scenarios.push generate_reference(feature, scenario)
       end
       scenarios
@@ -51,8 +52,8 @@ module Chutney
     def generate_reference(feature, scenario)
       reference = {}
       reference[:reference] = location(feature, scenario, nil)
-      reference[:name] = "#{scenario[:keyword]}: #{scenario[:name]}"
-      reference[:text] = scenario[:steps].map { |step| render_step(step) }.join ' '
+      reference[:name] = "#{scenario.keyword}: #{scenario.name}"
+      reference[:text] = scenario.steps.map { |step| render_step(step) }.join ' '
       reference
     end
   end

data/lib/chutney/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
-  VERSION = '2.1.0'.freeze
+  VERSION = '3.0.0'
 end

data/lib/config/locales/en.yml

@@ -21,6 +21,8 @@ en:
       Avoid using Background if you only have a single scenario.
     bad_scenario_name: >-
       You should avoid using words like '%{word}' in your scenario names.
+    empty_feature_file: >-
+      The feature file is empty
     file_name_differs_feature_name: >-
       The name of the feature should reflect the file name. Consider renaming this feature
       to '%{expected}'.

data/spec/chutney_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'chutney'
 
 describe Chutney::ChutneyLint do
@@ -6,25 +8,25 @@ describe Chutney::ChutneyLint do
   it 'has a version number' do
     expect(Chutney::VERSION).not_to be nil
   end
-  
+
   describe '#initialize' do
     it 'creates an instance' do
       expect(subject).not_to be_nil
     end
-    
+
     it 'has an empty list of files if none are given' do
       expect(subject.files).to eq []
     end
-    
+
     it 'has a list of files given on initialization' do
       alt_subject = Chutney::ChutneyLint.new('a', 'b')
       expect(alt_subject.files).to eq %w[a b]
     end
-    
+
     it 'initializes a results hash' do
       expect(subject.results).to eq({})
     end
-    
+
     it 'sets the load path for I18n' do
       expect(I18n.load_path).not_to eq []
     end
@@ -34,25 +36,25 @@ describe Chutney::ChutneyLint do
         expect(subject.configuration).not_to be_nil
         expect(subject.configuration).to respond_to :[]
       end
-      
+
       it 'allows the configuration to be set explicitly' do
         config = { 'BackgroundDoesMoreThanSetup' => { 'Enabled' => true } }
         subject.configuration = config
         expect(subject.configuration).to be config
       end
-      
+
       it 'controls the available linters' do
         subject.configuration = {}
         expect(subject.linters).to be_empty
       end
-      
+
       it 'enables linters to be activated' do
         config = { 'BackgroundDoesMoreThanSetup' => { 'Enabled' => true } }
         subject.configuration = config
         expect(subject.linters).to eq [Chutney::BackgroundDoesMoreThanSetup]
       end
     end
-    
+
     context 'linting' do
       it 'aliases analyse and analyze' do
         expect(subject).to respond_to :analyse

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'coveralls'
 # Coveralls.wear!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-17 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -28,19 +28,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: gherkin
+  name: cuke_modeler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -103,14 +103,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -173,14 +173,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.85.1
+        version: 0.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.85.1
+        version: 0.90.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -195,8 +195,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-description: A linter for your Cucumber features. It supports any spoken language
-  Cucumber v3 supports.
+description: A linter for your Cucumber features. Making sure you have nice, expressible
+  Gherkin is essential is making sure you have a readable test-base. Chutney is designed
+  to sniff out smells in your feature files. It supports any spoken language Cucumber
+  supports.
 email:
 - nigel@brookes-thomas.co.uk
 executables:
@@ -215,7 +217,8 @@ files:
 - README.md
 - Rakefile
 - chutney.gemspec
-- config/chutney.yml
+- config/chutney_defaults.yml
+- config/cucumber.yml
 - docs/.keep
 - docs/_config.yml
 - docs/credits.md
@@ -247,6 +250,7 @@ files:
 - lib/chutney/linter/background_does_more_than_setup.rb
 - lib/chutney/linter/background_requires_multiple_scenarios.rb
 - lib/chutney/linter/bad_scenario_name.rb
+- lib/chutney/linter/empty_feature_file.rb
 - lib/chutney/linter/file_name_differs_feature_name.rb
 - lib/chutney/linter/givens_after_background.rb
 - lib/chutney/linter/invalid_file_name.rb
@@ -288,9 +292,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -300,5 +304,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
-summary: A linter for English language Gherkin
+summary: A linter for multi-lingual Gherkin
 test_files: []