active_cart 0.0.7 → 0.0.8

data/.gitignore

@@ -2,3 +2,4 @@
 pkg
 rdoc
 test/log/*.log
+coverage

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/active_cart/cart.rb

@@ -78,9 +78,16 @@ module ActiveCart
     #   @cart[0].size # => 7
     #   @cart[1].size # => 4
     #
+    # Callbacks:
+    #
+    # Calls the storage engines before_add_to_cart(item, quantity) and after_add_to_cart(item, quantity) methods (if they exist). If before_add_to_cart returns false, the add will be halted.
+    # Calls the items before_add_to_item(quantity) and after_add_to_cart(quantity) methods (if they exist). If before_add_to_cart returns false, the add will be halted.
+    #
     def add_to_cart(item, quantity = 1)
       return false unless item.before_add_to_cart(quantity) if item.respond_to?(:before_add_to_cart)
+      return false unless @storage_engine.before_add_to_cart(item, quantity) if @storage_engine.respond_to?(:before_add_to_cart)
       @storage_engine.add_to_cart(item, quantity)
+      @storage_engine.after_add_to_cart(item, quantity) if @storage_engine.respond_to?(:after_add_to_cart)
       item.after_add_to_cart(quantity) if item.respond_to?(:after_add_to_cart)
     end
 
@@ -93,9 +100,16 @@ module ActiveCart
     #   @cart.remove_from_cart(item, 2)
     #   @cart[0] # => nil
     #
+    # Callbacks:
+    #
+    # Calls the storage engines before_remove_from_cart(item, quantity) and after_remove_from_cart(item, quantity) methods (if they exist). If before_remove_from_cart returns false, the remove will be halted.
+    # Calls the items before_remove_from_item(quantity) and after_remove_from_cart(quantity) methods (if they exist). If before_remove_from_cart returns false, the remove will be halted.
+    #
     def remove_from_cart(item, quantity = 1)
       return false unless item.before_remove_from_cart(quantity) if item.respond_to?(:before_remove_from_cart)
+      return false unless @storage_engine.before_remove_from_cart(item, quantity) if @storage_engine.respond_to?(:before_remove_from_cart)
       @storage_engine.remove_from_cart(item, quantity)
+      @storage_engine.after_remove_from_cart(item, quantity) if @storage_engine.respond_to?(:after_remove_from_cart)
       item.after_remove_from_cart(quantity) if item.respond_to?(:after_remove_from_cart)
     end
     
@@ -111,29 +125,14 @@ module ActiveCart
       storage_engine.state
     end
 
-    # Transitions to the cart's :shopping state
-    def continue_shopping!
-      storage_engine.continue_shopping!
-    end
-
-    # Transitions to the cart's :checkout state
-    def checkout!
-      storage_engine.checkout!
-    end
-
-    # Transitions to the cart's :verifying_payment state
-    def check_payment!
-      storage_engine.check_payment!
-    end
-
-    # Transitions to the cart's :successful state
-    def payment_successful!
-      storage_engine.payment_successful!
-    end
-
-    # Transitions to the cart's :failed state
-    def payment_failed!
-      storage_engine.payment_failed!
+    # :nodoc
+    def method_missing(symbol, *args)
+      # This allows developers to add extra aasm event transaction, and still allow them to called from the cart
+      if @storage_engine.class.aasm_events.keys.include?(symbol.to_s[0..-2].to_sym)
+        @storage_engine.send(symbol)
+      else
+        super
+      end
     end
   end
 end

data/lib/active_cart/cart_storage.rb

@@ -15,73 +15,104 @@ module ActiveCart
   module CartStorage
     def self.included(base) #:nodoc:
       base.send :include, AASM
+
       base.aasm_initial_state :shopping
-      base.aasm_state :shopping
-      base.aasm_state :checkout
-      base.aasm_state :verifying_payment
-      base.aasm_state :completed
-      base.aasm_state :failed
+      base.aasm_state :shopping, :enter => :enter_shopping, :exit => :exit_shopping
+      base.aasm_state :checkout, :enter => :enter_checkout, :exit => :exit_checkout
+      base.aasm_state :verifying_payment, :enter => :enter_verifying_payment, :exit => :exit_verifying_payment
+      base.aasm_state :completed, :enter => :enter_completed, :ext => :exit_completed
+      base.aasm_state :failed, :enter => :enter_failed, :exit => :exit_failed
 
       base.aasm_event :continue_shopping do
-        transitions :from => [ :checkout, :verifying_payment ], :to => :shopping, :enter => :before_continue_shopping, :exit => :after_continue_shopping
+        transitions :from => [ :checkout, :verifying_payment ], :to => :shopping, :guard => :guard_continue_shopping
       end
 
       base.aasm_event :checkout do
-        transitions :from => [ :shopping, :verifying_payment ], :to => :checkout, :enter => :before_checkout, :exit => :after_checkout
+        transitions :from => [ :shopping, :verifying_payment ], :to => :checkout, :guard => :guard_checkout
       end
 
       base.aasm_event :check_payment do
-        transitions :from => :checkout, :to => :verifying_payment, :enter => :before_check_payment, :exit => :after_check_payment
+        transitions :from => :checkout, :to => :verifying_payment, :guard => :guard_check_payment
       end
 
       base.aasm_event :payment_successful do
-        transitions :from => :verifying_payment, :to => :completed, :enter => :before_payment_successful, :exit => :after_payment_successful
+        transitions :from => :verifying_payment, :to => :completed, :guard => :guard_payment_successful
       end
 
       base.aasm_event :payment_failed do
-        transitions :from => :verifying_payment, :to => :failed, :enter => :before_payment_failed, :exit => :after_payment_failed
+        transitions :from => :verifying_payment, :to => :failed, :guard => :guard_payment_failed
       end
     end
 
-    # Called before transitioning into continuing_shopping
+    # Guard continue shopping. If this method returns false, the transition will be halted
+    #
+    def guard_continue_shopping
+      true
+    end
+
+    # Guard checkout. If this method returns false, the transition will be halted
+    #
+    def guard_checkout
+      true
+    end
+    
+    # Guard check payment. If this method returns false, the transition will be halted
+    #
+    def guard_check_payment
+      true
+    end
+    
+    # Guard payment successful. If this method returns false, the transition will be halted
+    #
+    def guard_payment_successful
+      true
+    end
+    
+    # Guard payment failed. If this method returns false, the transition will be halted
+    #
+    def guard_payment_failed
+      true
+    end
+
+    # Called when entering the shopping state
     #
-    def before_continuing_shopping; end
+    def enter_shopping; end
     
-    # Called after transitioning into continuing_shopping
+    # Called when exiting the shopping state
     #
-    def after_continuing_shopping; end
+    def exit_shopping; end
 
-    # Called before transitioning into checkout
+    # Called when entering the checkout state
     #
-    def before_checkout; end
+    def enter_checkout; end
 
-    # Called after transitioning into checkout
+    # Called when existing the checkout state
     #
-    def after_checkout; end
+    def exit_checkout; end
     
-    # Called before transitioning into check_payment
+    # Called when entering the verifying_payment state
     #
-    def before_check_payment; end
+    def enter_verifying_payment; end
     
-    # Called after transitioning into check_payment
+    # Called when exiting the verifying_payment state
     #
-    def after_check_payment; end
+    def exit_verifying_payment; end
     
-    # Called before transitioning into payment_successful
+    # Called when entering the completed state
     #
-    def before_payment_successful; end
+    def enter_completed; end
     
-    # Called after transitioning into payment_successful
+    # Called when existing the completed state
     #
-    def after_payment_successful; end
+    def exit_completed; end
     
-    # Called before transitioning into failed
+    # Called when entering the failed state
     #
-    def before_payment_failed; end
+    def enter_failed; end
     
-    # Called after transitioning into failed
+    # Called when existing the failed state
     #
-    def after_payment_failed; end
+    def exit_failed; end
 
     # Returns the unique invoice_id for this cart instance. This MUST be overriden by the concrete class this module is mixed into, otherwise you
     # will get a NotImplementedError

data/test/unit/cart_storage_test.rb

@@ -14,13 +14,33 @@ class CartStorageTest < ActiveSupport::TestCase
         end
 
         should 'transition from shopping to checkout' do
+          @cart_storage_engine.expects(:exit_shopping)
+          @cart_storage_engine.expects(:enter_checkout)
+          @cart_storage_engine.expects(:guard_checkout).returns(true)
+          
           assert_nothing_raised do
             @cart_storage_engine.checkout!
           end
           assert_equal :checkout, @cart_storage_engine.state
         end
 
+        should 'not transition from shopping to checkout if guard_checkout is false' do
+          @cart_storage_engine.expects(:guard_checkout).returns(false)
+          @cart_storage_engine.expects(:exit_shopping)
+          @cart_storage_engine.expects(:enter_shopping)
+          @cart_storage_engine.expects(:enter_checkout).never
+          
+          assert_nothing_raised do
+            @cart_storage_engine.checkout!
+          end
+          assert_equal :shopping, @cart_storage_engine.state
+        end
+
         should 'transition from checkout to check_payment' do
+          @cart_storage_engine.expects(:enter_verifying_payment)
+          @cart_storage_engine.expects(:exit_checkout)
+          @cart_storage_engine.expects(:guard_check_payment).returns(true)
+          
           @cart_storage_engine.checkout!
           assert_nothing_raised do
             @cart_storage_engine.check_payment!
@@ -28,7 +48,24 @@ class CartStorageTest < ActiveSupport::TestCase
           assert_equal :verifying_payment, @cart_storage_engine.state
         end
 
+        should 'not transition from checkout to check_payment if guard_check_payment is false' do
+          @cart_storage_engine.expects(:enter_verifying_payment).never
+          @cart_storage_engine.expects(:exit_checkout)
+          @cart_storage_engine.expects(:enter_checkout)
+          @cart_storage_engine.expects(:guard_check_payment).returns(false)
+          
+          @cart_storage_engine.checkout!
+          assert_nothing_raised do
+            @cart_storage_engine.check_payment!
+          end
+          assert_equal :checkout, @cart_storage_engine.state
+        end
+
         should 'transition from verifying_payment to completed' do
+          @cart_storage_engine.expects(:enter_completed)
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:guard_payment_successful).returns(true)
+          
           @cart_storage_engine.checkout!
           @cart_storage_engine.check_payment!
           assert_nothing_raised do
@@ -37,7 +74,25 @@ class CartStorageTest < ActiveSupport::TestCase
           assert_equal :completed, @cart_storage_engine.state
         end
 
+        should 'not transition from verifying_payment to completed if guard payment_successful is false' do
+          @cart_storage_engine.expects(:enter_completed).never
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:enter_verifying_payment)
+          @cart_storage_engine.expects(:guard_payment_successful).returns(false)
+          
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.payment_successful!
+          end
+          assert_equal :verifying_payment, @cart_storage_engine.state
+        end
+
         should 'transition from verifying_payment to shopping' do
+          @cart_storage_engine.expects(:enter_shopping).twice
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:guard_continue_shopping).returns(true)
+
           @cart_storage_engine.checkout!
           @cart_storage_engine.check_payment!
           assert_nothing_raised do
@@ -46,16 +101,52 @@ class CartStorageTest < ActiveSupport::TestCase
           assert_equal :shopping, @cart_storage_engine.state
         end
 
+        should 'not transition from verifying_payment to shopping if guard_continue_shopping is false' do
+          @cart_storage_engine.expects(:enter_shopping).once
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:enter_verifying_payment)
+          @cart_storage_engine.expects(:guard_continue_shopping).returns(false)
+
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.continue_shopping!
+          end
+          assert_equal :verifying_payment, @cart_storage_engine.state
+        end
+
         should 'transition from verifying_payment to checkout' do
+          @cart_storage_engine.expects(:enter_completed)
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:guard_payment_successful).returns(true)
+          
           @cart_storage_engine.checkout!
           @cart_storage_engine.check_payment!
           assert_nothing_raised do
-            @cart_storage_engine.checkout!
+            @cart_storage_engine.payment_successful!
           end
-          assert_equal :checkout, @cart_storage_engine.state
+          assert_equal :completed, @cart_storage_engine.state
+        end
+        
+        should 'not transition from verifying_payment to checkout if guard_payment_successful is false' do
+          @cart_storage_engine.expects(:enter_completed).never
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:enter_verifying_payment)
+          @cart_storage_engine.expects(:guard_payment_successful).returns(false)
+          
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.payment_successful!
+          end
+          assert_equal :verifying_payment, @cart_storage_engine.state
         end
 
         should 'transition from verifying_payment to failed' do
+          @cart_storage_engine.expects(:enter_failed)
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:guard_payment_failed).returns(true)
+          
           @cart_storage_engine.checkout!
           @cart_storage_engine.check_payment!
           assert_nothing_raised do
@@ -63,6 +154,21 @@ class CartStorageTest < ActiveSupport::TestCase
           end
           assert_equal :failed, @cart_storage_engine.state
         end
+
+        should 'not transition from verifying_payment to failed if guard_payment_failed if false' do
+          @cart_storage_engine.expects(:enter_failed).never
+          @cart_storage_engine.expects(:exit_verifying_payment)
+          @cart_storage_engine.expects(:enter_verifying_payment)
+          @cart_storage_engine.expects(:guard_payment_failed).returns(false)
+          
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.payment_failed!
+          end
+          assert_equal :verifying_payment, @cart_storage_engine.state
+        end
+
       end
     end
 

data/test/unit/cart_test.rb

@@ -9,46 +9,92 @@ class CartTest < ActiveSupport::TestCase
       end
 
       context 'callbacks' do
-        should 'fire the item before_add_to_cart callback on add to cart' do
-          item = TestItem.new
-          item.expects(:before_add_to_cart).with(1).returns(true)
-          @cart.add_to_cart(item, 1)
-          assert_equal 1, @cart.quantity
-        end
+        context 'items' do
+          should 'fire the item before_add_to_cart callback on add to cart' do
+            item = TestItem.new
+            item.expects(:before_add_to_cart).with(1).returns(true)
+            @cart.add_to_cart(item, 1)
+            assert_equal 1, @cart.quantity
+          end
 
-        should 'halt and return false if beforee_add_to_cart returnds false' do
-          item = TestItem.new
-          item.expects(:before_add_to_cart).with(1).returns(false)
-          assert !@cart.add_to_cart(item, 1)
-          assert_equal 0, @cart.quantity
-        end
+          should 'halt and return false if beforee_add_to_cart returnds false' do
+            item = TestItem.new
+            item.expects(:before_add_to_cart).with(1).returns(false)
+            assert !@cart.add_to_cart(item, 1)
+            assert_equal 0, @cart.quantity
+          end
 
-        should 'fire the item after_add_to_cart callback' do
-          item = TestItem.new
-          item.expects(:after_add_to_cart).with(1)
-          @cart.add_to_cart(item, 1)
-        end
+          should 'fire the item after_add_to_cart callback' do
+            item = TestItem.new
+            item.expects(:after_add_to_cart).with(1)
+            @cart.add_to_cart(item, 1)
+          end
 
-        should 'fire the item before_remove_from_cart callback on add to cart' do
-          item = TestItem.new
-          item.expects(:before_remove_from_cart).with(1).returns(true)
-          @cart.remove_from_cart(item, 1)
-          assert_equal 0, @cart.quantity
-        end
+          should 'fire the item before_remove_from_cart callback on add to cart' do
+            item = TestItem.new
+            item.expects(:before_remove_from_cart).with(1).returns(true)
+            @cart.remove_from_cart(item, 1)
+            assert_equal 0, @cart.quantity
+          end
 
-        should 'halt and return false if beforee_add_to_cart returns false' do
-          item = TestItem.new
-          @cart.add_to_cart(item, 1)
-          assert_equal 1, @cart.quantity
-          item.expects(:before_remove_from_cart).with(1).returns(false)
-          assert !@cart.remove_from_cart(item, 1)
-          assert_equal 1, @cart.quantity
+          should 'halt and return false if beforee_add_to_cart returns false' do
+            item = TestItem.new
+            @cart.add_to_cart(item, 1)
+            assert_equal 1, @cart.quantity
+            item.expects(:before_remove_from_cart).with(1).returns(false)
+            assert !@cart.remove_from_cart(item, 1)
+            assert_equal 1, @cart.quantity
+          end
+
+          should 'fire the item after_remove_from_cart callback' do
+            item = TestItem.new
+            item.expects(:after_remove_from_cart).with(1)
+            @cart.remove_from_cart(item, 1)
+          end
         end
 
-        should 'fire the item after_remove_from_cart callback' do
-          item = TestItem.new
-          item.expects(:after_remove_from_cart).with(1)
-          @cart.remove_from_cart(item, 1)
+        context 'storage engines' do
+          should 'fire the storage engines before_add_to_cart callback on add to cart' do
+            item = TestItem.new
+            @cart_storage_engine.expects(:before_add_to_cart).with(item, 1).returns(true)
+            @cart.add_to_cart(item, 1)
+            assert_equal 1, @cart.quantity
+          end
+
+          should 'halt and return false if before_add_to_cart returns false' do
+            item = TestItem.new
+            @cart_storage_engine.expects(:before_add_to_cart).with(item, 1).returns(false)
+            assert !@cart.add_to_cart(item, 1)
+            assert_equal 0, @cart.quantity
+          end
+
+          should 'fire the storage engines after_add_to_cart callback' do
+            item = TestItem.new
+            @cart_storage_engine.expects(:after_add_to_cart).with(item, 1)
+            @cart.add_to_cart(item, 1)
+          end
+
+          should 'fire the storage engines before_remove_from_cart callback on add to cart' do
+            item = TestItem.new
+            @cart_storage_engine.expects(:before_remove_from_cart).with(item, 1).returns(true)
+            @cart.remove_from_cart(item, 1)
+            assert_equal 0, @cart.quantity
+          end
+
+          should 'halt and return false if beforee_add_to_cart returns false' do
+            item = TestItem.new
+            @cart.add_to_cart(item, 1)
+            assert_equal 1, @cart.quantity
+            @cart_storage_engine.expects(:before_remove_from_cart).with(item, 1).returns(false)
+            assert !@cart.remove_from_cart(item, 1)
+            assert_equal 1, @cart.quantity
+          end
+
+          should 'fire the storage engines after_remove_from_cart callback' do
+            item = TestItem.new
+            @cart_storage_engine.expects(:after_remove_from_cart).with(item, 1)
+            @cart.remove_from_cart(item, 1)
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_cart
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Myles Eftos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-01 00:00:00 +08:00
+date: 2010-03-13 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency