shoppe 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b79095cb897e80d6693d4cb9f1458f1581d17c2
-  data.tar.gz: c44a89fb521ab3051320be885c2255e954265b27
+  metadata.gz: 654732ba8cacdcd7bbca27157c736b6e580057b5
+  data.tar.gz: 79ca38d5d11640b2eae2cf4a6312c4ea700345c9
 SHA512:
-  metadata.gz: 3fcb2055f19c5bdbb15b97a924f6fe6d312da850aa8ebbe3ddc94ef43e9c71f81be613e9f6c4ddff1322f224e5ac1325aec4d73e3db1a0b3d3a2e890b70c2ed1
-  data.tar.gz: f3ee60d2f4eb75d0ecc05786cc35772400c1a8783ff37e824d50a6066b41af889884aa466e69d4088e6dc7baa34029fdf5527c352b89b7657209e013c96f7bc7
+  metadata.gz: 01b12f0ef8412ead707dcdb3181af156b5112de357f001e9315dc1844b1017a1d167d8b147b26e043b0a04960443d42c2202f917f70f8bd754e04ea187434cd9
+  data.tar.gz: de74b94ebf50aa7d0609909b04e6004655f91dd86fd530b54b41095092485bff219182ff44eb55cf1b23cc2e36f2322ff28b46430d80bf4453230daad07e04c3

data/README.md

@@ -0,0 +1,55 @@
+# Shoppe
+
+Shoppe is an Rails-based e-commerce platform which allows you to easily introduce a
+catalogue-based store into your Rails 4 applications. 
+
+![GemVersion](https://badge.fury.io/rb/shoppe.png)
+[![Code Climate](https://codeclimate.com/github/tryshoppe/core/badges/gpa.svg)](https://codeclimate.com/github/tryshoppe/core)
+[![Build Status](https://travis-ci.org/tryshoppe/shoppe.svg?branch=master)](https://travis-ci.org/tryshoppe/shoppe)
+
+* [Check out the website](http://tryshoppe.com)
+* [View the demo site](http://demo.tryshoppe.com)
+* [Check out the demo site source](http://github.com/tryshoppe/example-store)
+* [Read the release notes](https://github.com/tryshoppe/core/blob/master/CHANGELOG.md)
+* [Read API documentation](http://api.tryshoppe.com)
+
+## Features
+
+* An attractive & easy to use admin interface with integrated authentication
+* Full product/catalogue management
+* Stock control
+* Tax management
+* Flexible & customisable order flow
+* Delivery/shipping control, management & weight-based calculation
+
+## Getting Started
+
+Shoppe provides the core framework for the store and you're responsible for creating
+the storefront which your customers will use to purchase products. In addition to
+creating the UI for the frontend, you are also responsible for integrating with whatever
+payment gateway takes your fancy.
+
+### Installing into a new Rails application
+
+To get up and running with Shoppe in a new Rails application is simple. Just follow the
+instructions below and you'll be up and running in minutes.
+
+    rails new my_store
+    cd my_store
+    echo "gem 'shoppe', '~> 1.0'" >> Gemfile
+    bundle
+    rails generate shoppe:setup
+    rails generate nifty:attachments:migration
+    rails generate nifty:key_value_store:migration
+    rake db:migrate shoppe:setup
+    rails server
+
+## Contribution
+
+If you'd like to help with this project, please get in touch with me. The best place is on
+Twitter (@adamcooke) or by e-mail to adam@atechmedia.com.
+
+## License
+
+Shoppe is licenced under the MIT license. Full details can be found in the MIT-LICENSE
+file in the root of the repository.

data/app/assets/stylesheets/shoppe/application.scss

@@ -154,6 +154,11 @@ header.main {
 			.splitContainer { margin:0 25px; margin-bottom:15px; height:50px;}
 			.splitContainer:last-child { margin-bottom:0;}
 
+			dl.cleared {
+				margin-top:15px;
+				clear:both;
+			}
+
 			dl {
 				margin:0 25px;
 				margin-bottom:15px;
@@ -262,6 +267,17 @@ header.main {
 					width:auto;
 				}
 			}
+
+			//
+			// category's children table
+			//
+			table.categoryChildren {
+				@extend table.importExample;
+				a { color:#000; }
+				tr:nth-last-child(2) td {
+					border: 1px solid #ddd;
+				}
+			}
 		}
 		p.submit {margin:0; background:#fff; border:1px solid #dce2eb; padding:25px; }
 		p.submit .button {

data/app/controllers/shoppe/product_categories_controller.rb

@@ -5,7 +5,7 @@ module Shoppe
     before_filter { params[:id] && @product_category = Shoppe::ProductCategory.find(params[:id]) }
 
     def index
-      @product_categories = Shoppe::ProductCategory.ordered.all
+      @product_categories_without_parent = Shoppe::ProductCategory.without_parent.ordered
     end
 
     def new
@@ -40,7 +40,7 @@ module Shoppe
     private
 
     def safe_params
-      params[:product_category].permit(:name, :permalink, :description, :image_file)
+      params[:product_category].permit(:name, :permalink, :description, :image_file, :parent_id, :permalink_includes_ancestors)
     end
 
   end

data/app/controllers/shoppe/products_controller.rb

@@ -5,7 +5,7 @@ module Shoppe
     before_filter { params[:id] && @product = Shoppe::Product.root.find(params[:id]) }
 
     def index
-      @products = Shoppe::Product.root.includes(:stock_level_adjustments, :default_image, :product_category, :variants).order(:name).group_by(&:product_category).sort_by { |cat,pro| cat.name }
+      @products = Shoppe::Product.root.includes(:stock_level_adjustments, :default_image, :product_categories, :variants).order(:name).group_by(&:product_category).sort_by { |cat,pro| cat.name }
     end
 
     def new
@@ -51,7 +51,7 @@ module Shoppe
     private
 
     def safe_params
-      params[:product].permit(:product_category_id, :name, :sku, :permalink, :description, :short_description, :weight, :price, :cost_price, :tax_rate_id, :stock_control, :default_image_file, :data_sheet_file, :active, :featured, :in_the_box, :product_attributes_array => [:key, :value, :searchable, :public])
+      params[:product].permit(:name, :sku, :permalink, :description, :short_description, :weight, :price, :cost_price, :tax_rate_id, :stock_control, :default_image_file, :data_sheet_file, :active, :featured, :in_the_box, :product_attributes_array => [:key, :value, :searchable, :public], :product_category_ids => [])
     end
 
   end

data/app/helpers/shoppe/product_category_helper.rb

@@ -0,0 +1,36 @@
+module Shoppe
+  module ProductCategoryHelper
+
+    def nested_product_category_spacing_adjusted_for_depth(category, relative_depth)
+      depth = category.depth - relative_depth
+      spacing = depth < 2 ? 0.8 : 1.5
+      ("<span style='display:inline-block;width:#{spacing}em;'></span>"*category.depth).html_safe
+    end
+
+    def nested_product_category_rows(category, current_category = nil, link_to_current = true, relative_depth = 0)
+      if category.present? && category.children.count > 0
+        String.new.tap do |s|
+          category.children.ordered.each do |child|
+            s << "<tr>"
+            s << "<td>"
+            if child == current_category
+              if link_to_current == false
+                s << "#{nested_product_category_spacing_adjusted_for_depth child, relative_depth} &#8627; #{child.name} (#{t('shoppe.product_category.nesting.current_category')})"
+              else
+                s << "#{nested_product_category_spacing_adjusted_for_depth child, relative_depth} &#8627; #{link_to(child.name, [:edit, child]).html_safe} (#{t('shoppe.product_category.nesting.current_category')})"
+              end
+            else
+              s << "#{nested_product_category_spacing_adjusted_for_depth child, relative_depth} &#8627; #{link_to(child.name, [:edit, child]).html_safe}"
+            end
+            s << "</td>"
+            s << "</tr>"
+            s << nested_product_category_rows(child, current_category, link_to_current, relative_depth)
+          end
+        end.html_safe
+      else
+        ""
+      end
+    end
+
+  end
+end

data/app/models/shoppe/payment.rb

@@ -1,6 +1,10 @@
 module Shoppe
   class Payment < ActiveRecord::Base
 
+    # Additional callbacks
+    extend ActiveModel::Callbacks
+    define_model_callbacks :refund
+
     # The associated order
     #
     # @return [Shoppe::Order]
@@ -50,15 +54,17 @@ module Shoppe
     # @param amount [String] the amount which should be refunded
     # @return [Boolean]
     def refund!(amount)
-      amount = BigDecimal(amount)
-      if refundable_amount >= amount
-        transaction do
-          self.class.create(:parent => self, :order_id => self.order_id, :amount => 0-amount, :method => self.method, :reference => reference)
-          self.update_attribute(:amount_refunded, self.amount_refunded + amount)
-          true
+      run_callbacks :refund do
+        amount = BigDecimal(amount)
+        if refundable_amount >= amount
+          transaction do
+            self.class.create(:parent => self, :order_id => self.order_id, :amount => 0-amount, :method => self.method, :reference => reference)
+            self.update_attribute(:amount_refunded, self.amount_refunded + amount)
+            true
+          end
+        else
+          raise Shoppe::Errors::RefundFailed, :message => I18n.t('.refund_failed', refundable_amount: refundable_amount)
         end
-      else
-        raise Shoppe::Errors::RefundFailed, :message => I18n.t('.refund_failed', refundable_amount: refundable_amount)
       end
     end
 

data/app/models/shoppe/product.rb

@@ -13,10 +13,14 @@ module Shoppe
     attachment :default_image
     attachment :data_sheet
 
-    # The product's category
+    # The product's categorizations
+    #
+    # @return [Shoppe::ProductCategorization]
+    has_many :product_categorizations, dependent: :destroy, class_name: 'Shoppe::ProductCategorization', inverse_of: :product
+    # The product's categories
     #
     # @return [Shoppe::ProductCategory]
-    belongs_to :product_category, :class_name => 'Shoppe::ProductCategory'
+    has_many :product_categories, class_name: 'Shoppe::ProductCategory', through: :product_categorizations
 
     # The product's tax rate
     #
@@ -34,7 +38,7 @@ module Shoppe
 
     # Validations
     with_options :if => Proc.new { |p| p.parent.nil? } do |product|
-      product.validates :product_category_id, :presence => true
+      product.validate :has_at_least_one_product_category
       product.validates :description, :presence => true
       product.validates :short_description, :presence => true
     end
@@ -94,6 +98,13 @@ module Shoppe
       self.stock_level_adjustments.sum(:adjustment)
     end
 
+    # Return the first product category
+    #
+    # @return [Shoppe::ProductCategory]
+    def product_category
+      self.product_categories.first rescue nil
+    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:
@@ -134,19 +145,16 @@ module Shoppe
             product.weight = row["weight"]
             product.price = row["price"].nil? ? 0 : row["price"]
 
-            product.product_category_id = begin
+            product.product_categories << begin
               if Shoppe::ProductCategory.find_by(name: row["category_name"]).present?
-                # Find and set the category
-                Shoppe::ProductCategory.find_by(name: row["category_name"]).id
+                Shoppe::ProductCategory.find_by(name: row["category_name"])
               else
-                # Create the category
-                Shoppe::ProductCategory.create(name: row["category_name"]).id
+                Shoppe::ProductCategory.create(name: row["category_name"])
               end
             end
 
             product.save!
 
-            # Create quantities
             qty = row["qty"].to_i
             if qty > 0
               product.stock_level_adjustments.create!(description: I18n.t('shoppe.import'), adjustment: qty)
@@ -165,5 +173,13 @@ module Shoppe
       end
     end
 
+    private
+
+    # Validates
+
+    def has_at_least_one_product_category
+      errors.add(:base, 'must add at least one product category') if self.product_categories.blank?
+    end
+
   end
 end

data/app/models/shoppe/product_categorization.rb

@@ -0,0 +1,14 @@
+module Shoppe
+  class ProductCategorization < ActiveRecord::Base
+  
+    self.table_name = 'shoppe_product_categorizations'
+
+    # Links back 
+    belongs_to :product, class_name: 'Shoppe::Product'
+    belongs_to :product_category, class_name: 'Shoppe::ProductCategory'
+    
+    # Validations
+    validates_presence_of :product, :product_category
+
+  end
+end

data/app/models/shoppe/product_category.rb

@@ -1,23 +1,68 @@
+require 'awesome_nested_set'
+
 module Shoppe
   class ProductCategory < ActiveRecord::Base
 
+    # Allow the nesting of product categories
+    # :restrict_with_exception relies on a fix to the awesome_nested_set gem
+    # which has been referenced in the Gemfile as we can't add a dependency
+    # to a branch in the .gemspec
+    acts_as_nested_set  dependent: :restrict_with_exception,
+                        after_move: :set_ancestral_permalink
+  
     self.table_name = 'shoppe_product_categories'
-
+    
     # Categories have an image attachment
     attachment :image
 
     # All products within this category
-    has_many :products, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Product'
+    has_many :product_categorizations, dependent: :restrict_with_exception, class_name: 'Shoppe::ProductCategorization', inverse_of: :product_category
+    has_many :products, class_name: 'Shoppe::Product', through: :product_categorizations
 
     # Validations
     validates :name, :presence => true
-    validates :permalink, :presence => true, :uniqueness => true, :permalink => true
+    validates :permalink, :presence => true, :uniqueness => {scope: :parent_id}, :permalink => true
 
     # All categories ordered by their name ascending
     scope :ordered, -> { order(:name) }
 
+    # Root (no parent) product categories only
+    scope :without_parent, -> { where(parent_id: nil) }
+ 
+    # No descendents
+    scope :except_descendants, ->(record) { where.not(id: (Array.new(record.descendants) << record).flatten) }
+    
     # Set the permalink on callback
-    before_validation { self.permalink = self.name.parameterize if self.permalink.blank? && self.name.is_a?(String) }
+    before_validation :set_permalink, :set_ancestral_permalink
+    after_save :set_child_permalinks
+
+    def combined_permalink
+      if self.permalink_includes_ancestors && self.ancestral_permalink.present?
+        "#{self.ancestral_permalink}/#{self.permalink}"
+      else
+        self.permalink
+      end
+    end
+
+    private
+
+    def set_permalink
+      self.permalink = self.name.parameterize if self.permalink.blank? && self.name.is_a?(String)
+    end
+
+    def set_ancestral_permalink
+      permalinks = Array.new
+      self.ancestors.each do |category|
+        permalinks << category.permalink
+      end
+      self.ancestral_permalink = permalinks.join '/'
+    end
 
+    def set_child_permalinks
+      self.children.each do |category|
+        category.save!  # save forces children to update their ancestral_permalink
+      end
+    end
+  
   end
 end

data/app/views/shoppe/product_categories/_form.html.haml

@@ -1,17 +1,42 @@
 = form_for @product_category do |f|
   = f.error_messages
+
   = field_set_tag t('shoppe.product_category.category_details') do
+    %dl
+      %dt= f.label :name, t('shoppe.product_category.name')
+      %dd= f.text_field :name, :class => 'focus text'
     .splitContainer
-      %dl.half
-        %dt= f.label :name, t('shoppe.product_category.name')
-        %dd= f.text_field :name, :class => 'focus text'
       %dl.half
         %dt= f.label :permalink, t('shoppe.product_category.permalink')
         %dd= f.text_field :permalink, :class => 'text'
-    %dl
+      %dl.half
+        %dt  
+        %dd.checkbox
+          = f.check_box :permalink_includes_ancestors
+          = f.label :permalink_includes_ancestors, t('shoppe.product_category.permalink_includes_ancestors')
+    %dl.cleared
       %dt= f.label :description, t('shoppe.product_category.description')
       %dd= f.text_area :description, :class => 'text'
 
+  = field_set_tag t('shoppe.product_category.nesting.category_nesting') do
+    %dl
+      %dt= f.label :parent_id, t('shoppe.product_category.nesting.category_parent')
+      %dd= f.collection_select :parent_id, Shoppe::ProductCategory.except_descendants(@product_category).ordered, :id, :name, {:include_blank => t('shoppe.product_category.nesting.blank_option')}, {:class => 'chosen'}  
+    %dl
+      %dt= f.label :child_ids, t('shoppe.product_category.nesting.hierarchy')
+      %dd
+        %table.categoryChildren
+          %tbody
+            - if @product_category.children.count == 0
+              %tr
+                %td
+                  = t('shoppe.product_category.nesting.no_children')
+            - else
+              %tr
+                %td
+                  = "#{@product_category.name} (#{t('shoppe.product_category.nesting.current_category')})" 
+                = nested_product_category_rows(@product_category, current_category = @product_category, link_to_current = false, relative_depth = @product_category.depth)
+
   = field_set_tag t('shoppe.product_category.attachments') do
     %dl
       %dt= f.label :image_file, t('shoppe.product_category.image')

data/app/views/shoppe/product_categories/index.html.haml

@@ -10,10 +10,11 @@
       %tr
         %th= t('shoppe.product_category.name')
     %tbody
-      - if @product_categories.empty?
+      - if @product_categories_without_parent.empty?
         %tr.empty
           %td= t('shoppe.product_category.no_categories')
       - else
-        - for cat in @product_categories
+        - for cat in @product_categories_without_parent
           %tr
             %td= link_to cat.name, [:edit, cat]
+          = nested_product_category_rows(cat)

data/app/views/shoppe/products/_form.html.haml

@@ -2,8 +2,8 @@
   = f.error_messages
   = field_set_tag  t('shoppe.products.product_information') do
     %dl
-      %dt= f.label :product_category_id, t('shoppe.products.product_category')
-      %dd= f.collection_select :product_category_id, Shoppe::ProductCategory.ordered, :id, :name, {:prompt => false}, {:class => 'chosen'}
+      %dt= f.label :product_categories, t('shoppe.product_category.product_categories')
+      %dd= f.collection_select :product_category_ids, Shoppe::ProductCategory.ordered, :id, :name, {:prompt => false}, {:class => 'chosen', :multiple => true, :data => {:placeholder => t('shoppe.product_category.choose_product_category') }}
 
     .splitContainer
       %dl.third