graphviz_aasm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 689c7a59230667068094f130a38eff5af5282a21
+  data.tar.gz: c7bbb0d0dc62f3c29acfe865ef2dc5dc00020660
+SHA512:
+  metadata.gz: 9c48c61e4e3b619e7c31149a7542b521ca384f0794f3d43222636c34a355983dbe14c9fcd6db3e32689ae01e28d0a8bed859f554f66ad31a86b9cd51adf4c404
+  data.tar.gz: fc3fd2e310f2a0151b310854a73c607323b9e02705a75b4e1458f48a9d2b2c87435bee5d25ab4fdabb65b67f7c4749d8f96a1c6a6fe923aa6285974564b9f246

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roman Trofimov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# GraphvizAasm
+
+Adds support for generating graphs based on states, events and transitions defined for AASM state machine using
+[GraphViz](http://www.graphviz.org) and [Ruby-GraphViz](https://github.com/glejeune/Ruby-Graphviz).
+It is a simplified version of the same functionality for [state_machine](https://github.com/pluginaweek/state_machine) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'graphviz_aasm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphviz_aasm
+
+## Usage
+
+To generate a graph for a specific model:
+
+    $ rake aasm:draw CLASS=Vehicle
+
+To save files to a specific path:
+
+    $ rake aasm:draw CLASS=Vehicle,Vehicle::Color TARGET=./tmp
+
+
+## Contributing
+
+1. Fork it ( http://github.com/romatr/graphviz_aasm/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')

data/graphviz_aasm.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphviz_aasm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphviz_aasm"
+  spec.version       = GraphvizAasm::VERSION
+  spec.authors       = ["Roman Trofimov"]
+  spec.email         = ["trofimov.roman@gmail.com"]
+  spec.summary       = %q{Use Ruby-GraphViz for AASM.}
+  spec.description   = %q{This gem patches AASM to be able to generate graphs using GraphViz.}
+  spec.homepage      = "https://github.com/romatr/graphviz_aasm"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.2.1"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+
+  spec.add_dependency "aasm", "~> 3.1.1"
+  spec.add_dependency "rails", "~> 4.0.4"
+  spec.add_dependency "ruby-graphviz", "~> 1.0.9"
+end

data/lib/aasm/graph.rb

@@ -0,0 +1,16 @@
+require "graphviz"
+
+module AASM
+  class Graph < ::GraphViz
+    def initialize(class_name, options = {})
+      options = {path: '.'}.merge(options)
+
+      @file_path = File.join(options[:path], "#{class_name.parameterize('_')}_aasm.png")
+      super(:G)
+    end
+
+    def output
+      super png: @file_path
+    end
+  end
+end

data/lib/graphviz_aasm.rb

@@ -0,0 +1,55 @@
+require "aasm"
+require "aasm/graph"
+require "graphviz_aasm/version"
+
+module GraphvizAasm
+  require "graphviz_aasm/railtie" if defined?(Rails)
+
+  AASM::StateMachine.class_eval do
+    def self.draw(class_names, options = {})
+      raise ArgumentError, "At least one class must be specified" unless class_names && class_names.split(',').any?
+
+      class_names.split(',').each do |class_name|
+        klass = class_name.constantize
+
+        graph = AASM::Graph.new(class_name, options)
+
+        klass.aasm.states.each do |state|
+          state.draw(graph)
+        end
+
+        klass.aasm.events.each_value do |event|
+          event.draw(graph)
+        end
+        graph.output
+      end
+    end
+  end
+
+  AASM::State.class_eval do
+    def draw(graph)
+      node = graph.add_nodes(self.human_name, shape: final? ? "doublecircle" : "ellipse")
+      graph.add_edge(graph.add_nodes("starting_state", shape: "point"), node) if initial?
+    end
+
+    def initial?
+      @clazz.aasm.initial_state == self.name
+    end
+
+    def final?
+      !@clazz.aasm.events.any? do |_, event|
+        event.transitions.any? do |transition|
+          transition.from == self.name
+        end
+      end
+    end
+  end
+
+  AASM::Event.class_eval do
+    def draw(graph)
+      transitions.each do |transition|
+        graph.add_edge(transition.from.to_s.capitalize, transition.to.to_s.capitalize)
+      end
+    end
+  end
+end

data/lib/graphviz_aasm/railtie.rb

@@ -0,0 +1,9 @@
+module GraphvizAasm
+  class Railtie < Rails::Railtie
+    railtie_name :graphviz_aasm
+
+    rake_tasks do
+      load "tasks/graphviz_aasm.rake"
+    end
+  end
+end

data/lib/graphviz_aasm/version.rb

@@ -0,0 +1,3 @@
+module GraphvizAasm
+  VERSION = "0.0.1"
+end

data/lib/tasks/graphviz_aasm.rake

@@ -0,0 +1,10 @@
+namespace :aasm do
+  desc "Draws AASM states using GraphViz (options: CLASS=User,Vehicle; TARGET=/folder/path ; ORIENTATION=portrait;)"
+  task draw: :environment do
+    options = {}
+    options[:path]        = ENV['TARGET'] if ENV['TARGET']
+    options[:orientation] = ENV['ORIENTATION'] if ENV['ORIENTATION']
+
+    AASM::StateMachine.draw(ENV['CLASS'], options)
+  end
+end

data/spec/lib/graphviz_aasm_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe GraphvizAasm do
+  pending
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "graphviz_aasm"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: graphviz_aasm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roman Trofimov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+description: This gem patches AASM to be able to generate graphs using GraphViz.
+email:
+- trofimov.roman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- graphviz_aasm.gemspec
+- lib/aasm/graph.rb
+- lib/graphviz_aasm.rb
+- lib/graphviz_aasm/railtie.rb
+- lib/graphviz_aasm/version.rb
+- lib/tasks/graphviz_aasm.rake
+- spec/lib/graphviz_aasm_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/romatr/graphviz_aasm
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Use Ruby-GraphViz for AASM.
+test_files:
+- spec/lib/graphviz_aasm_spec.rb
+- spec/spec_helper.rb