aasm 4.9.0 → 4.10.0

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -1,5 +1,3 @@
-require_relative 'base'
-
 module AASM
   module Persistence
     module MongoidPersistence
@@ -33,10 +31,23 @@ module AASM
       def self.included(base)
         base.send(:include, AASM::Persistence::Base)
         base.send(:include, AASM::Persistence::MongoidPersistence::InstanceMethods)
+        base.extend AASM::Persistence::MongoidPersistence::ClassMethods
 
         base.after_initialize :aasm_ensure_initial_state
       end
 
+      module ClassMethods
+        def aasm_create_scope(state_machine_name, scope_name)
+          scope_options = lambda {
+            send(
+              :where,
+              { aasm(state_machine_name).attribute_name.to_sym => scope_name.to_s }
+            )
+          }
+          send(:scope, scope_name, scope_options)
+        end
+      end
+
       module InstanceMethods
 
         # Writes <tt>state</tt> to the state column and persists it to the database
@@ -95,8 +106,17 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          AASM::StateMachine[self.class].keys.each do |state_machine_name|
-            send("#{self.class.aasm(state_machine_name).attribute_name}=", aasm(state_machine_name).enter_initial_state.to_s) if send(self.class.aasm(state_machine_name).attribute_name).blank?
+          AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |state_machine_name|
+            attribute_name = self.class.aasm(state_machine_name).attribute_name.to_s
+            # Do not load initial state when object attributes are not loaded,
+            # mongoid has_many relationship does not load child object attributes when
+            # only ids are loaded, for example parent.child_ids will not load child object attributes.
+            # This feature is introduced in mongoid > 4.
+            if attribute_names.include?(attribute_name) && attributes[attribute_name].blank?
+              # attribute_missing? is defined in mongoid > 4
+              return if Mongoid::VERSION.to_f >= 4 && attribute_missing?(attribute_name)
+              send("#{self.class.aasm(state_machine_name).attribute_name}=", aasm(state_machine_name).enter_initial_state.to_s)
+            end
           end
         end
       end # InstanceMethods

data/lib/aasm/persistence/redis_persistence.rb

@@ -0,0 +1,107 @@
+module AASM
+  module Persistence
+    module RedisPersistence
+
+      def self.included(base)
+        base.send(:include, AASM::Persistence::Base)
+        base.send(:include, AASM::Persistence::RedisPersistence::InstanceMethods)
+      end
+
+      module InstanceMethods
+        # Add the inital value to intiializer
+        #
+        # redis-objects removed the key from redis when set to nil
+        def initialize(*args)
+          super
+          state = send(self.class.aasm.attribute_name)
+          state.value = aasm.determine_state_name(self.class.aasm.initial_state)
+        end
+        # Returns the value of the aasm.attribute_name - called from <tt>aasm.current_state</tt>
+        #
+        # If it's a new record, and the aasm state column is blank it returns the initial state
+        #
+        #   class Foo
+        #     include Redis::Objects
+        #     include AASM
+        #     aasm :column => :status do
+        #       state :opened
+        #       state :closed
+        #     end
+        #   end
+        #
+        #   foo = Foo.new
+        #   foo.current_state # => :opened
+        #   foo.close
+        #   foo.current_state # => :closed
+        #
+        #   foo = Foo[1]
+        #   foo.current_state # => :opened
+        #   foo.aasm_state = nil
+        #   foo.current_state # => nil
+        #
+        # NOTE: intended to be called from an event
+        #
+        # This allows for nil aasm states - be sure to add validation to your model
+        def aasm_read_state(name=:default)
+          state = send(self.class.aasm(name).attribute_name)
+
+          if state.value.nil?
+            nil
+          else
+            state.value.to_sym
+          end
+        end
+
+        # Ensures that if the aasm_state column is nil and the record is new
+        # that the initial state gets populated before validation on create
+        #
+        #   foo = Foo.new
+        #   foo.aasm_state # => nil
+        #   foo.valid?
+        #   foo.aasm_state # => "open" (where :open is the initial state)
+        #
+        #
+        #   foo = Foo.find(:first)
+        #   foo.aasm_state # => 1
+        #   foo.aasm_state = nil
+        #   foo.valid?
+        #   foo.aasm_state # => nil
+        #
+        def aasm_ensure_initial_state
+          aasm.enter_initial_state if
+          send(self.class.aasm.attribute_name).to_s.strip.empty?
+        end
+
+        # Writes <tt>state</tt> to the state column and persists it to the database
+        #
+        #   foo = Foo[1]
+        #   foo.aasm.current_state # => :opened
+        #   foo.close!
+        #   foo.aasm.current_state # => :closed
+        #   Foo[1].aasm.current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state(state)
+          aasm_column = self.class.aasm.attribute_name
+          self.send("#{aasm_column}=", state)
+        end
+
+        # Writes <tt>state</tt> to the state column, but does not persist it to the database
+        #
+        #   foo = Foo[1]
+        #   foo.aasm.current_state # => :opened
+        #   foo.close
+        #   foo.aasm.current_state # => :closed
+        #   Foo[1].aasm.current_state # => :opened
+        #   foo.save
+        #   foo.aasm.current_state # => :closed
+        #   Foo[1].aasm.current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state_without_persistence(state)
+          send("#{self.class.aasm.attribute_name}=", state)
+        end
+      end
+    end
+  end
+end

data/lib/aasm/persistence/sequel_persistence.rb

@@ -1,5 +1,3 @@
-require_relative 'base'
-
 module AASM
   module Persistence
     module SequelPersistence
@@ -71,7 +69,7 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          AASM::StateMachine[self.class].keys.each do |state_machine_name|
+          AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |state_machine_name|
             aasm(state_machine_name).enter_initial_state if
               (new? || values.key?(self.class.aasm(state_machine_name).attribute_name)) &&
               send(self.class.aasm(state_machine_name).attribute_name).to_s.strip.empty?

data/lib/aasm/state_machine.rb

@@ -1,14 +1,6 @@
 module AASM
   class StateMachine
-
-    # the following two methods provide the storage of all state machines
-    def self.[](klass)
-      (@machines ||= {})[klass.to_s]
-    end
-
-    def self.[]=(klass, machine)
-      (@machines ||= {})[klass.to_s] = machine
-    end
+    # the following four methods provide the storage of all state machines
 
     attr_accessor :states, :events, :initial_state, :config, :name, :global_callbacks
 

data/lib/aasm/state_machine_store.rb

@@ -0,0 +1,73 @@
+module AASM
+  class StateMachineStore
+    class << self
+      def stores
+        @stores ||= {}
+      end
+
+      # do not overwrite existing state machines, which could have been created by
+      # inheritance, see AASM::ClassMethods method inherited
+      def register(klass, overwrite = false, state_machine = nil)
+        raise "Cannot register #{klass}" unless klass.is_a?(Class)
+
+        case name = template = overwrite
+          when FalseClass then stores[klass.to_s] ||= new
+          when TrueClass then stores[klass.to_s] = new
+          when Class then stores[klass.to_s] = stores[template.to_s].clone
+          when Symbol then stores[klass.to_s].register(name, state_machine)
+          when String then stores[klass.to_s].register(name, state_machine)
+          else raise "Don't know what to do with #{overwrite}"
+        end
+      end
+      alias_method :[]=, :register
+
+      def fetch(klass, fallback = nil)
+        stores[klass.to_s] || fallback && begin
+          match = klass.ancestors.find do |ancestor|
+            ancestor.include? AASM and stores[ancestor.to_s]
+          end
+
+          stores[match.to_s]
+        end
+      end
+      alias_method :[], :fetch
+
+      def unregister(klass)
+        stores.delete(klass.to_s)
+      end
+    end
+
+    def initialize
+      @machines = {}
+    end
+
+    def clone
+      StateMachineStore.new.tap do |store|
+        @machines.each_pair do |name, machine|
+          store.register(name, machine.clone)
+        end
+      end
+    end
+
+    def machine(name)
+      @machines[name.to_s]
+    end
+    alias_method :[], :machine
+
+    def machine_names
+      @machines.keys
+    end
+    alias_method :keys, :machine_names
+
+    def register(name, machine, force = false)
+      raise "Cannot use #{name.inspect} for machine name" unless name.is_a?(Symbol) or name.is_a?(String)
+      raise "Cannot use #{machine.inspect} as a machine" unless machine.is_a?(AASM::StateMachine)
+
+      if force
+        @machines[name.to_s] = machine
+      else
+        @machines[name.to_s] ||= machine
+      end
+    end
+  end
+end

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.9.0"
+  VERSION = "4.10.0"
 end

data/lib/generators/active_record/templates/migration_existing.rb

@@ -1,9 +1,5 @@
-class AddAASMTo<%= table_name.camelize %> < ActiveRecord::Migration
-  def self.up
+class Add<%= column_name.camelize %>To<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
     add_column :<%= table_name %>, :<%= column_name %>, :string
   end
-
-  def self.down
-    remove_column :<%= table_name %>, :<%= column_name %>
-  end
 end

data/lib/motion-aasm.rb

@@ -0,0 +1,35 @@
+unless defined?(Motion::Project::App)
+  raise "This must be required from within a RubyMotion Rakefile"
+end
+
+file_dependencies = {
+  'aasm/aasm.rb' => ['aasm/persistence.rb'],
+  'aasm/persistence.rb' => ['aasm/persistence/plain_persistence.rb', 'aasm/persistence/core_data_query_persistence.rb'],
+  'aasm/persistence/base.rb' => ['aasm/base.rb'],
+  'aasm/persistence/core_data_query_persistence.rb' => ['aasm/persistence/base.rb']
+}
+
+exclude_files = [
+  'aasm/rspec.*',
+  'aasm/persistence/active_record_persistence.rb',
+  'aasm/persistence/dynamoid_persistence.rb',
+  'aasm/persistence/mongo_mapper_persistence.rb',
+  'aasm/persistence/mongoid_persistence.rb',
+  'aasm/persistence/sequel_persistence.rb',
+  'aasm/persistence/redis_persistence.rb'
+]
+
+Motion::Project::App.setup do |app|
+  parent = File.expand_path File.dirname(__FILE__)
+
+  app.files.unshift Dir.glob(File.join(parent, "aasm/**/*.rb")).reject { |file| exclude_files.any? { |exclude| file.match(exclude) } }
+
+  app.files_dependencies file_dependencies.inject({}, &->(file_dependencies, (file, *dependencies)) do
+    file = File.join(parent, file)
+    dependencies = dependencies.flatten(1).map do |dependency|
+      File.join(parent, dependency)
+    end
+
+    file_dependencies.merge({ file => dependencies })
+  end)
+end

data/spec/models/callbacks/basic.rb

@@ -39,8 +39,15 @@ module Callbacks
         :exit         => :exit_closed,
         :after_exit   => :after_exit_closed
 
-      event :close, :before => :before_event, :after => :after_event, :guard => :event_guard, :ensure => :ensure_event do
-        transitions :to => :closed, :from => [:open], :guard => :transition_guard, :after => :after_transition
+      event :close,
+            :before => :before_event,
+            :after => :after_event,
+            :guard => :event_guard,
+            :ensure => :ensure_event do
+        transitions :to => :closed, :from => [:open],
+                    :guard => :transition_guard,
+                    :after => :after_transition,
+                    :success => :success_transition
       end
 
       event :open, :before => :before_event, :after => :after_event  do
@@ -79,6 +86,9 @@ module Callbacks
     def after_event;              log('after_event');         end
     def after_all_events;         log('after_all_events');    end
 
+    def after_transition;     log('after_transition');    end
+    def success_transition;   log('transition_success');  end
+
     def ensure_event;             log('ensure');              end
     def ensure_on_all_events;     log('ensure');              end
   end

data/spec/models/callbacks/guard_within_block.rb

@@ -26,7 +26,7 @@ module Callbacks
         :after_exit   => :after_exit_closed
 
       event :close, :before => :before, :after => :after, :guard => :event_guard do
-        transitions :to => :closed, :from => [:open], :after => :transitioning do
+        transitions :to => :closed, :from => [:open], :after => :transitioning, :success => :success_transition do
           guard do
             transition_guard
           end
@@ -59,6 +59,7 @@ module Callbacks
     def event_guard; log('event_guard'); !@fail_event_guard; end
     def transition_guard; log('transition_guard'); !@fail_transition_guard; end
     def transitioning; log('transitioning'); end
+    def success_transition; log('success transition'); end
 
     def before; log('before'); end
     def after; log('after'); end

data/spec/models/callbacks/multiple_transitions_transition_guard.rb

@@ -28,7 +28,7 @@ module Callbacks
       state :failed
 
       event :close, :before => :before, :after => :after, :guard => :event_guard do
-        transitions :to => :closed, :from => [:open], :guard => :transition_guard, :after => :transitioning
+        transitions :to => :closed, :from => [:open], :guard => :transition_guard, :after => :transitioning, :success => :success_transition
         transitions :to => :failed, :from => [:open]
       end
 
@@ -58,6 +58,7 @@ module Callbacks
     def event_guard; log('event_guard'); !@fail_event_guard; end
     def transition_guard; log('transition_guard'); !@fail_transition_guard; end
     def transitioning; log('transitioning'); end
+    def success_transition; log('transition success'); end
 
     def before; log('before'); end
     def after; log('after'); end

data/spec/models/callbacks/with_args.rb

@@ -29,7 +29,7 @@ module Callbacks
         :after_exit   => :after_exit_closed
 
       event :close, :before => :before, :after => :after do
-        transitions :to => :closed, :from => [:open], :after => :transition_proc
+        transitions :to => :closed, :from => [:open], :after => :transition_proc, :success => :transition_success_proc
       end
 
       event :open, :before => :before, :after => :after do
@@ -57,5 +57,6 @@ module Callbacks
     def before(arg1, *args); log("before(#{arg1.inspect},#{args.map(&:inspect).join(',')})"); end
     def transition_proc(arg1, arg2); log("transition_proc(#{arg1.inspect},#{arg2.inspect})"); end
     def after(*args); log("after(#{args.map(&:inspect).join(',')})"); end
+    def transition_success_proc(*args); log("transition_success(#{args.map(&:inspect).join(',')})"); end
   end
 end

data/spec/models/callbacks/with_state_arg.rb

@@ -9,8 +9,8 @@ module Callbacks
       state :out_to_lunch
 
       event :close, :before => :before_method, :after => :after_method do
-        transitions :to => :closed, :from => [:open], :after => :transition_method
-        transitions :to => :out_to_lunch, :from => [:open], :after => :transition_method2
+        transitions :to => :closed, :from => [:open], :after => :transition_method, :success => :success_method
+        transitions :to => :out_to_lunch, :from => [:open], :after => :transition_method2, :success => :success_method2
       end
     end
 
@@ -22,5 +22,9 @@ module Callbacks
 
     def transition_method2(arg); end
 
+    def success_method(arg); end
+
+    def success_method2(arg); end
+
   end
 end

data/spec/models/mongoid/mongoid_relationships.rb

@@ -0,0 +1,26 @@
+class Parent
+  include Mongoid::Document
+  include AASM
+
+  field :status, :type => String
+  has_many :childs
+
+  aasm column: :status do
+    state :unknown_scope
+    state :new
+  end
+end
+
+class Child
+  include Mongoid::Document
+  include AASM
+  field :parent_id
+
+  field :status, :type => String
+  belongs_to :parent
+
+  aasm column: :status do
+    state :unknown_scope
+    state :new
+  end
+end

data/spec/models/namespaced_multiple_example.rb

@@ -0,0 +1,28 @@
+class NamespacedMultipleExample
+  include AASM
+  aasm(:status) do
+    state :unapproved, :initial => true
+    state :approved
+
+    event :approve do
+      transitions :from => :unapproved, :to => :approved
+    end
+
+    event :unapprove do
+      transitions :from => :approved, :to => :unapproved
+    end
+  end
+
+  aasm(:review_status, namespace: :review) do
+    state :unapproved, :initial => true
+    state :approved
+
+    event :approve_review do
+      transitions :from => :unapproved, :to => :approved
+    end
+
+    event :unapprove_review do
+      transitions :from => :approved, :to => :unapproved
+    end
+  end
+end