brown 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cc95726eacf9732ee7d020ffc841e087f5b057a
-  data.tar.gz: 708dc32a8fe3830acf136ed7d6830e5b8df80fae
+  metadata.gz: 831f8702bad84d8fe35c098f0a624632ab06f835
+  data.tar.gz: 55684d48c7e8233a7cd6d68621f77116e2b05f49
 SHA512:
-  metadata.gz: e91292e3193b4ed6f25971c76acb83afc69f6c015bc7c63f10e8c13770de1e18c9d9c00aad183149d9a7dc33189ada46cd71a60f5c66c420817f321fb81267d0
-  data.tar.gz: dbffc92d30352eb5c7c66b0e20c4806e796bc5eeb5292e2910ffccceb013f8303488bd73c9056613761e6d4924430daf58e43b632d35e944eeaf03b22fd30e2a
+  metadata.gz: f879eb251cb5b9e511d4331a2b5e84c1c8590a80a846bf7c1d7ff813f50bf359be28a7421ffa5b718e5190d6a2fa59e25139c47f9399529d203bd8427a238096
+  data.tar.gz: cbf37ca7b491d245d85e389d74ad91187d6824ec86503010b054b5eb9e0a7c5ab00950eaaa871df283a487f684843b59bdae48f18d8f0d6d854c3cb216d4ac52

data/README.md

@@ -161,15 +161,14 @@ simply receive stimuli and act on them, testing is quite simple in
 principle, but the parallelism inherent in agents can make them hard to test
 without some extra helpers.
 
-To enable the additional testing helpers, you must `require
-'brown/test_helpers'` somewhere in your testing setup, before you define
-your agents.  This will add a bunch of extra methods, defined in
-{Brown::TestHelpers} to {Brown::Agent}, which you can then call to examine
-certain aspects of the agent (such as `memo?(name)` and
-`amqp_publisher?(name)`) as well as send stimuli to the agent and have it
-behave appropriately, which you can then make assertions about (either by
-examining the new state of the overall system, or through the use of
-mocks/spies).
+To enable the additional testing helpers, you must `require 'brown/test'`
+somewhere in your testing setup, before you define your agents.  This will
+add a bunch of extra methods, defined in {Brown::TestHelpers} to
+{Brown::Agent}, which you can then call to examine certain aspects of the
+agent (such as `memo?(name)` and `amqp_publisher?(name)`) as well as send
+stimuli to the agent and have it behave appropriately, which you can then
+make assertions about (either by examining the new state of the overall
+system, or through the use of mocks/spies).
 
 While full documentation for all of the helper methods are available in the
 YARD docs for {Brown::TestHelpers}, here are some specific tips for using
@@ -178,6 +177,10 @@ them to test certain aspects of your agents in popular testing frameworks.
 
 ### RSpec
 
+To enable additional RSpec-specific test integration (resetting memos at the
+end of each test), then **instead** of `require 'brown/test'`, you should
+`require 'brown/rspec'` before your agent code is loaded.
+
 To test a directly declared stimulus, you don't need to do very much -- you
 can just instantiate the agent class and call the method you want:
 

data/lib/brown/rspec.rb

@@ -0,0 +1,11 @@
+require 'brown/test'
+
+RSpec.configure do |c|
+	c.after(:each) do
+		ObjectSpace.each_object(Class).each do |klass|
+			if klass != Brown::Agent and klass.ancestors.include?(Brown::Agent)
+				klass.reset_memos
+			end
+		end
+	end
+end

data/lib/brown/test.rb

@@ -5,7 +5,7 @@ require 'brown/agent/amqp_message_mock'
 #
 # You can cause these methods to become part of {Brown::Agent} with
 #
-#     require 'brown/test_helpers'
+#     require 'brown/test'
 #
 module Brown::TestHelpers
 	#:nodoc:
@@ -51,6 +51,23 @@ module Brown::TestHelpers
 		@memos[name] = Brown::Agent::Memo.new(generator, safe, true)
 	end
 
+	# Reset all memos to "undefined" values.
+	#
+	# Because memo values are cached at the class level, this means that they're
+	# cached between test cases.  Often, this isn't what you want (because if the
+	# value of the memo was changed by a test case, the next test won't run in a
+	# pristine environment).  Calling this method will cause all of the memos in
+	# the agent to be reset to a state which is the same as if the memo had never
+	# been called at all.
+	#
+	def reset_memos
+		@memos ||= {}
+
+		@memos.values.each do |memo|
+			memo.instance_variable_set(:@cached_value, nil)
+		end
+	end
+
 	# Is there a timer which will go off every `n` seconds registered on this
 	# agent?
 	#
@@ -67,7 +84,14 @@ module Brown::TestHelpers
 	# @param n [Integer]
 	#
 	def trigger(n)
-		self.instance_methods.select { |m| m =~ /^every_#{n}__/ }.each do |m|
+		trigger_methods = self.instance_methods.select { |m| m =~ /^every_#{n}__/ }
+
+		if trigger_methods.empty?
+			raise RuntimeError,
+			      "Nothing is set to run every #{n} second#{n == 1 ? "" : "s"}"
+		end
+
+		trigger_methods.each do |m|
 			self.new.__send__(m)
 		end
 	end
@@ -146,7 +170,11 @@ module Brown::TestHelpers
 
 		msg = Brown::Agent::AMQPMessageMock.new(opts.merge(payload: payload))
 
-		@amqp_listeners[exchange_name].call(msg)
+		self.new.tap do |p|
+			uuid = SecureRandom.uuid
+			p.singleton_class.__send__(:define_method, uuid, &@amqp_listeners[exchange_name])
+			p.__send__(uuid, msg)
+		end
 
 		msg.acked?
 	end
@@ -155,4 +183,3 @@ end
 class << Brown::Agent
 	include Brown::TestHelpers
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brown
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -206,6 +206,7 @@ files:
 - lib/brown/agent/amqp_publisher.rb
 - lib/brown/agent/memo.rb
 - lib/brown/agent/stimulus.rb
+- lib/brown/rspec.rb
 - lib/brown/test.rb
 homepage: http://theshed.hezmatt.org/brown
 licenses: []