chutney 2.0.3.1 → 3.0.0.beta.2

data/lib/chutney/linter/scenario_names_match.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 require 'chutney/linter'
 
 module Chutney
   # service class to lint for tags used multiple times
   class ScenarioNamesMatch < Linter
-    MESSAGE = 'Scenario Name does not match pattern'.freeze
+    MESSAGE = 'Scenario Name does not match pattern'
   
 
     def lint
       scenarios do |feature, scenario|
-        name = scenario.key?(:name) ? scenario[:name].strip : ''
-        next unless (name =~ /#{configuration['Matcher']}/).nil?
+        next unless (scenario.name =~ /#{configuration['Matcher']}/).nil?
         
         add_issue(
           I18n.t('linters.scenario_names_match', 

data/lib/chutney/linter/tag_used_multiple_times.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for tags used multiple times
   class TagUsedMultipleTimes < Linter

data/lib/chutney/linter/too_clumsy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'chutney/linter'
 
 module Chutney
@@ -5,7 +7,7 @@ module Chutney
   class TooClumsy < Linter
     def lint
       filled_scenarios do |feature, scenario|
-        characters = scenario[:steps].map { |step| step[:text].length }.inject(0, :+)
+        characters = scenario.steps.map { |step| step.text.length }.inject(0, :+)
         next if characters < 400
         
         add_issue(

data/lib/chutney/linter/too_long_step.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for too long steps
   class TooLongStep < Linter
     def lint
       steps do |feature, scenario, step|
-        next if step[:text].length <= maxlength
+        next if step.text.length <= maxlength
         
         add_issue(
-          I18n.t('linters.too_long_step', length: step[:text].length, max: maxlength), 
+          I18n.t('linters.too_long_step', length: step.text.length, max: maxlength), 
           feature, scenario
         )
       end

data/lib/chutney/linter/too_many_different_tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for too many different tags
   class TooManyDifferentTags < Linter
@@ -16,9 +18,9 @@ module Chutney
     end
     
     def all_tags
-      return [] unless feature.include?(:children)
+      return [] unless feature&.scenarios
       
-      tags_for(feature) + feature[:children].map { |scenario| tags_for(scenario) }.flatten
+      tags_for(feature) + feature.scenarios.map { |scenario| tags_for(scenario) }.flatten
     end
   end
 end

data/lib/chutney/linter/too_many_steps.rb

@@ -1,12 +1,14 @@
+# 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

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

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

data/lib/chutney/linter/unknown_variable.rb

@@ -1,10 +1,12 @@
+# 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
             
@@ -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 step.text
+      return vars unless step.block
       
-      vars + gather_vars_from_argument(step[:argument])
+      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,15 @@
+# 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)
+        next unless scenario.is_a? CukeModeler::Outline
+      
+        scenario.examples.each do |example|
           
-          example[:tableHeader][:cells].map { |cell| cell[:value] }.each do |variable|
+          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 +20,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 +31,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
+      return false unless step.block.is_a?(CukeModeler::Table)
       
-      step[:argument][:rows].each do |row|
-        row[:cells].each { |value| return true if value[:value].include?(variable) }
+      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?
+      scenarios do |_feature, scenario|
+        next unless scenario.steps
         
-        has_non_given_step = true unless given_word?(scenario[:steps].first[:keyword])
+        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?
+    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.key? :examples
-        prototypes.each { |prototype| yield prototype }
+        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
@@ -36,12 +38,11 @@ module Chutney
 
     def gather_scenarios(feature)
       scenarios = []
-      return scenarios unless feature.include? :children
+      return scenarios if feature.nil? || !feature.tests
       
-      feature[:children].each do |scenario|
-        next unless scenario[:type] == :Scenario
-        next unless scenario.include? :steps
-        next if scenario[:steps].empty?
+      scenarios do |_feature, scenario|
+        next unless scenario.steps
+        next if scenario.steps.empty?
         
         scenarios.push generate_reference(feature, scenario)
       end
@@ -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.0.3.1'.freeze
+  VERSION = '3.0.0.beta.2'
 end

data/lib/config/locales/en.yml

@@ -11,12 +11,18 @@ en:
     avoid_scripting: >-
       You have %{count} When steps when you should only have one.
       Be careful not to add And steps following a When.
+    avoid_typographers_quotes: >-
+      You are using typographers quotation marks (curly quotes).
+      Make sure you intend to use this character and not a neutral quote
+      (straight quote) instead.
     background_does_more_than_setup: >-
       The Background does more than setup. It should only contain Given steps.
     background_requires_multiple_scenarios: >-
       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

data/spec/spec_helper.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 2.0.3.1
+  version: 3.0.0.beta.2
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 - Stefan Rohe
 - Nishtha Argawal
 - John Gluck
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-09-17 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
@@ -99,6 +99,20 @@ dependencies:
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -159,14 +173,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 0.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 0.89.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -181,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:
@@ -195,12 +211,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rufo"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - chutney.gemspec
 - config/chutney.yml
+- config/cucumber.yml
 - docs/.keep
 - docs/_config.yml
 - docs/credits.md
@@ -228,9 +246,11 @@ files:
 - lib/chutney/linter/avoid_full_stop.rb
 - lib/chutney/linter/avoid_outline_for_single_example.rb
 - lib/chutney/linter/avoid_scripting.rb
+- lib/chutney/linter/avoid_typographers_quotes.rb
 - 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
@@ -266,23 +286,23 @@ metadata:
   homepage_uri: https://billyruffian.github.io/chutney/
   source_code_uri: https://github.com/BillyRuffian/chutney
   changelog_uri: https://github.com/BillyRuffian/chutney/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: A linter for English language Gherkin
+summary: A linter for multi-lingual Gherkin
 test_files: []