chutney 3.3.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6725cb1d8360b6cf746da8362a04e4e1e1795ee21d70876d39ff08e230ffd0dd
-  data.tar.gz: ad0cc926afdacbdcd8853866073102f0796f0cd3338b02f5ff5bdc69060c2724
+  metadata.gz: 0badc9f82efb1e59bc755597c4ef3f7a4f973e37fec2fc25d4b93192319a75eb
+  data.tar.gz: 9459b41ac94999efc721d07f54e8e14b3c83c4f00786f003937a65dd2054fb9f
 SHA512:
-  metadata.gz: a36c2f5da40c1672b77dbbc836a4db6cccf7f445547303aae8e85392ab7b84daba918c8d0343eb73c4683f42c0fce03ebbaf4500a2690878a1fe4fdb5fe0385a
-  data.tar.gz: 5a51f02edf59cee68d71855263cdc7692d6132c8eddeb5f97f8d1e3d0512a08e1533457f6545abf6f737dada8c36f81a83d29d6cea15a8c6f4c198a51a7c5728
+  metadata.gz: 404c7bd04be47d2c2fb6c71e9d44bc317b5d0a9abe1a3362945ce2841a76f9cc25eb7703cc39134c2065dfcc8c83d5f615f24e035160cd10aab09178e8f8d6fe
+  data.tar.gz: 29150aae2c605d2ce489dd3a41b914ad7bc67dc53867122c7c11b67830d5fe82771a433d0b6250c926d0e7bd34c0fa8af53941c734e32d5d8db3f435153f8c0f

data/README.md

@@ -19,7 +19,7 @@
 
 </div>
 
-Read the documentation [here](https://billyruffian.github.io/chutney/) or try [Chutney Online](https://chutney.billy-ruffian.co.uk).
+Read the documentation [here](https://billyruffian.github.io/chutney/).
 
 See [this page](https://billyruffian.github.io/chutney/usage/rules.html) for a full list of the rules chutney encourages.
 

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.13.0'
+  spec.add_runtime_dependency 'i18n', '>= 1.8.2', '< 1.15.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.32.0'
+  spec.add_development_dependency 'rubocop', '~> 1.50.2'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
   spec.required_ruby_version = '>= 2.6'

data/config/chutney_defaults.yml

@@ -24,16 +24,22 @@ 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:
     Enabled: true
+InconsistentQuoting:
+    Enabled: true
 InvalidFileName:
     Enabled: true
 InvalidStepFlow:

data/docs/usage/rules.md

@@ -33,18 +33,24 @@ Chutney enforces its rules with the linters. These are:
 
 [GivensAfterBackground](https://github.com/BillyRuffian/chutney/blob/master/features/givens_after_background.feature): If you have a Background section and your scenario needs more preconditions then it should start immediately with an `And` step and not another `Given`.
 
+[InconsistentQuoting](https://github.com/BillyRuffian/chutney/blob/master/features/inconsistent_quoting.feature): Use either single quotation marks *or* double quotation marks around parameters but don't use a mix of the two styles.
+
 [InvalidFileName](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_file_name.feature): Make sure your file name is in snake case, not mixed case or with spaces.
 
 [InvalidStepFlow](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_step_flow.feature): Your scenarios should follow Given → When → Then, in that order.
 
 [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/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/inconsistent_quoting.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for avoiding periods
+  class InconsistentQuoting < Linter
+    # regular expression to extract quoted string
+    # matching group 1: opening quote; 2: quoted text; 3: closing quote
+    # opening and closing quote must match (via backrefs)
+    # apostrophes, both singular and plural posessives, are accounted for
+    QUOTED_STRING = /(?!\b\b)(['"])(.*(?:\b'\b[^\1]*)*(?!\b[\1]\b))(\1)/.freeze
+    Parameter = Struct.new('Parameter', :quotation_mark, :name)
+
+    def lint
+      quoted_params = parameters.group_by(&:quotation_mark)
+      single_quoted = quoted_params[%(')] || []
+      double_quoted = quoted_params[%(")] || []
+      return unless single_quoted.count.positive? && double_quoted.count.positive?
+
+      add_issue(
+        I18n.t('linters.inconsistent_quoting',
+               count_single: single_quoted.count, count_double: double_quoted.count,
+               example_single: %('#{single_quoted.first.name}'), example_double: %("#{double_quoted.first.name}")),
+        feature
+      )
+    end
+
+    def parameters
+      parameters = []
+
+      steps do |_feature, _child, step|
+        step_parameters = step
+                          .text
+                          .scan(QUOTED_STRING)
+                          .map { |p| p.take(2) } # close quote will match open quote: drop it
+                          .map { |p| Parameter.new(*p) }
+        parameters.concat(step_parameters)
+      end
+
+      parameters
+    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.3.0'
+  VERSION = '3.6.0'
 end

data/lib/chutney.rb

@@ -16,12 +16,15 @@ require 'chutney/linter/bad_scenario_name'
 require 'chutney/linter/empty_feature_file'
 require 'chutney/linter/file_name_differs_feature_name'
 require 'chutney/linter/givens_after_background'
+require 'chutney/linter/inconsistent_quoting'
 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

@@ -33,6 +33,12 @@ en:
     givens_after_background: >-
       Avoid using the 'Given' keyword in scenarios if you have a background.
       Instead, setup steps begin your scenario and should start with an 'And' or 'But' keyword.
+    inconsistent_quoting: >-
+      Avoid using inconsistent quoting for your parameters.
+      You have %{count_single} single-quoted parameters (e.g. %{example_single})
+      and %{count_double} double-quoted parameters (e.g. %{example_double}).
+      You should adopt a single style to avoid confusion about the meaning and purpose
+      of the parameters.
     invalid_file_name: >-
       Filenames of feature files should be in snake case.
       You should name this file '%{recommended_name}'.
@@ -49,6 +55,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.
@@ -56,6 +64,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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2023-07-18 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.13.0
+        version: 1.15.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.13.0
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -179,14 +179,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -262,12 +262,15 @@ files:
 - 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/inconsistent_quoting.rb
 - 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
@@ -312,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A linter for multi-lingual Gherkin