stateful_enum 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e93fa3aad64f0c66c8d1e5a14993b0176c269274
-  data.tar.gz: 0712a38f75019a9ee82e8a121e8d6d509aa208f4
+  metadata.gz: a1388d189d8fe2a3c7f30a3b765526823295ef8a
+  data.tar.gz: c672208f53cdd2b07ec8c7e3d03f9c284e915d62
 SHA512:
-  metadata.gz: f54ad2ee66dc272f0f0c6594c847b5df6e70deb7f6e851e570f8442a1e8ae9c7301a512389c3fec15f188fe3fb26f73e971029d004f83d9b1489e8ab8899debc
-  data.tar.gz: c734c80ccf99dd5c077f643c9769369b1937fc7a8141fb48db674cae5d5e149b53fb618c4cd1db088aecf1bf92743a7a45f51e7d02ed805647bc41f93354a094
+  metadata.gz: 6110d07106f0590e8651bc0c1b91f5e7e72d1ba30063ddb67a2a151405cc2b3c9aaa08153516b8115fbc7e82e59a20a140cb3a112307295246a08aea43f1238f
+  data.tar.gz: af06537cecafe02ce03d1744f202ece3d3039be662f5d7a726277350d64e51ca41b5d907b13c01da43b3d52e2fc71eba91b02420b6eaf7d16544f1d00b08fdfe

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+gemfiles/*.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -1,4 +1,22 @@
 language: ruby
+
+cache:
+  - bundler
+
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.11.2
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+
+gemfile:
+  - gemfiles/Gemfile-rails.4.1.x
+  - gemfiles/Gemfile-rails.4.2.x
+  - gemfiles/Gemfile-rails.5.0.0.beta3
+
+before_install:
+ - sudo apt-get install graphviz
+ - gem install bundler -v 1.11.2
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -1,4 +1,4 @@
-# StatefulEnum
+# StatefulEnum [![Build Status](https://travis-ci.org/amatsuda/stateful_enum.svg?branch=master)](https://travis-ci.org/amatsuda/stateful_enum)
 
 stateful_enum is a state machine gem built on top of ActiveRecord's built-in ActiveRecord::Enum.
 
@@ -18,7 +18,7 @@ And bundle.
 
 ### You Ain't Gonna Need Abstraction
 
-stateful_enum depends on ActiveRecord. If you prefer a well-abstracted state machine library that supports multiple datastores, or Plain Old Ruby Objects (who needs that feature?), I'm sorry but this gem is not for you.
+stateful_enum depends on ActiveRecord. If you prefer a "well-abstracted" state machine library that supports multiple datastores, or Plain Old Ruby Objects (who needs that feature?), I'm sorry but this gem is not for you.
 
 ### I Hate Saving States in a VARCHAR Column
 
@@ -77,7 +77,7 @@ You can declare events through `event` method inside of an `enum` block. Then st
 **An instance method to fire the event**
 
 ```ruby
-@bug.assign  # does nothing if a valid transition for the current state is not defined
+@bug.assign  # does nothing and returns false if a valid transition for the current state is not defined
 ```
 
 **An instance method with `!` to fire the event**
@@ -117,11 +117,20 @@ event :assign do
 end
 ```
 
-### Event hooks
+### Event Hooks
 
 You can define `before` and `after` event hooks inside of an `event` block.
 
 
+## Generating State Machine Diagrams
+
+stateful_enum includes a Rails generator that generates a state machine diagram.
+Note that you need to bundle the ruby-graphviz gem (and its dependencies) for the development env in order to run the generator.
+
+```bash
+% rails g stateful_enum:graph bug
+```
+
 ## TODO
 
 * Better Error handling

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require 'yaml'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -8,3 +9,11 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+namespace :test do
+  task :all do
+    YAML.load(File.read(File.expand_path('.travis.yml')))['gemfile'].each do |gemfile|
+      sh "BUNDLE_GEMFILE='#{gemfile}' bundle exec rake test"
+    end
+  end
+end

data/gemfiles/Gemfile-rails.4.1.x

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'stateful_enum', path: '..'
+
+gem 'rails', '~> 4.1.0'
+gem 'sqlite3'
+gem 'minitest', '~> 5.0'
+gem 'ruby-graphviz'

data/gemfiles/Gemfile-rails.4.2.x

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'stateful_enum', path: '..'
+
+gem 'rails', '~> 4.2.0'
+gem 'sqlite3'
+gem 'minitest', '~> 5.0'
+gem 'ruby-graphviz'

data/gemfiles/Gemfile-rails.5.0.0.beta3

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'stateful_enum', path: '..'
+
+gem 'rails', '~> 5.0.0.beta3'
+gem 'sqlite3'
+gem 'minitest', '~> 5.0'
+gem 'ruby-graphviz'

data/lib/generators/stateful_enum/graph_generator.rb

@@ -0,0 +1,66 @@
+require 'rails/generators/named_base'
+
+module StatefulEnum
+  module Generators
+    class GraphGenerator < ::Rails::Generators::NamedBase
+      desc 'Draws a state machine diagram'
+      def draw
+        require 'graphviz'
+        StatefulEnum::Machine.prepend StatefulEnum::Graph
+        class_name.constantize
+      end
+    end
+  end
+
+  module Graph
+    def initialize(model, _column, states, prefix, suffix, &block)
+      super
+      GraphDrawer.new model, states, @prefix, @suffix, &block if block
+    end
+
+    class GraphDrawer
+      def initialize(model, states, prefix, suffix, &block)
+        @states, @prefix, @suffix = states, prefix, suffix
+        @g = ::GraphViz.new 'G', rankdir: 'TB'
+
+        states.each do |state|
+          @g.add_node state.to_s, label: state.to_s, width: '1', height: '1', shape: 'ellipse'
+        end
+        @g.add_edge @g.add_node('start state', shape: 'point'), @g.get_node_at_index(0)
+
+        instance_eval(&block)
+
+        (@g.each_edge.map {|e| e.node_two }.uniq - @g.each_edge.map {|e| e.node_one }.uniq).each do |final|
+          @g.get_node(final) {|n| n['shape'] = 'doublecircle' }
+        end
+
+        @g.output png: "#{model.name}.png"
+      end
+
+      def event(name, &block)
+        EventDrawer.new @g, @states, @prefix, @suffix, name, &block
+      end
+    end
+
+    class EventDrawer < ::StatefulEnum::Machine::Event
+      def initialize(g, states, prefix, suffix, name, &block)
+        @g, @states, @prefix, @suffix, @name = g, states, prefix, suffix, name
+
+        instance_eval(&block) if block
+      end
+
+      def transition(transitions, options = {})
+        if options.blank?
+          transitions.delete :if
+          transitions.delete :unless
+        end
+
+        transitions.each_pair do |from, to|
+          Array(from).each do |f|
+            @g.add_edge f.to_s, to.to_s, label: "#{@prefix}#{@name}#{@suffix}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stateful_enum/active_record_extension.rb

@@ -8,12 +8,13 @@ module StatefulEnum
     #     end
     #   end
     def enum(definitions, &block)
+      prefix, suffix = definitions[:_prefix], definitions[:_suffix] if Rails::VERSION::STRING >= '5'
       enum = super definitions
 
       if block
         definitions.each_key do |column|
           states = enum[column]
-          StatefulEnum::Machine.new self, column, (states.is_a?(Hash) ? states.keys : states), &block
+          StatefulEnum::Machine.new self, column, (states.is_a?(Hash) ? states.keys : states), prefix, suffix, &block
         end
       end
     end

data/lib/stateful_enum/machine.rb

@@ -1,58 +1,77 @@
 module StatefulEnum
   class Machine
-    def initialize(model, column, states, &block)
+    def initialize(model, column, states, prefix, suffix, &block)
       @model, @column, @states, @event_names = model, column, states, []
+      @prefix = if prefix == true
+                  "#{column}_"
+                elsif prefix
+                  "#{prefix}_"
+                end
+      @suffix = if suffix == true
+                  "_#{column}"
+                elsif suffix
+                  "_#{suffix}"
+                end
 
       # undef non-verb methods e.g. Model#active!
       states.each do |state|
-        @model.send :undef_method, "#{state}!"
+        @model.send :undef_method, "#{@prefix}#{state}#{@suffix}!"
       end
 
       instance_eval(&block) if block
     end
 
     def event(name, &block)
-      raise "event: :#{name} has already been defined." if @event_names.include? name
-      Event.new @model, @column, @states, name, &block
+      raise ArgumentError, "event: :#{name} has already been defined." if @event_names.include? name
+      Event.new @model, @column, @states, @prefix, @suffix, name, &block
       @event_names << name
     end
 
     class Event
-      def initialize(model, column, states, name, &block)
-        @model, @column, @states, @name, @transitions = model, column, states, name, {}
+      def initialize(model, column, states, prefix, suffix, name, &block)
+        @states, @name, @transitions, @before, @after = states, name, {}, nil, nil
 
         instance_eval(&block) if block
 
-        define_transition_methods
-      end
-
-      def define_transition_methods
-        column, name, transitions, before, after = @column, @name, @transitions, @before, @after
+        transitions, before, after = @transitions, @before, @after
+        new_method_name = "#{prefix}#{name}#{suffix}"
 
-        @model.send(:define_method, name) do
-          to, condition = transitions[self.send(column).to_sym]
-          #TODO better error
-          if to && (!condition || instance_exec(&condition))
-            #TODO transaction?
-            instance_eval(&before) if before
-            ret = self.class.instance_variable_get(:@_enum_methods_module).instance_method("#{to}!").bind(self).call
-            instance_eval(&after) if after
-            ret
-          else
-            false
+        # defining event methods
+        model.class_eval do
+          # def assign()
+          detect_enum_conflict! column, new_method_name
+          define_method new_method_name do
+            to, condition = transitions[self.send(column).to_sym]
+            #TODO better error
+            if to && (!condition || instance_exec(&condition))
+              #TODO transaction?
+              instance_eval(&before) if before
+              original_method = self.class.send(:_enum_methods_module).instance_method "#{prefix}#{to}#{suffix}!"
+              ret = original_method.bind(self).call
+              instance_eval(&after) if after
+              ret
+            else
+              false
+            end
           end
-        end
 
-        @model.send(:define_method, "#{name}!") do
-          send(name) || raise('Invalid transition')
-        end
+          # def assign!()
+          detect_enum_conflict! column, "#{new_method_name}!"
+          define_method "#{new_method_name}!" do
+            send(new_method_name) || raise('Invalid transition')
+          end
 
-        @model.send(:define_method, "can_#{name}?") do
-          transitions.has_key? self.send(column).to_sym
-        end
+          # def can_assign?()
+          detect_enum_conflict! column, "can_#{new_method_name}?"
+          define_method "can_#{new_method_name}?" do
+            transitions.has_key? self.send(column).to_sym
+          end
 
-        @model.send(:define_method, "#{name}_transition") do
-          transitions[self.send(column).to_sym].try! :first
+          # def assign_transition()
+          detect_enum_conflict! column, "#{new_method_name}_transition"
+          define_method "#{new_method_name}_transition" do
+            transitions[self.send(column).to_sym].try! :first
+          end
         end
       end
 
@@ -68,6 +87,7 @@ module StatefulEnum
           raise "Undefined state #{to}" unless @states.include? to
           Array(from).each do |f|
             raise "Undefined state #{f}" unless @states.include? f
+            raise "Duplicate entry: Transition from #{f} to #{@transitions[f].first} has already been defined." if @transitions[f]
             @transitions[f] = [to, options[:if]]
           end
         end

data/lib/stateful_enum/version.rb

@@ -1,3 +1,3 @@
 module StatefulEnum
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stateful_enum
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/Gemfile-rails.4.1.x
+- gemfiles/Gemfile-rails.4.2.x
+- gemfiles/Gemfile-rails.5.0.0.beta3
+- lib/generators/stateful_enum/graph_generator.rb
 - lib/stateful_enum.rb
 - lib/stateful_enum/active_record_extension.rb
 - lib/stateful_enum/machine.rb