rimless 1.7.5 → 1.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c529e0b02be14c5f7314056e997817c8f9457cde8e84dfe68da219df922801
-  data.tar.gz: 7be0885ca438c95a653330aaa5e06f874f7abd572d5f36738c293f6da680b8a7
+  metadata.gz: 65a81e9d34d669a1e6acd791e2c10a189869fc40d2910b478fa37fac6c84accb
+  data.tar.gz: 69a88291a2aef544f0d646e58951f7fc9dc143848b9cc05041cfd19a8e19d47a
 SHA512:
-  metadata.gz: df1aa2ab9018d994d829cc9257831266c4a8dd548fc92d9d294a3bd805e3e773704156d7f4bb751038a369b9d189dfa196216807a774e24e7b8b0bc123fc7a8b
-  data.tar.gz: d42b81a6e97bd3a4f2a47733c3d9814b5ee506a64b21dbd4d59a1694e706a19de1a4b97412034d0f309f1cb80b6ecd47e41f9f5bc740311ab5d3f09a3e8f3fbc
+  metadata.gz: 427e0d60a2aae434d3742ab73ae676917077c16216282d6de286c3f32cc5a4c2df02034ff743b8acb1470f2d347d710d0bac322c264f64ddbdda5ad1526a7667
+  data.tar.gz: 7f1bd3ff9c139586dd4b4c14efdd80177860e3d4e7d2dc93e58a29ed2fed67985218031fb3264b103efe2bac209fb3f02a2c9a1495f23d81e66384112d0209bb

data/.yardopts

@@ -4,4 +4,5 @@
 -
 README.md
 doc/examples/**/*.rb
+doc/*.md
 doc/kafka-playground/examples/**/*.rb

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 1.7.7
+
+* Corrected the Sidekiq interchanger decoding, which is caused by an upstream
+  update of the karafka-sidekiq-backend gem (#43)
+
+### 1.7.6
+
+* Added a monkey-patch for the constellation Karafka 1.4 and Thor 1.3,
+  on Ruby >=2.7 (#42)
+
 ### 1.7.5
 
 * Just a retag of 1.7.1

data/lib/rimless/compatibility/karafka_1_4.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'karafka/cli/base'
+
+module Karafka
+  class Cli
+    # See: https://github.com/hausgold/rimless/issues/36
+    #
+    # Karafka 1.4 is not compatible with Thor 1.3. Unfortunately they did not
+    # backported the fix on Karafka 2.0 back to 1.4, so we have to do it here
+    # with a monkey-patch.
+    class Base
+      class << self
+        alias original_bind_to bind_to
+
+        # This method will bind a given Cli command into Karafka Cli.
+        # This method is a wrapper to way Thor defines its commands.
+        #
+        # @param cli_class [Karafka::Cli] the class to bind to
+        #
+        # rubocop:disable Metrics/MethodLength because of the
+        #   monkey-patching logic
+        def bind_to(cli_class)
+          @aliases ||= []
+          @options ||= []
+
+          # We're late to the party here, as the +karafka/cli/console+ and
+          # +karafka/cli/server+ files were already required and therefore they
+          # already wrote to the +@options+ array. So we will sanitize/split
+          # the options here to allow correct usage of the original Karafka 1.4
+          # +.bind_to+ method.
+          @options.select! do |set|
+            # We look for option sets without name (aliases),
+            # a regular set looks like this: +[:daemon, {:default=>false, ..}]+
+            next true unless set.first.is_a? Hash
+
+            # An alias looks like this: +[{:aliases=>"s"}]+
+            @aliases << set.first[:aliases].to_s
+
+            # Strip this set from the options
+            false
+          end
+
+          # Run the original Karafka 1.4 +.bind_to+ method
+          original_bind_to(cli_class)
+
+          # Configure the command aliases
+          @aliases.each do |cmd_alias|
+            cli_class.map cmd_alias => name.to_s
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/rimless/initializers/compatibility.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Check the actual (currently loaded) gem version against the expected
+# (given) version. It returns +true+ when the expected version matches the
+# actual one. The version check is patch-level independent.
+#
+# @param expected [String] the expected gem version (eg. +'~> 5.1'+)
+# @return [Boolean] whenever the version is loaded or not
+def rimless_gem_version?(gem_name, expected)
+  actual = Gem.loaded_specs[gem_name].version
+  Gem::Dependency.new('', expected.to_s).match?('', actual)
+end
+
+# Load some polyfills for ActiveSupport lower than 6.0
+require 'rimless/compatibility/karafka_1_4' \
+  if rimless_gem_version?('karafka', '~> 1.4') \
+     && rimless_gem_version?('thor', '>= 1.3')

data/lib/rimless/karafka/base64_interchanger.rb

@@ -11,7 +11,8 @@ module Rimless
       # Encode a binary Apache Kafka message(s) so they can be passed to the
       # Sidekiq +Rimless::ConsumerJob+.
       #
-      # @param params_batch [Mixed] the raw message(s) to encode
+      # @param params_batch [Karafka::Params::ParamsBatch] the karafka params
+      #   batch object
       # @return [String] the marshaled+base64 encoded data
       def encode(params_batch)
         Base64.encode64(Marshal.dump(super))
@@ -21,9 +22,9 @@ module Rimless
       # the Sidekiq +Rimless::ConsumerJob+.
       #
       # @param params_string [String] the marshaled+base64 encoded data
-      # @return [Mixed] the unmarshaled+base64 decoded data
-      def decode(params_string)
-        Marshal.load(Base64.decode64(super)).map(&:stringify_keys)
+      # @return [Array<Hash>] the unmarshaled+base64 decoded data
+      def decode(params_batch)
+        super(Marshal.load(Base64.decode64(params_batch))).map(&:stringify_keys)
       end
     end
     # rubocop:enable Security/MarshalLoad

data/lib/rimless/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Rimless
   # The version of the +rimless+ gem
-  VERSION = '1.7.5'
+  VERSION = '1.7.7'
 
   class << self
     # Returns the version of gem as a string.

data/lib/rimless.rb

@@ -19,6 +19,9 @@ require 'erb'
 
 # The top level namespace for the rimless gem.
 module Rimless
+  # Configure the relative gem code base location
+  root_path = Pathname.new("#{__dir__}/rimless")
+
   # Top level elements
   autoload :Configuration, 'rimless/configuration'
   autoload :ConfigurationHandling, 'rimless/configuration_handling'
@@ -47,4 +50,7 @@ module Rimless
   include Rimless::KafkaHelpers
   include Rimless::Dependencies
   include Rimless::Consumer
+
+  # Load all initializers of the gem
+  Dir[root_path.join('initializers/**/*.rb')].sort.each { |path| require path }
 end

data/rimless.gemspec

@@ -35,14 +35,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7'
 
-  spec.add_runtime_dependency 'activesupport', '>= 5.2'
-  spec.add_runtime_dependency 'avro_turf', '~> 0.11.0'
-  spec.add_runtime_dependency 'karafka', '~> 1.4', '< 1.4.15'
-  spec.add_runtime_dependency 'karafka-sidekiq-backend', '~> 1.4'
-  spec.add_runtime_dependency 'karafka-testing', '~> 1.4'
-  spec.add_runtime_dependency 'retries', '>= 0.0.5'
-  spec.add_runtime_dependency 'sinatra', '~> 2.2'
-  spec.add_runtime_dependency 'sparsify', '~> 1.1'
-  spec.add_runtime_dependency 'waterdrop', '~> 1.4'
-  spec.add_runtime_dependency 'webmock', '~> 3.18'
+  spec.add_dependency 'activesupport', '>= 5.2'
+  spec.add_dependency 'avro_turf', '~> 0.11.0'
+  spec.add_dependency 'karafka', '~> 1.4', '< 1.4.15'
+  spec.add_dependency 'karafka-sidekiq-backend', '~> 1.4'
+  spec.add_dependency 'karafka-testing', '~> 1.4'
+  spec.add_dependency 'retries', '>= 0.0.5'
+  spec.add_dependency 'sinatra', '~> 2.2'
+  spec.add_dependency 'sparsify', '~> 1.1'
+  spec.add_dependency 'waterdrop', '~> 1.4'
+  spec.add_dependency 'webmock', '~> 3.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rimless
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.7.7
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -221,11 +221,13 @@ files:
 - lib/rimless/avro_helpers.rb
 - lib/rimless/avro_utils.rb
 - lib/rimless/base_consumer.rb
+- lib/rimless/compatibility/karafka_1_4.rb
 - lib/rimless/configuration.rb
 - lib/rimless/configuration_handling.rb
 - lib/rimless/consumer.rb
 - lib/rimless/consumer_job.rb
 - lib/rimless/dependencies.rb
+- lib/rimless/initializers/compatibility.rb
 - lib/rimless/kafka_helpers.rb
 - lib/rimless/karafka/avro_deserializer.rb
 - lib/rimless/karafka/base64_interchanger.rb