cartman 0.2.0 → 0.3.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+script: bundle exec rspec spec

data/README.md

@@ -1,4 +1,5 @@
 # Cartman
+[![Build Status](https://secure.travis-ci.org/willcosgrove/cartman.png)](http://travis-ci.org/willcosgrove/cartman)
 
 ![](http://blog.brightcove.com/sites/all/uploads/eric_theodore_cartman_southpark.jpg)
 
@@ -26,19 +27,26 @@ Cartman has a few (read 3) configuration options you can set, most likely in an
 # config/initializers/cartman.rb
 Cartman.config do
   cart_expires_in 604800 # one week, in seconds.  This is the default
-  return_items_as :openstruct # vs a :hash
   cost_field :cost # for cart totaling
+  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`.
-- `return_items_as` lets you set how you want Cartman to return your items as.  You can choose either an `OpenStruct` or a `Hash`.
 - `cost_field` lets you tell Cartman where you're storing the "cost" of each item, so that when you call `cart.total` it knows which values to sum.
 
 ## Usage
 
 To create a new shopping cart, just call `Cartman::Cart.new(user.id)`.  The parameter for `Cart.new()` is a unique id.  If you don't want a user to have more than one cart at a time, it's generally best to set this to the user's id.  Then to add an item to the cart, just call `cart.add_item(data)` which takes a hash of data that you want to store.  Then to retrieve the items, you just call `cart.items` which will give you an array of all the items they've added.
 
+The returned Items come back as `Cartman::Item` instances, which have a few special methods to be aware of:
+
+- `remove` - which will remove the item from the cart
+- `cart` - which will return the parent cart, think ActiveRecord association
+- `_id` - which will return the id of the item, if you need that for whatever reason
+- `_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`).
+
 Lets walk through an example implementation with a Rails app that has a User model and a Product model.
 
 ```ruby

data/lib/cartman.rb

@@ -1,6 +1,7 @@
 require "cartman/version"
 require "cartman/configuration"
 require "cartman/cart"
+require "cartman/item"
 require 'redis'
 require 'ostruct'
 
@@ -10,7 +11,7 @@ module Cartman
     if block_given?
       @config = Configuration.new(&block)
     else
-      @config
+      @config ||= Configuration.new
     end
   end
 end

data/lib/cartman/cart.rb

@@ -18,23 +18,22 @@ module Cartman
           @@redis.expire item, Cartman::Configuration.cart_expires_in
         end
       end
+      get_item(line_item_id)
     end
 
-    def items(return_as=Cartman::Configuration.return_items_as)
-      items = line_item_keys.collect { |item_key|
-        @@redis.hgetall(item_key).inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} # symbolize keys
+    def remove_item(item)
+      @@redis.del "cartman:line_item:#{item._id}"
+      @@redis.srem key, item._id
+    end
+
+    def items
+      items = line_item_ids.collect { |item_id|
+        get_item(item_id)
       }
-      if return_as == :openstruct
-        items.collect { |item|
-          OpenStruct.new(item)
-        }
-      else
-        items
-      end
     end
 
     def total
-      items(:openstruct).collect { |item|
+      items.collect { |item|
         (item.send(Cartman::Configuration.cost_field).to_f * 100).to_i
       }.inject{|sum,cost| sum += cost} / 100.0
     end
@@ -56,5 +55,9 @@ module Cartman
     def line_item_keys
       line_item_ids.collect{ |id| "cartman:line_item:#{id}" }
     end
+
+    def get_item(id)
+      Item.new(id, @uid, @@redis.hgetall("cartman:line_item:#{id}").inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+    end
   end
 end

data/lib/cartman/configuration.rb

@@ -1,13 +1,15 @@
+require 'redis'
+
 module Cartman
   class Configuration
     @@configuration = {
       cart_expires_in: 604800, # one week
-      return_items_as: :openstruct, # vs a :hash
       cost_field: :cost, # for cart totaling
+      redis: Redis.new, # Redis connection
     }
 
     def initialize(&block)
-      instance_eval &block
+      instance_eval &block if block_given?
     end
 
     def method_missing(method, *args, &block)

data/lib/cartman/item.rb

@@ -0,0 +1,34 @@
+module Cartman
+  class Item
+    def initialize(item_id, cart_id, data)
+      @id = item_id
+      @cart_id = cart_id
+      @data = data
+    end
+
+    def _id
+      @id
+    end
+
+    def cart
+      @cart ||= Cart.new(@cart_id)
+    end
+
+    def remove
+      cart.remove_item(self)
+    end
+
+    def _key
+      "cartman:line_item:#{@id}"
+    end
+
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /=\z/
+        Cartman::Configuration.redis.hset _key, method[0..-2], args[0].to_s
+        @data.store(method[0..-2].to_sym, args[0].to_s)
+      else
+        @data.fetch(method)
+      end
+    end
+  end
+end

data/lib/cartman/version.rb

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

data/spec/cart_spec.rb

@@ -4,12 +4,6 @@ describe Cartman do
   describe Cartman::Cart do
     let(:cart) { Cartman::Cart.new(1) }
 
-    before(:all) do
-      Cartman.config do
-        redis Redis.new
-      end
-    end
-
     before(:each) do
       Cartman.config.redis.flushdb
     end
@@ -22,7 +16,7 @@ describe Cartman do
 
     describe "#add_item" do
       before(:each) do
-        cart.add_item(id: 17, class: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
       end
 
       it "creates a line item key" do
@@ -37,29 +31,31 @@ describe Cartman do
         cart.ttl.should eq(Cartman.config.cart_expires_in)
         Cartman.config.redis.ttl("cartman:line_item:1").should eq(Cartman.config.cart_expires_in)
       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)
+      end
     end
 
-    describe "#items" do
-      before(:each) do
-        cart.add_item(id: 17, class: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
-        cart.add_item(id: 34, class: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
+    describe "#remove_item" do
+      it "should remove the id from the set, and delete the line_item key" do
+        item = cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        item_id = item._id
+        cart.remove_item(item)
+        Cartman.config.redis.sismember(cart.send(:key), item_id).should be_false
+        Cartman.config.redis.exists("cartman:line_item:#{item_id}").should be_false
       end
+    end
 
-      it "should return an array of hashes if config hashes is set" do
-        Cartman.config do
-          return_items_as :hash
-        end
-        cart.items.class.should eq(Array)
-        cart.items.first.class.should eq(Hash)
-        cart.items.size.should eq(2)
-        cart.items.first[:id].should eq("17")
+    describe "#items" do
+      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, type: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
       end
 
-      it "should return an array of openstructs if no return type is set" do
-        Cartman.config do
-          return_items_as :openstruct
-        end
-        cart.items.first.class.should eq(OpenStruct)
+      it "should return an array of Items" do
+        cart.items.first.class.should eq(Cartman::Item)
         cart.items.first.id.should eq("17")
         cart.items.first.name.should eq("Bordeux")
       end
@@ -67,8 +63,8 @@ describe Cartman do
 
     describe "#total" do
       it "should total the default costs field" do
-        cart.add_item(id: 17, class: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
-        cart.add_item(id: 34, class: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        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.total.should eq(368.48)
       end
 
@@ -76,8 +72,8 @@ describe Cartman do
         Cartman.config do
           cost_field :cost_in_cents
         end
-        cart.add_item(id: 17, class: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
-        cart.add_item(id: 34, class: "Bottle", name: "Cabernet", 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: 2)
+        cart.add_item(id: 34, type: "Bottle", name: "Cabernet", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
         cart.total.should eq(36848)
       end
     end

data/spec/item_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Cartman do
+  describe Cartman::Item do
+    let(:cart) { Cartman::Cart.new(1) }
+    let(:item) { cart.add_item(id: 17, type: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2) }
+ 
+    describe "data getters and setters" do
+      it "should let me get data stored for the item" do
+        item.id.should eq("17")
+        item.type.should eq("Bottle")
+        item.cost.should eq("184.24")
+      end
+
+      it "should let me modify data stored for the item" do
+        item.quantity.should eq("2")
+        item.quantity = 3
+        item.quantity.should eq("3")
+      end
+
+      it "should immediately save data back to redis" do
+        item.quantity.should eq("2")
+        item.quantity = 3
+        new_item = cart.send(:get_item, item._id)
+        new_item.quantity.should eq("3")
+      end
+    end
+
+    describe "#remove" do
+      it "should remove the item from the cart" do
+        item_id = item._id
+        item.remove
+        Cartman.config.redis.sismember(cart.send(:key), item_id).should be_false
+        Cartman.config.redis.exists("cartman:line_item:#{item_id}").should be_false
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cartman
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -51,6 +51,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -59,8 +60,10 @@ files:
 - lib/cartman.rb
 - lib/cartman/cart.rb
 - lib/cartman/configuration.rb
+- lib/cartman/item.rb
 - lib/cartman/version.rb
 - spec/cart_spec.rb
+- spec/item_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/willcosgrove/cartman
 licenses: []
@@ -76,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1736743105413686891
+      hash: 3094534765024072547
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1736743105413686891
+      hash: 3094534765024072547
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -94,4 +97,5 @@ specification_version: 3
 summary: Doing shopping carts like a boss since 2012
 test_files:
 - spec/cart_spec.rb
+- spec/item_spec.rb
 - spec/spec_helper.rb