spree_related_products 3.0.1

data/README.markdown

@@ -0,0 +1,45 @@
+Related Products
+================
+
+This extension provides a generic way for you to define different types of relationships between your products, by defining a RelationType for each type of relationship you'd like to maintain.
+
+You can manage RelationTypes via the admin configuration menu, and you can maintain product relationships via __Related Products__ tab on the edit product UI.
+
+Possible uses
+-------------
+
+* Accessories
+
+* Cross Sells
+
+* Up Sells
+
+* Compatible Products
+
+* Replacement Products
+
+* Warranty & Support Products
+
+
+
+Relation Types
+--------------
+When you create a RelationType you can access that set of related products by referencing the relation_type name, see below for an example:
+
+        rt = RelationType.create(:name => "Accessories", :applies_to => "Product")
+         => #<RelationType id: 4, name: "Accessories" ...>
+        product = Product.last
+         => #<Product id: 1060500592 ...>
+        product.accessories
+         => []
+
+You can access all related products regardless of RelationType by:
+
+        product.relations
+         => []
+
+
+Discounts
+---------
+If you install the spree-automatic-coupons extension you can also specify a discount amount to be applied if a customer purchases both products. Note: In order for the coupon to be automatically applied, you must create a coupon of type: __RelatedProductDiscount__ and leave the __code__ value empty (blank codes are required for coupons to be automatically applied).
+

data/app/controllers/admin/relation_types_controller.rb

@@ -0,0 +1,7 @@
+class Admin::RelationTypesController < Admin::BaseController
+ resource_controller
+
+ update.wants.html { redirect_to collection_url }
+ create.wants.html { redirect_to collection_url }
+ destroy.success.wants.js { render_js_for_destroy }
+end

data/app/controllers/admin/relations_controller.rb

@@ -0,0 +1,21 @@
+class Admin::RelationsController < Admin::BaseController
+  resource_controller
+  belongs_to :product
+
+  actions :create, :destroy
+
+  create do
+    flash nil
+  end
+
+  create.before do
+    object.related_to = Variant.find(params[:relation][:related_to_id]).product
+  end
+
+  create.response do |wants|
+    wants.html { render :partial => "admin/products/related_products_table", :locals => {:product => @product}, :layout => false}
+  end
+
+  destroy.success.wants.js { render_js_for_destroy }
+
+end

data/app/helpers/admin/relation_types_helper.rb

@@ -0,0 +1,2 @@
+module Admin::RelationTypesHelper
+end

data/app/helpers/admin/relations_helper.rb

@@ -0,0 +1,2 @@
+module Admin::RelationsHelper
+end

data/app/models/calculator/related_product_discount.rb

@@ -0,0 +1,49 @@
+class Calculator::RelatedProductDiscount < Calculator
+  preference :item_total_threshold, :decimal, :default => 5
+
+  def self.description
+    I18n.t("related_product_discount")
+  end
+
+  def self.register
+    super
+    Coupon.register_calculator(self)
+  end
+
+  def compute(object)
+    if object.is_a?(Array)
+      return if object.empty?
+      order = object.first.order
+    else
+      order = object
+    end
+
+    return unless eligible?(order)
+    total = order.line_items.inject(0) do |total, line_item|
+      relations =  Relation.find(:all, :conditions => ["discount_amount <> 0.0 AND relatable_type = ? AND relatable_id = ?", "Product", line_item.variant.product.id])
+      discount_applies_to = relations.map {|rel| rel.related_to.master }
+
+      order.line_items.each do |li|
+        if discount_applies_to.include? li.variant
+          discount = relations.detect {|rel| rel.related_to.variant == li.variant}.discount_amount
+
+          total += if li.quantity < line_item.quantity
+            (discount * li.quantity)
+          else
+            (discount * line_item.quantity)
+          end
+        end
+      end
+
+      total
+    end
+
+    total == 0 ? nil : total
+  end
+
+  def eligible?(order)
+    order.line_items.any? { |line_item| Relation.exists?(["discount_amount <> 0.0 AND relatable_type = ? AND relatable_id = ?", "Product", line_item.variant.product.id])}
+  end
+
+end
+

data/app/models/relation.rb

@@ -0,0 +1,7 @@
+class Relation < ActiveRecord::Base
+  belongs_to :relation_type
+  belongs_to :relatable, :polymorphic => true
+  belongs_to :related_to, :polymorphic => true
+
+  validates_presence_of :relation_type, :relatable, :related_to
+end

data/app/models/relation_type.rb

@@ -0,0 +1,3 @@
+class RelationType < ActiveRecord::Base
+  has_many :relations
+end

data/app/views/admin/products/_related_products.html.erb

@@ -0,0 +1,5 @@
+<% if url_options_authenticate?(:controller => 'admin/products') %>
+  <li<%= ' class="active"' if current == "Related Products" %>>
+    <%= link_to t("related_products"), related_admin_product_url(@product) %>
+  </li>
+<% end %>

data/app/views/admin/products/_related_products_table.html.erb

@@ -0,0 +1,26 @@
+<table class="index">
+  <thead>
+    <tr>
+      <th><%= t('name') %></th>
+      <% if Spree::Extension.descendants.map(&:to_s).include? "AutomaticCouponsExtension" %>
+        <th><%= t('discount_amount') %></th>
+      <% end %>
+      <th><%= t('type') %></th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% product.relations.each do |relation| %>
+      <tr id="<%= dom_id relation %>">
+        <td><%= relation.related_to.name %></td>
+        <% if Spree::Extension.descendants.map(&:to_s).include? "AutomaticCouponsExtension" %>
+          <td><%= relation.discount_amount != 0 ? number_to_currency(relation.discount_amount) : "-" %></td>
+        <% end %>
+        <td><%= relation.relation_type.name %></td>
+        <td width="70px">
+          <%= link_to_delete relation, {:url => admin_product_relation_url(relation.relatable, relation)} %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/admin/products/related.html.erb

@@ -0,0 +1,50 @@
+<%= render :partial => 'admin/shared/product_sub_menu' %>
+
+<%= render :partial => 'admin/shared/product_tabs', :locals => {:current => "Related Products"} %>
+
+
+<% if @relation_types.empty? %>
+  <%= t("no_relation_types") %>
+<% else %>
+  <div id="add-line-item">
+    <fieldset>
+      <legend><%= t('add_related_product') %></legend>
+      <div style="float:left;width:<%= Spree::Extension.descendants.map(&:to_s).include?("AutomaticCouponsExtension") ? "40" : "55" %>%;margin-right:5%;">
+        <%= label_tag :add_product_name, t("name_or_sku") %>
+        <%= text_field_tag :add_product_name,  {}, :class => 'fullwidth title'  %>
+        <%= hidden_field_tag :add_variant_id %>
+      </div>
+      <% if Spree::Extension.descendants.map(&:to_s).include? "AutomaticCouponsExtension" %>
+        <div style="float:left;width:10%;margin-right:5%;">
+          <%= label_tag :add_discount, t("discount_amount") %>
+          <%= text_field_tag :add_discount, 0.0, :style => 'margin: 0pt; padding: 4px; font-size: 1.5em; width: 98%;'  %>
+        </div>
+      <% end %>
+      <div style="float:left;width:20%;margin-right:5%;">
+        <%= label_tag :add_type, t("type") %>
+        <%= select_tag :add_type, options_for_select(@relation_types.map{|rt| [rt.name, rt.id]}), :style => 'margin: 0pt; padding: 4px; font-size: 1.5em; width: 98%;' %>
+      </div>
+      <div style="float: left; width: 15%; padding-top: 17px;">
+        <%= button_link_to_remote t("add"),
+                           {:url => admin_product_relations_url(@product),
+                           :method => :post,
+                           :with => "'relation[related_to_type]=Product&relation[related_to_id]=' + $('#add_variant_id').val() + '&relation[relation_type_id]=' + $('#add_type').val() + '&relation[discount_amount]=' + $('#add_discount').val()",
+                           :before => "if($('#add_variant_id').val()==''){ return false; }",
+                           :after => "$('#add_product_name').val('');$('#add_variant_id').val('');$('#add_quantity').val(1)",
+                           :update => "products-table-wrapper"}, :icon => 'add' %>
+      </div>
+
+    </fieldset>
+  </div>
+
+  <div id="products-table-wrapper">
+    <%= render :partial => "related_products_table", :locals => {:product => @product} %>
+  </div>
+
+  <% content_for :head do %>
+    <%= javascript_tag "var expand_variants = false;" %>
+    <%= javascript_include_tag 'admin/orders/edit.js' %>
+    <%= stylesheet_link_tag 'admin/edit_orders.css' %>
+  <% end %>
+
+<% end %>

data/app/views/admin/relation_types/_form.html.erb

@@ -0,0 +1,22 @@
+<%- locals = {:f => f} -%>
+<% hook :admin_relation_type_form_fields, locals do %>
+  <% f.field_container :name do %>
+    <%= f.label :name, t("name") %><br />
+    <%= f.text_field :name, :class => 'fullwidth title' %>
+    <%= error_message_on :relation_type, :name %>
+  <% end %>
+
+  <% f.field_container :applies_to do %>
+    <%= f.label :applies_to, t("applies_to") %><br />
+    <%= f.text_field :applies_to, :value => f.object.nil? ? "Product" : f.object.applies_to, :class => 'fullwidth title' %>
+    <%= error_message_on :relation_type, :applies_to%>
+  <% end %>
+
+  <% f.field_container :description do %>
+    <%= f.label :description, t("description") %><br />
+    <%= f.text_area :description, {:cols => 60, :rows => 2, :class => 'fullwidth'} %>
+    <%= error_message_on :relation_type, :description %>
+  <% end %>
+
+<% end %>
+

data/app/views/admin/relation_types/edit.html.erb

@@ -0,0 +1,16 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<% hook :admin_relation_type_edit_form_header do %>
+  <h1><%= t("editing_relation_type") %></h1>
+  <%= error_messages_for :relation_type %>
+<% end %>
+
+<% hook :admin_relation_type_edit_form do %>
+  <% form_for(@relation_type, :url => object_url, :html => { :method => :put }) do |f| %>
+    <%= render :partial => "form", :locals => { :f => f } %>
+
+    <% hook :admin_relation_type_edit_form_buttons do %>
+      <%= render :partial => "admin/shared/edit_resource_links" %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/admin/relation_types/index.html.erb

@@ -0,0 +1,46 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<div class='toolbar'>
+  <ul class='actions'>
+    <li>
+      <%= button_link_to t("new_relation_type"), new_object_url, :icon => 'add'  %>
+    </li>
+  </ul>
+  <br class='clear' />
+</div>
+
+<h1><%= t("relation_types") %></h1>
+
+<table class="index">
+  <thead>
+    <tr>
+    <% hook :admin_relation_types_index_headers do %>
+      <th><%= t("name") %></th>
+      <th><%= t("applies_to") %></th>
+      <th><%= t("description") %></th>
+    <% end %>
+      <th>
+        <% hook :admin_relation_types_index_header_actions %>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @relation_types.each do |relation_type| %>
+      <tr id="<%= dom_id relation_type %>">
+        <%- locals = {:relation_type => relation_type} -%>
+        <% hook :admin_relation_types_index_rows, locals do %>
+          <td><%= relation_type.name %></td>
+          <td><%= relation_type.applies_to %></td>
+          <td><%= relation_type.description %></td>
+        <% end %>
+        <td width="140px">
+          <% hook :admin_relation_types_index_row_actions, locals do %>
+            <%= link_to_edit relation_type %> &nbsp;
+            <%= link_to_delete relation_type %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+

data/app/views/admin/relation_types/new.html.erb

@@ -0,0 +1,17 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<% hook :admin_relation_type_new_form_header do %>
+  <h1><%= t("new_relation_type") %></h1>
+
+  <%= error_messages_for :relation_type %>
+<% end %>
+
+<% hook :admin_relation_type_new_form do %>
+  <% form_for(:relation_type, :url => collection_url) do |f| %>
+    <%= render :partial => "form", :locals => { :f => f } %>
+
+    <% hook :admin_relation_type_new_form_buttons do %>
+      <%= render :partial => "admin/shared/new_resource_links" %>
+    <% end %>
+  <% end %>
+<% end %>

data/lib/spree_related_products.rb

@@ -0,0 +1,43 @@
+require 'spree_core'
+
+module SpreeRelatedProducts
+  class Engine < Rails::Engine
+
+    def self.activate
+
+      # Calculator::RelatedProductDiscount.register
+
+      Product.class_eval do
+        has_many :relations, :as => :relatable
+
+        def self.relation_types
+          RelationType.find_all_by_applies_to(self.to_s, :order => :name)
+        end
+
+        def method_missing(method, *args)
+          relation_type =  self.class.relation_types.detect { |rt| rt.name.downcase.gsub(" ", "_").pluralize == method.to_s.downcase }
+
+          if relation_type.nil?
+            super
+          else
+            relations.find_all_by_relation_type_id(relation_type.id).map(&:related_to).select {|product| product.deleted_at.nil? && product.available_on <= Time.now()}
+          end
+
+        end
+      end
+
+      Admin::ProductsController.class_eval do
+        def related
+          load_object
+          @relation_types = Product.relation_types
+        end
+      end
+
+    end
+
+    config.autoload_paths += %W(#{config.root}/lib #{config.root}/app/models/calculator)
+    config.to_prepare &method(:activate).to_proc
+
+  end
+end
+

data/lib/spree_related_products_hooks.rb

@@ -0,0 +1,9 @@
+class SpreeRelatedProductsHooks < Spree::ThemeSupport::HookListener
+
+  insert_after :admin_product_tabs, "admin/products/related_products"
+
+  insert_after :admin_configurations_menu do
+    "<%= configurations_menu_item(I18n.t('relation_types'), admin_relation_types_url, I18n.t('manage_relation_types')) %>"
+  end
+
+end

data/lib/tasks/related_products_extension_tasks.rake

@@ -0,0 +1,17 @@
+namespace :spree do
+  namespace :extensions do
+    namespace :related_products do
+      desc "Copies public assets of the Related Products to the instance public/ directory."
+      task :update => :environment do
+        is_svn_git_or_dir = proc {|path| path =~ /\.svn/ || path =~ /\.git/ || File.directory?(path) }
+        Dir[RelationsExtension.root + "/public/**/*"].reject(&is_svn_git_or_dir).each do |file|
+          path = file.sub(RelationsExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: spree_related_products
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 1
+  version: 3.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: -1848229955
+        segments: 
+        - 0
+        - 30
+        - 0
+        - beta1
+        version: 0.30.0.beta1
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/spree_related_products.rb
+- lib/spree_related_products_hooks.rb
+- lib/tasks/related_products_extension_tasks.rake
+- app/controllers/admin/relation_types_controller.rb
+- app/controllers/admin/relations_controller.rb
+- app/helpers/admin/relation_types_helper.rb
+- app/helpers/admin/relations_helper.rb
+- app/models/calculator/related_product_discount.rb
+- app/models/relation.rb
+- app/models/relation_type.rb
+- app/views/admin/products/_related_products.html.erb
+- app/views/admin/products/_related_products_table.html.erb
+- app/views/admin/products/related.html.erb
+- app/views/admin/relation_types/_form.html.erb
+- app/views/admin/relation_types/edit.html.erb
+- app/views/admin/relation_types/index.html.erb
+- app/views/admin/relation_types/new.html.erb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Allows multiple types of relationships between products to be defined
+test_files: []
+