aasm_statecharts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e89b5b44cb179e336bb467bbe9c0af6198cbb4f5
+  data.tar.gz: cea3f2ae3f920efe4a13e8d47d71566215248c43
+SHA512:
+  metadata.gz: 437de932bc28fc77a87015af178618b023fb70e8de11ea407f25885b59b809277c9dbebf57094380952b1e540d8f98d8396a3286dc87ac040101bd5e481ea339
+  data.tar.gz: bf0f765d8eb824967cbcceb54139b1e8020088f741bb2eb7f718014236eb779cc24fca8c68191e200b82176f99f5f0d0e9ca270c909c9c8c5af9cd4421c9bb0c

data/bin/aasm_statecharts

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'bundler'
+  Bundler.setup
+rescue Exception
+end
+
+here = File.expand_path(File.dirname __FILE__)
+$:<< "#{here}/../lib"
+
+require 'optparse'
+require 'aasm_statechart'
+
+
+def parse_command_line!
+  options = {
+    all: false,
+    directory: './doc',
+    format: 'png',
+  }
+
+  formats = AasmStatechart::Renderer::FORMATS.join(', ')
+
+  parser = OptionParser.new do |opts|
+    opts.banner = "Usage: aasm_statechart [options] <model> [models ...]"
+
+    opts.on('-a', '--all', "Render all models using AASM") do
+      options[:all] = true
+    end
+
+    opts.on('-d', '--directory directory',
+            "Output to a specific directory (default: #{options[:directory]})") do |directory|
+      options[:directory] = directory
+    end
+
+    opts.on('-t', '--file-type type',
+            "Output in the specified format (default: #{options[:format]}), which must be one of the following: #{formats}.") do |format|
+      format = format.downcase
+
+      if !AasmStatechart::Renderer::FORMATS.include?(format)
+        puts "error: #{format} is not a recognized file format."
+        puts "The file format must be one of the following: #{formats}."
+        exit(1)
+      end
+
+      options[:format] = format
+    end
+
+    opts
+  end
+
+  parser.parse!
+
+  if !options[:all] && ARGV.empty?
+    puts parser
+    exit(1)
+  end
+
+  [options, ARGV]
+end
+
+def load_rails!
+  if !File.exists? './config/environment.rb'
+    script_name = File.basename $PROGRAM_NAME
+    puts 'error: unable to find ./config/environment.rb.'
+    puts "Please run #{script_name} from the root of your Rails application."
+    exit(1)
+  end
+
+  require './config/environment'
+end
+
+def ensure_directory! directory
+  Dir.mkdir(directory) unless Dir.exists? directory
+end
+
+def collect_models(model_names)
+  model_names.map { |model_name| model_name.classify.constantize }
+end
+
+def collect_all_models
+  Rails::Application.subclasses.first.eager_load!
+  ActiveRecord::Base.subclasses.select { |klass| klass.respond_to? :aasm }
+end
+
+
+options, model_names = parse_command_line!
+load_rails!
+ensure_directory! options[:directory]
+
+models = options[:all] ? collect_all_models : collect_models(model_names)
+
+models.each do |klass|
+  name = klass.name.underscore
+  renderer = AasmStatechart::Renderer.new(klass)
+  filename = "#{options[:directory]}/#{name}.#{options[:format]}"
+  renderer.save(filename, format: options[:format])
+  puts " * rendered #{name} to #{filename}"
+end

data/lib/aasm_statechart.rb

@@ -0,0 +1,140 @@
+#
+#
+# @author Brendan MacDonell
+
+require 'graphviz'
+
+
+module AasmStatechart
+  class Renderer
+    FORMATS = GraphViz::Constants::FORMATS
+
+    GRAPH_STYLE = {
+      rankdir: :TB,
+    }
+
+    NODE_STYLE = {
+      shape: :Mrecord,
+      fontname: 'Arial',
+      fontsize: 10,
+      penwidth: 0.7,
+    }
+
+    EDGE_STYLE = {
+      dir: :forward,
+      fontname: 'Arial',
+      fontsize: 9,
+      penwidth: 0.7,
+    }
+
+    START_NODE_STYLE = {
+      shape: :circle,
+      label: '',
+      style: :filled,
+      color: 'black',
+      fillcolor: 'black',
+      fixedsize: true,
+      width: 0.25,
+      height: 0.25,
+    }
+
+    END_NODE_STYLE = {
+      shape: :doublecircle,
+      label: '',
+      style: :filled,
+      color: 'black',
+      fillcolor: 'black',
+      fixedsize: true,
+      width: 0.20,
+      height: 0.20,
+    }
+
+    ENTER_CALLBACKS = [:before_enter, :enter, :after_enter, :after_commit]
+    EXIT_CALLBACKS = [:before_exit, :exit, :after_exit]
+    TRANSITION_CALLBACKS = [:before, :on_transition, :after]
+
+    def initialize(klass)
+      @start_node = nil
+      @end_node = nil
+
+      @graph = GraphViz.new(:statechart)
+      @graph.type = 'digraph'
+
+      # ruby-graphviz is missing an API to set styles in bulk, so set them here
+      GRAPH_STYLE.each { |k, v| @graph.graph[k] = v }
+      NODE_STYLE.each { |k, v| @graph.node[k] = v }
+      EDGE_STYLE.each { |k, v| @graph.edge[k] = v }
+
+      klass.aasm.states.each { |state| render_state(state) }
+      klass.aasm.events.each { |name, event| render_event(name, event) }
+    end
+
+    def save(filename, format: 'png')
+      @graph.output({format => filename})
+    end
+
+    private
+
+    def start_node
+      if @start_node.nil?
+        @start_node = @graph.add_nodes(SecureRandom.uuid, **START_NODE_STYLE)
+      end
+
+      @start_node
+    end
+
+    def end_node
+      if @end_node.nil?
+        @end_node = @graph.add_nodes(SecureRandom.uuid, **END_NODE_STYLE)
+      end
+
+      @end_node
+    end
+
+    def get_options(options, keys)
+      options
+        .select { |key| keys.include? key }
+        .values
+        .flatten
+    end
+
+    def get_callbacks(options, keys)
+      get_options(options, keys)
+        .map { |callback| "#{callback}();" }
+        .join(' ')
+    end
+
+    def render_state(state)
+      enter_callbacks = get_callbacks(state.options, ENTER_CALLBACKS)
+      exit_callbacks = get_callbacks(state.options, EXIT_CALLBACKS)
+
+      callbacks_list = []
+      callbacks_list << "entry / #{enter_callbacks}" if enter_callbacks.present?
+      callbacks_list << "exit / #{exit_callbacks}" if exit_callbacks.present?
+      label = "{#{state.display_name}|#{callbacks_list.join('\l')}}"
+
+      node = @graph.add_nodes(state.name.to_s, label: label)
+
+      if state.options.fetch(:initial, false)
+        @graph.add_edges(start_node, node)
+      elsif state.options.fetch(:final, false)
+        @graph.add_edges(node, end_node)
+      end
+    end
+
+    def render_event(name, event)
+      event.transitions.each do |transition|
+        chunks = [name]
+
+        guard = transition.options.fetch(:guard, nil)
+        chunks << "[#{guard}]" if guard
+        callbacks = get_callbacks(transition.options, TRANSITION_CALLBACKS)
+        chunks << '/' << callbacks if callbacks.present?
+
+        label = " #{chunks.join(' ')}  "
+
+        @graph.add_edges(transition.from.to_s, transition.to.to_s, label: label)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: aasm_statecharts
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brendan MacDonell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Generate UML-style state charts from AASM state machines
+email: brendan@macdonell.net
+executables:
+- aasm_statecharts
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/aasm_statecharts
+- lib/aasm_statechart.rb
+homepage: http://rubygems.org/gems/aasm_statecharts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: AASM statecharts
+test_files: []
+has_rdoc: