tienda 1.0.0

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

@@ -0,0 +1,20 @@
+module Tienda
+  class Product < ActiveRecord::Base
+
+    # Product attributes for this product
+    has_many :product_attributes, -> { order(:position) }, :class_name => 'Tienda::ProductAttribute'
+
+    # Used for setting an array of product attributes which will be updated. Usually
+    # received from a web browser.
+    attr_accessor :product_attributes_array
+
+    # After saving automatically try to update the product attributes based on the
+    # the contents of the product_attributes_array array.
+    after_save do
+      if product_attributes_array.is_a?(Array)
+        self.product_attributes.update_from_array(product_attributes_array)
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,51 @@
+module Tienda
+  class Product < ActiveRecord::Base
+
+    # Validations
+    validate { errors.add :base, :can_belong_to_root if self.parent && self.parent.parent }
+
+    # Variants of the product
+    has_many :variants, -> { order(:default => :desc, :name => :asc) }, :class_name => 'Tienda::Product', :foreign_key => 'parent_id', :dependent => :destroy
+
+    # The parent product (only applies to variants)
+    belongs_to :parent, :class_name => 'Tienda::Product', :foreign_key => 'parent_id'
+
+    # All products which are not variants
+    scope :root, -> { where(:parent_id => nil) }
+
+    # If a variant is created, the base product should be updated so that it doesn't have stock control enabled
+    after_save do
+      if self.parent
+        self.parent.price = 0
+        self.parent.cost_price = 0
+        self.parent.tax_rate = nil
+        self.parent.weight = 0
+        self.parent.stock_control = false
+        self.parent.save if self.parent.changed?
+      end
+    end
+
+    # Does this product have any variants?
+    #
+    # @return [Boolean]
+    def has_variants?
+      !variants.empty?
+    end
+
+    # Returns the default variant for the product or nil if none exists.
+    #
+    # @return [Tienda::Product]
+    def default_variant
+      return nil if self.parent
+      @default_variant ||= self.variants.select { |v| v.default? }.first
+    end
+
+    # Is this product a variant of another?
+    #
+    # @return [Boolean]
+    def variant?
+      !self.parent_id.blank?
+    end
+
+  end
+end

data/app/models/tienda/product.rb

@@ -0,0 +1,169 @@
+require 'roo'
+
+module Tienda
+  class Product < ActiveRecord::Base
+
+    self.table_name = 'tienda_products'
+
+    # Add dependencies for products
+    require_dependency 'tienda/product/product_attributes'
+    require_dependency 'tienda/product/variants'
+
+    # Products have a default_image and a data_sheet
+    attachment :default_image
+    attachment :data_sheet
+
+    # The product's category
+    #
+    # @return [Tienda::ProductCategory]
+    belongs_to :product_category, :class_name => 'Tienda::ProductCategory'
+
+    # The product's tax rate
+    #
+    # @return [Tienda::TaxRate]
+    belongs_to :tax_rate, :class_name => "Tienda::TaxRate"
+
+    # Ordered items which are associated with this product
+    has_many :order_items, :dependent => :restrict_with_exception, :class_name => 'Tienda::OrderItem', :as => :ordered_item
+
+    # Orders which have ordered this product
+    has_many :orders, :through => :order_items, :class_name => 'Tienda::Order'
+
+    # Stock level adjustments for this product
+    has_many :stock_level_adjustments, :dependent => :destroy, :class_name => 'Tienda::StockLevelAdjustment', :as => :item
+
+    # 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, :permalink => true
+    validates :sku, :presence => true
+    validates :weight, :numericality => true
+    validates :price, :numericality => true
+    validates :cost_price, :numericality => true, :allow_blank => true
+
+    # Before validation, set the permalink if we don't already have one
+    before_validation { self.permalink = self.name.parameterize if self.permalink.blank? && self.name.is_a?(String) }
+
+    # All active products
+    scope :active, -> { where(:active => true) }
+
+    # All featured products
+    scope :featured, -> {where(:featured => true)}
+
+    # All products ordered with default items first followed by name ascending
+    scope :ordered, -> {order(:default => :desc, :name => :asc)}
+
+    # Return the name of the product
+    #
+    # @return [String]
+    def full_name
+      self.parent ? "#{self.parent.name} (#{name})" : name
+    end
+
+    # Is this product orderable?
+    #
+    # @return [Boolean]
+    def orderable?
+      return false unless self.active?
+      return false if self.has_variants?
+      true
+    end
+
+    # The price for the product
+    #
+    # @return [BigDecimal]
+    def price
+      self.default_variant ? self.default_variant.price : read_attribute(:price)
+    end
+
+    # Is this product currently in stock?
+    #
+    # @return [Boolean]
+    def in_stock?
+      self.default_variant ? self.default_variant.in_stock? : (stock_control? ? stock > 0 : true)
+    end
+
+    # Return the total number of items currently in stock
+    #
+    # @return [Fixnum]
+    def stock
+      self.stock_level_adjustments.sum(:adjustment)
+    end
+
+    # Search for products which include the given attributes and return an active record
+    # scope of these products. Chainable with other scopes and with_attributes methods.
+    # For example:
+    #
+    #   Tienda::Product.active.with_attribute('Manufacturer', 'Apple').with_attribute('Model', ['Macbook', 'iPhone'])
+    #
+    # @return [Enumerable]
+    def self.with_attributes(key, values)
+      product_ids = Tienda::ProductAttribute.searchable.where(:key => key, :value => values).pluck(:product_id).uniq
+      where(:id => product_ids)
+    end
+
+    # Imports products from a spreadsheet file
+    # Example:
+    #
+    #   Tienda:Product.import("path/to/file.csv")
+    def self.import(file)
+      spreadsheet = open_spreadsheet(file)
+      spreadsheet.default_sheet = spreadsheet.sheets.first
+      header = spreadsheet.row(1)
+      (2..spreadsheet.last_row).each do |i|
+        row = Hash[[header, spreadsheet.row(i)].transpose]
+
+        # Don't import products where the name is blank
+        unless row["name"].nil?
+          if product = find_by(name: row["name"])
+            # Dont import products with the same name but update quantities if they're not the same
+            qty = row["qty"].to_i
+            if qty > 0 && qty != product.stock
+              product.stock_level_adjustments.create!(description: I18n.t('tienda.import'), adjustment: qty)
+            end
+          else
+            product = new
+            product.name = row["name"]
+            product.sku = row["sku"]
+            product.description = row["description"]
+            product.short_description = row["short_description"]
+            product.weight = row["weight"]
+            product.price = row["price"].nil? ? 0 : row["price"]
+
+            product.product_category_id = begin
+              if Tienda::ProductCategory.find_by(name: row["category_name"]).present?
+                # Find and set the category
+                Tienda::ProductCategory.find_by(name: row["category_name"]).id
+              else
+                # Create the category
+                Tienda::ProductCategory.create(name: row["category_name"]).id
+              end
+            end
+
+            product.save!
+
+            # Create quantities
+            qty = row["qty"].to_i
+            if qty > 0
+              product.stock_level_adjustments.create!(description: I18n.t('tienda.import'), adjustment: qty)
+            end
+          end
+        end
+      end
+    end
+
+    def self.open_spreadsheet(file)
+      case File.extname(file.original_filename)
+      when ".csv" then Roo::CSV.new(file.path)
+      when ".xls" then Roo::Excel.new(file.path)
+      when ".xlsx" then Roo::Excelx.new(file.path)
+      else raise I18n.t('tienda.imports.errors.unknown_format', filename: File.original_filename)
+      end
+    end
+
+  end
+end

data/app/models/tienda/product_attribute.rb

@@ -0,0 +1,66 @@
+module Tienda
+  class ProductAttribute < ActiveRecord::Base
+
+    self.table_name = 'tienda_product_attributes'
+
+    # Validations
+    validates :key, :presence => true
+
+    # The associated product
+    #
+    # @return [Tienda::Product]
+    belongs_to :product, :class_name => 'Tienda::Product'
+
+    # All attributes which are searchable
+    scope :searchable, -> { where(:searchable => true) }
+
+    # All attributes which are public
+    scope :publicly_accessible, -> { where(:public => true) }
+
+    # Return the the available options as a hash
+    #
+    # @return [Hash]
+    def self.grouped_hash
+      all.group_by(&:key).inject(Hash.new) do |h, (key, attributes)|
+        h[key] = attributes.map(&:value).uniq
+        h
+      end
+    end
+
+    # Create/update attributes for a product based on the provided hash of
+    # keys & values.
+    #
+    # @param array [Array]
+    def self.update_from_array(array)
+      existing_keys = self.pluck(:key)
+      index = 0
+      array.each do |hash|
+        next if hash['key'].blank?
+        index += 1
+        params = hash.merge({
+          :searchable => hash['searchable'].to_s == '1',
+          :public => hash['public'].to_s == '1',
+          :position => index
+        })
+        if existing_attr = self.where(:key => hash['key']).first
+          if hash['value'].blank?
+            existing_attr.destroy
+            index -= 1
+          else
+            existing_attr.update_attributes(params)
+          end
+        else
+          attribute = self.create(params)
+        end
+      end
+      self.where(:key => existing_keys - array.map { |h| h['key']}).delete_all
+      true
+    end
+
+    def self.public
+      ActiveSupport::Deprecation.warn("The use of Tienda::ProductAttribute.public is deprecated. use Tienda::ProductAttribute.publicly_accessible.")
+      self.publicly_accessible
+    end
+
+  end
+end

data/app/models/tienda/product_category.rb

@@ -0,0 +1,23 @@
+module Tienda
+  class ProductCategory < ActiveRecord::Base
+
+    self.table_name = 'tienda_product_categories'
+
+    # Categories have an image attachment
+    attachment :image
+
+    # All products within this category
+    has_many :products, :dependent => :restrict_with_exception, :class_name => 'Tienda::Product'
+
+    # Validations
+    validates :name, :presence => true
+    validates :permalink, :presence => true, :uniqueness => true, :permalink => true
+
+    # All categories ordered by their name ascending
+    scope :ordered, -> { order(:name) }
+
+    # Set the permalink on callback
+    before_validation { self.permalink = self.name.parameterize if self.permalink.blank? && self.name.is_a?(String) }
+
+  end
+end

data/app/models/tienda/setting.rb

@@ -0,0 +1,68 @@
+require 'ostruct'
+
+module Tienda
+  class Setting < ActiveRecord::Base
+
+    # Validations
+    validates :key, :presence => true, :uniqueness => true
+    validates :value, :presence => true
+    validates :value_type, :presence => true
+
+    before_validation do
+      self.value_type = I18n.t("tienda.settings.types")[self.key.to_sym].try(:capitalize) || self.value.class.to_s
+      self.value      = encoded_value
+    end
+
+    # The encoded value for saving in the backend (as a string)
+    #
+    # @return [String]
+    def encoded_value
+      case value_type
+      when 'Array', 'Hash'  then  value.to_json
+      when 'Boolean'        then  value.to_s == 'true' ? 'true' : 'false'
+      else                        value.to_s
+      end
+    end
+
+    # The decoded value for the setting attribute (in it's native type)
+    #
+    # @return [Object]
+    def decoded_value
+      case value_type
+      when 'Fixnum'         then  value.to_i
+      when 'Float'          then  value.to_f
+      when 'Array', 'Hash'  then  JSON.parse(value)
+      when 'Boolean'        then  value == 'true' ? true : false
+      else                        value.to_s
+      end
+    end
+
+    # A full hash of all settings available in the current scope
+    #
+    # @return [Hash]
+    def self.to_hash
+      all.inject({}) do |h, setting|
+        h[setting.key.to_s] = setting.decoded_value
+        h
+      end
+    end
+
+    # Update settings from a given hash and persist them. Accepts a
+    # hash of keys (which should be strings).
+    #
+    # @return [Hash]
+    def self.update_from_hash(hash)
+      existing_settings = self.all.to_a
+      hash.each do |key, value|
+        existing = existing_settings.select { |s| s.key.to_s == key.to_s }.first
+        if existing
+          value.blank? ? existing.destroy! : existing.update!(:value => value)
+        else
+          value.blank? ? nil : self.create!(:key => key, :value => value)
+        end
+      end
+      hash
+    end
+
+  end
+end

data/app/models/tienda/stock_level_adjustment.rb

@@ -0,0 +1,19 @@
+module Tienda
+  class StockLevelAdjustment < ActiveRecord::Base
+
+    # The orderable item which the stock level adjustment belongs to
+    belongs_to :item, :polymorphic => true
+
+    # The parent (OrderItem) which the stock level adjustment belongs to
+    belongs_to :parent, :polymorphic => true
+
+    # Validations
+    validates :description, :presence => true
+    validates :adjustment, :numericality => true
+    validate { errors.add(:adjustment, I18n.t('tienda.activerecord.attributes.stock_level_adjustment.must_be_greater_or_equal_zero')) if adjustment == 0 }
+
+    # All stock level adjustments ordered by their created date desending
+    scope :ordered, -> { order(:id => :desc) }
+
+  end
+end

data/app/models/tienda/tax_rate.rb

@@ -0,0 +1,46 @@
+module Tienda
+  class TaxRate < ActiveRecord::Base
+
+    self.table_name = 'tienda_tax_rates'
+
+    include Tienda::AssociatedCountries
+
+    # The order address types which may be used when choosing how to apply the tax rate
+    ADDRESS_TYPES = ['billing', 'delivery']
+
+    # Validations
+    validates :name, :presence => true
+    validates :address_type, :inclusion => {:in => ADDRESS_TYPES}
+    validates :rate, :numericality => true
+
+    # All products which are assigned to this tax rate
+    has_many :products, :dependent => :restrict_with_exception, :class_name => 'Tienda::Product'
+
+    # All delivery service prices which are assigned to this tax rate
+    has_many :delivery_service_prices, :dependent => :restrict_with_exception, :class_name => 'Tienda::DeliveryServicePrice'
+
+    # All tax rates ordered by their ID
+    scope :ordered, -> { order(:id)}
+
+    # Set the address type if appropriate
+    before_validation { self.address_type = ADDRESS_TYPES.first if self.address_type.blank? }
+
+    # A description of the tax rate including its name & percentage
+    #
+    # @return [String]
+    def description
+      "#{name} (#{rate}%)"
+    end
+
+    # The rate for a given order based on the rules on the tax rate
+    #
+    # @return [BigDecimal]
+    def rate_for(order)
+      return rate if countries.empty?
+      return rate if address_type == 'billing'  && (order.billing_country.nil?   || country?(order.billing_country))
+      return rate if address_type == 'delivery' && (order.delivery_country.nil?  || country?(order.delivery_country))
+      BigDecimal(0)
+    end
+
+  end
+end

data/app/models/tienda/user.rb

@@ -0,0 +1,49 @@
+module Tienda
+  class User < ActiveRecord::Base
+
+    self.table_name = 'tienda_users'
+
+    has_secure_password
+
+    # Validations
+    validates :first_name, :presence => true
+    validates :last_name, :presence => true
+    validates :email_address, :presence => true
+
+    # The user's first name & last name concatenated
+    #
+    # @return [String]
+    def full_name
+      "#{first_name} #{last_name}"
+    end
+
+    # The user's first name & initial of last name concatenated
+    #
+    # @return [String]
+    def short_name
+      "#{first_name} #{last_name[0,1]}"
+    end
+
+    # Reset the user's password to something random and e-mail it to them
+    def reset_password!
+      self.password = SecureRandom.hex(8)
+      self.password_confirmation = self.password
+      self.save!
+      Tienda::UserMailer.new_password(self).deliver
+    end
+
+    # Attempt to authenticate a user based on email & password. Returns the
+    # user if successful otherwise returns false.
+    #
+    # @param email_address [String]
+    # @param paassword [String]
+    # @return [Tienda::User]
+    def self.authenticate(email_address, password)
+      user = self.where(:email_address => email_address).first
+      return false if user.nil?
+      return false unless user.authenticate(password)
+      user
+    end
+
+  end
+end

data/app/validators/permalink_validator.rb

@@ -0,0 +1,7 @@
+class PermalinkValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /\A[a-zA-Z0-9-_]+\Z/
+      record.errors.add(attribute, :wrong_format)
+    end
+  end
+end

data/app/views/layouts/tienda/application.html.haml

@@ -0,0 +1,34 @@
+!!!
+%html
+  %head
+    %title #{@page_title} - Tienda
+    = stylesheet_link_tag 'tienda/application'
+    = javascript_include_tag 'tienda/application'
+    = csrf_meta_tags
+    :javascript
+      window.Tienda = {}
+      window.Tienda.currencyUnit = "#{h Tienda.settings.currency_unit}";
+  %body
+    %nav.sidebar
+      %header.logo
+        %h1= link_to "Tienda", root_path
+        %p v#{Tienda::VERSION}
+      %p.logged= t('.logged_in_as', user_name: current_user.full_name)
+
+      %ul
+        - for item in Tienda::NavigationManager.find(:admin_primary).items
+          %li= navigation_manager_link item
+
+        %li= link_to t('.logout'), [:logout], :method => :delete
+
+    %header.main
+      = yield :header
+
+    #content
+      = display_flash
+      %section.main
+        = yield
+
+    %footer
+      %p.store= link_to "← #{t('.goto')} #{Tienda.settings.store_name}".html_safe, '/'
+

data/app/views/layouts/tienda/printable.html.haml

@@ -0,0 +1,11 @@
+!!!
+%html
+  %head
+    %title= @page_title
+    = stylesheet_link_tag 'tienda/printable', :media => :all
+    :javascript
+      window.print();
+  %body
+    #content
+      = yield
+      

data/app/views/layouts/tienda/sub.html.haml

@@ -0,0 +1,10 @@
+!!!
+%html.login
+  %head
+    %title #{@page_title} - Tienda
+    %meta{:name => 'viewport', :content => 'width=device-width, initial-scale=1.0'}
+    = stylesheet_link_tag 'tienda/sub'
+    = javascript_include_tag 'tienda/application'
+  %body
+    #content
+      = yield

data/app/views/tienda/countries/_form.html.haml

@@ -0,0 +1,35 @@
+= form_for @country do |f|
+  = f.error_messages
+  = field_set_tag t('tienda.countries.country_details') do
+
+    .splitContainer
+      %dl.third
+        %dt= f.label :name, t('tienda.countries.name')
+        %dd= f.text_field :name, :class => 'focus text'
+      %dl.third
+        %dt= f.label :code2, t('tienda.countries.iso_alpha_2')
+        %dd= f.text_field :code2, :class => 'text'
+      %dl.third
+        %dt= f.label :code3, t('tienda.countries.iso_alpha_3')
+        %dd= f.text_field :code3, :class => 'text'
+
+    .splitContainer
+      %dl.third
+        %dt= f.label :continent, t('tienda.countries.continent')
+        %dd= f.text_field :continent, :class => 'text'
+      %dl.third
+        %dt= f.label :tld, t('tienda.countries.tld')
+        %dd= f.text_field :tld, :class => 'text'
+      %dl.third
+        %dt= f.label :eu_member, t('tienda.countries.eu_member')
+        %dd.checkbox
+          = f.check_box :eu_member
+          = f.label :eu_member, t('tienda.countries.is_eu_member')
+
+  %p.submit
+    - unless @country.new_record?
+      %span.right
+        = link_to t('tienda.delete'), @country, :class => 'button purple',
+          :method => :delete, :data => {:confirm => t('tienda.countries.delete_confirmation')}
+    = f.submit t('tienda.submit'), :class => 'button green'
+    = link_to t('tienda.cancel'), :countries, :class => 'button'

data/app/views/tienda/countries/edit.html.haml

@@ -0,0 +1,6 @@
+- @page_title = t('tienda.countries.countries')
+
+= content_for :header do
+  %p.buttons= link_to t('tienda.countries.back'), :countries, :class => 'button'
+  %h2.countries= t('tienda.countries.countries')
+= render 'form'

data/app/views/tienda/countries/index.html.haml

@@ -0,0 +1,25 @@
+- @page_title = t('tienda.countries.countries')
+
+= content_for :header do
+  %p.buttons=link_to t('tienda.countries.new_country') , :new_country, :class => 'button green'
+  %h2.countries= t('tienda.countries.countries')
+
+.table
+  %table.data
+    %thead
+      %tr
+        %th= t('tienda.countries.name')
+        %th= t('tienda.countries.iso_alpha_2')
+        %th= t('tienda.countries.iso_alpha_3')
+        %th= t('tienda.countries.continent')
+        %th= t('tienda.countries.tld')
+        %th= t('tienda.countries.eu?')
+    %tbody
+      - for country in @countries
+        %tr
+          %td= link_to country.name, [:edit, country]
+          %td= country.code2
+          %td= country.code3
+          %td= country.continent
+          %td= country.tld
+          %td= boolean_tag country.eu_member?

data/app/views/tienda/countries/new.html.haml

@@ -0,0 +1,7 @@
+- @page_title = t('tienda.countries.countries')
+
+= content_for :header do
+  %p.buttons= link_to t('tienda.countries.back') , :countries, :class => 'button'
+  %h2.countries= t('tienda.countries.countries')
+
+= render 'form'