aasm 2.1.1 → 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/README.rdoc

@@ -25,7 +25,7 @@ The callback chain & order on a successful event looks like:
   __update state__
   event:success*
   oldstate:after_exit
-  oldstate:after_enter
+  newstate:after_enter
   event:after
   obj:aasm_event_fired*
 
@@ -36,15 +36,21 @@ The callback chain & order on a successful event looks like:
 
 The latest AASM can currently be pulled from the git repository on github.
 
-* http://github.com/ttilley/aasm/tree/master
+* http://github.com/rubyist/aasm/tree/master
 
 
 == Installation
 
-=== From GitHub hosted gems
+=== 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 ttilley-aasm
+  % sudo gem install rubyist-aasm
 
 === Building your own gems
 

data/Rakefile

@@ -1,95 +1,108 @@
-# Copyright 2008 Scott Barron (scott@elitists.net)
-# All rights reserved
-
-# This file may be distributed under an MIT style license.
-# See MIT-LICENSE for details.
+require 'rubygems'
+require 'rake'
 
 begin
-  require 'rubygems'
-  require 'rake/gempackagetask'
-  require 'rake/testtask'
-  require 'rake/rdoctask'
-  require 'spec/rake/spectask'
-rescue Exception
-  nil
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "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"]
+    gem.email = "scott@elitists.net, ttilley@gmail.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
 
-if `ruby -Ilib -raasm -e "print AASM.Version"` =~ /([0-9.]+)$/
-  CURRENT_VERSION = $1
-else
-  CURRENT_VERSION = '0.0.0'
+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
-$package_version = CURRENT_VERSION
 
-PKG_FILES = FileList['[A-Z]*',
-  'lib/**/*.rb',
-  'doc/**/*'
-]
+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
 
-desc 'Generate documentation for the acts as state machine plugin.'
-rd = Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'html'
-  rdoc.template = 'doc/jamis.rb'
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'AASM'
-  rdoc.options << '--line-numbers' << '--inline-source' <<  '--main' << 'README.rdoc' << '--title' << 'AASM'
-  rdoc.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'TODO', 'CHANGELOG')
-  rdoc.rdoc_files.include('lib/*.rb', 'lib/**/*.rb', 'doc/**/*.rdoc')
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['-cfs']
 end
 
-if !defined?(Gem)
-  puts "Package target requires RubyGEMs"
-else
-  spec = Gem::Specification.new do |s|
-    s.name = 'aasm'
-    s.version = $package_version
-    s.summary = 'State machine mixin for Ruby objects'
-    s.description = <<EOF
-AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.
-EOF
+Spec::Rake::SpecTask.new(:rcov_rspec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
 
-    s.files = PKG_FILES.to_a
-    s.require_path = 'lib'
-    s.has_rdoc = true
-    s.extra_rdoc_files = rd.rdoc_files.reject {|fn| fn =~ /\.rb$/}.to_a
-    s.rdoc_options = rd.options
+task :test => :check_dependencies
+task :spec => :check_dependencies
 
-    s.authors = ['Scott Barron', 'Scott Petersen', 'Travis Tilley']
-    s.email = 'ttilley@gmail.com'
-    s.homepage = 'http://github.com/ttilley/aasm'
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
   end
-
-  package_task = Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = true
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
   end
 end
 
-if !defined?(Spec)
-  puts "spec and cruise targets require RSpec"
-else
-  desc "Run all examples with RCov"
-  Spec::Rake::SpecTask.new('cruise') do |t|
-    t.spec_files = FileList['spec/**/*.rb']
-    t.rcov = true
-    t.rcov_opts = ['--exclude', 'spec', '--exclude', 'Library', '--exclude', 'rcov.rb']
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
   end
-
-  desc "Run all examples"
-  Spec::Rake::SpecTask.new('spec') do |t|
-    t.spec_files = FileList['spec/**/*.rb']
-    t.rcov = false
-    t.spec_opts = ['-cfs']
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
   end
 end
 
-if !defined?(Gem)
-  puts "Package target requires RubyGEMs"
-else
-  desc "sudo gem uninstall aasm && rake gem && sudo gem install pkg/aasm-3.0.0.gem"
-  task :reinstall do
-    puts `sudo gem uninstall aasm && rake gem && sudo gem install pkg/aasm-3.0.0.gem`
+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
 
-task :default => [:spec]

data/VERSION

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

data/lib/aasm/aasm.rb

@@ -4,10 +4,6 @@ require File.join(File.dirname(__FILE__), 'state_machine')
 require File.join(File.dirname(__FILE__), 'persistence')
 
 module AASM
-  def self.Version
-    '2.1.1'
-  end
-
   class InvalidTransition < RuntimeError
   end
 
@@ -88,7 +84,20 @@ module AASM
       @aasm_current_state = aasm_read_state
     end
     return @aasm_current_state if @aasm_current_state
-    aasm_determine_state_name(self.class.aasm_initial_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
@@ -101,6 +110,7 @@ module AASM
   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')
@@ -120,12 +130,12 @@ module AASM
 
   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."
+      when Symbol, String
+        state
+      when Proc
+        state.call(self)
+      else
+        raise NotImplementedError, "Unrecognized state-type given.  Expected Symbol, String, or Proc."
     end
   end
 
@@ -148,13 +158,13 @@ module AASM
 
     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)
@@ -163,7 +173,7 @@ module AASM
         self.aasm_current_state = new_state_name
       end
 
-      if persist_successful 
+      if persist_successful
         old_state.call_action(:after_exit, self)
         new_state.call_action(:after_enter, self)
         event.call_action(:after, self)

data/lib/aasm/event.rb

@@ -4,13 +4,11 @@ module AASM
   module SupportingClasses
     class Event
       attr_reader :name, :success, :options
-      
+
       def initialize(name, options = {}, &block)
         @name = name
-        @success = options[:success]
         @transitions = []
-        @options = options
-        instance_eval(&block) if block
+        update(options, &block)
       end
 
       def fire(obj, to_state=nil, *args)
@@ -37,35 +35,59 @@ module AASM
         @transitions.select { |t| t.from == state }
       end
 
-      def execute_success_callback(obj, success = nil)
-        callback = success || @success
-        case(callback)
-        when String, Symbol
-          obj.send(callback)
-        when Proc
-          callback.call(obj)
-        when Array
-          callback.each{|meth|self.execute_success_callback(obj, meth)}
-        end
+      def all_transitions
+        @transitions
       end
 
       def call_action(action, record)
         action = @options[action]
-        case action
-        when Symbol, String
-          record.send(action)
-        when Proc
-          action.call(record)
-        when Array
-          action.each { |a| record.send(a) }
+        action.is_a?(Array) ?
+                action.each {|a| _call_action(a, record)} :
+                _call_action(action, record)
+      end
+
+      def ==(event)
+        if event.is_a? Symbol
+          name == event
+        else
+          name == event.name
         end
       end
 
-      def all_transitions
-        @transitions
+      def update(options = {}, &block)
+        if options.key?(:success) then
+          @success = options[:success]
+        end
+        if block then
+          instance_eval(&block)
+        end
+        @options = options
+        self
+      end
+
+      def execute_success_callback(obj, success = nil)
+        callback = success || @success
+        case(callback)
+          when String, Symbol
+            obj.send(callback)
+          when Proc
+            callback.call(obj)
+          when Array
+            callback.each{|meth|self.execute_success_callback(obj, meth)}
+        end
       end
 
       private
+
+      def _call_action(action, record)
+        case action
+          when Symbol, String
+            record.send(action)
+          when Proc
+            action.call(record)
+        end
+      end
+
       def transitions(trans_opts)
         Array(trans_opts[:from]).each do |s|
           @transitions << SupportingClasses::StateTransition.new(trans_opts.merge({:from => s.to_sym}))

data/lib/aasm/persistence/active_record_persistence.rb

@@ -155,7 +155,7 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          send("#{self.class.aasm_column}=", self.aasm_current_state.to_s)
+          send("#{self.class.aasm_column}=", self.aasm_enter_initial_state.to_s) if send(self.class.aasm_column).blank?
         end
 
       end

data/lib/aasm/state.rb

@@ -4,7 +4,8 @@ module AASM
       attr_reader :name, :options
 
       def initialize(name, options={})
-        @name, @options = name, options
+        @name = name
+        update(options)
       end
 
       def ==(state)
@@ -17,19 +18,38 @@ module AASM
 
       def call_action(action, record)
         action = @options[action]
-        case action
-        when Symbol, String
-          record.send(action)
-        when Proc
-          action.call(record)
-        when Array
-          action.each { |a| record.send(a) }
-        end
+        action.is_a?(Array) ?
+                action.each {|a| _call_action(a, record)} :
+                _call_action(action, record)
+      end
+
+      def display_name
+        @display_name ||= name.to_s.gsub(/_/, ' ').capitalize
       end
 
       def for_select
-        [name.to_s.gsub(/_/, ' ').capitalize, name.to_s]
+        [display_name, name.to_s]
+      end
+
+      def update(options = {})
+        if options.key?(:display) then
+          @display_name = options.delete(:display)
+        end
+        @options = options
+        self
       end
+
+      private
+
+      def _call_action(action, record)
+        case action
+          when Symbol, String
+            record.send(action)
+          when Proc
+            action.call(record)
+        end
+      end
+
     end
   end
 end