enum_state_machine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d195b0469b462e5fdb5257d7c552159dd81b9584
+  data.tar.gz: 9823967bda0300a02fad53e1b4db6e70b39f2cc6
+SHA512:
+  metadata.gz: 0f8186afaf20c300450f3c494d069772b3fd2ba9282db5f386f651d3ac118d9a504eaa45662d66a4e5a2b9d61e26daeaf046547a2ffea7272dc0cbb7023d99bc
+  data.tar.gz: 1c6b94a1e170edeaa89af462f41df0b1665adf12d23730825b325cab3262f7a5f7ca45562c0bd2092aa27d43589d3353558786bed07f3f49d4c3d542ffa1b7aa

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle/
+.idea/
+.rbx/
+.yardoc/
+coverage/
+/doc/
+test/*.log
+/Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.0.0@enum_state_machine --create

data/Appraisals

@@ -0,0 +1,28 @@
+appraise "default" do
+end
+
+# GraphViz
+appraise "graphviz_1.0.9" do
+  gem "ruby-graphviz", "~> 1.0.9"
+end
+
+# ActiveRecord integrations
+if RUBY_VERSION > "1.9.2"
+  appraise "active_record_4.0.4" do
+    gem "sqlite3", "~> 1.3.9"
+    gem "activerecord", "~> 4.0.4"
+    gem "activerecord-deprecated_finders", "~> 1.0.3"
+    gem "protected_attributes", "~> 1.0.7"
+    gem "rails-observers", "~> 0.1.2"
+  end
+end
+
+# ActiveModel integrations
+if RUBY_VERSION > "1.9.2"
+  appraise "active_model_4.0.4" do
+    gem "activemodel", "~> 4.0.4"
+    gem "rails-observers", "~> 0.1.2"
+    gem "protected_attributes", "~> 1.0.7"
+  end
+end
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://www.rubygems.org"
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2006-2012 Aaron Pfeifer
+PowerEnum integration Copyright (c) 2014 Horns and Hooves team.
+
+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,4 @@
+##enum_state_machine
+==================
+
+state_machine patches to use PowerEnum enums for state values.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rake'
+require 'rake/testtask'
+
+require 'appraisal'
+
+desc 'Default: run all tests.'
+task :default => :test
+
+desc "Test enum_state_machine."
+Rake::TestTask.new(:test) do |t|
+  integration = %w(active_model active_record).detect do |name|
+    Bundler.default_gemfile.to_s.include?(name)
+  end
+  
+  t.libs << 'lib'
+  t.test_files = integration ? Dir["test/unit/integrations/#{integration}_test.rb"] : Dir['test/{functional,unit}/*_test.rb'] + ['test/unit/integrations/base_test.rb']
+  t.verbose = true
+  t.warning = true if ENV['WARNINGS']
+end
+
+namespace :appraisal do
+  desc "Run the given task for a particular integration's appraisals"
+  task :integration do
+    integration = ENV['INTEGRATION']
+
+    Appraisal::File.each do |appraisal|
+      if appraisal.name.include?(integration)
+        appraisal.install
+        Appraisal::Command.from_args(appraisal.gemfile_path).run
+      end
+    end
+
+    exit
+  end
+end
+
+load File.dirname(__FILE__) + '/lib/tasks/enum_state_machine.rake'
+
+Bundler::GemHelper.install_tasks

data/enum_state_machine.gemspec

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'enum_state_machine/version'
+
+Gem::Specification.new do |s|
+  s.name              = "enum_state_machine"
+  s.version           = EnumStateMachine::VERSION
+  s.authors           = ["The HornsAndHooves Team"]
+  s.email             = ["arthur.shagall@gmail.com"]
+  s.homepage          = "https://github.com/HornsAndHooves/enum_state_machine"
+  s.description       = "Adds support for creating enum  state machines for attributes on any Ruby class"
+  s.summary           = "Enum State machines for attributes"
+  s.require_paths     = ["lib"]
+  ignores             = File.read(".gitignore").split.map {|i| i.sub(/\/$/, "/*").sub(/^[^\/]/, "**/\\0")}
+  s.files             = (Dir[".*"] + Dir["**/*"]).select {|f| File.file?(f) && !ignores.any? {|i| File.fnmatch(i, "/#{f}")}}
+  s.test_files        = s.files.grep(/^test\//)
+  s.rdoc_options      = %w(--line-numbers --inline-source --title enum_state_machine --main README.md)
+  s.extra_rdoc_files  = %w(README.md CHANGELOG.md LICENSE)
+  s.license           = 'MIT'
+
+  s.add_dependency("power_enum", "~> 2.4")
+  
+  s.add_development_dependency("rake")
+  s.add_development_dependency("simplecov")
+  s.add_development_dependency("appraisal", "~> 0.5.0")
+end

data/gemfiles/active_model_4.0.4.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://www.rubygems.org"
+
+gem "activemodel", "~> 4.0.4"
+gem "rails-observers", "~> 0.1.2"
+gem "protected_attributes", "~> 1.0.7"
+
+gemspec :path=>"../"

data/gemfiles/active_model_4.0.4.gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: ../
+  specs:
+    enum_state_machine (1.2.0)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    activemodel (4.0.4)
+      activesupport (= 4.0.4)
+      builder (~> 3.1.0)
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (0.5.2)
+      bundler
+      rake
+    atomic (1.1.16)
+    builder (3.1.4)
+    docile (1.1.3)
+    i18n (0.6.9)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    protected_attributes (1.0.7)
+      activemodel (>= 4.0.1, < 5.0)
+    rails-observers (0.1.2)
+      activemodel (~> 4.0)
+    rake (10.2.2)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.1)
+      atomic (>= 1.1.7, < 2)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 4.0.4)
+  appraisal (~> 0.5.0)
+  enum_state_machine!
+  protected_attributes (~> 1.0.7)
+  rails-observers (~> 0.1.2)
+  rake
+  simplecov

data/gemfiles/active_record_4.0.4.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://www.rubygems.org"
+
+gem "sqlite3", "~> 1.3.9"
+gem "activerecord", "~> 4.0.4"
+gem "activerecord-deprecated_finders", "~> 1.0.3"
+gem "protected_attributes", "~> 1.0.7"
+gem "rails-observers", "~> 0.1.2"
+
+gemspec :path=>"../"

data/gemfiles/active_record_4.0.4.gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: ../
+  specs:
+    enum_state_machine (1.2.0)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    activemodel (4.0.4)
+      activesupport (= 4.0.4)
+      builder (~> 3.1.0)
+    activerecord (4.0.4)
+      activemodel (= 4.0.4)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.4)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (0.5.2)
+      bundler
+      rake
+    arel (4.0.2)
+    atomic (1.1.16)
+    builder (3.1.4)
+    docile (1.1.3)
+    i18n (0.6.9)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    protected_attributes (1.0.7)
+      activemodel (>= 4.0.1, < 5.0)
+    rails-observers (0.1.2)
+      activemodel (~> 4.0)
+    rake (10.2.2)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sqlite3 (1.3.9)
+    thread_safe (0.3.1)
+      atomic (>= 1.1.7, < 2)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.0.4)
+  activerecord-deprecated_finders (~> 1.0.3)
+  appraisal (~> 0.5.0)
+  enum_state_machine!
+  protected_attributes (~> 1.0.7)
+  rails-observers (~> 0.1.2)
+  rake
+  simplecov
+  sqlite3 (~> 1.3.9)

data/gemfiles/default.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://www.rubygems.org"
+
+
+
+gemspec :path=>"../"

data/gemfiles/default.gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: ../
+  specs:
+    enum_state_machine (1.2.0)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.0)
+  enum_state_machine!
+  rake
+  simplecov

data/gemfiles/graphviz_1.0.9.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://www.rubygems.org"
+
+gem "ruby-graphviz", "~> 1.0.9"
+
+gemspec :path=>"../"

data/gemfiles/graphviz_1.0.9.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: ../
+  specs:
+    enum_state_machine (1.2.0)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    appraisal (0.5.2)
+      bundler
+      rake
+    docile (1.1.3)
+    multi_json (1.9.2)
+    rake (10.2.2)
+    ruby-graphviz (1.0.9)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.0)
+  enum_state_machine!
+  rake
+  ruby-graphviz (~> 1.0.9)
+  simplecov

data/lib/enum_state_machine/assertions.rb

@@ -0,0 +1,36 @@
+module EnumStateMachine
+  # Provides a set of helper methods for making assertions about the content
+  # of various objects
+  module Assertions
+    # Validates that the given hash *only* includes the specified valid keys.
+    # If any invalid keys are found, an ArgumentError will be raised.
+    #
+    # == Examples
+    # 
+    #   options = {:name => 'John Smith', :age => 30}
+    #   
+    #   assert_valid_keys(options, :name)           # => ArgumentError: Invalid key(s): age
+    #   assert_valid_keys(options, 'name', 'age')   # => ArgumentError: Invalid key(s): age, name
+    #   assert_valid_keys(options, :name, :age)     # => nil
+    def assert_valid_keys(hash, *valid_keys)
+      invalid_keys = hash.keys - valid_keys
+      raise ArgumentError, "Invalid key(s): #{invalid_keys.join(', ')}" unless invalid_keys.empty?
+    end
+    
+    # Validates that the given hash only includes at *most* one of a set of
+    # exclusive keys.  If more than one key is found, an ArgumentError will be
+    # raised.
+    # 
+    # == Examples
+    # 
+    #   options = {:only => :on, :except => :off}
+    #   assert_exclusive_keys(options, :only)                   # => nil
+    #   assert_exclusive_keys(options, :except)                 # => nil
+    #   assert_exclusive_keys(options, :only, :except)          # => ArgumentError: Conflicting keys: only, except
+    #   assert_exclusive_keys(options, :only, :except, :with)   # => ArgumentError: Conflicting keys: only, except
+    def assert_exclusive_keys(hash, *exclusive_keys)
+      conflicting_keys = exclusive_keys & hash.keys
+      raise ArgumentError, "Conflicting keys: #{conflicting_keys.join(', ')}" unless conflicting_keys.length <= 1
+    end
+  end
+end

data/lib/enum_state_machine/branch.rb

@@ -0,0 +1,225 @@
+require 'enum_state_machine/matcher'
+require 'enum_state_machine/eval_helpers'
+require 'enum_state_machine/assertions'
+
+module EnumStateMachine
+  # Represents a set of requirements that must be met in order for a transition
+  # or callback to occur.  Branches verify that the event, from state, and to
+  # state of the transition match, in addition to if/unless conditionals for
+  # an object's state.
+  class Branch
+    include Assertions
+    include EvalHelpers
+    
+    # The condition that must be met on an object
+    attr_reader :if_condition
+    
+    # The condition that must *not* be met on an object
+    attr_reader :unless_condition
+    
+    # The requirement for verifying the event being matched
+    attr_reader :event_requirement
+    
+    # One or more requirements for verifying the states being matched.  All
+    # requirements contain a mapping of {:from => matcher, :to => matcher}.
+    attr_reader :state_requirements
+    
+    # A list of all of the states known to this branch.  This will pull states
+    # from the following options (in the same order):
+    # * +from+ / +except_from+
+    # * +to+ / +except_to+
+    attr_reader :known_states
+    
+    # Creates a new branch
+    def initialize(options = {}) #:nodoc:
+      # Build conditionals
+      @if_condition = options.delete(:if)
+      @unless_condition = options.delete(:unless)
+      
+      # Build event requirement
+      @event_requirement = build_matcher(options, :on, :except_on)
+      
+      if (options.keys - [:from, :to, :on, :except_from, :except_to, :except_on]).empty?
+        # Explicit from/to requirements specified
+        @state_requirements = [{:from => build_matcher(options, :from, :except_from), :to => build_matcher(options, :to, :except_to)}]
+      else
+        # Separate out the event requirement
+        options.delete(:on)
+        options.delete(:except_on)
+        
+        # Implicit from/to requirements specified
+        @state_requirements = options.collect do |from, to|
+          from = WhitelistMatcher.new(from) unless from.is_a?(Matcher)
+          to = WhitelistMatcher.new(to) unless to.is_a?(Matcher)
+          {:from => from, :to => to}
+        end
+      end
+      
+      # Track known states.  The order that requirements are iterated is based
+      # on the priority in which tracked states should be added.
+      @known_states = []
+      @state_requirements.each do |state_requirement|
+        [:from, :to].each {|option| @known_states |= state_requirement[option].values}
+      end
+    end
+    
+    # Determines whether the given object / query matches the requirements
+    # configured for this branch.  In addition to matching the event, from state,
+    # and to state, this will also check whether the configured :if/:unless
+    # conditions pass on the given object.
+    # 
+    # == Examples
+    # 
+    #   branch = EnumStateMachine::Branch.new(:parked => :idling, :on => :ignite)
+    #   
+    #   # Successful
+    #   branch.matches?(object, :on => :ignite)                                   # => true
+    #   branch.matches?(object, :from => nil)                                     # => true
+    #   branch.matches?(object, :from => :parked)                                 # => true
+    #   branch.matches?(object, :to => :idling)                                   # => true
+    #   branch.matches?(object, :from => :parked, :to => :idling)                 # => true
+    #   branch.matches?(object, :on => :ignite, :from => :parked, :to => :idling) # => true
+    #   
+    #   # Unsuccessful
+    #   branch.matches?(object, :on => :park)                                     # => false
+    #   branch.matches?(object, :from => :idling)                                 # => false
+    #   branch.matches?(object, :to => :first_gear)                               # => false
+    #   branch.matches?(object, :from => :parked, :to => :first_gear)             # => false
+    #   branch.matches?(object, :on => :park, :from => :parked, :to => :idling)   # => false
+    def matches?(object, query = {})
+      !match(object, query).nil?
+    end
+    
+    # Attempts to match the given object / query against the set of requirements
+    # configured for this branch.  In addition to matching the event, from state,
+    # and to state, this will also check whether the configured :if/:unless
+    # conditions pass on the given object.
+    # 
+    # If a match is found, then the event/state requirements that the query
+    # passed successfully will be returned.  Otherwise, nil is returned if there
+    # was no match.
+    # 
+    # Query options:
+    # * <tt>:from</tt> - One or more states being transitioned from.  If none
+    #   are specified, then this will always match.
+    # * <tt>:to</tt> - One or more states being transitioned to.  If none are
+    #   specified, then this will always match.
+    # * <tt>:on</tt> - One or more events that fired the transition.  If none
+    #   are specified, then this will always match.
+    # * <tt>:guard</tt> - Whether to guard matches with the if/unless
+    #   conditionals defined for this branch.  Default is true.
+    # 
+    # == Examples
+    # 
+    #   branch = EnumStateMachine::Branch.new(:parked => :idling, :on => :ignite)
+    #   
+    #   branch.match(object, :on => :ignite)  # => {:to => ..., :from => ..., :on => ...}
+    #   branch.match(object, :on => :park)    # => nil
+    def match(object, query = {})
+      assert_valid_keys(query, :from, :to, :on, :guard)
+      
+      if (match = match_query(query)) && matches_conditions?(object, query)
+        match
+      end
+    end
+    
+    # Draws a representation of this branch on the given graph.  This will draw
+    # an edge between every state this branch matches *from* to either the
+    # configured to state or, if none specified, then a loopback to the from
+    # state.
+    # 
+    # For example, if the following from states are configured:
+    # * +idling+
+    # * +first_gear+
+    # * +backing_up+
+    # 
+    # ...and the to state is +parked+, then the following edges will be created:
+    # * +idling+      -> +parked+
+    # * +first_gear+  -> +parked+
+    # * +backing_up+  -> +parked+
+    # 
+    # Each edge will be labeled with the name of the event that would cause the
+    # transition.
+    def draw(graph, event, valid_states)
+      state_requirements.each do |state_requirement|
+        # From states determined based on the known valid states
+        from_states = state_requirement[:from].filter(valid_states)
+        
+        # If a to state is not specified, then it's a loopback and each from
+        # state maps back to itself
+        if state_requirement[:to].values.empty?
+          loopback = true
+        else
+          to_state = state_requirement[:to].values.first
+          to_state = to_state ? to_state.to_s : 'nil'
+          loopback = false
+        end
+        
+        # Generate an edge between each from and to state
+        from_states.each do |from_state|
+          from_state = from_state ? from_state.to_s : 'nil'
+          graph.add_edges(from_state, loopback ? from_state : to_state, :label => event.to_s)
+        end
+      end
+      
+      true
+    end
+    
+    protected
+      # Builds a matcher strategy to use for the given options.  If neither a
+      # whitelist nor a blacklist option is specified, then an AllMatcher is
+      # built.
+      def build_matcher(options, whitelist_option, blacklist_option)
+        assert_exclusive_keys(options, whitelist_option, blacklist_option)
+        
+        if options.include?(whitelist_option)
+          value = options[whitelist_option]
+          value.is_a?(Matcher) ? value : WhitelistMatcher.new(options[whitelist_option])
+        elsif options.include?(blacklist_option)
+          value = options[blacklist_option]
+          raise ArgumentError, ":#{blacklist_option} option cannot use matchers; use :#{whitelist_option} instead" if value.is_a?(Matcher)
+          BlacklistMatcher.new(value)
+        else
+          AllMatcher.instance
+        end
+      end
+      
+      # Verifies that all configured requirements (event and state) match the
+      # given query.  If a match is found, then a hash containing the
+      # event/state requirements that passed will be returned; otherwise, nil.
+      def match_query(query)
+        query ||= {}
+        
+        if match_event(query) && (state_requirement = match_states(query))
+          state_requirement.merge(:on => event_requirement)
+        end
+      end
+      
+      # Verifies that the event requirement matches the given query
+      def match_event(query)
+        matches_requirement?(query, :on, event_requirement)
+      end
+      
+      # Verifies that the state requirements match the given query.  If a
+      # matching requirement is found, then it is returned.
+      def match_states(query)
+        state_requirements.detect do |state_requirement|
+          [:from, :to].all? {|option| matches_requirement?(query, option, state_requirement[option])}
+        end
+      end
+      
+      # Verifies that an option in the given query matches the values required
+      # for that option
+      def matches_requirement?(query, option, requirement)
+        !query.include?(option) || requirement.matches?(query[option], query)
+      end
+      
+      # Verifies that the conditionals for this branch evaluate to true for the
+      # given object
+      def matches_conditions?(object, query)
+        query[:guard] == false ||
+        Array(if_condition).all? {|condition| evaluate_method(object, condition)} &&
+        !Array(unless_condition).any? {|condition| evaluate_method(object, condition)}
+      end
+  end
+end