active_cart 0.0.6 → 0.0.7

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/active_cart.rb

@@ -11,6 +11,8 @@ require 'order_total_collection'
 require 'cart'
 require 'acts_as_cart' if defined?(ActiveRecord)
 
+require 'exceptions/out_of_stock'
+
 require 'storage_engines/memory'
 require 'items/memory_item'
 

data/lib/active_cart/acts_as_cart.rb

@@ -13,10 +13,12 @@ module ActiveCart
       module ClassMethods
         # acts_as_cart - Turns an ActiveRecord model in to a cart. It can take a hash of options
         #
-        # state_column: The database column that stores the persistent state machine state. Default: state
-        # invoice_id_column: The column that stores the invoice id. Default: invoice_id
-        # cart_items: The model that represents the items for this cart. Is associated as a has_many. Default: cart_items
-        # order_totals: The model that represents order totals for this cart. It is associated as a has_many. Default: order_totals
+        #   state_column: The database column that stores the persistent state machine state. Default: state
+        #   invoice_id_column: The column that stores the invoice id. Default: invoice_id
+        #   cart_items: The model that represents the items for this cart. Is associated as a has_many. Default: cart_items
+        #   order_totals: The model that represents order totals for this cart. It is associated as a has_many. Default: order_totals
+        #
+        # Example
         #
         #   class Cart < ActiveModel::Base
         #     acts_as_cart
@@ -26,6 +28,14 @@ module ActiveCart
         #
         # You can create custom acts_as_state_machine (aasm) states and events after declaring acts_as_cart
         #
+        # NOTE: this is a STORAGE ENGINE, so you need to create it (by finding by id) then pass the result in to ActiveCart::Cart.new. It might look something like this
+        # (Most likely in ApplicationController):
+        #
+        #   if session[:cart_id]
+        #     engine = Cart.find(session[:cart_id])
+        #     @cart = ActiveCart.new(engine) if engine
+        #   end
+        #
         def acts_as_cart(options = {})
           cattr_accessor :aac_config
           
@@ -42,13 +52,46 @@ module ActiveCart
             #include AASM::Persistence::ActiveRecordPersistence
             include ActiveCart::CartStorage
 
+            #:nodoc
             def invoice_id
               read_attribute(self.aac_config[:invoice_id_column])
             end
             
+            #:nodoc
             def state
               read_attribute(self.aac_config[:state_column])
             end
+
+            #:nodoc
+            def find_cart_item(item)
+              self.send(:cart_items).find(:first, :conditions => [ 'original_id = ? AND original_type = ?', item.id, item.class.to_s ])
+            end
+
+            #:nodoc
+            def add_to_cart(item, quantity = 1)
+              cart_item = find_cart_item(item)
+              if cart_item
+                cart_item.quantity += quantity
+                cart_item.save!
+              else
+                cart_item = self.send(:cart_items).create!(self.aac_config[:cart_items].to_s.classify.constantize.new_from_item(item).attributes.merge(:quantity => quantity, :original_id => item.id, :original_type => item.class.to_s))
+              end
+              self.reload 
+            end
+
+            #:nodoc
+            def remove_from_cart(item, quantity = 1)
+              cart_item = find_cart_item(item)
+              if cart_item
+                if cart_item.quantity - quantity > 0
+                  cart_item.quantity = cart_item.quantity - quantity
+                  cart_item.save!
+                else
+                  cart_item.destroy
+                end
+              end
+              self.reload 
+            end
           end
          
           aasm_column self.aac_config[:state_column]
@@ -80,6 +123,8 @@ module ActiveCart
         # acts_as_cart uses the 'original' polymorphic attribute to store a reference to the original Item object. The compound attribute gets nullified if the original Item gets
         # deleted.
         #
+        # When adding an item to a cart, you should pass in the actual concrete item, not the cart_item - the model will take care of the conversion. 
+        #
         # For complex carts with multiple item types, you will probably need to use STI, as it's basically impossible to use a polymorphic relationship (If someone can
         # suggest a better way, I'm all ears). That said, there is no easy way to model complex carts, so I'll leave this as an exercise for the reader.
         #
@@ -132,6 +177,16 @@ module ActiveCart
               read_attribute(self.aaci_config[:price_column])
             end
           end
+          
+          # Creates a new cart_item item for the passed in concrete item
+          #
+          # The default copies all the common attributes from the passed in item to new cart_item (Except id). Override it if you want to do something special.
+          #
+          def new_from_item(item)
+            cart_item = self.new
+            item.class.columns.each { |col| cart_item.send((col.to_s + "=").to_sym, item.send(col)) if cart_item.respond_to?((col.to_s + "=").to_sym) }
+            cart_item
+          end
 
           belongs_to self.aaci_config[:cart], :foreign_key => self.aaci_config[:foreign_key]
           belongs_to :original, :polymorphic => true

data/lib/exceptions/out_of_stock.rb

@@ -0,0 +1,4 @@
+module ActiveCart
+  class OutOfStock < StandardError
+  end
+end

data/test/blueprints.rb

@@ -6,11 +6,17 @@ Cart.blueprint do
   state { 'shopping' }  
 end
 
+Item.blueprint do
+  name { Faker::Lorem.words(2).join(' ') }
+  price { (rand(9999) + 1).to_i / 100 }
+end
+
 CartItem.blueprint do
   cart { Cart.make }
   name { Faker::Lorem.words(2).join(' ') }
   quantity { rand(10).to_i }
   price { (rand(9999) + 1).to_i / 100 }
+  original { Item.make }
 end
 
 OrderTotal.blueprint do

data/test/fixtures/item.rb

@@ -0,0 +1,2 @@
+class Item < ActiveRecord::Base
+end

data/test/schema.rb

@@ -5,6 +5,11 @@ ActiveRecord::Schema.define :version => 0 do
     t.string :dummy # Not needed in real carts - used sa a dummy field for testing
   end
 
+  create_table :items, :force => true do |t|
+    t.string :name
+    t.float :price
+  end
+
   create_table :cart_items, :force => true do |t|
     t.integer :cart_id
     t.string :name

data/test/test_helper.rb

@@ -34,6 +34,7 @@ require 'active_cart/acts_as_cart'
 load(File.dirname(__FILE__) + '/schema.rb')
 
 require 'fixtures/cart'
+require 'fixtures/item'
 require 'fixtures/cart_item'
 require 'fixtures/order_total'
 require 'blueprints'

data/test/unit/acts_as_cart_test.rb

@@ -350,5 +350,114 @@ class ActsAsCartTest < ActiveSupport::TestCase
         end
       end
     end
+
+    context 'add to cart' do
+      should 'add an item to the cart if the cart is empty' do
+        assert @cart.empty?
+        item = Item.make
+        @cart.add_to_cart(item)
+        assert_equal 1, @cart.size
+        assert_equal 1, @cart[0].quantity
+        assert_equal 1, @cart.quantity
+        assert_equal CartItem, @cart[0].class
+        assert_equal item.id, @cart[0].original.id
+      end
+
+      should 'increase the item quantity if the same item is added to the cart again' do
+        assert @cart.empty?
+        item = Item.make
+        @cart.add_to_cart(item)
+        assert_equal 1, @cart.size
+        assert_equal 1, @cart[0].quantity
+
+        item_2 = Item.find(item.id) # Has the same id, is the same as item
+        @cart.add_to_cart(item_2)
+        assert_equal 1, @cart.size
+        assert_equal 2, @cart[0].quantity
+        assert_equal 2, @cart.quantity
+        assert_equal CartItem, @cart[0].class
+        assert_equal item.id, @cart[0].original.id
+      end
+
+      should 'increase the item quantity by the supplied number if the same item is add to the cart again and a quantity is supplied' do
+        assert @cart.empty?
+        item = Item.make
+        @cart.add_to_cart(item)
+        assert_equal 1, @cart.size
+        assert_equal 1, @cart[0].quantity
+
+        item_2 = Item.find(item.id) # Has the same id, is the same as item
+        @cart.add_to_cart(item_2, 10)
+        assert_equal 1, @cart.size
+        assert_equal 11, @cart[0].quantity
+        assert_equal 11, @cart.quantity
+      end
+
+      should 'add another item to the cart' do
+        assert @cart.empty?
+        item = Item.make
+        @cart.add_to_cart(item)
+        assert_equal 1, @cart.size
+        assert_equal 1, @cart[0].quantity
+
+        item_2 = Item.make
+        @cart.add_to_cart(item_2, 10)
+        assert_equal 2, @cart.size
+        assert_equal 1, @cart[0].quantity
+        assert_equal 10, @cart[1].quantity
+        assert_equal 11, @cart.quantity
+        assert_equal CartItem, @cart[0].class
+        assert_equal item.id, @cart[0].original.id
+        assert_equal CartItem, @cart[1].class
+        assert_equal item_2.id, @cart[1].original.id
+      end
+    end
+
+    context 'remove_from_cart' do
+      should 'remove the quantity supplied from the cart' do
+        item = Item.make
+        @cart.add_to_cart(item, 10)
+        assert_equal 1, @cart.size
+        assert_equal 10, @cart.quantity
+
+        @cart.remove_from_cart(item)
+        assert_equal 1, @cart.size
+        assert_equal 9, @cart.quantity
+      end
+
+      should 'remove the item from the cart if the quantity to be removed is equal to the number in cart' do
+        item = Item.make
+        @cart.add_to_cart(item, 10)
+        assert_equal 1, @cart.size
+        assert_equal 10, @cart.quantity
+
+        @cart.remove_from_cart(item, 10)
+        assert_equal 0, @cart.size
+      end
+
+      should 'remove the item from the cart if the quantity to be removed is greater than the number in cart' do
+        item = Item.make
+        @cart.add_to_cart(item, 10)
+        assert_equal 1, @cart.size
+        assert_equal 10, @cart.quantity
+
+        @cart.remove_from_cart(item, 11)
+        assert_equal 0, @cart.size
+
+        assert_not_nil Item.find(item.id)
+      end
+
+      should "simply return if the item doesn't exist in the cart" do
+        item = Item.make
+        @cart.add_to_cart(item, 10)
+        assert_equal 1, @cart.size
+        assert_equal 10, @cart.quantity
+
+        item_2 = Item.make
+        @cart.remove_from_cart(item_2, 10)
+        assert_equal 1, @cart.size
+        assert_equal 10, @cart.quantity
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_cart
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Myles Eftos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-28 00:00:00 +08:00
+date: 2010-03-01 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,9 +95,11 @@ files:
 - lib/active_cart/order_total.rb
 - lib/active_cart/order_total_collection.rb
 - lib/active_cart/storage_engines/memory.rb
+- lib/exceptions/out_of_stock.rb
 - test/blueprints.rb
 - test/fixtures/cart.rb
 - test/fixtures/cart_item.rb
+- test/fixtures/item.rb
 - test/fixtures/order_total.rb
 - test/mocks/test_cart_storage.rb
 - test/mocks/test_item.rb
@@ -152,6 +154,7 @@ test_files:
 - test/fixtures/cart_item.rb
 - test/fixtures/order_total.rb
 - test/fixtures/cart.rb
+- test/fixtures/item.rb
 - test/blueprints.rb
 - test/test_helper.rb
 - test/performance/browsing_test.rb