state_machines 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 592765d98fcb41a672f7aab26d298b350095f2f1
-  data.tar.gz: f5b1d1c24d1d6fef21593c9cccd1a284999f13f5
+  metadata.gz: dfbc8746b1a9da7b7103d3f4aeb4aac4f9774874
+  data.tar.gz: 7fea0a568c143c925769dde22c1259bc909f8bb8
 SHA512:
-  metadata.gz: 6c2fca5379dd4adeac3f69560bacb568117ed3a41c0d65bba0c716c25655cf3a05b958d73db464479e16ecfd9ee4ab269ad37808a74551a8b5e86332a1557154
-  data.tar.gz: 6ec09db4711dad2e998e87ce9d5a645e26429d498c50c5a739ae6911b1ce9e2b23a3176962226ef92d40d19aaf2bad5734f4d3ec82d7a8709a3275ec2774f280
+  metadata.gz: 3a38794da50af36c33211543369062c8c8bdc3675617bbf4a2fa348da9e462315c30da692d06831840db515d45c42542e29d9428251fba9b5ce67270f6a30938
+  data.tar.gz: c6bf5cba1b08470e6533ce4f32a6a9eac23decb8d915c303b7f3a2f349578d58357f9c8a063df040ec770858cd0cfddd5ac8c6826788d794254a94555e59dd2e

data/Changelog.md

@@ -1,3 +1,5 @@
+*   Fixed inconsistent use of :use_transactions 
+
 *   Namespaced integrations are not registered by default anymore
 
 *   Pass `static: false` in case you don't want initial states to be forced. e.g.

data/README.md

@@ -39,7 +39,7 @@ Class definition:
 class Vehicle
   attr_accessor :seatbelt_on, :time_used, :auto_shop_busy
 
-  state_machine state, initial: :parked do
+  state_machine :state, initial: :parked do
     before_transition parked: :any - :parked, do: :put_on_seatbelt
 
     after_transition on: :crash, do: :tow
@@ -591,7 +591,6 @@ For documenting state machines:
 ## TODO
 
 * Add matchers/assertions for rspec and minitest
-* Fix integrations dependency
 
 ## Contributing
 

data/lib/state_machines/machine_collection.rb

@@ -25,50 +25,49 @@ module StateMachines
 
       result = yield if block_given?
 
-      each_value do |machine| 
+      each_value do |machine|
         unless machine.dynamic_initial_state?
           force = options[:static] == :force || !attributes.keys.map(&:to_sym).include?(machine.attribute)
           machine.initialize_state(object, force: force, :to => options[:to])
         end
       end if options[:static]
-      
+
       each_value do |machine|
         machine.initialize_state(object, :force => options[:dynamic] == :force, :to => options[:to]) if machine.dynamic_initial_state?
       end if options[:dynamic]
 
       result
     end
-    
+
     # Runs one or more events in parallel on the given object.  See
     # StateMachines::InstanceMethods#fire_events for more information.
     def fire_events(object, *events)
       run_action = [true, false].include?(events.last) ? events.pop : true
-      
+
       # Generate the transitions to run for each event
       transitions = events.collect do |event_name|
         # Find the actual event being run
         event = nil
         detect {|name, machine| event = machine.events[event_name, :qualified_name]}
-        
+
         raise(InvalidEvent.new(object, event_name)) unless event
-        
+
         # Get the transition that will be performed for the event
         unless transition = event.transition_for(object)
           event.on_failure(object)
         end
-        
         transition
       end.compact
-      
+
       # Run the events in parallel only if valid transitions were found for
       # all of them
       if events.length == transitions.length
-        TransitionCollection.new(transitions, :actions => run_action).perform
+        TransitionCollection.new(transitions, {use_transactions: resolve_use_transactions, actions: run_action}).perform
       else
         false
       end
     end
-    
+
     # Builds the collection of transitions for all event attributes defined on
     # the given object.  This will only include events whose machine actions
     # match the one specified.
@@ -78,8 +77,20 @@ module StateMachines
       transitions = map do |name, machine|
         machine.events.attribute_transition_for(object, true) if machine.action == action
       end
-      
-      AttributeTransitionCollection.new(transitions.compact, options)
+
+      AttributeTransitionCollection.new(transitions.compact, {use_transactions: resolve_use_transactions}.merge(options))
+    end
+
+    protected
+
+    def resolve_use_transactions
+      use_transactions = nil
+      each_value do |machine|
+        # Determine use_transactions setting for this set of transitions.  If from multiple state_machines, the settings must match.
+        raise 'Encountered mismatched use_transactions configurations for multiple state_machines' if !use_transactions.nil? && use_transactions != machine.use_transactions
+        use_transactions = machine.use_transactions
+      end
+      use_transactions
     end
   end
 end

data/lib/state_machines/transition.rb

@@ -160,7 +160,7 @@ module StateMachines
       self.args = args
       
       # Run the transition
-      !!TransitionCollection.new([self], :actions => run_action).perform
+      !!TransitionCollection.new([self], {use_transactions: machine.use_transactions, actions: run_action}).perform
     end
     
     # Runs a block within a transaction for the object being transitioned.

data/lib/state_machines/transition_collection.rb

@@ -10,7 +10,7 @@ module StateMachines
     attr_reader :skip_after
     
     # Whether transitions should wrapped around a transaction block
-    attr_reader :use_transaction
+    attr_reader :use_transactions
     
     # Creates a new collection of transitions that can be run in parallel.  Each
     # transition *must* be for a different attribute.
@@ -29,11 +29,11 @@ module StateMachines
       attributes = map {|transition| transition.attribute}.uniq
       fail ArgumentError, 'Cannot perform multiple transitions in parallel for the same state machine attribute' if attributes.length != length
 
-      options.assert_valid_keys(:actions, :after, :transaction)
-      options = {:actions => true, :after => true, :transaction => true}.merge(options)
+      options.assert_valid_keys(:actions, :after, :use_transactions)
+      options = {actions: true, after: true, use_transactions: true}.merge(options)
       @skip_actions = !options[:actions]
       @skip_after = !options[:after]
-      @use_transaction = options[:transaction]
+      @use_transactions = options[:use_transactions]
     end
     
     # Runs each of the collection's transitions in parallel.
@@ -177,7 +177,7 @@ module StateMachines
       # Runs a block within a transaction for the object being transitioned.  If
       # transactions are disabled, then this is a no-op.
       def within_transaction
-        if use_transaction && !empty?
+        if use_transactions && !empty?
           first.within_transaction do
             yield
             success?
@@ -192,7 +192,7 @@ module StateMachines
   # based events
   class AttributeTransitionCollection < TransitionCollection
     def initialize(transitions = [], options = {}) #:nodoc:
-      super(transitions, {:transaction => false, :actions => false}.merge(options))
+      super(transitions, {use_transactions: false, :actions => false}.merge(options))
     end
     
     private

data/lib/state_machines/version.rb

@@ -1,3 +1,3 @@
 module StateMachines
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/test/unit/transition_collection/attribute_transition_collection_by_default_test.rb

@@ -14,7 +14,7 @@ class AttributeTransitionCollectionByDefaultTest < StateMachinesTest
   end
 
   def test_should_not_use_transaction
-    refute @transitions.use_transaction
+    refute @transitions.use_transactions
   end
 
   def test_should_be_empty

data/test/unit/transition_collection/transition_collection_by_default_test.rb

@@ -14,7 +14,7 @@ class TransitionCollectionByDefaultTest < StateMachinesTest
   end
 
   def test_should_use_transaction
-    assert @transitions.use_transaction
+    assert @transitions.use_transactions
   end
 
   def test_should_be_empty

data/test/unit/transition_collection/transition_collection_test.rb

@@ -3,7 +3,7 @@ require_relative '../../test_helper'
 class TransitionCollectionTest < StateMachinesTest
   def test_should_raise_exception_if_invalid_option_specified
     exception = assert_raises(ArgumentError) { StateMachines::TransitionCollection.new([], invalid: true) }
-    assert_equal 'Unknown key: :invalid. Valid keys are: :actions, :after, :transaction', exception.message
+    assert_equal 'Unknown key: :invalid. Valid keys are: :actions, :after, :use_transactions', exception.message
   end
 
   def test_should_raise_exception_if_multiple_transitions_for_same_attribute_specified

data/test/unit/transition_collection/transition_collection_with_transactions_test.rb

@@ -21,7 +21,7 @@ class TransitionCollectionWithTransactionsTest < StateMachinesTest
     @object = @klass.new
     @transitions = StateMachines::TransitionCollection.new([
       StateMachines::Transition.new(@object, @machine, :ignite, :parked, :idling)
-    ], transaction: true)
+    ], use_transactions: true)
   end
 
   def test_should_run_before_callbacks_within_transaction

data/test/unit/transition_collection/transition_collection_without_transactions_test.rb

@@ -19,7 +19,7 @@ class TransitionCollectionWithoutTransactionsTest < StateMachinesTest
     @object = @klass.new
     @transitions = StateMachines::TransitionCollection.new([
       StateMachines::Transition.new(@object, @machine, :ignite, :parked, :idling)
-    ], transaction: false)
+    ], use_transactions: false)
     @transitions.perform
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -354,39 +354,19 @@ files:
 - test/unit/matcher_helpers/matcher_helpers_all_test.rb
 - test/unit/matcher_helpers/matcher_helpers_any_test.rb
 - test/unit/matcher_helpers/matcher_helpers_same_test.rb
-- |-
-  test/unit/node_collection/node_collection_after_being_copied_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_after_update_test
-  .rb
+- test/unit/node_collection/node_collection_after_being_copied_test.rb
+- test/unit/node_collection/node_collection_after_update_test.rb
 - test/unit/node_collection/node_collection_by_default_test.rb
 - test/unit/node_collection/node_collection_test.rb
-- |-
-  test/unit/node_collection/node_collection_with_indices_test
-  .rb
+- test/unit/node_collection/node_collection_with_indices_test.rb
 - test/unit/node_collection/node_collection_with_matcher_contexts_test.rb
-- |-
-  test/unit/node_collection/node_collection_with_nodes_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_numeric_index_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_postdefined_contexts_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_predefined_contexts_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_string_index_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_symbol_index_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_without_indices_test
-  .rb
+- test/unit/node_collection/node_collection_with_nodes_test.rb
+- test/unit/node_collection/node_collection_with_numeric_index_test.rb
+- test/unit/node_collection/node_collection_with_postdefined_contexts_test.rb
+- test/unit/node_collection/node_collection_with_predefined_contexts_test.rb
+- test/unit/node_collection/node_collection_with_string_index_test.rb
+- test/unit/node_collection/node_collection_with_symbol_index_test.rb
+- test/unit/node_collection/node_collection_without_indices_test.rb
 - test/unit/path/path_by_default_test.rb
 - test/unit/path/path_test.rb
 - test/unit/path/path_with_available_transitions_after_reaching_target_test.rb
@@ -817,39 +797,19 @@ test_files:
 - test/unit/matcher_helpers/matcher_helpers_all_test.rb
 - test/unit/matcher_helpers/matcher_helpers_any_test.rb
 - test/unit/matcher_helpers/matcher_helpers_same_test.rb
-- |-
-  test/unit/node_collection/node_collection_after_being_copied_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_after_update_test
-  .rb
+- test/unit/node_collection/node_collection_after_being_copied_test.rb
+- test/unit/node_collection/node_collection_after_update_test.rb
 - test/unit/node_collection/node_collection_by_default_test.rb
 - test/unit/node_collection/node_collection_test.rb
-- |-
-  test/unit/node_collection/node_collection_with_indices_test
-  .rb
+- test/unit/node_collection/node_collection_with_indices_test.rb
 - test/unit/node_collection/node_collection_with_matcher_contexts_test.rb
-- |-
-  test/unit/node_collection/node_collection_with_nodes_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_numeric_index_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_postdefined_contexts_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_predefined_contexts_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_string_index_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_with_symbol_index_test
-  .rb
-- |-
-  test/unit/node_collection/node_collection_without_indices_test
-  .rb
+- test/unit/node_collection/node_collection_with_nodes_test.rb
+- test/unit/node_collection/node_collection_with_numeric_index_test.rb
+- test/unit/node_collection/node_collection_with_postdefined_contexts_test.rb
+- test/unit/node_collection/node_collection_with_predefined_contexts_test.rb
+- test/unit/node_collection/node_collection_with_string_index_test.rb
+- test/unit/node_collection/node_collection_with_symbol_index_test.rb
+- test/unit/node_collection/node_collection_without_indices_test.rb
 - test/unit/path/path_by_default_test.rb
 - test/unit/path/path_test.rb
 - test/unit/path/path_with_available_transitions_after_reaching_target_test.rb