chutney 3.10.0 → 3.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6734d8a322d5394f40d363d0ad93def2424ea97be81f4a13cd7bb92c91ade597
-  data.tar.gz: 0146772a58c64cfa3aa8f7ab05861c94945d37abec3ff10c93bd3f653c9784b4
+  metadata.gz: 74225c8b4badcb729231121bce2547b43c1a7d21b239bf17f0de152a4a425686
+  data.tar.gz: acfe603816c3c0bafd77e4fc149d895d665745b5260b341f24744baa7ab162c1
 SHA512:
-  metadata.gz: 9f869fc17e30cee78412fab391049971c81316937148e73dcd6111afb6d55a5c60e9ac5db24d36917b9be63556dd8ee63ea4b1d082f8fd4a8b3edb3bae037ba4
-  data.tar.gz: 87f372ffc4bcef3f514aef73ae971d8a5dd8545d6bd7897770e7c69808c11fd7f0740afd0befe271ef49274720e91da5a92a4913cd108737bf2e1fbe99f1dd5e
+  metadata.gz: d4a3ed6425a8157e7dbcba96808fd8e340760da1140b3966e25b44fc4d2d5849f774e6cd0f3bd9c8c93bf4c6e7aedd4c648476d2a393e819a39cfc5c69d00c96
+  data.tar.gz: 5f51a71f864e39ee219b841167fa5a8bffdf9837db27bb705089573e7402a9dd3931c6340c51861c2363bc8bbce73718404221280a348dbceebae027a9c6beb8

data/Gemfile

@@ -6,7 +6,6 @@ gemspec
 
 gem 'coveralls', '~> 0.8'
 gem 'cucumber', '>= 9.0'
-gem 'pry-byebug', '~> 3.0'
 gem 'rake', '~> 13.0'
 gem 'rerun', '~> 0.13'
 gem 'rspec', '~> 3.13'

data/config/chutney_defaults.yml

@@ -50,6 +50,8 @@ InvalidStepFlow:
   Enabled: true
 RequiredTagsStartsWith:
   Enabled: false
+SameScenario:
+  Enabled: true
 SameTagDifferentCase:
   Enabled: true
 SameTagForAllScenarios:

data/docs/usage/rules.md

@@ -57,6 +57,8 @@ Chutney enforces its rules with the linters. These are:
 
 [RequiredTagsStartWith](https://github.com/BillyRuffian/chutney/blob/master/features/required_tags_starts_with.feature): Chutney can enforce a configurable naming prefix for your tags.
 
+[SameSecenario](https://github.com/BillyRuffian/chutney/blob/master/features/same_scenario.feature): Makes sure you don't acidentally duplicate the actions of your scenario. *Since v3.11.0*
+
 [SameTagForDifferentCase](https://github.com/BillyRuffian/chutney/blob/master/features/same_tag_different_case.feature): Don't mix the case of tags which have already appeared. Cucumber tags are case sensitive. *Since 3.1.0*
 
 [SameTagForAllScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/same_tag_for_all_scenarios.feature): You have the same tag for all you scenarios; move the tag to the feature level instead.

data/lib/chutney/linter/same_scenario.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Chutney
+  # Rule to find all the duplicated scenarios
+  class SameScenario < Linter
+    def lint
+      dictionary = Hash.new { |hash, key| hash[key] = [] }
+
+      scenarios do |feature, scenario|
+        text = scenario
+               .steps
+               .map { |step| "#{step.text} #{child_text(step)}" }
+               .join("\n") + example_text(scenario)
+
+        digest = Digest::SHA2.hexdigest(text)
+        dictionary[digest] << { scenario:, feature: }
+      end
+
+      dictionary.filter { |_k, v| v.size > 1 }
+                .each_value do |v|
+        v[1...].each do |problem|
+          add_issue(I18n.t('linters.same_scenario',
+                           feature: problem[:feature].name,
+                           scenario: problem[:scenario].name,
+                           original_feature: v.first[:feature].name,
+                           original_scenario: v.first[:scenario].name),
+                    problem[:feature], problem[:scenario], nil)
+        end
+      end
+    end
+
+    def child_text(step)
+      step.children.map do |child|
+        if child.is_a?(CukeModeler::Table)
+          child.rows.flat_map(&:cells).map(&:value).join(' | ')
+        elsif child.is_a?(CukeModeler::DocString)
+          child.content
+        else
+          ''
+        end
+      end
+    end
+
+    def example_text(scenario)
+      if scenario.is_a?(CukeModeler::Outline)
+        "\n" + scenario.examples
+                       .flat_map(&:rows)
+                       .flat_map(&:cells)
+                       .map(&:value).join(' | ')
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/chutney/version.rb

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

data/lib/chutney.rb

@@ -30,6 +30,7 @@ require 'chutney/linter/missing_scenario_outline'
 require 'chutney/linter/missing_test_action'
 require 'chutney/linter/missing_verification'
 require 'chutney/linter/required_tags_starts_with'
+require 'chutney/linter/same_scenario'
 require 'chutney/linter/same_tag_different_case'
 require 'chutney/linter/same_tag_for_all_scenarios'
 require 'chutney/linter/scenario_names_match'
@@ -48,6 +49,7 @@ require 'chutney/locator'
 require 'chutney/version'
 
 require 'cuke_modeler'
+require 'digest'
 require 'forwardable'
 require 'i18n'
 require 'yaml'

data/lib/config/locales/en.yml

@@ -78,6 +78,8 @@ en:
       the assertion being tested.
     required_tags_starts_with: >-
       You have tags which do not match the required format. Allowed prefixes are '%{allowed}'.
+    same_scenario: >-
+      Duplicate scenario detected: %{feature} / %{scenario} is a duplicate of %{original_feature} / %{original_scenario}
     scenario_names_match: >-
       You have a scenario name which does not match the required format.
       Allowed patterns are '%{pattern}'.

data/usechutney.com/_data/navigation.yml

@@ -81,6 +81,8 @@ sidebar:
         url: /docs/rules/missing-test-verification/
       - title: "Required tags start with"
         url: /docs/rules/required-tags-start-with/
+      - title: "Same Scenario"
+        url:  /docs/rules/same-scenario/
       - title: "Same tag different case"
         url: /docs/rules/same-tag-different-case/
       - title: "Same tag for all scenarios"

data/usechutney.com/docs/rules/same-scenario/index.md

@@ -0,0 +1,24 @@
+---
+title: "Same Scenario"
+layout: single
+permalink: /docs/rules/same-scenario/
+---
+
+You have a `Scenario`, or a `Scenario Outline` which appears to be duplicated. This probably means you have a redundant test. You should probably make sure you only have one copy of your steps to be consitent and efficient.
+
+
+This rule ignores the names of your scenarios but takes into account data tables, examples and doc strings.
+
+## Examples
+
+```gherkin
+Feature: Test
+  Scenario: Scenario A
+      When I do a thing
+      Then A thing happens
+
+  Scenario: Scenario B
+      When I do a thing
+      Then A thing happens
+```
+

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 - Stefan Rohe
 - Nishtha Argawal
 - John Gluck
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -181,6 +180,7 @@ files:
 - lib/chutney/linter/missing_test_action.rb
 - lib/chutney/linter/missing_verification.rb
 - lib/chutney/linter/required_tags_starts_with.rb
+- lib/chutney/linter/same_scenario.rb
 - lib/chutney/linter/same_tag_different_case.rb
 - lib/chutney/linter/same_tag_for_all_scenarios.rb
 - lib/chutney/linter/scenario_names_match.rb
@@ -241,6 +241,7 @@ files:
 - usechutney.com/docs/rules/missing-test-action/index.md
 - usechutney.com/docs/rules/missing-test-verification/index.md
 - usechutney.com/docs/rules/required-tag-starts-with/index.md
+- usechutney.com/docs/rules/same-scenario/index.md
 - usechutney.com/docs/rules/same-tag-different-case/index.md
 - usechutney.com/docs/rules/same-tag-for-all-scenarios/index.md
 - usechutney.com/docs/rules/scenario-names-match/index.md
@@ -266,7 +267,6 @@ metadata:
   homepage_uri: https://www.usechutney.com/
   source_code_uri: https://github.com/BillyRuffian/chutney
   changelog_uri: https://github.com/BillyRuffian/chutney/releases
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -281,8 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A linter for multi-lingual Gherkin
 test_files: []