state_machines 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f3852a59e959d4add7fbde2dc0252eee9ac51a7
-  data.tar.gz: 41ee2c50b0bbcc40691cfe6ff13fed6ab5d14ce7
+  metadata.gz: '029961fc61666a778298a5b6e5b5b31802b8710f'
+  data.tar.gz: d9e00ff04cbffbaf522e82b40e76aeb9c9ab3564
 SHA512:
-  metadata.gz: fa703fb24e2453a0fe96c386b83ab52a633698a8dd7b5d9de9afd48e3d9ee81c058e963d2a7546fe009266e50d22ecd9adfb9575fdb81ebe55dbe9ad166795ac
-  data.tar.gz: 5f74b1a302c64c4a0d6046decb74bb7e5e167f11bb3675795c6f53d46a2f235c7a91c31f9cd03b1e63c4246330b958937dd113413a2e8c96e6ce1e29f9759292
+  metadata.gz: 52f6b57620f17c661585a1bccf2340d46be80366f2a7de609c41033ff46024cc62fc17814279267b26de65974612f149c0a057b47f2396e45f842c249742c9cd
+  data.tar.gz: b8bbe1923532edffd936139272782d6053b0ab8f1b338eaf61f805fbbc2a3b1c284bd523c35a375fc40fecb6f4948cb4aabcfc72c0fda5ded46959557a20b1cc

data/.ruby-gemset

@@ -0,0 +1 @@
+state_machines

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -6,6 +6,8 @@ rvm:
   - 2.1
   - 2.0.0
   - 2.2
+  - 2.3.4
+  - 2.4.1
   - jruby
   - rbx-2
 matrix:

data/Changelog.md

@@ -1,4 +1,10 @@
-*   Fixed inconsistent use of :use_transactions 
+## 0.5.0
+
+*   Fix states being evaluated with wrong `owner_class` context
+
+*   Fixed state machine false duplication
+
+*   Fixed inconsistent use of :use_transactions
 
 *   Namespaced integrations are not registered by default anymore
 

data/README.md

@@ -1,9 +1,11 @@
 [![Build Status](https://travis-ci.org/state-machines/state_machines.svg?branch=master)](https://travis-ci.org/state-machines/state_machines)
-[![Code Climate](https://codeclimate.com/github/state-machines/state_machines.png)](https://codeclimate.com/github/state-machines/state_machines)
+[![Code Climate](https://codeclimate.com/github/state-machines/state_machines.svg)](https://codeclimate.com/github/state-machines/state_machines)
 # State Machines
 
 State Machines adds support for creating state machines for attributes on any Ruby class.
 
+*Please note that multiple integrations are available for [Active Model](https://github.com/state-machines/state_machines-activemodel), [Active Record](https://github.com/state-machines/state_machines-activerecord), [Mongoid](https://github.com/state-machines/state_machines-mongoid) and more in the [State Machines organisation](https://github.com/state-machines).*  If you want to save state in your database, **you need one of these additional integrations**.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,10 +42,10 @@ class Vehicle
   attr_accessor :seatbelt_on, :time_used, :auto_shop_busy
 
   state_machine :state, initial: :parked do
-    before_transition parked: :any - :parked, do: :put_on_seatbelt
-
+    before_transition parked: any - :parked, do: :put_on_seatbelt
+    
     after_transition on: :crash, do: :tow
-    after_transition on: :repair, :do: :fix
+    after_transition on: :repair, do: :fix
     after_transition any => :parked do |vehicle, transition|
       vehicle.seatbelt_on = false
     end
@@ -83,7 +85,7 @@ class Vehicle
     event :repair do
       # The first transition that matches the state and passes its conditions
       # will be used
-      transition stalled: parked, unless: :auto_shop_busy
+      transition stalled: :parked, unless: :auto_shop_busy
       transition stalled: same
     end
 
@@ -217,7 +219,7 @@ vehicle.fire_events(:shift_down, :enable_alarm) # => true
 vehicle.state_name                              # => :first_gear
 vehicle.alarm_state_name                        # => :active
 
-vehicle.fire_events!(:ignite, :enable_alarm)    # => StateMachines:InvalidTransition: Cannot run events in parallel: ignite, enable_alarm
+vehicle.fire_events!(:ignite, :enable_alarm)    # => StateMachines:InvalidParallelTransition: Cannot run events in parallel: ignite, enable_alarm
 
 # Human-friendly names can be accessed for states/events
 Vehicle.human_state_name(:first_gear)               # => "first gear"
@@ -400,8 +402,8 @@ For example, transitions and callbacks can be defined like so:
 class Vehicle
   state_machine initial: :parked do
     before_transition from: :parked, except_to: :parked, do: :put_on_seatbelt
-    after_transition to: :parked do |transition|
-      self.seatbelt = 'off' # self is the record
+    after_transition to: :parked do |vehicle, transition|
+      vehicle.seatbelt = 'off'
     end
 
     event :ignite do
@@ -425,7 +427,7 @@ class Vehicle
     ...
 
     state :parked do
-      transition to::idling, :on => [:ignite, :shift_up], if: :seatbelt_on?
+      transition to: :idling, :on => [:ignite, :shift_up], if: :seatbelt_on?
 
       def speed
         0

data/lib/state_machines/extensions.rb

@@ -133,7 +133,7 @@ module StateMachines
     #   vehicle = Vehicle.new                         # => #<Vehicle:0xb7c02850 @state="parked", @alarm_state="active">
     #   vehicle.fire_events(:ignite, :disable_alarm)  # => true
     #
-    #   vehicle.fire_events!(:ignite, :disable_alarm) # => StateMachines::InvalidTranstion: Cannot run events in parallel: ignite, disable_alarm
+    #   vehicle.fire_events!(:ignite, :disable_alarm) # => StateMachines::InvalidParallelTransition: Cannot run events in parallel: ignite, disable_alarm
     def fire_events!(*events)
       run_action = [true, false].include?(events.last) ? events.pop : true
       fire_events(*(events + [run_action])) || fail(StateMachines::InvalidParallelTransition.new(self, events))

data/lib/state_machines/integrations.rb

@@ -1,5 +1,3 @@
-require 'set'
-
 module StateMachines
   # Integrations allow state machines to take advantage of features within the
   # context of a particular library.  This is currently most useful with
@@ -54,7 +52,6 @@ module StateMachines
 
       alias_method :list, :integrations
 
-
       # Attempts to find an integration that matches the given class.  This will
       # look through all of the built-in integrations under the StateMachines::Integrations
       # namespace and find one that successfully matches the class.
@@ -86,7 +83,7 @@ module StateMachines
       # == Examples
       #
       #   StateMachines::Integrations.match_ancestors([])                    # => nil
-      #   StateMachines::Integrations.match_ancestors(['ActiveRecord::Base']) # => StateMachines::Integrations::ActiveModel
+      #   StateMachines::Integrations.match_ancestors([ActiveRecord::Base]) # => StateMachines::Integrations::ActiveModel
       def match_ancestors(ancestors)
         integrations.detect { |integration| integration.matches_ancestors?(ancestors) }
       end
@@ -103,7 +100,6 @@ module StateMachines
         integrations.detect { |integration| integration.integration_name == name } || raise(IntegrationNotFound.new(name))
       end
 
-
       private
 
       def add(integration)

data/lib/state_machines/integrations/base.rb

@@ -24,20 +24,17 @@ module StateMachines
 
         # Whether the integration should be used for the given class.
         def matches?(klass)
-          matches_ancestors?(klass.ancestors.map { |ancestor| ancestor.name })
+          matching_ancestors.any? { |ancestor| klass <= ancestor }
         end
 
         # Whether the integration should be used for the given list of ancestors.
         def matches_ancestors?(ancestors)
           (ancestors & matching_ancestors).any?
         end
-
       end
 
-      extend ClassMethods
-
       def self.included(base) #:nodoc:
-        base.class_eval { extend ClassMethods }
+        base.extend ClassMethods
       end
     end
   end

data/lib/state_machines/machine.rb

@@ -419,7 +419,11 @@ module StateMachines
         name = args.first || :state
 
         # Find an existing machine
-        if owner_class.respond_to?(:state_machines) && machine = owner_class.state_machines[name]
+        machine = owner_class.respond_to?(:state_machines) &&
+          (args.first && owner_class.state_machines[name] || !args.first &&
+          owner_class.state_machines.values.first) || nil
+
+        if machine
           # Only create a new copy if changes are being made to the machine in
           # a subclass
           if machine.owner_class != owner_class && (options.any? || block_given?)
@@ -2046,14 +2050,12 @@ module StateMachines
     # the method and is further along in the ancestor chain than this
     # machine's helper module.
     def owner_class_ancestor_has_method?(scope, method)
+      return false unless owner_class_has_method?(scope, method)
+
       superclasses = owner_class.ancestors[1..-1].select { |ancestor| ancestor.is_a?(Class) }
 
       if scope == :class
-        # Use singleton classes
-        current = (
-        class << owner_class;
-          self;
-        end)
+        current = owner_class.singleton_class
         superclass = superclasses.first
       else
         current = owner_class
@@ -2068,14 +2070,16 @@ module StateMachines
 
       # Search for for the first ancestor that defined this method
       ancestors.detect do |ancestor|
-        ancestor = (
-        class << ancestor;
-          self;
-        end) if scope == :class && ancestor.is_a?(Class)
+        ancestor = ancestor.singleton_class if scope == :class && ancestor.is_a?(Class)
         ancestor.method_defined?(method) || ancestor.private_method_defined?(method)
       end
     end
 
+    def owner_class_has_method?(scope, method)
+      target = scope == :class ? owner_class.singleton_class : owner_class
+      target.method_defined?(method) || target.private_method_defined?(method)
+    end
+
     # Adds helper methods for accessing naming information about states and
     # events on the owner class
     def define_name_helpers

data/lib/state_machines/path_collection.rb

@@ -45,7 +45,7 @@ module StateMachines
     # 
     #   paths.from_states # => [:parked, :idling, :first_gear, ...]
     def from_states
-      map {|path| path.from_states}.flatten.uniq
+      flat_map(&:from_states).uniq
     end
     
     # Lists all of the states that can be transitioned to through the paths in
@@ -55,7 +55,7 @@ module StateMachines
     # 
     #   paths.to_states # => [:idling, :first_gear, :second_gear, ...]
     def to_states
-      map {|path| path.to_states}.flatten.uniq
+      flat_map(&:to_states).uniq
     end
     
     # Lists all of the events that can be fired through the paths in this
@@ -65,7 +65,7 @@ module StateMachines
     # 
     #   paths.events  # => [:park, :ignite, :shift_up, ...]
     def events
-      map {|path| path.events}.flatten.uniq
+      flat_map(&:events).uniq
     end
     
     private

data/lib/state_machines/state.rb

@@ -2,7 +2,7 @@ module StateMachines
   # A state defines a value that an attribute can be in after being transitioned
   # 0 or more times.  States can represent a value of any type in Ruby, though
   # the most common (and default) type is String.
-  # 
+  #
   # In addition to defining the machine's value, a state can also define a
   # behavioral context for an object when that object is in the state.  See
   # StateMachines::Machine#state for more information about how state-driven
@@ -10,7 +10,7 @@ module StateMachines
   class State
 
     # The state machine for which this state is defined
-    attr_accessor :machine
+    attr_reader :machine
 
     # The unique identifier for the state used in event and callback definitions
     attr_reader :name
@@ -38,7 +38,7 @@ module StateMachines
     attr_accessor :matcher
 
     # Creates a new state within the context of the given machine.
-    # 
+    #
     # Configuration options:
     # * <tt>:initial</tt> - Whether this state is the beginning state for the
     #   machine. Default is false.
@@ -86,6 +86,11 @@ module StateMachines
       @context = StateContext.new(self)
     end
 
+    def machine=(machine)
+      @machine = machine
+      @context = StateContext.new(self)
+    end
+
     # Determines whether there are any states that can be transitioned to from
     # this state.  If there are none, then this state is considered *final*.
     # Any objects in a final state will remain so forever given the current
@@ -107,15 +112,15 @@ module StateMachines
     end
 
     # Generates a human-readable description of this state's name / value:
-    # 
+    #
     # For example,
-    # 
+    #
     #   State.new(machine, :parked).description                               # => "parked"
     #   State.new(machine, :parked, :value => :parked).description            # => "parked"
     #   State.new(machine, :parked, :value => nil).description                # => "parked (nil)"
     #   State.new(machine, :parked, :value => 1).description                  # => "parked (1)"
     #   State.new(machine, :parked, :value => lambda {Time.now}).description  # => "parked (*)
-    # 
+    #
     # Configuration options:
     # * <tt>:human_name</tt> - Whether to use this state's human name in the
     #   description or just the internal name
@@ -129,9 +134,9 @@ module StateMachines
     # The value that represents this state.  This will optionally evaluate the
     # original block if it's a lambda block.  Otherwise, the static value is
     # returned.
-    # 
+    #
     # For example,
-    # 
+    #
     #   State.new(machine, :parked, :value => 1).value                        # => 1
     #   State.new(machine, :parked, :value => lambda {Time.now}).value        # => Tue Jan 01 00:00:00 UTC 2008
     #   State.new(machine, :parked, :value => lambda {Time.now}).value(false) # => <Proc:0xb6ea7ca0@...>
@@ -152,14 +157,14 @@ module StateMachines
     # Determines whether this state matches the given value.  If no matcher is
     # configured, then this will check whether the values are equivalent.
     # Otherwise, the matcher will determine the result.
-    # 
+    #
     # For example,
-    # 
+    #
     #   # Without a matcher
     #   state = State.new(machine, :parked, :value => 1)
     #   state.matches?(1)           # => true
     #   state.matches?(2)           # => false
-    #   
+    #
     #   # With a matcher
     #   state = State.new(machine, :parked, :value => lambda {Time.now}, :if => lambda {|value| !value.nil?})
     #   state.matches?(nil)         # => false
@@ -170,7 +175,7 @@ module StateMachines
 
     # Defines a context for the state which will be enabled on instances of
     # the owner class when the machine is in this state.
-    # 
+    #
     # This can be called multiple times.  Each time a new context is created,
     # a new module will be included in the owner class.
     def context(&block)
@@ -184,7 +189,7 @@ module StateMachines
       new_methods = context_methods.to_a.select { |(name, method)| old_methods[name] != method }
 
       # Alias new methods so that the only execute when the object is in this state
-      new_methods.each do |(method_name, method)|
+      new_methods.each do |(method_name, _method)|
         context_name = context_name_for(method_name)
         context.class_eval <<-end_eval, __FILE__, __LINE__ + 1
           alias_method :"#{context_name}", :#{method_name}
@@ -208,7 +213,7 @@ module StateMachines
 
     # Calls a method defined in this state's context on the given object.  All
     # arguments and any block will be passed into the method defined.
-    # 
+    #
     # If the method has never been defined for this state, then a NoMethodError
     # will be raised.
     def call(object, method, *args, &block)
@@ -239,9 +244,9 @@ module StateMachines
     end
 
     # Generates a nicely formatted description of this state's contents.
-    # 
+    #
     # For example,
-    # 
+    #
     #   state = StateMachines::State.new(machine, :parked, :value => 1, :initial => true)
     #   state   # => #<StateMachines::State name=:parked value=1 initial=true context=[]>
     def inspect

data/lib/state_machines/state_collection.rb

@@ -93,7 +93,7 @@ module StateMachines
 
       machine.events.each { |event| order += event.known_states }
       order += select { |state| state.context_methods.any? }.map { |state| state.name }
-      order += keys(:name) - machine.callbacks.values.flatten.map { |callback| callback.known_states }.flatten
+      order += keys(:name) - machine.callbacks.values.flatten.flat_map(&:known_states)
       order += keys(:name)
 
       order.uniq!

data/lib/state_machines/transition.rb

@@ -290,7 +290,7 @@ module StateMachines
       def pausable
         begin
           halted = !catch(:halt) { yield; true }
-        rescue Exception => error
+        rescue => error
           raise unless @resume_block
         end
         

data/lib/state_machines/transition_collection.rb

@@ -168,7 +168,7 @@ module StateMachines
       def catch_exceptions
         begin
           yield
-        rescue Exception
+        rescue
           rollback
           raise
         end
@@ -210,7 +210,7 @@ module StateMachines
           # Rollback only if exceptions occur during before callbacks
           begin
             super
-          rescue Exception
+          rescue
             rollback unless @before_run
             @success = nil  # mimics ActiveRecord.save behavior on rollback
             raise

data/lib/state_machines/version.rb

@@ -1,3 +1,3 @@
 module StateMachines
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/state_machines.gemspec

@@ -12,9 +12,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/state-machines/state_machines'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_ruby_version     = '>= 2.0.0'
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(/^test\//)
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '>= 1.7.6'

data/test/files/integrations/vehicle.rb

@@ -2,6 +2,6 @@ module VehicleIntegration
   include StateMachines::Integrations::Base
 
   def self.matching_ancestors
-    ['Vehicle']
+    [Vehicle]
   end
 end

data/test/files/models/driver.rb

@@ -0,0 +1,13 @@
+require_relative 'model_base'
+
+class Driver < ModelBase
+  state_machine :status, :initial => :parked do
+    event :park do
+      transition :idling => :parked
+    end
+
+    event :ignite do
+      transition :parked => :idling
+    end
+  end
+end