statesman-diagram 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a197c2d36873e26b2de620f97d8180782b059a8
-  data.tar.gz: 5ea01f31f7fc7658e1fb9f6191b95c9367ac1a5c
+  metadata.gz: 16343a14d2db965949cd03525930344782e89c63
+  data.tar.gz: 1482e56175e597d5e09c2546f81233e76ce933a5
 SHA512:
-  metadata.gz: 88eb555e1a56c21c2b406d6d7b283d67c5347243897254e664d80dc67763dab2d5a8d7268011bb9715de60f9e10eb83d936d3a4ad1421beec0c703fa67a406a7
-  data.tar.gz: 27f358220e8c5632b44732ff028dfccd00d33db77b9770c577d320c1a68f4c94d58ebc9ec257825ff1b09cd3ec9b2685d4e6c0dfd62595f942b8b6cd18103225
+  metadata.gz: b19dde9ff759e4bb95c54165a34e201d3c80c454909cee982766f36034d8e2ddfc1a91f364d06ffd4a3617a11faa33d12064b1d03a775931d3ca68a0e8e86fec
+  data.tar.gz: eda071f3eb579a75be5c0ff4b5d4f6cc0e961976469b829f0ae620ca51548824f91c4cd32333028785f14efe068df9325e16617297d71a95a5d7222c83996287

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    statesman-diagram (0.1.2)
+      statesman (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    statesman (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  statesman-diagram!
+
+BUNDLED WITH
+   1.15.4

data/README.md

@@ -40,7 +40,10 @@ Or install it yourself as:
 ## Usage
 
 Run `rake statesman:diagram[My::State::Machine::Class]`.
-Find the state diagram of this class in `My::State::Machine::Class.png`.
+Find the state diagram of this class in `My_State_Machine_Class.png`.
+
+You can also specify the name of the file `rake statesman:diagram[My::State::Machine::Class, ./temp/state]`
+Find the state diagram of this class in `./temp/state.png`.
 
 ## Development
 

data/Rakefile

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

data/lib/statesman-diagram.rb

@@ -1,15 +1,2 @@
-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
+require 'statesman/machine/class_methods'
+require 'statesman/diagram'

data/lib/statesman/diagram.rb

@@ -0,0 +1,49 @@
+require 'open3'
+
+module Statesman
+  class Diagram
+    # @param [String] name  - name of the diagram.
+    # @param [Hash]   graph - list of vertices and edges.
+    def initialize(name:, graph:)
+      @name  = name
+      @graph = graph
+    end
+
+    # @return [String] diagram in DOT format.
+    def to_dot
+      format("digraph %{name} {\n  %{body}\n}", name: @name, body: dot_body.join("\n  "))
+    end
+
+    def to_png(file_name = nil)
+      file_name ||= @name
+      file_name += '.png'
+
+      build_png(file_name)
+    end
+
+    private
+
+    # @return [String]
+    def dot_body
+      @graph.map do |vertex, edges|
+        edges.map do |to|
+          "#{vertex} -> #{to};"
+        end
+      end.flatten
+    end
+
+    def build_png(file_name)
+      cmd = ['dot', '-Tpng', "-o#{file_name}"]
+
+      puts "Running '#{cmd.join(' ')}' with this ^ as stdin..."
+
+      output, status = Open3.capture2e(*cmd, stdin_data: to_dot)
+      if status.success?
+        puts "Success. You can open #{file_name} and see the diagram."
+      else
+        puts 'The command failed:'
+        puts output
+      end
+    end
+  end
+end

data/lib/statesman/diagram/version.rb

@@ -0,0 +1,5 @@
+module Statesman
+  class Diagram
+    VERSION = '0.1.2'.freeze
+  end
+end

data/lib/statesman/machine/class_methods.rb

@@ -0,0 +1,21 @@
+require 'statesman/machine'
+
+module Statesman
+  module Machine
+    module ClassMethods
+      # @return [Statesman::Diagram] diagram for the state machine
+      def diagram
+        Diagram.new(name: name.gsub('::', '_'), graph: successors)
+      end
+
+      # @return [String] state machine in DOT format.
+      def to_dot
+        diagram.to_dot
+      end
+
+      def to_png(file_name = nil)
+        diagram.to_png(file_name)
+      end
+    end
+  end
+end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: statesman-diagram
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ilya Vassilevsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: statesman
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: statesman
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: 
 email:
 - vassilevsky@gmail.com
@@ -73,15 +73,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".vexor.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/statesman-diagram.rb
-- lib/tasks/statesman.rake
-- statesman-diagram.gemspec
+- lib/statesman/diagram.rb
+- lib/statesman/diagram/version.rb
+- lib/statesman/machine/class_methods.rb
 homepage: https://github.com/vassilevsky/statesman-diagram
 licenses:
 - MIT

data/.gitignore

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

data/.vexor.yml

@@ -1,10 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.3.3
-  - 2.2.6
-  - 2.1.9
-
-before_install:
-- sudo apt-get update -yq && sudo apt-get install -y graphviz
-- gem install bundler -v 1.14.4

data/lib/tasks/statesman.rake

@@ -1,21 +0,0 @@
-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.name.gsub('::','_')}.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

@@ -1,27 +0,0 @@
-# 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.1"
-  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