active_cart 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,3 @@
-active-cart.gemspec
+*.gemspec
 pkg
 rdoc

data/Rakefile

@@ -14,6 +14,7 @@ begin
     gem.homepage = "http://gemcutter.org/gems/active-cart"
     gem.authors = ["Myles Eftos"]
     gem.version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    gem.add_dependency 'aasm'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/active_cart/cart.rb

@@ -9,10 +9,19 @@ module ActiveCart
   # The Cart object delegates a number of Array methods:
   # :[], :<<, :[]=, :at, :clear, :collect, :map, :delete, :delete_at, :each, :each_index, :empty?, :eql?, :first, :include?, :index, :inject, :last, :length, :pop, :push, :shift, :size, :unshift
   #
+  # The CartEngine object uses a state machine to track the state of the cart. The default states are: shopping, checkout, verifying_payment, completed, failed. It exposed the following transitions:
+  # continue_shopping, checkout, check_payment, payment_successful, payment_failed
+  #
+  #   @cart.checkout! # transitions from shopping or verifying_payment to checkout
+  #   @cart.check_payment! # transistions from checkout to verifying_payment
+  #   @cart.payment_successful! # transitions from verifying_payment to completed
+  #   @cart.payment_failed! # transitions from verifying_payment to failed
+  #   @cart.continue_shopping # transitions from checkout or verifying_payment to shopping
+  #
   class Cart
     attr_accessor :storage_engine, :order_total_calculators, :customer
     include Enumerable
-
+    
     # The method MUST be called before you call instance, otherwise you will receive and StandardError
     # You need to supply a storage engine. An optional block can be given which allows you to add order total items.
     #
@@ -71,7 +80,9 @@ module ActiveCart
     #   @cart[1].size # => 4
     #
     def add_to_cart(item, quantity = 1)
+      return false unless item.before_add_to_cart(quantity) if item.respond_to?(:before_add_to_cart)
       @storage_engine.add_to_cart(item, quantity)
+      item.after_add_to_cart(quantity) if item.respond_to?(:after_add_to_cart)
     end
 
     # Removes an item from the cart (identified by the id of the item). If the supplied quantity is greater than equal to the number in the cart, the item will be removed, otherwise the quantity will simply be decremented by the supplied amount
@@ -84,7 +95,9 @@ module ActiveCart
     #   @cart[0] # => nil
     #
     def remove_from_cart(item, quantity = 1)
+      return false unless item.before_remove_from_cart(quantity) if item.respond_to?(:before_remove_from_cart)
       @storage_engine.remove_from_cart(item, quantity)
+      item.after_remove_from_cart(quantity) if item.respond_to?(:after_remove_from_cart)
     end
     
     # Returns the total of the cart. This includes all the order_total calculations
@@ -92,5 +105,36 @@ module ActiveCart
     def total
       sub_total + order_total_calculators.total
     end
+
+    # Returns the current state of the cart storage engine
+    #
+    def state
+      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!
+    end
   end
 end

data/lib/active_cart/cart_storage.rb

@@ -1,7 +1,109 @@
-# Mixin this module into the class you want to user as your storage class. Remember to override the invoice_id method
+# Mixin this module into the class you want to use as your storage class. Remember to override the invoice_id method
 #
 module ActiveCart
+  # The CartStorage object uses a state machine to track the state of the cart. The default states are: shopping, checkout, verifying_payment, completed, failed. It exposed the following transitions:
+  # continue_shopping, checkout, check_payment, payment_successful, payment_failed
+  #
+  #   @cart.checkout! # transitions from shopping or verifying_payment to checkout
+  #   @cart.check_payment! # transistions from checkout to verifying_payment
+  #   @cart.payment_successful! # transitions from verifying_payment to completed
+  #   @cart.payment_failed! # transitions from verifying_payment to failed
+  #   @cart.continue_shopping # transitions from checkout or verifying_payment to shopping
+  #   
+  #   It will fire before_ and after callbacks with the same name as the transitions
+  #
   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_event :continue_shopping do
+        transitions :from => [ :checkout, :verifying_payment ], :to => :shopping, :enter => :before_continue_shopping, :exit => :after_continue_shopping
+      end
+
+      base.aasm_event :checkout do
+        transitions :from => [ :shopping, :verifying_payment ], :to => :checkout, :enter => :before_checkout, :exit => :after_checkout
+      end
+
+      base.aasm_event :check_payment do
+        transitions :from => :checkout, :to => :verifying_payment, :enter => :before_check_payment, :exit => :after_check_payment
+      end
+
+      base.aasm_event :payment_successful do
+        transitions :from => :verifying_payment, :to => :completed, :enter => :before_payment_successful, :exit => :after_payment_successful
+      end
+
+      base.aasm_event :payment_failed do
+        transitions :from => :verifying_payment, :to => :failed, :enter => :before_payment_failed, :exit => :after_payment_failed
+      end
+    end
+
+    # Called before transitioning into continuing_shopping
+    #
+    def before_continuing_shopping; end
+    
+    # Called after transitioning into continuing_shopping
+    #
+    def after_continuing_shopping; end
+
+    # Called before transitioning into checkout
+    #
+    def before_checkout; end
+
+    # Called after transitioning into checkout
+    #
+    def after_checkout; end
+    
+    # Called before transitioning into check_payment
+    #
+    def before_check_payment; end
+    
+    # Called after transitioning into check_payment
+    #
+    def after_check_payment; end
+    
+    # Called before transitioning into payment_successful
+    #
+    def before_payment_successful; end
+    
+    # Called after transitioning into payment_successful
+    #
+    def after_payment_successful; end
+    
+    # Called before transitioning into failed
+    #
+    def before_payment_failed; end
+    
+    # Called after transitioning into failed
+    #
+    def after_payment_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
+    #
+    def invoice_id
+      raise NotImplementedError
+    end
+
+    # Returns the sub-total of all the items in the cart. Usually returns a float.
+    #
+    #   @cart.sub_total # => 100.00
+    #
+    def sub_total
+      inject(0) { |t, item| t + (item.quantity * item.price)  }
+    end
+
+    # Returns the number of items in the cart. It takes into account the individual quantities of each item, eg if there are 3 items in the cart, each with a quantity of 2, this will return 6
+    #
+    def quantity
+      inject(0) { |t, item| t + item.quantity }
+    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
     #
@@ -67,5 +169,9 @@ module ActiveCart
         end
       end
     end
+
+    def state
+      return aasm_current_state
+    end
   end
 end

data/lib/active_cart/item.rb

@@ -0,0 +1,36 @@
+# Mixin this module into the class you want to act as an item 
+#
+module ActiveCart
+  # 
+  module Item
+    # A unique id for the item. The Mixee needs to implement this or a NotImplementedError will be thrown
+    #
+    def id
+      raise NotImplementedError
+    end
+
+    # A display name for the item. The Mixee needs to implement this or a NotImplementedError will be thrown
+    #
+    def name
+      raise NotImplementedError
+    end
+
+    # Returns the quantity of this item in the context of a cart
+    #
+    def quantity
+      @quantity || 0
+    end
+
+    # Set the quantity of this item in the context of a cart
+    #
+    def quantity=(quantity)
+      @quantity = quantity
+    end
+
+    # Returns the price of this item
+    #
+    def price
+      raise NotImplementedError
+    end
+  end
+end

data/lib/active_cart.rb

@@ -1,7 +1,10 @@
 $:.unshift(File.join(File.dirname(__FILE__), 'active_cart'))
 
+require 'rubygems'
 require 'singleton'
 require 'forwardable'
+require 'aasm'
+require 'active_cart/item'
 require 'active_cart/cart_storage'
 require 'active_cart/order_total'
 require 'active_cart/order_total_collection'

data/test/mocks/test_item.rb

@@ -1,5 +1,7 @@
 class TestItem
-  attr_accessor :id, :price, :quantity
+  include ActiveCart::Item
+
+  attr_accessor :id
 
   def ==(item)
     self.id == item.id
@@ -7,14 +9,25 @@ class TestItem
 
   def initialize(id = 1)
     self.id = id
-    self.quantity = 0
+  end
+
+  def id
+    @id
+  end
+
+  def name
+    "Test item"
   end
 
   def price
     @price || 2
   end
 
+  def price=(price)
+    @price = price
+  end
+
   def inspect
-    "TestItem: #{self.id}: #{self.quantity}x$#{self.price}"
+    "#{name}: #{self.id}: #{self.quantity}x$#{self.price}"
   end
 end

data/test/unit/cart_storage_test.rb

@@ -7,6 +7,65 @@ class CartStorageTest < Test::Unit::TestCase
       @cart = ActiveCart::Cart.new(@cart_storage_engine)
     end
 
+    context 'states' do
+      context 'checkout' do
+        should 'default to shopping' do
+          assert_equal :shopping, @cart_storage_engine.state
+        end
+
+        should 'transition from shopping to checkout' do
+          assert_nothing_raised do
+            @cart_storage_engine.checkout!
+          end
+          assert_equal :checkout, @cart_storage_engine.state
+        end
+
+        should 'transition from checkout to check_payment' do
+          @cart_storage_engine.checkout!
+          assert_nothing_raised do
+            @cart_storage_engine.check_payment!
+          end
+          assert_equal :verifying_payment, @cart_storage_engine.state
+        end
+
+        should 'transition from verifying_payment to completed' do
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.payment_successful!
+          end
+          assert_equal :completed, @cart_storage_engine.state
+        end
+
+        should 'transition from verifying_payment to shopping' do
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.continue_shopping!
+          end
+          assert_equal :shopping, @cart_storage_engine.state
+        end
+
+        should 'transition from verifying_payment to checkout' do
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.checkout!
+          end
+          assert_equal :checkout, @cart_storage_engine.state
+        end
+
+        should 'transition from verifying_payment to failed' do
+          @cart_storage_engine.checkout!
+          @cart_storage_engine.check_payment!
+          assert_nothing_raised do
+            @cart_storage_engine.payment_failed!
+          end
+          assert_equal :failed, @cart_storage_engine.state
+        end
+      end
+    end
+
     context 'sub_total' do
       setup do
         @item_1 = TestItem.new(1)

data/test/unit/cart_test.rb

@@ -8,6 +8,50 @@ class CartTest < Test::Unit::TestCase
         @cart = ActiveCart::Cart.new(@cart_storage_engine)
       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
+
+        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 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
+        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
+
       context 'delegate to cart storage' do
         should 'delegate []' do
           @cart_storage_engine.expects(:[]).with(0)
@@ -141,6 +185,36 @@ class CartTest < Test::Unit::TestCase
           @cart_storage_engine.expects(:sub_total)
           @cart.sub_total
         end
+
+        should 'delegate :state' do
+          @cart_storage_engine.expects(:state).returns(:shopping)
+          @cart.state
+        end
+        
+        should 'delegate :continue_shopping!' do
+          @cart_storage_engine.expects(:continue_shopping!)
+          @cart.continue_shopping!
+        end
+        
+        should 'delegate :checkout!' do
+          @cart_storage_engine.expects(:checkout!)
+          @cart.checkout!
+        end
+        
+        should 'delegate :check_payment!' do
+          @cart_storage_engine.expects(:check_payment!)
+          @cart.check_payment!
+        end
+        
+        should 'delegate :payment_successful!' do
+          @cart_storage_engine.expects(:payment_successful!)
+          @cart.payment_successful!
+        end
+        
+        should 'delegate :payment_failed!' do
+          @cart_storage_engine.expects(:payment_failed!)
+          @cart.payment_failed!
+        end
       end
 
       context 'setup' do

data/test/unit/item_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class ItemTest < Test::Unit::TestCase
+  context '' do
+    should '' do
+      assert true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_cart
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Myles Eftos
@@ -11,8 +11,17 @@ cert_chain: []
 
 date: 2010-02-27 00:00:00 +08:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aasm
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: You can use active-cart as the basis of a shopping cart system. It's definately not complete, you need to build a website around it.
 email: myles@madpilot.com.au
 executables: []
@@ -32,6 +41,7 @@ files:
 - lib/active_cart.rb
 - lib/active_cart/cart.rb
 - lib/active_cart/cart_storage.rb
+- lib/active_cart/item.rb
 - lib/active_cart/order_total.rb
 - lib/active_cart/order_total_collection.rb
 - test/mocks/test_cart_storage.rb
@@ -41,6 +51,7 @@ files:
 - test/test_helper.rb
 - test/unit/cart_storage_test.rb
 - test/unit/cart_test.rb
+- test/unit/item_test.rb
 - test/unit/order_total_collection_test.rb
 - uninstall.rb
 has_rdoc: true
@@ -75,6 +86,7 @@ test_files:
 - test/unit/order_total_collection_test.rb
 - test/unit/cart_storage_test.rb
 - test/unit/cart_test.rb
+- test/unit/item_test.rb
 - test/mocks/test_cart_storage.rb
 - test/mocks/test_order_total.rb
 - test/mocks/test_item.rb