chutney 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0badc9f82efb1e59bc755597c4ef3f7a4f973e37fec2fc25d4b93192319a75eb
-  data.tar.gz: 9459b41ac94999efc721d07f54e8e14b3c83c4f00786f003937a65dd2054fb9f
+  metadata.gz: 07c1a6a4a0afe29926cdb6c12fd189f6d30fe10e2a5d728478144ff3707ddee2
+  data.tar.gz: b6e39a2d58ed3a4f8a67c04e3f55522d068192b7d4d8975f9f03ad8d8385a1da
 SHA512:
-  metadata.gz: 404c7bd04be47d2c2fb6c71e9d44bc317b5d0a9abe1a3362945ce2841a76f9cc25eb7703cc39134c2065dfcc8c83d5f615f24e035160cd10aab09178e8f8d6fe
-  data.tar.gz: 29150aae2c605d2ce489dd3a41b914ad7bc67dc53867122c7c11b67830d5fe82771a433d0b6250c926d0e7bd34c0fa8af53941c734e32d5d8db3f435153f8c0f
+  metadata.gz: 04d16c6f3be6ce96f57df7db2c6a2e7c3bc1cd3946f676400df989c0fb6afb07b02519248b2b22c873705d362b05af2cd214f849e234252116e215427ac067be
+  data.tar.gz: c00827961589bd8ca1b47a4c7b0c229ba5fa7505830fc061891c461ceb28c4af9cfb98b660bbef47d30eac725c86b9ebc61f1eb7bf7ed6f7d4d7a024c478df84

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

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

data/lib/chutney.rb

@@ -47,8 +47,6 @@ require 'chutney/version'
 
 require 'cuke_modeler'
 require 'forwardable'
-# require 'gherkin/dialect'
-# require 'gherkin/parser'
 require 'i18n'
 require 'set'
 require 'yaml'
@@ -91,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch