shop_bunny 0.8.5 → 0.8.6

data/README

@@ -0,0 +1,18 @@
+ShopBunny doesn't taste like chicken.
+
+=== Installation
+1. Running the generator
+  Currently ShopBunny needs a "Cart" model in the host application.
+  You can install both plus all necessary migrations and an initializerusing the generator:
+    rails generate shop_bunny:install
+
+2. Mounting the app
+  Add this to your routes file:
+    mount ShopBunny::Engine => '/'
+  You can access the shopping cart at '/cart'
+
+3. Setup you "Item" class
+  A Cart has man "items". To setup the class of "item" to "Product" you'd have to set the following inside
+  'config/initializers/shop_bunny, which was installed by the generator above:
+    config.item_model_class_name = 'Product'
+

data/Rakefile

@@ -0,0 +1,33 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ShopBunny'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/app/controllers/shop_bunny/application_controller.rb

@@ -0,0 +1,5 @@
+module ShopBunny
+  class ApplicationController < ActionController::Base
+    protect_from_forgery
+  end
+end

data/app/controllers/shop_bunny/carts_controller.rb

@@ -0,0 +1,5 @@
+module ShopBunny
+  class CartsController < ApplicationController
+    include ShopBunny::CartControllerModule
+  end
+end

data/app/models/{cart_item.rb → shop_bunny/cart_item.rb}

@@ -1,4 +1,4 @@
-class CartItem < ActiveRecord::Base
+class ShopBunny::CartItem < ActiveRecord::Base
   belongs_to :cart
   # belongs_to :item, :class_name => ShopBunny.item_model_class_name
   
@@ -8,12 +8,9 @@ class CartItem < ActiveRecord::Base
   
   before_validation :set_default_quantity
   after_update :destroy_if_empty
-  
-  after_save :touch_cart
-  after_destroy :touch_cart
-  
-  # TODO attr_accessible :quantity
-  
+  after_save :update_automatic_coupons
+  after_destroy :update_automatic_coupons
+
   def total_price
     quantity * item.price
   end
@@ -45,7 +42,11 @@ class CartItem < ActiveRecord::Base
   end
 
   private
-  
+
+  def update_automatic_coupons
+    cart.update_automatic_coupons! if cart
+  end
+
   def set_default_quantity
     self.quantity ||= 0
   end
@@ -63,9 +64,4 @@ class CartItem < ActiveRecord::Base
   ShopBunny.cart_item_enhancements.each do |enhancement|
     include enhancement
   end
-  
-  protected
-  def touch_cart
-    cart.touch if cart
-  end
 end

data/app/models/{coupon.rb → shop_bunny/coupon.rb}

@@ -1,51 +1,47 @@
-class Coupon < ActiveRecord::Base
+class ShopBunny::Coupon < ActiveRecord::Base
   InvalidEvent = Class.new(NoMethodError)
-  has_many :coupon_uses, :dependent => :destroy
+  has_many :coupon_uses, :dependent => :destroy, :class_name => 'ShopBunny::CouponUse'
   has_many :carts, :through => :coupon_uses
   belongs_to :bonus_article, :class_name => ShopBunny.item_model_class_name
 
   validates_presence_of :code
   validates_uniqueness_of :code
   validates_presence_of :title
-  
+
   after_initialize { self.state ||= 'inactive' }
-  after_save :touch_cart
-  after_destroy :touch_cart
-  
-  # TODO Add self destruction when coupon has expired?
-  
+
   scope :valid, lambda {{:conditions => ['(coupons.valid_from IS NULL OR coupons.valid_from <= ?) AND (coupons.valid_until IS NULL OR coupons.valid_until >= ?) AND coupons.state = ?', Time.now, Time.now, 'active']}}
   scope :automatically_added_over, lambda {|value| {:conditions => ['value_of_automatic_add <= ?', value]}}
-  
+
   def expired?
     not_yet_valid? || has_expired?
   end
-  
-  # FIXME rename?
+
   def not_yet_valid?
     Time.now < self.valid_from if self.valid_from 
   end
-  
+
   def has_expired?
     Time.now > self.valid_until if self.valid_until 
   end
 
+  def used_up?
+    max_uses && max_uses <= coupon_uses.count
+  end
+
   def redeemable?
-    !not_yet_valid? && !has_expired? && state == 'active'
+    !not_yet_valid? && !has_expired? && state == 'active' && !used_up?
   end
 
   def activate!
     raise InvalidEvent unless state == 'inactive'
     self.state = 'active'
+    save!
   end
 
   def redeem!
     raise InvalidEvent unless redeemable?
     self.state = 'redeemed'
-  end
-
-  protected
-  def touch_cart
-    carts.each {|cart| cart.touch}
+    save!
   end
 end

data/app/models/shop_bunny/coupon_use.rb

@@ -0,0 +1,7 @@
+class ShopBunny::CouponUse < ActiveRecord::Base
+  belongs_to :cart
+  belongs_to :coupon, :class_name => 'ShopBunny::Coupon'
+
+  validates_presence_of :cart_id
+  validates_presence_of :coupon_id
+end

data/app/views/{carts → shop_bunny/carts}/show.html.erb

@@ -11,14 +11,14 @@
       <tr>
         <th><%= item.id %></th>
         <th><%= item.price %></th>
-        <th><%= link_to("Add to cart", add_item_to_cart_path(:item_id => item.id)) %></th>
+        <th id="<%= dom_id(item) %>"><%= link_to("Add to cart", add_item_to_cart_path(:item_id => item.id)) %></th>
       </tr>
       <% end %>
     </table>
   </table>
 </div>
 
-<div class="shopping-cart">
+<div id="cart">
   <div class="items">
     <%= form_for @cart, :url => cart_path do |f| %>
       <h1>Shopping Cart</h1>
@@ -35,20 +35,20 @@
             <td><%= cart_item.object.item.id %></td>
             <td><%= cart_item.object.item.price %></td>
             <td><%= cart_item.text_field :quantity %></td>        
-            <td><%= link_to 'Remove', remove_item_from_cart_path(:item_id => cart_item.object.item.id) %></td>
+            <td><%= link_to "Remove item #{cart_item.object.item.id}", remove_item_from_cart_path(:item_id => cart_item.object.item.id) %></td>
           </tr>
         <% end %>
       </table>
 
       <table class="cashpoint">
         <tr>
-          <td>Sum: <%= @cart.item_sum %></td>
+          <td>Sum: <span id="price-item-sum"><%= number_to_currency @cart.item_sum %></span></td>
         </tr>
         <tr>
-          <td>Shippin costs: <%= @cart.shipping_costs %></td>
+          <td>Shippin costs: <span id="price-shipping-costs"><%= number_to_currency @cart.shipping_costs %></span></td>
         </tr>
         <tr>
-          <td>Total: <%= @cart.total %></td>
+          <td>Total: <span id="price-total"><%= number_to_currency @cart.total %></span></td>
         </tr>
       </table>
   
@@ -58,29 +58,24 @@
 
   <div class="coupons">
     <%= form_for @cart, :url => cart_path do |f| %>
-      <h1>Available coupons</h2>
-      <ul>
-      <% Coupon.limit(10).all.each do |coupon| %>
-        <li><%= coupon.code %></ti>
-      <% end %>
-      </ul>
-
       <h2>Your coupons</h2>
-      <ul>
-      <% @cart.coupons.each do |coupon| %>
-        <li><%= coupon.title %></ti>
+      <% if @cart.coupons.empty? %>
+        No coupons added
+      <% else %>
+        <ul id="your_coupons">
+        <% @cart.coupons.each do |coupon| %>
+          <li><%= coupon.title %></ti>
+        <% end %>
+        </ul>
+      <% end %>
+      <ul id="error_messages">
+      <% @cart.errors.full_messages.each do |err| %>
+        <li><%= err %></li>
       <% end %>
       </ul>
-      <p>
-        <%# TODO Show error messages  %>
-        <%= @cart.errors if @cart.errors.any? %>
-      </p>
-      <%= f.label :coupon_code, 'Got a code?' %>
+      <%= f.label :coupon_code, 'Coupon code' %>
       <%= f.text_field :coupon_code %>
-      <%= f.submit :value => "Add code" %>
+      <%= f.submit :value => "Add coupon" %>
     <% end %>
   </div>
-  <div class="checkout">
-    <%= link_to "checkout", :controller => "carts", :action => :checkout %>
-  </div>
 </div>

data/config/locales/shop_bunny.en.yml

@@ -0,0 +1,10 @@
+en:
+  activerecord:
+    errors:
+      models:
+        cart:
+          attributes:
+            coupon_code:
+              unknown: "The provided code is unknown or invalid"
+              expired: "The provided code has expired"
+              used_up: "The number of uses for this code has been exceeded"

data/config/routes.rb

@@ -1,65 +1,6 @@
-Rails.application.routes.draw do
+ShopBunny::Engine.routes.draw do
   resource :cart, :only => [:show, :update] do
-      match ':action'
-      get :checkout
-      get :add_item, :as => 'add_item_to'
-      get :remove_item, :as => 'remove_item_from'
+    get :add_item, :as => 'add_item_to'
+    get :remove_item, :as => 'remove_item_from'
   end
-
-  # The priority is based upon order of creation:
-  # first created -> highest priority.
-
-  # Sample of regular route:
-  #   match 'products/:id' => 'catalog#view'
-  # Keep in mind you can assign values other than :controller and :action
-
-  # Sample of named route:
-  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
-  # This route can be invoked with purchase_url(:id => product.id)
-
-  # Sample resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Sample resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Sample resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Sample resource route with more complex sub-resources
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', :on => :collection
-  #     end
-  #   end
-
-  # Sample resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
-
-  # You can have the root of your site routed with "root"
-  # just remember to delete public/index.html.
-  # root :to => "welcome#index"
-
-  # See how all your routes lay out with "rake routes"
-
-  # This is a legacy wild controller route that's not recommended for RESTful applications.
-  # Note: This route will make all actions in every controller accessible via GET requests.
-  # match ':controller(/:action(/:id(.:format)))'
 end

data/db/migrate/20110202235446_add_raw_item_to_cart_items.rb

@@ -2,7 +2,7 @@ class AddRawItemToCartItems < ActiveRecord::Migration
   def self.up
     add_column :cart_items, :raw_item, :text
     
-    CartItem.all.each do |e|
+    ShopBunny::CartItem.all.each do |e|
       if e.read_attribute(:item_id)
         i = ShopBunny.item_model_class_name.constantize.find_by_id(e.read_attribute(:item_id))
         if i

data/lib/generators/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Install ShopBunny assets
+
+Example:
+    rails generate shop_bunny:install
+    
+    Make sure to look at config/initializers/shop_bunny.rb after you run the generator.
+    

data/lib/generators/install/install_generator.rb

@@ -0,0 +1,23 @@
+module ShopBunny  
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path("../../../../", __FILE__)
+    class_option :model, :type => :boolean, :default => true, :desc => "copy model templatefile."
+
+    def copy_files
+      puts Dir['.']
+      copy_file 'lib/generators/install/templates/initializer.rb', 'config/initializers/shop_bunny.rb'
+      copy_file 'lib/generators/install/templates/shopbunny_model_template.rb', 'app/models/cart.rb' if options.model?
+    end
+
+    def create_migrations
+      Dir["#{self.class.source_root}/migrations/*.rb"].sort.each do |filepath|
+        name = File.basename(filepath)
+        migration_template "migrations/#{name}", "db/migrate/#{name.gsub(/^\d+_/,'')}"
+      end
+    end
+
+  end
+end
+
+# TODO Write a generator test

data/lib/shop_bunny/cart_controller_module.rb

@@ -18,33 +18,25 @@ module ShopBunny
       end
       @cart.add_item(@item, :quantity => quantity) if @item
       respond_with @cart do |format|
-        format.html { redirect_to :action => :show }
+        format.html { redirect_to cart_path }
       end
     end
     
     def remove_item
       @cart.remove_item(@item) if @item
       respond_with @cart do |format|
-        format.html { redirect_to :action => :show }
+        format.html { redirect_to cart_path }
       end
     end
-
-    def checkout
-    end
     
     def update
       @cart.update_attributes(params[:cart])
-      @cart.update_automatic_coupons!
       respond_with @cart do |format|
-        format.html {
-          if @cart.errors.any?
-            render 'show'
+        format.html { 
+          if @cart.errors.empty?
+            redirect_to cart_path
           else
-            # We have to redirect by hand here, because 
-            # url_for(@cart) returns "/cart.x" when cart is a singular resource
-            # (see routes.rb). This is a known limitation of Rails.
-            # See https://rails.lighthouseapp.com/projects/8994/tickets/4168
-            redirect_to :action => :show
+            render :show
           end
         }
       end

data/lib/shop_bunny/cart_module.rb

@@ -3,9 +3,9 @@ module ShopBunny
   
     def self.included(clazz)
       clazz.send(:attr_accessor, :coupon_code)
-      clazz.send(:has_many, :cart_items, :dependent => :destroy)
-      clazz.send(:has_many, :coupon_uses, :dependent => :destroy)
-      clazz.send(:has_many, :coupons, :through => :coupon_uses)
+      clazz.send(:has_many, :cart_items, :dependent => :destroy, :class_name => 'ShopBunny::CartItem')
+      clazz.send(:has_many, :coupon_uses, :dependent => :destroy, :class_name => 'ShopBunny::CouponUse')
+      clazz.send(:has_many, :coupons, :through => :coupon_uses, :uniq => true)
       clazz.send(:accepts_nested_attributes_for, :cart_items, :allow_destroy => true )
       clazz.send(:before_save, :update_coupons)
       clazz.send(:attr_accessible, :coupon_code, :cart_items_attributes)
@@ -53,28 +53,21 @@ module ShopBunny
 
     # Calculates the total sum and applies the coupons discount! 
     def total
-            
       [0, items_with_coupons + shipping_costs].max
     end
     
-    #increases the quantity of an article. creates a new one if it doesn't exist
+    # Adds one or options[:quantity] number of items to the cart or increases it's quantity.
     def add_item(item,options = {})
-      options[:quantity] ||= 1
-      cart_item = self.cart_items.select {|e| e.item.id == item.id}.first
+      cart_item = find_cart_item(item)
       cart_item ||= self.cart_items.build(:item => item)
-      cart_item.quantity += options[:quantity]
+      cart_item.quantity += options[:quantity] || 1
       cart_item.save!
-      
-      update_automatic_coupons!
-      
-      self.save!
       self.reload
-      cart_item
     end
     
-    #removes a quantity of an article specified by :article_id, returns nil if no article has been found
+    # Decreases the quantity of an item in the cart by 1 or options[:quantity]
     def remove_item(item,options = {})
-      cart_item = self.cart_items.select {|e| e.item.id == item.id}.first
+      cart_item = find_cart_item(item)
       if cart_item
         options[:quantity] ||= cart_item.quantity
         if cart_item
@@ -83,24 +76,16 @@ module ShopBunny
           self.reload
         end
       end
-      
-      update_automatic_coupons!
-      
-      cart_item
     end
 
-    #sets the quantity of an article specified by :article_id, returns nil if no article has been found
+    # Sets the quantity of the item to options[:quantity]
     def update_item(item,options)
-      cart_item = self.cart_items.select {|e| e.item.id == item.id}.first
+      cart_item = find_cart_item(item)
       if cart_item
         cart_item.quantity = options[:quantity]
         cart_item.save!
         self.reload
       end
-
-      update_automatic_coupons!
-
-      cart_item
     end
 
     def shipping_cost_calculator
@@ -117,17 +102,12 @@ module ShopBunny
       cart_items.empty? && bonus_items.empty?
     end
     
-    # Remove all items from the cart
+    # Remove all items and coupons from the cart
     def clear!
-      cart_items.each {|i| i.destroy}
       cart_items.clear
-      
-      coupon_uses.each {|u| u.destroy}
-      coupon_uses.clear
       coupons.clear
     end
     
-    # Make
     def as_json(options={})
       { 
         :cart => attributes.
@@ -144,23 +124,21 @@ module ShopBunny
     end
 
     def update_automatic_coupons!
-      coupon_uses.each do |use|
-        use.destroy if use.coupon.value_of_automatic_add
-      end
-
-      save
-      reload
-
+      coupon_uses.joins(:coupon).where('coupons.value_of_automatic_add IS NOT NULL').destroy_all
       Coupon.valid.automatically_added_over(item_sum).each do |coupon|
         coupons << coupon
       end
     end
 
     protected
+    def find_cart_item(item)
+      self.cart_items.detect {|e| e.item.id == item.id}
+    end
+
     def update_coupons
       Array(@coupon_code).each { |code|
         coupon = Coupon.find_by_code(code)
-        coupons << coupon if coupon && !coupons.include?(coupon) && (coupon.max_uses.nil? || coupon.max_uses >= coupon.coupon_uses.count)
+        coupons << coupon if coupon && coupon.redeemable?
       }
     end
     
@@ -168,11 +146,11 @@ module ShopBunny
       Array(@coupon_code).each { |code|
         coupon = Coupon.find_by_code(code)
         if coupon.nil?
-          errors.add(:coupon_code, "is unknown")
+          errors.add(:coupon_code, :unknown)
         elsif coupon.expired?
-          errors.add(:coupon_code, "is expired")
-        elsif coupon.max_uses && coupon.max_uses < coupon.coupon_uses.count
-          errors.add(:coupon_code, "is overused")
+          errors.add(:coupon_code, :expired)
+        elsif coupon.used_up? && !coupons.include?(coupon)
+          errors.add(:coupon_code, :used_up)
         end
       }
     end

data/{config/initializers/add_cart_finder_to_controllers.rb → lib/shop_bunny/controller_helpers.rb}

@@ -1,6 +1,6 @@
-module ActionController
-  class Base
-    protected
+module ShopBunny
+  # These methods are included in ApplicationController
+  module ControllerHelpers
     # The default behaviour is to map a Cart to a session variable 'cart_id'.
     # You might want to overwrite this method to authorize a user.
     # TODO This could result in a mass of empty carts. A Problem?
@@ -18,9 +18,9 @@ module ActionController
         session[:cart_id] = @cart.id
       end
     end
-    
+
     def clear_cart
       session[:cart_id] = nil
     end
   end
-end
+end

data/lib/shop_bunny/engine.rb

@@ -1,15 +1,20 @@
-require 'rails'
-
 module ShopBunny
   class Engine < Rails::Engine
+    isolate_namespace ShopBunny
 
     # Config defaults
     config.mount_at = '/'
-    
+
     # Check the gem config
-    initializer "check config" do |app|            
+    initializer "shop_bunny.check_mount_point" do |app|
       # make sure mount_at ends with trailing slash
       config.mount_at += '/' unless config.mount_at.last == '/'
-    end        
+    end
+
+    initializer "shop_bunny.add_controller_helpers" do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include ShopBunny::ControllerHelpers
+      end
+    end
   end
 end

data/lib/shop_bunny/version.rb

@@ -0,0 +1,3 @@
+module ShopBunny
+  VERSION = "0.8.6"
+end

data/lib/shop_bunny.rb

@@ -4,6 +4,7 @@ module ShopBunny
   require 'shop_bunny/shipping_cost_calculator'
   require 'shop_bunny/cart_module'
   require 'shop_bunny/cart_controller_module'
+  require 'shop_bunny/controller_helpers'
   
   mattr_accessor :item_model_class_name
   @@item_model_class_name = 'Item'
@@ -13,7 +14,11 @@ module ShopBunny
   
   mattr_accessor :cart_item_enhancements
   @@cart_item_enhancements ||= []
-  
+
+  def self.table_name_prefix
+    ''
+  end
+
   # This is the default way to setup ShopBunny and is used in the 
   # initializer which gets generated by `rails generate shop_bunny:install`
   def self.setup