effective_resources 1.9.16 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2aae5d9ac90fa652dad2f7a60995282a9347dbfbbfdb0b497d1c46db42d7fe4
-  data.tar.gz: 9d19f8cc152193da25ab30c7a4bc43187f9e52fb4eb309c0751df134f2a76dbc
+  metadata.gz: 0bc703e350cb8ca2e07dd5d9f0413f88bd15e98bab5d113e2696397e00af0732
+  data.tar.gz: d40aa7078d8ce692b7c5c7991b5c5ed2c06de95b0bf3602c5253b2b19affe6e6
 SHA512:
-  metadata.gz: 2f33925a5ae6b5eda2076f6a27607af422e02412db62b55d0b6175a77cff200c18450611c314680b54c7843b59bdc498b508b760c03221e47da2a6e62f59efb1
-  data.tar.gz: 71e9ab7dd0e61db615b043455459dad0de6b4e199f14ed39a0eb88ac16558d8b33d55bb9e0b95a2412dd4fa630ef277b198636078825ddb66d5c6db68c6b9fd3
+  metadata.gz: 1f5a322f0390678c9fc5834003621d73a42ab538cb3c904d942b68d44a57acb81cd5ad4601b722f8f8795e64930074ad4281a8f26baea4d798edc0b182eaa48b
+  data.tar.gz: efcd8d06e4889a5adce7a747eb207a0abfb920ae4f46981fd4de82ddeace22eb9ff2364fe1482c99ccff71d94d0d3393e986fd10fd2c6aa74059459ac583f06a

data/app/controllers/concerns/effective/wizard_controller/before_actions.rb

@@ -69,6 +69,13 @@ module Effective
         @page_title ||= resource_wizard_step_title(resource, step)
       end
 
+      def ready_checkout
+        return unless step == :checkout
+        return unless resource.class.try(:acts_as_purchasable_wizard?)
+
+        resource.ready!
+      end
+
     end
   end
 end

data/app/controllers/concerns/effective/wizard_controller.rb

@@ -25,6 +25,8 @@ module Effective
 
         before_action :assign_current_step
         before_action :assign_page_title
+
+        before_action :ready_checkout
       end
 
       helper_method :resource

data/app/helpers/effective_resources_wizard_helper.rb

@@ -14,8 +14,8 @@ module EffectiveResourcesWizardHelper
     return sidebar unless block_given?
 
     content_tag(:div, class: 'row') do
-      content_tag(:div, class: 'col-3') { sidebar } +
-      content_tag(:div, class: 'col-9') { yield }
+      content_tag(:div, class: 'col-lg-3') { sidebar } +
+      content_tag(:div, class: 'col-lg-9') { yield }
     end
   end
 
@@ -28,10 +28,10 @@ module EffectiveResourcesWizardHelper
     disabled = !resource.can_visit_step?(nav_step)
 
     label = [index, title].compact.join('. ')
-    klass = ['list-group-item', ('active' if current), ('disabled' if disabled && !current)].compact.join(' ')
+    klass = ['list-group-item', 'list-group-item-action', ('active' if current), ('disabled' if disabled && !current)].compact.join(' ')
 
     if (current || disabled)
-      content_tag(:li, label, class: klass)
+      content_tag(:a, label, class: klass)
     else
       link_to(label, wizard_path(nav_step), class: klass)
     end

data/app/models/concerns/acts_as_purchasable_wizard.rb

@@ -0,0 +1,129 @@
+# ActsAsPurchasableWizard
+#
+
+module ActsAsPurchasableWizard
+  extend ActiveSupport::Concern
+
+  module Base
+    def acts_as_purchasable_wizard
+      raise('please declare acts_as_wizard first') unless respond_to?(:acts_as_wizard?)
+      raise('please declare acts_as_purchasable_parent first') unless respond_to?(:acts_as_purchasable_parent?)
+
+      unless (const_get(:WIZARD_STEPS).keys & [:billing, :checkout, :submitted]).length == 3
+        raise('please include a :billing, :checkout and :submitted step')
+      end
+
+      include ::ActsAsPurchasableWizard
+    end
+  end
+
+  included do
+    validates :owner, presence: true
+
+    # Billing Step
+    validate(if: -> { current_step == :billing && owner.present? }) do
+      self.errors.add(:base, "must have a billing address") unless owner.billing_address.present?
+      self.errors.add(:base, "must have an email") unless owner.email.present?
+    end
+
+    after_purchase do |_|
+      raise('expected submit_order to be purchased') unless submit_order&.purchased?
+      before_submit_purchased!
+      submit_purchased!
+      after_submit_purchased!
+    end
+  end
+
+  # All Fees and Orders
+  def submit_fees
+    raise('to be implemented by caller')
+  end
+
+  def submit_order
+    orders.first
+  end
+
+  def find_or_build_submit_fees
+    submit_fees
+  end
+
+  def find_or_build_submit_order
+    order = submit_order || orders.build(user: owner)
+    fees = submit_fees().reject { |fee| fee.marked_for_destruction? }
+
+    # Adds fees, but does not overwrite any existing price.
+    fees.each do |fee|
+      order.add(fee) unless order.purchasables.include?(fee)
+    end
+
+    order.order_items.each do |order_item|
+      fee = fees.find { |fee| fee == order_item.purchasable }
+      order.remove(order_item) unless fee.present?
+    end
+
+    # From Billing Step
+    order.billing_address = owner.billing_address if owner.billing_address.present?
+
+    # Important to add/remove anything
+    order.save!
+
+    order
+  end
+
+  # Should be indempotent.
+  def build_submit_fees_and_order
+    return false if was_submitted?
+
+    fees = find_or_build_submit_fees()
+    raise('already has purchased submit fees') if fees.any?(&:purchased?)
+
+    order = find_or_build_submit_order()
+    raise('already has purchased submit order') if order.purchased?
+
+    true
+  end
+
+  # Owner clicks on the Billing step. Next step is Checkout
+  def billing!
+    ready! && save!
+  end
+
+  # Ready to check out
+  # This is called by the "ready_checkout" before_action in wizard_controller/before_actions.rb
+  def ready!
+    without_current_step do
+      build_submit_fees_and_order
+      save!
+    end
+  end
+
+  # Called automatically via after_purchase hook above
+  def submit_purchased!
+    return false if was_submitted?
+
+    wizard_steps[:checkout] = Time.zone.now
+    submit!
+  end
+
+  # A hook to extend
+  def before_submit_purchased!
+  end
+
+  def after_submit_purchased!
+  end
+
+  # Draft -> Submitted requirements
+  def submit!
+    raise('already submitted') if was_submitted?
+    raise('expected a purchased order') unless submit_order&.purchased?
+
+    wizard_steps[:checkout] ||= Time.zone.now
+    wizard_steps[:submitted] = Time.zone.now
+    submitted!
+  end
+
+  module ClassMethods
+    def acts_as_purchasable_wizard?; true; end
+  end
+
+end

data/app/models/concerns/acts_as_wizard.rb

@@ -50,9 +50,13 @@ module ActsAsWizard
       can_revisit_completed_steps(step)
     end
 
+    def wizard_step_keys
+      self.class.const_get(:WIZARD_STEPS).keys
+    end
+
     def required_steps
       return self.class.test_required_steps if Rails.env.test? && self.class.test_required_steps.present?
-      self.class.const_get(:WIZARD_STEPS).keys
+      wizard_step_keys()
     end
 
     def wizard_step_title(step)
@@ -104,6 +108,16 @@ module ActsAsWizard
       has_completed_step?(required_steps.last)
     end
 
+    def without_current_step(&block)
+      existing = current_step
+
+      begin
+        self.current_step = nil; yield
+      ensure
+        self.current_step = existing
+      end
+    end
+
     private
 
     def can_revisit_completed_steps(step)

data/app/views/layouts/effective_mailer_layout.html.haml

@@ -0,0 +1,7 @@
+!!!
+%html{style: 'background: #fff;'}
+  %head
+    %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
+
+  %body{style: 'background: #fff;'}
+    = yield

data/config/effective_resources.rb

@@ -21,6 +21,8 @@ EffectiveResources.setup do |config|
   # end
   config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
 
+  # Default Submits
+  #
   # These default submit actions will be added to each controller
   # and rendered when calling effective_submit(f)
   # based on the controller, and its `submits` if any.
@@ -28,4 +30,22 @@ EffectiveResources.setup do |config|
   # Supported values: 'Save', 'Continue', and 'Add New'
   config.default_submits = ['Save', 'Continue', 'Add New']
 
+  # Email Settings
+  #
+  # The default mailer settings for all effective gems
+  #
+  # Configure the parent class responsible to send e-mails.
+  # config.parent_mailer = '::ApplicationMailer'
+
+  # Default deliver method
+  # config.deliver_method = :deliver_now
+
+  # Default layout
+  # config.mailer_layout = 'effective_mailer_layout'
+
+  # Default From
+  config.mailer_sender = "no-reply@example.com"
+
+  # Send Admin correspondence To
+  config.mailer_admin = "admin@example.com"
 end

data/lib/effective_resources/effective_gem.rb

@@ -38,6 +38,16 @@ module EffectiveGem
 
       true
     end
+
+    # This is included into every gem
+    # The gem may not have a mailer or use effective email templates
+    def send_email(email, *args)
+      raise('gem does not respond to mailer_class') unless respond_to?(:mailer_class)
+      raise('expected args to be an Array') unless args.kind_of?(Array)
+
+      mailer_class.send(email, *args).send(EffectiveResources.deliver_method)
+    end
+
   end
 
 end

data/lib/effective_resources/engine.rb

@@ -28,6 +28,7 @@ module EffectiveResources
         ActiveRecord::Base.extend(ActsAsSlugged::Base)
         ActiveRecord::Base.extend(ActsAsStatused::Base)
         ActiveRecord::Base.extend(ActsAsWizard::Base)
+        ActiveRecord::Base.extend(ActsAsPurchasableWizard::Base)
         ActiveRecord::Base.extend(HasManyRichTexts::Base)
 
         ActiveRecord::Base.extend(EffectiveDeviseUser::Base)

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.9.16'.freeze
+  VERSION = '1.10.0'.freeze
 end

data/lib/effective_resources.rb

@@ -5,7 +5,10 @@ require 'effective_resources/effective_gem'
 module EffectiveResources
 
   def self.config_keys
-    [:authorization_method, :default_submits]
+    [
+      :authorization_method, :default_submits,
+      :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :parent_mailer
+    ]
   end
 
   include EffectiveGem
@@ -31,6 +34,28 @@ module EffectiveResources
     (['Save', 'Continue', 'Add New'] & Array(config.default_submits)).inject({}) { |h, v| h[v] = true; h }
   end
 
+  # Email
+  def self.deliver_method
+    config[:deliver_method] || :deliver_now
+  end
+
+  def self.mailer_layout
+    config[:mailer_layout] || 'effective_mailer_layout'
+  end
+
+  def self.mailer_sender
+    config[:mailer_sender] || raise('effective resources mailer_sender missing. Add it to config/initializers/effective_resources.rb')
+  end
+
+  def self.mailer_admin
+    config[:mailer_admin] || raise('effective resources mailer_admin missing. Add it to config/initializers/effective_resources.rb')
+  end
+
+  def self.parent_mailer_class
+    return config[:parent_mailer].constantize if config[:parent_mailer].present?
+    '::ApplicationMailer'.safe_constantize || 'ActionMailer::Base'.constantize
+  end
+
   # Utilities
 
   # This looks up the best class give the name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.9.16
+  version: 1.10.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -153,6 +153,7 @@ files:
 - app/helpers/effective_resources_wizard_helper.rb
 - app/models/concerns/acts_as_archived.rb
 - app/models/concerns/acts_as_email_form.rb
+- app/models/concerns/acts_as_purchasable_wizard.rb
 - app/models/concerns/acts_as_slugged.rb
 - app/models/concerns/acts_as_statused.rb
 - app/models/concerns/acts_as_tokened.rb
@@ -201,6 +202,7 @@ files:
 - app/views/effective/resource/_actions.html.haml
 - app/views/effective/resource/_actions_dropleft.html.haml
 - app/views/effective/resource/_actions_glyphicons.html.haml
+- app/views/layouts/effective_mailer_layout.html.haml
 - config/effective_resources.rb
 - lib/effective_resources.rb
 - lib/effective_resources/effective_gem.rb