aasm 2.1.1 → 5.2.0

data/spec/models/active_record/transactor.rb

@@ -0,0 +1,124 @@
+class Transactor < ActiveRecord::Base
+
+  belongs_to :worker
+
+  include AASM
+  aasm :column => :status do
+    state :sleeping, :initial => true
+    state :running, :before_enter => :start_worker, :after_enter => :fail
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+
+private
+
+  def start_worker
+    worker.update_attribute(:status, 'running')
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+
+end
+
+class NoLockTransactor < ActiveRecord::Base
+
+  belongs_to :worker
+
+  include AASM
+
+  aasm :column => :status do
+    state :sleeping, :initial => true
+    state :running
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+end
+
+class LockTransactor < ActiveRecord::Base
+
+  belongs_to :worker
+
+  include AASM
+
+  aasm :column => :status, requires_lock: true do
+    state :sleeping, :initial => true
+    state :running
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+end
+
+class LockNoWaitTransactor < ActiveRecord::Base
+
+  belongs_to :worker
+
+  include AASM
+
+  aasm :column => :status, requires_lock: 'FOR UPDATE NOWAIT' do
+    state :sleeping, :initial => true
+    state :running
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+end
+
+class NoTransactor < ActiveRecord::Base
+
+ belongs_to :worker
+
+  include AASM
+  aasm :column => :status, use_transactions: false do
+    state :sleeping, :initial => true
+    state :running, :before_enter => :start_worker, :after_enter => :fail
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+
+  private
+
+  def start_worker
+    worker.update_attribute(:status, 'running')
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+end
+
+class MultipleTransactor < ActiveRecord::Base
+
+  belongs_to :worker
+
+  include AASM
+  aasm :left, :column => :status do
+    state :sleeping, :initial => true
+    state :running, :before_enter => :start_worker, :after_enter => :fail
+
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+  end
+
+private
+
+  def start_worker
+    worker.update_attribute(:status, 'running')
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+
+end

data/spec/models/active_record/transient.rb

@@ -0,0 +1,6 @@
+class Transient < ActiveRecord::Base
+  def aasm_write_state_without_persistence(state)
+    "fum"
+  end
+  include AASM
+end

data/spec/models/active_record/validator.rb

@@ -0,0 +1,118 @@
+class Validator < ActiveRecord::Base
+  attr_accessor :after_all_transactions_performed,
+    :after_transaction_performed_on_fail,
+    :after_transaction_performed_on_run,
+    :before_all_transactions_performed,
+    :before_transaction_performed_on_fail,
+    :before_transaction_performed_on_run,
+    :invalid
+
+  validate do |model|
+    errors.add(:validator, "invalid") if invalid
+  end
+
+  include AASM
+
+  aasm :column => :status, :whiny_persistence => true do
+    before_all_transactions :before_all_transactions
+    after_all_transactions  :after_all_transactions
+
+    state :sleeping, :initial => true
+    state :running
+    state :failed, :after_enter => :fail
+
+    event :run, :after_commit => :change_name! do
+      after_transaction do
+        @after_transaction_performed_on_run = true
+      end
+
+      before_transaction do
+        @before_transaction_performed_on_run = true
+      end
+
+      transitions :to => :running, :from => :sleeping
+    end
+
+    event :sleep do
+      after_commit do |name|
+        change_name_on_sleep name
+      end
+      transitions :to => :sleeping, :from => :running
+    end
+
+    event :fail do
+      after_transaction do
+        @after_transaction_performed_on_fail = true
+      end
+
+      before_transaction do
+        @before_transaction_performed_on_fail = true
+      end
+
+      transitions :to => :failed, :from => [:sleeping, :running]
+    end
+  end
+
+  validates_presence_of :name
+
+  def change_name!
+    self.name = "name changed"
+    save!
+  end
+
+  def change_name_on_sleep name
+    self.name = name
+    save!
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+
+  def after_all_transactions
+    @after_all_transactions_performed = true
+  end
+
+  def before_all_transactions
+    @before_all_transactions_performed = true
+  end
+end
+
+class MultipleValidator < ActiveRecord::Base
+
+  include AASM
+  aasm :left, :column => :status, :whiny_persistence => true do
+    state :sleeping, :initial => true
+    state :running
+    state :failed, :after_enter => :fail
+
+    event :run, :after_commit => :change_name! do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      after_commit do |name|
+        change_name_on_sleep name
+      end
+      transitions :to => :sleeping, :from => :running
+    end
+    event :fail do
+      transitions :to => :failed, :from => [:sleeping, :running]
+    end
+  end
+
+  validates_presence_of :name
+
+  def change_name!
+    self.name = "name changed"
+    save!
+  end
+
+  def change_name_on_sleep name
+    self.name = name
+    save!
+  end
+
+  def fail
+    raise StandardError.new('failed on purpose')
+  end
+end

data/spec/models/active_record/with_enum.rb

@@ -0,0 +1,39 @@
+class WithEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  def self.test
+    {}
+  end
+
+  aasm :enum => :test do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end
+
+class MultipleWithEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  def self.test
+    {}
+  end
+
+  aasm :left, :enum => :test do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/with_enum_without_column.rb

@@ -0,0 +1,38 @@
+class WithEnumWithoutColumn < ActiveRecord::Base
+  include AASM
+
+  if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 1 # won't work with Rails <= 4.1
+    enum status: {
+      opened: 0,
+      closed: 1
+    }
+  end
+
+  aasm :column => :status do
+    state :closed, initial: true
+    state :opened
+
+    event :view do
+      transitions :to => :opened, :from => :closed
+    end
+  end
+end
+
+class MultipleWithEnumWithoutColumn < ActiveRecord::Base
+  include AASM
+  if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 1 # won't work with Rails <= 4.1
+    enum status: {
+      opened: 0,
+      closed: 1
+    }
+  end
+
+  aasm :left, :column => :status do
+    state :closed, initial: true
+    state :opened
+
+    event :view do
+      transitions :to => :opened, :from => :closed
+    end
+  end
+end

data/spec/models/active_record/with_false_enum.rb

@@ -0,0 +1,31 @@
+class WithFalseEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  aasm :enum => false do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end
+
+class MultipleWithFalseEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  aasm :left, :enum => false do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/with_true_enum.rb

@@ -0,0 +1,39 @@
+class WithTrueEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  def value
+    'value'
+  end
+
+  aasm :enum => true do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end
+
+class MultipleWithTrueEnum < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  attr_accessor :aasm_state
+
+  def value
+    'value'
+  end
+
+  aasm :left, :enum => true do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/work.rb

@@ -0,0 +1,3 @@
+class Work < ActiveRecord::Base
+  include AASM
+end

data/spec/models/active_record/worker.rb

@@ -0,0 +1,2 @@
+class Worker < ActiveRecord::Base
+end

data/spec/models/active_record/writer.rb

@@ -0,0 +1,6 @@
+class Writer < ActiveRecord::Base
+  def aasm_write_state(state)
+    "fo"
+  end
+  include AASM
+end

data/spec/models/basic_two_state_machines_example.rb

@@ -0,0 +1,25 @@
+class BasicTwoStateMachinesExample
+  include AASM
+
+  aasm :search do
+    state :initialised, :initial => true
+    state :queried
+    state :requested
+
+    event :query do
+      transitions :from => [:initialised, :requested], :to => :queried
+    end
+    event :request do
+      transitions :from => :queried, :to => :requested
+    end
+  end
+
+  aasm :sync do
+    state :unsynced, :initial => true
+    state :synced
+
+    event :sync do
+      transitions :from => :unsynced, :to => :synced
+    end
+  end
+end

data/spec/models/callbacks/basic.rb

@@ -0,0 +1,98 @@
+module Callbacks
+  class Basic
+    include AASM
+
+    def initialize(options={})
+      @fail_event_guard = options[:fail_event_guard]
+      @fail_transition_guard = options[:fail_transition_guard]
+      @log = options[:log]
+      reset_data
+    end
+
+    def reset_data
+      @data = []
+    end
+
+    def data
+      @data.join(' ')
+    end
+
+    aasm do
+      before_all_events       :before_all_events
+      after_all_events        :after_all_events
+      ensure_on_all_events    :ensure_on_all_events
+      after_all_transitions   :after_all_transitions
+
+      state :open, :initial => true,
+        :before_enter => :before_enter_open,
+        :enter        => :enter_open,
+        :after_enter  => :after_enter_open,
+        :before_exit  => :before_exit_open,
+        :exit         => :exit_open,
+        :after_exit   => :after_exit_open
+
+      state :closed,
+        :before_enter => :before_enter_closed,
+        :enter        => :enter_closed,
+        :after_enter  => :after_enter_closed,
+        :before_exit  => :before_exit_closed,
+        :exit         => :exit_closed,
+        :after_exit   => :after_exit_closed
+
+      event :close,
+            :before => :before_event,
+            :after => :after_event,
+            :guard => :event_guard,
+            :before_success => :event_before_success,
+            :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
+        transitions :to => :open, :from => :closed
+      end
+    end
+
+    def log(text)
+      @data << text
+      puts text if @log
+    end
+
+    def aasm_write_state(*args);  log('aasm_write_state'); true;  end
+    def before_enter_open;        log('before_enter_open');       end
+    def enter_open;               log('enter_open');              end
+    def before_exit_open;         log('before_exit_open');        end
+    def after_enter_open;         log('after_enter_open');        end
+    def exit_open;                log('exit_open');               end
+    def after_exit_open;          log('after_exit_open');         end
+
+    def before_enter_closed;      log('before_enter_closed'); end
+    def enter_closed;             log('enter_closed');        end
+    def before_exit_closed;       log('before_exit_closed');  end
+    def exit_closed;              log('exit_closed');         end
+    def after_enter_closed;       log('after_enter_closed');  end
+    def after_exit_closed;        log('after_exit_closed');   end
+
+    def event_guard;              log('event_guard');         !@fail_event_guard;      end
+    def transition_guard;         log('transition_guard');    !@fail_transition_guard; end
+
+    def event_before_success;     log('event_before_success'); end
+
+    def after_transition;         log('after_transition');        end
+    def after_all_transitions;    log('after_all_transitions');   end
+
+    def before_all_events;        log('before_all_events')    end
+    def before_event;             log('before_event');        end
+    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
+end

data/spec/models/callbacks/basic_multiple.rb

@@ -0,0 +1,75 @@
+module Callbacks
+  class BasicMultiple
+    include AASM
+
+    def initialize(options={})
+      @fail_event_guard = options[:fail_event_guard]
+      @fail_transition_guard = options[:fail_transition_guard]
+      @log = options[:log]
+      reset_data
+    end
+
+    def reset_data
+      @data = []
+    end
+
+    def data
+      @data.join(' ')
+    end
+
+    aasm(:left) do
+      state :open, :initial => true,
+        :before_enter => :before_enter_open,
+        :enter        => :enter_open,
+        :after_enter  => :after_enter_open,
+        :before_exit  => :before_exit_open,
+        :exit         => :exit_open,
+        :after_exit   => :after_exit_open
+
+      state :closed,
+        :before_enter => :before_enter_closed,
+        :enter        => :enter_closed,
+        :after_enter  => :after_enter_closed,
+        :before_exit  => :before_exit_closed,
+        :exit         => :exit_closed,
+        :after_exit   => :after_exit_closed
+
+      event :left_close, :before => :before_event, :after => :after_event, :guard => :event_guard do
+        transitions :to => :closed, :from => [:open], :guard => :transition_guard, :after => :after_transition
+      end
+
+      event :left_open, :before => :before_event, :after => :after_event do
+        transitions :to => :open, :from => :closed
+      end
+    end
+
+    def log(text)
+      @data << text
+      puts text if @log
+    end
+
+    def aasm_write_state(*args); log("aasm_write_state(#{args.inspect})"); true; end
+
+    def before_enter_open;    log('before_enter_open');   end
+    def enter_open;           log('enter_open');          end
+    def before_exit_open;     log('before_exit_open');    end
+    def after_enter_open;     log('after_enter_open');    end
+    def exit_open;            log('exit_open');           end
+    def after_exit_open;      log('after_exit_open');     end
+
+    def before_enter_closed;  log('before_enter_closed'); end
+    def enter_closed;         log('enter_closed');        end
+    def before_exit_closed;   log('before_exit_closed');  end
+    def exit_closed;          log('exit_closed');         end
+    def after_enter_closed;   log('after_enter_closed');  end
+    def after_exit_closed;    log('after_exit_closed');   end
+
+    def event_guard;          log('event_guard');         !@fail_event_guard;      end
+    def transition_guard;     log('transition_guard');    !@fail_transition_guard; end
+
+    def after_transition;     log('after_transition');    end
+
+    def before_event;         log('before_event');        end
+    def after_event;          log('after_event');         end
+  end
+end

data/spec/models/callbacks/guard_within_block.rb

@@ -0,0 +1,67 @@
+module Callbacks
+  class GuardWithinBlock
+    include AASM
+
+    def initialize(options={})
+      @fail_event_guard = options[:fail_event_guard]
+      @fail_transition_guard = options[:fail_transition_guard]
+      @log = options[:log]
+    end
+
+    aasm do
+      state :open, :initial => true,
+        :before_enter => :before_enter_open,
+        :enter        => :enter_open,
+        :after_enter  => :after_enter_open,
+        :before_exit  => :before_exit_open,
+        :exit         => :exit_open,
+        :after_exit   => :after_exit_open
+
+      state :closed,
+        :before_enter => :before_enter_closed,
+        :enter        => :enter_closed,
+        :after_enter  => :after_enter_closed,
+        :before_exit  => :before_exit_closed,
+        :exit         => :exit_closed,
+        :after_exit   => :after_exit_closed
+
+      event :close, :before => :before, :after => :after, :guard => :event_guard do
+        transitions :to => :closed, :from => [:open], :after => :transitioning, :success => :success_transition do
+          guard do
+            transition_guard
+          end
+        end
+      end
+
+      event :open, :before => :before, :after => :after do
+        transitions :to => :open, :from => :closed
+      end
+    end
+
+    def log(text)
+      puts text if @log
+    end
+
+    def before_enter_open; log('before_enter_open'); end
+    def enter_open; log('enter_open'); end
+    def before_exit_open; log('before_exit_open'); end
+    def after_enter_open; log('after_enter_open'); end
+    def exit_open; log('exit_open'); end
+    def after_exit_open; log('after_exit_open'); end
+
+    def before_enter_closed; log('before_enter_closed'); end
+    def enter_closed; log('enter_closed'); end
+    def before_exit_closed; log('before_exit_closed'); end
+    def exit_closed; log('exit_closed'); end
+    def after_enter_closed; log('after_enter_closed'); end
+    def after_exit_closed; log('after_exit_closed'); end
+
+    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
+  end
+end