statum 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8faf2ca3f2b51f152887aa12e747d8089b3aef9c
-  data.tar.gz: b1312cb2bdf56cd71d32780faf14dc0699409327
+  metadata.gz: 3d044edb13c46dc2a4ece61532eb8268c6dfa91f
+  data.tar.gz: 3c51404c5dc3281442ed7f4a7be5a34d2fbb7f57
 SHA512:
-  metadata.gz: f469b8e8ecad0b292ca837fdb4289d329b5b9dec87591ea8cfcb32c9f65f3eefb4baacaa423acb5734faec5a4fb04d1aa84da74525183336f7e7b5c2dc18301f
-  data.tar.gz: bfe730ae1c8ad58cc939464139480278c06ac84f9b1379a23793cf8eed5ad4e7182053618ccac0f16730edd211b801d5e1536b455a3d68ffd78cf63f57fa88ee
+  metadata.gz: f8b8b6c598abfe37921b2edb85c1d55624d53074097ea8288b34d2a906c84c6c27369e624d98a4de598c1fadd18d9aa5af61aca9cfe594094242bb0961f0c8c7
+  data.tar.gz: 3a4f4e46b868a885e5138265d63a5d5ee5c8f0005e16bda19f2d815293c589f262a4c28f7c84f54b97fdc281f40bcc4604872000066b8122e0f55df2ab1df5c8

data/README.md

@@ -2,6 +2,7 @@
 
 ![Build Status](https://travis-ci.org/nulldef/statum.svg?branch=master)
 [![Coverage Status](https://coveralls.io/repos/github/nulldef/statum/badge.svg?branch=master)](https://coveralls.io/github/nulldef/statum?branch=master&v=1)
+[![Gem Version](https://badge.fury.io/rb/statum.svg)](https://badge.fury.io/rb/statum)
 
  Finite state machine for your objects 
  

data/lib/statum.rb

@@ -1,16 +1,25 @@
 require "statum/version"
+require "statum/class_methods"
+require "statum/instance_methods"
 require "statum/machine"
 require "statum/hook"
 require "statum/event"
 require "statum/state_definer"
 
 module Statum
+  # Error for unknown event
   UnknownEventError    = Class.new(ArgumentError)
+
+  # Error for wrong transition
   ErrorTransitionError = Class.new(StandardError)
+
+  # Error for duplicated state machine
   ExistingMachineError = Class.new(ArgumentError)
 
+  # Variable to store state machines
   STATE_MACHINES_VARIABLE = '@__statum_machines'.freeze
 
+  # Any state identifier
   ANY_STATE_NAME = :__statum_any_state
 
   class << self
@@ -19,61 +28,4 @@ module Statum
       base.include(Statum::InstanceMethods)
     end
   end
-
-  module ClassMethods
-    def statum(field, options = {}, &block)
-      definer = Statum::StateDefiner.new(self, field, options)
-      definer.instance_eval(&block) if block_given?
-      add_machine(definer.state_machine)
-    end
-
-    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?('?') && (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
-    end
-
-    def respond_to_missing?(meth, *args)
-      if meth.to_s.end_with?('?')
-        !find_machine_by_state(meth[0...-1]).nil?
-      elsif meth.to_s.end_with?('!')
-        !find_machine_by_event(meth[0...-1]).nil?
-      else
-        super
-      end
-    end
-
-    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/class_methods.rb

@@ -0,0 +1,35 @@
+module Statum
+  module ClassMethods
+    # Define new state machine
+    #
+    # @param [Symbol] field Field to store state
+    # @param [Hash] options Options
+    # @option options [Symbol] initial Initial value
+    # @param [Block] block Bloc with DSL
+    def statum(field, options = {}, &block)
+      definer = Statum::StateDefiner.new(self, field, options)
+      definer.instance_eval(&block) if block_given?
+      add_machine(definer.state_machine)
+    end
+
+    # Returns defined state machines
+    #
+    # @return [Array<Statum::Machine>]
+    def state_machines
+      instance_variable_get(STATE_MACHINES_VARIABLE) || []
+    end
+
+    private
+
+    # Add new state machine
+    #
+    # @param [Statum::Machine] machine New state machine
+    # @raise Statum::ExistingMachineError
+    def add_machine(machine)
+      if state_machines.any? { |m| m.name == machine.name }
+        raise Statum::ExistingMachineError, "State machine for #{machine.name} already exists"
+      end
+      instance_variable_set(STATE_MACHINES_VARIABLE, state_machines + [machine])
+    end
+  end
+end

data/lib/statum/event.rb

@@ -3,18 +3,18 @@ module Statum
   #
   # @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, 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|Array] from From state name
-    # @param [String|Symbol] to To state name
+    # @param [Symbol, Array<Symbol>] from From state name
+    # @param [Symbol] to To state name
     # @param [Hash] options Options for event
     def initialize(from, to, options = {})
-      @from   = from.is_a?(Array) ? from : from.to_sym
+      @from   = from.is_a?(Array) ? from.map(&:to_sym) : from.to_sym
       @to     = to.to_sym
       @before = Statum::Hook.new(options.fetch(:before, nil))
       @after = Statum::Hook.new(options.fetch(:after, nil))
@@ -22,7 +22,7 @@ module Statum
 
     # Returns true if event can be fired from current state
     #
-    # @param [String|Symbol] current_state Current state
+    # @param [Symbol] current_state Current state
     #
     # @return [Boolean]
     def can_fire?(current_state)

data/lib/statum/hook.rb

@@ -3,7 +3,7 @@ module Statum
   class Hook
     # Creates new Hook instance
     #
-    # @param [Symbol|Proc|Lambda] hook Callable object or symbol that represents instance method
+    # @param [Symbol, Proc] hook Callable object or symbol that represents instance method
     def initialize(hook)
       @hook = hook
     end
@@ -23,6 +23,11 @@ module Statum
 
     private
 
+    # Finds hook on instance
+    #
+    # @param [Object] instance Instance of class that included Statum
+    #
+    # @return [Proc]
     def find_hook(instance)
       @hook.respond_to?(:call) ? @hook : instance.method(@hook)
     end

data/lib/statum/instance_methods.rb

@@ -0,0 +1,37 @@
+module Statum
+  module InstanceMethods
+    def method_missing(meth, *args)
+      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
+    end
+
+    def respond_to_missing?(meth, *args)
+      if meth.to_s.end_with?('?')
+        !find_machine_by_state(meth[0...-1]).nil?
+      elsif meth.to_s.end_with?('!')
+        !find_machine_by_event(meth[0...-1]).nil?
+      else
+        super
+      end
+    end
+
+    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/machine.rb

@@ -1,5 +1,9 @@
 module Statum
   # Class for representing event machine
+  #
+  # @attr_reader [Hash] events Events
+  # @attr_reader [Array<Symbol>] states States
+  # @attr_reader [Symbol] field State field
   class Machine
     attr_reader :events, :states, :field
 
@@ -9,6 +13,10 @@ module Statum
     # Creates machine instance
     #
     # @param [Hash] options options hash
+    # @option options [Symbol] field Field to store state
+    # @option options [Symbol] initial Initial state
+    # @option options [Array<Symbol>] states States
+    # @option options [Hash] events Events
     def initialize(options)
       @field   = options.delete(:field)
       @initial = options.delete(:initial)
@@ -18,7 +26,7 @@ module Statum
 
     # Checks if state present
     #
-    # @param [String|Symbol] name state name
+    # @param [Symbol] name state name
     #
     # @return [Boolean]
     def state?(name)
@@ -27,7 +35,7 @@ module Statum
 
     # Checks if event present
     #
-    # @param [String|Boolean] name event name
+    # @param [Symbol] name event name
     #
     # @return [Boolean]
     def event?(name)
@@ -37,7 +45,10 @@ module Statum
     # Execute an event
     #
     # @param [Object] instance Instance of class, that includes Statum
-    # @param [String|Symbol] name Event name
+    # @param [Symbol] name Event name
+    #
+    # @raise Statum::UnknownEventError
+    # @raise Statum::ErrorTransitionError
     def fire!(instance, name)
       raise Statum::UnknownEventError, "Event #{name} not found" unless event?(name)
 

data/lib/statum/state_definer.rb

@@ -6,6 +6,7 @@ module Statum
     # @param [Class] klass Class that includes Statum
     # @param [String|Symbol] field Field that will be used for storing current state
     # @param [Hash] options Hash options
+    # @option options [Symbol] initial Initial value
     def initialize(klass, field, options)
       @klass   = klass
       @field   = field.to_sym
@@ -16,7 +17,7 @@ module Statum
       state(@initial) unless @initial.nil?
     end
 
-    # Returns state maching
+    # Returns state machine
     #
     # @return [Statum::Machine]
     def state_machine
@@ -30,7 +31,7 @@ module Statum
 
     # Define a new state
     #
-    # @param [String|Symbol] name State name
+    # @param [Symbol] name State name
     def state(name)
       @states << name.to_sym unless @states.include?(name.to_sym)
     end

data/lib/statum/version.rb

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

data/statum.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "coveralls", "~> 0.8"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statum
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alexey Bespalov
@@ -99,8 +99,10 @@ files:
 - bin/console
 - bin/setup
 - lib/statum.rb
+- lib/statum/class_methods.rb
 - lib/statum/event.rb
 - lib/statum/hook.rb
+- lib/statum/instance_methods.rb
 - lib/statum/machine.rb
 - lib/statum/state_definer.rb
 - lib/statum/version.rb
@@ -117,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="