Class: AASM::InstanceBase

Inherits:
Object
  • Object
show all
Defined in:
lib/aasm/instance_base.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance, name = :default) ⇒ InstanceBase

instance of the class including AASM, name of the state machine


6
7
8
9
# File 'lib/aasm/instance_base.rb', line 6

def initialize(instance, name=:default) # instance of the class including AASM, name of the state machine
  @instance = instance
  @name = name
end

Instance Attribute Details

#current_eventObject

Returns the value of attribute current_event


4
5
6
# File 'lib/aasm/instance_base.rb', line 4

def current_event
  @current_event
end

#from_stateObject

Returns the value of attribute from_state


4
5
6
# File 'lib/aasm/instance_base.rb', line 4

def from_state
  @from_state
end

#to_stateObject

Returns the value of attribute to_state


4
5
6
# File 'lib/aasm/instance_base.rb', line 4

def to_state
  @to_state
end

Instance Method Details

#current_stateObject


11
12
13
# File 'lib/aasm/instance_base.rb', line 11

def current_state
  @instance.aasm_read_state(@name)
end

#current_state=(state) ⇒ Object


15
16
17
# File 'lib/aasm/instance_base.rb', line 15

def current_state=(state)
  @instance.aasm_write_state_without_persistence(state, @name)
end

#determine_state_name(state) ⇒ Object


98
99
100
101
102
103
104
105
106
107
# File 'lib/aasm/instance_base.rb', line 98

def determine_state_name(state)
  case state
    when Symbol, String
      state
    when Proc
      state.call(@instance)
    else
      raise NotImplementedError, "Unrecognized state-type given. Expected Symbol, String, or Proc."
  end
end

#enter_initial_stateObject


19
20
21
22
23
24
25
26
27
28
# File 'lib/aasm/instance_base.rb', line 19

def enter_initial_state
  state_name = determine_state_name(@instance.class.aasm(@name).initial_state)
  state_object = state_object_for_name(state_name)

  state_object.fire_callbacks(:before_enter, @instance)
  self.current_state = state_name
  state_object.fire_callbacks(:after_enter, @instance)

  state_name
end

#events(options = {}, *args) ⇒ Object


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/aasm/instance_base.rb', line 61

def events(options={}, *args)
  state = options[:state] || current_state
  events = @instance.class.aasm(@name).events.select {|e| e.transitions_from_state?(state) }

  options[:reject] = Array(options[:reject])
  events.reject! { |e| options[:reject].include?(e.name) }

  if options.has_key?(:permitted)
    # filters the results of events_for_current_state so that only those that
    # are really currently possible (given transition guards) are shown.
    if options[:permitted]
      events.select! { |e| @instance.send("may_#{e.name}?", *args) }
    else
      events.select! { |e| !@instance.send("may_#{e.name}?", *args) }
    end
  end

  events
end

#fire(event_name, *args, &block) ⇒ Object


117
118
119
# File 'lib/aasm/instance_base.rb', line 117

def fire(event_name, *args, &block)
  @instance.send(event_name, *args, &block)
end

#fire!(event_name, *args, &block) ⇒ Object


121
122
123
124
# File 'lib/aasm/instance_base.rb', line 121

def fire!(event_name, *args, &block)
  event_name = event_name.to_s.+("!").to_sym
  @instance.send(event_name, *args, &block)
end

#human_stateObject


30
31
32
# File 'lib/aasm/instance_base.rb', line 30

def human_state
  state_object_for_name(current_state).display_name
end

#may_fire_event?(name, *args) ⇒ Boolean

Returns:

  • (Boolean)

109
110
111
112
113
114
115
# File 'lib/aasm/instance_base.rb', line 109

def may_fire_event?(name, *args)
  if event = @instance.class.aasm(@name).state_machine.events[name]
    !!event.may_fire?(@instance, *args)
  else
    false # unknown event
  end
end

#permitted_transitionsObject


81
82
83
84
85
86
87
88
89
90
# File 'lib/aasm/instance_base.rb', line 81

def permitted_transitions
  events(permitted: true).flat_map do |event|
    available_transitions = event.transitions_from_state(current_state)
    allowed_transitions = available_transitions.select { |t| t.allowed?(@instance) }

    allowed_transitions.map do |transition|
      { event: event.name, state: transition.to }
    end
  end
end

#set_current_state_with_persistence(state) ⇒ Object


126
127
128
129
130
# File 'lib/aasm/instance_base.rb', line 126

def set_current_state_with_persistence(state)
  save_success = @instance.aasm_write_state(state, @name)
  self.current_state = state if save_success
  save_success
end

#state_object_for_name(name) ⇒ Object


92
93
94
95
96
# File 'lib/aasm/instance_base.rb', line 92

def state_object_for_name(name)
  obj = @instance.class.aasm(@name).states.find {|s| s.name == name}
  raise AASM::UndefinedState, "State :#{name} doesn't exist" if obj.nil?
  obj
end

#states(options = {}, *args) ⇒ Object


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/aasm/instance_base.rb', line 34

def states(options={}, *args)
  if options.has_key?(:permitted)
    selected_events = events({:permitted => options[:permitted]}, *args)
    # An array of arrays. Each inner array represents the transitions that
    # transition from the current state for an event
    event_transitions = selected_events.map {|e| e.transitions_from_state(current_state) }

    # An array of :to transition states
    to_state_names = event_transitions.map do |transitions|
      return nil if transitions.empty?

      # Return the :to state of the first transition that is allowed (or not) or nil
      if options[:permitted]
        transition = transitions.find { |t| t.allowed?(@instance, *args) }
      else
        transition = transitions.find { |t| !t.allowed?(@instance, *args) }
      end
      transition ? transition.to : nil
    end.flatten.compact.uniq

    # Select states that are in to_state_names
    @instance.class.aasm(@name).states.select {|s| to_state_names.include?(s.name)}
  else
    @instance.class.aasm(@name).states
  end
end