solidus_subscriptions-alpha 0.0.3 → 0.0.4

data/app/models/solidus_subscriptions/line_item.rb

@@ -1,98 +1,98 @@
-# The LineItem class is responsible for associating Line items to subscriptions.  # It tracks the following values:
-#
-# [Spree::LineItem] :spree_line_item The spree object which created this instance
-#
-# [SolidusSubscription::Subscription] :subscription The object responsible for
-#   grouping all information needed to create new subscription orders together
-#
-# [Integer] :subscribable_id The id of the object to be added to new subscription
-#   orders when they are placed
-#
-# [Integer] :quantity How many units of the subscribable should be included in
-#   future orders
-#
-# [Integer] :interval How often subscription orders should be placed
-#
-# [Integer] :installments How many subscription orders should be placed
-module SolidusSubscriptions
-  class LineItem < ActiveRecord::Base
-    include Interval
-
-    belongs_to :spree_line_item, class_name: 'Spree::LineItem', inverse_of: :subscription_line_items
-    has_one :order, through: :spree_line_item, class_name: 'Spree::Order'
-    belongs_to(
-      :subscription,
-      class_name: 'SolidusSubscriptions::Subscription',
-      inverse_of: :line_items
-    )
-
-    validates :subscribable_id, presence: :true
-    validates :quantity, numericality: { greater_than: 0 }
-    validates :interval_length, numericality: { greater_than: 0 }, unless: -> { subscription }
-
-    before_update :update_actionable_date_if_interval_changed
-
-    def next_actionable_date
-      dummy_subscription.next_actionable_date
-    end
-
-    def as_json(**options)
-      options[:methods] ||= [:dummy_line_item, :next_actionable_date]
-      super(options)
-    end
-
-    # Get a placeholder line item for calculating the values of future
-    # subscription orders. It is frozen and cannot be saved
-    def dummy_line_item
-      li = LineItemBuilder.new([self]).spree_line_items.first
-      return unless li
-
-      li.order = dummy_order
-      li.validate
-      li.freeze
-    end
-
-    def interval
-      subscription.try!(:interval) || super
-    end
-
-    private
-
-    # Get a placeholder order for calculating the values of future
-    # subscription orders. It is a frozen duplicate of the current order and
-    # cannot be saved
-    def dummy_order
-      order = spree_line_item ? spree_line_item.order.dup : Spree::Order.create
-      order.ship_address = subscription.shipping_address || subscription.user.ship_address if subscription
-
-      order.freeze
-    end
-
-    # A place holder for calculating dynamic values needed to display in the cart
-    # it is frozen and cannot be saved
-    def dummy_subscription
-      Subscription.new(line_items: [dup], interval_length: interval_length, interval_units: interval_units).freeze
-    end
-
-    def update_actionable_date_if_interval_changed
-      if persisted? && subscription && (interval_length_changed? || interval_units_changed?)
-        base_date = if subscription.installments.any?
-          subscription.installments.last.created_at
-        else
-          subscription.created_at
-        end
-
-        new_date = interval.since(base_date)
-
-        if new_date < Time.zone.now
-          # if the chosen base time plus the new interval is in the past, set
-          # the actionable_date to be now to avoid confusion and possible
-          # mis-processing.
-          new_date = Time.zone.now
-        end
-
-        subscription.actionable_date = new_date
-      end
-    end
-  end
-end
+# The LineItem class is responsible for associating Line items to subscriptions.  # It tracks the following values:
+#
+# [Spree::LineItem] :spree_line_item The spree object which created this instance
+#
+# [SolidusSubscription::Subscription] :subscription The object responsible for
+#   grouping all information needed to create new subscription orders together
+#
+# [Integer] :subscribable_id The id of the object to be added to new subscription
+#   orders when they are placed
+#
+# [Integer] :quantity How many units of the subscribable should be included in
+#   future orders
+#
+# [Integer] :interval How often subscription orders should be placed
+#
+# [Integer] :installments How many subscription orders should be placed
+module SolidusSubscriptions
+  class LineItem < ActiveRecord::Base
+    include Interval
+
+    belongs_to :spree_line_item, class_name: 'Spree::LineItem', inverse_of: :subscription_line_items
+    has_one :order, through: :spree_line_item, class_name: 'Spree::Order'
+    belongs_to(
+      :subscription,
+      class_name: 'SolidusSubscriptions::Subscription',
+      inverse_of: :line_items
+    )
+
+    validates :subscribable_id, presence: :true
+    validates :quantity, numericality: { greater_than: 0 }
+    validates :interval_length, numericality: { greater_than: 0 }, unless: -> { subscription }
+
+    before_update :update_actionable_date_if_interval_changed
+
+    def next_actionable_date
+      dummy_subscription.next_actionable_date
+    end
+
+    def as_json(**options)
+      options[:methods] ||= [:dummy_line_item, :next_actionable_date]
+      super(options)
+    end
+
+    # Get a placeholder line item for calculating the values of future
+    # subscription orders. It is frozen and cannot be saved
+    def dummy_line_item
+      li = LineItemBuilder.new([self]).spree_line_items.first
+      return unless li
+
+      li.order = dummy_order
+      li.validate
+      li.freeze
+    end
+
+    def interval
+      subscription.try!(:interval) || super
+    end
+
+    private
+
+    # Get a placeholder order for calculating the values of future
+    # subscription orders. It is a frozen duplicate of the current order and
+    # cannot be saved
+    def dummy_order
+      order = spree_line_item ? spree_line_item.order.dup : Spree::Order.create
+      order.ship_address = subscription.shipping_address || subscription.user.ship_address if subscription
+
+      order.freeze
+    end
+
+    # A place holder for calculating dynamic values needed to display in the cart
+    # it is frozen and cannot be saved
+    def dummy_subscription
+      Subscription.new(line_items: [dup], interval_length: interval_length, interval_units: interval_units).freeze
+    end
+
+    def update_actionable_date_if_interval_changed
+      if persisted? && subscription && (interval_length_changed? || interval_units_changed?)
+        base_date = if subscription.installments.any?
+          subscription.installments.last.created_at
+        else
+          subscription.created_at
+        end
+
+        new_date = interval.since(base_date)
+
+        if new_date < Time.zone.now
+          # if the chosen base time plus the new interval is in the past, set
+          # the actionable_date to be now to avoid confusion and possible
+          # mis-processing.
+          new_date = Time.zone.now
+        end
+
+        subscription.actionable_date = new_date
+      end
+    end
+  end
+end

data/app/models/solidus_subscriptions/line_item_builder.rb

@@ -1,44 +1,44 @@
-# This class is responsible for taking SubscriptionLineItems and building
-# them into Spree::LineItems which can be added to an order
-module SolidusSubscriptions
-  class LineItemBuilder
-    attr_reader :subscription_line_items
-
-    # Get a new instance of a LineItemBuilder
-    #
-    # @param subscription_line_items[Array<SolidusSubscriptions::LineItem>] The
-    #   subscription line item to be converted into a Spree::LineItem
-    #
-    # @return [SolidusSubscriptions::LineItemBuilder]
-    def initialize(subscription_line_items)
-      @subscription_line_items = subscription_line_items
-    end
-
-    # Get a new (unpersisted) Spree::LineItem which matches the details of
-    # :subscription_line_item
-    #
-    # @return [Array<Spree::LineItem>]
-    def spree_line_items
-      line_items = subscription_line_items.map do |subscription_line_item|
-        variant = subscribables.fetch(subscription_line_item.subscribable_id)
-
-        raise UnsubscribableError.new(variant) unless variant.subscribable?
-        next unless variant.can_supply?(subscription_line_item.quantity)
-
-        Spree::LineItem.new(variant: variant, quantity: subscription_line_item.quantity)
-      end
-
-      # Either all line items for an installment are fullfilled or none are
-      line_items.all? ? line_items : []
-    end
-
-    private
-
-    def subscribables
-      return @subscribables if @subscribables
-
-      ids = subscription_line_items.map(&:subscribable_id)
-      @subscribables ||= Spree::Variant.find(ids).index_by(&:id)
-    end
-  end
-end
+# This class is responsible for taking SubscriptionLineItems and building
+# them into Spree::LineItems which can be added to an order
+module SolidusSubscriptions
+  class LineItemBuilder
+    attr_reader :subscription_line_items
+
+    # Get a new instance of a LineItemBuilder
+    #
+    # @param subscription_line_items[Array<SolidusSubscriptions::LineItem>] The
+    #   subscription line item to be converted into a Spree::LineItem
+    #
+    # @return [SolidusSubscriptions::LineItemBuilder]
+    def initialize(subscription_line_items)
+      @subscription_line_items = subscription_line_items
+    end
+
+    # Get a new (unpersisted) Spree::LineItem which matches the details of
+    # :subscription_line_item
+    #
+    # @return [Array<Spree::LineItem>]
+    def spree_line_items
+      line_items = subscription_line_items.map do |subscription_line_item|
+        variant = subscribables.fetch(subscription_line_item.subscribable_id)
+
+        raise UnsubscribableError.new(variant) unless variant.subscribable?
+        next unless variant.can_supply?(subscription_line_item.quantity)
+
+        Spree::LineItem.new(variant: variant, quantity: subscription_line_item.quantity)
+      end
+
+      # Either all line items for an installment are fullfilled or none are
+      line_items.all? ? line_items : []
+    end
+
+    private
+
+    def subscribables
+      return @subscribables if @subscribables
+
+      ids = subscription_line_items.map(&:subscribable_id)
+      @subscribables ||= Spree::Variant.find(ids).index_by(&:id)
+    end
+  end
+end

data/app/models/solidus_subscriptions/order_builder.rb

@@ -1,40 +1,40 @@
-# This class is responsible for adding line items to order without going
-# through order contents.
-module SolidusSubscriptions
-  class OrderBuilder
-    attr_reader :order
-
-    # Get a new instance of a OrderBuilder
-    #
-    # @param order [Spree::Order] The order to be built
-    #
-    # @return [SolidusSubscriptions::OrderBuilder]
-    def initialize(order)
-      @order = order
-    end
-
-    # Add line items for to an order. If the order already
-    # has a line item for a given variant_id, update the quantity. Otherwise
-    # add the line item to the order.
-    #
-    # @param items [Array<Spree::LineItem>] The order to add the line item to
-    # @return [Array<Spree::LineItem] The collection that was passed in
-    def add_line_items(items)
-      items.map { |item| add_item_to_order(item) }
-    end
-
-    private
-
-    def add_item_to_order(new_item)
-      line_item = order.line_items.detect do |li|
-        li.variant_id == new_item.variant_id
-      end
-
-      if line_item
-        line_item.increment!(:quantity, new_item.quantity)
-      else
-        order.line_items << new_item
-      end
-    end
-  end
-end
+# This class is responsible for adding line items to order without going
+# through order contents.
+module SolidusSubscriptions
+  class OrderBuilder
+    attr_reader :order
+
+    # Get a new instance of a OrderBuilder
+    #
+    # @param order [Spree::Order] The order to be built
+    #
+    # @return [SolidusSubscriptions::OrderBuilder]
+    def initialize(order)
+      @order = order
+    end
+
+    # Add line items for to an order. If the order already
+    # has a line item for a given variant_id, update the quantity. Otherwise
+    # add the line item to the order.
+    #
+    # @param items [Array<Spree::LineItem>] The order to add the line item to
+    # @return [Array<Spree::LineItem] The collection that was passed in
+    def add_line_items(items)
+      items.map { |item| add_item_to_order(item) }
+    end
+
+    private
+
+    def add_item_to_order(new_item)
+      line_item = order.line_items.detect do |li|
+        li.variant_id == new_item.variant_id
+      end
+
+      if line_item
+        line_item.increment!(:quantity, new_item.quantity)
+      else
+        order.line_items << new_item
+      end
+    end
+  end
+end

data/app/models/solidus_subscriptions/out_of_stock_dispatcher.rb

@@ -1,19 +1,19 @@
-# This service class is intented to provide callback behaviour to handle
-# the case where an installment cannot be processed due to lack of stock.
-module SolidusSubscriptions
-  class OutOfStockDispatcher < Dispatcher
-    def dispatch
-      installments.each(&:out_of_stock)
-      super
-    end
-
-    private
-
-    def message
-      "
-      The following installments cannot be fulfilled due to lack of stock:
-      #{installments.map(&:id).join(', ')}.
-      "
-    end
-  end
-end
+# This service class is intented to provide callback behaviour to handle
+# the case where an installment cannot be processed due to lack of stock.
+module SolidusSubscriptions
+  class OutOfStockDispatcher < Dispatcher
+    def dispatch
+      installments.each(&:out_of_stock)
+      super
+    end
+
+    private
+
+    def message
+      "
+      The following installments cannot be fulfilled due to lack of stock:
+      #{installments.map(&:id).join(', ')}.
+      "
+    end
+  end
+end

data/app/models/solidus_subscriptions/payment_failed_dispatcher.rb

@@ -1,23 +1,23 @@
-# This service class is intented to provide callback behaviour to handle
-# the case where a subscription order cannot be processed because a payment
-# failed
-module SolidusSubscriptions
-  class PaymentFailedDispatcher < Dispatcher
-    def dispatch
-      order.touch :completed_at
-      order.cancel!
-
-      installments.each { |i| i.payment_failed!(order) }
-      super
-    end
-
-    private
-
-    def message
-      "
-      The following installments could not be processed due to payment
-      authorization failure: #{installments.map(&:id).join(', ')}
-      "
-    end
-  end
-end
+# This service class is intented to provide callback behaviour to handle
+# the case where a subscription order cannot be processed because a payment
+# failed
+module SolidusSubscriptions
+  class PaymentFailedDispatcher < Dispatcher
+    def dispatch
+      order.touch :completed_at
+      order.cancel!
+
+      installments.each { |i| i.payment_failed!(order) }
+      super
+    end
+
+    private
+
+    def message
+      "
+      The following installments could not be processed due to payment
+      authorization failure: #{installments.map(&:id).join(', ')}
+      "
+    end
+  end
+end