marples 1.0.0 → 1.0.2

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in marples.gemspec
 gemspec
+
+gem 'activerecord-nulldb-adapter', :git => 'git://github.com/nulldb/nulldb.git', :require => false

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 HM Government
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -75,3 +75,27 @@ just use the model like you normally would:
     s.add_filling "cheese"
     s.add_filling "ham"
     s.save!
+
+
+## Testing
+
+You probably don't want to provide a broker to your test environment.
+
+Marples provides `Marples::NullTransport` which you can use in place of your
+real transport when you don't care what happens to the messages:
+
+  null_transport = Marples::NullTransport.instance
+  Marples::Client.new transport: null_transport, client_name: 'whatever'
+
+
+## Semantic Versioning
+
+To give you confidence when deciding which version of Marples to depend on we
+will be using the Semantic Versioning scheme described at http://semver.org/.
+
+
+## Licencing information
+
+It's not adviseable to use code that's not had the terms of its licence made
+explicit. This project is released under the MIT licence, a copy of which
+should be distributed with this project in the LICENCE file.

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/lib/marples.rb

@@ -1,4 +1,3 @@
-require "pethau"
 require "null_logger"
 require "active_support/core_ext/hash/conversions"
 require "singleton"

data/lib/marples/client.rb

@@ -7,6 +7,7 @@ module Marples
 
    def initialize *args
      if args[0].kind_of? Hash
+       options = args.shift
        self.transport = options[:transport]
        self.client_name = options[:client_name]
        self.logger = options[:logger]
@@ -18,7 +19,7 @@ module Marples
          "deprecated and will be removed."
      end
      raise "You must provide a transport" if transport.nil?
-     self.logger ||= NullLogger.instance
+     self.logger = NullLogger.instance if logger.nil?
    end
 
     def join

data/lib/marples/model_action_broadcast.rb

@@ -1,6 +1,7 @@
 module Marples
   module ModelActionBroadcast
-    CALLBACKS = [ :save, :create, :update, :destroy, :commit ]
+    TRANSACTION_ACTIONS = :create, :update, :destroy
+    CALLBACKS = TRANSACTION_ACTIONS + [:save, :commit]
 
     def self.included base
       base.class_eval do
@@ -18,8 +19,12 @@ module Marples
           callback_action = callback.to_s =~ /e$/ ? "#{callback}d" : "#{callback}ed"
           after_callback = "after_#{callback}"
           next unless respond_to? after_callback
-          send after_callback do |record|
-            record.class.marples_client.send callback_action, record
+
+          notify = lambda { |record| record.class.marples_client.send callback_action, record }
+          if TRANSACTION_ACTIONS.include?(callback) && respond_to?(:after_commit)
+            after_commit :on => callback, &notify
+          else
+            send after_callback, &notify
           end
         end
 
@@ -28,7 +33,7 @@ module Marples
         end
 
         def self.build_marples_client
-          Marples::Client.new :transport: marples_transport,
+          Marples::Client.new transport: marples_transport,
             client_name: marples_client_name, logger: marples_logger
         end
       end

data/lib/marples/version.rb

@@ -1,3 +1,3 @@
 module Marples
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/marples.gemspec

@@ -17,7 +17,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "pethau", ">= 0.0.2"
   s.add_runtime_dependency "null_logger"
   s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency 'i18n'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'activerecord-nulldb-adapter'
 end

data/test/support/notifications.rb

@@ -0,0 +1,29 @@
+class FakeTransport
+  include Singleton
+
+  attr_reader :notifications
+
+  def initialize
+    flush
+  end
+
+  def flush
+    self.notifications = []
+  end
+
+  def publish(destination, message, headers = {})
+    notifications << { destination: destination, message: Hash.from_xml(message), headers: headers }
+  end
+
+  private
+    attr_writer :notifications
+end
+
+def flush_notifications
+  FakeTransport.instance.flush
+end
+
+def latest_notification_with_destination(destination)
+  notifications = FakeTransport.instance.notifications
+  notifications.reverse.detect { |n| n[:destination] == destination }
+end

data/test/support/rails.rb

@@ -0,0 +1,5 @@
+module Rails
+  def self.logger
+    NullLogger.instance # because Marples::ModelActionBroadcast.included calls Rails.logger
+  end
+end

data/test/support/widget.rb

@@ -0,0 +1,3 @@
+class Widget < ActiveRecord::Base
+  include Marples::ModelActionBroadcast
+end

data/test/test_model_action_broadcast.rb

@@ -0,0 +1,78 @@
+require 'test/unit'
+require 'marples'
+require 'marples/model_action_broadcast'
+require 'active_record'
+
+require 'support/rails'
+require 'support/notifications'
+require 'support/widget'
+
+class TestModelActionBroadcast < Test::Unit::TestCase
+  def setup
+    ActiveRecord::Base.establish_connection :adapter => :nulldb
+    ActiveRecord::Schema.define do
+      create_table :widgets
+    end
+
+    Widget.marples_transport = FakeTransport.instance
+    Widget.marples_client_name = 'widgetotron'
+
+    FakeTransport.instance.flush
+  end
+
+  def test_created_notification_is_sent_on_create
+    assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.created'
+    Widget.create!
+    assert_not_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.created'
+  end
+
+  def test_updated_notification_is_sent_on_update
+    widget = Widget.create!
+
+    assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.updated'
+    widget.save!
+    assert_not_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.updated'
+  end
+
+  def test_destroyed_notification_is_sent_on_destroy
+    widget = Widget.create!
+
+    assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.destroyed'
+    widget.destroy
+    assert_not_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.destroyed'
+  end
+
+  def test_created_notification_is_sent_after_commit
+    Widget.transaction do
+      assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.created'
+      Widget.create!
+      assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.created'
+    end
+
+    assert_not_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.created'
+  end
+
+  def test_updated_notification_is_sent_after_commit
+    widget = Widget.create!
+
+    Widget.transaction do
+      assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.updated'
+      widget.save!
+      assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.updated'
+    end
+
+    assert_not_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.updated'
+  end
+
+  def test_destroyed_notification_is_sent_after_commit
+    widget = Widget.create!
+
+    Widget.transaction do
+      assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.destroyed'
+      widget.destroy
+      assert_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.destroyed'
+    end
+
+    assert_not_nil latest_notification_with_destination '/topic/marples.widgetotron.widgets.destroyed'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marples
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000Z
+date: 2011-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pethau
-  requirement: &70334323087180 !ruby/object:Gem::Requirement
+  name: null_logger
+  requirement: &70212070634820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334323087180
+  version_requirements: *70212070634820
 - !ruby/object:Gem::Dependency
-  name: null_logger
-  requirement: &70334323086760 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &70212070633860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334323086760
+  version_requirements: *70212070633860
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70334323086300 !ruby/object:Gem::Requirement
+  name: i18n
+  requirement: &70212070632780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,40 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70334323086300
+  version_requirements: *70212070632780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70212070631880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70212070631880
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70212070630920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70212070630920
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: &70212070629780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70212070629780
 description: Message destination arbiter
 email:
 - craig@barkingiguana.com
@@ -55,6 +88,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENCE
 - README.md
 - Rakefile
 - lib/marples.rb
@@ -63,6 +97,10 @@ files:
 - lib/marples/null_transport.rb
 - lib/marples/version.rb
 - marples.gemspec
+- test/support/notifications.rb
+- test/support/rails.rb
+- test/support/widget.rb
+- test/test_model_action_broadcast.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -75,16 +113,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2905283016913556502
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2905283016913556502
 requirements: []
 rubyforge_project: marples
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Message destination arbiter
-test_files: []
+test_files:
+- test/support/notifications.rb
+- test/support/rails.rb
+- test/support/widget.rb
+- test/test_model_action_broadcast.rb