statesman-diagram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca3590ccc9a8e59faa1f476fdc5040cf6042581f
+  data.tar.gz: 21044a3ad7fb2512fe29d110655bf97dd2dcd84f
+SHA512:
+  metadata.gz: efb8318d957ef1f33ab03c49528a2b222e670d2b9bf2547974eda61af68037503a7f6a148917c2bc37ccf0081afb8d95d23a847ba9c9b69e8053e35bb165127a
+  data.tar.gz: 8498622a278ed83a5870f291aa18193dbc94d333b6673bc848b0609bb060c7a8514db75a63c674a28c4fd646a344ee94cba5a469cce8922b49ef087dcdd9c935

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ilya Vassilevsky
+
+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,51 @@
+# Statesman State Diagram
+
+Adds `.to_dot` method to `Statesman::Machine`. It can export your machine
+class definition to the
+[DOT](https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29) format.
+
+Also adds a Rake task called `statesman:diagram`. It runs the `dot`
+program (GraphViz) to make a PNG image from the DOT representation of the
+machine class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'statesman-diagram'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statesman-diagram
+
+## Prerequisites
+
+* GraphViz (the `dot` program)
+  * `brew install graphviz` on OS X / macOS
+
+## Usage
+
+Run `rake statesman:diagram[My::State::Machine::Class]`.
+Find the state diagram of this class in `My::State::Machine::Class.png`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vassilevsky/statesman-diagram.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/statesman-diagram.rb

@@ -0,0 +1,15 @@
+require "statesman/machine"
+
+module Statesman
+  module Machine
+    module ClassMethods
+      def to_dot
+        <<-DOT
+digraph #{name.gsub('::', '_')} {
+#{successors.map{|from, tos| tos.map{|to| "  #{from} -> #{to};" } }.flatten.join("\n")}
+}
+        DOT
+      end
+    end
+  end
+end

data/lib/tasks/statesman.rake

@@ -0,0 +1,21 @@
+namespace :statesman do
+  desc "Render a PNG image of the state diagram of the given state machine class"
+  task :diagram, [:class] => :environment do |t, args|
+    machine_class = self.class.const_get(args[:class])
+    puts "Will draw the state diagram of #{machine_class}"
+    dot = machine_class.to_dot
+    puts "Here it is in the textual form:"
+    puts dot
+    filename = "#{machine_class}.png"
+    cmd = %W(dot -Tpng -o#{filename})
+    puts "Running '#{cmd.join(' ')}' with this ^ as stdin..."
+    require 'open3'
+    output, status = Open3.capture2e(*cmd, stdin_data: dot)
+    if status.success?
+      puts "Success. You can open #{filename} and see the diagram."
+    else
+      puts 'The command failed:'
+      puts output
+    end
+  end
+end

data/statesman-diagram.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "statesman-diagram"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Ilya Vassilevsky"]
+  spec.email         = ["vassilevsky@gmail.com"]
+
+  spec.summary       = "Generates DOT representations of Statesman machines and runs dot to render them to PNGs"
+  spec.homepage      = "https://github.com/vassilevsky/statesman-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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "statesman", "~> 2.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: statesman-diagram
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilya Vassilevsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: statesman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- vassilevsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/statesman-diagram.rb
+- lib/tasks/statesman.rake
+- statesman-diagram.gemspec
+homepage: https://github.com/vassilevsky/statesman-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.5.2
+signing_key: 
+specification_version: 4
+summary: Generates DOT representations of Statesman machines and runs dot to render
+  them to PNGs
+test_files: []