chutney 3.9.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fb7860cfd94d79eb4aae1f69269c7aa0178d81cb155844dac4b67905e5caf55
-  data.tar.gz: 710d27816dfa2226e9b5384e88c7cd568a6096bea8e9078bd1898ee4eab5f218
+  metadata.gz: c008b1c26d32fdc61e5971638623f09d6f34526e0482b31c9e6c98ca7770a5e6
+  data.tar.gz: 4868772b4ffea1157e0c443772d779dc5b693aa7ec693d3e37718d392ab6676b
 SHA512:
-  metadata.gz: a7d58d734669f76a342c4a570c1cca7ae179d1439f0426b256f673f48772a3709bec4e327ca6ee5e198493d4e5951ab4158e68d4bb333f70ce6def94f7aa0acf
-  data.tar.gz: e71d49b4ef0d6a6acbb21e601d8cd6ec55b100bcc63ac87199b8aace0b43e28d53279f68c9a38f6f620f30511d22dc86b48f1e70decec3e898f32038bea742de
+  metadata.gz: 03c10adcf4fe4c184ef0a867f7b735c1f39e9845ce691c6d6bb2679a3f81917d65e417dd32e80776a5db036afa11de056f35464fdf54db3caf55c82015803cce
+  data.tar.gz: 90fb24d6851765a01e014f1c838c51eed6d0190ce85265ab0344f481fded24ff9b632bdbc847263ddf2b20e80a81f61140cc452409785c52dcc000a105b4c8c4

data/config/chutney_defaults.yml

@@ -1,80 +1,84 @@
+AvoidColonsAtStartOfNames:
+  Enabled: true
+AvoidCommaInTags:
+  Enabled: true
 AvoidOutlineForSingleExample:
-    Enabled: true
+  Enabled: true
 AvoidFullStop:
-    Enabled: true
+  Enabled: true
 AvoidScripting:
-    Enabled: true
+  Enabled: true
 AvoidSplatStepsInBackground:
-    Enabled: true
+  Enabled: true
 AvoidSplatStepsInScenarios:
-    Enabled: true
+  Enabled: true
 AvoidTypographersQuotes:
-    Enabled: true
+  Enabled: true
 BackgroundDoesMoreThanSetup:
-    Enabled: true
+  Enabled: true
 BackgroundRequiresMultipleScenarios:
-    Enabled: true
+  Enabled: true
 BadScenarioName:
-    Enabled: true
+  Enabled: true
 EmptyFeatureFile:
-    Enabled: true
+  Enabled: true
 FileNameDiffersFeatureName:
-    Enabled: true
+  Enabled: true
 GivensAfterBackground:
-    Enabled: true
+  Enabled: true
 MissingExampleName:
-    Enabled: true
+  Enabled: true
 MissingExampleTable:
-    Enabled: true
+  Enabled: true
 MissingFeatureDescription:
-    Enabled: true
+  Enabled: true
 MissingFeatureName:
-    Enabled: true
+  Enabled: true
 MissingScenarioName:
-    Enabled: true
+  Enabled: true
 MissingScenarioOutline:
-    Enabled: true
+  Enabled: true
 MissingTestAction:
-    Enabled: true
+  Enabled: true
 MissingVerification:
-    Enabled: true
+  Enabled: true
 InconsistentQuoting:
-    Enabled: true
+  Enabled: true
 InvalidFileName:
-    Enabled: true
+  Enabled: true
 InvalidStepFlow:
-    Enabled: true
+  Enabled: true
 RequiredTagsStartsWith:
-    Enabled: false
+  Enabled: false
 SameTagDifferentCase:
-    Enabled: true
+  Enabled: true
 SameTagForAllScenarios:
-    Enabled: true
+  Enabled: true
 ScenarioNamesMatch:
-    Enabled: false
+  Enabled: false
 TagUsedMultipleTimes:
-    Enabled: true
+  Enabled: true
 TooClumsy:
-    Enabled: true
+  Enabled: true
 TooManyDifferentTags:
-    Enabled: true
-    MaxCount: 3
+  Enabled: true
+  MaxCount: 3
 TooManySteps:
-    Enabled: true
-    MaxCount: 10
+  Enabled: true
+  MaxCount: 10
 TooManyTags:
-    Enabled: true
-    MaxCount: 3
+  Enabled: true
+  MaxCount: 3
 TooLongStep:
-    Enabled: true
-    MaxLength: 80
+  Enabled: true
+  MaxLength: 80
 UniqueScenarioNames:
-    Enabled: true
+  Enabled: true
 UnknownVariable:
-    Enabled: true
+  Enabled: true
 UnusedVariable:
-    Enabled: true
+  Enabled: true
 UseBackground:
-    Enabled: true
+  Enabled: true
 UseOutline:
-    Enabled: true
+  Enabled: true

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for avoiding colons at the start of names
+  class AvoidColonsAtStartOfNames < Linter
+    def lint
+      add_issue(I18n.t('linters.avoid_colons_at_start_of_names'), feature) if feature.name.start_with? ':'
+
+      scenarios do |_feature, scenario|
+        if scenario.name.start_with? ':'
+          add_issue(I18n.t('linters.avoid_colons_at_start_of_names'), feature,
+                    scenario)
+        end
+      end
+    end
+  end
+end

data/lib/chutney/linter/same_scenario.rb

@@ -0,0 +1,52 @@
+module Chutney
+
+  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 { |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
+
+    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.9.0'
+  VERSION = '3.11.0'
 end

data/lib/chutney.rb

@@ -4,6 +4,7 @@ require 'amatch'
 
 require 'chutney/configuration'
 require 'chutney/linter'
+require 'chutney/linter/avoid_colons_at_start_of_names'
 require 'chutney/linter/avoid_comma_in_tags'
 require 'chutney/linter/avoid_full_stop'
 require 'chutney/linter/avoid_outline_for_single_example'
@@ -29,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'

data/lib/config/locales/en.yml

@@ -3,6 +3,8 @@
 # God save the Queen, etc. etc.
 en:
   linters:
+    avoid_colons_at_start_of_names: >-
+      Avoid using colons at the start of names, it can make them hard to read or find.
     avoid_comma_in_tags: >-
       Avoid using commas in tags. Tags should be separated by spaces.
     avoid_full_stop: >- # https://en.wikipedia.org/wiki/Full_stop
@@ -76,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

@@ -29,6 +29,10 @@ sidebar:
 
   - title: "Rules"
     children:
+      - title: "Avoid colons at start of names"
+        url: /docs/rules/avoid-colons-at-start-of-names/
+      - title: "Avoid comma in tags"
+        url: /docs/rules/avoid-comma-in-tags/
       - title: "Avoid full stops"
         url: /docs/rules/avoid-full-stops/
       - title: "Avoid outline for single example"
@@ -77,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/avoid-colons-at-start-of-names/index.md

@@ -0,0 +1,28 @@
+---
+title: "Avoid Colons at Start of Names"
+layout: single
+permalink: /docs/rules/avoid-colons-at-start-of-names/
+---
+
+Don't have colons at the start of feature or scenario names. It's probably a mistake if you have them from double typing the colon after the `Feature` or `Scenario` keyword.
+
+
+## Bad
+
+```gherkin
+Feature: :My Feature
+  Scenario: :My Scenario
+    Given I have visited the website
+    When I log in
+    Then I will see my account
+```
+
+## Good
+
+```gherkin
+Feature: My Feature
+  Scenario: My Scenario
+    Given I have visited the website
+    When I log in
+    Then I will see my account
+```

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.9.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 - Stefan Rohe
 - Nishtha Argawal
 - John Gluck
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -155,6 +154,7 @@ files:
 - lib/chutney/formatter/rainbow_formatter.rb
 - lib/chutney/issue.rb
 - lib/chutney/linter.rb
+- lib/chutney/linter/avoid_colons_at_start_of_names.rb
 - lib/chutney/linter/avoid_comma_in_tags.rb
 - lib/chutney/linter/avoid_full_stop.rb
 - lib/chutney/linter/avoid_outline_for_single_example.rb
@@ -180,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
@@ -214,6 +215,7 @@ files:
 - usechutney.com/docs/disabling-rules/index.md
 - usechutney.com/docs/installing/index.md
 - usechutney.com/docs/language-server/index.md
+- usechutney.com/docs/rules/avoid-colons-at-start-of-names/index.md
 - usechutney.com/docs/rules/avoid-comma-in-tags/index.md
 - usechutney.com/docs/rules/avoid-full-stops/index.md
 - usechutney.com/docs/rules/avoid-outline-for-single-example/index.md
@@ -239,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
@@ -264,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
@@ -279,8 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A linter for multi-lingual Gherkin
 test_files: []