rimless 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c4f8ffaba9e9935ef3dce5dbb9dbe983c0b7405fd2b94b0e3c49abf4d23f37a
-  data.tar.gz: 2590e8e7d9858460924a7947413770b51b1b367f77add354d79af8f95621eb1e
+  metadata.gz: d94b5db1c219992a8e7f2470a33c5c260065d19ad9c678fdbe7c34d8d7eac5ef
+  data.tar.gz: 208ec10f307dc7b777b656cdeb0c5e959cbc1cc33206fe62cc7655e59823b1cd
 SHA512:
-  metadata.gz: d06e180257c7c14b712aac3e7bb47105354ab03ad177c68737d32c5867166b83503a25afbd5b3bb60625da05deedc4a77581497a2c02f5b8344452ad0d3fe097
-  data.tar.gz: e1859640122aaab64ee8af5c1272cc29a86e43551e7b505d5295f18b214baa94db6d6f7273086f10b5417c5af12e7a739643415a218131a95e8a8d1f171761de
+  metadata.gz: 999b3384beea7efb59e9a78a12b721d15f5333ae0ed8f8dc2d5462301a179430083c6947507ca05308370257d6a822ff8b7787db08fc353e609bf00d6d0a068b
+  data.tar.gz: 26f9863a2d2252007027d4f3229f1c1883e0156cb12d56941fde1f203b4eb7057a7f5fb5ce5a8a76d810f923e7940a71ac198b82ec70c2c9599abbc2d5cee838

data/.github/workflows/documentation.yml

@@ -0,0 +1,39 @@
+name: Build Documentation
+on:
+  repository_dispatch:
+    types: [documentation]
+
+concurrency:
+  group: 'docs'
+
+jobs:
+  docs:
+    name: Build gem documentation
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Build gem documentation
+        run: make docs
+
+      - name: Upload the code coverage report
+        run: coverage
+
+      - name: Add this job to the commit status
+        run: commit-status '${{ job.status }}'
+        if: always()

data/.github/workflows/test.yml

@@ -0,0 +1,63 @@
+name: Test
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * MON'
+
+concurrency:
+  group: '${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.5', '2.7']
+        rails: ['5.2']
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage
+
+  trigger-docs:
+    name: Trigger the documentation upload
+    runs-on: ubuntu-22.04
+    timeout-minutes: 2
+    needs: test
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/noop
+
+      - name: Trigger the documentation upload
+        run: workflow documentation

data/.rspec

@@ -1,3 +1,3 @@
+--backtrace
+--force-color
 --format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,19 +1,25 @@
-require: rubocop-rspec
+require:
+  - rubocop-rspec
+  - rubocop-rails
 
 Rails:
   Enabled: true
 
-Documentation:
+Style/Documentation:
   Enabled: true
 
 AllCops:
+  NewCops: enable
+  SuggestExtensions: false
   DisplayCopNames: true
   TargetRubyVersion: 2.5
+  TargetRailsVersion: 5.2
   Exclude:
     - bin/**/*
     - vendor/**/*
     - build/**/*
     - gemfiles/**/*
+    - doc/kafka-playground/**/*
 
 Metrics/BlockLength:
   Exclude:
@@ -23,6 +29,14 @@ Metrics/BlockLength:
     - '**/*.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

data/.simplecov

@@ -1,3 +1,15 @@
+# frozen_string_literal: true
+
+require 'simplecov-html'
+require 'simplecov_json_formatter'
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter
+  ]
+)
+
 SimpleCov.start 'test_frameworks' do
   add_filter '/vendor/bundle/'
 end

data/Appraisals

@@ -1,26 +1,6 @@
 # frozen_string_literal: true
 
-appraise 'rails-4.2' do
-  gem 'activesupport', '~> 4.2.11'
-  gem 'railties', '~> 4.2.11'
-end
-
-appraise 'rails-5.0' do
-  gem 'activesupport', '~> 5.0.7'
-  gem 'railties', '~> 5.0.7'
-end
-
-appraise 'rails-5.1' do
-  gem 'activesupport', '~> 5.1.6'
-  gem 'railties', '~> 5.1.6'
-end
-
 appraise 'rails-5.2' do
-  gem 'activesupport', '~> 5.2.2'
-  gem 'railties', '~> 5.2.2'
-end
-
-appraise 'rails-6.0' do
-  gem 'activesupport', '~> 6.0.0'
-  gem 'railties', '~> 6.0.0'
+  gem 'activesupport', '~> 5.2.0'
+  gem 'railties', '~> 5.2.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 1.3.0
+
+* Bundler >= 2.3 is from now on required as minimal version (#19)
+* Dropped support for Ruby < 2.5 (#19)
+* Dropped support for Rails < 5.2 (#19)
+* Updated all development/runtime gems to their latest
+  Ruby 2.5 compatible version (#19)
+
+### 1.2.0
+
+* Added a `capture_kafka_messages` helper for RSpec (#12)
+
 ### 1.1.1
 
 * Corrected the GNU Make release target

data/Dockerfile

@@ -2,7 +2,7 @@ FROM hausgold/ruby:2.5
 MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
 
 # Update system gem
-RUN gem update --system
+RUN gem update --system '3.3.26'
 
 # Install system packages and the latest bundler
 RUN apt-get update -yqqq && \
@@ -11,8 +11,7 @@ RUN apt-get update -yqqq && \
     ca-certificates \
     bash-completion inotify-tools && \
   echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
-  gem install bundler -v '~> 2.0' --no-document --no-prerelease && \
-  gem install bundler -v '~> 1.0' --no-document --no-prerelease
+  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
 
 # Add new web user
 RUN mkdir /app && \

data/Envfile

@@ -1,6 +1,3 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
-
-# Just fix this, so Appraisals with Rails 4 are working fine
-BUNDLER_VERSION=1.17.3

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+(directories %w[lib spec]).select do |d|
+  if Dir.exist?(d)
+    d
+  else
+    UI.warning("Directory #{d} does not exist")
+  end
+end
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/rimless.rb}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/rimless/([^\\]+)\.rb$}) do |m|
+    "spec/rimless/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/rimless/([^\\]+)/(.*)\.rb$}) do |m|
+    "spec/rimless/#{m[1]}/#{m[2]}_spec.rb"
+  end
+end

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 HAUSGOLD | talocasa GmbH
+Copyright (c) 2023 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/Makefile

@@ -9,6 +9,7 @@ SHELL := bash
 # Environment switches
 MAKE_ENV ?= docker
 COMPOSE_RUN_SHELL_FLAGS ?= --rm
+BASH_RUN_SHELL_FLAGS ?=
 
 # Directories
 VENDOR_DIR ?= vendor/bundle
@@ -29,8 +30,9 @@ XARGS ?= xargs
 APPRAISAL ?= appraisal
 BUNDLE ?= bundle
 GEM ?= gem
+GUARD ?= guard
 RAKE ?= rake
-RAKE ?= rake
+RSPEC ?= rspec
 RUBOCOP ?= rubocop
 YARD ?= yard
 
@@ -46,7 +48,8 @@ define run-shell
 	$(COMPOSE) run $(COMPOSE_RUN_SHELL_FLAGS) \
 		-e LANG=en_US.UTF-8 -e LANGUAGE=en_US.UTF-8 -e LC_ALL=en_US.UTF-8 \
 		-e HOME=/home/web -e BUNDLE_APP_CONFIG=/app/.bundle \
-		-u `$(ID) -u` test bash -c 'sleep 0.1; echo; $(1)'
+		-u `$(ID) -u` test \
+		bash $(BASH_RUN_SHELL_FLAGS) -c 'sleep 0.1; echo; $(1)'
 endef
 else ifeq ($(MAKE_ENV),baremetal)
 define run-shell
@@ -63,6 +66,7 @@ all:
 	#
 	# test               Run the whole test suite
 	# test-style         Test the code styles
+	# watch              Watch for code changes and rerun the test suite
 	#
 	# docs               Generate the Ruby documentation of the library
 	# stats              Print the code statistics (library and test suite)
@@ -72,31 +76,37 @@ all:
 	# shell              Run an interactive shell on the container
 	# shell-irb          Run an interactive IRB shell on the container
 
+.interactive:
+	@$(eval BASH_RUN_SHELL_FLAGS = --login)
+
 install:
 	# Install the dependencies
 	@$(MKDIR) -p $(VENDOR_DIR)
 	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
-	@$(call run-shell,GEM_HOME=vendor/bundle/ruby/$${RUBY_MAJOR}.0 \
-		$(GEM) install bundler -v "~> 1.0")
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
 
-update: install
+update:
 	# Install the dependencies
 	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) update)
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
 
+watch: install .interactive
+	# Watch for code changes and rerun the test suite
+	@$(call run-shell,$(BUNDLE) exec $(GUARD))
+
 test: \
 	test-specs \
 	test-style
 
 test-specs:
 	# Run the whole test suite
-	@$(call run-shell,$(BUNDLE) exec $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
 
 $(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
 $(TEST_GEMFILES):
 	# Run the whole test suite ($(GEMFILE))
-	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RSPEC))
 
 test-style: \
 	test-style-ruby
@@ -111,8 +121,8 @@ clean:
 	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
 	@$(RM) -rf $(GEMFILES_DIR)/vendor
 	@$(RM) -rf $(GEMFILES_DIR)/*.lock
-	@$(RM) -rf pkg
-	@$(RM) -rf coverage
+	@$(RM) -rf .bundle .yardoc coverage pkg Gemfile.lock doc/api \
+		.rspec_status
 
 clean-containers:
 	# Clean running containers
@@ -123,31 +133,31 @@ endif
 clean-images:
 	# Clean build images
 ifeq ($(MAKE_ENV),docker)
-	@-$(DOCKER) images | $(GREP) rimless \
+	@-$(DOCKER) images | $(GREP) $(shell basename "`pwd`") \
 		| $(AWK) '{ print $$3 }' \
 		| $(XARGS) -rn1 $(DOCKER) rmi -f
 endif
 
 distclean: clean clean-containers clean-images
 
-shell: install
+shell:
 	# Run an interactive shell on the container
 	@$(call run-shell,$(BASH) -i)
 
-shell-irb: install
+shell-irb:
 	# Run an interactive IRB shell on the container
 	@$(call run-shell,bin/console)
 
-docs: install
+docs:
 	# Build the API documentation
 	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
 		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
 
-notes: install
+notes:
 	# Print the code statistics (library and test suite)
 	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
 
-stats: install
+stats:
 	# Print all the notes from the code
 	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
 

data/README.md

@@ -1,10 +1,10 @@
 ![rimless](doc/assets/project.svg)
 
-[![Build Status](https://travis-ci.com/hausgold/rimless.svg?token=4XcyqxxmkyBSSV3wWRt7&branch=master)](https://travis-ci.com/hausgold/rimless)
+[![Continuous Integration](https://github.com/hausgold/rimless/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/rimless/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/rimless.svg)](https://badge.fury.io/rb/rimless)
-[![Maintainability](https://api.codeclimate.com/v1/badges/0d51996b52def6cf0262/maintainability)](https://codeclimate.com/repos/5cb06f700f7b09026e00a896/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/0d51996b52def6cf0262/test_coverage)](https://codeclimate.com/repos/5cb06f700f7b09026e00a896/test_coverage)
-[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/rimless)
+[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/rimless/coverage.svg)](https://knowledge.hausgold.de/coverage)
+[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/rimless/ratio.svg)](https://knowledge.hausgold.de/coverage)
+[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/rimless/documentation.svg)](https://www.rubydoc.info/gems/rimless)
 
 This project is dedicated to ship a ready to use [Apache
 Kafka](https://kafka.apache.org/) / [Confluent Schema
@@ -575,6 +575,13 @@ describe 'message producer job' do
         .with(key: user.id, topic: 'test.identity-api.users').twice
         .with_data(firstname: 'John', lastname: 'Doe').twice
   end
+
+  it 'allows to capture messages to check them in detail' do
+    (capture_kafka_messages { action }).tap do |messages|
+      expect(messages.first[:data]).to \
+        match(a_hash_including('entity' => a_hash_including('items' => items)))
+    end
+  end
 end
 ```
 

data/Rakefile

@@ -2,75 +2,23 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rails/code_statistics'
-require 'pp'
+require 'countless/rake_tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-# Load some railties tasks
-load 'rails/tasks/statistics.rake'
-load 'rails/tasks/annotations.rake'
-
-# Clear the default statistics directory constant
-#
-# rubocop:disable Style/MutableConstant because we define it
-Object.send(:remove_const, :STATS_DIRECTORIES)
-::STATS_DIRECTORIES = []
-# rubocop:enable Style/MutableConstant
-
-# Monkey patch the Rails +CodeStatistics+ class to support configurable
-# patterns per path. This is reuqired to support top-level only file matches.
-class CodeStatistics
-  DEFAULT_PATTERN = /^(?!\.).*?\.(rb|js|coffee|rake)$/.freeze
-
-  # Pass the possible +pattern+ argument down to the
-  # +calculate_directory_statistics+ method call.
-  def calculate_statistics
-    Hash[@pairs.map do |pair|
-      [pair.first, calculate_directory_statistics(*pair[1..-1])]
-    end]
-  end
-
-  # Match the pattern against the individual file name and the relative file
-  # path. This allows top-level only matches.
-  def calculate_directory_statistics(directory, pattern = DEFAULT_PATTERN)
-    stats = CodeStatisticsCalculator.new
-
-    Dir.foreach(directory) do |file_name|
-      path = "#{directory}/#{file_name}"
-
-      if File.directory?(path) && (/^\./ !~ file_name)
-        stats.add(calculate_directory_statistics(path, pattern))
-      elsif file_name =~ pattern || path =~ pattern
-        stats.add_by_file_path(path)
-      end
-    end
-
-    stats
-  end
-end
-
 # Configure all code statistics directories
-vendors = [
-  [:unshift, 'RSpec matchers', 'lib/rimless/rspec'],
-  [:unshift, 'RSpec matchers specs', 'spec/rimless/rspec'],
-
-  [:unshift, 'Top-levels', 'lib', %r{lib(/rimless)?/[^/]+\.rb$}],
-  [:unshift, 'Top-levels specs', 'spec',
-   %r{spec/rimless(_spec\.rb|/[^/]+\.rb$)}]
-].reverse
-
-vendors.each do |method, type, dir, pattern|
-  ::STATS_DIRECTORIES.send(method, [type, dir, pattern].compact)
-  ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
-end
-
-# Setup annotations
-ENV['SOURCE_ANNOTATION_DIRECTORIES'] = 'spec,doc'
-
-desc 'Enumerate all annotations'
-task :notes do
-  SourceAnnotationExtractor.enumerate '@?OPTIMIZE|@?FIXME|@?TODO', tag: true
+Countless.configure do |config|
+  config.stats_base_directories = [
+    { name: 'Top-levels', dir: 'lib',
+      pattern: %r{/lib(/rimless)?/[^/]+\.rb$} },
+    { name: 'Top-levels specs', test: true, dir: 'spec',
+      pattern: %r{/spec(/rimless)?/[^/]+_spec\.rb$} },
+    { name: 'RSpec matchers', pattern: 'lib/rimless/rspec/**/*.rb' },
+    { name: 'RSpec matchers specs', test: true,
+      pattern: 'spec/rimless/rspec/**/*_spec.rb' },
+    { name: 'Rake Tasks', pattern: 'lib/rimless/tasks/**/*' },
+    { name: 'Karafka Extensions', pattern: 'lib/rimless/karafka/**/*.rb' }
+  ]
 end

data/doc/kafka-playground/.gitignore

@@ -0,0 +1,2 @@
+log
+vendor/bundle

data/doc/kafka-playground/Dockerfile

@@ -0,0 +1,41 @@
+FROM hausgold/ruby:2.5
+MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
+
+# Update system gem
+RUN gem update --system
+
+# Add backports repository
+RUN echo 'deb http://ftp.debian.org/debian buster-backports main' \
+  >> /etc/apt/sources.list
+
+# Install nodejs 16
+RUN curl -sL https://deb.nodesource.com/setup_16.x | bash -
+
+# Install system packages and the ruby bundless
+RUN apt-get update -yqqq && \
+  apt-get install -y \
+    build-essential nodejs locales sudo vim \
+    ca-certificates jq curl cmake \
+    bash-completion inotify-tools && \
+  echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
+  gem install bundler --no-document --no-prerelease
+
+# Install kcat (formerly known as kafkacat)
+RUN curl -sL https://github.com/edenhill/kcat/archive/refs/tags/1.7.0.tar.gz \
+  | tar xfvz - -C /tmp && cd /tmp/kcat-* && ./bootstrap.sh && \
+  mv kcat /usr/local/bin && cd / && rm -rf /tmp/kcat-*
+
+# Add new app user
+RUN mkdir /app && \
+  adduser app --home /home/app --shell /bin/bash \
+    --disabled-password --gecos ""
+ADD config/docker/shell/ /home/app/
+RUN chown app:app -R /app /home/app /usr/local/bundle && \
+  mkdir -p /home/app/.ssh && \
+  sudo -HEu app bash -c 'bundle config set system "true"'
+
+# Set the root password and grant root access to app
+RUN echo 'root:root' | chpasswd
+RUN echo 'app ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+
+WORKDIR /app

data/doc/kafka-playground/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# A bundle of opinionated Apache Kafka / Confluent Schema Registry helpers.
+gem 'rimless', '~> 1.2'
+# Thor is a toolkit for building powerful command-line interfaces.
+gem 'thor', '~> 1.1'