chutney 3.2.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc456f7ef0c0788108026c08c161d0883fdf046b87d3851901eb3cabf80bbde3
-  data.tar.gz: fdd038b05c9650b1a785175f633397eb5bb00640ae82d9169f04f43e45c5fa42
+  metadata.gz: 72a8913c71a8e2291fa14ef87b527e11481dfe45519370455fbddf2df8856836
+  data.tar.gz: cd4fded7ea629dd5ae5e5b74ac204c8b5d3dfee96e21f65db3c3355449dbb0c1
 SHA512:
-  metadata.gz: 423221898076fd513aa1dd07eb7778660b89ee615f814dca871b08cc700f1080190f37c72440cba8a4d6524ecc9ac6cb5b656d1983a8eae1e1bfac4a13805a38
-  data.tar.gz: feea3300f389e31739e184f60e6226ab3586f438da71ccfcfaa9edc355d673059e2a06469ded959c718ef4b6dd7c2f2c14ae9a6e36fa8614839a58e91044b873
+  metadata.gz: 2387b637bdb751865c8f6fbc97f61e90e25f7d6dc52f6da7dae598f5d156c06226f985df609b3a58597213f7e9b6e5a87be2fd5c67c78b57ae60c16603cde040
+  data.tar.gz: b7d67216485f10777e91250582facc4143e0f463360463f87aa8bf219e16b91e8e000a4e8ae94f442130f5246d0adf61e4df0b50b22bea1a05743145ea77e346

data/.gitignore

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

data/Rakefile

@@ -2,7 +2,7 @@
 
 require 'rake/testtask'
 
-task default: :build
+task default: :test
 
 desc 'Builds the Gem.'
 task build: :format

data/chutney.gemspec

@@ -50,7 +50,7 @@ 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', '< 1.12.0'
+  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'
 
@@ -61,7 +61,7 @@ Gem::Specification.new do |spec|
   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.31.2'
+  spec.add_development_dependency 'rubocop', '~> 1.45.1'
   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:
@@ -20,12 +24,16 @@ GivensAfterBackground:
     Enabled: true
 MissingExampleName:
     Enabled: true
+MissingExampleTable:
+    Enabled: true
 MissingFeatureDescription:
     Enabled: true
 MissingFeatureName:
     Enabled: true
 MissingScenarioName:
     Enabled: true
+MissingScenarioOutline:
+    Enabled: true
 MissingTestAction:
     Enabled: true
 MissingVerification:

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.
@@ -35,12 +39,16 @@ Chutney enforces its rules with the linters. These are:
 
 [MissingExampleName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_example_name.feature): If you have more than one example table in your scenario, they should each be given unique names.
 
+[MissingExampleTable](https://github.com/BillyRuffian/chutney/blob/master/features/missing_example_table.feature): You are missing an example table. You should have at least one example table when using Scenario outlines.
+
 [MissingFeatureDescription](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_description.feature): Your feature should have a value statement. These are usually in the form 'As a... I want.. So that...'.
 
 [MissingFeatureName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_name.feature): You should give your features a descriptive name.
 
 [MissingScenarioName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_scenario_name.feature): You should name your scenarios and scenario outlines.
 
+[MissingScenarioOutline](https://github.com/BillyRuffian/chutney/blob/master/features/missing_scenario_outline.feature): You should use Scenario Outline instead of Scenario when there is an Examples table to indicate that this scenario will be run multiple times with different data.
+
 [MissingTestAction](https://github.com/BillyRuffian/chutney/blob/master/features/missing_test_action.feature): You don't have an action (a `When` step) in your scenario.
 
 [MissingVerification](https://github.com/BillyRuffian/chutney/blob/master/features/missing_verification.feature): You don't have a verification step (a `Then` step) in your scenario.

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_outline_for_single_example.rb

@@ -9,6 +9,7 @@ module Chutney
         next unless scenario.examples
 
         next if scenario.examples.length > 1
+        next if scenario.examples.first.nil? # dont run lint if the example does not exist
         next if scenario.examples.first.rows.length > 2 # first row is the header
 
         add_issue(I18n.t('linters.avoid_outline_for_single_example'), feature, scenario)

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/missing_example_table.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'chutney/linter'
+
+module Chutney
+  # service class to lint for missing example tables in scenario outlines
+  class MissingExampleTable < Linter
+    def lint
+      scenarios do |_feature, scenario|
+        next unless scenario.is_a? CukeModeler::Outline
+        next unless scenario.examples.empty?
+
+        add_issue(I18n.t('linters.missing_example_table'), feature, scenario)
+      end
+    end
+  end
+end

data/lib/chutney/linter/missing_scenario_outline.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'chutney/linter'
+
+module Chutney
+  # service class to lint for missing scenario outlines when examples tables given
+  class MissingScenarioOutline < Linter
+    def lint
+      scenarios do |_feature, scenario|
+        next unless scenario.is_a? CukeModeler::Outline
+        next unless scenario.keyword == 'Scenario'
+
+        add_issue(I18n.t('linters.missing_scenario_outline'), feature, scenario)
+      end
+    end
+  end
+end

data/lib/chutney/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chutney
-  VERSION = '3.2.1'
+  VERSION = '3.5.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'
@@ -17,9 +19,11 @@ require 'chutney/linter/givens_after_background'
 require 'chutney/linter/invalid_file_name'
 require 'chutney/linter/invalid_step_flow'
 require 'chutney/linter/missing_example_name'
+require 'chutney/linter/missing_example_table'
 require 'chutney/linter/missing_feature_description'
 require 'chutney/linter/missing_feature_name'
 require 'chutney/linter/missing_scenario_name'
+require 'chutney/linter/missing_scenario_outline'
 require 'chutney/linter/missing_test_action'
 require 'chutney/linter/missing_verification'
 require 'chutney/linter/required_tags_starts_with'

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
@@ -45,6 +49,8 @@ en:
       You have a scenerio with more than one example table, at least one of which is
       unnamed or has a duplicate name.
       You should give your example tables clear and meaningful names when you have more than one.
+    missing_example_table: >-
+      Scenario Outline must have at least one Examples table.
     missing_feature_description: >-
       Features should have a description / value statement so that the importance of the feature
       is well understood.
@@ -52,6 +58,8 @@ en:
       This feature is unnamed. You should name all features.
     missing_scenario_name: >-
       This scenario is unnamed. You should name all scenarios.
+    missing_scenario_outline: >-
+      Scenario Outline should be used instead of Scenario when there is an Examples table.
     missing_test_action: >-
       Your test has no action step. All scenarios should have a 'When' step indicating the
       action being taken.

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.2.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -50,7 +50,7 @@ dependencies:
         version: 1.8.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -60,7 +60,7 @@ dependencies:
         version: 1.8.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -179,14 +179,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.2
+        version: 1.45.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.31.2
+        version: 1.45.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -253,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
@@ -263,9 +265,11 @@ files:
 - lib/chutney/linter/invalid_file_name.rb
 - lib/chutney/linter/invalid_step_flow.rb
 - lib/chutney/linter/missing_example_name.rb
+- lib/chutney/linter/missing_example_table.rb
 - lib/chutney/linter/missing_feature_description.rb
 - lib/chutney/linter/missing_feature_name.rb
 - lib/chutney/linter/missing_scenario_name.rb
+- lib/chutney/linter/missing_scenario_outline.rb
 - lib/chutney/linter/missing_test_action.rb
 - lib/chutney/linter/missing_verification.rb
 - lib/chutney/linter/required_tags_starts_with.rb
@@ -310,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: A linter for multi-lingual Gherkin