state_machines-graphviz 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b375be8fce2b404843e60ffc947edb7d7b37a5e4
-  data.tar.gz: e46a7734205fd1ff0946dacb72195e82e1863d5a
+  metadata.gz: 7816ed9a804fa1c1d96d1bb33ee7c06b8f46b6cc
+  data.tar.gz: 9732fe05fdafb7b65cc69da7e9c9824a9d831262
 SHA512:
-  metadata.gz: db7731a6a0236d51ca0a888870ab4f0bf1670ade1832051b2e84bd7220290b8ac5b86d473c089608aeb667388c70665fb9f2acf10cc89d59ee57d7f76fe59965
-  data.tar.gz: 854bb07b3eff8a50165b6bbc7012e2304259711d768238d5a0fbf88f02898f6e5a9730f36971a5c5d6f810cc87d30a649e9bfbf33a62230e1ff1ef99c7eda6c8
+  metadata.gz: 9e2a02602e0ac22e1890d944ea9e4f24cd69cd7d6b428ad145fd01f359f4c893b4090a9af03da1d1635c288b28a13a29592d1983c7816dc6f9d3d83014edb981
+  data.tar.gz: dbbbdf235db77bca214d0a5f21297da629d9d1868f86590d0c1173f4d304ab0258e4acdbc277035bce5a3813e50b92574104cbff94563ff58e18702b3107b344

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.idea

data/{.travis.yaml → .travis.yml}

@@ -1,6 +1,8 @@
 language: ruby
 install: sudo apt-get install graphviz -y
-before_install: gem install bundler
+before_install:
+ - gem install bundler
+ - bundle install
 script: bundle exec rake
 rvm:
   - 1.9.3

data/Gemfile

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

data/README.md

@@ -1,12 +1,13 @@
 # StateMachines::Graphviz
 
-TODO: Write a gem description
+This adds support for generating di-graphs based on the
+events, states, and transitions defined for a state machine using [GraphViz](http://www.graphviz.org).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'state_machine2-graphviz' , group: :development
+    gem 'state_machines-graphviz' , group: :development
 
 And then execute:
 
@@ -14,15 +15,68 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install state_machine2-graphviz
+    $ gem install state_machines-graphviz
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Examples
+
+To generate a graph for a specific file / class:
+
+```bash
+rake state_machines:draw FILE=vehicle.rb CLASS=Vehicle
+```
+From a Rails app directory:
+
+```bash
+rake state_machines:draw CLASS=Vehicle
+```
+
+To save files to a specific path:
+
+```bash
+rake state_machines:draw FILE=vehicle.rb CLASS=Vehicle TARGET=files
+```
+
+To customize the image format / orientation:
+
+```bash
+rake state_machines:draw FILE=vehicle.rb CLASS=Vehicle FORMAT=jpg ORIENTATION=landscape
+```
+
+See http://rdoc.info/github/glejeune/Ruby-Graphviz/GraphViz/Constants for the list of
+supported image formats.  If resolution is an issue, the svg format may offer
+better results.
+
+To generate multiple state machine graphs:
+
+```bash
+rake state_machines:draw FILE=vehicle.rb,car.rb CLASS=Vehicle,Car
+```
+
+To use human state / event names:
+
+```bash
+rake state_machines:draw FILE=vehicle.rb CLASS=Vehicle HUMAN_NAMES=true
+```
+
+**Note** that this will generate a different file for every state machine defined
+in the class.  The generated files will use an output filename of the format
+`#{class_name}_#{machine_name}.#{format}`.
+
+For examples of actual images generated using this task, see those under the
+examples folder.
+
+### Interactive graphs
+
+Jean Bovet's [Visual Automata Simulator](http://www.cs.usfca.edu/~jbovet/vas.html)
+is a great tool for "simulating, visualizing and transforming finite state
+automata and Turing Machines".  It can help in the creation of states and events
+for your models.  It is cross-platform, written in Java.
 
 ## Contributing
 
-1. Fork it ( https://github.com/seuros/state_machine2-graphviz/fork )
+1. Fork it ( https://github.com/seuros/state_machines-graphviz/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`)

data/Rakefile

@@ -1,5 +1,4 @@
-require 'rubygems'
-require 'bundler/setup'
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new do |t|
@@ -7,4 +6,8 @@ RSpec::Core::RakeTask.new do |t|
 end
 
 desc 'Default: run all tests.'
-task :default => :spec
+task :default => :spec
+task :test => :spec
+
+
+load File.dirname(__FILE__) + '/lib/state_machines/tasks/state_machines.rake'

data/lib/state_machines-graphviz.rb

@@ -0,0 +1 @@
+require 'state_machines/graphviz'

data/lib/state_machines/graphviz.rb

@@ -3,3 +3,5 @@ require 'graphviz'
 require 'state_machines/graphviz/monkeypatch'
 require 'state_machines/graphviz/graph'
 require 'state_machines/graphviz/version'
+
+require 'state_machines/tasks/railtie' if defined?(Rails)

data/lib/state_machines/graphviz/version.rb

@@ -1,6 +1,6 @@
 module StateMachines
   # Gem version
   module Graphviz
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/lib/state_machines/tasks/railtie.rb

@@ -0,0 +1,10 @@
+require 'state_machines/graphviz'
+require 'rails'
+module StateMachines
+  # https://gist.github.com/josevalim/af7e572c2dc973add221
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'state_machines/tasks/state_machines.rake'
+    end
+  end
+end

data/lib/state_machines/tasks/state_machines.rake

@@ -0,0 +1,3 @@
+require 'state_machines/graphviz'
+
+require File.join("#{File.dirname(__FILE__)}/state_machines")

data/lib/state_machines/tasks/state_machines.rb

@@ -0,0 +1,32 @@
+# Test with:
+#  rake state_machines:draw FILE=./spec/files/switch.rb CLASS=Switch
+namespace :state_machines do
+  desc 'Draws state machines using GraphViz (options: CLASS=User,Vehicle; FILE=user.rb,vehicle.rb [not required in Rails / Merb]; FONT=Arial; FORMAT=png; ORIENTATION=portrait; HUMAN_NAMES=true'
+  task :draw do
+    # Build drawing options
+    options = {}
+    options[:file] = ENV['FILE'] if ENV['FILE']
+    options[:path] = ENV['TARGET'] if ENV['TARGET']
+    options[:format] = ENV['FORMAT'] if ENV['FORMAT']
+    options[:font] = ENV['FONT'] if ENV['FONT']
+    options[:orientation] = ENV['ORIENTATION'] if ENV['ORIENTATION']
+    options[:human_names] = ENV['HUMAN_NAMES'] == 'true' if ENV['HUMAN_NAMES']
+    
+    if defined?(Rails)
+      puts "Files are automatically loaded in Rails; ignoring FILE option" if options.delete(:file)
+      Rake::Task['environment'].invoke
+    elsif defined?(Merb)
+      puts "Files are automatically loaded in Merb; ignoring FILE option" if options.delete(:file)
+      Rake::Task['merb_env'].invoke
+      
+      # Fix ruby-graphviz being incompatible with Merb's process title
+      $0 = 'rake'
+    else
+      # Load the library
+      $:.unshift(File.dirname(__FILE__) + '/..')
+      require 'state_machines'
+    end
+    
+    StateMachines::Machine.draw(ENV['CLASS'], options)
+  end
+end

data/state_machines-graphviz.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = StateMachines::Graphviz::VERSION
   spec.authors       = ['Abdelkader Boudih', 'Aaron Pfeifer']
   spec.email         = ['terminale@gmail.com']
-  spec.summary       = %q(Drawing module for state machine2)
-  spec.description   = %q(Graphviz module for state machine2)
+  spec.summary       = %q(Drawing module for state machines)
+  spec.description   = %q(Graphviz module for state machines)
   spec.homepage      = 'https://github.com/seuros/state_machines-graphviz'
   spec.license       = 'MIT'
 
@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ruby-graphviz'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec' , '3.0.0.beta2'
+  spec.add_development_dependency 'rspec' , '>=3.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-graphviz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines
@@ -71,17 +71,17 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
-description: Graphviz module for state machine2
+        version: 3.0.0
+description: Graphviz module for state machines
 email:
 - terminale@gmail.com
 executables: []
@@ -90,15 +90,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yaml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/state_machines-graphviz.rb
 - lib/state_machines/graphviz.rb
 - lib/state_machines/graphviz/graph.rb
 - lib/state_machines/graphviz/monkeypatch.rb
 - lib/state_machines/graphviz/version.rb
+- lib/state_machines/tasks/railtie.rb
+- lib/state_machines/tasks/state_machines.rake
+- lib/state_machines/tasks/state_machines.rb
 - spec/files/switch.rb
 - spec/graph_spec.rb
 - spec/machine_drawing_spec.rb
@@ -126,9 +130,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Drawing module for state machine2
+summary: Drawing module for state machines
 test_files: []
-has_rdoc: