rimless 1.2.0 → 1.3.0

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 = {}
@@ -184,7 +185,7 @@ module Rimless
           begin
             Rimless.avro.decode(message[:encoded_data],
                                 schema_name: @schema.to_s)
-            return true
+            true
           rescue Avro::IO::SchemaMatchException
             false
           end
@@ -213,8 +214,7 @@ module Rimless
         end
 
         # Setup the +WaterDrop+ spies and record each sent message.
-        #
-        # rubocop:disable Metrics/AbcSize because of the message decoding
+        # because of the message decoding
         # rubocop:disable Metrics/MethodLength dito
         def listen_to_messages
           decode = proc do |encoded|
@@ -231,7 +231,6 @@ module Rimless
             nil
           end
         end
-        # rubocop:enable Metrics/AbcSize
         # rubocop:enable Metrics/MethodLength
 
         # Serve the RSpec API and return the positive failure message.

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.2.0'
+  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', '< 6.1'
+  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.18'
-  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rimless
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: avro_turf
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: sparsify
   requirement: !ruby/object:Gem::Requirement
@@ -114,96 +114,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.18'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: countless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -219,143 +235,143 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.28
 - !ruby/object:Gem::Dependency
   name: yard-activesupport-concern
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.1
 description: A bundle of opinionated Apache Kafka / Confluent Schema Registry helpers.
@@ -378,6 +394,7 @@ files:
 - Dockerfile
 - Envfile
 - Gemfile
+- Guardfile
 - LICENSE
 - Makefile
 - README.md
@@ -389,12 +406,32 @@ files:
 - config/docker/.bashrc
 - config/docker/.inputrc
 - doc/assets/project.svg
+- doc/kafka-playground/.gitignore
+- doc/kafka-playground/Dockerfile
+- doc/kafka-playground/Gemfile
+- doc/kafka-playground/Gemfile.lock
+- doc/kafka-playground/Makefile
+- doc/kafka-playground/README.md
+- doc/kafka-playground/bin/consume-topic
+- doc/kafka-playground/bin/create-topic
+- doc/kafka-playground/bin/delete-topic
+- doc/kafka-playground/bin/list-topics
+- doc/kafka-playground/bin/produce-event
+- doc/kafka-playground/config/avro_schemas/.gitignore
+- doc/kafka-playground/config/avro_schemas/playground_app/item_v1.avsc.erb
+- doc/kafka-playground/config/avro_schemas/playground_app/payment_v1.avsc.erb
+- doc/kafka-playground/config/avro_schemas/playground_app/payment_v1_event.avsc.erb
+- doc/kafka-playground/config/docker/shell/.bash_profile
+- doc/kafka-playground/config/docker/shell/.bashrc
+- doc/kafka-playground/config/docker/shell/.config/kcat.conf
+- doc/kafka-playground/config/docker/shell/.gemrc
+- doc/kafka-playground/config/docker/shell/.inputrc
+- doc/kafka-playground/config/environment.rb
+- doc/kafka-playground/doc/assets/project.svg
+- doc/kafka-playground/docker-compose.yml
+- doc/kafka-playground/examples/rimless-produce
 - docker-compose.yml
-- gemfiles/rails_4.2.gemfile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
 - lib/rimless.rb
 - lib/rimless/avro_helpers.rb
 - lib/rimless/avro_utils.rb
@@ -422,9 +459,15 @@ files:
 - lib/rimless/version.rb
 - log/development.log
 - rimless.gemspec
-homepage: https://github.com/hausgold/rimless
-licenses: []
-metadata: {}
+homepage:
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hausgold/rimless
+  source_code_uri: https://github.com/hausgold/rimless
+  changelog_uri: https://github.com/hausgold/rimless/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hausgold/rimless/issues
+  documentation_uri: https://www.rubydoc.info/gems/rimless
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -433,14 +476,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: A bundle of opinionated Apache Kafka / Confluent Schema Registry helpers.