msgr 1.2.0 → 1.4.0

data/lib/msgr/channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Msgr
   class Channel
     include Logging
@@ -20,17 +22,17 @@ 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
     end
 
-    def queue(name)
-      @channel.queue(prefix(name), durable: true).tap do |queue|
+    def queue(name, **opts)
+      @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
@@ -53,13 +55,8 @@ 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
   end
-end
+end

data/lib/msgr/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optionparser'
 
 module Msgr
@@ -8,7 +10,8 @@ module Msgr
       @options = options
 
       if !File.exist?(options[:require]) ||
-          (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
+         (File.directory?(options[:require]) &&
+         !File.exist?("#{options[:require]}/config/application.rb"))
         raise <<~ERR
           Rails application or required ruby file not found: #{options[:require]}
         ERR
@@ -22,15 +25,13 @@ module Msgr
         require 'rails'
         if ::Rails::VERSION::MAJOR == 4
           require File.expand_path("#{options[:require]}/config/application.rb")
-          ::Rails::Application.initializer "msgr.eager_load" do
+          ::Rails::Application.initializer 'msgr.eager_load' do
             ::Rails.application.config.eager_load = true
           end
-          require 'msgr/railtie'
-          require File.expand_path("#{options[:require]}/config/environment.rb")
-        else
-          require 'msgr/railtie'
-          require File.expand_path("#{options[:require]}/config/environment.rb")
         end
+
+        require 'msgr/railtie'
+        require File.expand_path("#{options[:require]}/config/environment.rb")
       else
         require(options[:require])
       end
@@ -40,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
+      readable = IO.select([r])
+      case readable.first[0].gets.strip
+        when 'INT', 'TERM' # Safe shutdown
+          Msgr.client.stop
+        else # Error
+          exit 1
       end
     end
 
@@ -61,18 +61,24 @@ module Msgr
 
       private
 
-      def parse(argv)
+      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)' do |arg|
+          o.on(
+            '-r', '--require [PATH|DIR]',
+            'Location of Rails application (default to current directory)',
+          ) do |arg|
             options[:require] = arg
           end
 
-          o.on '-e', '--environment [env]', 'Rails environment (default to development)' do |arg|
+          o.on(
+            '-e', '--environment [env]',
+            'Rails environment (default to development)',
+          ) do |arg|
             options[:environment] = arg
           end
         end.parse!

data/lib/msgr/client.rb

@@ -2,37 +2,31 @@
 
 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',
         vhost: '/',
-        max: 2
+        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,9 +145,10 @@ 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}"
+          "New PID: #{::Process.pid}"
       end
 
       reset
@@ -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
@@ -76,7 +88,7 @@ module Msgr
       if routes.empty?
         log(:warn) do
           "No routes to bound to. Bind will have no effect:\n" \
-          "  #{routes.inspect}"
+            "  #{routes.inspect}"
         end
       else
         bind_all(routes)

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 = %r{\A(?<consumer>(?:\w+/)*\w+)#(?<action>\w+)\z}.freeze
     def initialize(key, opts = {})
       @opts = opts
       raise ArgumentError.new 'Missing `to` options.' unless @opts[:to]
@@ -19,7 +16,7 @@ module Msgr
       unless result
         raise ArgumentError.new \
           "Invalid consumer format: #{opts[:to].strip.to_s.inspect}. " \
-          'Must be `consumer_class#action`.'
+          'Must be `name/space/consumer_class#action`.'
       end
 
       @consumer = "#{result[:consumer].camelize}Consumer"

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,7 +3,7 @@
 module Msgr
   module VERSION
     MAJOR = 1
-    MINOR = 2
+    MINOR = 4
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')

data/lib/msgr.rb

@@ -25,7 +25,8 @@ require 'msgr/railtie' if defined? Rails
 
 module Msgr
   class << self
-    attr_writer :client, :config
+    attr_writer :client, :config, :logger
+
     delegate :publish, to: :client
 
     def config
@@ -45,8 +46,6 @@ module Msgr
       @logger
     end
 
-    attr_writer :logger
-
     def start
       client.start
       client

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,23 +9,25 @@ 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'
   spec.license       = 'MIT'
 
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w[lib]
 
+  spec.required_ruby_version = '>= 2.5'
+
   spec.add_dependency 'activesupport'
   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/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

data/scripts/simple_test.rb

@@ -19,7 +19,6 @@ class TestConsumer < Msgr::Consumer
   end
 end
 
-#
 class NullPool
   def initialize(*); end
 
@@ -29,7 +28,7 @@ class NullPool
 end
 
 @client = Msgr::Client.new user: 'guest', password: 'guest',
-                           max: 4 # , pool_class: 'NullPool'
+  max: 4 # , pool_class: 'NullPool'
 
 @client.routes.configure do
   route 'abc.#', to: 'test#index'
@@ -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}"