chutney 3.7.0 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c1a6a4a0afe29926cdb6c12fd189f6d30fe10e2a5d728478144ff3707ddee2
-  data.tar.gz: b6e39a2d58ed3a4f8a67c04e3f55522d068192b7d4d8975f9f03ad8d8385a1da
+  metadata.gz: 06e7bafb2c4fb8f14e168e16a2f83a5aaf958f6a4d3430678f9f0c9da954835e
+  data.tar.gz: 07c8004a2cbd18de1ed90ab634df369c9548b1b7e952f8d111890924ccb77b67
 SHA512:
-  metadata.gz: 04d16c6f3be6ce96f57df7db2c6a2e7c3bc1cd3946f676400df989c0fb6afb07b02519248b2b22c873705d362b05af2cd214f849e234252116e215427ac067be
-  data.tar.gz: c00827961589bd8ca1b47a4c7b0c229ba5fa7505830fc061891c461ceb28c4af9cfb98b660bbef47d30eac725c86b9ebc61f1eb7bf7ed6f7d4d7a024c478df84
+  metadata.gz: 1904c405fb2f33997023ee7628ad5371c9f5b621850c193dd09c7d057b5d5e9f7a8dabdad98ef3ee24b40cb71348d5fa8f51ee2e7ef8154e069319237f2bd430
+  data.tar.gz: 9add005095ab65e1ec8d858379ac231d8457b0ff99f7b55f5518772e8255dccfa0145d02325a9f3b52e5641caf7052cf48c722b591dc14798cba1eed44231ba2

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

@@ -24,7 +24,7 @@ OptionParser.new do |opts|
 
   opts.on('-q',
           '--quiet',
-          'Disable chutney usage warnings. Does not affect the output of the formatters.') do 
+          'Disable chutney usage warnings. Does not affect the output of the formatters.') do
     quiet = true
   end
 
@@ -90,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,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'language_server-protocol'
+require 'logger'
+require 'optparse'
+require 'uri'
+
+require 'chutney'
+require 'chutney/lsp'
+require 'chutney/lsp/result'
+require 'chutney/lsp/server'
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: chutney-lsp'
+
+  opts.on('-v', '--version', 'Display the version.') do
+    puts Chutney::VERSION
+    exit
+  end
+end.parse!
+
+Chutney::LSP::Server.new.start

data/lib/chutney/configuration.rb

@@ -20,8 +20,10 @@ module Chutney
 
     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)

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.7.0'
+  VERSION = '3.8.1'
 end

data/lib/chutney.rb

@@ -48,7 +48,6 @@ require 'chutney/version'
 require 'cuke_modeler'
 require 'forwardable'
 require 'i18n'
-require 'set'
 require 'yaml'
 
 module Chutney

data/usechutney.com/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

data/usechutney.com/Gemfile

@@ -0,0 +1,37 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.3.4"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+  gem "jekyll-data"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+gem "minimal-mistakes-jekyll"
+gem 'base64'
+gem 'csv'