progressive 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f5298ec0afc9ff8c78d6e31ca7c6c9627b13b73
+  data.tar.gz: e9c8610f56ff36f77c97ee6b30e64cedecb8f5f0
+SHA512:
+  metadata.gz: cf893ff9135ed2235e5ac9121909805d3fe75e8643e60ee1328cfe33eb240efbfeab8696544bf87b21164001f6eaa435615133051ba0bb3b6158a05cc4f1285e
+  data.tar.gz: bff326e328e8a8881227c90a1913bdd4099c2dfac6d0cc12bfcaf7dad87a335bb3ca41fa2e0b4f13b2db0186bfa2d4012fe4ec0404cf97d9fa24fb5e726e3d93

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 dewski
+
+MIT License
+
+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,151 @@
+# Progressive
+
+A simple ActiveModel backed state machine.
+
+## Why yet another state machine?
+
+You may be asking why another state machine implementation? Well, first off YASM.
+Second, most other implementations rely on class level attributes and make it
+difficult for inheritance and the rare case when a subject will need to have
+_multiple_ states.
+
+If you only need to have 1 state for a model, Progressive works fine for that too.
+
+Progressive interacts with the states and events for a model at an instance level,
+not class level. There are no magic methods defined based on your states or events
+it relies on method missing so it's very interoperable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'progressive'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install progressive
+
+## Usage
+
+### Defining states on the subject model:
+
+```ruby
+class State < Progressive::State
+
+end
+
+class User < ActiveRecord::Base
+  include Progression::Subject
+
+  has_many :states, :as => :subject, :dependent => :destroy
+
+  states do
+    state :pending do
+      event :potential
+    end
+
+    state :potential do
+      event :interview => :interviewing
+      event :archive => :archived
+    end
+
+    state :interviewing do
+      event :potential
+      event :archive => :archived
+      event :hire => :hired
+    end
+
+    state :hired
+  end
+
+  after_hire :user_rollup
+  before_interview :notify_creator
+
+  def user_rollup
+    # Do something
+  end
+
+  def notify_creator
+
+  end
+end
+```
+
+### Interfacing with the state
+
+```ruby
+actor = User.first
+user = User.first
+
+state = user.states.first
+state.state # => 'pending'
+state.default_state # => :pending
+state.to(:archived, :actor => actor) # => false
+state.to(:potential, :actor => actor) # => true
+state.state # => 'potential'
+state.specification # => Progressive::Specification
+state.current_state # => Progressive::Specification::State
+```
+
+### Short circuiting an event
+
+Since Progressive uses the same ActiveModel callbacks you're familiar with in
+your ActiveRecord models, you can short circuit the event just by returning
+a falsey statement within each callback.
+
+You can add a before or after callback for any event. To see which events you
+have available just check the Progressive specification:
+
+```ruby
+Video.specification.event_names # => [:converting, :publish]
+```
+
+Example:
+
+```ruby
+class Video < ActiveRecord::Base
+  include Progression::Subject
+
+  has_one :state, :as => :subject, :dependent => :destroy
+
+  states do
+    state :pending do
+      event :converting
+    end
+
+    state :converting do
+      event :publish => :published
+    end
+
+    state :published
+  end
+
+  before_converting :valid_file_size?
+
+  def valid_file_size?
+    file_size < 1.gigabyte
+  end
+end
+
+video = Video.first
+video.file_size # => 2.gigabytes
+video.state # => :pending
+video.converting # => false
+video.state # => :pending
+```
+
+## Maintainers
+
+- [@dewski](/dewski)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/progressive.rb

@@ -0,0 +1,9 @@
+require 'progressive/version'
+
+module Progressive
+  # Your code goes here...
+end
+
+require 'progressive/specification'
+require 'progressive/subject'
+require 'progressive/state'

data/lib/progressive/specification.rb

@@ -0,0 +1,113 @@
+module Progressive
+  class Specification
+    class State
+      attr_reader :events
+
+      def initialize(&block)
+        @events = {}
+        return unless block.present?
+        instance_eval(&block)
+      end
+
+      # Public: Defines events
+      #
+      # args - Can either be symbol (:potential) or hash (:archive => :archived)
+      #
+      # Returns Progression::Specification::Event
+      def event(*args)
+        name, to = args.first.is_a?(Symbol) ? args.first : args.first.to_a.flatten
+        @events[name.to_sym] = Event.new(name, to)
+      end
+
+      # Public: Determine if a given event exists.
+      #
+      # state - Event name to check for.
+      #
+      # Returns true if event exists, false if not.
+      def event?(state)
+        @events.key?(state.to_sym)
+      end
+    end
+
+    class Event
+      attr_reader :name
+      attr_reader :to
+
+      def initialize(name, to = nil)
+        @name = name
+        @to   = to || name
+      end
+    end
+
+    attr_reader :options
+    attr_reader :states
+
+    # Public: Define the different states and events the subject can go through.
+    #
+    # options - The Hash options used to build the specification (default: {}):
+    #           :default - The default state the subject is instantiated at (optional).
+    # block   - A required block that is used to define states and events for
+    #           the subject.
+    #
+    # Returns Progression::Specification
+    def initialize(options = {}, &block)
+      raise MissingConfiguration if block.nil?
+
+      @options = options
+      @states = {}
+
+      instance_eval(&block)
+    end
+
+    # Public: Determine if an event exists within the specification.
+    #
+    # event - Event to check for.
+    #
+    # Returns true if exists, false if not.
+    def event?(event)
+      event_names.include?(event.to_sym)
+    end
+
+    # Public: All possible events that can be applied to the subject. Doesn't
+    # gaurantee it can progress to said states, but that they exist for the
+    # subject.
+    #
+    # Returns Array of Symbols.
+    def event_names
+      @event_names ||= @states.collect do |_, state|
+        state.events.keys
+      end.flatten.uniq
+    end
+
+    # Public: Defines states
+    #
+    # state - The name of the state
+    # block - block that is used to define events for the state.
+    #
+    # Returns Progression::Specification::State
+    def state(state, &block)
+      @states[state.to_sym] = State.new(&block)
+    end
+
+    # Public: Determine if a given state has been defined.
+    #
+    # state - The state name to check for.
+    #
+    # Returns true if defined, false if not.
+    def state?(state)
+      @states.key?(state.to_sym)
+    end
+
+    # Public: Returns the default state for the specification.
+    #
+    # Returns symbol.
+    def default_state
+      @default_state ||=
+        if options.key?(:default)
+          options[:default]
+        elsif states.any?
+          states.keys.first
+        end
+    end
+  end
+end

data/lib/progressive/state.rb

@@ -0,0 +1,48 @@
+module Progressive
+  class State < ActiveRecord::Base
+    belongs_to :subject, polymorphic: true
+
+    validates :subject_type, presence: true
+    validates :subject_id, presence: true, uniqueness: { scope: [:subject_type] }
+    validates :state, presence: true
+
+    def specification
+      @specification ||= subject.specification
+    end
+
+    def method_missing(method_sym, *args, &block)
+      if specification.state?(method_sym)
+        to(method_sym, *args)
+      elsif method_sym.to_s[-1] == '?'
+        predicate = method_sym.to_s[0..-2]
+        state == predicate
+      else
+        super
+      end
+    end
+
+    # Public: Transition from the current state to a new state.
+    #
+    # state - The event
+    #
+    # Returns nothing.
+    def to(state, options = {})
+      return false unless current_state.event?(state)
+
+      subject.run_callbacks(:progress) do
+        subject.run_callbacks(state) do
+          update_attribute(:state, state)
+        end
+      end
+    end
+
+    def current_state
+      specification.states[state.to_sym]
+    end
+
+    def to_s
+      state
+    end
+    delegate :humanize, to: :to_s
+  end
+end

data/lib/progressive/subject.rb

@@ -0,0 +1,46 @@
+require 'active_support/concern'
+require 'active_model/callbacks'
+
+module Progressive
+  module Subject
+    extend ActiveSupport::Concern
+    include ActiveModel::Callbacks
+
+    included do
+      class_attribute :specification
+
+      define_model_callbacks :progress, only: [:before, :after]
+    end
+
+    module ClassMethods
+      # Public: Define the different states and events the subject can go through.
+      #
+      # options - The Hash options used to build the specification (default: {}):
+      #           :default - The default state the subject is instantiated at (optional).
+      # block   - A required block that is used to define states and events for
+      #           the subject.
+      #
+      # Returns Progression::Specification
+      def states(options = {}, &block)
+        self.specification = Specification.new(options, &block)
+        define_model_callbacks(*specification.event_names, only: [:before, :after])
+      end
+    end
+
+    def method_missing(method_sym, *args, &block)
+      if method_sym.to_s[-1] == '?' && specification.state?(method_sym.to_s[0..-2])
+        state.send(method_sym)
+      else
+        super
+      end
+    end
+
+    def specification
+      self.class.specification
+    end
+
+    def human_state
+      state.humanize
+    end
+  end
+end

data/lib/progressive/version.rb

@@ -0,0 +1,3 @@
+module Progressive
+  VERSION = '0.0.1'.freeze
+end

data/progressive.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'progressive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'progressive'
+  spec.version       = Progressive::VERSION
+  spec.authors       = ['dewski']
+  spec.email         = ['me@garrettbjerkhoel.com']
+  spec.description   = 'A lightweight ActiveModel backed state machine.'
+  spec.summary       = 'A lightweight ActiveModel backed state machine.'
+  spec.homepage      = 'https://github.com/dewski/progressive'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '>= 3.0.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: progressive
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: A lightweight ActiveModel backed state machine.
+email:
+- me@garrettbjerkhoel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/progressive.rb
+- lib/progressive/specification.rb
+- lib/progressive/state.rb
+- lib/progressive/subject.rb
+- lib/progressive/version.rb
+- progressive.gemspec
+homepage: https://github.com/dewski/progressive
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A lightweight ActiveModel backed state machine.
+test_files: []
+has_rdoc: