solidus_product_assembly 1.0.0 → 1.1.0

data/app/decorators/models/solidus_product_assembly/spree/line_item_decorator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module LineItemDecorator
+      def self.prepended(base)
+        base.class_eval do
+          scope :assemblies, -> { joins(product: :parts).distinct }
+        end
+      end
+
+      def any_units_shipped?
+        inventory_units.any?(&:shipped?)
+      end
+
+      # The parts that apply to this particular LineItem. Usually `product#parts`, but
+      # provided as a hook if you want to override and customize the parts for a specific
+      # LineItem.
+      delegate :parts, to: :product
+
+      # The number of the specified variant that make up this LineItem. By default, calls
+      # `product#count_of`, but provided as a hook if you want to override and customize
+      # the parts available for a specific LineItem. Note that if you only customize whether
+      # a variant is included in the LineItem, and don't customize the quantity of that part
+      # per LineItem, you shouldn't need to override this method.
+      delegate :count_of, to: :product
+
+      def quantity_by_variant
+        if product.assembly?
+          {}.tap { |hash| product.assemblies_parts.each { |ap| hash[ap.part] = ap.count * quantity } }
+        else
+          { variant => quantity }
+        end
+      end
+
+      private
+
+      def update_inventory
+        saved_changes = respond_to?(:saved_changes?) ? saved_changes? : changed?
+        if (saved_changes || target_shipment.present?) && order.has_checkout_step?("delivery")
+          if product.assembly?
+            ::Spree::OrderInventoryAssembly.new(self).verify(target_shipment)
+          else
+            ::Spree::OrderInventory.new(order, self).verify(target_shipment)
+          end
+        end
+      end
+
+      ::Spree::LineItem.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/product_decorator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module ProductDecorator
+      def self.prepended(base)
+        base.class_eval do
+          has_and_belongs_to_many :parts, class_name: "Spree::Variant",
+                                          join_table: "spree_assemblies_parts",
+                                          foreign_key: "assembly_id", association_foreign_key: "part_id"
+
+          has_many :assemblies_parts, class_name: "Spree::AssembliesPart",
+                                      foreign_key: "assembly_id"
+
+          scope :individual_saled, -> { where(individual_sale: true) }
+
+          scope :search_can_be_part, ->(query){
+            not_deleted.available.joins(:master)
+                       .where(arel_table["name"].matches("%#{query}%").or(::Spree::Variant.arel_table["sku"].matches("%#{query}%")))
+                       .where(can_be_part: true)
+                       .limit(30)
+          }
+
+          validate :assembly_cannot_be_part, if: :assembly?
+        end
+      end
+
+      def add_part(variant, count = 1)
+        set_part_count(variant, count_of(variant) + count)
+      end
+
+      def remove_part(variant)
+        set_part_count(variant, 0)
+      end
+
+      def set_part_count(variant, count)
+        ap = assemblies_part(variant)
+        if count > 0
+          ap.count = count
+          ap.save
+        else
+          ap.destroy
+        end
+        reload
+      end
+
+      def assembly?
+        parts.present?
+      end
+
+      def count_of(variant)
+        ap = assemblies_part(variant)
+        # This checks persisted because the default count is 1
+        ap.persisted? ? ap.count : 0
+      end
+
+      def assembly_cannot_be_part
+        errors.add(:can_be_part, I18n.t('spree.assembly_cannot_be_part')) if can_be_part
+      end
+
+      private
+
+      def assemblies_part(variant)
+        ::Spree::AssembliesPart.get(id, variant.id)
+      end
+
+      ::Spree::Product.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/return_item_decorator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module ReturnItemDecorator
+      def self.prepended(base)
+        base.class_eval do
+          self.refund_amount_calculator = ::Spree::Calculator::Returns::AssembliesDefaultRefundAmount
+        end
+      end
+
+      ::Spree::ReturnItem.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/shipment_decorator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module ShipmentDecorator
+      # Overriden from Spree core as a product bundle part should not be put
+      # together with an individual product purchased (even though they're the
+      # very same variant) That is so we can tell the store admin which units
+      # were purchased individually and which ones as parts of the bundle
+      #
+      # Account for situations where we can't track the line_item for a variant.
+      # This should avoid exceptions when users upgrade from spree 1.3
+      #
+      # TODO Can possibly be removed as well. We already override the manifest
+      # partial so we can get the product there
+      def manifest
+        items = []
+        inventory_units.joins(:variant).includes(:variant, :line_item).group_by(&:variant).each do |variant, units|
+          units.group_by(&:line_item).each do |line_item, units|
+            states = {}
+            units.group_by(&:state).each { |state, iu| states[state] = iu.count }
+            line_item ||= order.find_line_item_by_variant(variant)
+
+            part = line_item ? line_item.product.assembly? : false
+            items << OpenStruct.new(part: part,
+                                    product: line_item.try(:product),
+                                    line_item: line_item,
+                                    variant: variant,
+                                    quantity: units.length,
+                                    states: states)
+          end
+        end
+        items
+      end
+
+      # There might be scenarios where we don't want to display every single
+      # variant on the shipment. e.g. when ordering a product bundle that includes
+      # 5 other parts. Frontend users should only see the product bundle as a
+      # single item to ship
+      def line_item_manifest
+        inventory_units.includes(:line_item, :variant).group_by(&:line_item).map do |line_item, units|
+          states = {}
+          units.group_by(&:state).each { |state, iu| states[state] = iu.count }
+          OpenStruct.new(line_item: line_item, variant: line_item.variant, quantity: units.length, states: states)
+        end
+      end
+
+      def inventory_units_for_item(line_item, variant)
+        inventory_units.where(line_item_id: line_item.id, variant_id: variant.id)
+      end
+
+      ::Spree::Shipment.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/stock/availability_validator_decorator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module Stock
+      # Overridden from spree core to make it also check for assembly parts stock
+      module AvailabilityValidatorDecorator
+        def validate(line_item)
+          if line_item.product.assembly?
+            line_item.quantity_by_variant.each do |variant, variant_quantity|
+              inventory_units = line_item.inventory_units.where(variant: variant).count
+              quantity = variant_quantity - inventory_units
+              next if quantity <= 0
+              next unless variant
+
+              quantifier = ::Spree::Stock::Quantifier.new(variant)
+
+              next if quantifier.can_supply? quantity
+
+              display_name = variant.name.to_s
+              display_name += %{ (#{variant.options_text})} if variant.options_text.present?
+
+              line_item.errors[:quantity] << I18n.t(
+                'spree.selected_quantity_not_available',
+                item: display_name.inspect
+              )
+            end
+          else
+            super
+          end
+        end
+
+        ::Spree::Stock::AvailabilityValidator.prepend self
+      end
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/stock/inventory_unit_builder_decorator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module Stock
+      module InventoryUnitBuilderDecorator
+        def units
+          @order.line_items.flat_map do |line_item|
+            line_item.quantity_by_variant.flat_map do |variant, quantity|
+              quantity.times.map { build_inventory_unit(variant, line_item) }
+            end
+          end
+        end
+
+        def build_inventory_unit(variant, line_item)
+          inventory_unit_attributes = {
+            pending: true,
+            variant: variant,
+            line_item: line_item,
+          }
+          if ::Spree.solidus_gem_version < Gem::Version.new('2.5.x')
+            inventory_unit_attributes[:order] = @order
+          end
+          @order.inventory_units.includes(
+            variant: {
+              product: {
+                shipping_category: {
+                  shipping_methods: [:calculator, { zones: :zone_members }]
+                }
+              }
+            }
+          ).build(inventory_unit_attributes)
+        end
+
+        ::Spree::Stock::InventoryUnitBuilder.prepend self
+      end
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/stock/inventory_units_finalizer_decorator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module Stock
+      module InventoryUnitsFinalizerDecorator
+        private
+
+        def unstock_inventory_units
+          inventory_units.group_by(&:shipment_id).each_value do |inventory_units_for_shipment|
+            inventory_units_for_shipment.group_by(&:line_item_id).each_value do |units|
+              shipment = units.first.shipment
+              line_item = units.first.line_item
+
+              if line_item.product.assembly?
+                units.group_by(&:variant_id).each_value do |units_for_part|
+                  part = units_for_part.first.variant
+                  shipment.stock_location.unstock part, units_for_part.count, shipment
+                end
+              else
+                shipment.stock_location.unstock line_item.variant, units.count, shipment
+              end
+            end
+          end
+        end
+
+        if ::Spree.solidus_gem_version >= Gem::Version.new('2.8')
+          ::Spree::Stock::InventoryUnitsFinalizer.prepend self
+        end
+      end
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/stock/inventory_validator_decorator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module Stock
+      module InventoryValidatorDecorator
+        def validate(line_item)
+          total_quantity = line_item.quantity_by_variant.values.sum
+
+          if line_item.inventory_units.count != total_quantity
+            line_item.errors[:inventory] << I18n.t(
+              'spree.inventory_not_available',
+              item: line_item.variant.name
+            )
+          end
+        end
+
+        ::Spree::Stock::InventoryValidator.prepend self
+      end
+    end
+  end
+end

data/app/decorators/models/solidus_product_assembly/spree/variant_decorator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SolidusProductAssembly
+  module Spree
+    module VariantDecorator
+      def self.prepended(base)
+        base.class_eval do
+          has_and_belongs_to_many :assemblies,
+            class_name: "Spree::Product",
+            join_table: "spree_assemblies_parts",
+            foreign_key: "part_id", association_foreign_key: "assembly_id"
+        end
+      end
+
+      def assemblies_for(products)
+        assemblies.where(id: products)
+      end
+
+      def part?
+        assemblies.exists?
+      end
+
+      ::Spree::Variant.prepend self
+    end
+  end
+end

data/app/models/spree/assemblies_part.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Spree
-  class AssembliesPart < ActiveRecord::Base
-    belongs_to :assembly, :class_name => "Spree::Product",
-      :foreign_key => "assembly_id", touch: true
+  class AssembliesPart < ApplicationRecord
+    belongs_to :assembly, class_name: "Spree::Product",
+                          foreign_key: "assembly_id", touch: true
 
-    belongs_to :part, :class_name => "Spree::Variant", :foreign_key => "part_id"
+    belongs_to :part, class_name: "Spree::Variant", foreign_key: "part_id"
 
     def self.get(assembly_id, part_id)
       find_or_initialize_by(assembly_id: assembly_id, part_id: part_id)

data/app/models/spree/calculator/returns/assemblies_default_refund_amount.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spree
+  module Calculator::Returns
+    class AssembliesDefaultRefundAmount < DefaultRefundAmount
+      def compute(return_item)
+        percentage = return_item.inventory_unit.percentage_of_line_item
+        if percentage < 1 && return_item.variant.part?
+          line_item = return_item.inventory_unit.line_item
+          (super * percentage * line_item.quantity).round 4, :up
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/models/spree/order_inventory_assembly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # This class has basically the same functionality of Spree core OrderInventory
   # except that it takes account of bundle parts and properly creates and removes
@@ -19,8 +21,14 @@ module Spree
           self.variant = part
 
           if existing_parts < total_parts
-            shipment = determine_target_shipment unless shipment
-            add_to_shipment(shipment, total_parts - existing_parts)
+            if method(:determine_target_shipment).arity == 1
+              quantity = total_parts - existing_parts
+              shipment = determine_target_shipment(quantity) unless shipment
+              add_to_shipment(shipment, quantity)
+            else
+              shipment = determine_target_shipment unless shipment
+              add_to_shipment(shipment, total_parts - existing_parts)
+            end
           elsif existing_parts > total_parts
             quantity = existing_parts - total_parts
             if shipment.present?
@@ -28,6 +36,7 @@ module Spree
             else
               order.shipments.each do |shipment|
                 break if quantity == 0
+
                 quantity -= remove_from_shipment(shipment, quantity)
               end
             end

data/app/overrides/add_admin_product_form_fields.rb

@@ -1,5 +1,7 @@
-Deface::Override.new(:virtual_path => "spree/admin/products/_form",
-                     :name => "product_assembly_admin_product_form_right",
-                     :insert_after => "[data-hook='admin_product_form_right'], #admin_product_form_right[data-hook]",
-                     :partial => "spree/admin/products/product_assembly_fields",
-                     :disabled => false)
+# frozen_string_literal: true
+
+Deface::Override.new(virtual_path: "spree/admin/products/_form",
+                     name: "product_assembly_admin_product_form_right",
+                     insert_after: "[data-hook='admin_product_form_right'], #admin_product_form_right[data-hook]",
+                     partial: "spree/admin/products/product_assembly_fields",
+                     disabled: false)

data/app/overrides/add_admin_tabs.rb

@@ -1,5 +1,7 @@
-Deface::Override.new(:virtual_path => "spree/admin/shared/_product_tabs",
-                     :name => "product_assembly_admin_product_tabs",
-                     :insert_bottom => "[data-hook='admin_product_tabs']",
-                     :partial => "spree/admin/shared/product_assembly_product_tabs",
-                     :disabled => false)
+# frozen_string_literal: true
+
+Deface::Override.new(virtual_path: "spree/admin/shared/_product_tabs",
+                     name: "product_assembly_admin_product_tabs",
+                     insert_bottom: "[data-hook='admin_product_tabs']",
+                     partial: "spree/admin/shared/product_assembly_product_tabs",
+                     disabled: false)

data/app/overrides/add_line_item_description.rb

@@ -1,5 +1,7 @@
-Deface::Override.new(:virtual_path => "spree/orders/_line_item",
-                     :name => "product_assembly_cart_item_description",
-                     :insert_bottom => "[data-hook='cart_item_description']",
-                     :partial => "spree/orders/cart_description",
-                     :disabled => false)
+# frozen_string_literal: true
+
+Deface::Override.new(virtual_path: "spree/orders/_line_item",
+                     name: "product_assembly_cart_item_description",
+                     insert_bottom: "[data-hook='cart_item_description']",
+                     partial: "spree/orders/cart_description",
+                     disabled: false)

data/app/overrides/spree/admin/orders/_carton_manifest/_assembly_parts_price.html.erb.deface

@@ -0,0 +1,9 @@
+<!-- replace ".item-price" -->
+
+<% if item.variant.part? %>
+  <td class="item-price">---</td>
+<% else %>
+  <td class="item-price">
+    <%= line_item_shipment_price(item.line_item, item.quantity) %>
+  </td>
+<% end %>

data/app/overrides/spree/admin/orders/_carton_manifest/_assembly_parts_total_price.html.erb.deface

@@ -0,0 +1,9 @@
+<!-- replace ".item-total" -->
+
+<% if item.variant.part? %>
+  <td class="item-total align-center">---</td>
+<% else %>
+  <td class="item-total align-center">
+    <%= line_item_shipment_price(item.line_item, item.quantity) %>
+  </td>
+<% end %>

data/app/overrides/spree/admin/orders/_shipment/stock_contents.html.erb.deface

@@ -1,2 +1,8 @@
 <!-- replace_contents  '.stock-contents tbody' -->
-<%= render 'stock_contents', shipment: shipment %>
+<% if Spree.solidus_gem_version < Gem::Version.new('2.4') %>
+  <%= render "stock_contents_2_3", shipment: shipment %>
+<% elsif Spree.solidus_gem_version < Gem::Version.new('2.5') %>
+  <%= render "stock_contents_2_4", shipment: shipment %>
+<% else %>
+  <%= render "stock_contents", shipment: shipment %>
+<% end %>

data/app/overrides/spree/products/show/add_links_to_parts.html.erb.deface

@@ -1,14 +1,14 @@
 <!-- insert_after '#cart-form' -->
 <% if @product.parts.any?(&:in_stock?) %>
 
-  <h6><%= Spree.t(:parts_included) %></h6>
+  <h6><%= t('spree.parts_included') %></h6>
 
   <ul id="products" class="inline product-listing" data-hook>
     <% @product.parts.each do |variant| %>
       <% if variant.in_stock? %>
         <li id="product_<%= variant.product.id %>" class="columns three <%= cycle("alpha", "secondary", "", "omega secondary") %>" data-hook="products_list_item" itemscope itemtype="http://schema.org/Product">
           <div class="product-image">
-            <%= link_to small_image(variant.product, :itemprop => "name"), variant.product %>
+            <%= render 'spree/shared/image', image: variant.product.gallery.images.first, size: :small %>
           </div>
           <%= link_to truncate(variant.product.name, :length => 50), variant.product, :class => 'info', :itemprop => "name", :title => variant.product.name %>
           <% if variant.product.individual_sale? %>

data/app/views/spree/admin/orders/_assemblies.html.erb

@@ -1,15 +1,16 @@
 <% if order.line_items.assemblies.any? %>
   <fieldset class="no-border-bottom">
     <legend align="center" class="" data-hook="">
-      <%= Spree.t(:product_bundles) %>
+      <%= t('spree.product_bundles') %>
     </legend>
   </fieldset>
 
   <table class="product-bundles index" data-hook="line-items">
     <colgroup>
-      <col style="width: 10%;" />
-      <col style="width: 20%;" />
-      <col style="width: 20%;" />
+      <col style="width: 15%;" />
+      <col style="width: 40%;" />
+      <col style="width: 15%;" />
+      <col style="width: 15%;" />
       <col style="width: 15%;" />
     </colgroup>
 
@@ -19,14 +20,15 @@
         <th><%= Spree::LineItem.human_attribute_name(:price) %></th>
         <th><%= Spree::LineItem.human_attribute_name(:quantity) %></th>
         <th><%= Spree::LineItem.human_attribute_name(:total) %></th>
-        <th class="orders-actions actions" data-hook="admin_order_form_line_items_header_actions">&nbsp;</th>
       </tr>
     </thead>
 
     <tbody>
       <% order.line_items.assemblies.each do |item| %>
         <%= content_tag :tr, class: 'line-item', id: "line-item-#{item.id}", data: { line_item_id: item.id } do %>
-          <td class="line-item-image"><%= image_tag item.variant.display_image.attachment(:mini) %></td>
+          <td class="line-item-image"><%= render 'spree/shared/image',
+                      image: (item.variant.gallery.images.first || item.variant.product.gallery.images.first),
+                      size: :mini %></td>
           <td class="line-item-name">
             <%= item.variant.product.name %><br><%= "(" + variant_options(item.variant) + ")" unless item.variant.option_values.empty? %>
             <% if item.variant.sku.present? %>
@@ -37,18 +39,7 @@
           <td class="line-item-qty-show align-center">
             <%= item.quantity %>
           </td>
-          <td class="line-item-qty-edit">
-            <%= number_field_tag :quantity, item.quantity, :min => 0, :class => "line_item_quantity", :size => 5 %>
-          </td>
           <td class="line-item-total align-center"><%= line_item_shipment_price(item, item.quantity) %></td>
-          <td class="cart-line-item-delete actions" data-hook="cart_line_item_delete">
-            <% if can? :update, item %>
-              <%= link_to '', '#', :class => 'save-line-item fa fa-ok no-text with-tip',       :title => Spree.t('actions.save') %>
-              <%= link_to '', '#', :class => 'cancel-line-item fa fa-cancel no-text with-tip', :title => Spree.t('actions.cancel') %>
-              <%= link_to '', '#', :class => 'edit-line-item fa fa-edit no-text with-tip',     :title => Spree.t('actions.edit') %>
-              <%= link_to '', '#', :class => 'delete-line-item fa fa-trash no-text with-tip',  :title => Spree.t('actions.delete') %>
-            <% end %>
-          </td>
         <% end %>
       <% end %>
     </tbody>

data/app/views/spree/admin/orders/_stock_contents.html.erb

@@ -1,69 +1,9 @@
 <%= render 'stock_item', shipment: shipment %>
 
 <% unless shipment.shipped? %>
-  <tr class="edit-method hidden total">
-    <td colspan="5">
-      <div class="field alpha five columns">
-        <%= label_tag 'selected_shipping_rate_id', Spree.t(:shipping_method) %>
-        <%= select_tag :selected_shipping_rate_id,
-              options_for_select(shipment.shipping_rates.map {|sr| ["#{sr.name} #{sr.display_price}", sr.id] }, shipment.selected_shipping_rate_id),
-              {:class => 'select2 fullwidth', :data => {'shipment-number' => shipment.number } } %>
-      </div>
-    </td>
-    <td class="actions">
-      <% if can? :update, shipment %>
-        <%= link_to '', '#', :class => 'save-method fa fa-ok no-text with-tip',
-          :data => {'shipment-number' => shipment.number, :action => 'save'}, title: Spree.t('actions.save') %>
-        <%= link_to '', '#', :class => 'cancel-method fa fa-cancel no-text with-tip',
-          :data => {:action => 'cancel'}, :title => Spree.t('actions.cancel') %>
-      <% end %>
-    </td>
+  <tr class="edit-shipping-method vertical-middle">
   </tr>
 <% end %>
 
-<tr class="show-method total">
-  <% if shipment.shipping_method %>
-    <td colspan="4">
-      <strong><%= shipment.shipping_method.name %></strong>
-    </td>
-    <td class="total" align="center">
-      <span><%= shipment.display_cost %></span>
-    </td>
-  <% else %>
-    <td colspan='5'><%= Spree.t(:no_shipping_method_selected) %></td>
-  <% end %>
-
-  <td class="actions">
-    <% if can? :update, shipment %>
-      <%= link_to '', '#', :class => 'edit-method fa fa-edit no-text with-tip', :data => {:action => 'edit'}, :title => Spree.t('edit') %>
-    <% end %>
-  </td>
-</tr>
-
-<tr class="edit-tracking hidden total">
-  <td colspan="5">
-    <label><%= Spree.t(:tracking_number) %>:</label>
-    <%= text_field_tag :tracking, shipment.tracking %>
-  </td>
-  <td class="actions">
-    <% if can? :update, shipment %>
-      <%= link_to '', '#', :class => 'save-tracking fa fa-ok no-text with-tip', :data => {'shipment-number' => shipment.number, :action => 'save'}, :title => Spree.t('actions.save') %>
-      <%= link_to '', '#', :class => 'cancel-tracking fa fa-cancel no-text with-tip', :data => {:action => 'cancel'}, :title => Spree.t('actions.cancel') %>
-    <% end %>
-  </td>
-</tr>
-
-<tr class="show-tracking total">
-  <td colspan="5">
-    <% if shipment.tracking.present? %>
-      <strong><%= Spree.t(:tracking) %>:</strong> <%= shipment.tracking %>
-    <% else %>
-      <%= Spree.t(:no_tracking_present) %>
-    <% end %>
-  </td>
-  <td class="actions">
-    <% if can? :update, shipment %>
-      <%= link_to '', '#', :class => 'edit-tracking fa fa-edit no-text with-tip', :data => {:action => 'edit'}, :title => Spree.t('edit') %>
-    <% end %>
-  </td>
+<tr class="edit-tracking vertical-middle">
 </tr>