rimless 1.1.1 → 1.3.0

data/lib/rimless/configuration_handling.rb

@@ -4,6 +4,8 @@ module Rimless
   # The top-level configuration handling.
   #
   # rubocop:disable Style/ClassVars because we split module code
+  # rubocop:disable Metrics/BlockLength because this is how
+  #   an +ActiveSupport::Concern+ looks like
   module ConfigurationHandling
     extend ActiveSupport::Concern
 
@@ -61,8 +63,15 @@ module Rimless
         # Check if a application is defined
         return if Rails.application.nil?
 
+        # We need a little compatibility here, as in Rails 6.1+ there is no
+        # more +parent_name+, instead they renamed it to +module_parent_name+
+        app_class = Rails.application.class
+        parent_name = app_class.module_parent_name \
+          if app_class.respond_to?(:module_parent_name)
+        parent_name ||= app_class.parent_name
+
         # Pass back the URI compatible application name
-        Rails.application.class.parent_name.underscore.dasherize
+        parent_name.underscore.dasherize
       end
 
       # Retrieve the current configured logger instance.
@@ -72,4 +81,5 @@ module Rimless
     end
   end
   # rubocop:enable Style/ClassVars
+  # rubocop:enable Metrics/BlockLength
 end

data/lib/rimless/consumer.rb

@@ -47,7 +47,7 @@ module Rimless
         return unless rails_env.exist?
 
         ENV['RAILS_ENV'] ||= 'development'
-        ENV['KARAFKA_ENV'] = ENV['RAILS_ENV']
+        ENV['KARAFKA_ENV'] = ENV.fetch('RAILS_ENV', nil)
         require rails_env
         Rails.application.eager_load!
       end
@@ -67,6 +67,7 @@ module Rimless
       # Configure the pure basics on the Karafka application.
       #
       # rubocop:disable Metrics/MethodLength because of the various settings
+      # rubocop:disable Metrics/AbcSize dito
       def initialize_karafka!
         setup do |config|
           mapper = Rimless::Karafka::PassthroughMapper.new
@@ -82,13 +83,14 @@ module Rimless
         end
       end
       # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       # When we run in development mode, we want to write the logs
       # to file and to stdout.
       def initialize_logger!
         return unless Rimless.env.development? && server?
 
-        STDOUT.sync = true
+        $stdout.sync = true
         Rimless.logger.extend(ActiveSupport::Logger.broadcast(
                                 ActiveSupport::Logger.new($stdout)
                               ))

data/lib/rimless/dependencies.rb

@@ -17,6 +17,8 @@ module Rimless
       end
 
       # Set sensible defaults for the +WaterDrop+ gem.
+      #
+      # rubocop:disable Metrics/AbcSize because of the configuration mapping
       def configure_waterdrop
         # Skip WaterDrop configuration when no brokers/client id is available,
         # because it will raise. Its fine to have none available for situations
@@ -43,6 +45,7 @@ module Rimless
           config.kafka.required_acks = -1
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Set sensible defaults for the +AvroTurf+ gem and (re)compile the Apache
       # Avro schema templates (ERB), so the gem can handle them properly.

data/lib/rimless/kafka_helpers.rb

@@ -21,6 +21,7 @@ module Rimless
       #   Rimless.topic(name: 'test', app: :fancy_app)
       #
       # rubocop:disable Metrics/AbcSize because of the usage flexibility
+      # rubocop:disable Metrics/CyclomaticComplexity dito
       def topic(*args)
         opts = args.last
         name = args.first if [String, Symbol].member?(args.first.class)
@@ -38,6 +39,7 @@ module Rimless
         "#{Rimless.topic_prefix(app)}#{name}".tr('_', '-')
       end
       # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Send a single message to Apache Kafka. The data is encoded according to
       # the given Apache Avro schema. The destination Kafka topic may be a

data/lib/rimless/karafka/avro_deserializer.rb

@@ -19,9 +19,9 @@ module Rimless
         # occurence should be rare.
         Rimless
           .decode(params.raw_payload)
-          .yield_self { |data| Sparsify(data, sparse_array: true) }
-          .yield_self { |data| data.transform_keys { |key| key.delete('\\') } }
-          .yield_self { |data| Unsparsify(data, sparse_array: true) }
+          .then { |data| Sparsify(data, sparse_array: true) }
+          .then { |data| data.transform_keys { |key| key.delete('\\') } }
+          .then { |data| Unsparsify(data, sparse_array: true) }
           .deep_symbolize_keys
       end
     end

data/lib/rimless/rspec/helpers.rb

@@ -23,6 +23,8 @@ module Rimless
       # @return [OpenStruct] the fake deserialized Kafka message
       #
       # rubocop:disable Metrics/MethodLength because of the various properties
+      # rubocop:disable Style/OpenStructUse because existing specs may rely
+      #   on this data type
       def kafka_message(topic: nil, headers: {}, **payload)
         OpenStruct.new(
           topic: Rimless.topic(topic),
@@ -38,6 +40,15 @@ module Rimless
         )
       end
       # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Style/OpenStructUse
+
+      # Capture all Apache Kafka messages of the given block.
+      #
+      # @yield the given block to capture the messages
+      # @return [Array<Hash{Symbol => Mixed}>] the captured messages
+      def capture_kafka_messages(&block)
+        Rimless::RSpec::Matchers::HaveSentKafkaMessage.new(nil).capture(&block)
+      end
     end
   end
 end

data/lib/rimless/rspec/matchers.rb

@@ -16,6 +16,7 @@ module Rimless
         # @param schema [String, Symbol, nil] the expected message schema
         # @return [HaveSentKafkaMessage] the expectation instance
         def initialize(schema)
+          super
           @schema = schema
           @args = {}
           @data = {}
@@ -23,6 +24,15 @@ module Rimless
           set_expected_number(:exactly, 1)
         end
 
+        # Capture all Apache Kafka messages of the given block.
+        #
+        # @yield the given block to capture the messages
+        # @return [Array<Hash{Symbol => Mixed}>] the captured messages
+        def capture(&block)
+          matches?(block)
+          @messages
+        end
+
         # Collect the expectation arguments for the Kafka message passing. (eg.
         # topic)
         #
@@ -173,8 +183,9 @@ module Rimless
           return true unless @schema
 
           begin
-            Rimless.avro.decode(message[:data], schema_name: @schema.to_s)
-            return true
+            Rimless.avro.decode(message[:encoded_data],
+                                schema_name: @schema.to_s)
+            true
           rescue Avro::IO::SchemaMatchException
             false
           end
@@ -199,24 +210,28 @@ module Rimless
         def data_match?(message)
           return true unless @data.any?
 
-          actual_data = Rimless.avro.decode(message[:data])
-          expected_data = @data.deep_stringify_keys
-
-          actual_data.merge(expected_data) == actual_data
+          message[:data].merge(@data.deep_stringify_keys) == message[:data]
         end
 
         # Setup the +WaterDrop+ spies and record each sent message.
+        # because of the message decoding
+        # rubocop:disable Metrics/MethodLength dito
         def listen_to_messages
+          decode = proc do |encoded|
+            { encoded_data: encoded, data: Rimless.avro.decode(encoded) }
+          end
+
           allow(WaterDrop::SyncProducer).to receive(:call) do |data, **args|
-            @messages << { data: data, args: args, type: :sync }
+            @messages << { args: args, type: :sync }.merge(decode[data])
             nil
           end
 
           allow(WaterDrop::AsyncProducer).to receive(:call) do |data, **args|
-            @messages << { data: data, args: args, type: :async }
+            @messages << { args: args, type: :async }.merge(decode[data])
             nil
           end
         end
+        # rubocop:enable Metrics/MethodLength
 
         # Serve the RSpec API and return the positive failure message.
         #
@@ -264,7 +279,7 @@ module Rimless
           result = ['message']
 
           result << " with #{message[:args]}" if message[:args].any?
-          result << " with data: #{Rimless.avro.decode(message[:data])}"
+          result << " with data: #{message[:data]}"
 
           result.join
         end

data/lib/rimless/rspec.rb

@@ -33,7 +33,7 @@ RSPEC_CONFIGURER.configure do |config|
     # schema repository it cannot conflict while refreshing it.
     unless ENV['TEST_ENV_NUMBER'].nil?
       Rimless.configure do |conf|
-        num = ENV['TEST_ENV_NUMBER']
+        num = ENV.fetch('TEST_ENV_NUMBER', nil)
         num = '1' if num.empty?
 
         conf.compiled_avro_schema_path = \

data/lib/rimless/tasks/consumer.rake

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 namespace :rimless do
+  # rubocop:disable Rails/RakeEnvironment because this is just an command
+  #   proxy, no need for an application bootstrap
   desc 'Start the Apache Kafka consumer'
   task :consumer do
     system 'bundle exec karafka server'
   end
+  # rubocop:enable Rails/RakeEnvironment
 
   desc 'Print all the consumer routes'
   task routes: :environment do

data/lib/rimless/tasks/generator.rake

@@ -18,6 +18,8 @@ namespace :rimless do
     FileUtils.copy(src, dest)
   end
 
+  # rubocop:disable Rails/RakeEnvironment because this is just an
+  #   helper command, no need for an application bootstrap
   desc 'Install the Rimless consumer components'
   task :install do
     install_template('karafka.rb')
@@ -33,4 +35,5 @@ namespace :rimless do
       # your project root. And list all routes with +rake rimless:routes+.
     OUTPUT
   end
+  # rubocop:enable Rails/RakeEnvironment
 end

data/lib/rimless/tasks/stats.rake

@@ -3,6 +3,8 @@
 if defined?(Rails) && Rails.env.development?
   require 'rspec/core/rake_task'
 
+  # rubocop:disable Rails/RakeEnvironment because this is just an
+  #   helper command, no need for an application bootstrap
   task :stats do
     require 'rails/code_statistics'
 
@@ -11,8 +13,9 @@ if defined?(Rails) && Rails.env.development?
     ].each do |method, type, dir|
       next unless File.directory? dir
 
-      ::STATS_DIRECTORIES.send(method, [type, dir])
-      ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
+      STATS_DIRECTORIES.send(method, [type, dir])
+      CodeStatistics::TEST_TYPES << type if type.include? 'specs'
     end
   end
+  # rubocop:enable Rails/RakeEnvironment
 end

data/lib/rimless/version.rb

@@ -1,6 +1,23 @@
 # frozen_string_literal: true
 
+# The gem version details.
 module Rimless
   # The version of the +rimless+ gem
-  VERSION = '1.1.1'
+  VERSION = '1.3.0'
+
+  class << self
+    # Returns the version of gem as a string.
+    #
+    # @return [String] the gem version as string
+    def version
+      VERSION
+    end
+
+    # Returns the version of the gem as a +Gem::Version+.
+    #
+    # @return [Gem::Version] the gem version as object
+    def gem_version
+      Gem::Version.new VERSION
+    end
+  end
 end

data/lib/rimless.rb

@@ -15,7 +15,6 @@ require 'karafka'
 require 'karafka-sidekiq-backend'
 require 'sparsify'
 require 'erb'
-require 'pp'
 
 # The top level namespace for the rimless gem.
 module Rimless

data/rimless.gemspec

@@ -5,47 +5,61 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rimless/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'rimless'
-  spec.version       = Rimless::VERSION
-  spec.authors       = ['Hermann Mayer']
-  spec.email         = ['hermann.mayer92@gmail.com']
+  spec.name = 'rimless'
+  spec.version = Rimless::VERSION
+  spec.authors = ['Hermann Mayer']
+  spec.email = ['hermann.mayer92@gmail.com']
 
-  spec.summary       = 'A bundle of opinionated Apache Kafka / Confluent ' \
-                       'Schema Registry helpers.'
-  spec.description   = 'A bundle of opinionated Apache Kafka / Confluent ' \
-                       'Schema Registry helpers.'
-  spec.homepage      = 'https://github.com/hausgold/rimless'
+  spec.license = 'MIT'
+  spec.summary = 'A bundle of opinionated Apache Kafka / Confluent ' \
+                 'Schema Registry helpers.'
+  spec.description = 'A bundle of opinionated Apache Kafka / Confluent ' \
+                     'Schema Registry helpers.'
+
+  base_uri = "https://github.com/hausgold/#{spec.name}"
+  spec.metadata = {
+    'homepage_uri' => base_uri,
+    'source_code_uri' => base_uri,
+    'changelog_uri' => "#{base_uri}/blob/master/CHANGELOG.md",
+    'bug_tracker_uri' => "#{base_uri}/issues",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{spec.name}"
+  }
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '>= 4.2.0'
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_runtime_dependency 'activesupport', '>= 5.2'
   spec.add_runtime_dependency 'avro_turf', '~> 0.11.0'
   spec.add_runtime_dependency 'karafka', '~> 1.4'
   spec.add_runtime_dependency 'karafka-sidekiq-backend', '~> 1.4'
   spec.add_runtime_dependency 'karafka-testing', '~> 1.4'
-  spec.add_runtime_dependency 'sinatra'
+  spec.add_runtime_dependency 'sinatra', '~> 2.2'
   spec.add_runtime_dependency 'sparsify', '~> 1.1'
-  spec.add_runtime_dependency 'waterdrop', '~> 1.2'
-  spec.add_runtime_dependency 'webmock'
+  spec.add_runtime_dependency 'waterdrop', '~> 1.4'
+  spec.add_runtime_dependency 'webmock', '~> 3.18'
 
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
-  spec.add_development_dependency 'factory_bot', '~> 4.11'
-  spec.add_development_dependency 'railties', '>= 4.2.0'
+  spec.add_development_dependency 'appraisal', '~> 2.4'
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'countless', '~> 1.1'
+  spec.add_development_dependency 'factory_bot', '~> 6.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'railties', '>= 5.2'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rdoc', '~> 6.1'
-  spec.add_development_dependency 'redcarpet', '~> 3.4'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.63.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'yard', '~> 0.9.18'
-  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.14'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
+  spec.add_development_dependency 'simplecov', '>= 0.22'
+  spec.add_development_dependency 'timecop', '>= 0.9.6'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'yard', '>= 0.9.28'
+  spec.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'
 end