transitionable 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 933fdeae6a75c7c493a085742ae3beae2743a188
-  data.tar.gz: 12a92da1cdf7e2d9e55bdcbb0f1922f88036a9c0
+  metadata.gz: 952f7bc9e470346c073f9e6ea3a57dfe99cdd95c
+  data.tar.gz: c3160957e7b0ab4084c17ca8df4e23eb2ab53717
 SHA512:
-  metadata.gz: aa9d445044fb373bd20ac7bc2e65c0a3cf2a3d1200e3c51c4b4b44acd5dd001e5f160c37f3fc03e4b591271f43faaee7cf3b9dd2a6f617dd6a381a15204d73a3
-  data.tar.gz: 1a064aef3e18dc2632c145d39abd84908b29e5ac53137c51d804eba47cb42d26fecd53504c3aca754ca2a2c50595232e1c9ba1dda02d660d0296accef059c2c0
+  metadata.gz: 8179578162e736f2a85b4a24d0e8ad7f5d8b7662b0f4581ed8cf5cf962111d262e103d4867403a829e0aa5781fbdc5bbbc724f6f896c1cd06db1a68fb477fa39
+  data.tar.gz: 9dba3437433e2ffd449623790055c8427d3a343d6cc99bc0bfd1854ca13a6e2cb558fbacf567e685e137421def9f140328e952d3d6c63a2e09a598bce2fe460f

data/Gemfile.lock

@@ -1,22 +1,27 @@
 PATH
   remote: .
   specs:
-    transitionable (0.1.1)
+    transitionable (0.2.0)
       activesupport (~> 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    i18n (1.0.1)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
     minitest (5.11.3)
+    pry (0.12.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -40,6 +45,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  pry
   rake (~> 10.0)
   rspec (~> 3.7)
   transitionable!

data/README.md

@@ -2,6 +2,8 @@
 
 A convention-based state machine that complements your models without stealing the show.
 
+Multiple state machines are supported.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,10 +18,12 @@ And then execute:
 
 ## Usage
 
+### Single state machine in model
+
 ```ruby
 class Event
 
-  # Requires including class to define the following constants BEFORE including this module:
+  # By default, Transitionable assumes including class defines the following constants BEFORE including this module:
   #
   #  * STATES
   #  * TRANSITIONS
@@ -61,6 +65,63 @@ event.validate_transition!(target_state: 'new_state')
 # => returns true or raises Transitionable::InvalidStateTransition exception
 ```
 
+### Multiple state machines in model
+
+```ruby
+class Event
+
+  DELIVERY_STATES = {
+    STAGED:    'staged',
+    STARTED:   'started',
+    COMPLETED: 'completed'
+  }.freeze
+
+  PREP_STATES = {
+    COOKING: 'cooking',
+    COOKED:  'cooked'
+  }.freeze
+
+  DELIVERY_TRANSITIONS = [
+    { from: DELIVERY_STATES[:STAGED], to: DELIVERY_STATES[:STARTED] },
+    { from: DELIVERY_STATES[:STARTED], to: DELIVERY_STATES[:COMPLETED] }
+  ].freeze
+
+  PREP_TRANSITIONS = [
+    { from: PREP_STATES[:COOKING], to: PREP_STATES[:COOKED] }
+  ]
+
+  include Transitionable
+
+  transition :delivery_state, DELIVERY_STATES, DELIVERY_TRANSITIONS
+  transition :prep_state, PREP_STATES, PREP_TRANSITIONS
+
+end
+```
+
+Provides the following helpers
+
+```ruby
+event.staged?
+event.started?
+event.completed?
+event.cooking?
+event.cooked?
+```
+
+Provides 2 validation methods
+
+```ruby
+event.validate_transition(target_state: 'new_state')
+# => returns true or false
+
+event.validate_transition!(target_state: 'new_state')
+# => returns true or raises Transitionable::InvalidStateTransition exception
+```
+
+#### Important assumptions with multiple state machines:
+* Each state must be unique across all state machines in the model. Otherwise, `InvalidStateTransition` exception will thrown as Transitionable attempts to define the same helper method multiple times.
+* For the same reason, `"#{state}?"` must not be defined in your model for each of your state.
+
 ## 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/lib/transitionable/version.rb

@@ -1,3 +1,3 @@
 module Transitionable
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/transitionable.rb

@@ -8,39 +8,56 @@ module Transitionable
 
   class InvalidStateTransition < StandardError
     def initialize(from_state, to_state)
-      msg = "Can't transition from #{from_state} to #{to_state}."
+      msg = from_state ?
+        "Can't transition from #{from_state} to #{to_state}." :
+        "Can't transition to #{to_state}."
       super(msg)
     end
   end
 
   module ClassMethods
-    attr_accessor :trans_column
-
-    def transition(column)
-      self.trans_column = column
-      self::STATES.values.each do |this_state|
+    attr_accessor :state_machines
+
+    # This assumes states is a hash
+    def transition(name, states = self::STATES, transitions = self::TRANSITIONS)
+      self.state_machines ||= {}
+      self.state_machines[name] = { states: states.values, transitions: transitions }
+      self.state_machines[name][:states].each do |this_state|
+        raise 'Method already defined' if self.new.respond_to? this_state
         define_method "#{this_state}?" do
-          transitionable_state == this_state
+          current_state_based_on(this_state) == this_state
         end
       end
     end
   end
 
-  def transitionable_state
-    self.send(self.class.trans_column)
-  end
-
   def validate_transition!(target_state:)
+    current_state = current_state_based_on(target_state)
     unless validate_transition(target_state: target_state)
-      raise InvalidStateTransition.new(transitionable_state, target_state)
+      raise InvalidStateTransition.new(current_state, target_state)
     end
     true
   end
 
   def validate_transition(target_state:)
-    self.class::TRANSITIONS.detect do |transition|
-      transition[:from] == transitionable_state && transition[:to] == target_state
-    end.present? ? true : false
+    self.class.state_machines.each do |machine_name, machine|
+      next unless machine[:states].include?(target_state)
+      current_state = send(machine_name)
+      matched_transition = machine[:transitions].detect do |transition|
+        transition[:from] == current_state && transition[:to] == target_state
+      end
+      return matched_transition.present?
+    end
+    raise InvalidStateTransition.new(nil, target_state)
+  end
+
+  private
+
+  def current_state_based_on(target_state)
+    self.class.state_machines.each do |machine_name, machine|
+      return send(machine_name) if machine[:states].include?(target_state)
+    end
+    raise InvalidStateTransition.new(nil, target_state)
   end
 
 end

data/transitionable.gemspec

@@ -35,5 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency 'pry'
   spec.add_dependency "activesupport", "~>5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transitionable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - zino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-02 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement