shoppe 0.0.14 → 0.0.15

data/app/models/shoppe/order_item.rb

@@ -1,146 +1,148 @@
-class Shoppe::OrderItem < ActiveRecord::Base
+module Shoppe
+  class OrderItem < ActiveRecord::Base
   
-  # Set the table name
-  self.table_name = 'shoppe_order_items'
+    # Set the table name
+    self.table_name = 'shoppe_order_items'
   
-  # Relationships
-  belongs_to :order, :class_name => 'Shoppe::Order'
-  belongs_to :product, :class_name => 'Shoppe::Product'
-  has_many :stock_level_adjustments, :as => :parent, :dependent => :nullify
+    # Relationships
+    belongs_to :order, :class_name => 'Shoppe::Order'
+    belongs_to :ordered_item, :polymorphic => true
+    has_many :stock_level_adjustments, :as => :parent, :dependent => :nullify, :class_name => 'Shoppe::StockLevelAdjustment'
   
-  # Validations
-  validates :quantity, :numericality => true
+    # Validations
+    validates :quantity, :numericality => true
   
-  # Set some values based on the selected product on validation
-  before_validation do
-    self.weight          = self.quantity * self.product.weight
-  end
+    before_validation do
+      self.weight = self.quantity * self.ordered_item.weight
+    end
   
-  # This allows you to add a product to the scoped order. For example Order.first.order_items.add_product(...).
-  # This will either increase the quantity of the value in the order or create a new item if one does not
-  # exist already.
-  def self.add_product(product, quantity = 1)
-    transaction do
-      if existing = self.where(:product_id => product.id).first
-        existing.increase!(quantity)
-        existing
-      else
-        item = self.create(:product => product, :quantity => 0)
-        item.increase!(quantity)
+    # This allows you to add a product to the scoped order. For example Order.first.order_items.add_product(...).
+    # This will either increase the quantity of the value in the order or create a new item if one does not
+    # exist already.
+    def self.add_item(ordered_item, quantity = 1)
+      raise Errors::UnorderableItem, :ordered_item => ordered_item unless ordered_item.orderable?
+      transaction do
+        if existing = self.where(:ordered_item_id => ordered_item.id, :ordered_item_type => ordered_item.class.to_s).first
+          existing.increase!(quantity)
+          existing
+        else
+          new_item = self.create(:ordered_item => ordered_item, :quantity => 0)
+          new_item.increase!(quantity)
+        end
       end
     end
-  end
 
-  # This allows you to remove a product from an order. It will also ensure that the order's
-  # custom delivery service is updated.
-  def remove
-    transaction do
-      self.destroy!
-      self.order.remove_delivery_service_if_invalid
+    # This allows you to remove a product from an order. It will also ensure that the order's
+    # custom delivery service is updated.
+    def remove
+      transaction do
+        self.destroy!
+        self.order.remove_delivery_service_if_invalid
+      end
     end
-  end
   
   
-  # Increase the quantity of items in the order by the number provided. Will raise an error if we don't have
-  # the stock to do this.
-  def increase!(amount = 1)
-    transaction do
-      self.quantity += amount
-      if self.product.stock_control? && self.product.stock < self.quantity
-        raise Shoppe::Errors::NotEnoughStock, :product => self.product, :requested_stock => self.quantity
+    # Increase the quantity of items in the order by the number provided. Will raise an error if we don't have
+    # the stock to do this.
+    def increase!(amount = 1)
+      transaction do
+        self.quantity += amount
+        unless self.in_stock?
+          raise Shoppe::Errors::NotEnoughStock, :ordered_item => self.ordered_item, :requested_stock => self.quantity
+        end
+        self.save!
+        self.order.remove_delivery_service_if_invalid
       end
-      self.save!
-      self.order.remove_delivery_service_if_invalid
     end
-  end
   
-  # Decreases the quantity of items in the order by the number provided.
-  def decrease!(amount = 1)
-    transaction do
-      self.quantity -= amount
-      self.quantity == 0 ? self.destroy : self.save!
-      self.order.remove_delivery_service_if_invalid
+    # Decreases the quantity of items in the order by the number provided.
+    def decrease!(amount = 1)
+      transaction do
+        self.quantity -= amount
+        self.quantity == 0 ? self.destroy : self.save!
+        self.order.remove_delivery_service_if_invalid
+      end
     end
-  end
   
-  # Return the unit price for the item
-  def unit_price
-    @unit_price ||= read_attribute(:unit_price) || product.try(:price) || 0.0
-  end
+    # Return the unit price for the item
+    def unit_price
+      @unit_price ||= read_attribute(:unit_price) || ordered_item.try(:price) || 0.0
+    end
   
-  # Return the cost price for the item
-  def unit_cost_price
-    @unit_cost_price ||= read_attribute(:unit_cost_price) || product.try(:cost_price) || 0.0
-  end
+    # Return the cost price for the item
+    def unit_cost_price
+      @unit_cost_price ||= read_attribute(:unit_cost_price) || ordered_item.try(:cost_price) || 0.0
+    end
   
-  # Return the tax rate for the item
-  def tax_rate
-    @tax_rate ||= read_attribute(:tax_rate) || product.try(:tax_rate).try(:rate_for, self.order) || 0.0 
-  end
+    # Return the tax rate for the item
+    def tax_rate
+      @tax_rate ||= read_attribute(:tax_rate) || ordered_item.try(:tax_rate).try(:rate_for, self.order) || 0.0 
+    end
   
-  # Return the total tax for the item
-  def tax_amount
-    @tax_amount ||= read_attribute(:tax_amount) || (self.sub_total / BigDecimal(100)) * self.tax_rate
-  end
+    # Return the total tax for the item
+    def tax_amount
+      @tax_amount ||= read_attribute(:tax_amount) || (self.sub_total / BigDecimal(100)) * self.tax_rate
+    end
   
-  # Return the total cost for the product
-  def total_cost
-    quantity * unit_cost_price
-  end
+    # Return the total cost for the product
+    def total_cost
+      quantity * unit_cost_price
+    end
   
-  # Return the sub total for the product
-  def sub_total
-    quantity * unit_price
-  end
+    # Return the sub total for the product
+    def sub_total
+      quantity * unit_price
+    end
   
-  # Return the total price including tax for the order line
-  def total
-    tax_amount + sub_total
-  end
+    # Return the total price including tax for the order line
+    def total
+      tax_amount + sub_total
+    end
   
-  # This method will be triggered when the parent order is confirmed. This should automatically
-  # update the stock levels on the source product.
-  def confirm!
-    write_attribute :unit_price, self.unit_price
-    write_attribute :unit_cost_price, self.unit_cost_price
-    write_attribute :tax_rate, self.tax_rate
-    write_attribute :tax_amount, self.tax_amount
-    save!
+    # This method will be triggered when the parent order is confirmed. This should automatically
+    # update the stock levels on the source product.
+    def confirm!
+      write_attribute :unit_price, self.unit_price
+      write_attribute :unit_cost_price, self.unit_cost_price
+      write_attribute :tax_rate, self.tax_rate
+      write_attribute :tax_amount, self.tax_amount
+      save!
     
-    if self.product.stock_control?
-      self.product.stock_level_adjustments.create(:parent => self, :adjustment => 0 - self.quantity, :description => "Order ##{self.order.number} deduction")
+      if self.ordered_item.stock_control?
+        self.ordered_item.stock_level_adjustments.create(:parent => self, :adjustment => 0 - self.quantity, :description => "Order ##{self.order.number} deduction")
+      end
     end
-  end
   
-  # This method will be trigger when the parent order is accepted.
-  def accept!
-  end
+    # This method will be trigger when the parent order is accepted.
+    def accept!
+    end
   
-  # This method will be trigger when the parent order is rejected.
-  def reject!
-    self.stock_level_adjustments.destroy_all
-  end
+    # This method will be trigger when the parent order is rejected.
+    def reject!
+      self.stock_level_adjustments.destroy_all
+    end
   
-  # Do we have the stock needed to fulfil this order?
-  def in_stock?
-    if self.product.stock_control?
-      self.product.stock >= self.quantity
-    else
-      true
+    # Do we have the stock needed to fulfil this order?
+    def in_stock?
+      if self.ordered_item.stock_control?
+        self.ordered_item.stock >= self.quantity
+      else
+        true
+      end
     end
-  end
   
-  # Validate the stock level against the product and update as appropriate. This method will be executed
-  # before an order is completed. If we have run out of this product, we will update the quantity to an
-  # appropriate level (or remove the order item) and return the object.
-  def validate_stock_levels
-    if in_stock?
-      false
-    else
-      self.quantity = self.product.stock
-      self.quantity == 0 ? self.destroy : self.save!
-      self
+    # Validate the stock level against the product and update as appropriate. This method will be executed
+    # before an order is completed. If we have run out of this product, we will update the quantity to an
+    # appropriate level (or remove the order item) and return the object.
+    def validate_stock_levels
+      if in_stock?
+        false
+      else
+        self.quantity = self.ordered_item.stock
+        self.quantity == 0 ? self.destroy : self.save!
+        self
+      end
     end
-  end
   
+  end
 end

data/app/models/shoppe/product.rb

@@ -1,68 +1,90 @@
-class Shoppe::Product < ActiveRecord::Base
+module Shoppe
+  class Product < ActiveRecord::Base
   
-  # Set the table name
-  self.table_name = 'shoppe_products'  
+    # Set the table name
+    self.table_name = 'shoppe_products'  
   
-  # Require some concerns
-  require_dependency 'shoppe/product/product_attributes'
+    # Require some concerns
+    require_dependency 'shoppe/product/product_attributes'
+    require_dependency 'shoppe/product/variants'
   
-  # Attachments
-  attachment :default_image
-  attachment :data_sheet
+    # Attachments
+    attachment :default_image
+    attachment :data_sheet
   
-  # Relationships
-  belongs_to :product_category, :class_name => 'Shoppe::ProductCategory'
-  belongs_to :tax_rate, :class_name => "Shoppe::TaxRate"
-  has_many :order_items, :dependent => :restrict_with_exception, :class_name => 'Shoppe::OrderItem'
-  has_many :orders, :through => :order_items, :class_name => 'Shoppe::Order'
-  has_many :stock_level_adjustments, :dependent => :destroy
+    # Relationships
+    belongs_to :product_category, :class_name => 'Shoppe::ProductCategory'
+    belongs_to :tax_rate, :class_name => "Shoppe::TaxRate"
+    has_many :order_items, :dependent => :restrict_with_exception, :class_name => 'Shoppe::OrderItem', :as => :ordered_item
+    has_many :orders, :through => :order_items, :class_name => 'Shoppe::Order'
+    has_many :stock_level_adjustments, :dependent => :destroy, :class_name => 'Shoppe::StockLevelAdjustment', :as => :item
   
-  # Validations
-  validates :product_category_id, :presence => true
-  validates :title, :presence => true
-  validates :permalink, :presence => true, :uniqueness => true
-  validates :sku, :presence => true
-  validates :description, :presence => true
-  validates :short_description, :presence => true
-  validates :weight, :numericality => true
-  validates :price, :numericality => true
-  validates :cost_price, :numericality => true, :allow_blank => true
+    # Validations
+    with_options :if => Proc.new { |p| p.parent.nil? } do |product|
+      product.validates :product_category_id, :presence => true
+      product.validates :description, :presence => true
+      product.validates :short_description, :presence => true
+    end
+    validates :name, :presence => true
+    validates :permalink, :presence => true, :uniqueness => true
+    validates :sku, :presence => true
+    validates :weight, :numericality => true
+    validates :price, :numericality => true
+    validates :cost_price, :numericality => true, :allow_blank => true
   
-  # Set the permalink
-  before_validation { self.permalink = self.title.parameterize if self.permalink.blank? && self.title.is_a?(String) }
+    # Set the permalink
+    before_validation { self.permalink = self.name.parameterize if self.permalink.blank? && self.name.is_a?(String) }
   
-  # Scopes
-  scope :active, -> { where(:active => true) }
-  scope :featured, -> {where(:featured => true)}
+    # Scopes
+    scope :active, -> { where(:active => true) }
+    scope :featured, -> {where(:featured => true)}
+    scope :ordered, -> {order('name asc')}
+    
+    # Return the name of the product
+    def full_name
+      self.parent ? "#{self.parent.name} (#{name})" : name
+    end
+    
+    # Is this product actually orderable?
+    def orderable?
+      return false if self.has_variants?
+      true
+    end
+    
+    # Return the price for the product
+    def price
+      self.default_variant ? self.default_variant.price : read_attribute(:price)
+    end
 
-  # Is this product currently in stock?
-  def in_stock?
-    stock > 0
-  end
+    # Is this product currently in stock?
+    def in_stock?
+      self.default_variant ? self.default_variant.in_stock? : stock > 0
+    end
   
-  # Return the total number of items currently in stock
-  def stock
-    @stock ||= self.stock_level_adjustments.sum(:adjustment)
-  end
+    # Return the total number of items currently in stock
+    def stock
+      @stock ||= self.stock_level_adjustments.sum(:adjustment)
+    end
   
-  # Specify which attributes can be searched
-  def self.ransackable_attributes(auth_object = nil)
-    ["id", "title", "sku"] + _ransackers.keys
-  end
+    # Specify which attributes can be searched
+    def self.ransackable_attributes(auth_object = nil)
+      ["id", "name", "sku"] + _ransackers.keys
+    end
   
-  # Specify which associations can be searched
-  def self.ransackable_associations(auth_object = nil)
-    []
-  end
+    # Specify which associations can be searched
+    def self.ransackable_associations(auth_object = nil)
+      []
+    end
   
-  # Search for products which include the guven attributes and return an active record
-  # scope of these products. Chainable with other scopes and with_attributes methods.
-  # For example:
-  #
-  #   Shoppe::Product.active.with_attribute('Manufacturer', 'Apple').with_attribute('Model', ['Macbook', 'iPhone'])
-  def self.with_attributes(key, values)
-    product_ids = Shoppe::ProductAttribute.searchable.where(:key => key, :value => values).pluck(:product_id).uniq
-    where(:id => product_ids)
-  end
+    # Search for products which include the guven attributes and return an active record
+    # scope of these products. Chainable with other scopes and with_attributes methods.
+    # For example:
+    #
+    #   Shoppe::Product.active.with_attribute('Manufacturer', 'Apple').with_attribute('Model', ['Macbook', 'iPhone'])
+    def self.with_attributes(key, values)
+      product_ids = Shoppe::ProductAttribute.searchable.where(:key => key, :value => values).pluck(:product_id).uniq
+      where(:id => product_ids)
+    end
   
+  end
 end

data/app/models/shoppe/product/product_attributes.rb

@@ -1,15 +1,17 @@
-class Shoppe::Product
+module Shoppe
+  class Product
   
-  # Relationships
-  has_many :product_attributes, -> { order(:position) }, :class_name => 'Shoppe::ProductAttribute'
+    # Relationships
+    has_many :product_attributes, -> { order(:position) }, :class_name => 'Shoppe::ProductAttribute'
   
-  # Attribute for providing the hash
-  attr_accessor :product_attributes_array
+    # Attribute for providing the hash
+    attr_accessor :product_attributes_array
   
-  # Save the attributes after saving the record
-  after_save do
-    return unless product_attributes_array.is_a?(Array)
-    self.product_attributes.update_from_array(product_attributes_array)
-  end
+    # Save the attributes after saving the record
+    after_save do
+      return unless product_attributes_array.is_a?(Array)
+      self.product_attributes.update_from_array(product_attributes_array)
+    end
   
+  end
 end

data/app/models/shoppe/product/variants.rb

@@ -0,0 +1,26 @@
+module Shoppe
+  class Product
+    
+    # Relationships
+    has_many :variants, :class_name => 'Shoppe::Product', :foreign_key => 'parent_id', :dependent => :destroy
+    belongs_to :parent, :class_name => 'Shoppe::Product', :foreign_key => 'parent_id'
+    
+    # Validations
+    validate do
+      errors.add :base, "can only belong to a root product" if self.parent && self.parent.parent
+    end
+    
+    # Scopes
+    scope :root, -> { where(:parent_id => nil) }
+    
+    def has_variants?
+      !variants.empty?
+    end
+    
+    def default_variant
+      return nil if self.parent
+      @default_variant ||= self.variants.first
+    end
+    
+  end
+end