shop_bunny 0.7

data/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/app/controllers/carts_controller.rb

@@ -0,0 +1,50 @@
+class CartsController < ApplicationController
+  respond_to :html, :json
+  before_filter :find_cart
+  before_filter :find_item, :only => [:add_item, :remove_item]
+  
+  if ShopBunny.controller_enhancement
+    include ShopBunny.controller_enhancement
+  end
+    
+  def show
+    respond_with @cart
+  end  
+  
+  def add_item
+    @cart.add_item(@item) if @item
+    respond_with @cart do |format|
+      format.html { redirect_to :action => :show }
+    end
+  end
+  
+  def remove_item
+    @cart.remove_item(@item) if @item
+    respond_with @cart do |format|
+      format.html { redirect_to :action => :show }
+    end
+  end
+  
+  def update
+    @cart.update_attributes(params[:cart])
+    respond_with @cart do |format|
+      format.html { 
+        if @cart.errors.any?
+          render 'show' 
+        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 
+        end
+      }
+    end
+  end
+  
+  private
+  
+  def find_item
+    @item = @cart.item_model.find(params[:item_id])
+  end
+end

data/app/models/cart.rb

@@ -0,0 +1,121 @@
+class Cart < ActiveRecord::Base
+  attr_accessor :coupon_code
+  has_many :cart_items, :dependent => :destroy
+  has_many :coupon_uses, :dependent => :destroy
+  has_many :coupons, :through => :coupon_uses
+  accepts_nested_attributes_for :cart_items, :allow_destroy => true 
+  before_save :update_coupons
+  attr_accessible :coupon_code, :cart_items_attributes
+  validate :coupon_code_must_be_valid    
+  
+  def items
+    self.cart_items
+  end
+  
+  def item_count
+    self.cart_items.inject(0) {|sum,e| sum += e.quantity}
+  end
+  
+  def shipping_costs
+    return 0 if coupons.any?(&:removes_shipping_cost)
+    shipping_cost_calculator.costs_for(self)
+  end
+
+  # Calculates the sum of all cart_items, excluding the coupons discount!
+  def item_sum
+    self.cart_items.inject(0) {|sum,e| sum += e.quantity*e.item.price}
+  end
+
+  # Calculates the total sum and applies the coupons discount! 
+  def total
+    sum = item_sum
+
+    absolute_discount = coupons.sum(:discount_credit)
+    relative_discount = coupons.inject(1) {|s,coupon| s * coupon.discount_percentage }
+
+    sum -= absolute_discount
+    sum *= relative_discount
+    
+    sum + shipping_costs
+    
+    [0, sum].max
+  end
+  
+  #increases the quantity of an article. creates a new one if it doesn't exist
+  def add_item(item,options = {})
+    options[:quantity] ||= 1
+    cart_item = self.cart_items.find_or_create_by_item_id(item.id)
+    cart_item.quantity += options[:quantity]
+    cart_item.save!
+    self.reload
+    cart_item
+  end
+  
+  #removes a quantity of an article specified by :article_id, returns nil if no article has been found
+  def remove_item(item,options = {})
+    cart_item = self.cart_items.find_by_item_id(item)
+    
+    options[:quantity] ||= cart_item.quantity
+    if cart_item
+      cart_item.quantity -= options[:quantity]
+      cart_item.save!
+      self.reload
+    end
+    cart_item
+  end
+
+  #sets the quantity of an article specified by :article_id, returns nil if no article has been found
+  def update_item(item,options)
+     cart_item = self.cart_items.find_by_item_id(item)
+    if cart_item
+      cart_item.quantity = options[:quantity]
+      cart_item.save!
+      self.reload
+    end
+    cart_item
+  end
+  
+  def shipping_cost_calculator
+    ShopBunny.shipping_cost_calculator
+  end
+  
+  # Returns the class/model of the items you can buy. (Products)
+  def item_model
+    ShopBunny.item_model_class_name.constantize
+  end
+  
+  # Make
+  def as_json(options={})
+    { 
+      :cart => attributes.
+      merge(
+        :cart_items => cart_items.as_json,                
+        :item_count => item_count,
+        :coupons => coupons.as_json,
+        :item_sum => item_sum,
+        :shipping_costs => shipping_costs,
+        :total => total
+      )
+    }
+  end
+  
+  private
+  
+  def update_coupons
+    Array(@coupon_code).each { |code|
+      coupon = Coupon.find_by_code(code)
+      coupons << coupon if coupon
+    }
+  end
+  
+  def coupon_code_must_be_valid
+    Array(@coupon_code).each { |code|
+      coupon = Coupon.find_by_code(code)
+      if coupon.nil?
+        errors.add(:coupon_code, "is unknown")
+      elsif coupon.expired?
+        errors.add(:coupon_code, "is expired")
+      end
+    }
+  end
+end

data/app/models/cart_item.rb

@@ -0,0 +1,23 @@
+class CartItem < ActiveRecord::Base
+  belongs_to :cart
+  belongs_to :item, :class_name => ShopBunny.item_model_class_name
+  
+  validates_presence_of :cart_id
+  validates_presence_of :item_id
+  validates_numericality_of :quantity
+  
+  before_validation :set_default_quantity
+  after_update :destroy_if_empty
+  # TODO attr_accessible :quantity
+  
+
+  private
+  
+  def set_default_quantity
+    self.quantity ||= 0
+  end
+  
+  def destroy_if_empty
+    self.destroy if quantity.to_i <= 0
+  end
+end

data/app/models/coupon.rb

@@ -0,0 +1,24 @@
+class Coupon < ActiveRecord::Base
+  has_many :coupon_uses, :dependent => :destroy
+  has_many :carts, :through => :coupon_uses
+
+  validates_presence_of :code
+  validates_uniqueness_of :code
+  validates_presence_of :title
+  attr_accessible
+  
+  # TODO Add self destruction when coupon has expired?
+  
+  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
+end

data/app/models/coupon_use.rb

@@ -0,0 +1,7 @@
+class CouponUse < ActiveRecord::Base
+  belongs_to :cart
+  belongs_to :coupon
+
+  validates_presence_of :cart_id
+  validates_presence_of :coupon_id
+end

data/app/models/item.rb

@@ -0,0 +1,6 @@
+# An item in the store
+class Item < ActiveRecord::Base
+  validates_presence_of :price
+  validates_numericality_of :price
+end
+

data/app/views/carts/show.html.erb

@@ -0,0 +1,83 @@
+<div class="shop">
+  <h1>Shop</h1>
+  <table>
+    <table>
+      <tr>
+        <th>Item id</th>
+        <th>Item price</th>
+        <th>Action</th>
+      </tr>
+      <% @cart.item_model.limit(10).each do |item| %>
+      <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>
+      </tr>
+      <% end %>
+    </table>
+  </table>
+</div>
+
+<div class="shopping-cart">
+  <div class="items">
+    <%= form_for @cart, :url => cart_path do |f| %>
+      <h1>Shopping Cart</h1>
+      <table>
+        <tr>
+          <th>Item id</th>
+          <th>Item price</th>
+          <th>Item quantity</th>
+          <th>Remove</th>
+        </tr>
+    
+        <%= f.fields_for :cart_items do |cart_item| %>
+          <tr>
+            <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>
+          </tr>
+        <% end %>
+      </table>
+
+      <table class="cashpoint">
+        <tr>
+          <td>Sum: <%= @cart.item_sum %></td>
+        </tr>
+        <tr>
+          <td>Shippin costs: <%= @cart.shipping_costs %></td>
+        </tr>
+        <tr>
+          <td>Total: <%= @cart.total %></td>
+        </tr>
+      </table>
+  
+      <%= f.submit %>
+    <% end %>
+  </div>
+
+  <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>
+      <% end %>
+      </ul>
+      <p>
+        <%# TODO Show error messages  %>
+        <%= @cart.errors if @cart.errors.any? %>
+      </p>
+      <%= f.label :coupon_code, 'Got a code?' %>
+      <%= f.text_field :coupon_code %>
+      <%= f.submit :value => "Add code" %>
+    <% end %>
+  </div>
+</div>

data/db/migrate/20100902115627_create_carts.rb

@@ -0,0 +1,14 @@
+class CreateCarts < ActiveRecord::Migration
+  def self.up
+    create_table :carts do |t|
+      t.integer :owner_id
+      t.string :type
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :carts
+  end
+end

data/db/migrate/20100902115757_create_cart_items.rb

@@ -0,0 +1,15 @@
+class CreateCartItems < ActiveRecord::Migration
+  def self.up
+    create_table :cart_items do |t|
+      t.integer :cart_id
+      t.integer :item_id
+      t.integer :quantity
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :cart_items
+  end
+end

data/db/migrate/20100915073016_create_items.rb

@@ -0,0 +1,14 @@
+class CreateItems < ActiveRecord::Migration
+  def self.up
+    create_table :items do |t|
+      t.float :price
+      t.string :title
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :items
+  end
+end

data/db/migrate/20100915091059_create_coupons.rb

@@ -0,0 +1,21 @@
+class CreateCoupons < ActiveRecord::Migration
+  def self.up
+    create_table :coupons do |t|
+      t.boolean :removes_tax, :default => false
+      t.float :discount_percentage, :default => 1.0
+      t.float :discount_credit, :default => 0.0
+      t.boolean :removes_shipping_cost, :default => false
+      t.integer :bonus_article_id
+      t.date :valid_from
+      t.date :valid_until
+      t.text :title
+      t.string :code
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :coupons
+  end
+end

data/db/migrate/20100915093821_create_coupon_uses.rb

@@ -0,0 +1,14 @@
+class CreateCouponUses < ActiveRecord::Migration
+  def self.up
+    create_table :coupon_uses do |t|
+      t.integer :cart_id
+      t.integer :coupon_id
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :coupon_uses
+  end
+end

data/db/migrate/20100915162029_remove_owner_id_from_carts.rb

@@ -0,0 +1,9 @@
+class RemoveOwnerIdFromCarts < ActiveRecord::Migration
+  def self.up
+    remove_column :carts, :owner_id
+  end
+
+  def self.down
+    add_column :carts, :owner_id, :integer
+  end
+end

data/db/migrate/20100916194407_set_default_column_value_for_cart_items_quantity.rb

@@ -0,0 +1,9 @@
+class SetDefaultColumnValueForCartItemsQuantity < ActiveRecord::Migration
+  def self.up
+    change_column_default :cart_items, :quantity, 0
+  end
+
+  def self.down
+    change_column_default :cart_items, :quantity, nil
+  end
+end

data/db/schema.rb

@@ -0,0 +1,57 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20100916194407) do
+
+  create_table "cart_items", :force => true do |t|
+    t.integer  "cart_id"
+    t.integer  "item_id"
+    t.integer  "quantity",   :default => 0
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "carts", :force => true do |t|
+    t.string   "type"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "coupon_uses", :force => true do |t|
+    t.integer  "cart_id"
+    t.integer  "coupon_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "coupons", :force => true do |t|
+    t.boolean  "removes_tax",           :default => false
+    t.float    "discount_percentage",   :default => 1.0
+    t.float    "discount_credit",       :default => 0.0
+    t.boolean  "removes_shipping_cost", :default => false
+    t.integer  "bonus_article_id"
+    t.date     "valid_from"
+    t.date     "valid_until"
+    t.text     "title"
+    t.string   "code"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "items", :force => true do |t|
+    t.float    "price"
+    t.string   "title"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/db/seeds.rb

@@ -0,0 +1,19 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)
+
+# Dummy data for development
+if Rails.env.development?
+  3.times { |i| Item.create! :price => i }
+  3.times { |i| 
+    c = Coupon.new
+    c.code = "code#{i}"
+    c.title = "10% discount coupon #{i}"
+    c.discount_percentage = 0.9
+    c.save!
+  }
+end

data/lib/generators/shop_bunny/install_generator.rb

@@ -0,0 +1,13 @@
+module ShopBunny  
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../../", __FILE__)
+
+    def copy_files
+     puts Dir['.']
+     directory 'db/migrate'
+     copy_file 'config/initializers/shop_bunny.rb'
+    end
+  end
+end
+
+# TODO Write a generator test

data/lib/shop_bunny/engine.rb

@@ -0,0 +1,15 @@
+require 'rails'
+
+module ShopBunny
+  class Engine < Rails::Engine
+
+    # Config defaults
+    config.mount_at = '/'
+    
+    # Check the gem config
+    initializer "check config" do |app|            
+      # make sure mount_at ends with trailing slash
+      config.mount_at += '/' unless config.mount_at.last == '/'
+    end        
+  end
+end

data/lib/shop_bunny/shipping_cost_calculator.rb

@@ -0,0 +1,6 @@
+# The default shipping cost calculator
+class ShopBunny::ShippingCostCalculator
+  def self.costs_for(cart)
+    8.90
+  end
+end

data/lib/shop_bunny.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module ShopBunny
+  require 'shop_bunny/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'shop_bunny/shipping_cost_calculator'
+  
+  mattr_accessor :item_model_class_name
+  @@item_model_class_name = 'Item'
+    
+  mattr_accessor :shipping_cost_calculator
+  @@shipping_cost_calculator = ShopBunny::ShippingCostCalculator
+  
+  mattr_accessor :controller_enhancement
+  @@controller_enhancement = nil
+  
+  # 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
+    yield self
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: shop_bunny
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  version: "0.7"
+platform: ruby
+authors: 
+- kopfmaschine.com
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-20 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A simple shop gem that integrates a cart and coupons functionality
+email: 
+- jan@kopfmaschine.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/shop_bunny/install_generator.rb
+- lib/shop_bunny.rb
+- lib/shop_bunny/shipping_cost_calculator.rb
+- lib/shop_bunny/engine.rb
+- app/views/carts/show.html.erb
+- app/models/cart.rb
+- app/models/coupon_use.rb
+- app/models/cart_item.rb
+- app/models/coupon.rb
+- app/models/item.rb
+- app/controllers/application_controller.rb
+- app/controllers/carts_controller.rb
+- db/test.sqlite3
+- db/schema.rb
+- db/migrate/20100915162029_remove_owner_id_from_carts.rb
+- db/migrate/20100915091059_create_coupons.rb
+- db/migrate/20100915073016_create_items.rb
+- db/migrate/20100902115627_create_carts.rb
+- db/migrate/20100915093821_create_coupon_uses.rb
+- db/migrate/20100916194407_set_default_column_value_for_cart_items_quantity.rb
+- db/migrate/20100902115757_create_cart_items.rb
+- db/development.sqlite3
+- db/seeds.rb
+has_rdoc: true
+homepage: http://kopfmaschine.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A shop template for your needs
+test_files: []
+