aasm-diagram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b604cccce71edd0a95f6d09957930855dd64de6b
+  data.tar.gz: afdc4b655659c8ff3764bd2b5a9182585c20c51e
+SHA512:
+  metadata.gz: 311921f61fc3536de515dabc309c067fbedfe953060902ffa30d5cd01793003ff7d2c86d1b58cb8a98918cb27dcfe052065c85d38913f2acc1fbb145d4e38187
+  data.tar.gz: 933bb4fa55f73efbe3ca2a9d65a95c836ba9090a8ac81acca90cffbfa0c5cfdc9ab03ca573fe6436a13f87281b1169c76ce441ce6b980577b2aaf698a7b25709

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+
+aasm-diagram-*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aasm-diagram.gemspec
+gemspec

data/README.md

@@ -0,0 +1,138 @@
+# AASM Diagram
+
+[AASM Diagram](https://github.com/katee/aasm-diagram) creates diagrams for [ASSM](https://github.com/aasm/aasm) state machines. To take an example from the AASM Readme:
+
+```ruby
+require 'aasm-diagram'
+
+class Job
+  include AASM
+
+  aasm do
+    state :sleeping, :initial => true
+    state :running, :cleaning
+
+    event :run do
+      transitions :from => :sleeping, :to => :running
+    end
+
+    event :clean do
+      transitions :from => :running, :to => :cleaning
+    end
+
+    event :sleep do
+      transitions :from => [:running, :cleaning], :to => :sleeping
+    end
+  end
+end
+
+job = Job.new
+
+AASMDiagram::Diagram.new(job.aasm, 'docs/job.png')
+```
+
+Generates the following diagram:
+
+![Diagram of Job state machine](docs/job.png)
+
+## Installation
+
+* Install Graphviz ([see the rails-erd guide for more details](https://voormedia.github.io/rails-erd/install.html)). If you use Homebrew try `brew install graphviz`.
+* Add `gem 'aasm-diagram', require: false, group: :development` to your `Gemfile` and run `bundle`.
+
+## More Examples
+
+### Guards
+
+```ruby
+class Cleaner
+  include AASM
+
+  aasm do
+    state :idle, :initial => true
+    state :cleaning
+
+    event :clean do
+      transitions :from => :idle, :to => :cleaning, :guard => :cleaning_needed?
+    end
+
+    event :clean_if_needed do
+      transitions :from => :idle, :to => :cleaning do
+        guard do
+          cleaning_needed?
+        end
+      end
+      transitions :from => :idle, :to => :idle
+    end
+
+    event :clean_if_dirty do
+      transitions :from => :idle, :to => :cleaning, :guard => :if_dirty?
+    end
+  end
+
+  def cleaning_needed?
+    false
+  end
+
+  def if_dirty?(status)
+    status == :dirty
+  end
+end
+
+cleaner = Cleaner.new
+AASMDiagram::Diagram.new(job.aasm, '../docs/guard-cleaner.png')
+```
+
+![Diagram of Cleaner state machine](docs/guard-cleaner.png)
+
+### Multiple state machines per class
+
+```ruby
+class SimpleMultipleExample
+  include AASM
+  aasm(:move) do
+    state :standing, :initial => true
+    state :walking
+    state :running
+
+    event :walk do
+      transitions :from => :standing, :to => :walking
+    end
+    event :run do
+      transitions :from => [:standing, :walking], :to => :running
+    end
+    event :hold do
+      transitions :from => [:walking, :running], :to => :standing
+    end
+  end
+
+  aasm(:work) do
+    state :sleeping, :initial => true
+    state :processing
+
+    event :start do
+      transitions :from => :sleeping, :to => :processing
+    end
+    event :stop do
+      transitions :from => :processing, :to => :sleeping
+    end
+  end
+end
+
+simple = SimpleMultipleExample.new
+AASMDiagram::Diagram.new(simple.aasm(:move), 'docs/multiple-state-machines-1.png')
+AASMDiagram::Diagram.new(simple.aasm(:work), 'docs/multiple-state-machines-2.png')
+```
+
+Generates two images:
+
+![Diagram of state machine 1](docs/multiple-state-machines-1.png)
+![Diagram of state machine 2](docs/multiple-state-machines-2.png)
+
+## Notes
+
+AASM Diagram is heavily inspired by [rails-erd](https://github.com/voormedia/rails-erd).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/aasm-diagram.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'aasm_diagram/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aasm-diagram'
+  spec.version       = AASMDiagram::VERSION
+  spec.authors       = ['Kate Murphy']
+  spec.email         = ['hello@kate.io']
+
+  spec.summary       = 'Automatically generate diagrams of AASM state machines.'
+  spec.homepage      = 'https://github.com/katee/aasm-diagram'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'aasm', '~> 4.12'
+  spec.add_runtime_dependency 'ruby-graphviz', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/aasm-diagram.rb

@@ -0,0 +1,5 @@
+require 'aasm'
+require 'graphviz'
+
+require 'aasm_diagram/version'
+require 'aasm_diagram/diagram'

data/lib/aasm_diagram/diagram.rb

@@ -0,0 +1,53 @@
+module AASMDiagram
+  #
+  # Save a diagram of a single AASM state machine to an image
+  #
+  class Diagram
+    def initialize(aasm_instance, filename)
+      @aasm_instance = aasm_instance
+      draw
+      save(filename)
+    end
+
+    def draw
+      @graphviz = GraphViz.new(:G, type: :digraph)
+      draw_nodes
+      draw_edges
+    end
+
+    def draw_nodes
+      state_names.map do |state_name|
+        @graphviz.add_nodes(state_name.to_s)
+      end
+    end
+
+    def draw_edges
+      events.each do |event|
+        event.transitions.each do |transition|
+          from = @graphviz.get_node(transition.from.to_s)
+          to = @graphviz.get_node(transition.to.to_s)
+          label = event.name.to_s
+          @graphviz.add_edges(from, to, label: label)
+        end
+      end
+    end
+
+    def save(filename)
+      @graphviz.output(png: filename)
+    end
+
+    private
+
+    def states
+      @aasm_instance.states
+    end
+
+    def state_names
+      states.map(&:name)
+    end
+
+    def events
+      @aasm_instance.events.first.state_machine.events.values
+    end
+  end
+end

data/lib/aasm_diagram/version.rb

@@ -0,0 +1,3 @@
+module AASMDiagram
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: aasm-diagram
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kate Murphy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- hello@kate.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- aasm-diagram.gemspec
+- docs/guard-cleaner.png
+- docs/job.png
+- docs/multiple-state-machines-1.png
+- docs/multiple-state-machines-2.png
+- lib/aasm-diagram.rb
+- lib/aasm_diagram/diagram.rb
+- lib/aasm_diagram/version.rb
+homepage: https://github.com/katee/aasm-diagram
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Automatically generate diagrams of AASM state machines.
+test_files: []