cartman 1.1.1 → 2.0.0

data/README.md

@@ -25,18 +25,18 @@ Cartman has a few (read 3) configuration options you can set, most likely in an
 
 ```ruby
 # config/initializers/cartman.rb
-Cartman.config do
-  cart_expires_in 604800 # one week, in seconds.  This is the default
-  unit_cost_field :unit_cost # for cart totaling
-  quantity_field :quantity # for quantity totaling
-  redis Redis.new # set the redis connection here
+Cartman.config do |c|
+  c.cart_expires_in = 604800 # one week, in seconds.  This is the default
+  c.unit_cost_field = :unit_cost # for cart totaling
+  c.quantity_field = :quantity # for quantity totaling
+  c.redis = Redis.new # set the redis connection here
 end
 ```
 
-- The `cart_expires_in` setting will let you set how long a cart should live.  If no items are added to the cart before the time expires, the cart will be cleared.  If you want to disable cart expiration, set this to `-1`.
-- `unit_cost_field` lets you tell Cartman where you're storing the unit_cost of each item, so that you can use the `cost` method on the item, and the `total` method on `Cart`.
-- `quantity_field` lets you tell Cartman where you're storing the quantity of each item.  The `Item#cost` method uses this along with the `unit_cost` field to determine the cost.
-- `redis` lets you set the redis connection you want to use.  Note that this is not redis connection options, this is an actual instance of `Redis`.
+- The `cart_expires_in=` setting will let you set how long a cart should live.  If no items are added to the cart before the time expires, the cart will be cleared.  If you want to disable cart expiration, set this to `-1`.
+- `unit_cost_field=` lets you tell Cartman where you're storing the unit_cost of each item, so that you can use the `cost` method on the item, and the `total` method on `Cart`.
+- `quantity_field=` lets you tell Cartman where you're storing the quantity of each item.  The `Item#cost` method uses this along with the `unit_cost` field to determine the cost.
+- `redis=` lets you set the redis connection you want to use.  Note that this is not redis connection options, this is an actual instance of `Redis`.
 
 ## Usage
 

data/lib/cartman.rb

@@ -3,15 +3,11 @@ require "cartman/configuration"
 require "cartman/cart"
 require "cartman/item"
 require "cartman/item_collection"
-require 'redis'
 
 module Cartman
-  module_function
-  def config(&block)
-    if block_given?
-      @config = Configuration.new(&block)
-    else
-      @config ||= Configuration.new
-    end
+  def self.config
+    @config ||= Configuration.new
+    yield @config if block_given?
+    @config
   end
 end

data/lib/cartman/cart.rb

@@ -4,28 +4,27 @@ module Cartman
 
     def initialize(uid)
       @uid = uid
-      @@redis = Cartman::Configuration.redis
     end
 
     def add_item(options)
       raise "Must specify both :id and :type" unless options.has_key?(:id) && options.has_key?(:type)
-      line_item_id = @@redis.incr CART_LINE_ITEM_ID_KEY
-      @@redis.pipelined do
-        @@redis.mapped_hmset("cartman:line_item:#{line_item_id}", options)
-        @@redis.hincrby("cartman:line_item:#{line_item_id}", :_version, 1)
-        @@redis.sadd key, line_item_id
-        @@redis.sadd index_key, "#{options[:type]}:#{options[:id]}"
-        @@redis.set index_key_for(options), line_item_id
+      line_item_id = redis.incr CART_LINE_ITEM_ID_KEY
+      redis.pipelined do
+        redis.mapped_hmset("cartman:line_item:#{line_item_id}", options)
+        redis.hincrby("cartman:line_item:#{line_item_id}", :_version, 1)
+        redis.sadd key, line_item_id
+        redis.sadd index_key, "#{options[:type]}:#{options[:id]}"
+        redis.set index_key_for(options), line_item_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
-      @@redis.srem index_key, "#{item.type}:#{item.id}"
-      @@redis.del index_key_for(item)
+      redis.del "cartman:line_item:#{item._id}"
+      redis.srem key, item._id
+      redis.srem index_key, "#{item.type}:#{item.id}"
+      redis.del index_key_for(item)
       touch
     end
 
@@ -34,22 +33,22 @@ module Cartman
     end
 
     def contains?(object)
-      @@redis.sismember index_key, "#{object.class}:#{object.id}"
+      redis.sismember index_key, "#{object.class}:#{object.id}"
     end
 
     def find(object)
       if contains?(object)
-        get_item(@@redis.get(index_key_for(object)).to_i)
+        get_item(redis.get(index_key_for(object)).to_i)
       end
     end
 
     def count
-      @@redis.scard key
+      redis.scard key
     end
 
     def quantity
       line_item_keys.collect { |item_key|
-        @@redis.hget item_key, Cartman::Configuration.quantity_field
+        redis.hget item_key, Cartman.config.quantity_field
       }.inject(0){|sum,quantity| sum += quantity.to_i}
     end
 
@@ -60,7 +59,7 @@ module Cartman
     end
 
     def ttl
-      @@redis.ttl key
+      redis.ttl key
     end
 
     def destroy!
@@ -69,9 +68,9 @@ module Cartman
       keys << index_key
       keys << index_keys
       keys.flatten!
-      @@redis.pipelined do
+      redis.pipelined do
         keys.each do |key|
-          @@redis.del key
+          redis.del key
         end
       end
     end
@@ -79,32 +78,32 @@ module Cartman
     def touch
       keys_to_expire = line_item_keys
       keys_to_expire << key
-      if @@redis.exists index_key
+      if redis.exists index_key
         keys_to_expire << index_key
         keys_to_expire << index_keys
         keys_to_expire.flatten!
       end
-      @@redis.pipelined do
+      redis.pipelined do
         keys_to_expire.each do |item|
-          @@redis.expire item, Cartman::Configuration.cart_expires_in
+          redis.expire item, Cartman.config.cart_expires_in
         end
       end
-      @@redis.hincrby self.class.versions_key, version_key, 1
+      redis.hincrby self.class.versions_key, version_key, 1
     end
 
     def version
-      @@redis.hget(self.class.versions_key, version_key).to_i
+      redis.hget(self.class.versions_key, version_key).to_i
     end
 
     def reassign(new_id)
-      if @@redis.exists key
+      if redis.exists key
         new_index_keys = items.collect { |item|
           index_key_for(item, new_id)
         }
-        @@redis.rename key, key(new_id)
-        @@redis.rename index_key, index_key(new_id)
+        redis.rename key, key(new_id)
+        redis.rename index_key, index_key(new_id)
         index_keys.zip(new_index_keys).each do |key, value|
-          @@redis.rename key, value
+          redis.rename key, value
         end
       end
       @uid = new_id
@@ -133,7 +132,7 @@ module Cartman
     end
 
     def index_keys(id=@uid)
-      @@redis.keys "#{index_key(id)}:*"
+      redis.keys "#{index_key(id)}:*"
     end
 
     def index_key_for(object, id=@uid)
@@ -148,7 +147,7 @@ module Cartman
     end
 
     def line_item_ids
-      @@redis.smembers key
+      redis.smembers key
     end
 
     def line_item_keys
@@ -156,7 +155,13 @@ module Cartman
     end
 
     def get_item(id)
-      Item.new(id, @uid, @@redis.hgetall("cartman:line_item:#{id}").inject({}){|hash,(k,v)| hash[k.to_sym] = v; hash})
+      Item.new(id, @uid, redis.hgetall("cartman:line_item:#{id}").inject({}){|hash,(k,v)| hash[k.to_sym] = v; hash})
+    end
+
+    private
+
+    def redis
+      Cartman.config.redis
     end
   end
 end

data/lib/cartman/configuration.rb

@@ -1,34 +1,18 @@
-require 'redis'
+require "redis"
 
 module Cartman
   class Configuration
-    @@configuration = {
-      cart_expires_in: 604800, # one week
-      unit_cost_field: :unit_cost, # for cart totaling and costing
-      quantity_field: :quantity, # for cart totaling
-      redis: Redis.new, # Redis connection
-    }
+    attr_accessor :cart_expires_in, :unit_cost_field, :quantity_field
+    attr_writer :redis
 
-    def initialize(&block)
-      instance_eval &block if block_given?
+    def initialize
+      @cart_expires_in = 604800
+      @unit_cost_field = :unit_cost
+      @quantity_field = :quantity
     end
 
-    def method_missing(method, *args, &block)
-      if !args.empty?
-        @@configuration.store(method, *args)
-      else
-        @@configuration.fetch(method)
-      end
-    end
-    
-    class << self
-      def method_missing(method, *args, &block)
-        if !args.empty?
-          @@configuration.store(method, args[0])
-        else
-          @@configuration.fetch(method)
-        end
-      end
+    def redis
+      @redis ||= Redis.new
     end
   end
 end

data/lib/cartman/item.rb

@@ -11,8 +11,8 @@ module Cartman
     end
 
     def cost
-      unit_cost = (@data.fetch(Cartman::Configuration.unit_cost_field).to_f * 100).to_i
-      quantity = @data.fetch(Cartman::Configuration.quantity_field).to_i
+      unit_cost = (@data.fetch(Cartman.config.unit_cost_field).to_f * 100).to_i
+      quantity = @data.fetch(Cartman.config.quantity_field).to_i
       (unit_cost * quantity) / 100.0
     end
 
@@ -30,7 +30,7 @@ module Cartman
 
     def touch
       cart.touch
-      Cartman::Configuration.redis.hincrby _key, :_version, 1
+      redis.hincrby _key, :_version, 1
     end
 
     def _key
@@ -47,7 +47,7 @@ module Cartman
 
     def method_missing(method, *args, &block)
       if method.to_s =~ /=\z/
-        Cartman::Configuration.redis.hset _key, method[0..-2], args[0].to_s
+        redis.hset _key, method[0..-2], args[0].to_s
         @data.store(method[0..-2].to_sym, args[0].to_s)
         version = touch
         @data.store(:_version, version)
@@ -55,5 +55,11 @@ module Cartman
         @data.fetch(method)
       end
     end
+
+    private
+
+    def redis
+      Cartman.config.redis
+    end
   end
 end

data/lib/cartman/version.rb

@@ -1,3 +1,3 @@
 module Cartman
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

data/spec/cart_spec.rb

@@ -144,14 +144,14 @@ describe Cartman do
       end
 
       it "should return the sum of the defined quantity field" do
-        Cartman.config do
-          quantity_field :qty
+        Cartman.config do |c|
+          c.quantity_field = :qty
         end
         cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, qty: 2)
         cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost: 92.12, qty: 2)
         cart.quantity.should eq(4)
-        Cartman.config do
-          quantity_field :quantity
+        Cartman.config do |c|
+          c.quantity_field = :quantity
         end
       end
     end
@@ -164,14 +164,14 @@ describe Cartman do
       end
 
       it "should total whatever cost field the user sets" do
-        Cartman.config do
-          unit_cost_field :unit_cost_in_cents
+        Cartman.config do |c|
+          c.unit_cost_field = :unit_cost_in_cents
         end
         cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost_in_cents: 9212, quantity: 2)
         cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost_in_cents: 9212, quantity: 2)
         cart.total.should eq(36848)
-        Cartman.config do
-          unit_cost_field :unit_cost
+        Cartman.config do |c|
+          c.unit_cost_field = :unit_cost
         end
       end
     end
@@ -197,7 +197,7 @@ describe Cartman do
         Cartman.config.redis.ttl("cartman:cart:1:index").should eq(Cartman.config.cart_expires_in)
         Cartman.config.redis.ttl("cartman:cart:1:index:Bottle:17").should eq(Cartman.config.cart_expires_in)
       end
-      
+
       it "should record that the cart was updated" do
         cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
         cart.touch
@@ -212,9 +212,12 @@ describe Cartman do
       end
 
       it "should rename the key, and index_key if it exists" do
-        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 1)
+        cart.add_item(id: 18, type: "Bottle", name: "Merlot", unit_cost: 92.12, cost_in_cents: 18424, quantity: 3)
+        cart.quantity.should be(4)
         cart.reassign(2)
-        cart.items.size.should be(1)
+        cart.items.size.should be(2)
+        Cartman::Cart.new(2).quantity.should be(4)
         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:1:index:Bottle:17").should be_false
@@ -222,9 +225,9 @@ describe Cartman do
         Cartman.config.redis.exists("cartman:cart:2:index").should be_true
         Cartman.config.redis.exists("cartman:cart:2:index:Bottle:17").should be_true
         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.add_item(id: 19, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
         cart.reassign(1)
-        cart.items.size.should be(2)
+        cart.items.size.should be(3)
         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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cartman
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -79,18 +79,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -738931914198852373
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -738931914198852373
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -102,3 +96,4 @@ test_files:
 - spec/item_collection_spec.rb
 - spec/item_spec.rb
 - spec/spec_helper.rb
+has_rdoc: