aasm 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d198d23fad17dc052b4135e5ef02470edd8e146
-  data.tar.gz: 85019079c1b7cfb236cf529b833561ba35030d51
+  metadata.gz: 4f80e2467a731eee5737b3c74cfb3d4236be0df5
+  data.tar.gz: 7175348561bd968b2208bb1a54b382dc4d72d2e8
 SHA512:
-  metadata.gz: c1a3a8f5df97b012148fa50b79150d218f0dad130a4014e68502a2982b98ab3a6b79148832dac285321901366ab5ec976af11a5f431966ac528d60d5c62dcc5c
-  data.tar.gz: 9e09e2ec97235c8761fd34a4c884cb6d9579e9960acf02815f472e0068586b8c4d2ff50b6d08d71f6571f31d81aa9cf345b94784d7cde1a066b1ddf0f44c466b
+  metadata.gz: 4b435f505dc2a2f30302ac902fa1264d70f8c40f5d4101ac669dc8bac1ddddc34c9b67aca1ea5c899074814a3ef8fdb272c008ed10480c156bdaacd5adcb4a77
+  data.tar.gz: 50ac955db2fda8ca2bf711f0e2dcabf648996c021bb3921ace2793cef1ea71402407e00326674505e5c5bacf35d8b3d99f09d9acb8eedd7791fc6f3d6d022b6e

data/CHANGELOG.md

@@ -5,6 +5,12 @@
  * `aasm_column` has been removed. Use `aasm.attribute_name` instead
  * `aasm_human_event_name` has been removed. Use `aasm.human_event_name` instead
 
+## 4.0.4
+
+ * corrected callback order in README
+ * bugfix: initialize the aasm state column after initialization of the _ActiveRecord_ instance (see [issue #191](https://github.com/aasm/aasm/issues/191) for details)
+ * bugfix: avoid Rails autoloading conflicts (see [issue #137](https://github.com/aasm/aasm/issues/137) and [issue #139](https://github.com/aasm/aasm/issues/139) for details)
+
 ## 4.0.3
 
  * bugfix: fire guards only once per transition, part 2 (see [issue #187](https://github.com/aasm/aasm/issues/187) for details)

data/README.md

@@ -1,9 +1,9 @@
 # AASM - Ruby state machines
 
-<a href="http://badge.fury.io/rb/aasm"><img src="https://badge.fury.io/rb/aasm@2x.png" alt="Gem Version" height="18"></a>
+[![Gem Version](https://badge.fury.io/rb/aasm.svg)](http://badge.fury.io/rb/aasm)
 [![Build Status](https://travis-ci.org/aasm/aasm.svg?branch=master)](https://travis-ci.org/aasm/aasm)
-[![Code Climate](https://codeclimate.com/github/aasm/aasm.png)](https://codeclimate.com/github/aasm/aasm)
-[![Coverage Status](https://coveralls.io/repos/aasm/aasm/badge.png?branch=master)](https://coveralls.io/r/aasm/aasm)
+[![Code Climate](https://codeclimate.com/github/aasm/aasm/badges/gpa.svg)](https://codeclimate.com/github/aasm/aasm)
+[![Coverage Status](https://img.shields.io/coveralls/aasm/aasm.svg)](https://coveralls.io/r/aasm/aasm?branch=master)
 
 This package contains AASM, a library for adding finite state machines to Ruby classes.
 
@@ -145,11 +145,11 @@ begin
   transition      guards
   old_state       before_exit
   old_state       exit
+  transition      after
   new_state       before_enter
   new_state       enter
-    ...update state...
-    transition    after
-    event         success             # if persist successful
+  ...update state...
+  event         success             # if persist successful
   old_state       after_exit
   new_state       after_enter
   event           after
@@ -172,7 +172,7 @@ Note that when passing arguments to a state transition, the first argument must
 In case of an error during the event processing the error is rescued and passed to `:error`
 callback, which can handle it or re-raise it for further propagation.
 
-During the `:on_transition` callback (and reliably only then) you can access the
+During the transition's `:after` callback (and reliably only then) you can access the
 originating state (the from-state) and the target state (the to state), like this:
 
 ```ruby

data/aasm.gemspec

@@ -13,20 +13,16 @@ Gem::Specification.new do |s|
   s.date        = Time.now
   s.licenses    = ["MIT"]
 
-  # s.add_development_dependency 'activerecord', '3.2.15'
-  # s.add_development_dependency 'activerecord', '4.0.1'
-
-  # s.add_development_dependency 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
   s.add_development_dependency 'rake'
   s.add_development_dependency 'sdoc'
-  s.add_development_dependency 'rspec', '~> 2.14'
-  s.add_development_dependency 'rr'
-  # s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rspec', '>= 2.14', '< 2.99'
+
+  # debugging
   # s.add_development_dependency 'debugger'
   # s.add_development_dependency 'pry'
 
-  s.add_development_dependency 'mime-types', '~> 1.25' # needed by coveralls (>= 2.0 needs Ruby >=1.9.2)
+  # test coverage
+  # s.add_development_dependency 'mime-types', '~> 1.25' # needed by coveralls (>= 2.0 needs Ruby >=1.9.2)
   # s.add_development_dependency 'coveralls'
 
   s.files         = `git ls-files`.split("\n")

data/lib/aasm.rb

@@ -1,17 +1,15 @@
 require 'ostruct'
 
-%w(
-    version
-    errors
-    configuration
-    base
-    dsl_helper
-    instance_base
-    transition
-    event
-    state
-    localizer
-    state_machine
-    persistence
-    aasm
-  ).each { |file| require File.join(File.dirname(__FILE__), 'aasm', file) }
+require 'aasm/version'
+require 'aasm/errors'
+require 'aasm/configuration'
+require 'aasm/base'
+require 'aasm/dsl_helper'
+require 'aasm/instance_base'
+require 'aasm/core/transition'
+require 'aasm/core/event'
+require 'aasm/core/state'
+require 'aasm/localizer'
+require 'aasm/state_machine'
+require 'aasm/persistence'
+require 'aasm/aasm'

data/lib/aasm/aasm.rb

@@ -40,24 +40,6 @@ module AASM
     @aasm ||= AASM::InstanceBase.new(self)
   end
 
-  # may be overwritten by persistence mixins
-  def aasm_read_state
-    # all the following lines behave like @current_state ||= aasm.enter_initial_state
-    current = aasm.instance_variable_get("@current_state")
-    return current if current
-    aasm.instance_variable_set("@current_state", aasm.enter_initial_state)
-  end
-
-  # may be overwritten by persistence mixins
-  def aasm_write_state(new_state)
-    true
-  end
-
-  # may be overwritten by persistence mixins
-  def aasm_write_state_without_persistence(new_state)
-    true
-  end
-
 private
 
   # Takes args and a from state and removes the first

data/lib/aasm/base.rb

@@ -67,7 +67,7 @@ module AASM
 
     # define an event
     def event(name, options={}, &block)
-      @state_machine.events[name] = AASM::Event.new(name, options, &block)
+      @state_machine.events[name] = AASM::Core::Event.new(name, options, &block)
 
       # an addition over standard aasm so that, before firing an event, you can ask
       # may_event? and get back a boolean that tells you whether the guard method

data/lib/aasm/{event.rb → core/event.rb}

@@ -1,4 +1,4 @@
-module AASM
+module AASM::Core
   class Event
     include DslHelper
 
@@ -61,11 +61,11 @@ module AASM
       if definitions # define new transitions
         # Create a separate transition for each from-state to the given state
         Array(definitions[:from]).each do |s|
-          @transitions << AASM::Transition.new(attach_event_guards(definitions.merge(:from => s.to_sym)), &block)
+          @transitions << AASM::Core::Transition.new(attach_event_guards(definitions.merge(:from => s.to_sym)), &block)
         end
         # Create a transition if :to is specified without :from (transitions from ANY state)
         if @transitions.empty? && definitions[:to]
-          @transitions << AASM::Transition.new(attach_event_guards(definitions), &block)
+          @transitions << AASM::Core::Transition.new(attach_event_guards(definitions), &block)
         end
       end
       @transitions

data/lib/aasm/{state.rb → core/state.rb}

@@ -1,4 +1,4 @@
-module AASM
+module AASM::Core
   class State
     attr_reader :name, :options
 

data/lib/aasm/{transition.rb → core/transition.rb}

@@ -1,4 +1,4 @@
-module AASM
+module AASM::Core
   class Transition
     include DslHelper
 

data/lib/aasm/persistence.rb

@@ -7,23 +7,29 @@ module AASM
         hierarchy = base.ancestors.map {|klass| klass.to_s}
 
         if hierarchy.include?("ActiveRecord::Base")
-          require_files_for(:active_record)
-          base.send(:include, AASM::Persistence::ActiveRecordPersistence)
+          include_persistence base, :active_record
         elsif hierarchy.include?("Mongoid::Document")
-          require_files_for(:mongoid)
-          base.send(:include, AASM::Persistence::MongoidPersistence)
+          include_persistence base, :mongoid
         elsif hierarchy.include?("Sequel::Model")
-          require_files_for(:sequel)
-          base.send(:include, AASM::Persistence::SequelPersistence)
+          include_persistence base, :sequel
+        else
+          include_persistence base, :plain
         end
       end
 
-    private
+      private
 
-      def require_files_for(persistence)
-        ['base', "#{persistence}_persistence"].each do |file_name|
-          require File.join(File.dirname(__FILE__), 'persistence', file_name)
-        end
+      def include_persistence(base, type)
+        require File.join(File.dirname(__FILE__), 'persistence', "#{type}_persistence")
+        base.send(:include, constantize("AASM::Persistence::#{capitalize(type)}Persistence"))
+      end
+
+      def capitalize(string_or_symbol)
+        string_or_symbol.to_s.split('_').map {|segment| segment[0].upcase + segment[1..-1]}.join('')
+      end
+
+      def constantize(string)
+        instance_eval(string)
       end
 
     end # class << self

data/lib/aasm/persistence/active_record_persistence.rb

@@ -1,3 +1,5 @@
+require_relative 'base'
+
 module AASM
   module Persistence
     module ActiveRecordPersistence
@@ -31,15 +33,10 @@ module AASM
         base.extend AASM::Persistence::ActiveRecordPersistence::ClassMethods
         base.send(:include, AASM::Persistence::ActiveRecordPersistence::InstanceMethods)
 
-        if ActiveRecord::VERSION::MAJOR >= 3
-          base.before_validation(:aasm_ensure_initial_state, :on => :create)
-        else
-          base.before_validation_on_create(:aasm_ensure_initial_state)
+        base.after_initialize do
+          aasm_ensure_initial_state
         end
 
-        # ensure initial aasm state even when validations are skipped
-        base.before_create(:aasm_ensure_initial_state)
-
         # ensure state is in the list of states
         base.validate :aasm_validate_states
       end
@@ -195,5 +192,5 @@ module AASM
       end # InstanceMethods
 
     end
-  end
-end
+  end # Persistence
+end # AASM

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -1,3 +1,5 @@
+require_relative 'base'
+
 module AASM
   module Persistence
     module MongoidPersistence
@@ -131,5 +133,5 @@ module AASM
         end
       end
     end
-  end
-end
+  end # Persistence
+end # AASM

data/lib/aasm/persistence/plain_persistence.rb

@@ -0,0 +1,24 @@
+module AASM
+  module Persistence
+    module PlainPersistence
+
+      def aasm_read_state
+        # all the following lines behave like @current_state ||= aasm.enter_initial_state
+        current = aasm.instance_variable_get("@current_state")
+        return current if current
+        aasm.instance_variable_set("@current_state", aasm.enter_initial_state)
+      end
+
+      # may be overwritten by persistence mixins
+      def aasm_write_state(new_state)
+        true
+      end
+
+      # may be overwritten by persistence mixins
+      def aasm_write_state_without_persistence(new_state)
+        true
+      end
+
+    end
+  end
+end

data/lib/aasm/persistence/sequel_persistence.rb

@@ -1,3 +1,5 @@
+require_relative 'base'
+
 module AASM
   module Persistence
     module SequelPersistence

data/lib/aasm/state_machine.rb

@@ -32,7 +32,7 @@ module AASM
       # allow reloading, extending or redefining a state
       @states.delete(name) if @states.include?(name)
 
-      @states << AASM::State.new(name, klass, options)
+      @states << AASM::Core::State.new(name, klass, options)
     end
 
     private

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.0.3"
+  VERSION = "4.0.4"
 end

data/spec/database.rb

@@ -1,10 +1,14 @@
 ActiveRecord::Migration.suppress_messages do
-  %w{gates readers writers transients simples simple_new_dsls no_scopes no_direct_assignments thieves localizer_test_models persisted_states provided_and_persisted_states}.each do |table_name|
+  %w{gates readers writers transients simples  no_scopes no_direct_assignments thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums}.each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "aasm_state"
     end
   end
 
+  ActiveRecord::Migration.create_table "simple_new_dsls", :force => true do |t|
+    t.string "status"
+  end
+
   ActiveRecord::Migration.create_table "validators", :force => true do |t|
     t.string "name"
     t.string "status"

data/spec/models/callbacks/basic.rb

@@ -0,0 +1,62 @@
+module Callbacks
+  class Basic
+    include AASM
+
+    def initialize(options={})
+      @fail_event_guard = options[:fail_event_guard]
+      @fail_transition_guard = options[:fail_transition_guard]
+      @log = options[:log]
+    end
+
+    aasm do
+      state :open, :initial => true,
+        :before_enter => :before_enter_open,
+        :enter        => :enter_open,
+        :after_enter  => :after_enter_open,
+        :before_exit  => :before_exit_open,
+        :exit         => :exit_open,
+        :after_exit   => :after_exit_open
+
+      state :closed,
+        :before_enter => :before_enter_closed,
+        :enter        => :enter_closed,
+        :after_enter  => :after_enter_closed,
+        :before_exit  => :before_exit_closed,
+        :exit         => :exit_closed,
+        :after_exit   => :after_exit_closed
+
+      event :close, :before => :before_event, :after => :after_event, :guard => :event_guard do
+        transitions :to => :closed, :from => [:open], :guard => :transition_guard, :after => :after_transition
+      end
+
+      event :open, :before => :before_event, :after => :after_event do
+        transitions :to => :open, :from => :closed
+      end
+    end
+
+    def log(text)
+      puts text if @log
+    end
+
+    def before_enter_open; log('before_enter_open'); end
+    def enter_open; log('enter_open'); end
+    def before_exit_open; log('before_exit_open'); end
+    def after_enter_open; log('after_enter_open'); end
+    def exit_open; log('exit_open'); end
+    def after_exit_open; log('after_exit_open'); end
+
+    def before_enter_closed; log('before_enter_closed'); end
+    def enter_closed; log('enter_closed'); end
+    def before_exit_closed; log('before_exit_closed'); end
+    def exit_closed; log('exit_closed'); end
+    def after_enter_closed; log('after_enter_closed'); end
+    def after_exit_closed; log('after_exit_closed'); end
+
+    def event_guard; log('event_guard'); !@fail_event_guard; end
+    def transition_guard; log('transition_guard'); !@fail_transition_guard; end
+    def after_transition; log('after_transition'); end
+
+    def before_event; log('before_event'); end
+    def after_event; log('after_event'); end
+  end
+end

data/spec/models/callbacks/guard_within_block.rb

@@ -0,0 +1,66 @@
+module Callbacks
+  class GuardWithinBlock
+    include AASM
+
+    def initialize(options={})
+      @fail_event_guard = options[:fail_event_guard]
+      @fail_transition_guard = options[:fail_transition_guard]
+      @log = options[:log]
+    end
+
+    aasm do
+      state :open, :initial => true,
+        :before_enter => :before_enter_open,
+        :enter        => :enter_open,
+        :after_enter  => :after_enter_open,
+        :before_exit  => :before_exit_open,
+        :exit         => :exit_open,
+        :after_exit   => :after_exit_open
+
+      state :closed,
+        :before_enter => :before_enter_closed,
+        :enter        => :enter_closed,
+        :after_enter  => :after_enter_closed,
+        :before_exit  => :before_exit_closed,
+        :exit         => :exit_closed,
+        :after_exit   => :after_exit_closed
+
+      event :close, :before => :before, :after => :after, :guard => :event_guard do
+        transitions :to => :closed, :from => [:open], :after => :transitioning do
+          guard do
+            transition_guard
+          end
+        end
+      end
+
+      event :open, :before => :before, :after => :after do
+        transitions :to => :open, :from => :closed
+      end
+    end
+
+    def log(text)
+      puts text if @log
+    end
+
+    def before_enter_open; log('before_enter_open'); end
+    def enter_open; log('enter_open'); end
+    def before_exit_open; log('before_exit_open'); end
+    def after_enter_open; log('after_enter_open'); end
+    def exit_open; log('exit_open'); end
+    def after_exit_open; log('after_exit_open'); end
+
+    def before_enter_closed; log('before_enter_closed'); end
+    def enter_closed; log('enter_closed'); end
+    def before_exit_closed; log('before_exit_closed'); end
+    def exit_closed; log('exit_closed'); end
+    def after_enter_closed; log('after_enter_closed'); end
+    def after_exit_closed; log('after_exit_closed'); end
+
+    def event_guard; log('event_guard'); !@fail_event_guard; end
+    def transition_guard; log('transition_guard'); !@fail_transition_guard; end
+    def transitioning; log('transitioning'); end
+
+    def before; log('before'); end
+    def after; log('after'); end
+  end
+end