solidus_related_products 1.0.0

data/app/models/spree/calculator/related_product_discount.rb

@@ -0,0 +1,50 @@
+module Spree
+  class Calculator::RelatedProductDiscount < Spree::Calculator
+    def self.description
+      Spree.t(:related_product_discount)
+    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 |sum, line_item|
+        relations =  Spree::Relation.where(*discount_query(line_item))
+        discount_applies_to = relations.map {|rel| rel.related_to.master }
+
+        order.line_items.each do |li|
+          next unless discount_applies_to.include? li.variant
+          discount = relations.detect { |rel| rel.related_to.master == li.variant }.discount_amount
+          sum +=  if li.quantity < line_item.quantity
+                    (discount * li.quantity)
+                  else
+                    (discount * line_item.quantity)
+                  end
+        end
+
+        sum
+      end
+
+      total
+    end
+
+    def eligible?(order)
+      order.line_items.any? do |line_item|
+        Spree::Relation.exists?(discount_query(line_item))
+      end
+    end
+
+    def discount_query(line_item)
+      [
+        'discount_amount <> 0.0 AND relatable_type = ? AND relatable_id = ?',
+        'Spree::Product',
+        line_item.variant.product.id
+      ]
+    end
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,106 @@
+Spree::Product.class_eval do
+  has_many :relations, -> { order(:position) }, as: :relatable
+
+  # When a Spree::Product is destroyed, we also want to destroy all Spree::Relations
+  # "from" it as well as "to" it.
+  after_destroy :destroy_product_relations
+
+  # Returns all the Spree::RelationType's which apply_to this class.
+  def self.relation_types
+    Spree::RelationType.where(applies_to: to_s).order(:name)
+  end
+
+  # The AREL Relations that will be used to filter the resultant items.
+  #
+  # By default this will remove any items which are deleted, or not yet available.
+  #
+  # You can override this method to fine tune the filter. For example,
+  # to only return Spree::Product's with more than 2 items in stock, you could
+  # do the following:
+  #
+  #   def self.relation_filter
+  #     set = super
+  #     set.where('spree_products.count_on_hand >= 2')
+  #   end
+  #
+  # This could also feasibly be overridden to sort the result in a
+  # particular order, or restrict the number of items returned.
+  def self.relation_filter
+    where('spree_products.deleted_at' => nil)
+      .where('spree_products.available_on IS NOT NULL')
+      .where('spree_products.available_on <= ?', Time.now)
+      .references(self)
+  end
+
+  # Decides if there is a relevant Spree::RelationType related to this class
+  # which should be returned for this method.
+  #
+  # If so, it calls relations_for_relation_type. Otherwise it passes
+  # it up the inheritance chain.
+  def method_missing(method, *args)
+    # Fix for Ruby 1.9
+    raise NoMethodError if method == :to_ary
+
+    relation_type = find_relation_type(method)
+    if relation_type.nil?
+      super
+    else
+      relations_for_relation_type(relation_type)
+    end
+  end
+
+  def has_related_products?(relation_method)
+    find_relation_type(relation_method).present?
+  end
+
+  def destroy_product_relations
+    # First we destroy relationships "from" this Product to others.
+    relations.destroy_all
+    # Next we destroy relationships "to" this Product.
+    Spree::Relation.where(related_to_type: self.class.to_s).where(related_to_id: id).destroy_all
+  end
+
+  private
+
+  def find_relation_type(relation_name)
+    self.class.relation_types.detect { |rt| format_name(rt.name) == format_name(relation_name) }
+  rescue ActiveRecord::StatementInvalid
+    # This exception is throw if the relation_types table does not exist.
+    # And this method is getting invoked during the execution of a migration
+    # from another extension when both are used in a project.
+    nil
+  end
+
+  # Returns all the Products that are related to this record for the given RelationType.
+  #
+  # Uses the Relations to find all the related items, and then filters
+  # them using +Product.relation_filter+ to remove unwanted items.
+  def relations_for_relation_type(relation_type)
+    # Find all the relations that belong to us for this RelationType, ordered by position
+    related_ids = relations.where(relation_type_id: relation_type.id).order(:position).select(:related_to_id)
+
+    # Construct a query for all these records
+    result = self.class.where(id: related_ids)
+
+    # Merge in the relation_filter if it's available
+    result = result.merge(self.class.relation_filter) if relation_filter
+
+    # make sure results are in same order as related_ids array  (position order)
+    if result.present?
+      result.where(id: related_ids).order(:position)
+    end
+
+    result
+  end
+
+  # Simple accessor for the class-level relation_filter.
+  # Could feasibly be overloaded to filter results relative to this
+  # record (eg. only higher priced items)
+  def relation_filter
+    self.class.relation_filter
+  end
+
+  def format_name(name)
+    name.to_s.downcase.gsub(' ', '_').pluralize
+  end
+end

data/app/models/spree/relation.rb

@@ -0,0 +1,7 @@
+class Spree::Relation < ActiveRecord::Base
+  belongs_to :relation_type
+  belongs_to :relatable, polymorphic: true
+  belongs_to :related_to, polymorphic: true
+
+  validates :relation_type, :relatable, :related_to, presence: true
+end

data/app/models/spree/relation_type.rb

@@ -0,0 +1,6 @@
+class Spree::RelationType < ActiveRecord::Base
+  has_many :relations, dependent: :destroy
+
+  validates :name, :applies_to, presence: true
+  validates :name, uniqueness: { case_sensitive: false }
+end

data/app/overrides/add_product_relation_admin_sub_menu_tab.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_product_sub_menu',
+  name: 'add_product_relation_admin_sub_menu_tab',
+  insert_bottom: '[data-hook="admin_product_sub_tabs"]',
+  text: '<%= tab :relation_types %>'
+)

data/app/overrides/add_related_product_admin_tabs.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_product_tabs',
+  name: 'add_related_products_admin_tab',
+  insert_bottom: '[data-hook="admin_product_tabs"]',
+  partial: 'spree/admin/products/related_products'
+)

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

@@ -0,0 +1,3 @@
+<li<%== ' class="active"' if current == "Related Products" %>>
+  <%= link_to_with_icon 'resize-small', Spree.t(:related_products), related_admin_product_url(@product) %>
+</li>

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

@@ -0,0 +1,42 @@
+<table class="index sortable" data-hook="products_table" data-sortable-link="<%= update_positions_admin_product_relations_url(@product) %>">
+   <colgroup>
+    <col style="width: 5%" />
+    <col style="width: 35%" />
+    <col style="width: 35%" />
+    <col style="width: 20%" />
+    <col style="width: 5%" />
+  </colgroup>
+  <thead>
+    <tr data-hook="products_header">
+      <th></th>
+      <th><%= Spree.t(:name) %></th>
+      <th><%= Spree.t(:type) %></th>
+      <th><%= Spree.t(:discount_amount) %></th>
+      <th class="actions"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% product.relations.each do |relation| %>
+      <tr id="<%= spree_dom_id relation %>" data-hook="products_row">
+        <td class="handle move-handle">
+          <span class="icon icon-move handle"></span>
+        </td>
+        <td><%= link_to relation.related_to.name, relation.related_to %></td>
+        <td><%= relation.relation_type.name %></td>
+        <td>
+          <%= form_for relation, url: admin_product_relation_path(relation.relatable, relation) do |f| %>
+            <div class="input-group">
+              <%= f.text_field :discount_amount, class: 'form-control text-center' %>
+              <span class="input-group-btn">
+                <%= f.button Spree.t(:update), type: 'submit', class: 'btn btn-primary' %>
+              </span>
+            </div>
+          <% end %>
+        </td>
+        <td class="actions">
+          <%= link_to_delete relation, url: admin_product_relation_url(relation.relatable, relation), no_text: true %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,70 @@
+<%= render partial: 'spree/admin/shared/product_tabs', locals: { current: 'Related Products' } %>
+
+<%= csrf_meta_tag %>
+
+<% if @relation_types.empty? %>
+  <div class="alert alert-warning no-objects-found">
+    <%= Spree.t(:no_relation_types) %>
+  </div>
+<% else %>
+  <div id="add-line-item">
+    <fieldset>
+      <legend><%= Spree.t(:add_related_product) %></legend>
+      <div class="row">
+        <div id="related_product_name" class="col-md-5">
+          <div class="form-group">
+            <%= label_tag :add_variant_name, Spree.t(:name_or_sku_short) %>
+            <%= hidden_field_tag :add_variant_name, '', class: 'variant_autocomplete', style: "display: block !important;" %>
+          </div>
+        </div>
+        <div id="related_product_type" class="col-md-4">
+          <div class="form-group">
+            <%= label_tag :add_type, Spree.t(:type) %>
+            <%= select_tag :add_type, options_for_select(@relation_types.map { |rt| [rt.name, rt.id] }), class: 'select2' %>
+          </div>
+        </div>
+        <div id="related_product_discount" class="col-md-3">
+          <div class="form-group">
+            <%= label_tag :add_discount, Spree.t(:discount_amount) %>
+            <div class="input-group">
+              <%= text_field_tag :add_discount, 0.0, class: 'form-control text-center' %>
+              <span class="input-group-btn">
+                <%= button_link_to Spree.t(:add), admin_product_relations_url(@product), icon: 'add', class: 'btn-success', id: 'add_related_product', data: { update: 'products-table-wrapper' } %>
+              </span>
+            </div>
+          </div>
+        </div>
+      </div>
+    </fieldset>
+  </div>
+
+  <div id="products-table-wrapper">
+    <%= render 'related_products_table', product: @product %>
+  </div>
+
+  <%= content_for :head do %>
+    <script type="text/javascript">
+      var expand_variants = false;
+      $(document).on('click', '#add_related_product', function(){
+        if($('#add_variant_name').val() == '') { return false; }
+        update_target = $(this).data('update');
+        $.ajax({
+          dataType: 'script',
+          url: this.href,
+          type: 'POST',
+          data: {
+            'relation[related_to_type]' : 'Product',
+            'relation[related_to_id]': $('#add_variant_name').val(),
+            'relation[relation_type_id]': $('#add_type').val(),
+            'relation[discount_amount]' : $('#add_discount').val()
+          }
+        });
+        return false;
+      });
+
+      $(function () {
+        $('#add_variant_name.variant_autocomplete').variantAutocomplete();
+      });
+    </script>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,19 @@
+<div data-hook="admin_relation_type_form_fields" class="row">
+  <div class="col-md-12">
+    <div data-hook="name" class="form-group">
+      <%= f.label :name, Spree.t(:name) %> <span class="required">*</span>
+      <%= f.text_field :name, class: 'form-control' %>
+      <%= error_message_on :relation_type, :name %>
+    </div>
+    <div data-hook="applies_to" class="form-group">
+      <%= f.label :applies_to, Spree.t(:applies_to) %> <span class="required">*</span>
+      <%= f.text_field :applies_to, value: f.object.nil? ? 'Spree::Product' : f.object.applies_to, class: 'form-control' %>
+      <%= error_message_on :relation_type, :applies_to %>
+    </div>
+    <div data-hook="description" class="form-group">
+      <%= f.label :description, Spree.t(:description) %><br />
+      <%= f.text_area :description, rows: 4, class: 'form-control' %>
+      <%= error_message_on :relation_type, :description %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,14 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:editing_resource, resource: Spree::RelationType.model_name.human) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:back_to_resource_list, resource: Spree::RelationType.model_name.human), spree.admin_relation_types_path, class: 'btn-primary', icon: 'arrow-left' %>
+<% end %>
+
+<%= form_for [:admin, @relation_type] do |f| %>
+  <fieldset>
+    <%= render 'form', f: f %>
+    <%= render 'spree/admin/shared/edit_resource_links' %>
+  </fieldset>
+<% end %>

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

@@ -0,0 +1,44 @@
+<% content_for :page_title do %>
+  <%= Spree::RelationType.model_name.human(count: :many) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:new_relation_type), new_object_url, class: 'btn-primary', icon: 'add', id: 'admin_new_relation_type' %>
+<% end %>
+
+<% if @relation_types.any? %>
+  <table class="index" id="listing_relation_types" data-hook>
+    <colgroup>
+      <col style="width: 20%" />
+      <col style="width: 20%" />
+      <col style="width: 40%" />
+      <col style="width: 20%" />
+    </colgroup>
+    <thead>
+      <tr data-hook="admin_relation_types_index_headers">
+        <th><%= Spree.t(:name) %></th>
+        <th><%= Spree.t(:applies_to) %></th>
+        <th><%= Spree.t(:description) %></th>
+        <th class="actions" data-hook="admin_pages_index_header_actions"></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @relation_types.each do |relation_type| %>
+        <tr id="<%= spree_dom_id relation_type %>" data-hook="admin_relation_types_index_row" class="<%= cycle('odd', 'even') %>">
+          <td><%= relation_type.name %></td>
+          <td><%= relation_type.applies_to %></td>
+          <td><%= relation_type.description %></td>
+          <td class="actions" data-hook="admin_relation_types_index_row_actions">
+            <%= link_to_edit relation_type, no_text: true %>
+            <%= link_to_delete relation_type, no_text: true %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="alert alert-warning no-objects-found">
+    <%= Spree.t(:no_resource_found, resource: Spree::RelationType.model_name.human(count: :many)) %>,
+    <%= link_to Spree.t(:add_one), spree.new_admin_relation_type_path %>!
+  </div>
+<% end %>

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

@@ -0,0 +1,14 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:new_relation_type) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:back_to_resource_list, resource: Spree::RelationType.model_name.human), spree.admin_relation_types_path, class: 'btn-primary', icon: 'arrow-left' %>
+<% end %>
+
+<%= form_for :relation_type, url: collection_url do |f| %>
+  <fieldset>
+    <%= render 'form', f: f %>
+    <%= render 'spree/admin/shared/new_resource_links' %>
+  </fieldset>
+<% end %>

data/app/views/spree/admin/relations/create.js.erb

@@ -0,0 +1,5 @@
+$('#products-table-wrapper').html('<%= escape_javascript(render "spree/admin/products/related_products_table", product: @product) %>');
+$('#add_product_name').val('');
+$('#add_variant_id').val('');
+$('#add_quantity').val(1);
+$('.actions a').tooltip();

data/app/views/spree/admin/relations/destroy.js.erb

@@ -0,0 +1 @@
+$('#products-table-wrapper').html('<%= escape_javascript(render "spree/admin/products/related_products_table", product: @product) %>');

data/app/views/spree/api/relations/show.v1.rabl

@@ -0,0 +1,2 @@
+object @relation
+attributes *Spree::Relation.column_names

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_related_products/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/cs.yml

@@ -0,0 +1,18 @@
+---
+cs:
+  activerecord:
+    models:
+      spree/relation:
+        one: Relation
+        other: Relations
+      spree/relation_type:
+        one: Relation Type
+        other: Typy vztahů
+  spree:
+    new_relation_type: Nový typ relace
+    related_product_discount: Sleva pro související zboží
+    applies_to: Platí pro
+    related_products: Související zboží
+    add_related_product: Nové související zboží
+    name_or_sku_short: Název nebo SKU
+    no_relation_types: 'Musíte nastavit typy vztahů, než budete moci použít tuto funkci.'