aasm 4.0.8 → 4.5.2

data/lib/aasm/rspec/allow_transition_to.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :allow_transition_to do |state|
+  match do |obj|
+    @state_machine_name ||= :default
+    obj.aasm(@state_machine_name).states(:permitted => true).include?(state)
+  end
+
+  chain :on do |state_machine_name|
+    @state_machine_name = state_machine_name
+  end
+
+  description do
+    "allow transition to #{expected} (on :#{@state_machine_name})"
+  end
+
+  failure_message do |obj|
+    "expected that the state :#{expected} would be reachable (on :#{@state_machine_name})"
+  end
+
+  failure_message_when_negated do |obj|
+    "expected that the state :#{expected} would not be reachable (on :#{@state_machine_name})"
+  end
+end

data/lib/aasm/rspec/have_state.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :have_state do |state|
+  match do |obj|
+    @state_machine_name ||= :default
+    obj.aasm(@state_machine_name).current_state == state.to_sym
+  end
+
+  chain :on do |state_machine_name|
+    @state_machine_name = state_machine_name
+  end
+
+  description do
+    "have state #{expected} (on :#{@state_machine_name})"
+  end
+
+  failure_message do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would be :#{expected} (on :#{@state_machine_name})"
+  end
+
+  failure_message_when_negated do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would not be :#{expected} (on :#{@state_machine_name})"
+  end
+end

data/lib/aasm/rspec/transition_from.rb

@@ -0,0 +1,32 @@
+RSpec::Matchers.define :transition_from do |from_state|
+  match do |obj|
+    @state_machine_name ||= :default
+    obj.aasm(@state_machine_name).current_state = from_state.to_sym
+    # expect(obj).to receive(:broadcast_event).with(@event.to_s, obj, from_state, @to_state)
+    obj.send(@event) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+  end
+
+  chain :on do |state_machine_name|
+    @state_machine_name = state_machine_name
+  end
+
+  chain :to do |state|
+    @to_state = state
+  end
+
+  chain :on_event do |event|
+    @event = event
+  end
+
+  description do
+    "transition state to :#{@to_state} from :#{expected} on event :#{@event} (on :#{@state_machine_name})"
+  end
+
+  failure_message do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would be :#{@to_state} (on :#{@state_machine_name})"
+  end
+
+  failure_message_when_negated do |obj|
+    "expected that :#{obj.aasm(@state_machine_name).current_state} would not be :#{@to_state} (on :#{@state_machine_name})"
+  end
+end

data/lib/aasm/rspec.rb

@@ -0,0 +1,5 @@
+# relative-require all rspec files
+Dir[File.dirname(__FILE__) + '/rspec/*.rb'].each do |file|
+  require 'aasm/rspec/' + File.basename(file, File.extname(file))
+end
+

data/lib/aasm/state_machine.rb

@@ -10,13 +10,15 @@ module AASM
       (@machines ||= {})[klass.to_s] = machine
     end
 
-    attr_accessor :states, :events, :initial_state, :config
+    attr_accessor :states, :events, :initial_state, :config, :name, :global_callbacks
 
-    def initialize
+    def initialize(name)
       @initial_state = nil
       @states = []
       @events = {}
+      @global_callbacks = {}
       @config = AASM::Configuration.new
+      @name = name
     end
 
     # called internally by Ruby 1.9 after clone()
@@ -26,13 +28,25 @@ module AASM
       @events = @events.dup
     end
 
-    def add_state(name, klass, options)
-      set_initial_state(name, options)
+    def add_state(state_name, klass, options)
+      set_initial_state(state_name, options)
 
       # allow reloading, extending or redefining a state
-      @states.delete(name) if @states.include?(name)
+      @states.delete(state_name) if @states.include?(state_name)
 
-      @states << AASM::Core::State.new(name, klass, options)
+      @states << AASM::Core::State.new(state_name, klass, self, options)
+    end
+
+    def add_event(name, options, &block)
+      @events[name] = AASM::Core::Event.new(name, self, options, &block)
+    end
+
+    def add_global_callbacks(name, *callbacks, &block)
+      @global_callbacks[name] ||= []
+      callbacks.each do |callback|
+        @global_callbacks[name] << callback
+      end
+      @global_callbacks[name] << block if block
     end
 
     private

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.0.8"
+  VERSION = "4.5.2"
 end

data/spec/database.rb

@@ -1,5 +1,5 @@
 ActiveRecord::Migration.suppress_messages do
-  %w{gates readers writers transients simples  no_scopes no_direct_assignments thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums false_states}.each do |table_name|
+  %w{gates multiple_gates readers writers transients simples no_scopes multiple_no_scopes no_direct_assignments multiple_no_direct_assignments thieves multiple_thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums false_states multiple_with_enums multiple_with_true_enums multiple_with_false_enums multiple_false_states readme_jobs}.each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "aasm_state"
     end
@@ -8,17 +8,34 @@ ActiveRecord::Migration.suppress_messages do
   ActiveRecord::Migration.create_table "simple_new_dsls", :force => true do |t|
     t.string "status"
   end
+  ActiveRecord::Migration.create_table "multiple_simple_new_dsls", :force => true do |t|
+    t.string "status"
+  end
+
+  ActiveRecord::Migration.create_table "complex_active_record_examples", :force => true do |t|
+    t.string "left"
+    t.string "right"
+  end
 
   ActiveRecord::Migration.create_table "validators", :force => true do |t|
     t.string "name"
     t.string "status"
   end
+  ActiveRecord::Migration.create_table "multiple_validators", :force => true do |t|
+    t.string "name"
+    t.string "status"
+  end
 
   ActiveRecord::Migration.create_table "transactors", :force => true do |t|
     t.string "name"
     t.string "status"
     t.integer "worker_id"
   end
+  ActiveRecord::Migration.create_table "multiple_transactors", :force => true do |t|
+    t.string "name"
+    t.string "status"
+    t.integer "worker_id"
+  end
 
   ActiveRecord::Migration.create_table "workers", :force => true do |t|
     t.string "name"
@@ -29,9 +46,18 @@ ActiveRecord::Migration.suppress_messages do
     t.string "name"
     t.string "status"
   end
+  ActiveRecord::Migration.create_table "multiple_invalid_persistors", :force => true do |t|
+    t.string "name"
+    t.string "status"
+  end
 
   ActiveRecord::Migration.create_table "fathers", :force => true do |t|
     t.string "aasm_state"
     t.string "type"
   end
+
+  ActiveRecord::Migration.create_table "basic_active_record_two_state_machines_examples", :force => true do |t|
+    t.string "search"
+    t.string "sync"
+  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,33 @@
+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
+      transitions :from => :two, :to => :three
+    end
+    event :reset do
+      transitions :from => :three, :to => :one
+    end
+  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/localizer_test_model.rb

@@ -0,0 +1,34 @@
+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/en.yml'
+    I18n.default_locale = :en
+    I18n.reload!
+  end
+
+  after(:all) do
+    I18n.load_path.clear
+  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!")
+  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')
+  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/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/simple_new_dsl.rb

@@ -0,0 +1,17 @@
+class SimpleNewDsl < ActiveRecord::Base
+  include AASM
+  aasm :column => :status
+  aasm do
+    state :unknown_scope
+    state :new
+  end
+end
+
+class MultipleSimpleNewDsl < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :status
+  aasm :left do
+    state :unknown_scope
+    state :new
+  end
+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/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/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_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/writer.rb

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