msgr 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e99e52156e6545016340146893e7ccd3a252f2f9850f30c880497f3956723928
-  data.tar.gz: 79279c0f92e1889c18c93f54937927a815eeb93f0b4ec50c2a0da0da7404a300
+  metadata.gz: d1d1c4c93abd233370b3175719c7d41902637c1d8cae51223f86f3cd16611da9
+  data.tar.gz: 432388472168160b0bc1be0ee303656ab0776674d3178ac63f6c375a7395fb6c
 SHA512:
-  metadata.gz: 71069da32a4290f20921581a6a93c62e5490c656758ad871379cb06105bcdff4b9da85250c3d867d091a4576f30eac91e4933b5fdada452811457f8c380f4ce9
-  data.tar.gz: 4f93760bf39df80264a9b33e0bc2d016ccc0902d866850602820a83abd28771fd92165feefc4cbc02d168045e0deb9ee5c0a6c1b762b149aebd163064b277a45
+  metadata.gz: 11ce36e23b4a499aaaff01e67a1be9a91048e19e9c55cf0487491aef49d3343d1ead2cb854e4c1a1035319e524b764f62c4846e6632bac5fa81da9b7fb125329
+  data.tar.gz: 62e2a4460070ae90fe264f270cab8852f81d85f177e2fe77e8b730926f88a11dd651506cc1b5ef58fafefa3b23c1ea0889239beacd7ba6b8342d04d65e11e05c

data/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.github/workflows/test.yml

@@ -0,0 +1,79 @@
+name: test
+on: [push]
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        ruby:
+          - "3.0"
+          - "2.7"
+          - "2.6"
+          - "2.5"
+        gemfile:
+          - rails_5.2.gemfile
+          - rails_6.0.gemfile
+          - rails_6.1.gemfile
+          - rails_7.0.gemfile
+        exclude:
+          - ruby: "3.0"
+            gemfile: rails_5.2.gemfile
+          - ruby: "2.5"
+            gemfile: rails_7.0.gemfile
+          - ruby: "2.6"
+            gemfile: rails_7.0.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-20.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/.rubocop.yml

@@ -1,52 +1,17 @@
-AllCops:
-  TargetRubyVersion: 2.3
-
+inherit_gem:
+  my-rubocop: default.yml
 
-Metrics/BlockLength:
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: False
   Exclude:
-    - 'spec/**/*_spec.rb'
+    - gemfiles/**/*
+    - spec/integration/dummy/**/*
+    - vendor/**/*
 
-Metrics/LineLength:
+Layout/LineLength:
   Exclude:
-    - 'spec/**/*_spec.rb'
-
-
-Layout/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-  SupportedStyles:
-    - case
-    - end
-  IndentOneStep: true
-
-Layout/SpaceInsideBlockBraces:
-  EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: no_space
-  SpaceBeforeBlockParameters: false
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/RaiseArgs:
-  EnforcedStyle: compact
-
-Style/SafeNavigation:
-  Enabled: false # not available before 2.3
-
-Style/SignalException:
-  EnforcedStyle: only_raise
+    - spec/**/*
 
-Style/TrivialAccessors:
-  AllowPredicates: true
+RSpec/MultipleMemoizedHelpers:
+  Max: 15

data/Appraisals

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# vim: ft=ruby
+
+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-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,37 +1,85 @@
 # 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.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
 - 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`.
@@ -39,69 +87,103 @@ 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
 
 ## [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
   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
 
 ## [0.11.0-rc1] - 2014-03-29
+
 ### Added
+
 - 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 - 0.10.0
-### Changed
-- Some lost history due to several crises
+- Fix bug with empty routes on client start
 
 ## [0.4.0] - 2014-03-04
+
 ### Changed
+
 - 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
 
 ## [0.2.0] - 2014-02-21
+
 ### Changed
+
 - Improve rails initializer code
 
-[Unreleased]: https://github.com/jgraichen/msgr/compare/v1.2.0...HEAD
+[unreleased]: https://github.com/jgraichen/msgr/compare/v1.4.0...HEAD
+[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
 [1.2.0]: https://github.com/jgraichen/msgr/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/jgraichen/msgr/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/jgraichen/msgr/compare/v0.15.2...v1.0.0

data/Gemfile

@@ -2,22 +2,16 @@
 
 source 'https://rubygems.org'
 
-group :development, :test do
-  gem 'coveralls'
-  gem 'fuubar'
-  gem 'rake'
-  gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.72.0'
-end
+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'
 
-group :rails do
-  unless defined?(NO_RAILS_GEM)
-    gem 'rails', '>= 4.2'
-    gem 'sqlite3', '~> 1.3.6'
-  end
-
-  gem 'rspec-rails', require: false
-end
+gem 'rails'
+gem 'sqlite3'
 
 # Specify your gem's dependencies in acfs.gemspec
 gemspec

data/README.md

@@ -1,16 +1,13 @@
-# 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](http://img.shields.io/travis/jgraichen/msgr/master.svg)](https://travis-ci.org/jgraichen/msgr)
-[![Coverage Status](http://img.shields.io/coveralls/jgraichen/msgr/master.svg)](https://coveralls.io/r/jgraichen/msgr)
-[![Code Climate](http://img.shields.io/codeclimate/github/jgraichen/msgr.svg)](https://codeclimate.com/github/jgraichen/msgr)
+[![Gem](https://img.shields.io/gem/v/msgr?logo=rubygems)](https://rubygems.org/gems/msgr)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jgraichen/msgr/test?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
@@ -82,16 +79,18 @@ class TestController < ApplicationController
 end
 ```
 
+Run client daemon with `bundle exec msgr`.
+
 ## Advanced configuration
 
-### Manual message acknowledgement
+### Manual message acknowledgments
 
-Per default messages are automatically acknowledged, if no (n)ack is sent explicitly by the consumer. This can be disabled by setting the `auto_ack` attribute to `false`. 
+Per default messages are automatically acknowledged, if no (n)ack is sent explicitly by the consumer. This can be disabled by setting the `auto_ack` attribute to `false`.
 
 ```ruby
 class TestConsumer < Msgr::Consumer
   self.auto_ack = false
-  
+
   def index
     data = { fuubar: 'abc' }
 
@@ -100,29 +99,14 @@ class TestConsumer < Msgr::Consumer
 end
 ```
 
-
 ### Prefetch count
 
 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
- ```
-
-### Msgr and fork web server like unicorn
-
-Per default msgr opens the rabbitmq connect when rails is loaded. If you use a multi-process web server that preloads the application (like unicorn) will lead to unexpected behavior. In this case adjust `config/rabbitmq.yml` and adjust `autostart = false`:
-
-
-```yaml
-common: &common
-  uri: amqp://localhost/
-  autostart: false
+```ruby
+route 'local.test.index', to: 'test#index', prefetch: 42
 ```
 
-And call inside each worker `Msgr.start` - e.g. in an after-fork block
-
-
 ## Testing
 
 ### Recommended configuration
@@ -166,7 +150,6 @@ it 'executes the consumer' do
 end
 ```
 
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -7,26 +7,30 @@ rescue LoadError
 end
 
 require 'rake'
-require 'bundler/gem_tasks'
+require 'rake/release/task'
 require 'rspec/core/rake_task'
 
+Rake::Release::Task.new do |spec|
+  spec.sign_tag = true
+end
+
 # Delegate spec task task to spec:all to run all specs.
 task spec: 'spec:all'
 
 desc 'Run all specs'
 namespace :spec do
   desc 'Run all msgr specs and all integration specs.'
-  task all: %i[msgr integration]
+  task all: %i[unit integration]
 
   desc 'Run all unit specs.'
-  RSpec::Core::RakeTask.new(:msgr) do |t|
-    t.ruby_opts = '-Ispec/support -rsetup -Ispec/msgr'
-    t.pattern = 'spec/msgr/**/*_spec.rb'
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.ruby_opts = '-Ispec/unit'
+    t.pattern = 'spec/unit/**/*_spec.rb'
   end
 
   desc 'Run all integration specs.'
   RSpec::Core::RakeTask.new(:integration) do |t|
-    t.ruby_opts = '-Ispec/support -rsetup -Ispec/integration'
+    t.ruby_opts = '-Ispec/integration'
     t.pattern = 'spec/integration/**/*_spec.rb'
   end
 end

data/bin/msgr

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'msgr/cli'
 

data/gemfiles/rails_5.2.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: "v3"
+gem "rake"
+gem "rake-release", "~> 1.1"
+gem "rspec", "~> 3.0"
+gem "rspec-rails"
+gem "rails", "~> 5.2.0"
+gem "sqlite3"
+
+gemspec path: "../"

data/gemfiles/rails_6.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: "v3"
+gem "rake"
+gem "rake-release", "~> 1.1"
+gem "rspec", "~> 3.0"
+gem "rspec-rails"
+gem "rails", "~> 6.0.0"
+gem "sqlite3"
+
+gemspec path: "../"

data/gemfiles/rails_6.1.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: "v3"
+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_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: "v3"
+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_head.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: "v3"
+gem "rake"
+gem "rake-release", "~> 1.1"
+gem "rspec", "~> 3.0"
+gem "rspec-rails"
+gem "rails", git: "https://github.com/rails/rails", require: "rails"
+gem "sqlite3"
+
+gemspec path: "../"

data/lib/msgr/binding.rb

@@ -4,7 +4,14 @@ module Msgr
   class Binding
     include Logging
 
-    attr_reader :queue, :subscription, :connection, :channel, :route, :dispatcher
+    attr_reader(
+      :channel,
+      :connection,
+      :dispatcher,
+      :queue,
+      :route,
+      :subscription,
+    )
 
     def initialize(connection, route, dispatcher)
       @connection = connection
@@ -43,13 +50,11 @@ module Msgr
 
     def subscribe
       @subscription = queue.subscribe(manual_ack: true) do |*args|
-        begin
-          dispatcher.call Message.new(channel, *args, route)
-        rescue => err
-          log(:error) do
-            "Rescued error from subscribe: #{err.class.name}: " \
-            "#{err}\n#{err.backtrace.join("\n")}"
-          end
+        dispatcher.call Message.new(channel, *args, route)
+      rescue StandardError => e
+        log(:error) do
+          "Rescued error from subscribe: #{e.class.name}: " \
+            "#{e}\n#{e.backtrace.join("\n")}"
         end
       end
     end