interstate_machine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffa91c86831fa5b11b22c705b710b42a33a0e8b2
+  data.tar.gz: bc7349ab2a864157ee0c03ff7f5ac8fb4a4cf3a2
+SHA512:
+  metadata.gz: e656466c3918cf7ab0cba559dccb8238ebf03d864970666532511c70a2c2dcadd1fd07b62f0616a6bd8d111e9b8aefba533b421db23d1060ca31e627566a875a
+  data.tar.gz: b9c00fdebd2851d3fbfffe5eca3fc64770a46e75836505e8c18e679b0c77d4aea6f91753fbb6a999843598f9cff2499235471fc0102813fffbb2010637f80b4e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/examples/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 SamuelMartini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# InterstateMachine
+When state machine meets interactor. InterstateMachine is a simple state machine which use interactors to trigger transitions. Long story short, an object receives an event which is a interactor and you can do fantastic things with interactors.
+What is an interactor?
+[*"An interactor is a simple, single-purpose object."*](https://github.com/collectiveidea/interactor)
+
+## Installation
+```ruby
+gem install interstate_machine
+```
+
+Gemfile
+```ruby
+gem 'interstate_machine', '~> 1.0.0'
+```
+
+## Usage
+```ruby
+class TrafficLight < ActiveRecord::Base
+  include InterstateMachine
+
+  initial_state :stop
+
+  transition_table :stop, :proceed, :caution, :tilt, :broken do
+    on event: :cycle do |event|
+      allow event: event, transition_to: [:proceed], from: [:stop]
+      allow event: event, transition_to: [:caution], from: [:proceed]
+      allow event: event, transition_to: [:stop], from: [:caution]
+    end
+    on event: :tilt, transition_to: [:broken], from: [:proceed, :caution, :stop]
+    on event: :repair, transition_to: [:stop], from: [:broken]
+  end
+end
+```
+If you want to use `InterstateMachine` in plain ruby, add `attr_accessor :state` to store the state.
+`transition_table` is where the state machine rules and states are defined.
+Each event represent an `Interactor` that is called to process the transition.
+
+`on` can take a block which defines different transition(rules) for the same event or a single transition
+
+In addition to the class where you define the state machine, you also need to create interactors for each event.
+
+In this case we have an event `cycle` that trigger many transitions so we define three interactors for the `cycle` event and two for the remaining.
+`CycleProceed`, `CycleCaution`, `CycleStop` and then `Tilt` and `Repair`. Yes, when an event triggers a transition to a single state and it's not a block, you have to name the class like the event name.
+
+```ruby
+class CycleProceed
+  include Interactor
+
+  before :validate_transition
+
+  def call
+    # do stuff needed when this state happen
+    'yeah'
+  end
+
+  private
+
+  def validate_transition
+    context.fail!(error: 'there is no power') if context.object.power == 0
+  end
+end
+```
+Note: You can use all the magics like [hooks](https://github.com/collectiveidea/interactor). Whoop!
+
+You can access the class where you have included InterstateMachine by `context.object`
+
+When transition is allowed:
+```ruby
+t = TrafficLight.new
+t.cycle
+#=> :proceed
+```
+
+When transition can't happen because something wrong executing the event
+
+```ruby
+t.power = 0
+t.cycle
+#=> 'there is no power'
+t.state
+#=> :stop
+```
+
+When transition is no allowed
+```ruby
+t.state
+#=> :stop
+t.repair
+#=> RuntimeError Exception:
+```
+## Contributing
+Feel free to play around, fork, add, pull request, and get a hug. If you decide to pull request please add tests

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/interstate_machine.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interstate_machine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interstate_machine"
+  spec.version       = InterstateMachine::VERSION
+  spec.authors       = ["SamuelMartini"]
+  spec.email         = ["samueljmartini@gmail.com"]
+
+  spec.summary       = 'a state machine with interactor implementation'
+  spec.description   = 'InterstateMachine is a simple state machine which use interactors to trigger transitions'
+  spec.homepage      = 'https://github.com/SamuelMartini/interstate_machine'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "interactor", "~> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency 'byebug', "~> 9.1"
+  spec.add_development_dependency 'activerecord', "~> 5.1"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency 'simplecov', "~> 0.15"
+end

data/lib/interstate_machine/active_record_class/instance_methods.rb

@@ -0,0 +1,11 @@
+module InterstateMachine
+  module ActiveRecordClass
+    module InstanceMethods
+      def self.included(base)
+        base.after_initialize do |_record|
+          @state_machine = StateMachine.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/interstate_machine/base/instance_methods.rb

@@ -0,0 +1,51 @@
+module InterstateMachine
+  module Base
+    module InstanceMethods
+
+      def states
+        state_machine.states
+      end
+
+      private
+
+      def evaluate_transition(event, transition_to, from)
+        if event_with_multiple_state_transition?(event, transition_to, from)
+          send("#{event}_#{state}")
+        elsif event_with_single_state_transition?(event, transition_to, from)
+          ensure_can_transit(event, transition_to, from)
+        else
+          raise "cannot transition via #{event} from #{state}"
+        end
+      end
+
+      def ensure_can_transit(event, transition_to, from, multiple: false)
+        @state_machine.evaluate_transition_by!(
+          Interactor::Context.new(
+            event: event, transition_to: transition_to, from: from,
+            multiple: multiple, object: self
+          )
+        )
+      end
+
+      def event_with_single_state_transition?(event, transition_to, from)
+        respond_to?(event) && transition_to && from
+      end
+
+      def event_with_multiple_state_transition?(event, _transition_to, _from)
+        respond_to?("#{event}_#{state}")
+      end
+
+      def constantize(event)
+        Object.const_get(event.to_s.split('_').collect(&:capitalize).join)
+      end
+
+      def interactor_name(event)
+        if state_machine.context.multiple
+          "#{event}_#{state_machine.next_state}"
+        else
+          event
+        end
+      end
+    end
+  end
+end

data/lib/interstate_machine/environment.rb

@@ -0,0 +1,16 @@
+module InterstateMachine
+  class Environment
+
+    def self.define(base)
+      if active_record?(base)
+        base.send(:include, ActiveRecordClass::InstanceMethods)
+      else
+        base.send(:prepend, PlainRuby::InstanceMethods)
+      end
+    end
+
+    def self.active_record?(base)
+      base.ancestors.include?(ActiveRecord::Base) rescue false
+    end
+  end
+end

data/lib/interstate_machine/plain_ruby/instance_methods.rb

@@ -0,0 +1,13 @@
+module PlainRuby
+  module InstanceMethods
+    attr_accessor :state_machine
+
+    def initialize
+      super
+      @state_machine = InterstateMachine::StateMachine.new(self)
+    end
+
+    def save
+    end
+  end
+end

data/lib/interstate_machine/state_machine.rb

@@ -0,0 +1,43 @@
+module InterstateMachine
+  class StateMachine
+    attr_reader :states, :context
+    attr_accessor :state
+
+    def initialize(object)
+      @states = object.class.machine_states
+      @state = defined_state(object)
+    end
+
+    def evaluate_transition_by!(rule)
+      @context = rule
+      raise failed_transition unless context.from.include? context.object.state.to_sym
+    end
+
+    def next_state
+      context.transition_to.first
+    end
+
+    def next
+      context.object.state = context.transition_to.first
+      context.object.save
+    end
+
+    private
+
+    def failed_transition
+      "can not transit to #{context.transition_to} from #{state} via
+        #{context.event}"
+    end
+
+    def defined_state(object)
+      # TODO  quite ugly, can be improved
+      if object.state.nil?
+        object.state = object.class.initialized_state.to_sym
+        object.save if object.respond_to?(:persisted?) && object.persisted?
+        object.state
+      else
+        object.state.to_sym
+      end
+    end
+  end
+end

data/lib/interstate_machine/version.rb

@@ -0,0 +1,3 @@
+module InterstateMachine
+  VERSION = '1.0.0'
+end

data/lib/interstate_machine.rb

@@ -0,0 +1,65 @@
+require 'interstate_machine/version'
+require 'interstate_machine/state_machine'
+require 'interstate_machine/environment'
+require 'interstate_machine/base/instance_methods'
+require 'interstate_machine/plain_ruby/instance_methods'
+
+require 'interstate_machine/active_record_class/instance_methods'
+require 'interactor'
+
+module InterstateMachine
+  def self.included(base)
+    base.class_eval do
+      Environment.define(base)
+      include Base::InstanceMethods
+      extend ClassMethods
+
+      private
+      attr_reader :state_machine
+    end
+  end
+
+  module ClassMethods
+    def initial_state(state)
+      @initialized_state = state
+    end
+
+    def initialized_state
+      @initialized_state ||= []
+    end
+
+    def machine_states
+      @machine_states ||= []
+    end
+
+    def transition_table(*states)
+      @machine_states = states
+      yield
+    end
+
+    def on(event:, transition_to: nil, from: nil)
+      yield(event) if block_given?
+      perform_transition_by(
+        event: event,
+        transition_to: transition_to,
+        from: from
+      )
+    end
+
+    def allow(event: nil, transition_to: nil, from: nil)
+      define_method "#{event}_#{from.first}" do
+        ensure_can_transit(event, transition_to, from, multiple: true)
+      end
+    end
+
+    private
+
+    def perform_transition_by(event: nil, transition_to: nil, from: nil)
+      define_method event do
+        evaluate_transition(event, transition_to, from)
+        action = constantize(interactor_name(event)).call(object: self)
+        action.success? ? @state_machine.next : action.error
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: interstate_machine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- SamuelMartini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: interactor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: InterstateMachine is a simple state machine which use interactors to
+  trigger transitions
+email:
+- samueljmartini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- interstate_machine.gemspec
+- lib/interstate_machine.rb
+- lib/interstate_machine/active_record_class/instance_methods.rb
+- lib/interstate_machine/base/instance_methods.rb
+- lib/interstate_machine/environment.rb
+- lib/interstate_machine/plain_ruby/instance_methods.rb
+- lib/interstate_machine/state_machine.rb
+- lib/interstate_machine/version.rb
+homepage: https://github.com/SamuelMartini/interstate_machine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: a state machine with interactor implementation
+test_files: []