chutney 3.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a4331eb00fea09babefa186ea7d1e51f13bacbd56cf381cf3fb3d58f293346
-  data.tar.gz: 16b169146ac5034d46eee9d6858a6b219d854b00d71445a5baca5d6532340b4a
+  metadata.gz: 6725cb1d8360b6cf746da8362a04e4e1e1795ee21d70876d39ff08e230ffd0dd
+  data.tar.gz: ad0cc926afdacbdcd8853866073102f0796f0cd3338b02f5ff5bdc69060c2724
 SHA512:
-  metadata.gz: 2a8000d183486b9c3201ff22e43fbcfc316d5117b68539aae88b0d22ec2d9d549fdd945c8a4a15393f14d147e53c038923be3aa1dda3483a6066fb58a48ff50f
-  data.tar.gz: a9a32669fb7ddfd30e742647883a079b654e570b2e6653996a8c9ea26fe1601a402148aabf357e6a79f9150d9f747c8ce6fc80b8036180e3a5b53b3096930950
+  metadata.gz: a36c2f5da40c1672b77dbbc836a4db6cccf7f445547303aae8e85392ab7b84daba918c8d0343eb73c4683f42c0fce03ebbaf4500a2690878a1fe4fdb5fe0385a
+  data.tar.gz: 5a51f02edf59cee68d71855263cdc7692d6132c8eddeb5f97f8d1e3d0512a08e1533457f6545abf6f737dada8c36f81a83d29d6cea15a8c6f4c198a51a7c5728

data/.gitignore

@@ -10,6 +10,7 @@
 Gemfile.lock
 # rspec failure tracking
 .rspec_status
+.idea/
 
 .DS_Store
 

data/.rubocop.yml

@@ -63,3 +63,4 @@ Style/StringConcatenation:
 
 AllCops:
   NewCops: enable
+  SuggestExtensions: false

data/Rakefile

@@ -2,7 +2,7 @@
 
 require 'rake/testtask'
 
-task default: :build
+task default: :test
 
 desc 'Builds the Gem.'
 task build: :format
@@ -27,7 +27,7 @@ rescue RuntimeError => e
 end
 
 task :spec do
-  sh 'rspec'
+  sh 'bundle exec rspec'
 end
 
 task :cucumber do

data/chutney.gemspec

@@ -50,18 +50,18 @@ Gem::Specification.new do |spec|
   
   spec.add_runtime_dependency 'amatch', '~> 0.4.0'
   spec.add_runtime_dependency 'cuke_modeler', '~> 3.3'
-  spec.add_runtime_dependency 'i18n', '~> 1.8.2'
+  spec.add_runtime_dependency 'i18n', '>= 1.8.2', '< 1.13.0'
   spec.add_runtime_dependency 'pastel', '~> 0.7'
   spec.add_runtime_dependency 'tty-pie', '~> 0.3'
 
 
   spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'cucumber', '~> 6.0'
+  spec.add_development_dependency 'cucumber', '>= 7.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rerun', '~> 0.13'
   spec.add_development_dependency 'rspec-expectations', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.14.0'
+  spec.add_development_dependency 'rubocop', '~> 1.32.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
   spec.required_ruby_version = '>= 2.6'

data/config/chutney_defaults.yml

@@ -4,6 +4,10 @@ AvoidFullStop:
     Enabled: true
 AvoidScripting:
     Enabled: true
+AvoidSplatStepsInBackground:
+    Enabled: true
+AvoidSplatStepsInScenarios:
+    Enabled: true
 AvoidTypographersQuotes:
     Enabled: true
 BackgroundDoesMoreThanSetup:

data/config/cucumber.yml

@@ -1 +1 @@
-default: --publish-quiet
+default: --publish-quiet

data/docs/usage/configuration.md

@@ -9,4 +9,4 @@ nav_order: 3
 
 Chutney looks for a configuration file in the current directory called `config/.chutney.yml`. This configuration mostly switches on individual linters globally, but a few have addition parameters which can be configured (e.g. the maximum characters in a step).
 
-A default configuration can be found [here](https://github.com/BillyRuffian/chutney/blob/master/config/chutney.yml).
+A default configuration can be found [here](https://github.com/BillyRuffian/chutney/blob/master/config/chutney_defaults.yml).

data/docs/usage/rules.md

@@ -15,6 +15,10 @@ Chutney enforces its rules with the linters. These are:
 
 [AvoidScripting](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_scripting.feature): You have a lot of steps, are you sure you're not scripting the scenario when you should be specifying the behaviour of the system?
 
+[AvoidSplatStepsInBackground](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_splat_steps_in_background.feature): The Background contains a splat step. It should only contain named steps.
+
+[AvoidSplatStepsInScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_splat_steps_in_scenarios.feature): The Scenario contains a splat step. It should only contain named steps.
+
 [AvoidTypographersQuotes](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_typographers_quotes.feature): Cutting and pasting from Word documents? Is that pasting in curly-quotes instead of neutral ones you would type on a keyboard? Are you sure that's what you want?
 
 [BackgroundDoesMoreThanSetup](https://github.com/BillyRuffian/chutney/blob/master/features/background_does_more_than_setup.feature): Background in feature files should only do setup activity and so they should only contain `Given` steps.

data/exe/chutney

@@ -10,6 +10,7 @@ require 'optparse'
 
 formatters = Set.new
 
+# rubocop:disable Metrics/BlockLength
 OptionParser.new do |opts|
   opts.banner = 'Usage: chutney [files]'
   opts.on('-f',
@@ -20,6 +21,11 @@ OptionParser.new do |opts|
     formatters << formatter
   end
 
+  opts.on('-v', '--version', 'Display the version.') do
+    puts Chutney::VERSION
+    exit
+  end
+
   opts.on('-l',
           '--linters',
           'List the linter status by this configuration and exit') do
@@ -38,6 +44,7 @@ OptionParser.new do |opts|
     exit
   end
 end.parse!
+# rubocop:enable Metrics/BlockLength
 
 formatters << 'RainbowFormatter' if formatters.empty?
 

data/lib/chutney/linter/avoid_splat_steps_in_background.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for avoiding splats
+  class AvoidSplatStepsInBackground < Linter
+    def lint
+      background do |feature, background|
+        splat_steps = background&.steps&.select { |s| s.keyword == '*' }
+        # add_issue(I18n.t('linters.avoid_full_stop'), feature, child, step) if step.text.strip.end_with? '.'
+        if splat_steps && !splat_steps.empty?
+          add_issue(I18n.t('linters.avoid_splat_steps_in_background'), feature, background, splat_steps.first)
+        end
+      end
+    end
+  end
+end

data/lib/chutney/linter/avoid_splat_steps_in_scenarios.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for avoiding splats
+  class AvoidSplatStepsInScenarios < Linter
+    def lint
+      steps do |feature, child, step|
+        add_issue(I18n.t('linters.avoid_splat_steps_in_scenarios'), feature, child, step) if step.keyword == '*'
+      end
+    end
+  end
+end

data/lib/chutney/linter.rb

@@ -66,7 +66,14 @@ module Chutney
     end
 
     def dialect
-      @content.feature&.parsing_data&.dig(:language) || 'en'
+      parsing_data = @content.feature&.parsing_data
+      if !parsing_data.nil? && parsing_data.respond_to?(:language)
+        parsing_data.language
+      elsif parsing_data
+        parsing_data[:language]
+      else
+        raise UnsupportedCucumberError, 'This version of cucumber is unsupported (langauge detection)'
+      end
     end
 
     def tags_for(element)
@@ -79,19 +86,12 @@ module Chutney
         gherkin_type: type(feature, scenario, item),
         location: location(feature, scenario, item),
         feature: feature&.name,
-        scenario: scenario&.name,
-        step: item&.parsing_data&.dig(:name)
+        scenario: scenario&.name
       ).to_h
     end
 
     def location(feature, scenario, step)
-      if step
-        step.parsing_data[:location]
-      elsif scenario
-        scenario.parsing_data.dig(:scenario, :location) || scenario.parsing_data.dig(:background, :location)
-      else
-        feature ? feature.parsing_data[:location] : { line: 0, column: 0 }
-      end
+      Locator.locate(feature, scenario, step)
     end
 
     def type(_feature, scenario, step)

data/lib/chutney/locator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Chutney
+  # Utility module to assist in locating the source of parts of a gherkin specification
+  module Locator
+    module_function
+
+    def locate(feature, scenario, step)
+      if step
+        locate_step(step)
+      elsif scenario
+        locate_scenario(scenario)
+      elsif feature
+        locate_feature(feature)
+      else
+        feature
+      end
+    end
+
+    def locate_step(step)
+      return step.parsing_data.location.to_h if step.parsing_data.respond_to?(:location)
+      return step.parsing_data[:location] if step.parsing_data.is_a?(Hash)
+
+      raise UnsupportedCucumberError, 'This version of cucumber is unsupported (step location)'
+    end
+
+    def locate_scenario(scenario)
+      parsing_data = scenario.parsing_data
+
+      if parsing_data.is_a?(Hash)
+        parsing_data.dig(:scenario, :location) || parsing_data.dig(:background, :location)
+      elsif parsing_data.respond_to?(:scenario)
+        (parsing_data.scenario || parsing_data.background).location.to_h
+      else
+        raise UnsupportedCucumberError, 'This version of cucumber is unsupported (scenario location)'
+      end
+    end
+
+    def locate_feature(feature)
+      return feature.parsing_data.location.to_h if feature.parsing_data.respond_to?(:location)
+      return feature.parsing_data[:location] if feature.parsing_data.is_a?(Hash)
+
+      raise UnsupportedCucumberError, 'This version of cucumber is unsupported (feature location)'
+    end
+  end
+end

data/lib/chutney/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chutney
-  VERSION = '3.1.1'
+  VERSION = '3.3.0'
 end

data/lib/chutney.rb

@@ -7,6 +7,8 @@ require 'chutney/linter'
 require 'chutney/linter/avoid_full_stop'
 require 'chutney/linter/avoid_outline_for_single_example'
 require 'chutney/linter/avoid_scripting'
+require 'chutney/linter/avoid_splat_steps_in_background'
+require 'chutney/linter/avoid_splat_steps_in_scenarios'
 require 'chutney/linter/avoid_typographers_quotes'
 require 'chutney/linter/background_does_more_than_setup'
 require 'chutney/linter/background_requires_multiple_scenarios'
@@ -37,6 +39,7 @@ require 'chutney/linter/unknown_variable'
 require 'chutney/linter/unused_variable'
 require 'chutney/linter/use_background'
 require 'chutney/linter/use_outline'
+require 'chutney/locator'
 require 'chutney/version'
 
 require 'cuke_modeler'
@@ -48,6 +51,8 @@ require 'set'
 require 'yaml'
 
 module Chutney
+  class UnsupportedCucumberError < StandardError; end
+
   # gherkin linter
   class ChutneyLint
     extend Forwardable

data/lib/config/locales/en.yml

@@ -11,6 +11,10 @@ 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_splat_steps_in_background: >-
+      The Background contains a splat step. It should only contain named steps.
+    avoid_splat_steps_in_scenarios: >-
+      The Scenario contains a splat step. It should only contain named steps.
     avoid_typographers_quotes: >-
       You are using typographers quotation marks (curly quotes).
       Make sure you intend to use this character and not a neutral quote

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'simplecov'
-require 'coveralls'
-# Coveralls.wear!
-SimpleCov.start
+# require 'simplecov'
+# require 'coveralls'
+# # Coveralls.wear!
+# SimpleCov.start
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -45,16 +45,22 @@ dependencies:
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -101,16 +107,16 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -173,14 +179,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.32.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.32.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -247,6 +253,8 @@ 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_splat_steps_in_background.rb
+- lib/chutney/linter/avoid_splat_steps_in_scenarios.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
@@ -277,6 +285,7 @@ files:
 - lib/chutney/linter/unused_variable.rb
 - lib/chutney/linter/use_background.rb
 - lib/chutney/linter/use_outline.rb
+- lib/chutney/locator.rb
 - lib/chutney/version.rb
 - lib/config/locales/en.yml
 - spec/chutney_spec.rb
@@ -303,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A linter for multi-lingual Gherkin