police_state 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cb2c1110ee730d95c0736792fe123449bb87b02
+  data.tar.gz: 7a757181a7fb2ebf15f4d98930c56c6249f3a238
+SHA512:
+  metadata.gz: 2a14b69fa95a25bb675c66d4bb2b9fc1a0ad6caa310343eefc1d04a3fac46df5229894a88721378d9e4dcc218d916ab7d676ac21591613b92e5179c121708ddb
+  data.tar.gz: fa2f01744990415a13690664aef9d4cd652b5c03c94291a94fab1da7af7e560f284b111f045e36c7a5f7784320486dfa43c1ccb31008853568e7b12a1ed12444

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Ian Purvis
+
+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,147 @@
+[![Build Status](https://travis-ci.org/ianpurvis/police_state.svg?branch=master)](https://travis-ci.org/ianpurvis/police_state)
+[![Doc Status](http://inch-ci.org/github/ianpurvis/police_state.svg?branch=master)](http://inch-ci.org/github/ianpurvis/police_state)
+
+# Police State
+Lightweight state machine for Active Record and Active Model.
+
+
+## Background
+After experimenting with state machines in a recent project, I became interested in a workflow that felt more natural for rails. In particular, I wanted to reduce architectural overlap incurred by flow control, guard, and callback workflows.
+
+The goal of Police State is to let you easily work with state machines based on `ActiveModel::Dirty`, `ActiveModel::Validation`, and `ActiveModel::Callbacks`
+
+
+## Usage
+Police State revolves around the use of `TransitionValidator` and two helper methods, `attribute_transitioning?` and `attribute_transitioned?`.
+
+To get started, just include `PoliceState` in your model and define a set of valid transitions:
+
+```ruby
+class Model < ApplicationRecord
+  include PoliceState
+
+  enum status: {
+    queued: 0,
+    active: 1,
+    complete: 2,
+    failed: 3
+  }
+  
+  validates :status, transition: { from: nil, to: :queued }
+  validates :status, transition: { from: :queued, to: :active }
+  validates :status, transition: { from: :active, to: :complete }
+  validates :status, transition: { from: [:queued, :active], to: :failed }
+end
+```
+
+### Committing a Transition
+One aspect of Police State that will feel different than other ruby state machines is the idea that in-memory state has not fully transitioned until it is persisted to the database. This lets you operate within a traditional Active Record workflow:
+
+```ruby
+model = Model.new(status: :complete)
+# => #<Model:0x007fa94844d088 @status=:complete>
+
+model.status_transitioning?(from: nil)
+# => true
+
+model.status_transitioning?(to: :complete)
+# => true
+
+model.valid?
+# => false
+
+model.errors.to_hash
+# => {:status=>["can't transition to complete"]}
+
+model.save
+# => false
+
+model.save!
+# => ActiveRecord::RecordInvalid: Validation failed: Status can't transition to complete
+
+model.status = :queued
+# => :queued
+
+model.valid?
+# => true
+
+model.save
+# => true
+
+model.status_transitioned?(from: nil, to: :queued)
+# => true
+
+```
+
+
+### Guard Conditions
+Guard conditions can be introduced for a state by adding a conditional ActiveRecord validation:
+
+```ruby
+validates :another_field, :presence, if: -> { queued? }
+```
+
+### Callbacks
+
+Callbacks can be attached to specific transitions by adding a condition on `attribute_transitioned?`. If the callback needs to occur before persistence, `attribute_transitioning?` can also be used.
+
+```ruby
+after_commit :notify, if: -> { status_transitioned?(to: :complete) }
+after_commit :alert, if: -> { status_transitioned?(from: :active, to: :failed) }
+after_commit :log, if: -> { status_transitioned? }
+```
+
+### Events
+Explicit event languge can be added to models by wrapping `update` and / or `update!`
+
+```ruby
+def run
+  update(status: :active) 
+end
+  
+def run!
+  update!(status: :active)
+end
+```
+
+The bang methods defined by `ActiveRecord::Enum` work as well:
+
+```ruby
+model.active!
+# => ActiveRecord::RecordInvalid: Validation failed: Status can't transition to active
+```
+
+### Validation Logic
+One important note about `TransitionValidator` is that it performs a unidirectional validation. For example, the following ensures that the `active` state can only be reached from the `queued` state:
+
+```ruby
+validates :status, transition: { from: :queued, to: :active }
+```
+
+However, this does not prevent `queued` from transitioning to other states. Those states must be controlled by their own validators.
+
+
+### Active Model
+If you are using Active Model, make sure your class correctly implements `ActiveModel::Dirty`. For an example, check out [spec/test_model.rb](spec/test_model.rb)
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'police_state'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install police_state
+```
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PoliceState'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  puts 'Could not load RSpec'
+end
+

data/lib/police_state.rb

@@ -0,0 +1,38 @@
+#--
+# Copyright (c) 2017 Ian Purvis
+#
+# 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.
+#++
+
+require "active_model"
+require "active_support/core_ext/array/wrap.rb"
+require "active_support/core_ext/hash/slice.rb"
+require "police_state/transition_helpers"
+require "police_state/transition_validator"
+require "police_state/validation_helpers"
+
+module PoliceState
+  extend ActiveSupport::Concern
+
+  included do
+    include PoliceState::TransitionHelpers
+    extend PoliceState::ValidationHelpers
+  end
+end

data/lib/police_state/transition_helpers.rb

@@ -0,0 +1,71 @@
+module PoliceState
+
+  # == Police State Transition Helpers
+  #
+  # Provides a way to monitor attribute state transitions for Active Record and Active Model objects.
+  #
+  # Note: If using with Active Model, make sure that your class implements +ActiveModel::Dirty+.
+  module TransitionHelpers
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    # :stopdoc:
+    included do
+      raise ArgumentError, "Including class must implement ActiveModel::Dirty" unless include?(ActiveModel::Dirty)
+      attribute_method_suffix "_transitioned?", "_transitioning?"
+    end
+    # :startdoc:
+
+    # Returns +true+ if +attribute+ transitioned at the last save event, otherwise +false+.
+    #
+    # You can specify origin and destination states using the +:from+ and +:to+
+    # options. If +attribute+ is an +ActiveRecord::Enum+, these may be
+    # specified as either symbol or their native enum value.
+    #
+    #  model = Model.create!(status: :complete)
+    #  # => #<Model:0x007fa94844d088 @status=:complete>
+    #
+    #  model.status_transitioned?                            # => true
+    #  model.status_transitioned?(from: nil)                 # => true
+    #  model.status_transitioned?(to: :complete)             # => true
+    #  model.status_transitioned?(to: "complete")            # => true
+    #  model.status_transitioned?(from: nil, to: :complete)  # => true
+    def attribute_transitioned?(attr, options={})
+      options = _transform_options_for_attribute(attr, options)
+      !!previous_changes_include?(attr) &&
+        (!options.include?(:to) || options[:to] == previous_changes[attr].last) &&
+        (!options.include?(:from) || options[:from] == previous_changes[attr].first)
+    end
+
+    # Returns +true+ if +attribute+ is currently transitioning but not saved, otherwise +false+.
+    #
+    # You can specify origin and destination states using the +:from+ and +:to+
+    # options. If +attribute+ is an +ActiveRecord::Enum+, these may be
+    # specified as either symbol or their native enum value.
+    #
+    #  model = Model.new(status: :complete)
+    #  # => #<Model:0x007fa94844d088 @status=:complete>
+    #
+    #  model.status_transitioning?                            # => true
+    #  model.status_transitioning?(from: nil)                 # => true
+    #  model.status_transitioning?(to: :complete)             # => true
+    #  model.status_transitioning?(to: "complete")            # => true
+    #  model.status_transitioning?(from: nil, to: :complete)  # => true
+    def attribute_transitioning?(attr, options={})
+      options = _transform_options_for_attribute(attr, options)
+      attribute_changed?(attr, options)
+    end
+
+
+    private
+
+    # Facilitates easier change checking for ActiveRecord::Enum attributes
+    # by casting any symbolized :to and :from values into their native strings.
+    def _transform_options_for_attribute(attr, options={})
+      return options unless self.class.respond_to?(:attribute_types)
+      options.transform_values {|value|
+        self.class.attribute_types.with_indifferent_access[attr].cast(value)
+      }
+    end
+  end
+end

data/lib/police_state/transition_validator.rb

@@ -0,0 +1,32 @@
+module PoliceState
+  class TransitionValidator < ActiveModel::EachValidator # :nodoc:
+
+    def check_validity!
+      raise ArgumentError, "Options must include :from" unless options.include?(:from)
+      raise ArgumentError, "Options must include :to" unless options.include?(:to)
+      raise ArgumentError, "Options cannot specify array for :to" if options[:to].is_a?(Array)
+    end
+
+    def validate_each(record, attr_name, value)
+      unless transition_allowed?(record, attr_name)
+        record.errors.add(attr_name, "can't transition to #{value}", options)
+      end
+    end
+
+
+    private
+
+    def destination
+      options[:to]
+    end
+
+    def origins
+      options[:from].instance_eval {nil? ? [nil] : Array.wrap(self)}
+    end
+
+    def transition_allowed?(record, attr_name)
+      !record.attribute_transitioning?(attr_name, to: destination) ||
+        origins.any? {|origin| record.attribute_transitioning?(attr_name, from: origin)}
+    end
+  end
+end

data/lib/police_state/validation_helpers.rb

@@ -0,0 +1,34 @@
+module PoliceState
+
+  # == Police State Validation Helpers
+  module ValidationHelpers
+
+    # Validates that the specified attribute is transitioning to a
+    # destination state from one or more origin states.
+    #
+    #   class Model < ActiveRecord::Base
+    #     validates_transition_of :status, from: nil, to: :queued
+    #     validates_transition_of :status, from: :queued, to: :active
+    #     validates_transition_of :status, from: :active, to: :complete
+    #     validates_transition_of :status, from: [:queued, :active], to: :failed
+    #   end
+    #
+    # Note: This check is only performed if the attribute is transitioning to the
+    # destination state.
+    #
+    # You can specify +nil+ states for nullable attributes.
+    #
+    # Configuration options:
+    #
+    # * <tt>:from</tt> - The origin state(s) of the attribute. This can be supplied as a
+    #   single value or an array.
+    # * <tt>:to</tt> - The destination state of the attribute.
+    #
+    # There is also a list of default options supported by every validator:
+    # +:if+, +:unless+, +:on+, +:allow_nil+, +:allow_blank+, and +:strict+.
+    # See <tt>ActiveModel::Validation#validates</tt> for more information
+    def validates_transition_of(*attr_names)
+      validates_with PoliceState::TransitionValidator, _merge_attributes(attr_names)
+    end
+  end
+end

data/lib/police_state/version.rb

@@ -0,0 +1,3 @@
+module PoliceState
+  VERSION = '0.3.0' # :nodoc:
+end

data/lib/tasks/police_state_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :police_state do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: police_state
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Ian Purvis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ian@purvisresearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/police_state.rb
+- lib/police_state/transition_helpers.rb
+- lib/police_state/transition_validator.rb
+- lib/police_state/validation_helpers.rb
+- lib/police_state/version.rb
+- lib/tasks/police_state_tasks.rake
+homepage: 
+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: Lightweight state machine for Active Record and Active Model.
+test_files: []