rimless 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfed89b34243fa4fd3232152dfd848d95bafc3b4d4a8190708b2d1679e052457
-  data.tar.gz: 4d2186084e65445e3ebc300ecdf229afe35d602c91e39422ee6010ce43a8ead3
+  metadata.gz: e1b5957c80f5acbd1e6325410fa95f4765bfee153d509781074b9a680047c342
+  data.tar.gz: f19fe3dd85d3b8b4aa050fefdb7f73d764c5223be72a8db6adce7862635e2446
 SHA512:
-  metadata.gz: 2c15140a5b0f189dce414dd00e40a678c7f345dc3d91ccf9fbde5476aa4075569ff0edbadbfcc5d0f6bbc1f6a5141b9df1f54ff609638038e60272775f65ffbf
-  data.tar.gz: 54b265581fbacbdd6486212d1867946f472295af8002e8a60f63a21a73f784fc2684c6502ac5369edb69fd3b0148473c17ea340f8dded94577ed7e71f0fbb7dc
+  metadata.gz: 4aa33a161c9f008523781c426aea9943a7295bd4bff73049edcbcdae8b4a9bc7eb9c3c6b0e58ebd1792bf8c4b5d6cba35ad886b716532ef917a92d2f599cd328
+  data.tar.gz: 837b9ee7470ab9a55fc1cb452558cfce631e530986f3bb7a7772ec381dabf8f423bce029f7bcdb026b921f4414465791da389fff8d2a832b4b75f702670c5dbe

data/.rubocop.yml

@@ -1,3 +1,7 @@
+inherit_from:
+  - https://potpourri.hausgold.de/config/rubocop.yml
+  - https://potpourri.hausgold.de/config/rubocop-gem.yml
+
 plugins:
   - rubocop-rspec
   - rubocop-rails
@@ -5,9 +9,6 @@ plugins:
 Rails:
   Enabled: true
 
-Style/Documentation:
-  Enabled: true
-
 AllCops:
   NewCops: enable
   SuggestExtensions: false
@@ -21,43 +22,12 @@ AllCops:
     - gemfiles/**/*
     - doc/kafka-playground/**/*
 
-Metrics/BlockLength:
-  Exclude:
-    - Rakefile
-    - '*.gemspec'
-    - spec/**/*.rb
-    - '**/*.rake'
-    - doc/**/*.rb
-
-# MFA is not yet enabled for our gems yet.
-Gemspec/RequireMFA:
-  Enabled: false
-
-# We stay with the original Ruby Style Guide recommendation.
-Layout/LineLength:
-  Max: 80
-
-# Document all the things.
-Style/DocumentationMethod:
-  Enabled: true
-  RequireForNonPublicMethods: true
-
 # It's a deliberate idiom in RSpec.
 # See: https://github.com/bbatsov/rubocop/issues/4222
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "spec/**/*"
 
-# Because +expect_any_instance_of().to have_received()+ is not
-# supported with the +with(hash_including)+ matchers
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Because nesting makes sense here to group the feature tests
-# more effective. This increases maintainability.
-RSpec/NestedGroups:
-  Max: 4
-
 # Disable regular Rails spec paths.
 Rails/FilePath:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 2.2.0 (19 December 2025)
+
+* Migrated to a shared Rubocop configuration for HAUSGOLD gems ([#62](https://github.com/hausgold/rimless/pull/62))
+
 ### 2.1.0 (23 October 2025)
 
 * Added support for Rails 8.1 ([#60](https://github.com/hausgold/rimless/pull/60))

data/Envfile

@@ -1,3 +1,4 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
+RUBOCOP_CACHE_ROOT=/app/tmp

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 HAUSGOLD | talocasa GmbH
+Copyright (c) 2025 HAUSGOLD | talocasa GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -132,7 +132,7 @@ Registry. The subject naming convention is mostly the same as the Apache Kafka
 Topic convention, except the allowed characters. [Apache
 Avro](https://avro.apache.org/docs/1.8.2/spec.html#namespace) just allows
 `[A-Za-z0-9_]` and no numbers on the first char. The application environment
-prefix allows the usage of the very same Schema Registry instance for multipe
+prefix allows the usage of the very same Schema Registry instance for multiple
 environments and the application name just reflects the schema origin.
 Convention rules:
 
@@ -167,7 +167,7 @@ Each schema template MUST end with the `.avsc.erb` extension to be picked up,
 even in recursive directory structures.  You can make use of the ERB templating
 or not, but rimless just looks for these templates. When it comes to
 structuring the Avro Schemas it is important that the file path reflects the
-embeded schema namespace correctly. So when `$(pwd)/config/avro_schemas` is our
+embedded schema namespace correctly. So when `$(pwd)/config/avro_schemas` is our
 schema namespace root, then the `production.identity_api.user_v1` schema
 converts to the
 `$(pwd)/config/avro_schemas/compiled/production/identity_api/user_v1.avsc`
@@ -456,7 +456,7 @@ were the user (eg. a frontend client) just can add whatever comes to his mind
 for later processing. Its not searchable, its never touched by the backend, but
 its present.
 
-Thats a case we're experienced and kind of solved on the rimless gem. You can
+That's a case we're experienced and kind of solved on the rimless gem. You can
 make use of the `Rimless.avro_schemaless_h` method to [sparsify the data
 recursively](https://github.com/simplymeasured/sparsify). Say you have the
 following metadata hash:
@@ -476,7 +476,7 @@ metadata = {
 
 It's messy, by design. From the Apache Avro perspective you just can define a
 map. The map keys are assumed to be strings - and the most hitting value data
-type is a string, too. Thats where hash sparsification comes in. The resulting
+type is a string, too. That's where hash sparsification comes in. The resulting
 metadata hash looks like this and can be encoded by Apache Avro:
 
 ```ruby
@@ -500,10 +500,10 @@ Avro schema to be a string. Choice is yours.
 ### Writing tests for your messages
 
 Producing messages is a bliss with the rimless gem, but producing code needs to
-be tested as well. Thats why the gem ships some RSpec helpers and matchers for
+be tested as well. That's why the gem ships some RSpec helpers and matchers for
 this purpose. A common situation is also handled by the RSpec extension: on the
 test environment (eg. a continuous integration service) its not likely to have
-a Apache Kafka/Confluent Schema Registry cluster available. Thats why actual
+a Apache Kafka/Confluent Schema Registry cluster available. That's why actual
 calls to Kafka/Schema Registry are mocked away.
 
 First of all, just add `require 'rimless/rspec'` to your `spec_helper.rb` or

data/doc/kafka-playground/README.md

@@ -73,7 +73,7 @@ the creation of the `/etc/mdns.allow` file.
 
 ## What's in the box
 
-After the installation and bootup processes are finished you should have a
+After the installation and boot-up processes are finished you should have a
 working Apache Kafka setup which includes the following:
 
 * A single node [Apache Kafka](https://kafka.apache.org/) (without Zookeeper,
@@ -108,7 +108,7 @@ Metadata for all topics (from broker 1001: kafka.playground.local:9092/1001):
   topic "test" with 1 partitions:
 ```
 
-Now start a second teminal playground container with `$ make shell` and run:
+Now start a second terminal playground container with `$ make shell` and run:
 
 ```shell
 # Terminal B

data/lib/rimless/compatibility/karafka_1_4.rb

@@ -17,9 +17,6 @@ module Karafka
         # 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 ||= []
@@ -49,7 +46,6 @@ module Karafka
             cli_class.map cmd_alias => name.to_s
           end
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/rimless/configuration_handling.rb

@@ -4,8 +4,6 @@ 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
 
@@ -81,5 +79,4 @@ module Rimless
     end
   end
   # rubocop:enable Style/ClassVars
-  # rubocop:enable Metrics/BlockLength
 end

data/lib/rimless/consumer.rb

@@ -76,9 +76,6 @@ module Rimless
       end
 
       # Configure the pure basics on the Karafka application.
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the various settings
-      # rubocop:disable Metrics/AbcSize -- ditto
       def initialize_karafka!
         setup do |config|
           mapper = Rimless::Karafka::PassthroughMapper.new
@@ -93,8 +90,6 @@ module Rimless
           config.shutdown_timeout = 10
         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.
@@ -147,8 +142,6 @@ module Rimless
       #
       # @param topics [Hash{Hash => Class}] the topic to consumer mapping
       # @yield the given block on the routing table
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the Karafka DSL
       def topics(topics = [], &block)
         consumer_groups.draw do
           consumer_group(Rimless.configuration.client_id) do
@@ -168,7 +161,6 @@ module Rimless
 
         self
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Build the conventional Apache Kafka topic names from the given parts.
       # This allows various forms like single strings/symbols and a hash in the

data/lib/rimless/dependencies.rb

@@ -2,9 +2,6 @@
 
 module Rimless
   # The top-level dependencies helpers.
-  #
-  # rubocop:disable Metrics/BlockLength -- because its an Active Support
-  #   concern
   module Dependencies
     extend ActiveSupport::Concern
 
@@ -18,8 +15,6 @@ 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
@@ -46,7 +41,6 @@ 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.
@@ -72,5 +66,4 @@ module Rimless
       end
     end
   end
-  # rubocop:enable Metrics/BlockLength
 end

data/lib/rimless/kafka_helpers.rb

@@ -5,8 +5,6 @@ module Rimless
   module KafkaHelpers
     extend ActiveSupport::Concern
 
-    # rubocop:disable Metrics/BlockLength -- because its an Active Support
-    #   concern
     class_methods do
       # Generate a common topic name for Apache Kafka while taking care of
       # configured prefixes.
@@ -22,12 +20,6 @@ module Rimless
       #   Rimless.topic(name: 'test', app: :fancy_app)
       # @example Full name - use as is
       #   Rimless.topic(full_name: 'my.custom.topic.name')
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the usage
-      #   flexibility
-      # rubocop:disable Metrics/AbcSize -- ditto
-      # rubocop:disable Metrics/CyclomaticComplexity -- ditto
-      # rubocop:disable Metrics/PerceivedComplexity -- ditto
       def topic(*args)
         opts = args.last
         name = args.first if [String, Symbol].member?(args.first.class)
@@ -47,10 +39,6 @@ module Rimless
 
         "#{Rimless.topic_prefix(app)}#{name}".tr('_', '-')
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # 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
@@ -112,6 +100,5 @@ module Rimless
         WaterDrop::AsyncProducer.call(data, **args)
       end
     end
-    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/rimless/karafka/avro_deserializer.rb

@@ -14,9 +14,9 @@ module Rimless
         return if params.raw_payload.nil?
 
         # We use sparsed hashes inside of Apache Avro messages for schema-less
-        # blobs of data, such as loosely structured metadata blobs.  Thats a
+        # blobs of data, such as loosely structured metadata blobs.  That's a
         # somewhat bad idea on strictly typed and defined messages, but their
-        # occurence should be rare.
+        # occurrence should be rare.
         Rimless
           .decode(params.raw_payload)
           .then { |data| Sparsify(data, sparse_array: true) }

data/lib/rimless/rspec/helpers.rb

@@ -21,11 +21,6 @@ module Rimless
       # @param topic [String, Hash{Symbol => Mixed}] the actual message
       #   topic (full as string, or parts via hash)
       # @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),
@@ -40,8 +35,6 @@ module Rimless
           deserialized: true
         )
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Style/OpenStructUse
 
       # Capture all Apache Kafka messages of the given block.
       #

data/lib/rimless/rspec/matchers.rb

@@ -6,9 +6,6 @@ module Rimless
     # A set of Rimless/RSpec matchers.
     module Matchers
       # The Apache Kafka message expectation.
-      #
-      # rubocop:disable Metrics/ClassLength -- because its almost RSpec API
-      #   code
       class HaveSentKafkaMessage < ::RSpec::Matchers::BuiltIn::BaseMatcher
         include ::RSpec::Mocks::ExampleMethods
 
@@ -220,7 +217,6 @@ module Rimless
 
         # Setup the +WaterDrop+ spies and record each sent message.
         # because of the message decoding
-        # rubocop:disable Metrics/MethodLength -- ditto
         def listen_to_messages
           decode = proc do |encoded|
             { encoded_data: encoded, data: Rimless.avro.decode(encoded) }
@@ -236,7 +232,6 @@ module Rimless
             nil
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         # Serve the RSpec API and return the positive failure message.
         #
@@ -289,7 +284,6 @@ module Rimless
           result.join
         end
       end
-      # rubocop:enable Metrics/ClassLength
 
       # Check for messages which were sent to Apache Kafka by the given block.
       #

data/lib/rimless/rspec.rb

@@ -11,7 +11,7 @@ require 'karafka/testing/rspec/helpers'
 # this dependency as runtime, just as development. Therefore we added it.
 require 'avro_turf/test/fake_confluent_schema_registry_server'
 
-# Add a monkey patch to add propper Sinatra 4.x support
+# Add a monkey patch to add proper Sinatra 4.x support
 class FakeConfluentSchemaRegistryServer
   # Allow any host name on tests
   set :host_authorization, { permitted_hosts: [] }
@@ -23,8 +23,6 @@ end
 raise 'No RSPEC_CONFIGURER is defined, webmock is missing?' \
   unless defined?(RSPEC_CONFIGURER)
 
-# rubocop:disable Metrics/BlockLength -- because we have to configure RSpec
-#   properly
 RSPEC_CONFIGURER.configure do |config|
   config.include Rimless::RSpec::Helpers
   config.include Rimless::RSpec::Matchers
@@ -83,4 +81,3 @@ RSPEC_CONFIGURER.configure do |config|
     Rimless.consumer.initialize! if example.metadata[:type] == :consumer
   end
 end
-# rubocop:enable Metrics/BlockLength

data/lib/rimless/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rimless
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Hermann Mayer