statum 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52f0fb1eba87da4ce2d080b1256d3929628c2a05
-  data.tar.gz: 10871eafd35c6dd767ec219d0f4fcdf6342d7cae
+  metadata.gz: 8faf2ca3f2b51f152887aa12e747d8089b3aef9c
+  data.tar.gz: b1312cb2bdf56cd71d32780faf14dc0699409327
 SHA512:
-  metadata.gz: 4cfe42b84a4b55fad13213eb792f5b96a19cac90f7b2236892db35fa3eb3320a2dc3be897f8e7b5f9b50576d583309383206d123889e4239e729f284a79d8386
-  data.tar.gz: d5442a1c6fb819574e3bf1ec13258868ea7f5dac6c836bfc902ce8fbbce1ecd64f6e65d59c440fe63f9b916b1b8d8096ce423599ce6c65656159b9ffef0fcb72
+  metadata.gz: f469b8e8ecad0b292ca837fdb4289d329b5b9dec87591ea8cfcb32c9f65f3eefb4baacaa423acb5734faec5a4fb04d1aa84da74525183336f7e7b5c2dc18301f
+  data.tar.gz: bfe730ae1c8ad58cc939464139480278c06ac84f9b1379a23793cf8eed5ad4e7182053618ccac0f16730edd211b801d5e1536b455a3d68ffd78cf63f57fa88ee

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -35,6 +35,9 @@ Metrics/AbcSize:
   Enabled: false
 
 # Style
+Style/MixinUsage:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: false
 
@@ -56,3 +59,7 @@ Lint/AmbiguousOperator:
 
 Lint/AmbiguousBlockAssociation:
   Enabled: false
+
+# Layout
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space

data/.travis.yml

@@ -5,4 +5,10 @@ cache: bundler
 before_install: gem install bundler
 script: bundle exec rspec
 rvm:
+  - ruby-head
+  - 2.4.2
   - 2.4.0
+  - 2.3.5
+  - 2.3.1
+  - 2.2.5
+  - 2.2.0

data/README.md

@@ -4,6 +4,16 @@
 [![Coverage Status](https://coveralls.io/repos/github/nulldef/statum/badge.svg?branch=master)](https://coveralls.io/github/nulldef/statum?branch=master&v=1)
 
  Finite state machine for your objects 
+ 
+Tested on Ruby 2.2.0 +
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic usage](#basic-usage)
+  - [Multiple state machines](#multiple-state-machines)
+  - [Hooks](#hooks)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -49,6 +59,72 @@ car.riding? # => false
 car.ride! # changes idle state to riding
 ```
 
+You can define an array of states which will be able to fire event:
+```ruby
+class Car
+  include Statum
+  
+  attr_accessor :state
+  
+  statum :state, initial: :idle do
+    state :idle
+    state :parked
+    state :riding
+    
+    event :ride, %i[idle parked] => :riding
+  end
+end
+```
+
+Also you can use `any_state` helper to say, that event can be fired from any of defined states
+```ruby
+class Car
+  include Statum
+  
+  attr_accessor :state
+  
+  statum :state, initial: :idle do
+    state :idle
+    state :parked
+    state :riding
+    
+    event :ride, any_state => :riding
+  end
+end
+```
+
+### Multiple state machines
+You can define more than one state machine on your object.
+
+**IMPORTANT** use unique fields to work with two or more states
+```ruby
+class Car
+  include Statum
+
+  attr_accessor :state, :engine
+
+  statum :state do
+    state :riding
+    state :idle
+
+    event :ride, idle: :riding
+  end
+
+  statum :engine do
+    state :stopped
+    state :started
+
+    event :start, stopped: :started
+  end
+end
+```
+
+```ruby
+car = Car.new
+car.start! # changes engine to started
+car.ride! # changes state to riding
+``` 
+
 ### Hooks
 You can be able to execute some procs before and after event will be fired
 
@@ -76,6 +152,14 @@ end
 And then before state changes will be executed `before` proc, and after
 changing - `after` proc (in instance context).
 
+If you will wait for argument in hook - the instance will be passed.
+```ruby
+...
+event :ride, idle: :riding, 
+             before: -> (instance) { instance.started = true}
+...
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nulldef/statum.

data/lib/statum.rb

@@ -1,11 +1,17 @@
 require "statum/version"
-require "statum/state_definer"
 require "statum/machine"
+require "statum/hook"
 require "statum/event"
+require "statum/state_definer"
 
 module Statum
   UnknownEventError    = Class.new(ArgumentError)
   ErrorTransitionError = Class.new(StandardError)
+  ExistingMachineError = Class.new(ArgumentError)
+
+  STATE_MACHINES_VARIABLE = '@__statum_machines'.freeze
+
+  ANY_STATE_NAME = :__statum_any_state
 
   class << self
     def included(base)
@@ -18,20 +24,29 @@ module Statum
     def statum(field, options = {}, &block)
       definer = Statum::StateDefiner.new(self, field, options)
       definer.instance_eval(&block) if block_given?
-      instance_variable_set('@__statum_machine', definer.state_machine)
+      add_machine(definer.state_machine)
     end
 
-    def state_machine
-      instance_variable_get('@__statum_machine')
+    def state_machines
+      instance_variable_get(STATE_MACHINES_VARIABLE) || []
+    end
+
+    private
+
+    def add_machine(machine)
+      if state_machines.any? { |m| m.name == machine.name }
+        raise ExistingMachineError, "State machine for #{machine.name} already exists"
+      end
+      instance_variable_set(STATE_MACHINES_VARIABLE, state_machines + [machine])
     end
   end
 
   module InstanceMethods
     def method_missing(meth, *args)
-      if meth.to_s.end_with?('?') && state_machine.state?(meth[0...-1])
-        state_machine.current(self) == meth[0...-1].to_sym
-      elsif meth.to_s.end_with?('!') && state_machine.event?(meth[0...-1])
-        state_machine.fire!(self, meth[0...-1])
+      if meth.to_s.end_with?('?') && (machine = find_machine_by_state(meth[0...-1]))
+        machine.current(self) == meth[0...-1].to_sym
+      elsif meth.to_s.end_with?('!') && (machine = find_machine_by_event(meth[0...-1]))
+        machine.fire!(self, meth[0...-1])
       else
         super
       end
@@ -39,16 +54,26 @@ module Statum
 
     def respond_to_missing?(meth, *args)
       if meth.to_s.end_with?('?')
-        state_machine.state?(meth[0...-1])
+        !find_machine_by_state(meth[0...-1]).nil?
       elsif meth.to_s.end_with?('!')
-        state_machine.event?(meth[0...-1])
+        !find_machine_by_event(meth[0...-1]).nil?
       else
         super
       end
     end
 
-    def state_machine
-      self.class.state_machine
+    private
+
+    def find_machine_by_event(name)
+      state_machines.select { |machine| machine.event?(name) }.first
+    end
+
+    def find_machine_by_state(name)
+      state_machines.select { |machine| machine.state?(name) }.first
+    end
+
+    def state_machines
+      self.class.state_machines
     end
   end
 end

data/lib/statum/event.rb

@@ -1,30 +1,38 @@
 module Statum
   # Class for storing event info
+  #
+  # @attr [Statum::Hook] before Before hook object
+  # @attr [Statum::Hook] after After hook object
+  # @attr [Symbol|Array] from From state name (or names)
+  # @attr [Symbol] to To state name
   class Event
     attr_reader :from, :to, :before, :after
 
     # Creates an event class
     #
-    # @param [String|Symbol] from From state name
+    # @param [String|Symbol|Array] from From state name
     # @param [String|Symbol] to To state name
     # @param [Hash] options Options for event
     def initialize(from, to, options = {})
-      @from = from
-      @to = to
-      @before = options.fetch(:before, nil)&.to_proc
-      @after = options.fetch(:after, nil)&.to_proc
+      @from   = from.is_a?(Array) ? from : from.to_sym
+      @to     = to.to_sym
+      @before = Statum::Hook.new(options.fetch(:before, nil))
+      @after = Statum::Hook.new(options.fetch(:after, nil))
     end
 
-    # Check if before hook exists
-    # @return [boolean]
-    def before?
-      !before.nil?
-    end
-
-    # Checks if after hook present
-    # @return [boolean]
-    def after?
-      !after.nil?
+    # Returns true if event can be fired from current state
+    #
+    # @param [String|Symbol] current_state Current state
+    #
+    # @return [Boolean]
+    def can_fire?(current_state)
+      if from.is_a?(Array)
+        from.include?(current_state.to_sym)
+      elsif from == Statum::ANY_STATE_NAME
+        true
+      else
+        from == current_state.to_sym
+      end
     end
   end
 end

data/lib/statum/hook.rb

@@ -0,0 +1,30 @@
+module Statum
+  # Hook wrapper for Statum::Event
+  class Hook
+    # Creates new Hook instance
+    #
+    # @param [Symbol|Proc|Lambda] hook Callable object or symbol that represents instance method
+    def initialize(hook)
+      @hook = hook
+    end
+
+    # Execute hook on instane
+    #
+    # @param [Object] instance Class instance
+    def evaluate(instance)
+      return if @hook.nil?
+      hook = find_hook(instance)
+      if hook.arity.zero?
+        instance.instance_exec(&hook)
+      else
+        instance.instance_exec(instance, &hook)
+      end
+    end
+
+    private
+
+    def find_hook(instance)
+      @hook.respond_to?(:call) ? @hook : instance.method(@hook)
+    end
+  end
+end

data/lib/statum/machine.rb

@@ -3,6 +3,9 @@ module Statum
   class Machine
     attr_reader :events, :states, :field
 
+    # Use state field for name of machine
+    alias name field
+
     # Creates machine instance
     #
     # @param [Hash] options options hash
@@ -41,13 +44,13 @@ module Statum
       current_state = current(instance)
       event         = events[name.to_sym]
 
-      if event.from != current_state
+      unless event.can_fire?(current_state)
         raise Statum::ErrorTransitionError, "Cannot transition from #{current_state} to #{event.to}"
       end
 
-      instance.instance_eval(&event.before) if event.before?
+      event.before.evaluate(instance)
       instance.send("#{field}=", event.to)
-      instance.instance_eval(&event.after) if event.after?
+      event.after.evaluate(instance)
     end
 
     # Returns current state of instance
@@ -56,7 +59,8 @@ module Statum
     #
     # @return [Symbol] Current instance's state
     def current(instance)
-      instance.send(field)&.to_sym || @initial
+      value = instance.send(field)
+      value.nil? ? @initial : value.to_sym
     end
   end
 end

data/lib/statum/state_definer.rb

@@ -35,6 +35,13 @@ module Statum
       @states << name.to_sym unless @states.include?(name.to_sym)
     end
 
+    # Returns any state identifier
+    #
+    # @return [Symbol]
+    def any_state
+      Statum::ANY_STATE_NAME
+    end
+
     # Define a new event
     #
     # @param [String|Symbol] name Event name

data/lib/statum/version.rb

@@ -1,3 +1,3 @@
 module Statum
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/statum.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage    = "https://github.com/nulldef/statum"
   spec.license     = "MIT"
 
-
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statum
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexey Bespalov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-02 00:00:00.000000000 Z
+date: 2017-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -99,6 +100,7 @@ files:
 - bin/setup
 - lib/statum.rb
 - lib/statum/event.rb
+- lib/statum/hook.rb
 - lib/statum/machine.rb
 - lib/statum/state_definer.rb
 - lib/statum/version.rb
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby gem to control your states