cucumber-compatibility-kit 13.0.1 → 14.0.0

data/lib/cck/messages_comparator.rb

@@ -7,16 +7,12 @@ module CCK
   class MessagesComparator
     include Helpers
 
-    def initialize(validator, detected, expected)
-      @all_errors = []
-      @compared = []
-      @validator = validator
-
+    def initialize(detected, expected)
       compare(detected, expected)
     end
 
     def errors
-      @all_errors.flatten
+      all_errors.flatten
     end
 
     private
@@ -25,10 +21,10 @@ module CCK
       detected_by_type = messages_by_type(detected)
       expected_by_type = messages_by_type(expected)
 
-      detected_by_type.keys.each do |type|
+      detected_by_type.each_key do |type|
         compare_list(detected_by_type[type], expected_by_type[type])
       rescue StandardError => e
-        @all_errors << "Error while comparing #{type}: #{e.message}"
+        all_errors << "Error while comparing #{type}: #{e.message}"
       end
     end
 
@@ -55,8 +51,7 @@ module CCK
       return if ignorable?(detected)
       return if incomparable?(detected)
 
-      @all_errors << @validator.compare(detected, expected)
-      @compared << detected.class.name
+      all_errors << CCK::KeysChecker.compare(detected, expected)
       compare_sub_messages(detected, expected)
     end
 
@@ -84,7 +79,8 @@ module CCK
 
     def compare_sub_messages(detected, expected)
       return unless expected.respond_to? :to_h
-      expected.to_h.keys.each do |key|
+
+      expected.to_h.each_key do |key|
         value = expected.send(key)
         if value.is_a?(Array)
           compare_list(detected.send(key), value)
@@ -93,5 +89,9 @@ module CCK
         end
       end
     end
+
+    def all_errors
+      @all_errors ||= []
+    end
   end
 end

data/lib/cucumber/cucumber-compatibility-kit.rb

@@ -2,56 +2,54 @@
 
 require 'shared_examples'
 
-module Cucumber::CompatibilityKit
-  class << self
-    def all_examples
-      gherkin_examples + markdown_examples
-    end
+module Cucumber
+  module CompatibilityKit
+    class << self
+      def all_examples
+        gherkin_examples + markdown_examples
+      end
 
-    def gherkin_examples
-      Dir
-        .entries(examples_path)
-        .select do |file|
-          folder = File.join(examples_path, file)
+      def gherkin_examples
+        Dir.entries(examples_path).select do |file_or_folder|
+          next if file_or_folder.start_with?('.')
 
-          file != '.' && file != '..' &&
-            File.directory?(folder) &&
-            gherkin_example?(folder)
+          gherkin_example?(File.join(examples_path, file_or_folder))
         end
-    end
+      end
 
-    def markdown_examples
-      Dir
-      .entries(examples_path)
-      .select do |file|
-        folder = File.join(examples_path, file)
+      def markdown_examples
+        Dir.entries(examples_path).select do |file_or_folder|
+          next if file_or_folder.start_with?('.')
 
-        file != '.' && file != '..' &&
-          File.directory?(folder) &&
-          markdown_example?(folder)
+          markdown_example?(File.join(examples_path, file_or_folder))
+        end
       end
-    end
 
-    def examples_path
-      File.expand_path("#{File.dirname(__FILE__)}/../../features/")
-    end
+      def examples_path
+        File.expand_path("#{File.dirname(__FILE__)}/../../features/")
+      end
 
-    def example_path(example_name)
-      path = File.join(examples_path, example_name)
+      def example_path(example_name)
+        path = File.join(examples_path, example_name)
 
-      return path if File.directory?(path)
+        return path if File.directory?(path)
 
-      raise ArgumentError.new
-    end
+        raise ArgumentError, "No CCK example exists for #{example_name}"
+      end
 
-    private
+      private
 
-    def gherkin_example?(example_folder)
-      Dir.entries(example_folder).select { |file| File.extname(file) == '.feature' }.count > 0
-    end
+      def gherkin_example?(example_folder)
+        file_type_in_folder?('.feature', example_folder)
+      end
 
-    def markdown_example?(example_folder)
-      Dir.entries(example_folder).select { |file| File.extname(file) == '.md' }.count > 0
+      def markdown_example?(example_folder)
+        file_type_in_folder?('.md', example_folder)
+      end
+
+      def file_type_in_folder?(extension, folder)
+        Dir.entries(folder).any? { |file| File.extname(file) == extension }
+      end
     end
   end
 end

data/lib/cucumber-compatibility-kit.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'cucumber/cucumber-compatibility-kit'

data/lib/keys_checker.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'cck/keys_checker'

data/lib/messages_comparator.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'cck/messages_comparator'

data/lib/shared_examples.rb

@@ -10,7 +10,7 @@ require 'keys_checker'
 RSpec.shared_examples 'cucumber compatibility kit' do
   include CCK::Helpers
 
-  # Note: to use those examples, you need to define:
+  # NOTE: to use those examples, you need to define:
   # let(:example) {  } # the name of the example to test
   # let(:messages) {  } # the messages to validate
 
@@ -30,7 +30,7 @@ RSpec.shared_examples 'cucumber compatibility kit' do
   end
 
   it 'generates valid message structure' do
-    comparator = CCK::MessagesComparator.new(CCK::KeysChecker, parsed_generated, parsed_original)
+    comparator = CCK::MessagesComparator.new(parsed_generated, parsed_original)
 
     expect(comparator.errors).to be_empty, "There were comparison errors: #{comparator.errors}"
   end

data/spec/cck/messages_comparator_spec.rb

@@ -15,13 +15,13 @@ describe CCK::MessagesComparator do
     let(:meta_message_envelope) { Cucumber::Messages::Envelope.new(meta: blank_meta_message) }
 
     it 'ignores any detected CI messages' do
-      comparator = described_class.new(CCK::KeysChecker, [ci_message_envelope], [meta_message_envelope])
+      comparator = described_class.new([ci_message_envelope], [meta_message_envelope])
 
       expect(comparator.errors).to be_empty
     end
 
     it 'ignores any expected CI messages' do
-      comparator = described_class.new(CCK::KeysChecker, [meta_message_envelope], [ci_message_envelope])
+      comparator = described_class.new([meta_message_envelope], [ci_message_envelope])
 
       expect(comparator.errors).to be_empty
     end

data/spec/cucumber/cucumber-compatibility-kit_spec.rb

@@ -5,21 +5,21 @@ require 'cucumber-compatibility-kit'
 describe Cucumber::CompatibilityKit do
   let(:features_path) { File.expand_path("#{File.dirname(__FILE__)}/../../features") }
   let(:gherkin_examples) do
-    [
-      'attachments',
-      'cdata',
-      'data-tables',
-      'examples-tables',
-      'hooks',
-      'minimal',
-      'parameter-types',
-      'pending',
-      'retry',
-      'rules',
-      'skipped',
-      'stack-traces',
-      'undefined',
-      'unknown-parameter-type'
+    %w[
+      attachments
+      cdata
+      data-tables
+      examples-tables
+      hooks
+      minimal
+      parameter-types
+      pending
+      retry
+      rules
+      skipped
+      stack-traces
+      undefined
+      unknown-parameter-type
     ]
   end
   let(:markdown_examples) { ['markdown'] }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-compatibility-kit
 version: !ruby/object:Gem::Version
-  version: 13.0.1
+  version: 14.0.0
 platform: ruby
 authors:
 - Aurélien Reeves
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-messages
@@ -138,6 +138,7 @@ files:
 - features/attachments/document.pdf
 - features/cdata/cdata.feature
 - features/cdata/cdata.feature.ndjson
+- features/cdata/cdata.feature.rb
 - features/data-tables/data-tables.feature
 - features/data-tables/data-tables.feature.ndjson
 - features/data-tables/data-tables.feature.rb
@@ -217,7 +218,7 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: cucumber-compatibility-kit-13.0.1
+summary: cucumber-compatibility-kit-14.0.0
 test_files:
 - spec/cck/keys_checker_spec.rb
 - spec/cck/messages_comparator_spec.rb