class Object
Public Instance Methods
init()
click to toggle source
Define where state machine descriptions will be rendered
Calls superclass method
# File lib/state_machine/yard/templates/default/class/html/setup.rb, line 4 def init super sections.place(:state_machine_details).before(:children) end
state_machine_details()
click to toggle source
Renders state machine details in the main content of the class's documentation
# File lib/state_machine/yard/templates/default/class/html/setup.rb, line 10 def state_machine_details erb(:state_machines) if state_machines end
state_machine_image_path(machine)
click to toggle source
Generates the image path for the given machine's visualization
# File lib/state_machine/yard/templates/default/class/html/setup.rb, line 26 def state_machine_image_path(machine) base_path = File.dirname(serializer.serialized_path(object)) image_name = "#{object.name}_#{machine[:name]}" "#{File.join(base_path, image_name)}.png" end
state_machines()
click to toggle source
Gets a list of state machines prased for this class
# File lib/state_machine/yard/templates/default/class/html/setup.rb, line 15 def state_machines @state_machines ||= begin if state_machines = object['state_machines'] state_machines.each do |name, machine| serializer.serialize(state_machine_image_path(machine), machine[:image]) if machine[:image] end end end end