aasm 2.1.1 → 5.2.0

data/spec/localizer_test_model_deprecated_style.yml

@@ -0,0 +1,13 @@
+en:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state:
+          opened: "It's open now!"
+
+fr:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state:
+          opened: "C'est ouvert maintenant!"

data/spec/localizer_test_model_new_style.yml

@@ -0,0 +1,11 @@
+en:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state/opened: "It's open now!"
+
+fr:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state/opened: "C'est ouvert maintenant!"

data/spec/models/active_record/active_record_callback.rb

@@ -0,0 +1,93 @@
+class ActiveRecordCallback < ActiveRecord::Base
+  include AASM
+
+  def reset_data
+    @data = []
+  end
+
+  def data
+    @data.join(' ')
+  end
+
+  aasm column: :status 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,
+        :after_commit => :event_after_commit,
+        :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 ||= []
+    @data << text
+    #puts text
+  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
+
+  def event_after_commit;       log('after_commit');        end 
+end

data/spec/models/active_record/basic_active_record_two_state_machines_example.rb

@@ -0,0 +1,25 @@
+class BasicActiveRecordTwoStateMachinesExample < ActiveRecord::Base
+  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 :synchronise do
+      transitions :from => :unsynced, :to => :synced
+    end
+  end
+end

data/spec/models/active_record/complex_active_record_example.rb

@@ -0,0 +1,37 @@
+class ComplexActiveRecordExample < ActiveRecord::Base
+  include AASM
+
+  aasm :left, :column => 'left' do
+    state :one, :initial => true
+    state :two
+    state :three
+
+    event :increment do
+      transitions :from => :one, :to => :two, guard: :allowed?
+      transitions :from => :two, :to => :three
+    end
+    event :reset do
+      transitions :from => :three, :to => :one
+    end
+  end
+
+  def allowed?
+    true
+  end
+
+  aasm :right, :column => 'right' do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+
+    event :level_up do
+      transitions :from => :alpha, :to => :beta
+      transitions :from => :beta, :to => :gamma
+    end
+    event :level_down do
+      transitions :from => :gamma, :to => :beta
+      transitions :from => :beta, :to => :alpha
+    end
+  end
+
+end

data/spec/models/active_record/derivate_new_dsl.rb

@@ -0,0 +1,7 @@
+require_relative 'simple_new_dsl'
+
+class DerivateNewDsl < SimpleNewDsl
+end
+
+class MultipleDerivateNewDsl < MultipleSimpleNewDsl
+end

data/spec/models/active_record/false_state.rb

@@ -0,0 +1,35 @@
+class FalseState < ActiveRecord::Base
+  include AASM
+
+  def initialize(*args)
+    super
+    self.aasm_state = false
+  end
+
+  aasm do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end
+
+class MultipleFalseState < ActiveRecord::Base
+  include AASM
+
+  def initialize(*args)
+    super
+    self.aasm_state = false
+  end
+
+  aasm :left do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/gate.rb

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

data/spec/models/active_record/instance_level_skip_validation_example.rb

@@ -0,0 +1,19 @@
+class InstanceLevelSkipValidationExample < ActiveRecord::Base
+  include AASM
+
+  aasm :state do
+    state :new, :initial => true
+    state :draft
+    state :complete
+
+    event :set_draft do
+      transitions from: :new, to: :draft
+    end
+
+    event :complete do
+      transitions from: %i[draft new], to: :complete
+    end
+  end
+
+  validates :some_string, presence: true
+end

data/spec/models/active_record/invalid_persistor.rb

@@ -0,0 +1,29 @@
+class InvalidPersistor < ActiveRecord::Base
+  include AASM
+  aasm :column => :status, :skip_validation_on_save => true do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end
+
+class MultipleInvalidPersistor < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :status, :skip_validation_on_save => true do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end

data/spec/models/active_record/localizer_test_model.rb

@@ -0,0 +1,42 @@
+class LocalizerTestModel < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :opened, :initial => true
+    state :closed
+    event :close
+    event :open
+  end
+end
+
+describe 'localized state names' do
+  before(:all) do
+    I18n.load_path << 'spec/localizer_test_model_new_style.yml'
+    I18n.reload!
+  end
+
+  after(:all) do
+    I18n.load_path.delete('spec/localizer_test_model_new_style.yml')
+    I18n.backend.load_translations
+  end
+
+  it 'should localize' do
+    state = LocalizerTestModel.aasm.states.detect {|s| s == :opened}
+    expect(state.localized_name).to eq("It's open now!")
+    expect(state.human_name).to eq("It's open now!")
+    expect(state.display_name).to eq("It's open now!")
+
+    I18n.with_locale(:fr) do
+      expect(state.localized_name).to eq("C'est ouvert maintenant!")
+      expect(state.human_name).to eq("C'est ouvert maintenant!")
+      expect(state.display_name).to eq("C'est ouvert maintenant!")
+    end
+  end
+
+  it 'should use fallback' do
+    state = LocalizerTestModel.aasm.states.detect {|s| s == :closed}
+    expect(state.localized_name).to eq('Closed')
+    expect(state.human_name).to eq('Closed')
+    expect(state.display_name).to eq('Closed')
+  end
+end

data/spec/models/active_record/namespaced.rb

@@ -0,0 +1,16 @@
+class MultipleNamespaced < ActiveRecord::Base
+  include AASM
+
+  aasm(:status, namespace: :car) do
+    state :unsold, initial: true
+    state :sold
+
+    event :sell do
+      transitions from: :unsold, to: :sold
+    end
+
+    event :return do
+      transitions from: :sold, to: :unsold
+    end
+  end
+end

data/spec/models/active_record/no_direct_assignment.rb

@@ -0,0 +1,21 @@
+class NoDirectAssignment < ActiveRecord::Base
+  include AASM
+  aasm :no_direct_assignment => true do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end
+
+class MultipleNoDirectAssignment < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :aasm_state, :no_direct_assignment => true do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end

data/spec/models/active_record/no_scope.rb

@@ -0,0 +1,21 @@
+class NoScope < ActiveRecord::Base
+  include AASM
+  aasm :create_scopes => false do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end
+
+class MultipleNoScope < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :aasm_state, :create_scopes => false do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end

data/spec/models/active_record/persisted_state.rb

@@ -0,0 +1,12 @@
+class PersistedState < ActiveRecord::Base
+  attr_accessor :transient_store, :persisted_store
+  include AASM
+  aasm do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+    event :release do
+      transitions :from => [:alpha, :beta, :gamma], :to => :beta
+    end
+  end
+end

data/spec/models/active_record/person.rb

@@ -0,0 +1,23 @@
+class Base < ActiveRecord::Base
+  include AASM
+
+  aasm column: 'status' do
+    state :inactive, initial: true
+    state :active
+
+    event :activate do
+      transitions from: :inactive, to: :active
+    end
+
+    event :deactivate do
+      transitions from: :active, to: :inactive
+    end
+  end
+
+  self.abstract_class = true
+  self.table_name = 'users'
+end
+
+
+class Person < Base
+end

data/spec/models/active_record/provided_and_persisted_state.rb

@@ -0,0 +1,24 @@
+class ProvidedAndPersistedState < ActiveRecord::Base
+  attr_accessor :transient_store, :persisted_store
+  include AASM
+  aasm do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+    event :release do
+      transitions :from => [:alpha, :beta, :gamma], :to => :beta
+    end
+  end
+
+  def aasm_read_state(*args)
+    :gamma
+  end
+
+  def aasm_write_state(new_state, *args)
+    @persisted_store = new_state
+  end
+
+  def aasm_write_state_without_persistence(new_state, *args)
+    @transient_store = new_state
+  end
+end

data/spec/models/active_record/reader.rb

@@ -0,0 +1,7 @@
+class Reader < ActiveRecord::Base
+  include AASM
+
+  def aasm_read_state
+    "fi"
+  end
+end

data/spec/models/active_record/readme_job.rb

@@ -0,0 +1,21 @@
+class ReadmeJob < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running
+    state :cleaning
+
+    event :run do
+      transitions :from => :sleeping, :to => :running
+    end
+
+    event :clean do
+      transitions :from => :running, :to => :cleaning
+    end
+
+    event :sleep do
+      transitions :from => [:running, :cleaning], :to => :sleeping
+    end
+  end
+end

data/spec/models/active_record/silent_persistor.rb

@@ -0,0 +1,29 @@
+class SilentPersistor < ActiveRecord::Base
+  include AASM
+  aasm :column => :status, :whiny_persistence => false do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end
+
+class MultipleSilentPersistor < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :status, :whiny_persistence => false do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end

data/spec/models/active_record/simple_new_dsl.rb

@@ -0,0 +1,32 @@
+class SimpleNewDsl < ActiveRecord::Base
+  include AASM
+  aasm :column => :status
+  aasm do
+    state :unknown_scope, :another_unknown_scope
+    state :new
+  end
+end
+
+class MultipleSimpleNewDsl < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :status
+  aasm :left do
+    state :unknown_scope, :another_unknown_scope
+    state :new
+  end
+end
+
+class AbstractClassDsl < ActiveRecord::Base
+  include AASM
+
+  self.abstract_class = true
+
+  aasm :column => :status
+  aasm do
+    state :unknown_scope, :another_unknown_scope
+    state :new
+  end
+end
+
+class ImplementedAbstractClassDsl < AbstractClassDsl
+end

data/spec/models/active_record/thief.rb

@@ -0,0 +1,29 @@
+class Thief < ActiveRecord::Base
+  if ActiveRecord::VERSION::MAJOR >= 3
+    self.table_name = 'thieves'
+  else
+    set_table_name "thieves"
+  end
+  include AASM
+  aasm do
+    state :rich
+    state :jailed
+    initial_state Proc.new {|thief| thief.skilled ? :rich : :jailed }
+  end
+  attr_accessor :skilled, :aasm_state
+end
+
+class MultipleThief < ActiveRecord::Base
+  if ActiveRecord::VERSION::MAJOR >= 3
+    self.table_name = 'multiple_thieves'
+  else
+    set_table_name "multiple_thieves"
+  end
+  include AASM
+  aasm :left, :column => :aasm_state do
+    state :rich
+    state :jailed
+    initial_state Proc.new {|thief| thief.skilled ? :rich : :jailed }
+  end
+  attr_accessor :skilled, :aasm_state
+end

data/spec/models/active_record/timestamp_example.rb

@@ -0,0 +1,16 @@
+class TimestampExample < ActiveRecord::Base
+  include AASM
+
+  aasm column: :aasm_state, timestamps: true do
+    state :opened
+    state :closed
+
+    event :open do
+      transitions to: :opened
+    end
+
+    event :close do
+      transitions to: :closed
+    end
+  end
+end