jackhammer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24bc68715c2aa86d9452a0c4e4ac0cf3ca7505d1e985a1f109d67b74a497d03c
-  data.tar.gz: dcc42e3bef975c828c73ca65cdab23c921c258977e6692fb522c00ef98a2eb51
+  metadata.gz: b05bbadd40bdcdbf69d7ed079f5da3b5ef7494e5cfab42288b0e114aa1effb7c
+  data.tar.gz: 4db8060a85601dae226889a134531c48bf4b2b389b399f9bf782985f6909dd03
 SHA512:
-  metadata.gz: 174982c352090d5bde707a1d4046093fa356512bfc2b5b9754ebe49d8e7ee3f02624719ee87567a7930ef00a583532b816a490b95d8d5efba283dc823cc309ba
-  data.tar.gz: bc4423245e71589db053aba661a79ed2adb84e2fcbdf34187139c91c4e16942c2cd8dddb60c0824fe916f5487107342211a48305b143a914bf3b834a8804784a
+  metadata.gz: 3685542942aa0dcb6568bfa408a44015eeeade76268f610bd7a119feb8d6092e6c588dc846c7699325646ca86e6e242c7935b5eac1efa2e6334bdef1bfafcdd2
+  data.tar.gz: 16300121a91938775bf6f4a6e7e89cae0a4764653fc64e4e92f8c7a655be7e2953ff8a473a95f8d5205909150ac2226a641c7c687b06f30abff8e412c87a919e

data/.dependabot/config.yml

@@ -0,0 +1,18 @@
+version: 1
+
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "monthly"
+    commit_message:
+      prefix: "[dependabot]"
+    allowed_updates:
+      - match:
+          update_type: "all"
+    automerged_updates:
+      - match:
+          dependency_type: "development"
+          update_type: "all"
+      - match:
+          dependency_type: "production"
+          update_type: "all"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jackhammer (1.1.0)
+    jackhammer (1.2.0)
       bunny (~> 2.14)
 
 GEM
@@ -13,11 +13,11 @@ GEM
       amq-protocol (~> 2.3, >= 2.3.0)
     bunny-mock (1.7.0)
       bunny (>= 1.7)
-    byebug (11.0.1)
+    byebug (11.1.1)
     diff-lcs (1.3)
     jaro_winkler (1.5.4)
     parallel (1.19.1)
-    parser (2.6.5.0)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (13.0.1)
@@ -25,26 +25,26 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
     rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.78.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.1)
+    rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby
@@ -60,4 +60,4 @@ DEPENDENCIES
   rubocop-performance
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -36,12 +36,32 @@ default: &default
     auto_delete: false
     durable: true
     queues:
+      # queue_name => options pairs
       americas.south:
         auto_delete: true
         durable: false
         exclusive: false
         handler: "MyApp::SouthAmericaHandler"
         routing_key: "americas.south.#"
+      americas.north:
+        auto_delete: true
+        durable: false
+        exclusive: false
+        handler: "MyApp::NorthAmericaHandler"
+        routing_key: "americas.north.#"
+      # or an array
+      - queue_name: americas.south
+        auto_delete: true
+        durable: false
+        exclusive: false
+        handler: "MyApp::SouthAmericaHandler"
+        routing_key: "americas.south.#"
+      # queue_name can be skipped and auto generated from routing key
+      - auto_delete: true
+        durable: false
+        exclusive: false
+        handler: "MyApp::SouthAmericaHandler"
+        routing_key: "americas.south.#"
 
 development:
   <<: *default
@@ -70,6 +90,7 @@ module MyApp
       config.logger             = Logger.new(IO::NULL)
       config.publish_options    = { mandatory: true, persistent: true }
       config.yaml_config        = "config/jackhammer.yml"
+      config.app_name           = "my_app"
     end
   end
 end

data/lib/jackhammer.rb

@@ -7,6 +7,7 @@ require 'jackhammer/exceptions'
 require 'jackhammer/log'
 require 'jackhammer/configuration'
 require 'jackhammer/message_receiver'
+require 'jackhammer/queue_name'
 require 'jackhammer/queue'
 require 'jackhammer/topic'
 require 'jackhammer/topic_manager'

data/lib/jackhammer/configuration.rb

@@ -1,6 +1,7 @@
 module Jackhammer
   class Configuration
     attr_accessor(
+      :app_name,
       :connection_options,
       :connection_url,
       :environment,

data/lib/jackhammer/queue.rb

@@ -1,17 +1,19 @@
 module Jackhammer
   class Queue
-    def initialize(topic:, queue:, handler:, routing:)
+    attr_reader :queue, :handler_object
+
+    def initialize(topic:, queue:, handler:, routing_key:)
       @topic = topic
       @queue = queue
-      @queue.bind @topic, routing_key: routing
+      @queue.bind @topic, routing_key: routing_key
       @handler_object = handler
     end
 
     def subscribe
-      @queue.subscribe do |delivery_info, properties, content|
+      queue.subscribe do |delivery_info, properties, content|
         Log.info { [delivery_info.inspect, properties.inspect].join(' || ') }
         Log.debug { content }
-        @handler_object.call content
+        handler_object.call content
       rescue StandardError => e
         Log.error e
         Jackhammer.configuration.exception_adapter.call e

data/lib/jackhammer/queue_name.rb

@@ -0,0 +1,13 @@
+module Jackhammer
+  class QueueName
+    def self.app_name
+      Jackhammer.configuration.app_name
+    end
+
+    def self.from_routing_key(routing_key)
+      fail(InvalidConfigError, "app_name must be set to determine queue_name from routing_key") if app_name.to_s.empty?
+
+      "#{app_name}_#{routing_key}_q".gsub(/[^\w]+/, '_').gsub(/[_]+/, '_')
+    end
+  end
+end

data/lib/jackhammer/topic.rb

@@ -1,8 +1,11 @@
 module Jackhammer
   class Topic
+    QUEUE_NAME_KEY = 'queue_name'.freeze
+    ROUTING_KEY_KEY = 'routing_key'.freeze
+
     def initialize(name:, options:, queue_config:)
       @topic = Jackhammer.channel.topic name, options
-      @queue_config = queue_config
+      @queue_config = normalize_queue_config(queue_config)
     end
 
     def subscribe_queues
@@ -13,18 +16,41 @@ module Jackhammer
     # for each message published.
     def publish(message, options)
       full_options = Jackhammer.configuration.publish_options.dup.merge options
-      @topic.publish message, full_options
+      topic.publish message, full_options
     end
 
     def queues
       return @queues if @queues
 
-      @queues = @queue_config.map do |name, options|
+      @queues = queue_config.map do |options|
         handler = MessageReceiver.new(options.delete('handler'))
-        routing = options.delete 'routing_key'
-        queue = Jackhammer.channel.queue name, options
-        Queue.new topic: @topic, queue: queue, handler: handler, routing: routing
+        routing_key = fetch_and_delete_key(options, ROUTING_KEY_KEY)
+        queue_name = options.delete(QUEUE_NAME_KEY) || QueueName.from_routing_key(routing_key)
+        queue = Jackhammer.channel.queue(queue_name, options)
+        Log.info { "'#{queue_name}' configured to subscribe on '#{routing_key}'" }
+        Queue.new(topic: topic, queue: queue, handler: handler, routing_key: routing_key)
       end
     end
+
+    private
+
+    attr_reader :topic, :queue_config
+
+    # `queue_config` can be either:
+    # - an array of options containing `queue_name` key
+    # or
+    # - a hash containing `queue_name => options` pairs
+    def normalize_queue_config(config)
+      return config if config.is_a?(Array)
+
+      config.map do |name, options|
+        options[QUEUE_NAME_KEY] = name
+        options
+      end
+    end
+
+    def fetch_and_delete_key(options, key)
+      options.delete(key) || fail(InvalidConfigError, "#{key} not found in #{options.inspect}")
+    end
   end
 end

data/lib/jackhammer/version.rb

@@ -1,3 +1,3 @@
 module Jackhammer
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackhammer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Scott Serok
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -130,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dependabot/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -148,6 +149,7 @@ files:
 - lib/jackhammer/log.rb
 - lib/jackhammer/message_receiver.rb
 - lib/jackhammer/queue.rb
+- lib/jackhammer/queue_name.rb
 - lib/jackhammer/server.rb
 - lib/jackhammer/topic.rb
 - lib/jackhammer/topic_manager.rb