fcoury-aasm 2.1.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,8 @@
+*.gemspec
+*.sw?
+*~
+.DS_Store
+.idea
+coverage
+pkg
+rdoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Scott Barron
+
+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.rdoc

@@ -0,0 +1,129 @@
+= AASM - Ruby state machines
+
+This package contains AASM, a library for adding finite state machines to Ruby classes.
+
+AASM started as the acts_as_state_machine plugin but has evolved into a more generic library that no longer targets only ActiveRecord models.
+
+AASM has the following features:
+
+* States
+* Machines
+* Events
+* Transitions
+
+== New Callbacks
+
+The callback chain & order on a successful event looks like:
+
+  oldstate:exit*
+  event:before
+  __find transition, if possible__
+  transition:on_transition*
+  oldstate:before_exit
+  newstate:before_enter
+  newstate:enter*
+  __update state__
+  event:success*
+  oldstate:after_exit
+  newstate:after_enter
+  event:after
+  obj:aasm_event_fired*
+
+  (*) marks old callbacks
+
+
+== Download
+
+The latest AASM can currently be pulled from the git repository on github.
+
+* http://github.com/rubyist/aasm/tree/master
+
+
+== Installation
+
+=== From gemcutter
+
+  % sudo gem install gemcutter
+  % sudo gem tumble
+  % sudo gem install aasm
+
+=== From GitHub hosted gems (only older releases are available)
+
+  % sudo gem sources -a http://gems.github.com # (you only need to do this once)
+  % sudo gem install rubyist-aasm
+
+=== Building your own gems
+
+  % rake gemspec
+  % rake build
+  % sudo gem install pkg/aasm-2.1.gem
+
+
+== Simple Example
+
+Here's a quick example highlighting some of the features.
+
+  class Conversation
+    include AASM
+
+    aasm_initial_state :unread
+
+    aasm_state :unread
+    aasm_state :read
+    aasm_state :closed
+
+
+    aasm_event :view do
+      transitions :to => :read, :from => [:unread]
+    end
+
+    aasm_event :close do
+      transitions :to => :closed, :from => [:read, :unread]
+    end
+  end
+
+== A Slightly More Complex Example
+
+This example uses a few of the more complex features available.
+
+  class Relationship
+    include AASM
+    
+    aasm_initial_state Proc.new { |relationship| relationship.strictly_for_fun? ? :intimate : :dating }
+    
+    aasm_state :dating,   :enter => :make_happy,        :exit => :make_depressed
+    aasm_state :intimate, :enter => :make_very_happy,   :exit => :never_speak_again
+    aasm_state :married,  :enter => :give_up_intimacy,  :exit => :buy_exotic_car_and_wear_a_combover
+    
+    aasm_event :get_intimate do
+      transitions :to => :intimate, :from => [:dating], :guard => :drunk?
+    end
+    
+    aasm_event :get_married do
+      transitions :to => :married, :from => [:dating, :intimate], :guard => :willing_to_give_up_manhood?
+    end
+    
+    def strictly_for_fun?; end
+    def drunk?; end
+    def willing_to_give_up_manhood?; end
+    def make_happy; end
+    def make_depressed; end
+    def make_very_happy; end
+    def never_speak_again; end
+    def give_up_intimacy; end
+    def buy_exotic_car_and_wear_a_combover; end
+  end
+
+= Other Stuff
+
+Author::  Scott Barron <scott at elitists dot net>
+License:: Original code Copyright 2006, 2007, 2008 by Scott Barron.
+          Released under an MIT-style license.  See the LICENSE  file
+          included in the distribution.
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fcoury-aasm"
+    gem.summary = %Q{State machine mixin for Ruby objects}
+    gem.description = %Q{AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.}
+    gem.homepage = "http://rubyist.github.com/aasm/"
+    gem.authors = ["Scott Barron", "Scott Petersen", "Travis Tilley", "FelipeCoury"]
+    gem.email = "scott@elitists.net, ttilley@gmail.com, felipe@webbynode.com"
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "shoulda"
+    gem.add_development_dependency 'sdoc'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new(:rcov_shoulda) do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['-cfs']
+end
+
+Spec::Rake::SpecTask.new(:rcov_rspec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :test => :check_dependencies
+task :spec => :check_dependencies
+
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :test
+
+begin
+  require 'rake/rdoctask'
+  require 'sdoc'
+  Rake::RDocTask.new do |rdoc|
+    if File.exist?('VERSION')
+      version = File.read('VERSION')
+    else
+      version = ""
+    end
+
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "aasm #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+
+    rdoc.options << '--fmt' << 'shtml'
+    rdoc.template = 'direct'
+  end
+rescue LoadError
+  puts "aasm makes use of the sdoc gem. Install it with: sudo gem install sdoc"
+end
+

data/VERSION

@@ -0,0 +1 @@
+2.1.3

data/lib/aasm.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'aasm', 'aasm')

data/lib/aasm/aasm.rb

@@ -0,0 +1,195 @@
+require File.join(File.dirname(__FILE__), 'event')
+require File.join(File.dirname(__FILE__), 'state')
+require File.join(File.dirname(__FILE__), 'state_machine')
+require File.join(File.dirname(__FILE__), 'persistence')
+
+module AASM
+  class InvalidTransition < RuntimeError
+  end
+
+  class UndefinedState < RuntimeError
+  end
+
+  def self.included(base) #:nodoc:
+    base.extend AASM::ClassMethods
+    AASM::Persistence.set_persistence(base)
+    unless AASM::StateMachine[base]
+      AASM::StateMachine[base] = AASM::StateMachine.new('')
+    end
+  end
+
+  module ClassMethods
+    def inherited(klass)
+      AASM::StateMachine[klass] = AASM::StateMachine[self].clone
+      super
+    end
+
+    def aasm_initial_state(set_state=nil)
+      if set_state
+        AASM::StateMachine[self].initial_state = set_state
+      else
+        AASM::StateMachine[self].initial_state
+      end
+    end
+
+    def aasm_initial_state=(state)
+      AASM::StateMachine[self].initial_state = state
+    end
+
+    def aasm_state(name, options={})
+      sm = AASM::StateMachine[self]
+      sm.create_state(name, options)
+      sm.initial_state = name unless sm.initial_state
+
+      define_method("#{name.to_s}?") do
+        aasm_current_state == name
+      end
+    end
+
+    def aasm_event(name, options = {}, &block)
+      sm = AASM::StateMachine[self]
+
+      unless sm.events.has_key?(name)
+        sm.events[name] = AASM::SupportingClasses::Event.new(name, options, &block)
+      end
+
+      define_method("#{name.to_s}!") do |*args|
+        aasm_fire_event(name, true, *args)
+      end
+
+      define_method("#{name.to_s}") do |*args|
+        aasm_fire_event(name, false, *args)
+      end
+    end
+
+    def aasm_states
+      AASM::StateMachine[self].states
+    end
+
+    def aasm_events
+      AASM::StateMachine[self].events
+    end
+
+    def aasm_states_for_select
+      AASM::StateMachine[self].states.map { |state| state.for_select }
+    end
+
+  end
+
+  # Instance methods
+  def aasm_current_state
+    return @aasm_current_state if @aasm_current_state
+
+    if self.respond_to?(:aasm_read_state) || self.private_methods.include?('aasm_read_state')
+      @aasm_current_state = aasm_read_state
+    end
+    return @aasm_current_state if @aasm_current_state
+
+    aasm_enter_initial_state
+  end
+
+  def aasm_enter_initial_state
+    state_name = aasm_determine_state_name(self.class.aasm_initial_state)
+    state = aasm_state_object_for_state(state_name)
+
+    state.call_action(:before_enter, self)
+    state.call_action(:enter, self)
+    self.aasm_current_state = state_name
+    state.call_action(:after_enter, self)
+
+    state_name
+  end
+
+  def aasm_events_for_current_state
+    aasm_events_for_state(aasm_current_state)
+  end
+
+  def aasm_events_for_state(state)
+    events = self.class.aasm_events.values.select {|event| event.transitions_from_state?(state) }
+    events.map {|event| event.name}
+  end
+
+  private
+
+  def set_aasm_current_state_with_persistence(state)
+    save_success = true
+    if self.respond_to?(:aasm_write_state) || self.private_methods.include?('aasm_write_state')
+      save_success = aasm_write_state(state)
+    end
+    self.aasm_current_state = state if save_success
+
+    save_success
+  end
+
+  def aasm_current_state=(state)
+    if self.respond_to?(:aasm_write_state_without_persistence) || self.private_methods.include?('aasm_write_state_without_persistence')
+      aasm_write_state_without_persistence(state)
+    end
+    @aasm_current_state = state
+  end
+
+  def aasm_determine_state_name(state)
+    case state
+      when Symbol, String
+        state
+      when Proc
+        state.call(self)
+      else
+        raise NotImplementedError, "Unrecognized state-type given.  Expected Symbol, String, or Proc."
+    end
+  end
+
+  def aasm_state_object_for_state(name)
+    obj = self.class.aasm_states.find {|s| s == name}
+    raise AASM::UndefinedState, "State :#{name} doesn't exist" if obj.nil?
+    obj
+  end
+
+  def aasm_fire_event(name, persist, *args)
+    old_state = aasm_state_object_for_state(aasm_current_state)
+    event = self.class.aasm_events[name]
+
+    old_state.call_action(:exit, self)
+
+    # new event before callback
+    event.call_action(:before, self)
+
+    new_state_name = event.fire(self, *args)
+
+    unless new_state_name.nil?
+      new_state = aasm_state_object_for_state(new_state_name)
+
+      # new before_ callbacks
+      old_state.call_action(:before_exit, self)
+      new_state.call_action(:before_enter, self)
+
+      new_state.call_action(:enter, self)
+
+      persist_successful = true
+      if persist
+        persist_successful = set_aasm_current_state_with_persistence(new_state_name)
+        event.execute_success_callback(self) if persist_successful
+      else
+        self.aasm_current_state = new_state_name
+      end
+
+      if persist_successful
+        old_state.call_action(:after_exit, self)
+        new_state.call_action(:after_enter, self)
+        event.call_action(:after, self)
+
+        self.aasm_event_fired(name, old_state.name, self.aasm_current_state) if self.respond_to?(:aasm_event_fired)
+      else
+        self.aasm_event_failed(name, old_state.name) if self.respond_to?(:aasm_event_failed)
+      end
+
+      persist_successful
+    else
+      if self.respond_to?(:aasm_event_failed)
+        self.aasm_event_failed(name, old_state.name)
+      end
+
+      false
+    end
+  end
+end