chutney 3.6.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0badc9f82efb1e59bc755597c4ef3f7a4f973e37fec2fc25d4b93192319a75eb
-  data.tar.gz: 9459b41ac94999efc721d07f54e8e14b3c83c4f00786f003937a65dd2054fb9f
+  metadata.gz: 0e46a3bdaaed4652c5e7aa856c15b40995602a17f5b0c0d5ff1258e4a59c6842
+  data.tar.gz: f47caf4ee93c1e74499a6f1291de4e95643f7beab1f8ec9cee555d2bd7298f17
 SHA512:
-  metadata.gz: 404c7bd04be47d2c2fb6c71e9d44bc317b5d0a9abe1a3362945ce2841a76f9cc25eb7703cc39134c2065dfcc8c83d5f615f24e035160cd10aab09178e8f8d6fe
-  data.tar.gz: 29150aae2c605d2ce489dd3a41b914ad7bc67dc53867122c7c11b67830d5fe82771a433d0b6250c926d0e7bd34c0fa8af53941c734e32d5d8db3f435153f8c0f
+  metadata.gz: 7a75ae98a45dc49284d3b4acd395bb887e6726aefe23c585aae3181e4d014ea23682f29427a7d87d00db6f964db26a89c8ce4554838899b6f721d6bbc90c5262
+  data.tar.gz: a97f98ccbb8254dd8940144ae24cea907e70df9c60b8582b0b76365217d620fcd78f23d908a59543d4ad1851f91cc1df07ec44bab8cc07b3452b17456b84d364

data/.circleci/config.yml

@@ -1,11 +1,10 @@
 # Use the latest 2.1 version of CircleCI pipeline processing engine, see https://circleci.com/docs/2.0/configuration-reference/
 version: 2.1
 
-
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.6.3-stretch-node
+      - image: cimg/ruby:3.2
     steps:
       - checkout
       - run: bundle install

data/.rubocop.yml

@@ -27,14 +27,13 @@ Layout/LineLength:
 Metrics/MethodLength:
   Max: 20
 
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: predicate, comparison
 Style/NumericPredicate:
   Exclude:
-    - 'lib/chutney/linter/file_name_differs_feature_name.rb'
+    - "lib/chutney/linter/file_name_differs_feature_name.rb"
 
 Metrics/ModuleLength:
   Exclude:
@@ -63,4 +62,6 @@ Style/StringConcatenation:
 
 AllCops:
   NewCops: enable
-  SuggestExtensions: false
+  SuggestExtensions: false
+  Exclude:
+    - "usechutney.com/**"

data/Gemfile

@@ -3,3 +3,12 @@
 source 'https://rubygems.org'
 
 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'
+gem 'rspec-expectations', '~> 3.0'
+gem 'rubocop', '~> 1.66'

data/README.md

@@ -1,5 +1,5 @@
 <h1 align="center">
-  <img src="https://raw.githubusercontent.com/BillyRuffian/chutney/master/img/chutney.svg?sanitize=true" alt="Chutney" height="200">
+  <img src="https://raw.githubusercontent.com/BillyRuffian/chutney/master/img/happy_chutney.png?sanitize=true" alt="Chutney" height="200">
   <br>
   Chutney
   <br>
@@ -19,10 +19,56 @@
 
 </div>
 
-Read the documentation [here](https://billyruffian.github.io/chutney/).
+Read the documentation [here](https://www.usechutney.com/).
+
+Your documentation is precious and should be treated as such. Chutney is a tool to help you keep your gherkin files in good shape. It will help you to write better gherkin and keep your feature files consistent through an opinionated, but optional, set of rules.
+
+## Installation
+
+### Ruby
+
+Chutney is a ruby gem, so relies on you having ruby installed. It requires ruby 3.2 or later.
+
+For macOS, Linux or other Unix-like systems, I recommend using a version manager like [rvm](https://rvm.io), [asdf](https://asdf-vm.com) or [rbenv](https://github.com/rbenv/rbenv).
+
+For Windows, you can use [RubyInstaller](https://rubyinstaller.org/).
+
+### Chutney
+
+To install chutney system-wide, run:
+
+```bash
+gem install chutney
+```
+
+To install chutney for a specific project, add it to your Gemfile:
+
+```ruby
+gem 'chutney'
+```
+
+## Usage
+
+To run chutney, simply run:
+
+```bash
+chutney
+```
+
+It will search for any `.feature` files beneath the current directory and give you an opinion. It comes with a default set of rules and will give you a little nudge if you haven't got your own chutney configuration file.
+
+To create a configuration file, run:
+
+```bash
+chutney --init
+```
+
+(Configuration files can in either `.chutney.yml` or `.chutney.yml` and reside in the top-level of the project or in a `/config` directory.)
+
 
 See [this page](https://billyruffian.github.io/chutney/usage/rules.html) for a full list of the rules chutney encourages.
 
+
 ## Notes
 
-Chutney 3+ has replaced its direct dependency on Cucumber and instead uses the excellent [cuke_modeller](https://github.com/enkessler/cuke_modeler) to parse your feature files. 
+Chutney 3+ has replaced its direct dependency on Cucumber and instead uses the excellent [cuke_modeller](https://github.com/enkessler/cuke_modeler) to parse your feature files.

data/chutney.gemspec

@@ -43,26 +43,17 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|s|features)/}) }
   end
-  
+
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  
-  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.15.0'
-  spec.add_runtime_dependency 'pastel', '~> 0.7'
-  spec.add_runtime_dependency 'tty-pie', '~> 0.3'
 
+  spec.add_dependency 'amatch', '~> 0.4.0'
+  spec.add_dependency 'cuke_modeler', '~> 3.21'
+  spec.add_dependency 'i18n', '>= 1.8.2', '< 1.15.0'
+  spec.add_dependency 'language_server-protocol', '~> 3.17'
+  spec.add_dependency 'pastel', '~> 0.7'
+  spec.add_dependency 'tty-pie', '~> 0.3'
 
-  spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'cucumber', '>= 7.0'
-  spec.add_development_dependency 'pry-byebug', '~> 3.0'
-  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.50.2'
-  spec.add_development_dependency 'rspec', '~> 3.8'
-  
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 3.2'
 end

data/examples/emoji.feature

@@ -2,7 +2,7 @@
 
 📚: 🤯
 
-  As a 👹
+As a 👹
   I want to 🏃‍♂️ 🥒
   So that 👁 don't 👀 a 🍆
   
@@ -11,4 +11,3 @@
     🎬 I am 😘 by a 👸
     🎬 I am 😘 by a 👸
     🙏 I will ⏎ into a 🤴
-    

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|
@@ -64,7 +90,7 @@ basic_formatter = Chutney::Formatter.new
 basic_formatter.results = report
 
 if basic_formatter.files_with_issues.empty?
-  exit(true)
+  exit
 else
   exit(false)
 end

data/exe/chutney-lsp

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'language_server-protocol'
+require 'logger'
+require 'uri'
+
+require 'chutney'
+require 'chutney/lsp'
+require 'chutney/lsp/result'
+require 'chutney/lsp/server'
+
+Chutney::LSP::Server.new.start

data/lib/chutney/configuration.rb

@@ -5,28 +5,49 @@ 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
       config_files = ['chutney.yml', '.chutney.yml'].map do |fname|
-        Dir.glob(File.join(Dir.pwd, '**', fname))
-      end.flatten
+        ['.', 'config'].map do |dir|
+          Dir["#{dir}#{File::SEPARATOR}#{fname}"]
+        end
+      end.flatten.compact
+
+      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
 
-      config_file = config_files.first
-      merge_config(config_file) if !config_file.nil? && File.exist?(config_file)
+    def quiet!
+      @config['quiet'] = true
     end
 
     private

data/lib/chutney/formatter/pie_formatter.rb

@@ -21,13 +21,13 @@ module Chutney
     def print_report(data)
       return if data.empty?
 
-      print TTY::Pie.new(data: data, radius: 8, legend: { format: '%<label>s %<name>s %<value>i' })
+      print TTY::Pie.new(data:, radius: 8, legend: { format: '%<label>s %<name>s %<value>i' })
       puts
     end
 
     def top_offences
       offence = Hash.new(0)
-      files_with_issues.each do |_file, linter|
+      files_with_issues.each_value do |linter|
         linter.each do |lint|
           offence[lint[:linter]] += lint[:issues].count
         end

data/lib/chutney/linter/inconsistent_quoting.rb

@@ -7,7 +7,7 @@ module Chutney
     # 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
+    QUOTED_STRING = /(?!\b\b)(['"])(.*(?:\b'\b[^\1]*)*(?!\b[\1]\b))(\1)/
     Parameter = Struct.new('Parameter', :quotation_mark, :name)
 
     def lint

data/lib/chutney/linter/invalid_file_name.rb

@@ -15,7 +15,7 @@ module Chutney
     end
 
     def recommend(filename)
-      File.basename(filename, '.*').gsub(/::/, '/')
+      File.basename(filename, '.*').gsub('::', '/')
           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
           .tr('-', '_')

data/lib/chutney/linter/same_tag_different_case.rb

@@ -19,7 +19,7 @@ module Chutney
           collision_with = case_collision(tag)
           if collision_with
             add_issue(I18n.t('linters.same_tag_different_case',
-                             existing_tag: collision_with, tag: tag),
+                             existing_tag: collision_with, tag:),
                       feature, scenario)
           else
             @@all_known_tags << tag

data/lib/chutney/linter/same_tag_for_all_scenarios.rb

@@ -20,7 +20,7 @@ module Chutney
 
         add_issue(
           I18n.t('linters.same_tag_for_all_scenarios.feature_level',
-                 tag: tag),
+                 tag:),
           feature
         )
       end
@@ -37,7 +37,7 @@ module Chutney
           next if tag == 'skip'
 
           add_issue(I18n.t('linters.same_tag_for_all_scenarios.example_level',
-                           tag: tag), feature, scenario)
+                           tag:), feature, scenario)
         end
       end
     end

data/lib/chutney/linter/unique_scenario_names.rb

@@ -18,7 +18,7 @@ module Chutney
     def issue(name, first_location, scenario)
       add_issue(
         I18n.t('linters.unique_scenario_names',
-               name: name,
+               name:,
                line: first_location[:line],
                column: first_location[:column]),
         feature, scenario

data/lib/chutney/linter/unused_variable.rb

@@ -11,7 +11,7 @@ module Chutney
           example.rows.first.cells.map(&:value).each do |variable|
             next if used?(variable, scenario)
 
-            add_issue(I18n.t('linters.unused_variable', variable: variable), feature, scenario, example)
+            add_issue(I18n.t('linters.unused_variable', variable:), feature, scenario, example)
           end
         end
       end

data/lib/chutney/linter/use_outline.rb

@@ -23,7 +23,7 @@ module Chutney
 
     def add_issue(lhs, rhs, pct)
       super(I18n.t('linters.use_outline',
-                   pct: pct,
+                   pct:,
                    lhs_name: lhs[:name],
                    lhs_line: lhs[:reference][:line],
                    rhs_name: rhs[:name],

data/lib/chutney/linter.rb

@@ -82,7 +82,7 @@ module Chutney
 
     def add_issue(message, feature = nil, scenario = nil, item = nil)
       issues << Lint.new(
-        message: message,
+        message:,
         gherkin_type: type(feature, scenario, item),
         location: location(feature, scenario, item),
         feature: feature&.name,

data/lib/chutney/lsp/result.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Chutney
+  module LSP
+    # A wrapper that holds a response to the query message
+    # from the LSP client
+    class Result
+      attr_reader :id, :response
+
+      def initialize(response:, id: nil)
+        @id = id
+        @response = response
+      end
+    end
+  end
+end

data/lib/chutney/lsp/server.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module Chutney
+  module LSP
+    # A minimalistic language server which will lint gherkin
+    # files on open and save
+    class Server
+      LSP_CONST = LanguageServer::Protocol::Constant
+      LSP_IO = LanguageServer::Protocol::Transport::Stdio
+      LSP_IF = LanguageServer::Protocol::Interface
+
+      def initialize
+        @writer = LSP_IO::Writer.new
+        @reader = LSP_IO::Reader.new
+        @mutex = Mutex.new
+        @incoming_queue = Thread::Queue.new
+        @outgoing_queue = Thread::Queue.new
+
+        @dispatcher = Thread.new do
+          while (message = @outgoing_queue.pop)
+            if message.is_a? Result
+              @mutex.synchronize { @writer.write(id: message.id, result: message.response) }
+            else
+              @mutex.synchronize { @writer.write(message.to_hash) }
+            end
+          end
+        end
+
+        @worker = Thread.new do
+          while (message = @incoming_queue.pop)
+            process_message(message)
+          end
+        end
+
+        Thread.main.priority = 1
+      end
+
+      def process_message(message)
+        case message[:method]
+        when 'initialize'
+          run_initialize(message)
+        when 'initialized'
+          run_initialized
+        when 'textDocument/didOpen', 'textDocument/didSave'
+          run_did_change(message)
+        when 'textDocument/didClose'
+          # no-op
+        end
+      end
+
+      def send_message(message)
+        return if outgoing_queue.closed?
+
+        outgoing_queue << message
+      end
+
+      def send_log(message, method: 'window/logMessage', error: false)
+        type = error ? LSP_CONST::MessageType::ERROR : LSP_CONST::MessageType::INFO
+        notification = LSP_IF::NotificationMessage.new(
+          method:,
+          jsonrpc: '2.0',
+          params: LSP_IF::ShowMessageParams.new(
+            type:,
+            message: "Chutney LSP [#{VERSION}]: #{message}"
+          )
+        )
+        send_message(notification)
+      end
+
+      def send_notification(message, error: false)
+        send_log(message, method: 'window/showMessage', error:)
+      end
+
+      def run_initialize(message)
+        initialize_result = LSP_IF::InitializeResult.new(
+          capabilities: LSP_IF::ServerCapabilities.new(
+            document_formatting_provider: true,
+            text_document_sync: LSP_IF::TextDocumentSyncOptions.new(
+              change: LSP_CONST::TextDocumentSyncKind::FULL,
+              open_close: true,
+              save: true
+            )
+          ),
+          server_info: {
+            name: 'chutney-lsp',
+            version: VERSION
+          }
+        )
+        send_message(Result.new(id: message[:id], response: initialize_result))
+        send_log('Initializing')
+      end
+
+      def run_initialized
+        RubyVM::YJIT.enable if defined?(RubyVM::YJIT.enable)
+        send_notification('Chutney LSP Server up and running')
+        send_log('Initialized')
+      end
+
+      def run_did_change(message)
+        document = message.dig(:params, :textDocument)
+        filename = document[:uri].delete_prefix('file://')
+        send_log("Evaluating #{filename}")
+        linter = Chutney::ChutneyLint.new(*filename)
+        linter.configuration.quiet!
+        begin
+          offenses = linter.analyse.values.first.filter { |r| r[:issues].any? }
+        rescue StandardError => e
+          send_log("Could not parse #{filename} as Gherkin. Received: #{e.full_message}", error: true)
+          send_notification("Could not parse #{filename} as Gherkin.", error: true)
+          return
+        end
+        send_log("Found #{offenses.count} offenses")
+        diagnostics = offenses
+                      .flat_map { |group| group[:issues].each { |issue| issue[:linter] = group[:linter] } }
+                      .map { |offense| to_diagnostic(offense) }
+        send_message(diagnostic_message(document[:uri], diagnostics))
+      end
+
+      def diagnostic_message(file_uri, diagnostics)
+        {
+          method: 'textDocument/publishDiagnostics',
+          params: {
+            uri: file_uri,
+            diagnostics:
+          }
+        }
+      end
+
+      def to_diagnostic(offense)
+        code = offense[:linter]
+        message = offense[:message]
+        source = 'chutney'
+        { code:, message:, source:, severity: 1, range: to_range(offense[:location]) }
+      end
+
+      def to_range(location)
+        {
+          start: { character: location.fetch(:column, 1) - 1, line: location.fetch(:line, 1) - 1 },
+          end: { character: 0, line: location.fetch(:line, 1) }
+        }
+      end
+
+      def shutdown
+        incoming_queue.clear
+        outgoing_queue.clear
+        incoming_queue.close
+        outgoing_queue.close
+        worker.join
+        dispatcher.join
+        send_log('Shutdown complete')
+      end
+
+      def start
+        reader.read do |message|
+          method = message[:method]
+          send_log("Received #{method}")
+
+          case method
+          when 'initialize', 'initialized', 'textDocument/didOpen', 'textDocument/didClose', 'textDocument/didSave'
+            incoming_queue.push(message)
+          when 'shutdown'
+            shutdown
+          when 'exit'
+            mutex.synchronize do
+              status = incoming_queue.closed? ? 0 : 1
+              exit(status)
+            end
+          end
+        end
+      end
+
+      private
+
+      attr_reader :reader, :writer, :mutex, :incoming_queue, :outgoing_queue, :worker, :dispatcher
+    end
+  end
+end

data/lib/chutney/lsp.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Chutney
+  # The Chutney Language Server module wrapper
+  module LSP
+  end
+end

data/lib/chutney/version.rb

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

data/lib/chutney.rb

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