stateful_enum 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdcc7c193f8597cec775968ecf6cfae38dfe09299d024b877b5da5fae7e5e5ca
-  data.tar.gz: 20558b138fd9df10e915e40ce6ff197b436a3fe4ce4717f935207dae21d7254e
+  metadata.gz: 6d0d82f2cf13496a059030aac0a34a998e47997bcbf6605637fa488c5363454d
+  data.tar.gz: 69fc206ccfc3d4290ad0961cac0d011e92ed1fa5421c0064bd881213d52082d5
 SHA512:
-  metadata.gz: 1f89d7a82fc8264fbd93b3bd85bb320607409fa662f7726f5b79f04b65da88ee3f080ff39a9ba8d5a2a14c128a1b52fdbf7c773ac6f9cbad8df61cff7052a9e8
-  data.tar.gz: b2bb43940cffd1be568fff1903920f569585fc3e56a257b9f9d824427ec42de5b2aeaf675faeab48404794ea8179d671dc2a661b98f379e5a7f3f679d6900121
+  metadata.gz: e3f5cec3415b7401c36acf28d5dda810d75818cc88b38a768e721757aaf508714ee0613b7926bb0b5e05832df83e6d7deadc3cc0b816eb3e7ab9a6286f6b1399
+  data.tar.gz: 6a8d8196552d59c696c42872ae3a9decb62ddef4e75b42566af8e45cd2d3887e3fe6688808ac230f3d35ba7501f4e06328a4fad93462d3e8aee4fca985da4720

data/.travis.yml

@@ -15,6 +15,9 @@ addons:
 
 matrix:
   include:
+    - rvm: 2.6.0
+      gemfile: gemfiles/Gemfile-rails.6.0.x
+
     - rvm: 2.6.0
       gemfile: gemfiles/Gemfile-rails.5.2.x
     - rvm: 2.6.0

data/README.md

@@ -122,6 +122,38 @@ end
 
 You can define `before` and `after` event hooks inside of an `event` block.
 
+### Inspecting All Defined Events And Current Possible Events
+
+You can get the list of defined events from the model class:
+
+```ruby
+Bug.stateful_enum.events
+#=> an Array of all defined StatefulEnum::Machine::Event objects
+```
+
+And you can get the list of possible event definitions from the model instance:
+
+```ruby
+Bug.new(status: :assigned).stateful_enum.possible_events
+#=> an Array of StatefulEnum::Machine::Event objects that are callable from the receiver object
+```
+
+Maybe what you really need for your app is the list of possible event "names":
+
+```ruby
+Bug.new(status: :assigned).stateful_enum.possible_event_names
+#=> [:resolve, :close]
+```
+
+You can get the list of next possible state names as well:
+
+```ruby
+Bug.new(status: :assigned).stateful_enum.possible_states
+#=> [:resolved, :closed]
+```
+
+These features would help some kind of metaprogramming over state transitions.
+
 
 ## Generating State Machine Diagrams
 

data/gemfiles/Gemfile-rails.6.0.x

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'rails', '~> 6.0.0.rc1'
+gem 'selenium-webdriver'

data/lib/generators/stateful_enum/plantuml_generator.rb

@@ -65,7 +65,6 @@ module StatefulEnum
       end
     end
 
-    class Item < Struct.new(:from, :to, :label)
-    end
+    Item = Struct.new(:from, :to, :label)
   end
 end

data/lib/stateful_enum/active_record_extension.rb

@@ -10,13 +10,13 @@ module StatefulEnum
     #     end
     #   end
     def enum(definitions, &block)
-      prefix, suffix = definitions[:_prefix], definitions[:_suffix] if Rails::VERSION::STRING >= '5'
+      prefix, suffix = definitions[:_prefix], definitions[:_suffix] if Rails::VERSION::MAJOR >= 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), prefix, suffix, &block
+          (@_defined_stateful_enums ||= []) << StatefulEnum::Machine.new(self, column, (states.is_a?(Hash) ? states.keys : states), prefix, suffix, &block)
         end
       end
     end

data/lib/stateful_enum/machine.rb

@@ -2,8 +2,10 @@
 
 module StatefulEnum
   class Machine
+    attr_reader :events
+
     def initialize(model, column, states, prefix, suffix, &block)
-      @model, @column, @states, @event_names = model, column, states, []
+      @model, @column, @states, @events = model, column, states, []
       @prefix = if prefix
         prefix == true ? "#{column}_" : "#{prefix}_"
       end
@@ -20,40 +22,41 @@ module StatefulEnum
     end
 
     def event(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
+      raise ArgumentError, "event: :#{name} has already been defined." if @events.map(&:name).include? name
+      @events << Event.new(@model, @column, @states, @prefix, @suffix, name, &block)
     end
 
     class Event
+      attr_reader :name, :value_method_name
+
       def initialize(model, column, states, prefix, suffix, name, &block)
         @states, @name, @transitions, @before, @after = states, name, {}, [], []
 
         instance_eval(&block) if block
 
         transitions, before, after = @transitions, @before, @after
-        new_method_name = "#{prefix}#{name}#{suffix}"
+        @value_method_name = value_method_name = :"#{prefix}#{name}#{suffix}"
 
         # defining event methods
         model.class_eval do
           # def assign()
-          detect_enum_conflict! column, new_method_name
+          detect_enum_conflict! column, value_method_name
 
           # defining callbacks
-          define_callbacks new_method_name
+          define_callbacks value_method_name
           before.each do |before_callback|
-            model.set_callback new_method_name, :before, before_callback
+            model.set_callback value_method_name, :before, before_callback
           end
           after.each do |after_callback|
-            model.set_callback new_method_name, :after, after_callback
+            model.set_callback value_method_name, :after, after_callback
           end
 
-          define_method new_method_name do
+          define_method value_method_name do
             to, condition = transitions[send(column).to_sym]
             #TODO better error
             if to && (!condition || instance_exec(&condition))
               #TODO transaction?
-              run_callbacks new_method_name do
+              run_callbacks value_method_name do
                 original_method = self.class.send(:_enum_methods_module).instance_method "#{prefix}#{to}#{suffix}!"
                 original_method.bind(self).call
               end
@@ -63,14 +66,14 @@ module StatefulEnum
           end
 
           # def assign!()
-          detect_enum_conflict! column, "#{new_method_name}!"
-          define_method "#{new_method_name}!" do
-            send(new_method_name) || raise('Invalid transition')
+          detect_enum_conflict! column, "#{value_method_name}!"
+          define_method "#{value_method_name}!" do
+            send(value_method_name) || raise('Invalid transition')
           end
 
           # def can_assign?()
-          detect_enum_conflict! column, "can_#{new_method_name}?"
-          define_method "can_#{new_method_name}?" do
+          detect_enum_conflict! column, "can_#{value_method_name}?"
+          define_method "can_#{value_method_name}?" do
             state = send(column).to_sym
             return false unless transitions.key? state
             _to, condition = transitions[state]
@@ -78,8 +81,8 @@ module StatefulEnum
           end
 
           # def assign_transition()
-          detect_enum_conflict! column, "#{new_method_name}_transition"
-          define_method "#{new_method_name}_transition" do
+          detect_enum_conflict! column, "#{value_method_name}_transition"
+          define_method "#{value_method_name}_transition" do
             transitions[send(column).to_sym].try! :first
           end
         end

data/lib/stateful_enum/railtie.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 require 'stateful_enum/active_record_extension'
+require 'stateful_enum/state_inspection'
 
 module StatefulEnum
   class Railtie < ::Rails::Railtie
-    ActiveSupport.on_load :active_record do
-      ::ActiveRecord::Base.extend StatefulEnum::ActiveRecordEnumExtension
+    initializer 'stateful_enum' do
+      ActiveSupport.on_load :active_record do
+        ::ActiveRecord::Base.extend StatefulEnum::ActiveRecordEnumExtension
+        ::ActiveRecord::Base.include StatefulEnum::StateInspection
+      end
     end
   end
 end

data/lib/stateful_enum/state_inspection.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'stateful_enum/machine'
+
+module StatefulEnum
+  module StateInspection
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def stateful_enum
+        @_defined_stateful_enums
+      end
+    end
+
+    def stateful_enum
+      StateInspector.new(self.class.stateful_enum, self)
+    end
+  end
+
+  class StateInspector
+    def initialize(defined_stateful_enums, model_instance)
+      @defined_stateful_enums, @model_instance = defined_stateful_enums, model_instance
+    end
+
+    # List of possible events from the current state
+    def possible_events
+      @defined_stateful_enums.flat_map {|se| se.events.select {|e| @model_instance.send("can_#{e.value_method_name}?") } }
+    end
+
+    # List of possible event names from the current state
+    def possible_event_names
+      possible_events.map(&:value_method_name)
+    end
+
+    # List of transitionable states from the current state
+    def possible_states
+      @defined_stateful_enums.flat_map do |stateful_enum|
+        col = stateful_enum.instance_variable_get :@column
+        pe = stateful_enum.events.select {|e| @model_instance.send("can_#{e.value_method_name}?") }
+        pe.flat_map {|e| e.instance_variable_get(:@transitions)[@model_instance.send(col).to_sym].first }
+      end
+    end
+  end
+end

data/lib/stateful_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StatefulEnum
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stateful_enum
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - gemfiles/Gemfile-rails.5.0.x
 - gemfiles/Gemfile-rails.5.1.x
 - gemfiles/Gemfile-rails.5.2.x
+- gemfiles/Gemfile-rails.6.0.x
 - gemfiles/Gemfile-rails.edge
 - lib/generators/stateful_enum/graph_generator.rb
 - lib/generators/stateful_enum/plantuml_generator.rb
@@ -121,6 +122,7 @@ files:
 - lib/stateful_enum/active_record_extension.rb
 - lib/stateful_enum/machine.rb
 - lib/stateful_enum/railtie.rb
+- lib/stateful_enum/state_inspection.rb
 - lib/stateful_enum/version.rb
 - stateful_enum.gemspec
 homepage: https://github.com/amatsuda/stateful_enum
@@ -142,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A state machine plugin on top of ActiveRecord::Enum