chutney 3.5.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a8913c71a8e2291fa14ef87b527e11481dfe45519370455fbddf2df8856836
-  data.tar.gz: cd4fded7ea629dd5ae5e5b74ac204c8b5d3dfee96e21f65db3c3355449dbb0c1
+  metadata.gz: 07c1a6a4a0afe29926cdb6c12fd189f6d30fe10e2a5d728478144ff3707ddee2
+  data.tar.gz: b6e39a2d58ed3a4f8a67c04e3f55522d068192b7d4d8975f9f03ad8d8385a1da
 SHA512:
-  metadata.gz: 2387b637bdb751865c8f6fbc97f61e90e25f7d6dc52f6da7dae598f5d156c06226f985df609b3a58597213f7e9b6e5a87be2fd5c67c78b57ae60c16603cde040
-  data.tar.gz: b7d67216485f10777e91250582facc4143e0f463360463f87aa8bf219e16b91e8e000a4e8ae94f442130f5246d0adf61e4df0b50b22bea1a05743145ea77e346
+  metadata.gz: 04d16c6f3be6ce96f57df7db2c6a2e7c3bc1cd3946f676400df989c0fb6afb07b02519248b2b22c873705d362b05af2cd214f849e234252116e215427ac067be
+  data.tar.gz: c00827961589bd8ca1b47a4c7b0c229ba5fa7505830fc061891c461ceb28c4af9cfb98b660bbef47d30eac725c86b9ebc61f1eb7bf7ed6f7d4d7a024c478df84

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.45.1'
+  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

@@ -38,6 +38,8 @@ MissingTestAction:
     Enabled: true
 MissingVerification:
     Enabled: true
+InconsistentQuoting:
+    Enabled: true
 InvalidFileName:
     Enabled: true
 InvalidStepFlow:

data/docs/usage/rules.md

@@ -33,6 +33,8 @@ 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.

data/exe/chutney

@@ -9,6 +9,7 @@ require 'chutney/formatter/rainbow_formatter'
 require 'optparse'
 
 formatters = Set.new
+quiet = false
 
 # rubocop:disable Metrics/BlockLength
 OptionParser.new do |opts|
@@ -21,6 +22,12 @@ OptionParser.new do |opts|
     formatters << formatter
   end
 
+  opts.on('-q',
+          '--quiet',
+          'Disable chutney usage warnings. Does not affect the output of the formatters.') do 
+    quiet = true
+  end
+
   opts.on('-v', '--version', 'Display the version.') do
     puts Chutney::VERSION
     exit
@@ -28,7 +35,7 @@ OptionParser.new do |opts|
 
   opts.on('-l',
           '--linters',
-          'List the linter status by this configuration and exit') do
+          'List the linter status by this configuration and exit.') do
     pastel = Pastel.new
     chutney_config = Chutney::ChutneyLint.new.configuration
     max_name_length = chutney_config.keys.map(&:length).max + 1
@@ -43,6 +50,24 @@ OptionParser.new do |opts|
     end
     exit
   end
+
+  opts.on('--init',
+          'Install a `chutney.yml` configuration file.') do
+    config_dest = if File.exist?('config') && File.directory?('config')
+                    'config'
+                  else
+                    '.'
+                  end
+    config_path = File.join(config_dest, 'chutney.yml')
+    default_path = Chutney::ChutneyLint.new.configuration.default_configuration_path
+    if File.exist?(config_path)
+      puts "#{config_path} already exists - remove it first if you want to overwrite."
+    else
+      FileUtils.cp(default_path, config_path)
+      puts "#{config_path} created."
+    end
+    exit
+  end
 end.parse!
 # rubocop:enable Metrics/BlockLength
 
@@ -52,6 +77,7 @@ files = ARGV.map { |pattern| Dir.glob(pattern) }.flatten
 files = Dir.glob('features/**/*.feature') if ARGV.empty?
 
 linter = Chutney::ChutneyLint.new(*files)
+linter.configuration.quiet! if quiet
 report = linter.analyse
 
 formatters.each do |formatter|

data/lib/chutney/configuration.rb

@@ -5,19 +5,17 @@ require 'delegate'
 module Chutney
   # gherkin_lint configuration object
   class Configuration < SimpleDelegator
+    attr_accessor :default_configuration_path, :user_configuration_path
+
     def initialize(path)
-      @path = path
+      @default_configuration_path = path
       @config = load_configuration || {}
       load_user_configuration
       super(@config)
     end
 
-    def configuration_path
-      @path
-    end
-
     def load_configuration
-      YAML.load_file configuration_path || '' if configuration_path
+      YAML.load_file default_configuration_path || '' if default_configuration_path
     end
 
     def load_user_configuration
@@ -25,8 +23,29 @@ module Chutney
         Dir.glob(File.join(Dir.pwd, '**', fname))
       end.flatten
 
-      config_file = config_files.first
-      merge_config(config_file) if !config_file.nil? && File.exist?(config_file)
+      self.user_configuration_path = config_files.first
+      return unless !user_configuration_path.nil? && File.exist?(user_configuration_path)
+
+      begin
+        merge_config(user_configuration_path)
+      rescue TypeError
+        unless quiet?
+          warn("Chutney: configuration file `#{user_configuration_path}` is not correctly formatted YAML, " \
+               'falling back to gem defaults.')
+        end
+      end
+    end
+
+    def using_user_configuration?
+      !user_configuration_path.nil?
+    end
+
+    def quiet?
+      @config.fetch('quiet', false)
+    end
+
+    def quiet!
+      @config['quiet'] = true
     end
 
     private

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

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

data/lib/chutney.rb

@@ -16,6 +16,7 @@ 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'
@@ -46,8 +47,6 @@ require 'chutney/version'
 
 require 'cuke_modeler'
 require 'forwardable'
-# require 'gherkin/dialect'
-# require 'gherkin/parser'
 require 'i18n'
 require 'set'
 require 'yaml'
@@ -90,6 +89,14 @@ module Chutney
     end
 
     def analyse
+      if configuration.respond_to?(:using_user_configuration?) &&
+         !configuration.quiet? &&
+         !configuration.using_user_configuration?
+        warn('Chutney: no local configuration found, using gem defaults. Run `chutney -l` to list enabled ' \
+             'enabled linters, `chutney --init` to install a local configuration file or `chutney --quiet` ' \
+             'to disable this message.')
+      end
+
       files.each do |f|
         lint(f)
       end

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}'.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-12-07 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.45.1
+        version: 1.50.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.45.1
+        version: 1.50.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +262,7 @@ 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
@@ -314,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A linter for multi-lingual Gherkin