aasm 4.11.1 → 5.2.0

data/spec/generators/active_record_generator_spec.rb

@@ -1,44 +1,53 @@
 require 'spec_helper'
-require 'generator_spec'
-require 'generators/active_record/aasm_generator'
 
-describe ActiveRecord::Generators::AASMGenerator, type: :generator do
-  destination File.expand_path("../../../tmp", __FILE__)
-
-  before(:all) do
-    prepare_destination
-  end
-
-  it "creates model with aasm block for default column_name" do
-    run_generator %w(user)
-    assert_file "app/models/user.rb", /include AASM\n\n  aasm do\n  end\n/
-  end
-
-  it "creates model with aasm block for custom column_name" do
-    run_generator %w(user state)
-    assert_file "app/models/user.rb", /aasm :column => 'state' do\n  end\n/
-  end
-
-  it "creates model with aasm block for namespaced model" do
-    run_generator %w(Admin::User state)
-    assert_file "app/models/admin/user.rb", /aasm :column => 'state' do\n  end\n/
+if defined?(ActiveRecord)
+  require 'generator_spec'
+  require 'generators/active_record/aasm_generator'
+
+  describe ActiveRecord::Generators::AASMGenerator, type: :generator do
+    destination File.expand_path("../../../tmp", __FILE__)
+
+    before(:all) do
+      prepare_destination
+    end
+
+    it "creates model with aasm block for default column_name" do
+      run_generator %w(user)
+      assert_file "app/models/user.rb", /include AASM\n\n  aasm do\n  end\n/
+    end
+
+    it "creates model with aasm block for custom column_name" do
+      run_generator %w(user state)
+      assert_file "app/models/user.rb", /aasm :column => 'state' do\n  end\n/
+    end
+
+    it "creates model with aasm block for namespaced model" do
+      run_generator %w(Admin::User state)
+      assert_file "app/models/admin/user.rb", /aasm :column => 'state' do\n  end\n/
+    end
+
+    it "creates migration for model with aasm_column" do
+      run_generator %w(post)
+      assert_migration "db/migrate/aasm_create_posts.rb", /create_table(:posts) do |t|\n  t.string :aasm_state\n/
+    end
+
+    it "add aasm_column in existing model" do
+      run_generator %w(job)
+      assert_file "app/models/job.rb"
+      run_generator %w(job)
+      assert_migration "db/migrate/add_aasm_state_to_jobs.rb"
+    end
+
+    it "add custom aasm_column in existing model" do
+      run_generator %w(job state)
+      assert_migration "db/migrate/add_state_to_jobs.rb"
+    end
+
+    it "dont add column if column is already exists" do
+      require 'models/active_record/work.rb'
+      load_schema
+      run_generator %w(work status)
+      assert_no_migration "db/migrate/add_status_to_jobs.rb"
+    end
   end
-
-  it "creates migration for model with aasm_column" do
-    run_generator %w(post)
-    assert_migration "db/migrate/aasm_create_posts.rb", /create_table(:posts) do |t|\n  t.string :aasm_state\n/
-  end
-
-  it "add aasm_column in existing model" do
-    run_generator %w(job)
-    assert_file "app/models/job.rb"
-    run_generator %w(job)
-    assert_migration "db/migrate/add_aasm_state_to_jobs.rb"
-  end
-
-  it "add custom aasm_column in existing model" do
-    run_generator %w(job state)
-    assert_migration "db/migrate/add_state_to_jobs.rb"
-  end
-
 end

data/spec/generators/mongoid_generator_spec.rb

@@ -1,9 +1,8 @@
 require 'spec_helper'
-require 'generator_spec'
-require 'generators/mongoid/aasm_generator'
 
-begin
-  require "mongoid"
+if defined?(Mongoid::Document)
+  require 'generator_spec'
+  require 'generators/mongoid/aasm_generator'
 
   describe Mongoid::Generators::AASMGenerator, type: :generator do
     destination File.expand_path("../../../tmp", __FILE__)
@@ -28,6 +27,5 @@ begin
     end
 
   end
-rescue LoadError
-  puts "Not running Mongoid specs because mongoid gem is not installed!!!"
+
 end

data/spec/generators/no_brainer_generator_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+if defined?(NoBrainer::Document)
+  require 'generator_spec'
+  require 'generators/nobrainer/aasm_generator'
+
+  describe NoBrainer::Generators::AASMGenerator, type: :generator do
+    destination File.expand_path('../../../tmp', __FILE__)
+
+    before(:all) do
+      prepare_destination
+    end
+
+    it 'creates model with aasm block for default column_name' do
+      run_generator %w[user]
+      assert_file 'app/models/user.rb', /include AASM\n\n  aasm do\n  end\n/
+    end
+
+    it 'creates model with aasm block for custom column_name' do
+      run_generator %w[user state]
+      assert_file 'app/models/user.rb', /aasm :column => 'state' do\n  end\n/
+    end
+
+    it 'creates model with aasm block for namespaced model' do
+      run_generator %w[Admin::User state]
+      assert_file 'app/models/admin/user.rb', /aasm :column => 'state' do\n  end\n/
+    end
+  end
+end

data/spec/{en_deprecated_style.yml → localizer_test_model_deprecated_style.yml}

@@ -1,10 +1,13 @@
 en:
   activerecord:
-    events:
+    attributes:
       localizer_test_model:
-        close: "Let's close it!"
+        aasm_state:
+          opened: "It's open now!"
 
+fr:
+  activerecord:
     attributes:
       localizer_test_model:
         aasm_state:
-          opened: "It's open now!"
+          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/complex_active_record_example.rb

@@ -7,7 +7,7 @@ class ComplexActiveRecordExample < ActiveRecord::Base
     state :three
 
     event :increment do
-      transitions :from => :one, :to => :two
+      transitions :from => :one, :to => :two, guard: :allowed?
       transitions :from => :two, :to => :three
     end
     event :reset do
@@ -15,6 +15,10 @@ class ComplexActiveRecordExample < ActiveRecord::Base
     end
   end
 
+  def allowed?
+    true
+  end
+
   aasm :right, :column => 'right' do
     state :alpha, :initial => true
     state :beta

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/{invalid_persistor.rb → active_record/invalid_persistor.rb}

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class InvalidPersistor < ActiveRecord::Base
   include AASM
   aasm :column => :status, :skip_validation_on_save => true do

data/spec/models/active_record/localizer_test_model.rb

@@ -11,24 +11,32 @@ end
 
 describe 'localized state names' do
   before(:all) do
-    I18n.load_path << 'spec/en.yml'
-    I18n.default_locale = :en
+    I18n.load_path << 'spec/localizer_test_model_new_style.yml'
     I18n.reload!
   end
 
   after(:all) do
-    I18n.load_path.clear
+    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/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/{silent_persistor.rb → active_record/silent_persistor.rb}

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class SilentPersistor < ActiveRecord::Base
   include AASM
   aasm :column => :status, :whiny_persistence => false do

data/spec/models/active_record/simple_new_dsl.rb

@@ -15,3 +15,18 @@ class MultipleSimpleNewDsl < ActiveRecord::Base
     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/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

data/spec/models/{transactor.rb → active_record/transactor.rb}

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class Transactor < ActiveRecord::Base
 
   belongs_to :worker
@@ -74,6 +72,31 @@ class LockNoWaitTransactor < ActiveRecord::Base
   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

data/spec/models/{validator.rb → active_record/validator.rb}

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class Validator < ActiveRecord::Base
   attr_accessor :after_all_transactions_performed,
     :after_transaction_performed_on_fail,

data/spec/models/active_record/work.rb

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

data/spec/models/callbacks/basic.rb

@@ -43,6 +43,7 @@ module Callbacks
             :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,
@@ -78,6 +79,8 @@ module Callbacks
     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
 
@@ -86,8 +89,8 @@ 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 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

data/spec/models/callbacks/with_state_arg.rb

@@ -8,7 +8,7 @@ module Callbacks
       state :closed
       state :out_to_lunch
 
-      event :close, :before => :before_method, :after => :after_method do
+      event :close, :before => :before_method, :after => :after_method, :before_success => :before_success_method, :success => :success_method3 do
         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
@@ -16,6 +16,8 @@ module Callbacks
 
     def before_method(arg); end
 
+    def before_success_method(arg); end
+
     def after_method(arg); end
 
     def transition_method(arg); end
@@ -26,5 +28,7 @@ module Callbacks
 
     def success_method2(arg); end
 
+    def success_method3(arg); end
+
   end
 end

data/spec/models/callbacks/with_state_arg_multiple.rb

@@ -8,7 +8,7 @@ module Callbacks
       state :closed
       state :out_to_lunch
 
-      event :close, :before => :before_method, :after => :after_method do
+      event :close, :before => :before_method, :after => :after_method, :before_success => :before_success_method, :success => :success_method do
         transitions :to => :closed, :from => [:open], :after => :transition_method
         transitions :to => :out_to_lunch, :from => [:open], :after => :transition_method2
       end
@@ -16,11 +16,14 @@ module Callbacks
 
     def before_method(arg); end
 
+    def before_success_method(arg); end
+
     def after_method(arg); end
 
     def transition_method(arg); end
 
     def transition_method2(arg); end
 
+    def success_method(arg); end
   end
 end

data/spec/models/default_state.rb

@@ -2,7 +2,7 @@ class DefaultState
   attr_accessor :transient_store, :persisted_store
   include AASM
   aasm do
-    state :alpha, :initial => true
+    state :alpha, :initial => true, display: 'ALPHA'
     state :beta
     state :gamma
     event :release do

data/spec/models/guard_arguments_check.rb

@@ -0,0 +1,17 @@
+class GuardArgumentsCheck
+  include AASM
+
+  aasm do
+    state :new, :reviewed, :finalized
+
+    event :mark_as_reviewed,
+          :guard => proc { |*args| arguments_list(*args) } do
+      transitions :from => :new, :to => :reviewed
+    end
+  end
+
+  def arguments_list(arg1, arg2)
+    return false unless arg1.nil?
+    true
+  end
+end

data/spec/models/guard_with_params.rb

@@ -10,7 +10,7 @@ class GuardWithParams
 
   def user_is_manager?(user)
     ok = false
-    if user.has_role? :manager
+    if user && user.has_role?(:manager)
       ok = true
     end
     return ok

data/spec/models/guardian_without_from_specified.rb

@@ -0,0 +1,18 @@
+class GuardianWithoutFromSpecified
+  include AASM
+
+  aasm do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+
+    event :use_guards_where_the_first_fails do
+      transitions :to => :beta,  :guard => :fail
+      transitions :to => :gamma, :guard => :succeed
+    end
+  end
+
+
+  def fail; false; end
+  def succeed; true; end
+end

data/spec/models/mongoid/invalid_persistor_mongoid.rb

@@ -0,0 +1,39 @@
+class InvalidPersistorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  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
+
+class MultipleInvalidPersistorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  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