solidus_core 2.0.3 → 2.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a6f386d4b02423363675c20943ec411a624d36d
-  data.tar.gz: c651d02f3bed317f62d21268d60f90981897fc0f
+  metadata.gz: d27a7b1fb09b6aa81702049ad833916e12b1aa1b
+  data.tar.gz: 6ece03114b6598ab2dc3bebe5469f48d442e8e2e
 SHA512:
-  metadata.gz: 1018c8b201487476b9684120b094bc414bc0dfebb49a29fb768b855c16462cae88d6224e54964eb307a36f28be21cef04311ee15c93faf302065c39aff8929f3
-  data.tar.gz: 2c1499844ad3177827d67dbf554eccb46d228c1a5142207b5ce66e84bb06a74fd477fbbb83bb8efe4793ab49d8155f87157ad1352de7dd2c97e49de649bf3314
+  metadata.gz: c100bab17654d3fabdf7fe3534f7a98881a9a177033b576cd3fe5fa1cf575bf2610b87e8dc8348dfa616566e3e32fa5b8795484fada7dc7c3e376890fb3d3345
+  data.tar.gz: ef65a5ccb1f92b9c9d7695db45cc98bada5b2343f70d6dc9435c9eb32e4110eea34c80dcb4db5ef0fde1bcb29f3584bbbdd0bf2e4dbb851bb0f4493aa2a121a3

data/README.md

@@ -1,9 +1,68 @@
-# solidus\_core
+Summary
+------
+Solidus Core provides the essential e-commerce data models upon which the
+Solidus system depends.
 
-Core contains all the models and the majority of the logic for the Solidus
-ecommerce system.
+Core Models
+-----------
+Solidus implements over 200 [models](https://github.com/solidusio/solidus/tree/master/core/app/models/spree),
+and thus a deep inspection of each in this README would be overkill. Instead,
+let's take a quick look at the fundamental models upon which all else depend.
+Currently, these models remain in the Spree namespace as part of the legacy of
+[forking Spree](https://solidus.io/blog/2015/10/28/future-of-spree.html).
 
+## NOTE: Documentation is a work in progress
+The documentation of Solidus Core is still in progress. Contributions following
+this form are welcome and encouraged!
 
+* [The Order Sub-System](#the-order-sub-system)
+* [The User Sub-System](#the-user-sub-system)
+* [The Payment Sub-System](#the-payment-sub-system)
+* [The Inventory Sub-System](#the-inventory-sub-system)
+* [The Shipments Sub-System](#the-shipments-sub-system)
+
+## The Order Sub-System
+* `Spree::Store` - Records store specific configuration such as store name and URL.
+* `Spree::Order` - The customers cart until completed, then acts as
+permenent record of the transaction.
+* `Spree::LineItem` - Variants placed in the order at a particular price.
+
+## The User Sub-System
+* `Spree::LegacyUser` - Default implementation of User.
+* `Spree::UserClassHandle` - Configuration point for User model implementation.
+* [solidus_auth_devise](https://github.com/solidusio/solidus_auth_devise) -
+An offical, more robust implementation of a User class with Devise
+integration.
+
+## The Payment Sub-System
+* `Spree::Payment` - Manage and process a payment for an order, from a specific
+source (e.g. `Spree::CreditCard`) using a specific payment method (e.g
+`Solidus::Gateway::Braintree`).
+* `Spree::PaymentMethod` - An abstract class which is implemented most commonly
+as a `Spree::Gateway`.
+* `Spree::Gateway` - A concrete implementation of `Spree::PaymentMethod`
+intended to provide a base for extension. See
+https://github.com/solidusio/solidus_gateway/ for offically supported payment
+gateway implementations.
+* `Spree::CreditCard` - The default `source` of a `Spree::Payment`.
+
+## The Inventory Sub-System
+* `Spree::ReturnAuthorization` - Models the return of Inventory Units to
+a Stock Location for an Order.
+* `Spree::StockLocation` - Records the name and addresses from which stock items
+are fulfilled in cartons.
+* `Spree::InventoryUnit` - Tracks the state of line items' fulfillment.
+* `Spree::ShippingRate` - Records the costs of different shipping methods for a
+shipment and which method has been selected to deliver the shipment.
+* `Spree::ShippingMethod` - Represents a means of having a shipment delivered,
+such as FedEx or UPS.
+
+## The Shipments Sub-System
+* `Spree::Shipment` - An order's planned shipments including
+tracking and cost. Shipments are fulfilled from Stock Locations.
+
+Developer Notes
+---------------
 ## Testing
 
 Create the test site

data/app/assets/javascripts/spree.js.coffee.erb

@@ -1,7 +1,10 @@
 #= require jsuri
 class window.Spree
   @ready: (callback) ->
-    jQuery(document).ready(callback)
+    if typeof Turbolinks isnt 'undefined' and Turbolinks.supported
+      jQuery(document).on 'turbolinks:load', -> callback(jQuery)
+    else
+      jQuery(document).ready(callback)
 
   @mountedAt: ->
     "<%= Rails.application.routes.url_helpers.spree_path(trailing_slash: true) %>"

data/app/helpers/spree/base_helper.rb

@@ -66,8 +66,8 @@ module Spree
       nil
     end
 
-    def taxon_breadcrumbs(taxon, separator = " » ", breadcrumb_class = "inline")
-      return "" if current_page?("/") || taxon.nil?
+    def taxon_breadcrumbs(taxon, separator = ' » ', breadcrumb_class = 'inline')
+      return '' if current_page?('/') || taxon.nil?
 
       crumbs = [[Spree.t(:home), spree.root_path]]
 
@@ -81,15 +81,15 @@ module Spree
 
       separator = raw(separator)
 
-      crumbs.map! do |crumb|
-        content_tag(:li, itemscope: "itemscope", itemtype: "http://data-vocabulary.org/Breadcrumb") do
-          link_to(crumb.last, itemprop: "url") do
-            content_tag(:span, crumb.first, itemprop: "title")
+      items = crumbs.each_with_index.collect do |crumb, i|
+        content_tag(:li, itemprop: 'itemListElement', itemscope: '', itemtype: 'https://schema.org/ListItem') do
+          link_to(crumb.last, itemprop: 'item') do
+            content_tag(:span, crumb.first, itemprop: 'name') + tag('meta', { itemprop: 'position', content: (i+1).to_s }, false, false)
           end + (crumb == crumbs.last ? '' : separator)
         end
       end
 
-      content_tag(:nav, content_tag(:ul, raw(crumbs.map(&:mb_chars).join), class: breadcrumb_class), id: 'breadcrumbs', class: 'sixteen columns')
+      content_tag(:nav, content_tag(:ol, raw(items.map(&:mb_chars).join), class: breadcrumb_class, itemscope: '', itemtype: 'https://schema.org/BreadcrumbList'), id: 'breadcrumbs', class: 'sixteen columns')
     end
 
     def taxons_tree(root_taxon, current_taxon, max_level = 1)
@@ -134,15 +134,6 @@ module Spree
        time.strftime("%l:%M %p")].join(" ")
     end
 
-    def method_missing(method_name, *args, &block)
-      if image_style = image_style_from_method_name(method_name)
-        define_image_method(image_style)
-        send(method_name, *args)
-      else
-        super
-      end
-    end
-
     def link_to_tracking(shipment, options = {})
       return unless shipment.tracking && shipment.shipping_method
 
@@ -157,37 +148,5 @@ module Spree
       resource_class.model_name.human(count: Spree::I18N_GENERIC_PLURAL)
     end
 
-    private
-
-    # Returns style of image or nil
-    def image_style_from_method_name(method_name)
-      if method_name.to_s.match(/_image$/) && style = method_name.to_s.sub(/_image$/, '')
-        possible_styles = Spree::Image.attachment_definitions[:attachment][:styles]
-        style if style.in? possible_styles.with_indifferent_access
-      end
-    end
-
-    def create_product_image_tag(image, product, options, style)
-      options.reverse_merge! alt: image.alt.blank? ? product.name : image.alt
-      image_tag image.attachment.url(style), options
-    end
-
-    def define_image_method(style)
-      self.class.send :define_method, "#{style}_image" do |product, *options|
-        Spree::Deprecation.warn "Spree image helpers will be deprecated in the near future. Use the provided resource to access the intendend image directly.", caller
-        options = options.first || {}
-        if product.images.empty?
-          if !product.is_a?(Spree::Variant) && !product.variant_images.empty?
-            create_product_image_tag(product.variant_images.first, product, options, style)
-          elsif product.is_a?(Variant) && !product.product.variant_images.empty?
-            create_product_image_tag(product.product.variant_images.first, product, options, style)
-          else
-            image_tag "noimage/#{style}.png", options
-          end
-        else
-          create_product_image_tag(product.images.first, product, options, style)
-        end
-      end
-    end
   end
 end

data/app/models/spree/address.rb

@@ -1,13 +1,17 @@
 require 'twitter_cldr'
 
 module Spree
+  # `Spree::Address` provides the foundational ActiveRecord model for recording and
+  # validating address information for `Spree::Order`, `Spree::Shipment`,
+  # `Spree::UserAddress`, and `Spree::Carton`.
+  #
   class Address < Spree::Base
     extend ActiveModel::ForbiddenAttributesProtection
 
     belongs_to :country, class_name: "Spree::Country"
     belongs_to :state, class_name: "Spree::State"
 
-    validates :firstname, :lastname, :address1, :city, :country_id, presence: true
+    validates :firstname, :address1, :city, :country_id, presence: true
     validates :zipcode, presence: true, if: :require_zipcode?
     validates :phone, presence: true, if: :require_phone?
 

data/app/models/spree/adjustment.rb

@@ -184,15 +184,15 @@ module Spree
     end
 
     def repair_adjustments_associations_on_create
-      if adjustable.adjustments.loaded? && !adjustable.adjustments.include?(self)
-        Spree::Deprecation.warn("Adjustment was not added to #{adjustable.class}. Add adjustments via `adjustable.adjustments.create!`. Partial call stack: #{caller.select { |line| line =~ %r(/(app|spec)/) }}.", caller)
+      if adjustable.adjustments.loaded? && !adjustable.adjustments.include?(self) && !destroyed?
+        Spree::Deprecation.warn("Adjustment #{id} was not added to #{adjustable.class} #{adjustable.id}. Add adjustments via `adjustable.adjustments.create!`. Partial call stack: #{caller.select { |line| line =~ %r(/(app|spec)/) }}.", caller)
         adjustable.adjustments.proxy_association.add_to_target(self)
       end
     end
 
     def repair_adjustments_associations_on_destroy
       if adjustable.adjustments.loaded? && adjustable.adjustments.include?(self)
-        Spree::Deprecation.warn("Adjustment was not removed from #{adjustable.class}. Remove adjustments via `adjustable.adjustments.destroy`. Partial call stack: #{caller.select { |line| line =~ %r(/(app|spec)/) }}.", caller)
+        Spree::Deprecation.warn("Adjustment #{id} was not removed from #{adjustable.class} #{adjustable.id}. Remove adjustments via `adjustable.adjustments.destroy`. Partial call stack: #{caller.select { |line| line =~ %r(/(app|spec)/) }}.", caller)
         adjustable.adjustments.proxy_association.target.delete(self)
       end
     end

data/app/models/spree/app_configuration.rb

@@ -371,6 +371,19 @@ module Spree
       @add_payment_sources_to_wallet_class ||= Spree::Wallet::AddPaymentSourcesToWallet
     end
 
+    # Allows providing your own class for calculating taxes on an order.
+    #
+    # This extension point is under development and may change in a future minor release.
+    #
+    # @!attribute [rw] tax_adjuster_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::Tax::OrderAdjuster
+    # @api experimental
+    attr_writer :tax_adjuster_class
+    def tax_adjuster_class
+      @tax_adjuster_class ||= Spree::Tax::OrderAdjuster
+    end
+
     def static_model_preferences
       @static_model_preferences ||= Spree::Preferences::StaticModelPreferences.new
     end

data/app/models/spree/calculator.rb

@@ -17,9 +17,10 @@ module Spree
       end
     end
 
-    # overwrite to provide description for your calculators
+    # A description for this calculator in few words
+    # @return [String] A description for the calculator
     def self.description
-      'Base Calculator'
+      model_name.human
     end
 
     ###################################################################

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

@@ -4,10 +4,6 @@ module Spree
   class Calculator::DefaultTax < Calculator
     include Spree::Tax::TaxHelpers
 
-    def self.description
-      Spree.t(:default_tax)
-    end
-
     # Default tax calculator still needs to support orders for legacy reasons
     # Orders created before Spree 2.1 had tax adjustments applied to the order, as a whole.
     # Orders created with Spree 2.2 and after, have them applied to the line items individually.
@@ -19,7 +15,7 @@ module Spree
       line_items_total = matched_line_items.sum(&:discounted_amount)
       if rate.included_in_price
         order_tax_amount = round_to_two_places(line_items_total - ( line_items_total / (1 + rate.amount) ) )
-        refund_if_necessary(order_tax_amount, order.tax_zone)
+        refund_if_necessary(order_tax_amount, order.tax_address)
       else
         round_to_two_places(line_items_total * rate.amount)
       end
@@ -52,20 +48,20 @@ module Spree
       unrounded_net_amount = item.discounted_amount / (1 + sum_of_included_tax_rates(item))
       refund_if_necessary(
         round_to_two_places(unrounded_net_amount * rate.amount),
-        item.order.tax_zone
+        item.order.tax_address
       )
     end
 
-    def refund_if_necessary(amount, order_tax_zone)
-      if default_zone_or_zone_match?(order_tax_zone)
+    def refund_if_necessary(amount, order_tax_address)
+      if default_zone_or_zone_match?(order_tax_address)
         amount
       else
         amount * -1
       end
     end
 
-    def default_zone_or_zone_match?(order_tax_zone)
-      Zone.default_tax.try!(:contains?, order_tax_zone) || rate.zone.contains?(order_tax_zone)
+    def default_zone_or_zone_match?(order_tax_address)
+      Zone.default_tax.try!(:include?, order_tax_address) || rate.zone.include?(order_tax_address)
     end
   end
 end

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

@@ -4,10 +4,6 @@ module Spree
   class Calculator::FlatPercentItemTotal < Calculator
     preference :flat_percent, :decimal, default: 0
 
-    def self.description
-      Spree.t(:flat_percent)
-    end
-
     def compute(object)
       computed_amount = (object.amount * preferred_flat_percent / 100).round(2)
 

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

@@ -5,10 +5,6 @@ module Spree
     preference :amount, :decimal, default: 0
     preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-    def self.description
-      Spree.t(:flat_rate_per_order)
-    end
-
     def compute(object = nil)
       if object && preferred_currency.casecmp(object.currency).zero?
         preferred_amount

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

@@ -7,10 +7,6 @@ module Spree
     preference :max_items,       :integer, default: 0
     preference :currency,        :string,  default: ->{ Spree::Config[:currency] }
 
-    def self.description
-      Spree.t(:flexible_rate)
-    end
-
     def self.available?(_object)
       true
     end

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

@@ -3,9 +3,6 @@ module Spree
   #   The only case where it was used was for Free Shipping Promotions.  There is
   #   now a Promotion Action which deals with these types of promotions instead.
   class Calculator::FreeShipping < Calculator
-    def self.description
-      Spree.t(:free_shipping)
-    end
 
     def compute(object)
       if object.is_a?(Array)

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

@@ -3,10 +3,6 @@ module Spree
     class PercentOnLineItem < Calculator
       preference :percent, :decimal, default: 0
 
-      def self.description
-        Spree.t(:percent_per_item)
-      end
-
       def compute(object)
         (object.amount * preferred_percent) / 100
       end

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

@@ -10,10 +10,6 @@ module Spree
   class Calculator::PercentPerItem < Calculator
     preference :percent, :decimal, default: 0
 
-    def self.description
-      Spree.t(:percent_per_item)
-    end
-
     def compute(object = nil)
       return 0 if object.nil?
       object.line_items.map { |line_item|

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

@@ -7,10 +7,6 @@ module Spree
     preference :discount_amount, :decimal, default: 0
     preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-    def self.description
-      Spree.t(:price_sack)
-    end
-
     # as object we always get line items, as calculable we have Coupon, ShippingMethod
     def compute(object)
       if object.is_a?(Array)

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

@@ -3,9 +3,6 @@ require_dependency 'spree/returns_calculator'
 module Spree
   module Calculator::Returns
     class DefaultRefundAmount < ReturnsCalculator
-      def self.description
-        Spree.t(:default_refund_amount)
-      end
 
       def compute(return_item)
         return 0.0.to_d if return_item.part_of_exchange?

data/app/models/spree/calculator/shipping/flat_percent_item_total.rb

@@ -5,10 +5,6 @@ module Spree
     class FlatPercentItemTotal < ShippingCalculator
       preference :flat_percent, :decimal, default: 0
 
-      def self.description
-        Spree.t(:flat_percent)
-      end
-
       def compute_package(package)
         compute_from_price(total(package.contents))
       end

data/app/models/spree/calculator/shipping/flat_rate.rb

@@ -6,10 +6,6 @@ module Spree
       preference :amount, :decimal, default: 0
       preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_flat_rate_per_order)
-      end
-
       def compute_package(_package)
         preferred_amount
       end

data/app/models/spree/calculator/shipping/flexi_rate.rb

@@ -8,10 +8,6 @@ module Spree
       preference :max_items,       :integer, default: 0
       preference :currency,        :string,  default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_flexible_rate)
-      end
-
       def compute_package(package)
         compute_from_quantity(package.contents.sum(&:quantity))
       end

data/app/models/spree/calculator/shipping/per_item.rb

@@ -6,10 +6,6 @@ module Spree
       preference :amount, :decimal, default: 0
       preference :currency, :string, default: ->{ Spree::Config[:currency] }
 
-      def self.description
-        Spree.t(:shipping_flat_rate_per_item)
-      end
-
       def compute_package(package)
         compute_from_quantity(package.contents.sum(&:quantity))
       end