nxt_state_machine 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37f01d32a03c0c09b47018719f8b05b2439497034807ad0e6fa098a6d7d832ed
-  data.tar.gz: '02682339637194f92d32240b759e51cab84cd590a789af74c66109e27d5ce912'
+  metadata.gz: 89b1ad3a07fcc60e4b3541b770f1e1f287713e973d3a038f3496be0a145006c5
+  data.tar.gz: f213f914ffe2ff39a0d90d8c61f574857b312c9065e1241e9e09dce16cf6cc3a
 SHA512:
-  metadata.gz: e777bbfeffb013b7591d0d2e18169a7311d324aefe7ad2a97f181b53926f6d6aa0f2a3cd08728ca1e544ac21b5ca5893ae4479c39ff93e54ac083a0b8399cdb5
-  data.tar.gz: 53ff5dd521de00050a1fe553c7dfd560f1cc8fde10e8cfc1cdea571873b22f4ac3be103ec1863314b64da0a04d95244a19f655e41794395dbcc4b8708f720a8e
+  metadata.gz: 48b17f521db0a19ccc500fff321b459f4e962875792e047923185a45691c20b81bfec5bbab03b77cf6eaeb10be2b8191ec73bfbc4d4b05c9e518389b1d9cc497
+  data.tar.gz: 286382b6dd9512abc0a0b1c1f177196edab5aced50bc8888d0febf4a58a86697ac152b8a7617c238f3268cbbada15f9767248b333264cf1608421d6a9b9c2b93

data/.circleci/config.yml

@@ -16,11 +16,17 @@ jobs:
     steps:
       - checkout
 
+      - run:
+          name: Install apt dependencies
+          command: |
+            sudo apt update -q \
+            && sudo apt upgrade -q \
+            && sudo apt install -qq graphviz
       # Download and cache dependencies
       - restore_cache:
           keys:
             - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            
+
       - run: gem install bundler --version $BUNDLER_VERSION
 
       - run:
@@ -53,4 +59,4 @@ jobs:
           path: /tmp/test-results
       - store_artifacts:
           path: /tmp/test-results
-          destination: test-results
+          destination: test-results

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# v0.1.8 2020-0-05
+
+### Added
+
+- [internal] Allow to draw state machine graph with rake task 
+
+[Compare v0.1.7...v0.1.8](https://github.com/nxt-insurance/nxt_state_machine/compare/v0.1.7...v0.1.8)

data/Gemfile.lock

@@ -1,37 +1,38 @@
 PATH
   remote: .
   specs:
-    nxt_state_machine (0.1.7)
+    nxt_state_machine (0.1.8)
       activesupport
       nxt_registry (~> 0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activesupport (6.0.2.2)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     coderay (1.1.2)
     concurrent-ruby (1.1.6)
     diff-lcs (1.3)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.0)
+    minitest (5.14.1)
     nxt_registry (0.1.5)
       activesupport
-    pry (0.13.0)
+    pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (12.3.3)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -47,9 +48,11 @@ GEM
     rspec-support (3.9.0)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
+    ruby-graphviz (1.2.5)
+      rexml
     sqlite3 (1.4.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     zeitwerk (2.3.0)
 
@@ -64,6 +67,7 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
   rspec_junit_formatter
+  ruby-graphviz
   sqlite3
 
 BUNDLED WITH

data/README.md

@@ -393,14 +393,6 @@ class Article < ApplicationRecord
 end
 ``` 
 
-
-## TODO
-- Decide on how to include state methods in model classes
-- Should we clone machines for each context?
-- What about inheritance? => What would be the expected behaviour? (dup vs. no dup)
-    => Might also make sense to walk the ancestors chain and collect configure blocks
-
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/nxt_state_machine.rb

@@ -31,6 +31,7 @@ require "nxt_state_machine/state_machine"
 require "nxt_state_machine/integrations/active_record"
 require "nxt_state_machine/integrations/attr_accessor"
 require "nxt_state_machine/integrations/hash"
+require "nxt_state_machine/graph"
 
 module NxtStateMachine
   module ClassMethods

data/lib/nxt_state_machine/event.rb

@@ -41,6 +41,10 @@ module NxtStateMachine
       event_transitions.resolve!(state).present?
     end
 
+    def to_s
+      "#{self.class.name}[:#{name}]"
+    end
+
     private
 
     def configure(&block)

data/lib/nxt_state_machine/graph.rb

@@ -0,0 +1,77 @@
+module NxtStateMachine
+  class Graph
+    def initialize(state_machines, **options)
+      @state_machines = state_machines
+      @options = default_options.merge(**options)
+    end
+
+    def draw
+      require 'ruby-graphviz'
+
+      state_machines.each do |_, state_machine|
+        add_nodes(state_machine)
+        add_edges(state_machine)
+      end
+
+      filename = File.join(options[:path], "#{options[:name]}.#{options[:format]}")
+
+      graph.output options[:format] => filename
+
+      puts '----------------------------------------------'
+      puts 'Please run the following to open the generated file:'
+      puts "open '#{filename}'"
+      puts '----------------------------------------------'
+
+      graph
+    end
+
+    private
+
+    attr_reader :options, :state_machines
+
+    def graph
+      @graph ||= ::GraphViz.new(
+        'G',
+        rankdir: options[:orientation] == 'landscape' ? 'LR' : 'TB',
+        ratio: options[:ratio]
+      )
+    end
+
+    def add_nodes(state_machine)
+      binding.pry
+      state_machine.states.values.each do |state|
+        add_node(state)
+      end
+    end
+
+    def add_node(state)
+      node_options = {
+        label: state.to_s,
+        width: '1',
+        height: '1',
+        shape: 'ellipse'
+      }
+
+      graph.add_nodes(state.to_s, node_options)
+    end
+
+    def add_edges(state_machine)
+      state_machine.events.values.each do |event|
+        event.event_transitions.values.each do |transition|
+          graph.add_edges(transition.from.to_s, transition.to.to_s, label: event.name)
+        end
+      end
+    end
+
+    def default_options
+      {
+        name: 'state_machine',
+        path: '.',
+        orientation: 'landscape',
+        ratio: 'fill',
+        format: 'png',
+        font: 'Helvetica'
+      }
+    end
+  end
+end

data/lib/nxt_state_machine/state_machine.rb

@@ -15,7 +15,7 @@ module NxtStateMachine
       @initial_state = nil
     end
 
-    attr_reader :class_context, :transitions, :events, :options, :callbacks, :name, :error_callback_registry, :defuse_registry
+    attr_reader :class_context, :events, :options, :callbacks, :name, :error_callback_registry, :defuse_registry
     attr_accessor :initial_state
 
     def get_state_with(method = nil, &block)
@@ -90,6 +90,7 @@ module NxtStateMachine
         class_context.define_method event_name do |*args, **opts|
           event.state_machine.can_transition!(name, event.state_machine.current_state_name(self))
           transition = event.event_transitions.resolve(event.state_machine.current_state_name(self))
+          # Transition is build every time and thus should be thread safe!
           transition.build_transition(event_name, self, set_state_method, *args, **opts)
         end
       end

data/lib/nxt_state_machine/version.rb

@@ -1,3 +1,3 @@
 module NxtStateMachine
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/railtie.rb

@@ -0,0 +1,8 @@
+class Railtie < Rails::Railtie
+  railtie_name :nxt_state_machine
+
+  rake_tasks do
+    path = File.expand_path(__dir__)
+    Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+  end
+end

data/lib/tasks/draw_graph.rake

@@ -0,0 +1,8 @@
+namespace :graph do
+  desc 'draw the graph of a state machine'
+  task :draw, [:state_machine_class] => [:environment] do |_, args|
+    state_machine_class = Object.const_get(args.fetch(:state_machine_class))
+    state_machine = state_machine_class.state_machine
+    NxtStateMachine::Graph.new(state_machine).draw
+  end
+end

data/nxt_state_machine.gemspec

@@ -43,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "ruby-graphviz"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -125,6 +125,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A state machine library that can be used with ActiveRecord or in plain
   ruby and should be easy to customize for other integrations
 email:
@@ -139,6 +153,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -166,6 +181,7 @@ files:
 - lib/nxt_state_machine/event.rb
 - lib/nxt_state_machine/event/names.rb
 - lib/nxt_state_machine/event_registry.rb
+- lib/nxt_state_machine/graph.rb
 - lib/nxt_state_machine/integrations/active_record.rb
 - lib/nxt_state_machine/integrations/attr_accessor.rb
 - lib/nxt_state_machine/integrations/hash.rb
@@ -179,7 +195,10 @@ files:
 - lib/nxt_state_machine/transition/proxy.rb
 - lib/nxt_state_machine/transition/store.rb
 - lib/nxt_state_machine/version.rb
+- lib/railtie.rb
+- lib/tasks/draw_graph.rake
 - nxt_state_machine.gemspec
+- state_machine.png
 homepage: https://github.com/nxt-insurance/nxt_state_machine
 licenses:
 - MIT