brown 1.1.2 → 2.1.0

data/lib/brown/test.rb

@@ -0,0 +1,152 @@
+require 'brown'
+require 'brown/agent/amqp_message_mock'
+
+# Additional testing methods for {Brown::Agent}.
+#
+# You can cause these methods to become part of {Brown::Agent} with
+#
+#     require 'brown/test_helpers'
+#
+module Brown::TestHelpers
+	#:nodoc:
+	def self.included(base)
+		base.class_eval do
+			%i{memo amqp_publisher amqp_listener}.each do |m|
+				alias_method "#{m}_without_test".to_sym, m
+				alias_method m, "#{m}_with_test".to_sym
+			end
+		end
+	end
+
+	# Is there not an arbitrary stimulus with the specified name registered
+	# on this agent?
+	#
+	# @param name [Symbol]
+	#
+	# @return Boolean
+	#
+	def stimulus?(name)
+		@stimuli && @stimuli.has_key?(name)
+	end
+
+	# Is there a memo with the specified name registered on this agent?
+	#
+	# @param name [Symbol]
+	#
+	# @return Boolean
+	#
+	def memo?(name)
+		@memos && @memos.has_key?(name)
+	end
+
+	#:nodoc:
+	#
+	# Test-specific decorator to replace the "real" memo container object
+	# with a test-enabled alternative.
+	#
+	def memo_with_test(name, safe=false, &generator)
+		memo_without_test(name, safe, &generator)
+
+		# Throw out the real memo, replace with our own testing-enabled variant
+		@memos[name] = Brown::Agent::Memo.new(generator, safe, true)
+	end
+
+	# Is there a timer which will go off every `n` seconds registered on this
+	# agent?
+	#
+	# @param n [Integer]
+	#
+	# @return Boolean
+	#
+	def timer?(n)
+		!instance_methods.select { |m| m =~ /^every_#{n}__/ }.empty?
+	end
+
+	# Set off all timers which trigger every `n` seconds on the running agent.
+	#
+	# @param n [Integer]
+	#
+	def trigger(n)
+		self.instance_methods.select { |m| m =~ /^every_#{n}__/ }.each do |m|
+			self.new.__send__(m)
+		end
+	end
+
+	#:nodoc:
+	#
+	# Test-specific decorator to record the existence of a publisher.
+	#
+	def amqp_publisher_with_test(name, *args)
+		@amqp_publishers ||= {}
+
+		@amqp_publishers[name] = true
+
+		amqp_publisher_without_test(name, *args)
+	end
+
+	# Is there a publisher with the specified name registered on this agent?
+	#
+	# @param name [Symbol]
+	#
+	# @return Boolean
+	#
+	def amqp_publisher?(name)
+		@amqp_publishers && @amqp_publishers[name]
+	end
+
+	#:nodoc:
+	#
+	# Test-specific decorator to record the details of a listener.
+	#
+	def amqp_listener_with_test(exchange_name, *args, &blk)
+		@amqp_listeners ||= {}
+
+		@amqp_listeners[exchange_name.to_s] = blk
+
+		amqp_listener_without_test(exchange_name, *args, &blk)
+	end
+
+	# Is there a listener on the specified exchange name registered on this agent?
+	#
+	# @param exchange_name [#to_s]
+	#
+	# @return Boolean
+	#
+	def amqp_listener?(exchange_name)
+		@amqp_listeners && @amqp_listeners[exchange_name.to_s].is_a?(Proc)
+	end
+
+	# Cause a message to be received by the listener on `exchange_name`.
+	#
+	# @param exchange_name [#to_s] the name of the exchange.
+	#
+	# @param payload [String] the literal string which is the payload of the
+	#   message.
+	#
+	# @return [Boolean] whether or not the message was acked.  You *usually*
+	#   want to check that this is true, because an agent that doesn't ack
+	#   each message when it has finished processing it is almost always
+	#   buggy, but there are specialised circumstances where you actually
+	#   want to *not* ack the message.
+	#
+	# @raise [ArgumentError] if you attempt to send a message via an exchange
+	#   that isn't being listened on.
+	#
+	def amqp_receive(exchange_name, payload, **opts)
+		unless amqp_listener?(exchange_name)
+			raise ArgumentError,
+			      "Unknown exchange: #{exchange_name}"
+		end
+
+		msg = Brown::Agent::AMQPMessageMock.new(opts.merge(payload: payload))
+
+		@amqp_listeners[exchange_name].call(msg)
+
+		msg.acked?
+	end
+end
+
+class << Brown::Agent
+	include Brown::TestHelpers
+end
+

metadata

@@ -1,30 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: brown
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.1.0
 platform: ruby
 authors:
-- Richard Heycock
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: amqp
+  name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: envied
   requirement: !ruby/object:Gem::Requirement
@@ -40,63 +39,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: eventmachine-le
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: extlib
+  name: github-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: murmurhash3
+  name: guard-spork
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: protobuf
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,82 +109,106 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: github-release
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
-  name: git-version-bump
+  name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: 
+email:
+- theshed+brown@hezmatt.org
 executables:
 - brown
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- Gemfile
-- Rakefile
+- ".yardopts"
+- LICENCE
+- README.md
 - bin/brown
 - brown.gemspec
+- lib/.gitkeep
 - lib/brown.rb
-- lib/brown/acl_loader.rb
-- lib/brown/acl_lookup.rb
 - lib/brown/agent.rb
-- lib/brown/amqp_errors.rb
-- lib/brown/logger.rb
-- lib/brown/message.rb
-- lib/brown/module_methods.rb
-- lib/brown/queue_definition.rb
-- lib/brown/queue_factory.rb
-- lib/brown/receiver.rb
-- lib/brown/sender.rb
-- lib/brown/util.rb
-- lib/smith.rb
-homepage: 
-licenses:
-- GPL-3
+- lib/brown/agent/amqp_message.rb
+- lib/brown/agent/amqp_message_mock.rb
+- lib/brown/agent/amqp_publisher.rb
+- lib/brown/agent/memo.rb
+- lib/brown/agent/stimulus.rb
+- lib/brown/test.rb
+homepage: http://theshed.hezmatt.org/brown
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -195,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -206,5 +229,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Run individual smith agents directly from the command line
+summary: Autonomous agent framework
 test_files: []
+has_rdoc: 

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,19 +0,0 @@
-exec(*(["bundle", "exec", $PROGRAM_NAME] + ARGV)) if ENV['BUNDLE_GEMFILE'].nil?
-
-Bundler.setup(:default, :development)
-
-task :default => :test
-
-begin
-	Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-	$stderr.puts e.message
-	$stderr.puts "Run `bundle install` to install missing gems"
-	exit e.status_code
-end
-
-Bundler::GemHelper.install_tasks
-
-task :release do
-	sh "git release"
-end