wesm 0.1.8.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3d0921469fa5f7b77f24e5831c934543a624dd9
+  data.tar.gz: 40e543a39e9d89d66ebac43fc337c26b172580ef
+SHA512:
+  metadata.gz: 47ddb686ce25b8cb9040f3b2e19da0c7010fb89d4af9a847169ffb95bc84f309f97a55fe60af4bc8347bda68bbc734c517330313c0e915d53d95ace2c1c9cea0
+  data.tar.gz: fa01c0ec54c8836f33ce902f56f2fb15c865d6ef523ffab91572d203831ec927c588de675ab18b74eb8c062ad499ceff3eaeaae0888903c56a51bc90e47f860f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.DS_Store
+wesm-*.gem

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,136 @@
+# Wesm
+
+[![Build Status](https://travis-ci.org/arthurweisz/wesm.svg?branch=master)](https://travis-ci.org/arthurweisz/wesm)
+[![Code Climate](https://codeclimate.com/github/arthurweisz/wesm/badges/gpa.svg)](https://codeclimate.com/github/arthurweisz/wesm)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wesm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wesm
+
+## Usage
+
+### Specifying Transitions
+
+Extend your class with *Wesm* module and define transitions with *transition* method
+
+```ruby
+class OrderStateMachine
+  extend Wesm
+
+  transition :pending => :approved, actor: Manager
+  transition :pending => :rejected, actor: Manager, required: :reject_reason
+  transition :approved => :payment_verification, actor: :owner, required: :payment
+  transition :payment_verification => :paid, actor: StripePaymentsService
+  transition :rejected => :closed, actor: [Manager, OrdersSchedulerJob]
+end
+```
+
+### Performing transitions
+
+```ruby
+user = Manager.new
+order = Order.new(state: 'pending')
+
+OrderStateMachine.perform_transition(order, 'approved', user)
+
+order.state
+=> "approved"
+```
+
+Default implementation is just changing object's state  
+
+You can customize it by overriding *process_transition* method which accepts **object**, **transition**, **actor** and all extra arguments passed to *perform_transition*  
+
+ActiveRecord example with persistence:
+
+```ruby
+class OrderStateMachine
+  extend Wesm
+
+  def self.process_transition(object, transition, actor)
+    ActiveRecord::Base.transaction do
+      # any actions
+      object.state = transition.to_state
+      object.save!
+    end
+  end
+end
+```
+
+### Subsequent transitions information
+
+*successors* method can be used to list all possible subsequent states for transition regardless of actor and required fields
+
+```ruby
+order = Order.new(state: 'pending')
+
+OrderStateMachine.successors(order)
+=> ['approved', 'rejected']
+```
+
+*show_transitions* method shows list of allowed transitions for provided actor
+
+```ruby
+user = User.new
+manager = Manager.new
+order = Order.new(state: 'pending', owner: user)
+
+OrderStateMachine.show_transitions(order, user)
+=> [{
+      to_state: 'approved',
+      is_authorized: false,
+      can_perform: false,
+      required_fields: []
+    },
+    {
+      to_state: 'rejected',
+      is_authorized: false,
+      can_perform: false,
+      required_fields: [:reject_reason]
+    }]
+
+OrderStateMachine.show_transitions(order, manager)
+=> [{
+      to_state: 'approved',
+      is_authorized: true,
+      can_perform: true,
+      required_fields: []
+    },
+    {
+      to_state: 'rejected',
+      is_authorized: true,
+      can_perform: false,
+      required_fields: [:reject_reason]
+    }]
+```
+### State field  
+
+Default field for object's mapping is **state** and can be set by overriding *state_field*
+
+```ruby
+class OrderStateMachine
+  extend Wesm
+
+  def self.state_field
+    :custom_field
+  end
+end
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arthurweisz/wesm.

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'wesm'
+require 'pry'
+
+Pry.start

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/wesm.rb

@@ -0,0 +1,5 @@
+require 'wesm/transition'
+require 'wesm/helpers/transitions_helper'
+require 'wesm/errors'
+require 'wesm/version'
+require 'wesm/wesm'

data/lib/wesm/errors.rb

@@ -0,0 +1,6 @@
+module Wesm
+  class BaseError < StandardError; end
+  class AccessViolationError < BaseError; end
+  class UnexpectedTransitionError < BaseError; end
+  class TransitionRequirementError < BaseError; end
+end

data/lib/wesm/helpers/transitions_helper.rb

@@ -0,0 +1,21 @@
+module Wesm
+  module Helpers
+    module TransitionsHelper
+      def successors
+        self.class.state_machine.successors(self)
+      end
+
+      def show_transitions(actor)
+        self.class.state_machine.show_transitions(self, actor)
+      end
+
+      def required_fields(to_state)
+        self.class.state_machine.required_fields(self, to_state)
+      end
+
+      def perform_transition(to_state, actor, *extras)
+        self.class.state_machine.perform_transition(self, to_state, actor, *extras)
+      end
+    end
+  end
+end

data/lib/wesm/transition.rb

@@ -0,0 +1,65 @@
+module Wesm
+  class Transition
+    attr_accessor :from_state, :to_state, :performer, :required
+
+    def initialize(options)
+      @from_state = options.keys.first.to_s
+      @to_state = options.values.first.to_s
+      @valid_actors = Array(options[:actor])
+      @scope = options[:scope]
+      @required = Array(options[:required])
+      @performer = options[:performer]
+    end
+
+    def actor_is_valid?(object, actor)
+      @valid_actors.empty? || \
+        @valid_actors.map { |valid_actor| compare_actor(valid_actor, object, actor) }.any?
+    end
+
+    def required_fields(object)
+      @required.select { |required_field| object.public_send(required_field).nil? }
+    end
+
+    def required_fields_present?(object)
+      @required.each do |required_field|
+        return false if object.public_send(required_field).nil?
+      end
+      true
+    end
+
+    def valid_scope?(object)
+      @scope.to_h.each do |field, value|
+        return false unless \
+          begin
+            if value.is_a? Proc
+              value.call(*[object.public_send(field), object][0...value.arity])
+            else
+              object.public_send(field) == value
+            end
+          end
+      end
+      true
+    end
+
+    def run_performer_method(method, *args)
+      return unless @performer && @performer.respond_to?(method)
+      @performer.public_send(method, *args)
+    end
+
+    private
+
+    def compare_actor(valid_actor, object, actor)
+      if [String, Symbol].include? valid_actor.class
+        object.public_send(valid_actor) == actor
+      elsif valid_actor.is_a? Class
+        if actor.is_a?(Class)
+          actor == valid_actor
+        else
+          actor.is_a?(valid_actor)
+        end
+      else
+        false
+      end
+    end
+  end
+end

data/lib/wesm/version.rb

@@ -0,0 +1,3 @@
+module Wesm
+  VERSION = '0.1.8.8'
+end

data/lib/wesm/wesm.rb

@@ -0,0 +1,71 @@
+module Wesm
+  def transition(options)
+    @transitions ||= {}
+    transition = Transition.new(options)
+    (@transitions[transition.from_state] ||= []) << transition.freeze
+  end
+
+  def successors(object)
+    transitions_for(object).map(&:to_state).uniq
+  end
+
+  def show_transitions(object, actor)
+    transitions_for(object).map do |transition|
+      is_authorized = transition.actor_is_valid?(object, actor)
+
+      {
+        to_state: transition.to_state,
+        is_authorized: is_authorized,
+        can_perform: is_authorized && transition.required_fields_present?(object),
+        required_fields: transition.required_fields(object)
+      }
+    end
+  end
+
+  def required_fields(object, to_state)
+    transition = get_transition(object, to_state)
+    transition && transition.required_fields(object)
+  end
+
+  def perform_transition(object, to_state, actor, *extras)
+    transition = get_transition!(object, to_state, actor)
+
+    process_transition(object, transition, actor, *extras)
+  end
+
+  def process_transition(object, transition, actor, *extras)
+    object.public_send("#{state_field}=", transition.to_state)
+  end
+
+  private
+
+  def transitions_for(object)
+    (@transitions[object.public_send(state_field)] || [])
+      .reject { |transition| !transition.valid_scope?(object) }
+  end
+
+  def get_transition(object, to_state)
+    transitions_for(object).detect { |transition| transition.to_state == to_state }
+  end
+
+  def get_transition!(object, to_state, actor)
+    transition = get_transition(object, to_state)
+
+    if transition.nil?
+      error_desc = "from '#{object.public_send(state_field)}' to '#{to_state}'"
+      raise UnexpectedTransitionError.new(error_desc)
+    elsif !transition.actor_is_valid?(object, actor)
+      error_desc = "for actor: #{actor}"
+      raise AccessViolationError.new(error_desc)
+    elsif !transition.required_fields_present?(object)
+      error_desc = "fields: #{transition.required_fields(object).join(', ')}"
+      raise TransitionRequirementError.new(error_desc)
+    else
+      transition
+    end
+  end
+
+  def state_field
+    :state
+  end
+end

data/wesm.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wesm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wesm'
+  spec.version       = Wesm::VERSION
+  spec.authors       = ['arthurweisz']
+  spec.email         = ['cloudsong1@yandex.ru']
+
+  spec.summary       = 'Wisely Explicit State Machine'
+  spec.description   = 'Wisely Explicit State Machine'
+  spec.homepage      = ''
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.required_ruby_version = '>= 1.9'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: wesm
+version: !ruby/object:Gem::Version
+  version: 0.1.8.8
+platform: ruby
+authors:
+- arthurweisz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Wisely Explicit State Machine
+email:
+- cloudsong1@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wesm.rb
+- lib/wesm/errors.rb
+- lib/wesm/helpers/transitions_helper.rb
+- lib/wesm/transition.rb
+- lib/wesm/version.rb
+- lib/wesm/wesm.rb
+- wesm.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Wisely Explicit State Machine
+test_files: []