solidus_product_assembly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89f3f4fbf3c8638a1d3a0eb8daeec71ab2e0be2c
+  data.tar.gz: e67518d457ee0aa60495099b41e058b917f36472
+SHA512:
+  metadata.gz: a4dae9aac9db62b23daca17315e84596f8da6421269ba816e8f17b6ac100e0c5916692d09e5f701c69b09972f65afe538fb231bd325bbf6e37690d48e8827c25
+  data.tar.gz: ff2051e5a167ef6f1d4d7fce18d302baef6952e94f22df48115242ee5e9d9037170e93b99ab47e91ebd794e115dba79527db152c174ffd6f4659cdabcdb96003

data/.gitignore

@@ -0,0 +1,4 @@
+spec/dummy
+Gemfile.lock
+coverage
+spec/examples.txt

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format
+progress

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.3.1
+env:
+  matrix:
+    - SOLIDUS_BRANCH=v1.0 DB=postgres
+    - SOLIDUS_BRANCH=v1.1 DB=postgres
+    - SOLIDUS_BRANCH=v1.2 DB=postgres
+    - SOLIDUS_BRANCH=v1.3 DB=postgres
+    - SOLIDUS_BRANCH=v1.4 DB=postgres
+    - SOLIDUS_BRANCH=v2.0 DB=postgres
+    - SOLIDUS_BRANCH=master DB=postgres
+    - SOLIDUS_BRANCH=v1.0 DB=mysql
+    - SOLIDUS_BRANCH=v1.1 DB=mysql
+    - SOLIDUS_BRANCH=v1.2 DB=mysql
+    - SOLIDUS_BRANCH=v1.3 DB=mysql
+    - SOLIDUS_BRANCH=v1.4 DB=mysql
+    - SOLIDUS_BRANCH=v2.0 DB=mysql
+    - SOLIDUS_BRANCH=master DB=mysql

data/Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem "solidus", github: "solidusio/solidus", branch: branch
+gem 'solidus_auth_devise'
+
+if branch == 'master' || branch >= "v2.0"
+  gem "rails-controller-testing", group: :test
+end
+
+gem 'pg'
+gem 'mysql2'
+
+group :development, :test do
+  gem "pry-rails"
+end
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,13 @@
+Spree Product Assembly License
+==============================
+
+Copyright © 2007-2014, Spree Commerce Inc. and other contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Spree Commerce Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+_This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner of contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage._

data/README.md

@@ -0,0 +1,80 @@
+# Product Assembly
+
+[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_product_assembly.svg?branch=master)](https://travis-ci.org/solidusio-contrib/solidus_product_assembly)
+
+Create a product which is composed of other products.
+
+## Installation
+
+Add the following line to your `Gemfile`
+```ruby
+gem 'solidus_product_assembly', github: 'solidusio-contrib/solidus_product_assembly', branch: 'master'
+```
+
+Run bundle install as well as the extension intall command to copy and run migrations and
+append solidus_product_assembly to your js manifest file
+
+    bundle install
+    rails g solidus_product_assembly:install
+
+_master branch is compatible with spree edge and rails 4 only. Please use
+2-0-stable for Spree 2.0.x or 1-3-stable branch for Spree 1.3.x compatibility_
+
+_In case you're upgrading from 1-3-stable of this extension you might want to run a
+rake task which assigns a line item to your previous inventory units from bundle
+products. That is so you have a better view on the current backend UI and avoid
+exceptions. No need to run this task if you're not upgrading from product assembly
+1-3-stable_
+
+    rake solidus_product_assembly:upgrade
+
+## Use
+
+To build a bundle (assembly product) you'd need to first check the "Can be part"
+flag on each product you want to be part of the bundle. Then create a product
+and add parts to it. By doing that you're making that product an assembly.
+
+The store will treat assemblies a bit different than regular products on checkout.
+Spree will create and track inventory units for its parts rather than for the product itself.
+That means you essentially have a product composed of other products. From a
+customer perspective it's like they are paying a single amount for a collection
+of products.
+
+Contributing
+------------
+
+Spree is an open source project and we encourage contributions. Please see the [contributors guidelines][1] before contributing.
+
+In the spirit of [free software][2], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][3]
+* by suggesting new features
+* by writing translations
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][3]
+* by reviewing patches
+
+Starting point:
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Submit your pull request
+
+Copyright (c) 2014 [Spree Commerce Inc.][4] and [contributors][5], released under the [New BSD License][6]
+
+[1]: http://guides.spreecommerce.com/developer/contributing.html
+[2]: http://www.fsf.org/licensing/essays/free-sw.html
+[3]: https://github.com/spree/spree-product-assembly/issues
+[4]: https://github.com/spree
+[5]: https://github.com/spree/spree-product-assembly/graphs/contributors
+[6]: https://github.com/spree/spree-product-assembly/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_product_assembly'
+  Rake::Task['common:test_app'].invoke("Spree::User")
+end

data/app/assets/javascripts/spree/backend/solidus_product_assembly.js

@@ -0,0 +1 @@
+//= require_tree .

data/app/assets/javascripts/spree/frontend/solidus_product_assembly.js

@@ -0,0 +1 @@
+//= require spree/frontend

data/app/assets/stylesheets/spree/backend/solidus_product_assembly.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/backend
+*/

data/app/assets/stylesheets/spree/frontend/solidus_product_assembly.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/frontend
+*/

data/app/controllers/spree/admin/parts_controller.rb

@@ -0,0 +1,49 @@
+class Spree::Admin::PartsController < Spree::Admin::BaseController
+  before_filter :find_product
+
+  def index
+    @parts = @product.parts
+  end
+
+  def remove
+    @part = Spree::Variant.find(params[:id])
+    @product.remove_part(@part)
+    render 'spree/admin/parts/update_parts_table'
+  end
+
+  def set_count
+    @part = Spree::Variant.find(params[:id])
+    @product.set_part_count(@part, params[:count].to_i)
+    render 'spree/admin/parts/update_parts_table'
+  end
+
+  def available
+    if params[:q].blank?
+      @available_products = []
+    else
+      query = "%#{params[:q]}%"
+      @available_products = Spree::Product.search_can_be_part(query)
+      @available_products.uniq!
+    end
+    respond_to do |format|
+      format.html {render :layout => false}
+      format.js {render :layout => false}
+    end
+  end
+
+  def create
+    @part = Spree::Variant.find(params[:part_id])
+    qty = params[:part_count].to_i
+    @product.add_part(@part, qty) if qty > 0
+    render 'spree/admin/parts/update_parts_table'
+  end
+
+  private
+    def find_product
+      @product = Spree::Product.find_by(slug: params[:product_id])
+    end
+
+    def model_class
+      Spree::AssembliesPart
+    end
+end

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,9 @@
+module Spree
+  if defined? Spree::Frontend
+    CheckoutController.class_eval do
+      # Override because we don't want to remove unshippable items from the order
+      # A bundle itself is an unshippable item
+      def before_payment; end
+    end
+  end
+end

data/app/helpers/spree/admin/orders_helper_decorator.rb

@@ -0,0 +1,9 @@
+module Spree
+  module Admin
+    OrdersHelper.module_eval do
+      def line_item_shipment_price(line_item, quantity)
+        Spree::Money.new(line_item.price * quantity, { currency: line_item.currency })
+      end
+    end
+  end
+end

data/app/models/spree/assemblies_part.rb

@@ -0,0 +1,12 @@
+module Spree
+  class AssembliesPart < ActiveRecord::Base
+    belongs_to :assembly, :class_name => "Spree::Product",
+      :foreign_key => "assembly_id", touch: true
+
+    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)
+    end
+  end
+end

data/app/models/spree/inventory_unit_decorator.rb

@@ -0,0 +1,13 @@
+module Spree
+  InventoryUnit.class_eval do
+    def percentage_of_line_item
+      product = line_item.product
+      if product.assembly?
+        total_value = line_item.quantity_by_variant.map { |part, quantity| part.price * quantity }.sum
+        variant.price / total_value
+      else
+        1 / BigDecimal.new(line_item.quantity)
+      end
+    end
+  end
+end

data/app/models/spree/line_item_decorator.rb

@@ -0,0 +1,44 @@
+module Spree
+  LineItem.class_eval do
+    scope :assemblies, -> { joins(:product => :parts).uniq }
+
+    def any_units_shipped?
+      inventory_units.any? { |unit| unit.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.
+    def parts
+      product.parts
+    end
+
+    # 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.
+    def count_of(variant)
+      product.count_of(variant)
+    end
+
+    def quantity_by_variant
+      if self.product.assembly?
+        {}.tap { |hash| self.product.assemblies_parts.each { |ap| hash[ap.part] = ap.count * self.quantity } }
+      else
+        { self.variant => self.quantity }
+      end
+    end
+
+    private
+      def update_inventory
+        if (changed? || target_shipment.present?) && self.order.has_checkout_step?("delivery")
+          if self.product.assembly?
+            OrderInventoryAssembly.new(self).verify(target_shipment)
+          else
+            OrderInventory.new(self.order, self).verify(target_shipment)
+          end
+        end
+      end
+  end
+end

data/app/models/spree/order_inventory_assembly.rb

@@ -0,0 +1,39 @@
+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
+  # inventory unit for each parts of a bundle
+  class OrderInventoryAssembly < OrderInventory
+    attr_reader :product
+
+    def initialize(line_item)
+      @order = line_item.order
+      @line_item = line_item
+      @product = line_item.product
+    end
+
+    def verify(shipment = nil)
+      if order.completed? || shipment.present?
+        line_item.quantity_by_variant.each do |part, total_parts|
+          existing_parts = line_item.inventory_units.where(variant: part).count
+
+          self.variant = part
+
+          if existing_parts < total_parts
+            shipment = determine_target_shipment unless shipment
+            add_to_shipment(shipment, total_parts - existing_parts)
+          elsif existing_parts > total_parts
+            quantity = existing_parts - total_parts
+            if shipment.present?
+              remove_from_shipment(shipment, quantity)
+            else
+              order.shipments.each do |shipment|
+                break if quantity == 0
+                quantity -= remove_from_shipment(shipment, quantity)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,56 @@
+Spree::Product.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?
+
+  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, Spree.t(:assembly_cannot_be_part)) if can_be_part
+  end
+
+  private
+  def assemblies_part(variant)
+    Spree::AssembliesPart.get(self.id, variant.id)
+  end
+end

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,50 @@
+module Spree
+  Shipment.class_eval do
+    # 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
+  end
+end