graph_mediator 0.2.1 → 0.2.2

data/README.rdoc

@@ -31,14 +31,14 @@ The after_mediation callback is itself broken down into three phases:
   but which do not themselves alter the graph (in that they are reproducible
   from existing state) should be made in the cacheing phase.
 * :bumping - if the class has a +lock_column+ set
-  (ActiveRecord::Locking::Optimistic) and has on +updated_at/on+ timestamp then
+  (ActiveRecord::Locking::Optimistic) and has on <b>updated_at/on</b> timestamp then
   the instance will be touched, bumping the +lock_column+ and checking for stale
   data.
 
 During a mediated_transaction, the +lock_column+ will only update during the 
 +bumping+ phase of the after_mediation callback.
 
-But if there is no +update_at/on+ timestamp, then +lock_column+ cannot be
+But if there is no <b>update_at/on</b> timestamp, then +lock_column+ cannot be
 incremented when dependent objects are updated.  This is because there is 
 nothing to touch on the root record to trigger the +lock_column+ update.
 
@@ -90,20 +90,21 @@ See spec/examples for real, dingo-free examples.
 A lock_column and timestamp are not required, but without both columns in your schema
 there will be no versioning.
 
-+A lock_column by itself *without* a timestamp will not increment and will not provide
-any optimistic locking in a class including GraphMediator!+
+<em>A lock_column by itself *without* a timestamp will not increment and will not provide
+any optimistic locking in a class including GraphMediator!</em>
 
-Using a lock_column along with a counter_cache in a dependent child will raise a StaleObject
-error during a mediated_transaction if you touch the dependent.
+Using a lock_column along with a counter_cache in a dependent child will raise
+a StaleObject error during a mediated_transaction if you touch the dependent.
 
-The cache_counters do not play well with optimistic locking because they are updated with
-a direct SQL call to the database, so ActiveRecord instance remain unaware of the lock_version
-change and assume it came from another transaction.
+The cache_counters do not play well with optimistic locking because they are
+updated with a direct SQL call to the database, so ActiveRecord instance remain
+unaware of the lock_version change and assume it came from another transaction.
 
-You should not need to declare lock_version for any children that are declared as a dependency
-of the root node, since updates will also update the root nodes lock_version.  So if another
-transaction updates a child, root.lock_version should increment, and the first transaction
-should raise a StaleObject error when it too tries to update the child.
+You should not need to declare lock_version for any children that are declared
+as a dependency of the root node, since updates will also update the root nodes
+lock_version.  So if another transaction updates a child, root.lock_version
+should increment, and the first transaction should raise a StaleObject error
+when it too tries to update the child.
 
 If you override super in the model hierarchy you are mediating, you must pass your 
 override as a block to super or it will occur outside of mediation:

data/lib/graph_mediator/locking.rb

@@ -1,6 +1,6 @@
 module GraphMediator
-  # Overrides to ActiveRecord::Optimistic::Locking to ensure that lock_column is updated
-  # during the +versioning+ phase of a mediated transaction.
+  # Overrides to ActiveRecord::Optimistic::Locking to ensure that lock_column
+  # is updated during the +versioning+ phase of a mediated transaction.
   module Locking
 
     def self.included(base)
@@ -10,8 +10,8 @@ module GraphMediator
     end
 
     module ClassMethods
-      # Overrides ActiveRecord::Base.update_counters to skip locking if currently mediating
-      # the passed id.
+      # Overrides ActiveRecord::Base.update_counters to skip locking if
+      # currently mediating the passed id.
       def update_counters(ids, counters)
         # id may be an array of ids...
         unless currently_mediating?(ids)
@@ -32,9 +32,10 @@ module GraphMediator
       # Overrides ActiveRecord::Locking::Optimistic#locking_enabled?
       #
       # * True if we are not in a mediated_transaction and lock_enabled? is true
-      # per ActiveRecord (lock_column exists and lock_optimistically? true)
+      #   per ActiveRecord (lock_column exists and lock_optimistically? true)
       # * True if we are in a mediated_transaction and lock_enabled? is true per
-      # ActiveRecord and we are in the midst of the version bumping phase of the transaction.
+      #   ActiveRecord and we are in the midst of the version bumping phase of
+      #   the transaction.
       # 
       # Effectively this ensures that an optimistic lock check and version bump
       # occurs as usual outside of mediation but only at the end of the

data/lib/graph_mediator/mediator.rb

@@ -63,7 +63,8 @@ module GraphMediator
         attributes.all? { |a| attribute_changed?(a) }
       end
 
-      # True if any of the passed attributes were changed in root or a dependent.
+      # True if any of the passed attributes were changed in root or a
+      # dependent.
       def any_changed?(*attributes)
         attributes.any? { |a| attribute_changed?(a) }
       end
@@ -102,9 +103,9 @@ module GraphMediator
             klass = $1
             klass = klass.classify.constantize if klass
             attribute = $2
-# XXX Don't define a method here, or you run into issues with Rails class reloading.
-# After the first call, you hold a reference to an old Class which will no longer work as
-# a key in a new changes hash.
+# XXX Don't define a method here, or you run into issues with Rails class
+# reloading.  After the first call, you hold a reference to an old Class which
+# will no longer work as a key in a new changes hash.
 #            self.class.__send__(:define_method, method) do
               return attribute_changed?(attribute, klass) 
 #            end
@@ -200,7 +201,7 @@ module GraphMediator
       end
     end
 
-    # Reload them mediated instance.  Throws an ActiveRecord::StaleObjectError
+    # Reload the mediated instance.  Throws an ActiveRecord::StaleObjectError
     # if lock_column has been updated outside of transaction.
     def refresh_mediated_instance
       debug "refresh_mediated_instance called"

data/lib/graph_mediator/version.rb

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

data/lib/graph_mediator.rb

@@ -3,20 +3,23 @@ require 'graph_mediator/mediator'
 require 'graph_mediator/locking'
 require 'graph_mediator/version'
 
-# = GraphMediator =
+# = GraphMediator
 #
-# GraphMediator is used to coordinate changes between a graph of ActiveRecord objects
-# related to a root node.  See README.rdoc for details.
+# GraphMediator is used to coordinate changes between a graph of ActiveRecord
+# objects related to a root node.  See README.rdoc for details.
 #
-# GraphMediator::Base::DSL - is the simple class macro language used to set up mediation.
+# GraphMediator::Base::DSL - is the simple class macro language used to set up
+# mediation.
 #
 # == Versioning and Optimistic Locking
 #
-# If you include an integer +lock_version+ column in your class, it will be incremented
-# only once within a mediated_transaction and will serve as the optimistic locking check
-# for the entire graph so long as you have declared all your dependent models for mediation.
+# If you include an integer +lock_version+ column in your class, it will be
+# incremented only once within a mediated_transaction and will serve as the
+# optimistic locking check for the entire graph so long as you have declared
+# all your dependent models for mediation.
 #
-# Outside of a mediated_transaction, +lock_version+ will increment per update as usual.
+# Outside of a mediated_transaction, +lock_version+ will increment per update
+# as usual.
 #
 # == Convenience Methods for Save Without Mediation
 #
@@ -26,14 +29,14 @@ require 'graph_mediator/version'
 # 
 # For example, save_without_mediation! is equivalent to:
 #
-# instance.disable_mediation!
-# instance.save!
-# instance.enable_mediation!
+#  instance.disable_mediation!
+#  instance.save!
+#  instance.enable_mediation!
 #
 # == Overriding
 # 
-# GraphMediator overrides ActiveRecord's save_without_transaction to slip in mediation 
-# just before the save process is wrapped in a transaction.
+# GraphMediator overrides ActiveRecord's save_without_transaction to slip in
+# mediation just before the save process is wrapped in a transaction.
 # 
 # * save_without_transaction
 # * save_without_transaction_with_mediation
@@ -43,11 +46,11 @@ require 'graph_mediator/version'
 # defined locally by GraphMediator, so you can override with something like
 # alias_method_chain, but will need to be in a subclass to use super.
 # 
-# My original intention was to define aliased overrides in MediatorProxy if the target
-# was a method in a superclass (like save), so that the implementation class could
-# make a simple def foo; something; super; end override, but this is prevented by a bug
-# in ruby 1.8 with aliasing of methods that use super in a module.
-# http://redmine.ruby-lang.org/issues/show/734
+# My original intention was to define aliased overrides in MediatorProxy if the
+# target was a method in a superclass (like save), so that the implementation
+# class could make a simple def foo; something; super; end override, but this
+# is prevented by a bug in ruby 1.8 with aliasing of methods that use super in
+# a module.  http://redmine.ruby-lang.org/issues/show/734
 # 
 module GraphMediator
   
@@ -126,9 +129,10 @@ module GraphMediator
     # GraphMediator::Configuration.logger overrides this.
     mattr_accessor :logger
     
-    # Log level may be adjusted just for GraphMediator globally, or for each class including
-    # GraphMediator.  This should be an ActiveSupport::BufferedLogger log level constant
-    # such as ActiveSupport::BufferedLogger::DEBUG
+    # Log level may be adjusted just for GraphMediator globally, or for each
+    # class including GraphMediator.  This should be an
+    # ActiveSupport::BufferedLogger log level constant such as
+    # ActiveSupport::BufferedLogger::DEBUG
     mattr_accessor :log_level
     self.log_level = ActiveSupport::BufferedLogger::INFO
   end
@@ -179,8 +183,8 @@ module GraphMediator
       # (This is overwritten by GraphMediator._include_new_proxy)
       def mediator_hash_key; end
 
-      # Unique key to access a thread local array of mediators of new records for
-      # specific #{base}::MediatorProxy type.
+      # Unique key to access a thread local array of mediators of new records
+      # for specific #{base}::MediatorProxy type.
       #
       # (This is overwritten by GraphMediator._include_new_proxy)
       def mediator_new_array_key; end
@@ -212,7 +216,10 @@ module GraphMediator
     def mediated_transaction(&block)
       m_debug("#{self}.mediated_transaction called")
       mediator = _get_mediator
-      result = mediator.mediate(&block)
+      result = nil
+      transaction do
+        result = mediator.mediate(&block)
+      end
       m_debug("#{self}.mediated_transaction completed successfully")
       return result
     ensure
@@ -288,8 +295,8 @@ module GraphMediator
       self.class.mediators_for_new_records
     end
 
-    # Accessor for the mediator associated with this instance's id, or nil if we are
-    # not currently mediating.
+    # Accessor for the mediator associated with this instance's id, or nil if
+    # we are not currently mediating.
     def current_mediator
       m_debug("#{self}.current_mediator called")
       mediator = mediators[self.id]
@@ -323,16 +330,17 @@ module GraphMediator
     private
 
     # Wraps each method in a mediated_transaction call.
-    # The original method is aliased as :method_without_mediation so that it can be
-    # overridden separately if needed.
+    # The original method is aliased as :method_without_mediation so that it
+    # can be overridden separately if needed.
     #
     # * options:
     #   * :through => root node accessor that will be the target of the
-    #   mediated_transaction.  By default self is assumed.
+    #     mediated_transaction.  By default self is assumed.
     #   * :track_changes => if true, the mediator will track changes such
-    #   that they can be reviewed after_mediation.  The after_mediation
-    #   callbacks occur after dirty has completed and changes are normally lost.
-    #   False by default.  Normally only applied to save and destroy methods.
+    #     that they can be reviewed after_mediation.  The after_mediation
+    #     callbacks occur after dirty has completed and changes are normally
+    #     lost.  False by default.  Normally only applied to save and destroy
+    #     methods.
     def _register_for_mediation(*methods)
       options = methods.extract_options!
       root_node_accessor = options[:through]
@@ -426,16 +434,16 @@ module GraphMediator
   #
   # * before_mediation - runs before mediation is begun
   # * - mediate and save
-  # * mediate_reconciles - after saveing the instance, run any routines to make further 
-  #   adjustments to the structure of the graph or non-cache attributes
+  # * mediate_reconciles - after saveing the instance, run any routines to make
+  #   further adjustments to the structure of the graph or non-cache attributes
   # * mediate_caches - routines for updating cache values
   #
   # Example: 
   #
-  # mediate_reconciles :bar do |instance|
-  #   instance.something_else
-  # end
-  # mediate_reconciles :baz
+  #  mediate_reconciles :bar do |instance|
+  #    instance.something_else
+  #  end
+  #  mediate_reconciles :baz
   #
   # will ensure that [:bar, <block>, :baz] are run in 
   # sequence after :foo is done saveing within the context of a mediated
@@ -448,7 +456,7 @@ module GraphMediator
     # for mediation.
     #
     # * :methods => list of methods to mediate (automatically wrap in a
-    # mediated_transaction call)
+    #   mediated_transaction call)
     #
     # ActiveRecord::Base.save is decorated for mediation when GraphMediator
     # is included into your model.  If you have additional methods which 
@@ -462,15 +470,15 @@ module GraphMediator
     # * :options => hash of options
     #   * :dependencies => list of dependent member classes whose save methods
     #     should be decorated for mediation as well.
-    #   * :when_reconciling => list of methods to execute during the after_mediation 
-    #     reconcilation phase
-    #   * :when_cacheing => list of methods to execute during the after_mediation 
-    #     cacheing phase
+    #   * :when_reconciling => list of methods to execute during the
+    #     after_mediation reconcilation phase
+    #   * :when_cacheing => list of methods to execute during the
+    #     after_mediation cacheing phase
     #
-    # mediate :update_children,
-    #   :dependencies => Child,
-    #   :when_reconciling => :reconcile,
-    #   :when_caching => :cache 
+    #  mediate :update_children,
+    #    :dependencies => Child,
+    #    :when_reconciling => :reconcile,
+    #    :when_caching => :cache 
     #
     # = Dependent Classes
     #
@@ -483,11 +491,13 @@ module GraphMediator
     #
     # GraphMediator uses the class's lock_column (default +lock_version+) and
     # +updated_at+ or +updated_on+ for versioning and locks checks during
-    # mediation.  The lock_column is incremented only once during a mediated_transaction.
+    # mediation.  The lock_column is incremented only once during a
+    # mediated_transaction.
     # 
-    # +Unless both these columns are present in the schema, versioning/locking
-    # will not happen.+  A lock_column by itself will not be updated unless
-    # there is an updated_at/on timestamp available to touch.
+    # <em>Unless both these columns are present in the schema,
+    # versioning/locking will not happen.</em>  A lock_column by itself will
+    # not be updated unless there is an updated_at/on timestamp available to
+    # touch.
     # 
     def mediate(*methods)
       options = methods.extract_options!

data/spec/examples/dingo_pen_example_spec.rb

@@ -200,7 +200,7 @@ describe "DingoPen" do
       dp.lock_version.should == 1
     end
 
-    it "should succed without mediation" do
+    it "should succeed without mediation" do
       begin
         DingoPen.disable_all_mediation!
         dp = DingoPen.new(@dingo_pen_attributes)

data/spec/integration/transactions_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+require 'reservations/party_lodging'
+require 'reservations/lodging'
+require 'reservations/party'
+require 'reservations/reservation'
+
+describe "GraphMediator transaction scenarios" do
+
+  before(:all) do
+    load 'reservations/schema.rb'
+  end
+
+  before(:each) do
+    @today = Date.today
+    @r1 = Reservation.create!(:starts => @today, :ends => @today + 1, :name => 'foo')
+  end
+
+  it "should implicitly provide an activerecord transaction for mediated_transaction" do
+    lambda {
+      @r1.mediated_transaction do
+        @r1.parties.create(:name => 'Bob')
+        raise('should cause transaction rollback')
+      end
+    }.should raise_error(RuntimeError)
+    @r1.reload
+    @r1.parties.should be_empty 
+  end
+
+  it "should handle rollback in a mediated_transaction" do
+    @r1.mediated_transaction do
+      @r1.parties.create(:name => 'Bob')
+      raise(ActiveRecord::Rollback)
+    end
+    @r1.reload
+    @r1.parties.should be_empty 
+  end
+
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Josh Partlow
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-29 00:00:00 -08:00
+date: 2010-12-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,6 +101,7 @@ files:
 - spec/integration/locking_tests_spec.rb
 - spec/integration/nesting_spec.rb
 - spec/integration/threads_spec.rb
+- spec/integration/transactions_spec.rb
 - spec/integration/validation_spec.rb
 - spec/investigation/alias_method_chain_spec.rb
 - spec/investigation/insert_subclass_spec.rb
@@ -157,6 +158,7 @@ test_files:
 - spec/integration/locking_tests_spec.rb
 - spec/integration/nesting_spec.rb
 - spec/integration/threads_spec.rb
+- spec/integration/transactions_spec.rb
 - spec/integration/validation_spec.rb
 - spec/investigation/alias_method_chain_spec.rb
 - spec/investigation/insert_subclass_spec.rb