solidus_subscriptions-alpha 0.0.1

data/app/models/solidus_subscriptions/subscription_generator.rb

@@ -0,0 +1,60 @@
+# This module is responsible for taking SolidusSubscriptions::LineItem
+# objects and creating SolidusSubscriptions::Subscription Objects
+module SolidusSubscriptions
+  module SubscriptionGenerator
+    extend self
+
+    SubscriptionConfiguration = Struct.new(:interval_length, :interval_units, :end_date)
+
+    # Create and persist a subscription for a collection of subscription
+    #   line items
+    #
+    # @param subscription_line_items [Array<SolidusSubscriptions::LineItem>] The
+    #   subscription_line_items to be activated
+    #
+    # @return [SolidusSubscriptions::Subscription]
+    def activate(subscription_line_items)
+      return if subscription_line_items.empty?
+
+      order = subscription_line_items.first.order
+      configuration = subscription_configuration(subscription_line_items.first)
+
+      subscription_attributes = {
+        user: order.user,
+        line_items: subscription_line_items,
+        store: order.store,
+        shipping_address: order.ship_address,
+        **configuration.to_h
+      }
+
+      Subscription.create!(subscription_attributes) do |sub|
+        sub.actionable_date = sub.next_actionable_date
+      end
+    end
+
+    # Group a collection of line items by common subscription configuration
+    # options. Grouped subscription_line_items can belong to a single
+    # subscription.
+    #
+    # @param subscription_line_items [Array<SolidusSubscriptions::LineItem>] The
+    #   subscription_line_items to be grouped.
+    #
+    # @return [Array<Array<SolidusSubscriptions::LineItem>>]
+    def group(subscription_line_items)
+      subscription_line_items.group_by do |li|
+        subscription_configuration(li)
+      end.
+      values
+    end
+
+    private
+
+    def subscription_configuration(subscription_line_item)
+      SubscriptionConfiguration.new(
+        subscription_line_item.interval_length,
+        subscription_line_item.interval_units,
+        subscription_line_item.end_date
+      )
+    end
+  end
+end

data/app/models/solidus_subscriptions/subscription_line_item_builder.rb

@@ -0,0 +1,21 @@
+module SolidusSubscriptions
+  module SubscriptionLineItemBuilder
+    private
+
+    def create_subscription_line_item(line_item)
+      SolidusSubscriptions::LineItem.create!(
+        subscription_params.merge(spree_line_item: line_item)
+      )
+
+      # Rerun the promotion handler to pickup subscription promotions
+      Spree::PromotionHandler::Cart.new(line_item.order).activate
+      line_item.order.update!
+    end
+
+    def subscription_params
+      params.require(:subscription_line_item).permit(
+        SolidusSubscriptions::Config.subscription_line_item_attributes
+      )
+    end
+  end
+end

data/app/models/solidus_subscriptions/subscription_order_promotion_rule.rb

@@ -0,0 +1,25 @@
+module SolidusSubscriptions
+  class SubscriptionOrderPromotionRule < Spree::PromotionRule
+    # Promotion can be applied to an entire order. Will only be true
+    # for Spree::Order
+    #
+    # @param promotable [Object] Any object which could have this
+    #   promotion rule applied to it.
+    #
+    # @return [Boolean]
+    def applicable?(promotable)
+      promotable.is_a? Spree::Order
+    end
+
+    # An order is eligible if it fulfills a subscription Installment. Will only
+    # return true if the order fulfills one or more Installments
+    #
+    # @param order [Spree::Order] The order which could have this rule applied
+    #   to it.
+    #
+    # @return [Boolean]
+    def eligible?(order, **_options)
+      order.subscription_order?
+    end
+  end
+end

data/app/models/solidus_subscriptions/subscription_promotion_rule.rb

@@ -0,0 +1,38 @@
+module SolidusSubscriptions
+  class SubscriptionPromotionRule < Spree::PromotionRule
+    # Promotion can be applied to an entire order. Will only be true
+    # for Spree::Order
+    #
+    # @param promotable [Object] Any object which could have this
+    #   promotion rule applied to it.
+    #
+    # @return [Boolean]
+    def applicable?(promotable)
+      promotable.is_a? Spree::Order
+    end
+
+    # An order is eligible if it contains a line item with an associates
+    # subscription_line_item.  This rule applies to order and so its eligibility
+    # will always be considered against an order. Will only return true for
+    # orders containing Spree::Line item with associated subscription_line_items
+    #
+    # @param order [Spree::Order] The order which could have this rule applied
+    #   to it.
+    #
+    # @return [Boolean]
+    def eligible?(order, **_options)
+      order.subscription_line_items.any?
+    end
+
+    # Certain actions create adjustments on line items. In this case, only
+    # line items with associated subscription_line_itms are eligible to be
+    # adjusted. Will only return true # if :line_item has an associated
+    # subscription.
+    #
+    # @param line_item [Spree::LineItem] The line item which could be adjusted
+    #   by the promotion.
+    def actionable?(line_item)
+      line_item.subscription_line_items.present?
+    end
+  end
+end

data/app/models/solidus_subscriptions/success_dispatcher.rb

@@ -0,0 +1,16 @@
+# This service class is intented to provide callback behaviour to handle
+# an installment successfully being processed
+module SolidusSubscriptions
+  class SuccessDispatcher < Dispatcher
+    def dispatch
+      installments.each { |i| i.success!(order) }
+      super
+    end
+
+    private
+
+    def message
+      "Successfully processed installments: #{installments.map(&:id).join(', ')}"
+    end
+  end
+end

data/app/models/solidus_subscriptions/unsubscribable_error.rb

@@ -0,0 +1,17 @@
+# This error should be raised if a user attempts to subscribe to a item which
+# is not subscribable
+module SolidusSubscriptions
+  class UnsubscribableError < StandardError
+    def initialize(subscribable)
+      @subscribable = subscribable
+      super
+    end
+
+    def to_s
+      <<-MSG.squish
+        #{@subscribable.class} with id: #{@subscribable.id} cannot be
+        subscribed to.
+      MSG
+    end
+  end
+end

data/app/models/solidus_subscriptions/user_mismatch_error.rb

@@ -0,0 +1,15 @@
+module SolidusSubscriptions
+  class UserMismatchError < StandardError
+    def initialize(installments)
+      @installments = installments
+    end
+
+    def to_s
+      <<-MSG.squish
+        Installments must have the same user to be processed as a consolidated
+        installment. Could not process installments:
+        #{@installments.map(&:id).join(', ')}
+      MSG
+    end
+  end
+end

data/app/overrides/views/admin_subscribable_checkbox.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: "spree/admin/variants/_form",
+  name: "solidus_subscriptions_subscribable_checkbox",
+  insert_after: "[data-hook='track_inventory']",
+  partial: "spree/admin/variants/subscribable_checkbox"
+)

data/app/overrides/views/admin_subscriptions_menu_link.rb

@@ -0,0 +1,8 @@
+if !Spree::Backend::Config.respond_to?(:menu_items)
+  Deface::Override.new(
+    virtual_path: 'spree/admin/shared/_menu',
+    name: :add_subcriptions_admin_link,
+    insert_bottom: "[data-hook='admin_tabs']",
+    partial: 'spree/admin/shared/subscription_tab'
+  )
+end

data/app/overrides/views/subscription_line_item_fields.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: "spree/products/_cart_form",
+  name: "subscription_line_item_fields",
+  insert_after: "[data-hook='inside_product_cart_form']",
+  partial: "spree/frontend/products/subscription_line_item_fields"
+)

data/app/views/spree/admin/shared/_no_objects_found.html.erb

@@ -0,0 +1,4 @@
+<%= Spree.t(:no_resource, resource: resource.model_name.human.pluralize) %>
+<% if can? :create, resource %>
+  <%= link_to Spree.t(:create_one), new_resource_url %>
+<% end %>

data/app/views/spree/admin/shared/_subscription_tab.html.erb

@@ -0,0 +1,3 @@
+<% if can? :admin, SolidusSubscriptions::Subscription %>
+  <%= tab :subscriptions, icon: 'repeat' %>
+<% end %>

data/app/views/spree/admin/solidus_subscriptions/subscriptions/_subscription.html.erb

@@ -0,0 +1,66 @@
+<%= content_tag :tr, class: cycle('odd', 'even') do %>
+  <%= content_tag :td, l(subscription.created_at.to_date), class: 'align-center' %>
+
+  <%= content_tag :td, class: 'align-center' do %>
+    <%= link_to subscription.user.email, admin_user_path(subscription.user) %>
+  <% end %>
+
+  <%= content_tag :td, class: 'align-center' do %>
+    <%= subscription.actionable_date ? l(subscription.actionable_date) : '-' %>
+  <% end %>
+
+  <%= content_tag :td, class: 'align-center' do %>
+    <%= subscription.interval.inspect %>
+  <% end %>
+
+  <%= content_tag :td, class: 'align-center' do %>
+    <%= content_tag :span, subscription.human_state_name, class: "state #{ subscription.state }" %>
+  <% end %>
+
+  <%= content_tag :td, class: 'align-center' do %>
+    <%= content_tag :span,  class: "state #{ subscription.processing_state }" do %>
+      <%= subscription.class.human_attribute_name("processing_state.#{ subscription.processing_state }") %>
+    <% end %>
+  <% end %>
+
+  <td class="actions align-center">
+    <% if subscription.state_events.include?(:cancel) %>
+      <%=
+        link_to_with_icon(
+          :stop,
+          t('.cancel'),
+          spree.cancel_admin_subscription_path(subscription),
+          no_text: true,
+          method: :delete,
+          data: { confirm: t('.cancel_alert') }
+        )
+      %>
+    <% end %>
+
+    <% if subscription.state_events.include?(:activate) %>
+      <%=
+        link_to_with_icon(
+          :play,
+          t('.activate'),
+          spree.activate_admin_subscription_path(subscription),
+          no_text: true,
+          method: :post
+        )
+      %>
+    <% end %>
+
+    <% if subscription.active? %>
+      <%=
+        link_to_with_icon(
+          :'fast-forward',
+          t('.skip'),
+          spree.skip_admin_subscription_path(subscription),
+          no_text: true,
+          method: :post
+        )
+      %>
+    <% end %>
+
+    <%= link_to_edit(subscription, no_text: true) %>
+  </td>
+<% end %>

data/app/views/spree/admin/subscriptions/_form.html.erb

@@ -0,0 +1,81 @@
+<% new ||= false %>
+
+<fieldset class="no-border-top">
+  <fieldset class="index no-border-bottom">
+    <legend><%= t('.subscription') %></legend>
+
+    <% if new %>
+      <div class="row">
+        <div class="field twelve columns">
+          <%= f.label :user_id, Spree.t(:user), class: "required" %>
+          <%= f.collection_select :user_id,  Spree::User.all, :id, :email, {}, class: "select2 fullwidth" %>
+        </div>
+
+      </div>
+    <% end %>
+  </fieldset>
+
+  <div class="row">
+    <%= content_tag :div, class: "field alpha three columns" do %>
+      <%= f.label :actionable_date %>
+      <%= f.text_field :actionable_date, class: "fullwidth datepicker" %>
+    <% end %>
+
+    <div class='field three columns'>
+      <%= f.label :inverval_length %>
+      <%= f.number_field :interval_length, class: "fullwidth" %>
+    </div>
+
+    <div class='field three columns'>
+      <%= f.label :interval_units %>
+      <%
+        unit_values = SolidusSubscriptions::LineItem.interval_units.keys
+        units = unit_values.map do |unit|
+          [
+            unit,
+            SolidusSubscriptions::LineItem.human_attribute_name("interval_units.#{ unit }")
+          ]
+        end
+      %>
+
+      <div>
+        <% units.each_with_index do |(value, name), i| %>
+          <div>
+            <%= f.label :interval_units, for: "interval_units_#{ value }", class: 'fullwidth' do %>
+              <%= f.radio_button :interval_units, value, id: "interval_units_#{ value }" %>
+              <%= name %>
+            <% end %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+
+    <div class="field omega three columns">
+      <%= f.label :end_date %>
+      <%= f.date_field :end_date, class: "required fullwidth" %>
+    </div>
+  </div>
+
+  <%= f.fields_for :line_items do |lf| %>
+    <fieldset class='no-border-bottom'>
+      <legend><%= t('.subscription_line_item') %></legend>
+
+      <div class="row">
+        <div class='field alpha two columns'>
+          <%= lf.label :quantity %>
+          <%= lf.number_field :quantity, min: 1, class: "fullwidth" %>
+        </div>
+
+        <div class="field columns ten omega">
+          <%= lf.label :subscribable_id %>
+          <%= lf.collection_select :subscribable_id, Spree::Variant.where(subscribable: true), :id, :pretty_name, {}, { class: "fullwidth select2" } %>
+        </div>
+      </div>
+
+    </fieldset>
+  <% end %>
+
+  <div class="filter-actions" data-hook='buttons'>
+    <%= f.button type: :submit %>
+  </div>
+</fieldset>

data/app/views/spree/admin/subscriptions/_legacy_form.html.erb

@@ -0,0 +1,81 @@
+<% new ||= false %>
+
+<fieldset class="no-border-top">
+  <fieldset class="index no-border-bottom">
+    <legend><%= t('.subscription') %></legend>
+
+    <% if new %>
+      <div class="row">
+        <div class="field twelve columns">
+          <%= f.label :user_id, Spree.t(:user), class: "required" %>
+          <%= f.collection_select :user_id,  Spree::User.all, :id, :email, {}, class: "select2 fullwidth" %>
+        </div>
+
+      </div>
+    <% end %>
+  </fieldset>
+
+  <%= f.fields_for :line_item, @line_item do |lf| %>
+    <div class="row">
+      <%= content_tag :div, class: "field alpha three columns" do %>
+        <%= f.label :actionable_date %>
+        <%= f.text_field :actionable_date, class: "fullwidth datepicker" %>
+      <% end %>
+
+      <div class='field three columns'>
+        <%= lf.label :inverval_length %>
+        <%= lf.number_field :interval_length, class: "fullwidth" %>
+      </div>
+
+      <div class='field three columns'>
+        <%= lf.label :interval_units %>
+        <%
+          unit_values = SolidusSubscriptions::LineItem.interval_units.keys
+          units = unit_values.map do |unit|
+            [
+              unit,
+              SolidusSubscriptions::LineItem.human_attribute_name("interval_units.#{ unit }")
+            ]
+          end
+        %>
+
+        <div>
+          <% units.each_with_index do |(value, name), i| %>
+            <div>
+              <%= lf.label :interval_units, for: "interval_units_#{ value }", class: 'fullwidth' do %>
+                <%= lf.radio_button :interval_units, value, id: "interval_units_#{ value }" %>
+                <%= name %>
+              <% end %>
+            </div>
+          <% end %>
+        </div>
+      </div>
+
+      <div class="field omega three columns">
+        <%= lf.label :end_date %>
+        <%= lf.date_field :end_date, class: "required", class: "fullwidth" %>
+      </div>
+    </div>
+
+    <fieldset class='no-border-bottom'>
+      <legend><%= t('.subscription_line_item') %></legend>
+
+      <div class="row">
+        <div class='field alpha two columns'>
+          <%= lf.label :quantity %>
+          <%= lf.number_field :quantity, min: 1, class: "fullwidth" %>
+        </div>
+
+        <div class="field columns ten omega">
+          <%= lf.label :subscribable_id %>
+          <%= lf.collection_select :subscribable_id, Spree::Variant.where(subscribable: true), :id, :pretty_name, {}, { class: "fullwidth select2" } %>
+        </div>
+      </div>
+
+    </fieldset>
+  <% end %>
+
+  <div class="filter-actions" data-hook='buttons'>
+    <%= f.button type: :submit %>
+  </div>
+</fieldset>