Module: AASM

Defined in:
lib/aasm.rb,
lib/event.rb,
lib/state.rb,
lib/integers.rb,
lib/persistence.rb,
lib/state_machine.rb,
lib/state_transition.rb,
lib/persistence/active_record_persistence.rb

Defined Under Namespace

Modules: ClassMethods, Persistence, SupportingClasses Classes: InvalidTransition, StateMachine, UndefinedState

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



18
19
20
21
22
23
24
25
# File 'lib/aasm.rb', line 18

def self.included(base) #:nodoc:
  # TODO - need to ensure that a machine is being created because
  # AASM was either included or arrived at via inheritance.  It
  # cannot be both.
  base.extend AASM::ClassMethods
  AASM::Persistence.set_persistence(base)
  AASM::StateMachine[base] = AASM::StateMachine.new('')
end

.VersionObject



8
9
10
# File 'lib/aasm.rb', line 8

def self.Version
  '2.0.5'
end

Instance Method Details

#aasm_current_stateObject

Instance methods



86
87
88
89
90
91
92
93
94
# File 'lib/aasm.rb', line 86

def aasm_current_state
  return @aasm_current_state if @aasm_current_state

  if self.respond_to?(:aasm_read_state) || self.private_methods.include?('aasm_read_state')
    @aasm_current_state = aasm_read_state
  end
  return @aasm_current_state if @aasm_current_state
  self.class.aasm_initial_state
end

#aasm_events_for_current_stateObject



96
97
98
# File 'lib/aasm.rb', line 96

def aasm_events_for_current_state
  aasm_events_for_state(aasm_current_state)
end

#aasm_events_for_state(state) ⇒ Object



100
101
102
103
# File 'lib/aasm.rb', line 100

def aasm_events_for_state(state)
  events = self.class.aasm_events.values.select {|event| event.transitions_from_state?(state) }
  events.map {|event| event.name}
end