msgr 1.1.0.1.b306 → 1.3.2

data/lib/msgr/client.rb

@@ -2,15 +2,14 @@
 
 require 'uri'
 require 'cgi'
+require 'json'
 
 module Msgr
-  # rubocop:disable Metrics/ClassLength
   class Client
     include Logging
 
     attr_reader :config
 
-    # rubocop:disable MethodLength
     def initialize(config = {})
       @config = {
         host: '127.0.0.1',
@@ -18,21 +17,16 @@ module Msgr
         max: 2
       }
 
-      @config.merge! parse(config.delete(:uri)) if config.key?(:uri)
+      @config.merge! parse(config.delete(:uri)) if config[:uri]
       @config.merge! config.symbolize_keys
 
       @mutex  = ::Mutex.new
-      @routes = Routes.new
+      @routes = load_routes
       @pid ||= ::Process.pid
 
       log(:debug) { "Created new client on process ##{@pid}..." }
     end
-    # rubocop:enable all
 
-    # rubocop:disable AbcSize
-    # rubocop:disable MethodLength
-    # rubocop:disable PerceivedComplexity
-    # rubocop:disable CyclomaticComplexity
     def uri
       @uri = begin
         uri = ::URI.parse('amqp://localhost')
@@ -50,7 +44,6 @@ module Msgr
         uri
       end
     end
-    # rubocop:enable all
 
     def running?
       mutex.synchronize do
@@ -59,7 +52,6 @@ module Msgr
       end
     end
 
-    # rubocop:disable AbcSize
     def start
       mutex.synchronize do
         check_process!
@@ -67,12 +59,9 @@ module Msgr
 
         log(:debug) { "Start on #{uri}..." }
 
-        @routes << config[:routing_file] if config[:routing_file].present?
-        @routes.reload
         connection.bind(@routes)
       end
     end
-    # rubocop:enable all
 
     def connect
       mutex.synchronize do
@@ -85,7 +74,6 @@ module Msgr
       end
     end
 
-    # rubocop:disable AbcSize
     def stop(opts = {})
       mutex.synchronize do
         check_process!
@@ -100,7 +88,6 @@ module Msgr
         reset
       end
     end
-    # rubocop:enable all
 
     def purge(release: false)
       mutex.synchronize do
@@ -112,6 +99,15 @@ module Msgr
       end
     end
 
+    ##
+    # Purge all queues known to Msgr, if they exist.
+    #
+    def drain
+      @routes.each do |route|
+        connection.purge_queue(route.name)
+      end
+    end
+
     def publish(payload, opts = {})
       mutex.synchronize do
         check_process!
@@ -149,6 +145,7 @@ module Msgr
 
     def check_process!
       return if ::Process.pid == @pid
+
       log(:warn) do
         "Fork detected. Reset internal state. (Old PID: #{@pid} / " \
         "New PID: #{::Process.pid}"
@@ -178,22 +175,27 @@ module Msgr
       @dispatcher = nil
     end
 
-    # rubocop:disable AbcSize
     def parse(uri)
       # Legacy parsing of URI configuration; does not follow usual
       # AMQP vhost encoding but used regular URL path
       uri = ::URI.parse(uri)
 
       config = {}
-      config[:user]  ||= uri.user     if uri.user
-      config[:pass]  ||= uri.password if uri.password
-      config[:host]  ||= uri.host     if uri.host
-      config[:port]  ||= uri.port     if uri.port
-      config[:vhost] ||= uri.path     unless uri.path.empty?
+      config[:user] ||= uri.user if uri.user
+      config[:pass] ||= uri.password if uri.password
+      config[:host] ||= uri.host     if uri.host
+      config[:port] ||= uri.port     if uri.port
+      config[:vhost] ||= uri.path unless uri.path.empty?
       config[:ssl]   ||= uri.scheme.casecmp('amqps').zero?
 
       config
     end
-    # rubocop:enable all
+
+    def load_routes
+      Routes.new.tap do |routes|
+        routes << config[:routing_file] if config[:routing_file].present?
+        routes.reload
+      end
+    end
   end
 end

data/lib/msgr/connection.rb

@@ -3,7 +3,6 @@
 require 'bunny'
 
 module Msgr
-  # rubocop:disable Metrics/ClassLength
   class Connection
     include Logging
 
@@ -49,6 +48,7 @@ module Msgr
 
     def release
       return if bindings.empty?
+
       log(:debug) { "Release bindings (#{bindings.size})..." }
 
       bindings.each(&:release)
@@ -56,6 +56,7 @@ module Msgr
 
     def delete
       return if bindings.empty?
+
       log(:debug) { "Delete bindings (#{bindings.size})..." }
 
       bindings.each(&:delete)
@@ -63,11 +64,22 @@ module Msgr
 
     def purge(**kwargs)
       return if bindings.empty?
+
       log(:debug) { "Purge bindings (#{bindings.size})..." }
 
       bindings.each {|b| b.purge(**kwargs) }
     end
 
+    def purge_queue(name)
+      # Creating the queue in passive mode ensures that queues that do not exist
+      # won't be created just to purge them.
+      # That requires creating a new channel every time, as exceptions (on
+      # missing queues) invalidate the channel.
+      channel.queue(name, passive: true).purge
+    rescue Bunny::NotFound
+      nil
+    end
+
     def bindings
       @bindings ||= []
     end

data/lib/msgr/consumer.rb

@@ -5,6 +5,7 @@ module Msgr
     include Logging
 
     attr_reader :message
+
     delegate :payload, to: :@message
     delegate :action, to: :'@message.route'
     delegate :consumer, to: :'@message.consumer'
@@ -14,9 +15,7 @@ module Msgr
         @auto_ack || @auto_ack.nil?
       end
 
-      def auto_ack=(val)
-        @auto_ack = val
-      end
+      attr_writer :auto_ack
     end
 
     def dispatch(message)

data/lib/msgr/dispatcher.rb

@@ -27,9 +27,6 @@ module Msgr
       end
     end
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/CyclomaticComplexity
     def dispatch(message)
       consumer_class = Object.const_get message.route.consumer
 
@@ -37,17 +34,18 @@ module Msgr
 
       consumer_class.new.dispatch message
 
-      # Acknowledge message unless it is already acknowledged or auto_ack is disabled.
-      message.ack unless message.acked? or not consumer_class.auto_ack?
-    rescue => error
+      # Acknowledge message only if it is not already acknowledged and auto
+      # acknowledgment is enabled.
+      message.ack unless message.acked? || !consumer_class.auto_ack?
+    rescue StandardError => e
       message.nack unless message.acked?
 
       log(:error) do
-        "Dispatcher error: #{error.class.name}: #{error}\n" +
-          error.backtrace.join("\n")
+        "Dispatcher error: #{e.class.name}: #{e}\n" +
+          e.backtrace.join("\n")
       end
 
-      raise error if config[:raise_exceptions]
+      raise e if config[:raise_exceptions]
     ensure
       if defined?(ActiveRecord) &&
          ActiveRecord::Base.connection_pool.active_connection?

data/lib/msgr/logging.rb

@@ -3,7 +3,9 @@
 module Msgr
   module Logging
     def log(level)
+      # rubocop:disable Style/SafeNavigation - Msgr.logger can be false
       Msgr.logger.send(level) { "#{log_name} #{yield}" } if Msgr.logger
+      # rubocop:enable all
     end
 
     def log_name

data/lib/msgr/message.rb

@@ -11,8 +11,7 @@ module Msgr
       @payload       = payload
       @route         = route
 
-      # rubocop:disable Style/GuardClause
-      if content_type == 'application/json'
+      if content_type == 'application/json' # rubocop:disable Style/GuardClause
         @payload = JSON.parse(payload)
         @payload.symbolize_keys! if @payload.respond_to? :symbolize_keys!
       end

data/lib/msgr/railtie.rb

@@ -4,92 +4,31 @@ module Msgr
   class Railtie < ::Rails::Railtie
     config.msgr = ActiveSupport::OrderedOptions.new
 
-    if File.exist?("#{Rails.root}/app/consumers")
-      config.autoload_paths << File.expand_path("#{Rails.root}/app/consumers")
-    end
-
     initializer 'msgr.logger' do |app|
       app.config.msgr.logger ||= Rails.logger
     end
 
-    # Start msgr
     initializer 'msgr.start' do
       config.after_initialize do |app|
         Msgr.logger = app.config.msgr.logger
-
-        self.class.load app.config.msgr
+        self.class.load(app.config_for(:rabbitmq).symbolize_keys)
       end
     end
 
-    class << self
-      def load(rails_config)
-        cfg = parse_config load_config rails_config
-        return unless cfg # no config given -> does not load Msgr
-
-        Msgr.config = cfg
-        Msgr.client.connect if cfg[:checkcredentials]
-        Msgr.start if cfg[:autostart]
-      end
-
-      def parse_config(cfg)
-        unless cfg.is_a? Hash
-          Rails.logger.warn '[Msgr] Could not load rabbitmq config: Config must be a Hash'
-          return nil
-        end
-
-        unless cfg[Rails.env].is_a?(Hash)
-          Rails.logger.warn "Could not load rabbitmq config for environment \"#{Rails.env}\": is not a Hash"
-          return nil
-        end
-
-        cfg = HashWithIndifferentAccess.new cfg[Rails.env]
-        unless cfg[:uri]
-          raise ArgumentError.new('Could not load rabbitmq environment config: URI missing.')
-        end
-
-        case cfg[:autostart]
-          when true, 'true', 'enabled'
-            cfg[:autostart] = true
-          when false, 'false', 'disabled', nil
-            cfg[:autostart] = false
-          else
-            raise ArgumentError.new("Invalid value for rabbitmq config autostart: \"#{cfg[:autostart]}\"")
-        end
-
-        case cfg[:checkcredentials]
-          when true, 'true', 'enabled', nil
-            cfg[:checkcredentials] = true
-          when false, 'false', 'disabled'
-            cfg[:checkcredentials] = false
-          else
-            raise ArgumentError.new("Invalid value for rabbitmq config checkcredentials: \"#{cfg[:checkcredentials]}\"")
-        end
-
-        case cfg[:raise_exceptions]
-          when true, 'true', 'enabled'
-            cfg[:raise_exceptions] = true
-          when false, 'false', 'disabled', nil
-            cfg[:raise_exceptions] = false
-          else
-            raise ArgumentError.new("Invalid value for rabbitmq config raise_exceptions: \"#{cfg[:raise_exceptions]}\"")
-        end
-
-        cfg[:routing_file] ||= Rails.root.join('config/msgr.rb').to_s
-        cfg
-      end
-
-      def load_config(options)
-        if options.rabbitmq_config || !Rails.application.respond_to?(:config_for)
-          load_file options.rabbitmq_config || Rails.root.join('config', 'rabbitmq.yml')
-        else
-          conf = Rails.application.config_for :rabbitmq
-
-          {Rails.env.to_s => conf}
-        end
-      end
+    rake_tasks do
+      load File.expand_path('tasks/msgr/drain.rake', __dir__)
+    end
 
-      def load_file(path)
-        YAML.safe_load ERB.new(File.read(path)).result
+    class << self
+      def load(config)
+        # Set defaults
+        config.reverse_merge!(
+          checkcredentials: true,
+          routing_file: Rails.root.join('config/msgr.rb').to_s
+        )
+
+        Msgr.config = config
+        Msgr.client.connect if config.fetch(:checkcredentials)
       end
     end
   end

data/lib/msgr/route.rb

@@ -4,10 +4,7 @@ module Msgr
   class Route
     attr_reader :consumer, :action, :opts
 
-    MATCH_REGEXP = /\A(?<consumer>\w+)#(?<action>\w+)\z/
-
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
+    MATCH_REGEXP = /\A(?<consumer>\w+)#(?<action>\w+)\z/.freeze
     def initialize(key, opts = {})
       @opts = opts
       raise ArgumentError.new 'Missing `to` options.' unless @opts[:to]

data/lib/msgr/routes.rb

@@ -3,7 +3,9 @@
 module Msgr
   class Routes
     include Logging
+
     attr_reader :routes
+
     delegate :each, :empty?, :size, :any?, to: :@routes
 
     def initialize

data/lib/msgr/tasks/msgr/drain.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+namespace :msgr do
+  desc 'Drain all known queues'
+  task drain: :environment do
+    client = Msgr.client
+
+    client.connect
+    client.drain
+  end
+end

data/lib/msgr/test_pool.rb

@@ -31,8 +31,6 @@ module Msgr
 
     private
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
     def ns_run(count: 1, timeout: 5)
       received = 0
 
@@ -59,7 +57,7 @@ module Msgr
 
     class << self
       def new(*args)
-        @instance ||= super(*args)
+        @instance ||= super(*args) # rubocop:disable Naming/MemoizedInstanceVariableName
       end
 
       def run(*args)

data/lib/msgr/version.rb

@@ -3,8 +3,8 @@
 module Msgr
   module VERSION
     MAJOR = 1
-    MINOR = 1
-    PATCH = 0
+    MINOR = 3
+    PATCH = 2
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
 

data/lib/msgr.rb

@@ -26,6 +26,7 @@ require 'msgr/railtie' if defined? Rails
 module Msgr
   class << self
     attr_writer :client, :config
+
     delegate :publish, to: :client
 
     def config

data/msgr.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'msgr/version'
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'msgr'
   spec.version       = Msgr::VERSION
   spec.authors       = ['Jan Graichen']
-  spec.email         = ['jg@altimos.de']
+  spec.email         = ['jgraichen@altimos.de']
   spec.description   = 'Msgr: Rails-like Messaging Framework'
   spec.summary       = 'Msgr: Rails-like Messaging Framework'
   spec.homepage      = 'https://github.com/jgraichen/msgr'
@@ -24,8 +24,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bunny', '>= 1.4', '< 3.0'
 
   spec.add_development_dependency 'bundler'
-
-  if ENV['TRAVIS_BUILD_NUMBER']
-    spec.version = "#{spec.version}.1.b#{ENV['TRAVIS_BUILD_NUMBER']}"
-  end
 end

data/scripts/simple_test.rb

@@ -19,7 +19,6 @@ class TestConsumer < Msgr::Consumer
   end
 end
 
-#
 class NullPool
   def initialize(*); end
 
@@ -45,9 +44,9 @@ end
 
 begin
   sleep
-rescue Interrupt
+rescue Interrupt # rubocop:disable Lint/SuppressedException
 ensure
   @client.stop timeout: 10, delete: true
 end
 
-$stderr.puts "COUNTER: #{@counter}"
+warn "COUNTER: #{@counter}"

data/spec/fixtures/msgr_routes_test_drain.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+route 'abc', to: 'consumer1#action1'
+route 'def', to: 'consumer1#action2'
+route 'ghi', to: 'consumer2#action1'

data/spec/integration/dummy/Rakefile

@@ -3,6 +3,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Dummy::Application.load_tasks

data/spec/integration/dummy/bin/bundle

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/spec/integration/dummy/bin/rails

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-APP_PATH = File.expand_path('../../config/application', __FILE__)
+APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'

data/spec/integration/dummy/config/application.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../boot', __FILE__)
+require File.expand_path('boot', __dir__)
 
 require 'rails/all'
 

data/spec/integration/dummy/config/boot.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
 
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/integration/dummy/config/environment.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Load the Rails application.
-require File.expand_path('../application', __FILE__)
+require File.expand_path('application', __dir__)
 
 # Initialize the Rails application.
 Dummy::Application.initialize!

data/spec/integration/dummy/config/rabbitmq.yml

@@ -1,5 +1,5 @@
 common: &common
-  uri: amqp://localhost/
+  uri: <%= ENV.fetch("AMQP_SERVER", "amqp://localhost/") %>
 
 test:
   <<: *common

data/spec/integration/msgr/dispatcher_spec.rb

@@ -4,7 +4,19 @@ require 'spec_helper'
 
 class DispatcherTestConsumer < Msgr::Consumer
   def index
-    puts "<<< #{payload}"
+    self.class.called!
+  end
+
+  class << self
+    def calls
+      @calls ||= 0
+    end
+
+    attr_writer :calls
+
+    def called!
+      self.calls += 1
+    end
   end
 end
 
@@ -19,55 +31,59 @@ describe Msgr::Dispatcher do
   let(:config) { {max: 1} }
   let(:consumer) { 'DispatcherTestConsumer' }
   let(:route) do
-    double(:route).tap do |t|
+    instance_double('Msgr::Route').tap do |t|
       allow(t).to receive(:consumer).and_return consumer
       allow(t).to receive(:action).and_return 'index'
     end
   end
   let(:channel) do
-    double(:channel).tap do |c|
+    instance_double('Msgr::Channel').tap do |c|
       allow(c).to receive(:ack)
     end
   end
   let(:delivery_info) do
-    double(:delivery_info).tap do |ti|
+    instance_double('Bunny::DeliveryInfo').tap do |ti|
       allow(ti).to receive(:delivery_tag).and_return(3)
     end
   end
   let(:payload) { {} }
   let(:metadata) do
-    double(:metadata).tap do |metadata|
+    instance_double('Bunny::MessageProperties').tap do |metadata|
       allow(metadata).to receive(:content_type).and_return('text/plain')
     end
   end
   let(:message) { Msgr::Message.new channel, delivery_info, metadata, payload, route }
   let(:action) { -> { dispatcher.call message } }
 
-  it 'should consume message' do
-    expect_any_instance_of(DispatcherTestConsumer).to receive(:index)
-    dispatcher.call message
+  it 'consumes message' do
+    expect do
+      dispatcher.call message
+    end.to change(DispatcherTestConsumer, :calls).by(1)
   end
 
   context 'with not acknowledged message' do
-    before { dispatcher.call message }
     subject { message }
-    it { should be_acked }
+
+    before { dispatcher.call message }
+
+    it { is_expected.to be_acked }
   end
 
   describe 'exception swallowing' do
     let(:consumer) { 'DispatcherRaiseConsumer' }
+
     before do
       allow(message).to receive(:nack)
     end
 
-    it 'should swallow exceptions by default' do
+    it 'swallows exceptions by default' do
       expect { dispatcher.call(message) }.not_to raise_error
     end
 
     context 'with raise_exceptions configuration option and a synchronous pool' do
       let(:config) { super().merge(raise_exceptions: true) }
 
-      it 'should raise the exception' do
+      it 'raises the exception' do
         expect { dispatcher.call(message) }.to raise_error(ArgumentError)
       end
     end