rimless 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d94b5db1c219992a8e7f2470a33c5c260065d19ad9c678fdbe7c34d8d7eac5ef
-  data.tar.gz: 208ec10f307dc7b777b656cdeb0c5e959cbc1cc33206fe62cc7655e59823b1cd
+  metadata.gz: a6e582f19428db0fcb6ab242b81bb51fd465bfeef48c927fbc692384c672b533
+  data.tar.gz: c61759fa3351deb5fcaff4f4381720e93e908df13172d8b1327bb0408c7b94a3
 SHA512:
-  metadata.gz: 999b3384beea7efb59e9a78a12b721d15f5333ae0ed8f8dc2d5462301a179430083c6947507ca05308370257d6a822ff8b7787db08fc353e609bf00d6d0a068b
-  data.tar.gz: 26f9863a2d2252007027d4f3229f1c1883e0156cb12d56941fde1f203b4eb7057a7f5fb5ce5a8a76d810f923e7940a71ac198b82ec70c2c9599abbc2d5cee838
+  metadata.gz: 481fcbe51c58b8ed614ca65ad47cdb95d534ffce6b30b7ce86c636159df885212bef01a777655f26b4bd13e08aa05b94a98787f709c3a680712be67117881038
+  data.tar.gz: 62e61b02251048d64f3f508adea01b60cffc7fddeafed7375b9424223af6b683843a392d10130b2a454c2acd5d4c0c9180f59ab49bc2472d7ab0059f5e503002

data/.github/workflows/documentation.yml

@@ -25,6 +25,7 @@ jobs:
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/gem-test
 

data/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+run-name: Release ${{ github.event.inputs.VERSION }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        description: The new version to release. (eg. `1.0.0`) Check the
+          changelog for the latest version.
+
+concurrency:
+  group: '${{ github.event.inputs.VERSION }}'
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Release the gem
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Ruby 2.5
+        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_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Switch to SSH remotes for the Git repository
+        run: git-ssh-remotes
+
+      - name: Enforce version '${{ github.event.inputs.VERSION }}'
+        run: set-gem-version '${{ github.event.inputs.VERSION }}'
+
+      - name: Prepare the Git release commit
+        run: git-release-commit '${{ github.event.inputs.VERSION }}'
+
+      - name: Push the release Git commit/tag and package to the registry
+        run: make release

data/.github/workflows/test.yml

@@ -36,6 +36,7 @@ jobs:
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/gem-test
 
@@ -56,6 +57,7 @@ jobs:
         uses: hausgold/actions/ci@master
         with:
           clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings_secret_key: '${{ secrets.SETTINGS_SECRET_KEY }}'
           settings: '${{ github.repository }}'
           target: ci/noop
 

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### next
+
+* TODO: Replace this bullet point with an actual description of a change.
+
+### 1.4.1
+
+* Moved the development dependencies from the gemspec to the Gemfile (#29)
+* Pinned Karafka gem <1.4.15 in order to suppress the
+  `I_ACCEPT_CRITICAL_ERRORS_IN_KARAFKA_1_4=true` agony (#30)
+
+### 1.4.0
+
+* Added support for Gem release automation
+
 ### 1.3.0
 
 * Bundler >= 2.3 is from now on required as minimal version (#19)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at development@hausgold.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -6,3 +6,22 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in grape-jwt-authentication.gemspec
 gemspec
+
+# Development dependencies
+gem 'appraisal', '~> 2.4'
+gem 'bundler', '~> 2.3'
+gem 'countless', '~> 1.1'
+gem 'factory_bot', '~> 6.2'
+gem 'guard-rspec', '~> 4.7'
+gem 'railties', '>= 5.2'
+gem 'rake', '~> 13.0'
+gem 'redcarpet', '~> 3.5'
+gem 'rspec', '~> 3.12'
+gem 'rubocop', '~> 1.28'
+gem 'rubocop-rails', '~> 2.14'
+gem 'rubocop-rspec', '~> 2.10'
+gem 'simplecov', '>= 0.22'
+gem 'timecop', '>= 0.9.6'
+gem 'vcr', '~> 6.0'
+gem 'yard', '>= 0.9.28'
+gem 'yard-activesupport-concern', '>= 0.0.1'

data/README.md

@@ -32,7 +32,9 @@ opinionated framework which sets up solid conventions for producing messages.
     - [Handling of schemaless deep blobs](#handling-of-schemaless-deep-blobs)
   - [Writing tests for your messages](#writing-tests-for-your-messages)
 - [Development](#development)
+- [Code of Conduct](#code-of-conduct)
 - [Contributing](#contributing)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -587,17 +589,28 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`bundle exec rake spec` to run the tests. You can also run `bin/console` for an
+After checking out the repo, run `make install` to install dependencies. Then,
+run `make test` to run the tests. You can also run `make shell-irb` for an
 interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+## Code of Conduct
+
+Everyone interacting in the project codebase, issue tracker, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](./CODE_OF_CONDUCT.md).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/hausgold/rimless.
+https://github.com/hausgold/rimless. Make sure that every pull request adds
+a bullet point to the [changelog](./CHANGELOG.md) file with a reference to the
+actual pull request.
+
+## Releasing
+
+The release process of this Gem is fully automated. You just need to open the
+Github Actions [Release
+Workflow](https://github.com/hausgold/rimless/actions/workflows/release.yml)
+and trigger a new run via the **Run workflow** button. Insert the new version
+number (check the [changelog](./CHANGELOG.md) first for the latest release) and
+you're done.

data/gemfiles/rails_5.2.gemfile

@@ -2,7 +2,23 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 5.2.0"
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.3"
+gem "countless", "~> 1.1"
+gem "factory_bot", "~> 6.2"
+gem "guard-rspec", "~> 4.7"
 gem "railties", "~> 5.2.0"
+gem "rake", "~> 13.0"
+gem "redcarpet", "~> 3.5"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.28"
+gem "rubocop-rails", "~> 2.14"
+gem "rubocop-rspec", "~> 2.10"
+gem "simplecov", ">= 0.22"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "activesupport", "~> 5.2.0"
 
 gemspec path: "../"

data/lib/rimless/version.rb

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

data/rimless.gemspec

@@ -37,29 +37,11 @@ Gem::Specification.new do |spec|
 
   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', '~> 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 '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_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 '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.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Hermann Mayer
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,6 +45,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.4.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,6 +55,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.4.15
 - !ruby/object:Gem::Dependency
   name: karafka-sidekiq-backend
   requirement: !ruby/object:Gem::Requirement
@@ -136,244 +142,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.18'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.6
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.28
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        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.
 email:
 - hermann.mayer92@gmail.com
@@ -383,6 +151,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".github/workflows/documentation.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -391,6 +160,7 @@ files:
 - ".yardopts"
 - Appraisals
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Dockerfile
 - Envfile
 - Gemfile
@@ -459,7 +229,7 @@ files:
 - lib/rimless/version.rb
 - log/development.log
 - rimless.gemspec
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata:
@@ -468,7 +238,7 @@ metadata:
   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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -483,8 +253,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: A bundle of opinionated Apache Kafka / Confluent Schema Registry helpers.
 test_files: []