cartman 0.3.0 → 0.4.0

data/README.md

@@ -28,6 +28,7 @@ Cartman has a few (read 3) configuration options you can set, most likely in an
 Cartman.config do
   cart_expires_in 604800 # one week, in seconds.  This is the default
   cost_field :cost # for cart totaling
+  quantity_field :quantity # for quantity totaling
   redis Redis.new # set the redis connection here
 end
 ```
@@ -47,6 +48,22 @@ The returned Items come back as `Cartman::Item` instances, which have a few spec
 - `_key` - which will return the redis key the data is stored in.  Probably won't need that, but it's there.
 - `#{attribute}=` - this is a setter defined for all of the items attributes that you gave it.  It will instantly save to redis also, so no need to call `save` (which is why there isn't a `save`).
 
+The `Cart` object also has some handy methods that you should be aware of:
+
+- `add_item(data)` - which is the life blood of Cartman.  This method takes a hash of data you would like to store with the item.  Here's a few suggestions of keys you may want in your hash:
+  - `:id` - to store the ID of the product you're adding
+  - `:type` - to store the class of the product you're adding.  Useful if you have multiple models that can go in the cart.
+  - `:cost` - which if you use will let you use the `Cart#total` method without any extra configuration
+  - `:quantity` - which if you use will let you use the `Cart#quantity` method without any extra configuration
+- `remove_item(item) - which, you guessed it, removes an item.  This method takes an Item object, not a hash.
+- `contains?(Product)` - This is a biggie.  It will tell you if a certain item is in the cart.  And the way it works is you pass it an object, like an instance of a Product model, and it will examine the class, and the id, and look to see if it's in the cart already.  This method only works if the `:id` and `:type` keys are set in the item's data hash.
+- `count` - which will give you the total number of items in the cart.  Faster than `cart.items.size` because it doesn't load all of the item data from redis.
+- `quantity` - which will return the total quantity of all the items.  The quantity field is set in the config block, by default it's :quantity
+- `ttl` - will tell you how many seconds until the cart expires.  It will return -1 if the cart will never expire
+- `touch` - which will reset the ttl back to whatever expiration length is set in the config.  Touch is automatically called after `add_item` and `remove_item`
+- `destroy!` - which will delete the cart, and all the line_items out of it
+- `reassign(id)` - this method will reassign the cart's unique identifier.  So to access this cart at a later time after reassigning, you would put `Cart.new(reassigned_id)`.  This is useful for having a cart for an unsigned in user.  You can use their session ID while they're unauthenticated, and then when they sign in, you can reassign the cart to the user's ID.  NOTE: Reassigning will overwrite any cart in it's way.
+
 Lets walk through an example implementation with a Rails app that has a User model and a Product model.
 
 ```ruby
@@ -58,7 +75,9 @@ class User < ActiveRecord::Base
   end
   #...
 end
+```
 
+```ruby
 # app/controllers/products_controller.rb
 class ProductsController < ApplicationController
   #...
@@ -69,8 +88,10 @@ class ProductsController < ApplicationController
   end
   #...
 end
+```
 
-# app/view/cart/show.html.haml
+```haml
+-# app/view/cart/show.html.haml
 %h1 Cart - Total: #{@cart.total}
 %ul
   - @cart.items.each do |item|

data/lib/cartman.rb

@@ -3,7 +3,6 @@ require "cartman/configuration"
 require "cartman/cart"
 require "cartman/item"
 require 'redis'
-require 'ostruct'
 
 module Cartman
   module_function

data/lib/cartman/cart.rb

@@ -11,19 +11,21 @@ module Cartman
       line_item_id = @@redis.incr CART_LINE_ITEM_ID_KEY
       @@redis.mapped_hmset("cartman:line_item:#{line_item_id}", options)
       @@redis.sadd key, line_item_id
-      keys_to_expire = line_item_keys
-      keys_to_expire << key
-      @@redis.pipelined do
-        keys_to_expire.each do |item|
-          @@redis.expire item, Cartman::Configuration.cart_expires_in
-        end
+      if options.has_key?(:id) && options.has_key?(:type)
+        @@redis.sadd index_key, "#{options[:type]}:#{options[:id]}"
       end
+      touch
       get_item(line_item_id)
     end
 
     def remove_item(item)
       @@redis.del "cartman:line_item:#{item._id}"
       @@redis.srem key, item._id
+      begin
+        @@redis.srem index_key, "#{item.type}:#{item.id}"
+      rescue KeyError
+      end
+      touch
     end
 
     def items
@@ -32,6 +34,20 @@ module Cartman
       }
     end
 
+    def contains?(object)
+      @@redis.sismember index_key, "#{object.class}:#{object.id}"
+    end
+
+    def count
+      @@redis.scard key
+    end
+
+    def quantity
+      line_item_keys.collect { |item_key|
+        @@redis.hget item_key, Cartman::Configuration.quantity_field
+      }.inject(0){|sum,quantity| sum += quantity.to_i}
+    end
+
     def total
       items.collect { |item|
         (item.send(Cartman::Configuration.cost_field).to_f * 100).to_i
@@ -42,10 +58,46 @@ module Cartman
       @@redis.ttl key
     end
 
+    def destroy!
+      keys = line_item_keys
+      keys << key
+      keys << index_key
+      @@redis.pipelined do
+        keys.each do |key|
+          @@redis.del key
+        end
+      end
+    end
+
+    def touch
+      keys_to_expire = line_item_keys
+      keys_to_expire << key
+      keys_to_expire << index_key
+      @@redis.pipelined do
+        keys_to_expire.each do |item|
+          @@redis.expire item, Cartman::Configuration.cart_expires_in
+        end
+      end
+    end
+
+    def reassign(new_id)
+      if @@redis.exists key
+        @@redis.rename key, key(new_id)
+      end
+      if @@redis.exists index_key
+        @@redis.rename index_key, index_key(new_id)
+      end
+      @uid = new_id
+    end
+
     private
 
-    def key
-      "cartman:cart:#{@uid}"
+    def key(id=@uid)
+      "cartman:cart:#{id}"
+    end
+
+    def index_key(id=@uid)
+      key(id) + ":index"
     end
 
     def line_item_ids

data/lib/cartman/configuration.rb

@@ -5,6 +5,7 @@ module Cartman
     @@configuration = {
       cart_expires_in: 604800, # one week
       cost_field: :cost, # for cart totaling
+      quantity_field: :quantity, # for cart totaling
       redis: Redis.new, # Redis connection
     }
 

data/lib/cartman/version.rb

@@ -1,3 +1,3 @@
 module Cartman
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/cart_spec.rb

@@ -32,6 +32,17 @@ describe Cartman do
         Cartman.config.redis.ttl("cartman:line_item:1").should eq(Cartman.config.cart_expires_in)
       end
 
+      it "should add an index key to be able to look up by type and ID" do
+        Cartman.config.redis.exists("cartman:cart:1:index").should be_true
+        Cartman.config.redis.sismember("cartman:cart:1:index", "Bottle:17").should be_true
+      end
+
+      it "should not add an index key if type and ID are not set" do
+        cart.add_item(id: 18, name: "Cordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        Cartman.config.redis.sismember("cartman:cart:1:index", "Bottle:18").should be_false
+        Cartman.config.redis.scard("cartman:cart:1:index").should eq(1)
+      end
+
       it "should return an Item" do
         item = cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
         item.class.should eq(Cartman::Item)
@@ -61,6 +72,57 @@ describe Cartman do
       end
     end
 
+    describe "#contains?(item)" do
+      before(:all) do
+        Bottle = Struct.new(:id)
+      end
+
+      before(:each) do
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.add_item(id: 34, name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
+      end
+
+      it "should be able to tell you that an item in the cart is present" do
+        cart.contains?(Bottle.new(17)).should be_true
+      end
+
+      it "should be able to tell you that an item in the cart is absent" do
+        cart.contains?(Bottle.new(20)).should be_false
+      end
+
+      it "should be able to tell you that an item in the cart is absent if it's been removed" do
+        cart.remove_item(cart.items.first)
+        cart.contains?(Bottle.new(17)).should be_false
+        cart.remove_item(cart.items.last)
+        cart.contains?(Bottle.new(34)).should be_false
+      end
+    end
+
+    describe "#count" do
+      it "should return the number of items in the cart" do
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.count.should eq(2)
+      end
+    end
+
+    describe "#quantity" do
+      it "should return the sum of the default quantity field" do
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.quantity.should eq(4)
+      end
+
+      it "should return the sum of the defined quantity field" do
+        Cartman.config do
+          quantity_field :qty
+        end
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, qty: 2)
+        cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, qty: 2)
+        cart.quantity.should eq(4)
+      end
+    end
+
     describe "#total" do
       it "should total the default costs field" do
         cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
@@ -77,5 +139,49 @@ describe Cartman do
         cart.total.should eq(36848)
       end
     end
+
+    describe "#destroy" do
+      it "should delete the line_item keys, the index key, and the cart key" do
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.destroy!
+        Cartman.config.redis.exists("cartman:cart:1").should be_false
+        Cartman.config.redis.exists("cartman:line_item:1").should be_false
+        Cartman.config.redis.exists("cartman:line_item:2").should be_false
+        Cartman.config.redis.exists("cartman:cart:1:index").should be_false
+      end
+    end
+
+    describe "#touch" do
+      it "should reset the TTL" do
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.touch
+        cart.ttl.should eq(Cartman.config.cart_expires_in)
+      end
+    end
+
+    describe "#reassign" do
+      it "should only change the @uid if no key exists" do
+        cart.reassign(2)
+        cart.send(:key)[-1].should eq("2")
+      end
+
+      it "should rename the key, and index_key if it exists" do
+        cart.add_item(id: 17, name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.reassign(2)
+        Cartman.config.redis.exists("cartman:cart:1").should be_false
+        Cartman.config.redis.exists("cartman:cart:1:index").should be_false
+        Cartman.config.redis.exists("cartman:cart:2").should be_true
+        Cartman.config.redis.exists("cartman:cart:2:index").should be_false
+        cart.send(:key)[-1].should eq("2")
+        cart.add_item(id: 18, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.reassign(1)
+        Cartman.config.redis.exists("cartman:cart:2").should be_false
+        Cartman.config.redis.exists("cartman:cart:2:index").should be_false
+        Cartman.config.redis.exists("cartman:cart:1").should be_true
+        Cartman.config.redis.exists("cartman:cart:1:index").should be_true
+        cart.send(:key)[-1].should eq("1")
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cartman
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -79,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3094534765024072547
+      hash: 1475251034207197325
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3094534765024072547
+      hash: 1475251034207197325
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23