msgr 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13657fc492608f204e15feb6dd99b4201ae0de4972c6251970009fecab1f4343
-  data.tar.gz: 99b4dbd131d80b3d1ab7b638b78af8a3ec91d43f3a18f30bc7bec073cdd1c89d
+  metadata.gz: d505941f2c4bf678a5d8c5185b2d65c510fcc08aa818eca251e83e8f0225b178
+  data.tar.gz: 3f78955ee1074190d7fa63384294ae1b09802fcb362645b2aa52b79062ab9057
 SHA512:
-  metadata.gz: 7097dd99d5ce3ebfe81763a9a49775ba8605ceca1695d6b736baa0db6057d1c94b0e7d5d1349d9c7df0783c3a26a858a2ee659766a06846bd914bc0fdd75982b
-  data.tar.gz: 0ddde917911e057af0c55d0adc69e26aa4d76c8086df2aea35b7d519715555a4c06544e9befd835f3d638f40dcd6fa480f3dfbdd5e74d0c04b5c230c9d68c074
+  metadata.gz: e421518963ac9b653faaab3da418687a96b4a7b91dfd931e7afc8d3166b247c711a2e6eb199bcef6fc0e83d970308b2998a152b80e32b3bc1d7f248af5fd161d
+  data.tar.gz: 776b325f75779d39ad2c254020082da70ef4bf5a0dc1ec601c392546472315b29cfc0821718f94491d023077d1d84c7617b15ed808b9fa3f9b2aef1de56dd151

data/.github/workflows/test.yml

@@ -0,0 +1,83 @@
+name: test
+on: [push]
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}
+    runs-on: ubuntu-22.04
+
+    strategy:
+      matrix:
+        ruby:
+          - "3.2"
+          - "3.1"
+          - "3.0"
+          - "2.7"
+        gemfile:
+          - rails_5.2.gemfile
+          - rails_6.0.gemfile
+          - rails_6.1.gemfile
+          - rails_7.0.gemfile
+        exclude:
+          - ruby: "3.2"
+            gemfile: rails_5.2.gemfile
+          - ruby: "3.2"
+            gemfile: rails_6.0.gemfile
+          - ruby: "3.1"
+            gemfile: rails_5.2.gemfile
+          - ruby: "3.1"
+            gemfile: rails_6.0.gemfile
+          - ruby: "3.0"
+            gemfile: rails_5.2.gemfile
+      fail-fast: False
+
+    services:
+      rabbitmq:
+        image: rabbitmq:latest
+        options: >-
+          --health-cmd "rabbitmqctl node_health_check"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5672:5672
+
+    env:
+      AMQP_SERVER: amqp://localhost:5672
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 10
+      BUNDLE_WITHOUT: development
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: True
+
+      - name: Run unit tests
+        run: bundle exec rspec -Ispec/unit --color spec/unit
+
+      - name: Run integration tests
+        run: bundle exec rspec -Ispec/integration --color spec/integration
+
+  rubocop:
+    name: rubocop
+    runs-on: ubuntu-22.04
+
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 10
+      BUNDLE_WITHOUT: development
+
+    steps:
+      - uses: actions/checkout@master
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel --color

data/.gitignore

@@ -1,29 +1,29 @@
-*.gem
-*.rbc
+_yardoc
 .bundle
 .config
+.idea
+.rbx
+.rspec
 .yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
+*.gem
+*.iml
+*.lock
+*.log
+*.rbc
 coverage
 doc/
+InstalledFiles
 lib/bundler/man
 pkg
+pmip
 rdoc
+spec/integration/dummy/.generators
+spec/integration/dummy/.rakeTasks
+spec/integration/dummy/.sass-cache
+spec/integration/dummy/db/*.sqlite3
+spec/integration/dummy/db/*.sqlite3-journal
+spec/integration/dummy/tmp
 spec/reports
 test/tmp
 test/version_tmp
 tmp
-.idea
-pmip
-*.iml
-.rbx
-.rspec
-*.log
-spec/integration/dummy/db/*.sqlite3
-spec/integration/dummy/db/*.sqlite3-journal
-spec/integration/dummy/tmp
-spec/integration/dummy/.sass-cache
-spec/integration/dummy/.generators
-spec/integration/dummy/.rakeTasks

data/.markdownlint.yml

@@ -0,0 +1,22 @@
+# markdownlint config
+
+# The CHANGELOG contains duplicated headers by design
+MD024: false
+
+# MD013/line-length: disable line length for all. We prefer lines as
+# long as paragraph with in-editor line breaks.
+MD013: false
+
+# MD033/no-inline-html: allow often need tags
+MD033:
+  allowed_elements:
+    - figure
+    - figcaption
+
+# MD046/code-block-style: code block style conflicting with
+# admonitions...
+MD046: false
+
+# MD048/code-fence-style: code fence style
+MD048:
+  style: backtick

data/.rubocop.yml

@@ -1,8 +1,9 @@
 inherit_gem:
-  my-rubocop: default.yml
+  rubocop-config: default.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
+  SuggestExtensions: False
   Exclude:
     - gemfiles/**/*
     - spec/integration/dummy/**/*
@@ -11,3 +12,6 @@ AllCops:
 Layout/LineLength:
   Exclude:
     - spec/**/*
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 15

data/.vscode/ltex.dictionary.en-US.txt

@@ -0,0 +1 @@
+AMQP

data/Appraisals

@@ -1,18 +1,23 @@
 # frozen_string_literal: true
-# -*- mode: ruby -*-
 
-appraise 'rails-5.2' do
-  gem 'rails', '~> 5.2.0'
-end
+# vim: ft=ruby
 
-appraise 'rails-6.0' do
-  gem 'rails', '~> 6.0.0'
-end
+# appraise 'rails-5.2' do
+#   gem 'rails', '~> 5.2.0'
+# end
+
+# appraise 'rails-6.0' do
+#   gem 'rails', '~> 6.0.0'
+# end
 
 appraise 'rails-6.1' do
   gem 'rails', '~> 6.1.0'
 end
 
-appraise 'rails-master' do
+appraise 'rails-7.0' do
+  gem 'rails', '~> 6.1.0'
+end
+
+appraise 'rails-head' do
   gem 'rails', git: 'https://github.com/rails/rails', require: 'rails'
 end

data/CHANGELOG.md

@@ -1,54 +1,99 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.5.0] - 2023-08-16
+
+### Added
+
+- Support for Ruby 3.1 and 3.2
+
+### Changed
+
+- Drop support for Ruby < 2.7
+
+### Fixed
+
+- `TestPool#run` passing down keyword arguments
+
+## [1.4.0] - 2022-01-10
+
+### Added
+
+- Support for namespaced consumer classes in routes file (#48, #49)
+
+### Removed
+
+- Unused `Channel#reject` method
+
 ## [1.3.2] - 2021-09-21
+
 ### Fixed
+
 - Rake task `msgr:drain` ran before all routes were initialized (#44)
 
 ## [1.3.1] - 2020-12-16
+
 ### Fixed
+
 - Delay setting default options for correct relative routing file path
 
 ## [1.3.0] - 2020-12-16
+
 ### Added
+
 - Support and testing for Rails 6.1
 - Rake task for purging all known queues (#43)
 
 ### Changed
+
 - High-risk feature to autostart client in-process has been removed without replacement
 - Parsing config is more relaxed now but directly based on YAML boolean values
 
 ## [1.2.0] - 2019-06-27
+
 ### Added
+
 - Test support of Rails 5.2
 
 ### Changed
-- Serialize JSON using core JSON instead of MultiJson
+
+- Serialize JSON using core JSON instead of `MultiJson`
 - Remove application/text fallback for payload (#25)
 
 ## [1.1.0] - 2018-07-25
+
 ### Added
+
 - New command line runner
 
 ## [1.0.0] - 2017-12-29
+
 ### Changed
+
 - Configure prefetch per binding and disable auto ack in consumer for customized batch processing (#15)
 - Replace usage of deprecated exception class (#12)
 
 ## [0.15.2] - 2017-09-04
+
 ### Fixed
+
 - Fix regression in parsing `:uri` config with empty path
 
 ## [0.15.1] - 2017-07-31
+
 ### Fixed
+
 - Fix errors with additional configuration keys for AMQP connection (#13)
 
 ## [0.15.0] - 2017-03-30
+
 ### Added
+
 - Add new configuration option `:raise_exceptions` that can be used to enable
   exceptions being raised from consumers. Mostly useful for testing consumers.
   Defaults to `false`.
@@ -56,69 +101,101 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add methods for purging queues
 
 ### Changed
-- Rework TestPool timeout handling to not account processing time
+
+- Rework `TestPool` timeout handling to not account processing time
 
 ## [0.14.1] - 2016-02-17
+
 ### Fixed
+
 - Fix loading test pool source file
 
 ## [0.14.0] - 2016-02-17
+
 ### Added
+
 - Add experimental test pool (`Msgr::TestPool`)
 
 ## [0.13.0] - 2015-08-24
+
 ### Changed
+
 - Use `Rails.application.config_for` if available.
 
 ## [0.12.2] - 2015-01-14
+
 ### Changed
+
 - Do not delete the exchange on stop delete:true - as the exchange is changed
 
 ## [0.12.1] - 2014-11-06
+
 ### Changed
+
 - Loose dependency on bunny to allow `~> 1.4` for stone-age old RabbitMQ servers.
 
 ## [0.11.0-rc3] - 2014-04-11
+
 ### Added
-- Add checkcredentials config option to disable initial connect to rabbitmq
+
+- Add `checkcredentials` config option to disable initial connect to RabbitMQ
   server to check the credentials
 
 ### Changed
+
 - Define pool_class by string to make it useable with rails
 
 ## [0.11.0-rc2] - 2014-03-29
+
 ### Added
-- Add nack for messages when an error is rescued by dispatcher
+
+- Add `#nack` for messages when an error is rescued by dispatcher
 
 ## [0.11.0-rc1] - 2014-03-29
+
 ### Added
-- Add pool_class config to override pool classes used by dispatcher
+
+- Add `pool_class` config to override pool classes used by dispatcher
 
 ## [0.4.1] - 2014-03-18
+
 ### Fixed
+
 - Fix bug with empty routes on client start
 
 ## [0.4.0] - 2014-03-04
+
 ### Changed
-- Improve railtie and autostart code
+
+- Improve `Railtie` and autostart code
 
 ## 0.4.0 - 0.10.0
+
 ### Changed
+
 - Some lost history due to several crises
 
 ## [0.3.0] - 2014-03-03
+
 ### Added
+
 - Support for forking web servers like unicorn
 
 ## [0.2.1] - 2014-02-26
+
 ### Fixed
-- Fix wrong rails initializer code - was not use the config file
+
+- Fix wrong Rails initializer code - was not use the config file
 
 ## [0.2.0] - 2014-02-21
+
 ### Changed
+
 - Improve rails initializer code
 
-[Unreleased]: https://github.com/jgraichen/msgr/compare/v1.3.2...HEAD
+[Unreleased]: https://github.com/jgraichen/msgr/compare/v1.5.0...HEAD
+[1.5.0]: https://github.com/jgraichen/msgr/compare/v1.4.0...v1.5.0
+[1.4.0]: https://github.com/jgraichen/msgr/compare/v1.3.2...v1.4.0
 [1.3.2]: https://github.com/jgraichen/msgr/compare/v1.3.1...v1.3.2
 [1.3.1]: https://github.com/jgraichen/msgr/compare/v1.3.0...v1.3.1
 [1.3.0]: https://github.com/jgraichen/msgr/compare/v1.2.0...v1.3.0

data/Gemfile

@@ -4,11 +4,11 @@ source 'https://rubygems.org'
 
 gem 'appraisal'
 gem 'coveralls'
-gem 'my-rubocop', github: 'jgraichen/my-rubocop'
 gem 'rake'
 gem 'rake-release', '~> 1.1'
 gem 'rspec', '~> 3.0'
 gem 'rspec-rails'
+gem 'rubocop-config', github: 'jgraichen/rubocop-config', ref: 'v11', require: false
 
 gem 'rails'
 gem 'sqlite3'

data/README.md

@@ -1,34 +1,38 @@
-# Msgr: *Rails-like Messaging Framework*
+# Msgr: _Rails-like Messaging Framework_
 
-
-[![Gem Version](https://badge.fury.io/rb/msgr.svg)](http://badge.fury.io/rb/msgr)
-[![Build Status](https://travis-ci.org/jgraichen/msgr.svg?branch=master)](https://travis-ci.org/jgraichen/msgr)
-[![Build Status](https://github.com/jgraichen/msgr/workflows/Build/badge.svg?branch=master)](https://github.com/jgraichen/msgr/actions?query=workflow%3ABuild+branch%3Amaster)
+[![Gem](https://img.shields.io/gem/v/msgr?logo=rubygems)](https://rubygems.org/gems/msgr)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jgraichen/msgr/test.yml?branch=main&logo=github)](https://github.com/jgraichen/msgr/actions/workflows/test.yml)
 [![RubyDoc Documentation](http://img.shields.io/badge/rubydoc-here-blue.svg)](http://rubydoc.info/github/jgraichen/msgr/master/frames)
 
 You know it and you like it. Using Rails you can just declare your routes and
 create a controller. That's all you need to process requests.
 
-With *Msgr* you can do the same for asynchronous AMQP messaging. Just define
+With _Msgr_ you can do the same for asynchronous AMQP messaging. Just define
 your routes, create your consumer and watch your app processing messages.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'msgr'
+```ruby
+gem 'msgr', '~> 1.5'
+```
 
 And then execute:
 
-    $ bundle
+```console
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install msgr
+```console
+gem install msgr
+```
 
 ## Usage
 
-After adding 'msgr' to your gemfile create a `config/rabbitmq.yml` like this:
+After adding 'msgr' to your Gemfile create a `config/rabbitmq.yml` like this:
 
 ```yaml
 common: &common
@@ -83,7 +87,6 @@ end
 
 Run client daemon with `bundle exec msgr`.
 
-
 ## Advanced configuration
 
 ### Manual message acknowledgments
@@ -106,10 +109,9 @@ end
 
 Per default each message queue has a prefetch count of 1. This value can be changed when specifying the messaging routes:
 
- ```ruby
- route 'local.test.index', to: 'test#index', prefetch: 42
- ```
-
+```ruby
+route 'local.test.index', to: 'test#index', prefetch: 42
+```
 
 ## Testing
 
@@ -154,7 +156,6 @@ it 'executes the consumer' do
 end
 ```
 
-
 ## Contributing
 
 1. Fork it

data/gemfiles/rails_5.2.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "coveralls"
-gem "my-rubocop", github: "jgraichen/my-rubocop"
+gem "my-rubocop", github: "jgraichen/my-rubocop", ref: "v4"
 gem "rake"
+gem "rake-release", "~> 1.1"
 gem "rspec", "~> 3.0"
 gem "rspec-rails"
 gem "rails", "~> 5.2.0"

data/gemfiles/rails_6.0.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "coveralls"
-gem "my-rubocop", github: "jgraichen/my-rubocop"
+gem "my-rubocop", github: "jgraichen/my-rubocop", ref: "v4"
 gem "rake"
+gem "rake-release", "~> 1.1"
 gem "rspec", "~> 3.0"
 gem "rspec-rails"
 gem "rails", "~> 6.0.0"

data/gemfiles/rails_6.1.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "coveralls"
-gem "my-rubocop", github: "jgraichen/my-rubocop"
+gem "my-rubocop", github: "jgraichen/my-rubocop", ref: "v4"
 gem "rake"
+gem "rake-release", "~> 1.1"
 gem "rspec", "~> 3.0"
 gem "rspec-rails"
 gem "rails", "~> 6.1.0"

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "coveralls"
+gem "my-rubocop", github: "jgraichen/my-rubocop", ref: "v4"
+gem "rake"
+gem "rake-release", "~> 1.1"
+gem "rspec", "~> 3.0"
+gem "rspec-rails"
+gem "rails", "~> 6.1.0"
+gem "sqlite3"
+
+gemspec path: "../"

data/gemfiles/{rails_master.gemfile → rails_head.gemfile}

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "coveralls"
-gem "my-rubocop", github: "jgraichen/my-rubocop"
+gem "my-rubocop", github: "jgraichen/my-rubocop", ref: "v4"
 gem "rake"
+gem "rake-release", "~> 1.1"
 gem "rspec", "~> 3.0"
 gem "rspec-rails"
 gem "rails", git: "https://github.com/rails/rails", require: "rails"

data/lib/msgr/binding.rb

@@ -10,7 +10,7 @@ module Msgr
       :dispatcher,
       :queue,
       :route,
-      :subscription
+      :subscription,
     )
 
     def initialize(connection, route, dispatcher)
@@ -54,7 +54,7 @@ module Msgr
       rescue StandardError => e
         log(:error) do
           "Rescued error from subscribe: #{e.class.name}: " \
-          "#{e}\n#{e.backtrace.join("\n")}"
+            "#{e}\n#{e.backtrace.join("\n")}"
         end
       end
     end

data/lib/msgr/channel.rb

@@ -22,7 +22,7 @@ module Msgr
         @channel.topic(prefix(EXCHANGE_NAME), durable: true).tap do |ex|
           log(:debug) do
             "Created exchange #{ex.name} (type: #{ex.type}, " \
-                "durable: #{ex.durable?}, auto_delete: #{ex.auto_delete?})"
+              "durable: #{ex.durable?}, auto_delete: #{ex.auto_delete?})"
           end
         end
       end
@@ -32,7 +32,7 @@ module Msgr
       @channel.queue(prefix(name), durable: true, **opts).tap do |queue|
         log(:debug) do
           "Create queue #{queue.name} (durable: #{queue.durable?}, " \
-          "auto_delete: #{queue.auto_delete?})"
+            "auto_delete: #{queue.auto_delete?})"
         end
       end
     end
@@ -55,11 +55,6 @@ module Msgr
       log(:debug) { "Nacked message: #{delivery_tag}" }
     end
 
-    def reject(delivery_tag, requeue = true)
-      @channel.reject delivery_tag, requeue
-      log(:debug) { "Rejected message: #{delivery_tag}" }
-    end
-
     def close
       @channel.close if @channel.open?
     end

data/lib/msgr/cli.rb

@@ -41,17 +41,16 @@ module Msgr
       Signal.trap('INT') { w.puts 'INT' }
       Signal.trap('TERM') { w.puts 'TERM' }
 
-      Msgr.logger = Logger.new(STDOUT)
+      Msgr.logger = Logger.new($stdout)
       Msgr.client.start
 
-      while (readable = IO.select([r]))
-        case readable.first[0].gets.strip
-          when 'INT', 'TERM'
-            Msgr.client.stop
-            break
-          else
-            exit 1
-        end
+      # Wait until we receive a signal
+      r.wait_readable
+      case r.gets.strip
+        when 'INT', 'TERM' # Safe shutdown
+          Msgr.client.stop
+        else # Error
+          exit 1
       end
     end
 
@@ -65,20 +64,20 @@ module Msgr
       def parse(_argv)
         options = {
           require: Dir.pwd,
-          environment: 'development'
+          environment: 'development',
         }
 
         OptionParser.new do |o|
           o.on(
             '-r', '--require [PATH|DIR]',
-            'Location of Rails application (default to current directory)'
+            'Location of Rails application (default to current directory)',
           ) do |arg|
             options[:require] = arg
           end
 
           o.on(
             '-e', '--environment [env]',
-            'Rails environment (default to development)'
+            'Rails environment (default to development)',
           ) do |arg|
             options[:environment] = arg
           end