class AasmDiagram

Diagram for Acts As State Machine

Public Class Methods

new(options = OptionsStruct.new) click to toggle source
Calls superclass method AppDiagram::new
# File lib/railroady/aasm_diagram.rb, line 7
def initialize(options = OptionsStruct.new)
  # options.exclude.map! {|e| e = "app/models/" + e}
  super options
  @graph.diagram_type = 'Models'
  # Processed habtm associations
  @habtm = []
end

Public Instance Methods

generate() click to toggle source

Process model files

# File lib/railroady/aasm_diagram.rb, line 16
def generate
  $stderr.print "Generating AASM diagram\n" if @options.verbose
  get_files.each do |f|
    process_class extract_class_name(f).constantize
  end
end
get_files(prefix = '') click to toggle source
# File lib/railroady/aasm_diagram.rb, line 23
def get_files(prefix = '')
  files = !@options.specify.empty? ? Dir.glob(@options.specify) : Dir.glob("#{prefix}app/models/**/*.rb")
  files += Dir.glob('vendor/plugins/**/app/models/*.rb') if @options.plugins_models
  files - Dir.glob("#{prefix}app/models/concerns/**/*.rb") unless @options.include_concerns
  Dir.glob(@options.exclude)
end

Private Instance Methods

load_classes() click to toggle source

Load model classes

# File lib/railroady/aasm_diagram.rb, line 33
def load_classes
  disable_stdout
  get_files.each { |m| require m }
  enable_stdout
rescue LoadError
  enable_stdout
  print_error 'model classes'
  raise
end
process_aasm_class(current_class) click to toggle source
# File lib/railroady/aasm_diagram.rb, line 51
def process_aasm_class(current_class)
  node_attribs = []
  node_type = 'aasm'
  diagram_friendly_class_name = current_class.name.downcase.gsub(/[^a-z0-9\-_]+/i, '_')

  $stderr.print "\t\tprocessing as aasm\n" if @options.verbose
  current_class.aasm.states.each do |state|
    node_shape = current_class.aasm.initial_state == state.name ? ', peripheries = 2' : ''
    node_attribs << "#{diagram_friendly_class_name}_#{state.name} [label=#{state.name} #{node_shape}];"
  end
  @graph.add_node [node_type, current_class.name, node_attribs]

  current_class.aasm.events.each do |event|
    event.transitions.each do |transition|
      @graph.add_edge [
        'event',
        "#{diagram_friendly_class_name}_#{transition.from}",
        "#{diagram_friendly_class_name}_#{transition.to}",
        event.name.to_s
      ]
    end
  end
end
process_class(current_class) click to toggle source

Process a model class

# File lib/railroady/aasm_diagram.rb, line 44
def process_class(current_class)
  $stderr.print "\tProcessing #{current_class}\n" if @options.verbose

  # Only interested in aasm models.
  process_aasm_class(current_class)  if current_class.respond_to?(:aasm_states) || current_class.respond_to?(:aasm)
end