la_gear 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca8da71c32e27e8aabc8d13e7b00c12c5cc6107
-  data.tar.gz: d7eded901af06f3145c15f2395bc959d63f45082
+  metadata.gz: 768160cb15b491dd985aef30be9cc2b29bf9ddc2
+  data.tar.gz: 49f88664b7440dc21470f9778ed616fba089bf2e
 SHA512:
-  metadata.gz: 90cbd481807e189e60dec7c78ff5cd707abdc93c63972077bd1c5efaab3c7659e0c5ab17759bb723cad38b1106826d654a6b64878054626fe3e3b82612034790
-  data.tar.gz: c49890fda1ecbaa23614da07584eb1f456539bb2b34fea737d0eccc5da0ed2a997d70e8aba3453f6660b6a8ac41b4e245d330aa9e2a03eaa96ff442bfedd10c3
+  metadata.gz: b461a62b63c2d45cdaa13db78ec0cec265270594a6836eeba5388bed709820b631391885395124d89fa0deb33aea9c380479f5434b7e3775faef16ee5c99f938
+  data.tar.gz: df2ff3bab0755e9a06c7a2c8dcb38f991cbffe7b632a7de7660dc3823fd8ee5b26f892f8e89cdc036000c3509f965b7a6ee3d61261056533c7b67b3310c15ed3

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 *.log
+/.idea

data/README.md

@@ -46,21 +46,13 @@ would by default result in the following 2 queue names:
 - `pogs_are_awesome.bo_knows`
 - `pogs_are_awesome.bo_knows.retry`
 
-The default routing key would be: `bo_knows`. This allows for multiple consumer queue bindings for a direct exchange (see the Multiple Bindings section of https://www.rabbitmq.com/tutorials/tutorial-four-ruby.html). The `.retry` is for if you are using [dead letter exchanges](https://www.rabbitmq.com/dlx.html) and [message expirations](https://www.rabbitmq.com/ttl.html) to perform retries (which you should). Just call the `Sneakers::Worker#from_queue` method to override the convention-based defaults like so:
+The default routing key would be: `bo_knows`. This allows for multiple consumer queue bindings for a direct exchange (see the Multiple Bindings section of https://www.rabbitmq.com/tutorials/tutorial-four-ruby.html). The `.retry` is for if you are using [dead letter exchanges](https://www.rabbitmq.com/dlx.html) and [message expirations](https://www.rabbitmq.com/ttl.html) to perform retries (which you should). Just call the `subscribes_to` method to override the convention-based defaults like so:
 
 ```ruby
 class PowerRanger
   include LaGear::Worker
 
-  def self.routing_key
-    'bo_knows'
-  end
-
-  def self.default_queue_name
-    "#{Sneakers::CONFIG.fetch(:app_name).underscore}.#{name.underscore}"
-  end
-
-  from_queue default_queue_name, default_queue_opts
+  subscribes_to 'bo_knows'
 
   def perform(red, yellow)
     # process message...
@@ -87,6 +79,8 @@ would create the routing key `bo_knows.v1` and these queue names:
 - `pogs_are_awesome.bo_knows.v1`
 - `pogs_are_awesome.bo_knows.v1.retry`
 
+One caveat with `subscribes_to` and versioned workers is that the routing key must be manually incremented when a handler's version increments. If a worker `subscribes_to 'bo_knows.v1'`, and the `bo_knows.v1` message type increments to `bo_knows.v2`, you should create a new version of the worker that subscribes to `bo_knows.v2`. 
+
 ### The Bus
 
 There is also a `LaGear::Bus` class which is an alternative to the `Sneakers::Publisher`. It adds an `opts` parameter to the `publish` method, allowing you to pass the options you would pass to the `bunny` exchange publish [method](http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method) (see http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method for the list of options). It also allows you use a common way to publish messages:

data/examples/test_worker.rb

@@ -9,12 +9,22 @@ Sneakers.configure(
   handler: LaGear::Sneakers::Handlers::ExponentialBackoff
 )
 
+# old way
 class TestWorker
   include LaGear::Worker
 
   def perform(_); end
 end
 
+# new way
+class TestWorker2
+  include LaGear::Worker
+
+  subscribes_to :test_worker
+
+  def perform(_); end
+end
+
 Sneakers.logger.level = Logger::INFO
 bunny = Bunny.new
 bunny.start
@@ -23,8 +33,12 @@ queue = channel.queue(
   TestWorker.default_queue_name,
   TestWorker.default_queue_opts.merge(durable: true, arguments: TestWorker.default_queue_args),
 )
+queue2 = channel.queue(
+  TestWorker2.default_queue_name,
+  TestWorker2.default_queue_opts.merge(durable: true, arguments: TestWorker2.default_queue_args),
+)
 queue.purge
-r = Sneakers::Runner.new([TestWorker])
+r = Sneakers::Runner.new([TestWorker, TestWorker2])
 pid = fork do
   r.run
 end
@@ -34,5 +48,6 @@ sleep 3
 puts 'killing...'
 Process.kill('TERM', pid)
 sleep 3
-puts "message count #{queue.message_count}"
+puts "test_worker message count #{queue.message_count}"
+puts "test_worker2 message count #{queue2.message_count}"
 exit 1 if queue.message_count > 0

data/lib/la_gear/version.rb

@@ -1,3 +1,3 @@
 module LaGear
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/lib/la_gear/worker.rb

@@ -26,8 +26,12 @@ module LaGear
     end
 
     module SneakersClassMethods
+      def app_name
+        ::Sneakers::CONFIG.fetch(:app_name, 'sneakers').underscore
+      end
+
       def default_queue_name
-        "#{::Sneakers::CONFIG.fetch(:app_name, 'sneakers').underscore}.#{routing_key}"
+        @default_queue_name ||= "#{app_name}.#{routing_key}"
       end
 
       def default_queue_opts
@@ -43,7 +47,7 @@ module LaGear
       end
 
       def routing_key
-        name.underscore.gsub('/', '.')
+        @routing_key ||= name.underscore.tr('/', '.')
       end
 
       def retry_routing_key
@@ -53,6 +57,12 @@ module LaGear
       def default_queue_args
         { 'x-dead-letter-exchange' => "#{::Sneakers::CONFIG.fetch(:exchange, 'sneakers').underscore}.retry" }
       end
+
+      def subscribes_to(routing_key)
+        @routing_key = routing_key.to_s
+        @default_queue_name = "#{app_name}.#{name.underscore.tr('/', '.')}"
+        from_queue(default_queue_name, default_queue_opts) unless Worker.sidekiq_proc?
+      end
     end
 
     module NoOpSneakersClassMethods

data/test/test_worker.rb

@@ -1,5 +1,8 @@
 require_relative 'helper'
 
+Sneakers::CONFIG[:app_name] = 'bo_knows'
+Sneakers::CONFIG[:exchange] = 'football'
+
 class PumpItUp
   include LaGear::Worker
 end
@@ -17,6 +20,14 @@ module GoGo
   end
 end
 
+module SlapBraceletSender
+  class V1
+    include LaGear::Worker
+
+    subscribes_to NotPogs::V2.routing_key
+  end
+end
+
 class TestWorker < LaGear::Test
   describe 'when a worker is defined and there is a custom Sneakers app_name' do
     before do
@@ -91,10 +102,6 @@ class TestWorker < LaGear::Test
         NotPogs::V2.routing_key.must_equal @expected_queue_routing_key
       end
 
-      it 'must have pump_it_up as the routing_key' do
-        NotPogs::V2.routing_key.must_equal @expected_queue_routing_key
-      end
-
       it 'must have bo_knows.pump_it_up as the default_queue_name' do
         NotPogs::V2.default_queue_name.must_equal "#{Sneakers::CONFIG[:app_name]}.#{@expected_queue_routing_key}"
       end
@@ -129,10 +136,6 @@ class TestWorker < LaGear::Test
         GoGo::PowerRangers::V2.routing_key.must_equal @expected_queue_routing_key
       end
 
-      it 'must have pump_it_up as the routing_key' do
-        GoGo::PowerRangers::V2.routing_key.must_equal @expected_queue_routing_key
-      end
-
       it 'must have bo_knows.pump_it_up as the default_queue_name' do
         GoGo::PowerRangers::V2.default_queue_name.must_equal "#{Sneakers::CONFIG[:app_name]}.#{@expected_queue_routing_key}"
       end
@@ -157,5 +160,39 @@ class TestWorker < LaGear::Test
         )
       end
     end
+
+    describe 'when the worker is namespaced once and invokes subscribes_to' do
+      before do
+        @expected_queue_routing_key = 'not_pogs.v2'
+      end
+
+      it 'must have not_pogs.v2 as the routing_key' do
+        SlapBraceletSender::V1.routing_key.must_equal @expected_queue_routing_key
+      end
+
+      it 'must have bo_knows.slap_bracelet_sender.v1 as the default_queue_name' do
+        SlapBraceletSender::V1.default_queue_name.must_equal "#{Sneakers::CONFIG[:app_name]}.#{SlapBraceletSender::V1.name.underscore.tr('/', '.')}"
+      end
+
+      it 'must have bo_knows.slap_bracelet_sender.v1.retry as the retry_routing_key' do
+        SlapBraceletSender::V1.retry_routing_key.must_equal "#{Sneakers::CONFIG[:app_name]}.#{SlapBraceletSender::V1.name.underscore.tr('/', '.')}.retry"
+      end
+
+      it 'must have default queue has with x-dead-letter-exchange of football.retry' do
+        SlapBraceletSender::V1.default_queue_args.must_equal 'x-dead-letter-exchange' => "#{Sneakers::CONFIG[:exchange]}.retry"
+      end
+
+      it 'must have default queue options hash' do
+        SlapBraceletSender::V1.default_queue_opts.must_equal(
+          routing_key: [SlapBraceletSender::V1.routing_key, SlapBraceletSender::V1.retry_routing_key],
+          queue_options: {
+            arguments: SlapBraceletSender::V1.default_queue_args
+          },
+          handler_opts: {
+            routing_key: SlapBraceletSender::V1.retry_routing_key
+          }
+        )
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: la_gear
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Gabriel Chaney
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json