statum 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52f0fb1eba87da4ce2d080b1256d3929628c2a05
+  data.tar.gz: 10871eafd35c6dd767ec219d0f4fcdf6342d7cae
+SHA512:
+  metadata.gz: 4cfe42b84a4b55fad13213eb792f5b96a19cac90f7b2236892db35fa3eb3320a2dc3be897f8e7b5f9b50576d583309383206d123889e4239e729f284a79d8386
+  data.tar.gz: d5442a1c6fb819574e3bf1ec13258868ea7f5dac6c836bfc902ce8fbbce1ecd64f6e65d59c440fe63f9b916b1b8d8096ce423599ce6c65656159b9ffef0fcb72

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--require pry

data/.rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - db/schema.rb
+    - config/**/*.rb
+
+Rails:
+  Enabled: true
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+# Bundler
+Bundler/OrderedGems:
+  Enabled: false
+
+# Metrics
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 6
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 100
+  AllowHeredoc: true
+  IgnoredPatterns: ['#.*']
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+# Style
+Style/StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+# Lint
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+language: ruby
+cache: bundler
+before_install: gem install bundler
+script: bundle exec rspec
+rvm:
+  - 2.4.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in statum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alex
+
+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,85 @@
+# Statum
+
+![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)
+
+ Finite state machine for your objects 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'statum'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statum
+
+## Usage
+
+### Basic usage
+Statum provides a DSL for defining state machine for your class
+
+```ruby
+class Car
+  include Statum
+  
+  attr_accessor :state
+  
+  statum :state, initial: :idle do
+    state :idle
+    state :riding
+    
+    event :ride, idle: :riding
+  end
+end
+```
+
+Then `Car` object will receive following methods:
+```ruby
+car = Car.new
+car.idle? # => true
+car.riding? # => false
+car.ride! # changes idle state to riding
+```
+
+### Hooks
+You can be able to execute some procs before and after event will be fired
+
+```ruby
+class Car
+  include Statum
+  
+  attr_accessor :state, :started
+  
+  statum :state, initial: :idle do
+    state :idle
+    state :riding
+    
+    event :ride, idle: :riding,
+                 before: -> { self.started = true },
+                 after: :stop_engine
+  end
+  
+  def stop_engine
+    self.started = false
+  end
+end
+```
+
+And then before state changes will be executed `before` proc, and after
+changing - `after` proc (in instance context).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nulldef/statum.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "statum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/statum.rb

@@ -0,0 +1,54 @@
+require "statum/version"
+require "statum/state_definer"
+require "statum/machine"
+require "statum/event"
+
+module Statum
+  UnknownEventError    = Class.new(ArgumentError)
+  ErrorTransitionError = Class.new(StandardError)
+
+  class << self
+    def included(base)
+      base.extend(Statum::ClassMethods)
+      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?
+      instance_variable_set('@__statum_machine', definer.state_machine)
+    end
+
+    def state_machine
+      instance_variable_get('@__statum_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])
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(meth, *args)
+      if meth.to_s.end_with?('?')
+        state_machine.state?(meth[0...-1])
+      elsif meth.to_s.end_with?('!')
+        state_machine.event?(meth[0...-1])
+      else
+        super
+      end
+    end
+
+    def state_machine
+      self.class.state_machine
+    end
+  end
+end

data/lib/statum/event.rb

@@ -0,0 +1,30 @@
+module Statum
+  # Class for storing event info
+  class Event
+    attr_reader :from, :to, :before, :after
+
+    # Creates an event class
+    #
+    # @param [String|Symbol] 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
+    end
+
+    # Check if before hook exists
+    # @return [boolean]
+    def before?
+      !before.nil?
+    end
+
+    # Checks if after hook present
+    # @return [boolean]
+    def after?
+      !after.nil?
+    end
+  end
+end

data/lib/statum/machine.rb

@@ -0,0 +1,62 @@
+module Statum
+  # Class for representing event machine
+  class Machine
+    attr_reader :events, :states, :field
+
+    # Creates machine instance
+    #
+    # @param [Hash] options options hash
+    def initialize(options)
+      @field   = options.delete(:field)
+      @initial = options.delete(:initial)
+      @states  = options.delete(:states)
+      @events  = options.delete(:events)
+    end
+
+    # Checks if state present
+    #
+    # @param [String|Symbol] name state name
+    #
+    # @return [Boolean]
+    def state?(name)
+      @states.include?(name.to_sym)
+    end
+
+    # Checks if event present
+    #
+    # @param [String|Boolean] name event name
+    #
+    # @return [Boolean]
+    def event?(name)
+      @events.keys.include?(name.to_sym)
+    end
+
+    # Execute an event
+    #
+    # @param [Object] instance Instance of class, that includes Statum
+    # @param [String|Symbol] name Event name
+    def fire!(instance, name)
+      raise Statum::UnknownEventError, "Event #{name} not found" unless event?(name)
+
+      current_state = current(instance)
+      event         = events[name.to_sym]
+
+      if event.from != current_state
+        raise Statum::ErrorTransitionError, "Cannot transition from #{current_state} to #{event.to}"
+      end
+
+      instance.instance_eval(&event.before) if event.before?
+      instance.send("#{field}=", event.to)
+      instance.instance_eval(&event.after) if event.after?
+    end
+
+    # Returns current state of instance
+    #
+    # @param [Object] instance Instance of class
+    #
+    # @return [Symbol] Current instance's state
+    def current(instance)
+      instance.send(field)&.to_sym || @initial
+    end
+  end
+end

data/lib/statum/state_definer.rb

@@ -0,0 +1,51 @@
+module Statum
+  # Class for create hash options for machine
+  class StateDefiner
+    # Creates an instance of definer
+    #
+    # @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
+    def initialize(klass, field, options)
+      @klass   = klass
+      @field   = field.to_sym
+      @initial = options.fetch(:initial, nil)
+      @states  = []
+      @events  = {}
+
+      state(@initial) unless @initial.nil?
+    end
+
+    # Returns state maching
+    #
+    # @return [Statum::Machine]
+    def state_machine
+      Statum::Machine.new(
+        field:   @field,
+        initial: @initial,
+        states:  @states,
+        events:  @events
+      )
+    end
+
+    # Define a new state
+    #
+    # @param [String|Symbol] name State name
+    def state(name)
+      @states << name.to_sym unless @states.include?(name.to_sym)
+    end
+
+    # Define a new event
+    #
+    # @param [String|Symbol] name Event name
+    # @param [Hash] options Options hash
+    # First key-value pair must be 'from' and 'to' transition states
+    # Other pairs are event options
+    def event(name, options)
+      return if @events.key?(name.to_sym)
+
+      from, to = options.shift
+      @events[name.to_sym] = Statum::Event.new(from, to, options)
+    end
+  end
+end

data/lib/statum/version.rb

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

data/statum.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "statum/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "statum"
+  spec.version = Statum::VERSION
+  spec.authors = ["Alexey Bespalov"]
+  spec.email   = ["alex.coder1@gmail.com"]
+
+  spec.summary     = "Ruby gem to control your states"
+  spec.description = "Ruby state machine"
+  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
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: statum
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexey Bespalov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby state machine
+email:
+- alex.coder1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/statum.rb
+- lib/statum/event.rb
+- lib/statum/machine.rb
+- lib/statum/state_definer.rb
+- lib/statum/version.rb
+- statum.gemspec
+homepage: https://github.com/nulldef/statum
+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.8
+signing_key: 
+specification_version: 4
+summary: Ruby gem to control your states
+test_files: []