announce 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a15f3dd4b262c764d345c0c2cdc9a25a99ec2f96
-  data.tar.gz: 18ba68588930ddb7f81505a0cf4007084a43009b
+  metadata.gz: 657b17523c88c350d69e1b1de4393ff2b3d0c803
+  data.tar.gz: 9a2bb7fc21061b94e0af76a82129faba9e28e0a6
 SHA512:
-  metadata.gz: 730f6ed1fd833d3242cc5d9c3ad868cac3919553b1e79a7317fdfa0b5ebbd38d6c368925c8143b6e0e411f026549565d56e3e19ededecbec49b9b7c6959d2e2d
-  data.tar.gz: 5d0d5ad56873ca643a32f4eb0cfdd816e8f47cfe650baee06844751ca2631f0a1919d0559dbdd2f73b57507349cb95d00e34b96b3876ff8c4a1d8252e050f716
+  metadata.gz: 513d312adeeb87a82e89edff4f8ad19849a5303a451655f040aca03e06e2631c2210f3992ef05c94b5b206d28d0803037bd09ed82e025b3435d936fa7283a3f4
+  data.tar.gz: 037d43cabac0a80227d75289dfc3d80886d6ded53c45ab7255f4476a67ef707d98db4a0694eaa6a7cb3e3f5ec4dc4ec54499ef8a5695353e1ed712d80e840da8

data/README.md

@@ -32,7 +32,7 @@ end
 ```
 
 When building a Ruby app or service to receive messages, subscribe a job class to announcements like this:
-```
+```ruby
 require 'announce'
 
 class SomeCreateJob < ActiveJob::Base
@@ -223,7 +223,7 @@ Announce.announce(:story, :publish, id: story.id, {})
 ```
 
 There is also a module you can include to get `publish` and `announce` methods:
-```
+```ruby
 class SomeController
   include Announce::Publisher
 
@@ -247,7 +247,7 @@ Unlike other job libraries which specify the Ruby `Class` for processing as part
 
 To designate that a Ruby class will process a message, you must include the `Announce:Subscriber` module and call `subscribe_to` class method.
 
-```
+```ruby
 require 'announce'
 
 class SomeCreateJob < ActiveJob::Base
@@ -264,7 +264,7 @@ end
 This works because the `Announce::Subscriber` adds the `subscribe_to` class method, but also a default `perform(*args)` instance method that delegates message handling to a job instance method named `"receive_#{subject}_#{action}"`.
 
 This default `perform` method only passes the message `body` to `receive_subject_action` methods. The `subject`, but `action` and full `message` object are made available as instance properties of the subscriber.
-```
+```ruby
 require 'announce'
 
 class SomeCreateJob < ActiveJob::Base
@@ -302,6 +302,42 @@ For `shoryuken`, `subscribe_to` registers the worker for the appropriate queue,
 
 ## Development
 
+### Testing with Announce
+
+There is an Announce::Testing module which provides helper methods useful in your tests.
+To use them add the following lines into your test/spec helper:
+```ruby
+# use the testing helper
+require 'announce/testing'
+
+# include the methods - could also include in your base test class
+include Announce::Testing
+
+# this resets announce to use test settings, and clears messages
+reset_announce
+
+```
+
+Then you can use the following methods in your test class:
+
+`published_messages` - returns the array of published messages
+
+`last_message` - returns the last message published to announce
+
+`clear_messages` - clears all published messages
+
+`subscriptions` - returns the array of all subscriptions
+
+`last_subscription` - returns most recently added subscription
+
+`clear_subscriptions` - clears all subscriptions
+
+`broker_configured?` - returns whether or not the broker has been configured
+
+`reset_broker_config` - resets broker
+
+`reset_announce` - resets announce to use test adapter, prefix, app, and logging to `/dev/null`
+
 ### Developing an Adapter Class
 
 Adapter classes should be named with the following module structure: `Announce::Adapters::SomeBrokerAdapter`

data/lib/announce/testing.rb

@@ -0,0 +1,47 @@
+require 'announce'
+require 'announce/adapters/test_adapter'
+
+module Announce
+  module Testing
+
+    def published_messages
+      Announce::Adapters::TestAdapter::Topic.published_messages
+    end
+
+    def last_message
+      published_messages.last
+    end
+
+    def clear_messages
+      published_messages.clear
+    end
+
+    def subscriptions
+      Announce::Adapters::TestAdapter::Subscriber.subscriptions
+    end
+
+    def last_subscription
+      subscriptions.last
+    end
+
+    def clear_subscriptions
+      subscriptions.clear
+    end
+
+    def broker_configured?
+      Announce::Adapters::TestAdapter::BrokerManager.configured?
+    end
+
+    def reset_broker_config
+      Announce::Adapters::TestAdapter::BrokerManager.reset
+    end
+
+    def reset_announce
+      Announce.logger = Logger.new('/dev/null')
+      Announce.options[:adapter] = 'test'
+      Announce.options[:queue_name_prefix] = 'test'
+      Announce.options[:app_name] = 'app'
+      clear_messages
+    end
+  end
+end

data/lib/announce/version.rb

@@ -1,3 +1,3 @@
 module Announce
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: announce
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Kuklewicz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoryuken
@@ -181,6 +181,7 @@ files:
 - lib/announce/publisher.rb
 - lib/announce/railtie.rb
 - lib/announce/subscriber.rb
+- lib/announce/testing.rb
 - lib/announce/version.rb
 - lib/tasks/announce.rake
 homepage: https://github.com/PRX/announce