state_machines-graphviz 0.0.1 → 0.1.0

data/test/machine_drawing_with_nil_states_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+describe StateMachines::Graph do
+  def setup
+    @klass = Class.new do
+      def self.name
+        @name ||= "Vehicle_#{rand(1_000_000)}"
+      end
+    end
+
+    @machine = StateMachines::Machine.new(@klass, initial: :parked)
+    @machine.event :ignite do
+      transition parked: :idling
+    end
+    @machine.state :parked, value: nil
+
+    @graph = @machine.draw
+  end
+
+  def test_should_draw_all_states
+    assert(@graph.node_count, 3)
+  end
+
+  def test_should_draw_all_events
+    assert(@graph.edge_count, 2)
+  end
+
+  def test_should_draw_machine
+    assert(File.exist?("doc/state_machines/#{@klass.name}_state.png"))
+  end
+
+  def teardown
+    assert(FileUtils.rm(Dir["doc/state_machines/#{@klass.name}_state.png"]))
+  end
+end

data/test/state_drawing_final_test.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+describe StateMachines::Graph do
+  def setup
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine.states << @state = StateMachines::State.new(@machine, :parked)
+
+    graph = StateMachines::Graph.new('test')
+    @state.draw(graph)
+    @node = graph.get_node('parked')
+  end
+
+  def test_should_use_doublecircle_as_shape
+    assert_equal('doublecircle', @node['shape'].to_s.gsub('"', ''))
+  end
+end

data/test/state_drawing_initial_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+describe StateMachines::Graph do
+  def setup
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine.states << @state = StateMachines::State.new(@machine, :parked, initial: true)
+    @machine.event :ignite do
+      transition parked: :idling
+    end
+
+    @graph = StateMachines::Graph.new('test')
+    @state.draw(@graph)
+    @node = @graph.get_node('parked')
+  end
+
+  def test_should_use_ellipse_as_shape
+    assert_equal 'ellipse', @node['shape'].to_s.gsub('"', '')
+  end
+
+  def test_should_draw_edge_between_point_and_state
+    assert_equal(2, @graph.node_count)
+    assert_equal(1, @graph.edge_count)
+  end
+end

data/test/state_drawing_lambda_value_test.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+describe StateMachines::Graph do
+  def setup
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine.states << @state = StateMachines::State.new(@machine, :parked, value: -> {})
+
+    graph = StateMachines::Graph.new('test')
+    @state.draw(graph)
+    @node = graph.get_node('parked')
+  end
+
+  def test_should_have_a_node
+    assert(@node)
+  end
+
+  def test_should_use_description_as_label
+    assert_equal('parked (*)', @node['label'].to_s.gsub('"', ''))
+  end
+end

data/test/state_drawing_nil_name_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+describe StateMachines::Graph do
+  def setup
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine.states << @state = StateMachines::State.new(@machine, nil)
+
+    graph = StateMachines::Graph.new('test')
+    @state.draw(graph)
+    @node = graph.get_node('nil')
+  end
+
+  def test_should_have_a_node
+    assert(@node)
+  end
+
+  def test_should_use_description_as_label
+    assert_equal 'nil', @node['label'].to_s.gsub('"', '')
+  end
+end

data/test/state_drawing_non_final_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+describe StateMachines::Graph do
+  def setup
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine.states << @state = StateMachines::State.new(@machine, :parked)
+    @machine.event :ignite do
+      transition parked: :idling
+    end
+
+    graph = StateMachines::Graph.new('test')
+    @state.draw(graph)
+    @node = graph.get_node('parked')
+  end
+
+  def test_should_use_ellipse_as_shape
+    assert_equal('ellipse', @node['shape'].to_s.gsub('"', ''))
+  end
+end

data/test/state_drawing_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+
+describe StateMachines::Graph do
+  def setup
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine.states << @state = StateMachines::State.new(@machine, :parked, value: 1)
+    @machine.event :ignite do
+      transition parked: :idling
+    end
+
+    graph = StateMachines::Graph.new('test')
+    @state.draw(graph)
+    @node = graph.get_node('parked')
+  end
+
+  def test_should_use_ellipse_shape
+    assert_equal(@node['shape'].to_s.gsub('"', ''), 'ellipse')
+  end
+
+  def test_should_set_width_to_one
+    assert_equal('1', @node['width'].to_s.gsub('"', ''))
+  end
+
+  def test_should_set_height_to_one
+    assert_equal('1', @node['height'].to_s.gsub('"', ''))
+  end
+
+  def test_should_use_description_as_label
+    assert_equal(@node['label'].to_s.gsub('"', ''), 'parked (1)')
+  end
+end

data/test/state_drawing_with_human_name_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+describe StateMachines::Graph do
+  def setup
+    @machine = StateMachines::Machine.new(Class.new)
+    @machine.states << @state = StateMachines::State.new(@machine, :parked, human_name: 'Parked')
+    @machine.event :ignite do
+      transition parked: :idling
+    end
+
+    graph = StateMachines::Graph.new('test')
+    @state.draw(graph, human_name: true)
+    @node = graph.get_node('parked')
+  end
+
+  def test_should_use_description_with_human_name_as_label
+    assert_equal('Parked', @node['label'].to_s.gsub('"', ''))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'state_machines-graphviz'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-graphviz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 - Aaron Pfeifer
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines
@@ -25,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: state_machines-diagram
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
@@ -68,49 +81,57 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 5.27.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: 5.27.0
+description: Graphviz module for state machines
 email:
 - terminale@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yaml"
-- 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/renderer.rb
 - lib/state_machines/graphviz/version.rb
-- spec/files/switch.rb
-- spec/graph_spec.rb
-- spec/machine_drawing_spec.rb
-- spec/machine_spec.rb
-- spec/spec_helper.rb
-- spec/state_spec.rb
-- state_machines-graphviz.gemspec
-homepage: https://github.com/seuros/state_machines-graphviz
+- lib/state_machines/tasks/railtie.rb
+- lib/state_machines/tasks/state_machines.rake
+- test/files/switch.rb
+- test/graph_default_test.rb
+- test/graph_edges_test.rb
+- test/graph_nodes_test.rb
+- test/graph_output_test.rb
+- test/machine_class_drawing_test.rb
+- test/machine_drawing_test.rb
+- test/machine_drawing_with_dynamic_states_test.rb
+- test/machine_drawing_with_integer_states_test.rb
+- test/machine_drawing_with_nil_states_test.rb
+- test/state_drawing_final_test.rb
+- test/state_drawing_initial_test.rb
+- test/state_drawing_lambda_value_test.rb
+- test/state_drawing_nil_name_test.rb
+- test/state_drawing_non_final_test.rb
+- test/state_drawing_test.rb
+- test/state_drawing_with_human_name_test.rb
+- test/test_helper.rb
+homepage: https://github.com/state-machines/state_machines-graphviz
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -125,10 +146,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
-summary: Drawing module for state machine2
-test_files: []
-has_rdoc: 
+summary: Drawing module for state machines
+test_files:
+- test/files/switch.rb
+- test/graph_default_test.rb
+- test/graph_edges_test.rb
+- test/graph_nodes_test.rb
+- test/graph_output_test.rb
+- test/machine_class_drawing_test.rb
+- test/machine_drawing_test.rb
+- test/machine_drawing_with_dynamic_states_test.rb
+- test/machine_drawing_with_integer_states_test.rb
+- test/machine_drawing_with_nil_states_test.rb
+- test/state_drawing_final_test.rb
+- test/state_drawing_initial_test.rb
+- test/state_drawing_lambda_value_test.rb
+- test/state_drawing_nil_name_test.rb
+- test/state_drawing_non_final_test.rb
+- test/state_drawing_test.rb
+- test/state_drawing_with_human_name_test.rb
+- test/test_helper.rb

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,3 +0,0 @@
---color
---warnings
---require spec_helper

data/.travis.yaml

@@ -1,10 +0,0 @@
-language: ruby
-install: sudo apt-get install graphviz -y
-before_install: gem install bundler
-script: bundle exec rake
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - jruby-19mode
-  - rbx-2

data/Gemfile

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

data/Rakefile

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
-end
-
-desc 'Default: run all tests.'
-task :default => :spec

data/lib/state_machines/graphviz/monkeypatch.rb

@@ -1,161 +0,0 @@
-#TODO register graphviz as render engine
-module StateMachines
-  class Machine
-    class << self
-      # Draws the state machines defined in the given classes using GraphViz.
-      # The given classes must be a comma-delimited string of class names.
-      #
-      # Configuration options:
-      # * <tt>:file</tt> - A comma-delimited string of files to load that
-      #   contain the state machine definitions to draw
-      # * <tt>:path</tt> - The path to write the graph file to
-      # * <tt>:format</tt> - The image format to generate the graph in
-      # * <tt>:font</tt> - The name of the font to draw state names in
-      def draw(class_names, options = {})
-        raise ArgumentError, 'At least one class must be specified' unless class_names && class_names.split(',').any?
-
-        # Load any files
-        if files = options.delete(:file)
-          files.split(',').each { |file| require file }
-        end
-
-        class_names.split(',').each do |class_name|
-          # Navigate through the namespace structure to get to the class
-          klass = Object
-          class_name.split('::').each do |name|
-            klass = klass.const_defined?(name) ? klass.const_get(name) : klass.const_missing(name)
-          end
-
-          # Draw each of the class's state machines
-          klass.state_machines.each_value do |machine|
-            machine.draw(options)
-          end
-        end
-      end
-    end
-
-    # Draws a directed graph of the machine for visualizing the various events,
-    # states, and their transitions.
-    #
-    # This requires both the Ruby graphviz gem and the graphviz library be
-    # installed on the system.
-    #
-    # Configuration options:
-    # * <tt>:name</tt> - The name of the file to write to (without the file extension).
-    #   Default is "#{owner_class.name}_#{name}"
-    # * <tt>:path</tt> - The path to write the graph file to.  Default is the
-    #   current directory (".").
-    # * <tt>:format</tt> - The image format to generate the graph in.
-    #   Default is "png'.
-    # * <tt>:font</tt> - The name of the font to draw state names in.
-    #   Default is "Arial".
-    # * <tt>:orientation</tt> - The direction of the graph ("portrait" or
-    #   "landscape").  Default is "portrait".
-    # * <tt>:human_names</tt> - Whether to use human state / event names for
-    #   node labels on the graph instead of the internal name.  Default is false.
-    def draw(graph_options = {})
-      name = graph_options.delete(:name) || "#{owner_class.name}_#{self.name}"
-      draw_options = {:human_name => false}
-      draw_options[:human_name] = graph_options.delete(:human_names) if graph_options.include?(:human_names)
-
-      graph = Graph.new(name, graph_options)
-
-      # Add nodes / edges
-      states.by_priority.each { |state| state.draw(graph, draw_options) }
-      events.each { |event| event.draw(graph, draw_options) }
-
-      # Output result
-      graph.output
-      graph
-    end
-  end
-
-  class State
-    # Draws a representation of this state on the given machine.  This will
-    # create a new node on the graph with the following properties:
-    # * +label+ - The human-friendly description of the state.
-    # * +width+ - The width of the node.  Always 1.
-    # * +height+ - The height of the node.  Always 1.
-    # * +shape+ - The actual shape of the node.  If the state is a final
-    #   state, then "doublecircle", otherwise "ellipse".
-    #
-    # Configuration options:
-    # * <tt>:human_name</tt> - Whether to use the state's human name for the
-    #   node's label that gets drawn on the graph
-    def draw(graph, options = {})
-      node = graph.add_nodes(name ? name.to_s : 'nil',
-                             :label => description(options),
-                             :width => '1',
-                             :height => '1',
-                             :shape => final? ? 'doublecircle' : 'ellipse'
-      )
-
-      # Add open arrow for initial state
-      graph.add_edges(graph.add_nodes('starting_state', :shape => 'point'), node) if initial?
-
-      true
-    end
-  end
-
-  class Event
-    # Draws a representation of this event on the given graph.  This will
-    # create 1 or more edges on the graph for each branch (i.e. transition)
-    # configured.
-    #
-    # Configuration options:
-    # * <tt>:human_name</tt> - Whether to use the event's human name for the
-    #   node's label that gets drawn on the graph
-    def draw(graph, options = {})
-      valid_states = machine.states.by_priority.map {|state| state.name}
-      branches.each do |branch|
-        branch.draw(graph, options[:human_name] ? human_name : name, valid_states)
-      end
-
-      true
-    end
-  end
-
-  class Branch
-    # Draws a representation of this branch on the given graph.  This will draw
-    # an edge between every state this branch matches *from* to either the
-    # configured to state or, if none specified, then a loopback to the from
-    # state.
-    #
-    # For example, if the following from states are configured:
-    # * +idling+
-    # * +first_gear+
-    # * +backing_up+
-    #
-    # ...and the to state is +parked+, then the following edges will be created:
-    # * +idling+      -> +parked+
-    # * +first_gear+  -> +parked+
-    # * +backing_up+  -> +parked+
-    #
-    # Each edge will be labeled with the name of the event that would cause the
-    # transition.
-    def draw(graph, event, valid_states)
-      state_requirements.each do |state_requirement|
-        # From states determined based on the known valid states
-        from_states = state_requirement[:from].filter(valid_states)
-
-        # If a to state is not specified, then it's a loopback and each from
-        # state maps back to itself
-        if state_requirement[:to].values.empty?
-          loopback = true
-        else
-          to_state = state_requirement[:to].values.first
-          to_state = to_state ? to_state.to_s : 'nil'
-          loopback = false
-        end
-
-        # Generate an edge between each from and to state
-        from_states.each do |from_state|
-          from_state = from_state ? from_state.to_s : 'nil'
-          graph.add_edges(from_state, loopback ? from_state : to_state, :label => event.to_s)
-        end
-      end
-
-      true
-    end
-  end
-end

data/spec/graph_spec.rb

@@ -1,92 +0,0 @@
-require 'spec_helper'
-describe StateMachines::Graph do
-  context 'GraphDefault' do
-    before(:each) do
-      @graph = StateMachines::Graph.new('test')
-    end
-
-    it 'should_have_a_default_font' do
-      expect('Arial').to eq(@graph.font)
-    end
-
-    it 'should_use_current_directory_for_filepath' do
-      expect('doc/state_machines/test.png').to eq(@graph.file_path)
-    end
-
-    it 'should_have_a_default_file_format' do
-      expect('png').to eq(@graph.file_format)
-    end
-
-    it 'should_have_a_default_orientation' do
-      expect('TB').to eq(@graph[:rankdir].source)
-    end
-  end
-
-  context 'GraphNodes' do
-    before(:each) do
-      @graph = StateMachines::Graph.new('test')
-      @node = @graph.add_nodes('parked', :shape => 'ellipse')
-    end
-
-    it 'should_return_generated_node' do
-      expect(@node).to_not be_nil
-    end
-
-    it 'should_use_specified_name' do
-      expect(@node).to eq(@graph.get_node('parked'))
-    end
-
-    it 'should_use_specified_options' do
-      expect('ellipse').to eq(@node['shape'].to_s.gsub('"', ''))
-    end
-
-    it 'should_set_default_font' do
-      expect('Arial').to eq(@node['fontname'].to_s.gsub('"', ''))
-    end
-  end
-
-  context 'GraphEdges' do
-    before(:each) do
-      @graph = StateMachines::Graph.new('test')
-      @graph.add_nodes('parked', :shape => 'ellipse')
-      @graph.add_nodes('idling', :shape => 'ellipse')
-      @edge = @graph.add_edges('parked', 'idling', :label => 'ignite')
-    end
-
-    it 'should_return_generated_edge' do
-      expect(@edge).to_not be_nil
-    end
-
-    it 'should_use_specified_nodes' do
-      expect('parked').to eq(@edge.node_one(false))
-      expect('idling').to eq(@edge.node_two(false))
-    end
-
-    it 'should_use_specified_options' do
-      expect('ignite').to eq(@edge['label'].to_s.gsub('"', ''))
-    end
-
-    it 'should_set_default_font' do
-      expect('Arial').to eq(@edge['fontname'].to_s.gsub('"', ''))
-    end
-  end
-
-  context 'GraphOutput' do
-    before(:each) do
-      @graph_name = "test_#{rand(1000000)}"
-      @graph = StateMachines::Graph.new(@graph_name)
-      @graph.add_nodes('parked', :shape => 'ellipse')
-      @graph.add_nodes('idling', :shape => 'ellipse')
-      @graph.add_edges('parked', 'idling', :label => 'ignite')
-      @graph.output
-    end
-
-    it 'should_save_file' do
-      expect(File.exist?("doc/state_machines/#{@graph_name}.png")).to be_truthy
-    end
-
-    after(:each) do
-      FileUtils.rm Dir["doc/state_machines/#{@graph_name}.png"]
-    end
-  end
-end