solidus_subscriptions-alpha 0.0.4 → 0.0.5

data/app/models/solidus_subscriptions/failure_dispatcher.rb

@@ -1,19 +1,19 @@
-# A handler for behaviour that should happen after installments are marked as
-# failures
-module SolidusSubscriptions
-  class FailureDispatcher < Dispatcher
-    def dispatch
-      order.touch :completed_at
-      order.cancel!
-      installments.each { |i| i.failed!(order) }
-      super
-    end
-
-    def message
-      "
-      Something went wrong processing installments: #{installments.map(&:id).join(', ')}.
-      They have been marked for reprocessing.
-      "
-    end
-  end
-end
+# A handler for behaviour that should happen after installments are marked as
+# failures
+module SolidusSubscriptions
+  class FailureDispatcher < Dispatcher
+    def dispatch
+      order.touch :completed_at
+      order.cancel!
+      installments.each { |i| i.failed!(order) }
+      super
+    end
+
+    def message
+      "
+      Something went wrong processing installments: #{installments.map(&:id).join(', ')}.
+      They have been marked for reprocessing.
+      "
+    end
+  end
+end

data/app/models/solidus_subscriptions/installment.rb

@@ -1,126 +1,126 @@
-# This class represents a single iteration of a subscription. It is fulfulled
-# by a conmpleted order and maintains an association which tracks all attempts
-# successful or othewise at fulfulling this installment
-module SolidusSubscriptions
-  class Installment < ActiveRecord::Base
-    has_many :details, class_name: 'SolidusSubscriptions::InstallmentDetail'
-    belongs_to(
-      :subscription,
-      class_name: 'SolidusSubscriptions::Subscription',
-      inverse_of: :installments
-    )
-
-    validates :subscription, presence: true
-
-    scope :fulfilled, (lambda do
-      joins(:details).where(InstallmentDetail.table_name => { success: true }).distinct
-    end)
-
-    scope :unfulfilled, (lambda do
-      fulfilled_ids = fulfilled.pluck(:id)
-      where.not(id: fulfilled_ids).distinct
-    end)
-
-    scope :actionable, (lambda do
-      unfulfilled.where("#{table_name}.actionable_date <= ?", Time.zone.now)
-    end)
-
-    # Get the builder for the subscription_line_item. This will be an
-    # object that can generate the appropriate line item for the subscribable
-    # object
-    #
-    # @return [SolidusSubscriptions::LineItemBuilder]
-    def line_item_builder
-      subscription.line_item_builder
-    end
-
-    # Mark this installment as out of stock.
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the failed
-    #   processing attempt
-    def out_of_stock
-      advance_actionable_date!
-
-      details.create!(
-        success: false,
-        message: I18n.t('solidus_subscriptions.installment_details.out_of_stock')
-      )
-    end
-
-    # Mark this installment as a success
-    #
-    # @param order [Spree::Order] The order generated for this processing
-    #   attempt
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
-    #   successful processing attempt
-    def success!(order)
-      update!(actionable_date: nil)
-
-      details.create!(
-        success: true,
-        order: order,
-        message: I18n.t('solidus_subscriptions.installment_details.success')
-      )
-    end
-
-    # Mark this installment as a failure
-    #
-    # @param order [Spree::Order] The order generated for this processing
-    #   attempt
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
-    #   failed processing attempt
-    def failed!(order)
-      advance_actionable_date!
-
-      details.create!(
-        success: false,
-        order: order,
-        message: I18n.t('solidus_subscriptions.installment_details.failed')
-      )
-    end
-
-    # Does this installment still need to be fulfilled by a completed order
-    #
-    # @return [Boolean]
-    def unfulfilled?
-      !fulfilled?
-    end
-
-    # Had this installment been fulfilled by a completed order
-    #
-    # @return [Boolean]
-    def fulfilled?
-      details.where(success: true).exists?
-    end
-
-    # Mark this installment as having a failed payment
-    #
-    # @param order [Spree::Order] The order generated for this processing
-    #   attempt
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
-    #   failed processing attempt
-    def payment_failed!(order)
-      advance_actionable_date!
-
-      details.create!(
-        success: false,
-        order: order,
-        message: I18n.t('solidus_subscriptions.installment_details.payment_failed')
-      )
-    end
-
-    private
-
-    def advance_actionable_date!
-      update!(actionable_date: next_actionable_date)
-    end
-
-    def next_actionable_date
-      return if Config.reprocessing_interval.nil?
-      (DateTime.current + Config.reprocessing_interval).beginning_of_minute
-    end
-  end
-end
+# This class represents a single iteration of a subscription. It is fulfulled
+# by a conmpleted order and maintains an association which tracks all attempts
+# successful or othewise at fulfulling this installment
+module SolidusSubscriptions
+  class Installment < ActiveRecord::Base
+    has_many :details, class_name: 'SolidusSubscriptions::InstallmentDetail'
+    belongs_to(
+      :subscription,
+      class_name: 'SolidusSubscriptions::Subscription',
+      inverse_of: :installments
+    )
+
+    validates :subscription, presence: true
+
+    scope :fulfilled, (lambda do
+      joins(:details).where(InstallmentDetail.table_name => { success: true }).distinct
+    end)
+
+    scope :unfulfilled, (lambda do
+      fulfilled_ids = fulfilled.pluck(:id)
+      where.not(id: fulfilled_ids).distinct
+    end)
+
+    scope :actionable, (lambda do
+      unfulfilled.where("#{table_name}.actionable_date <= ?", Time.zone.now)
+    end)
+
+    # Get the builder for the subscription_line_item. This will be an
+    # object that can generate the appropriate line item for the subscribable
+    # object
+    #
+    # @return [SolidusSubscriptions::LineItemBuilder]
+    def line_item_builder
+      subscription.line_item_builder
+    end
+
+    # Mark this installment as out of stock.
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the failed
+    #   processing attempt
+    def out_of_stock
+      advance_actionable_date!
+
+      details.create!(
+        success: false,
+        message: I18n.t('solidus_subscriptions.installment_details.out_of_stock')
+      )
+    end
+
+    # Mark this installment as a success
+    #
+    # @param order [Spree::Order] The order generated for this processing
+    #   attempt
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
+    #   successful processing attempt
+    def success!(order)
+      update!(actionable_date: nil)
+
+      details.create!(
+        success: true,
+        order: order,
+        message: I18n.t('solidus_subscriptions.installment_details.success')
+      )
+    end
+
+    # Mark this installment as a failure
+    #
+    # @param order [Spree::Order] The order generated for this processing
+    #   attempt
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
+    #   failed processing attempt
+    def failed!(order)
+      advance_actionable_date!
+
+      details.create!(
+        success: false,
+        order: order,
+        message: I18n.t('solidus_subscriptions.installment_details.failed')
+      )
+    end
+
+    # Does this installment still need to be fulfilled by a completed order
+    #
+    # @return [Boolean]
+    def unfulfilled?
+      !fulfilled?
+    end
+
+    # Had this installment been fulfilled by a completed order
+    #
+    # @return [Boolean]
+    def fulfilled?
+      details.where(success: true).exists?
+    end
+
+    # Mark this installment as having a failed payment
+    #
+    # @param order [Spree::Order] The order generated for this processing
+    #   attempt
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
+    #   failed processing attempt
+    def payment_failed!(order)
+      advance_actionable_date!
+
+      details.create!(
+        success: false,
+        order: order,
+        message: I18n.t('solidus_subscriptions.installment_details.payment_failed')
+      )
+    end
+
+    private
+
+    def advance_actionable_date!
+      update!(actionable_date: next_actionable_date)
+    end
+
+    def next_actionable_date
+      return if Config.reprocessing_interval.nil?
+      (DateTime.current + Config.reprocessing_interval).beginning_of_minute
+    end
+  end
+end

data/app/models/solidus_subscriptions/installment_detail.rb

@@ -1,23 +1,23 @@
-# This class represents a single attempt to fulfill an installment. It will
-# indicate the result of that attept.
-module SolidusSubscriptions
-  class InstallmentDetail < ActiveRecord::Base
-    belongs_to(
-      :installment,
-      class_name: 'SolidusSubscriptions::Installment',
-      inverse_of: :details
-    )
-
-    belongs_to(:order, class_name: 'Spree::Order')
-
-    validates :installment, presence: true
-    alias_attribute :successful, :success
-
-    # Was the attempt at fulfilling this installment a failure?
-    #
-    # @return [Boolean]
-    def failed?
-      !success
-    end
-  end
-end
+# This class represents a single attempt to fulfill an installment. It will
+# indicate the result of that attept.
+module SolidusSubscriptions
+  class InstallmentDetail < ActiveRecord::Base
+    belongs_to(
+      :installment,
+      class_name: 'SolidusSubscriptions::Installment',
+      inverse_of: :details
+    )
+
+    belongs_to(:order, class_name: 'Spree::Order')
+
+    validates :installment, presence: true
+    alias_attribute :successful, :success
+
+    # Was the attempt at fulfilling this installment a failure?
+    #
+    # @return [Boolean]
+    def failed?
+      !success
+    end
+  end
+end

data/app/models/solidus_subscriptions/interval.rb

@@ -1,24 +1,24 @@
-# This module is intended to be included into any active record
-# modle which needs to be aware of how intervals and stored and
-# calculated in the db.
-#
-# Base models must have the following fields: interval_length (integer) and interval_units (integer)
-module SolidusSubscriptions
-  module Interval
-    def self.included(base)
-      base.enum interval_units: {
-        day: 0,
-        week: 1,
-        month: 2,
-        year: 3
-      }
-    end
-
-    # Calculates the number of seconds in the interval.
-    #
-    # @return [Integer] The number of seconds.
-    def interval
-      ActiveSupport::Duration.new(interval_length, { interval_units.pluralize.to_sym => interval_length })
-    end
-  end
-end
+# This module is intended to be included into any active record
+# modle which needs to be aware of how intervals and stored and
+# calculated in the db.
+#
+# Base models must have the following fields: interval_length (integer) and interval_units (integer)
+module SolidusSubscriptions
+  module Interval
+    def self.included(base)
+      base.enum interval_units: {
+        day: 0,
+        week: 1,
+        month: 2,
+        year: 3
+      }
+    end
+
+    # Calculates the number of seconds in the interval.
+    #
+    # @return [Integer] The number of seconds.
+    def interval
+      ActiveSupport::Duration.new(interval_length, { interval_units.pluralize.to_sym => interval_length })
+    end
+  end
+end

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