solidus_promotions 4.4.2 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c806b16cf91750622bd6577afe715ac790b156131f78111827f6fd357cd3fcb
-  data.tar.gz: 35a5c2ec0bbf7d6edb53b1322da77c4128336ae805d94c4579e9e40e25ad574b
+  metadata.gz: c7db30fb68623ede772e5dc6c53bc40205c8d3d929e89df335427b917a9c1857
+  data.tar.gz: 42f7f86d1f7c5fef3d62d27565c08b39b01eb3c15a0107c428dfea9afaafcd03
 SHA512:
-  metadata.gz: 8a470f82057f41699defd90c694caba8c525ff7d54b0672c0f1ea27b5bf9786512b6b2f87b4d0f4f9c326c7e0a8b2bf6c6a4660589285f58509ff67c2d6e7030
-  data.tar.gz: 74f76a2e69d156e4104dd80934867fa96fac155df112c5799309e715475f9be5a6f4ca92d2aac49d4aecc6acd0fd06eaacc3cf9113ab103be8225a7e666c74e2
+  metadata.gz: 114981896806a343b6d5e36db617ecfb4a06fbe3f00f19f4bab46df7db7b473706bc5c2d2a874d2c3d194c4f7002d4f7ca871d00c060faeea5e133403b882d46
+  data.tar.gz: 1666caa17bb47b1989b1356227aa7ce1058e2b9fb4b494e9888203ebfeaf114c30325ad288038c1b4e2966c4ec1e09198c75b5e41e060be3435a4cc3ae863d4d

data/MIGRATING.md

@@ -44,7 +44,7 @@ bundle exec rails solidus_promotions:migrate_existing_promotions
 
 This will create equivalents of the legacy promotion configuration in SolidusPromotions.
 
-Now, change `config/initializers/solidus_promotions.rb` to use your new promotion configuration:
+Now, change `config/initializers/spree.rb` to use your new promotion configuration:
 
 ## Change store behavior to use SolidusPromotions
 

data/README.md

@@ -2,17 +2,22 @@
 
 This gem contains Solidus' recommended promotion system. It is slated to replace the promotion system in the `legacy_promotions` gem.
 
-The basic architecture is very similar to the legacy promotion system, but with a few decisive tweaks, which I'll explain in the coming sections.
+The basic architecture is very similar to the legacy promotion system, but with a few decisive tweaks, which are explained in the subsequent sections.
+
+> [!IMPORTANT]  
+> If you are upgrading from a previous version of Solidus, it is advised that you update also the promotion system to the new gem. Please consult the [Migration Guide](./MIGRATING.md).
+> While the current version of Solidus still installs the legacy promotion system, we advise a migration at the earliest convinience to avoid having to rush the migration in the future. 
+
 
 ## Architecture
 
-This extension centralizes promotion handling in the order updater. A service class, the `SolidusPromotions::OrderAdjuster` applies the current promotion configuration to the order, adjusting or removing adjustments as necessary.
+This extension centralizes promotion handling in the order updater significantly improving the performance of cart calculations. A service class, the `SolidusPromotions::OrderAdjuster` applies the current promotion configuration to the order, adjusting or removing adjustments as necessary.
 
 `SolidusPromotions::Promotion` objects have benefits, and benefits have conditions. For example, a promotion that is "20% off shirts" would have a benefit of type "AdjustLineItem", and that benefit would have a condition of type "LineItemTaxon" that makes sure only line items with the "shirts" taxon will get the benefit.
 
 ### Promotion lanes
 
-Promotions get applied by "lane". Promotions within a lane conflict with each other, whereas promotions that do not share a lane will apply sequentially in the order of the lanes. By default these are "pre", "default" and "post", but you can configure this using the SolidusPromotions initializer:
+Promotions get applied by "lane". Promotions within a lane conflict with each other, whereas promotions that do not share a lane will apply sequentially in the order of the lanes. By default these are "pre", "default" and "post", but they can be configured using the SolidusPromotions initializer:
 
 ```rb
 SolidusPromotions.configure do |config|
@@ -25,11 +30,9 @@ SolidusPromotions.configure do |config|
 end
 ```
 
-### Benefits
-
-Solidus Friendly Promotions ships with only three benefit types by default that should cover most use cases: `AdjustLineItem`, `AdjustShipment` and `CreateDiscountedItem`. There is no benefit that creates order-level adjustments, as this feature of Solidus' legacy promotions system has proven to be very difficult for customer service and finance departments due to the difficulty of accruing order-level adjustments to individual line items when e.g. processing returns. In order to give a fixed discount to all line items in an order, use the `AdjustLineItem` benefit with the `DistributedAmount` calculator.
+### Types of Benefits
 
-Alle benefits are calculable. By setting their `calculator` to one of the classes provided, a great range of discounts is possible.
+The new Solidus Promotions Systems ships with three benefit types: `AdjustLineItem`, `AdjustShipment` and `CreateDiscountedItem`. To allow more efficient processing of returns and reduce the complexity for bookkeping and support departmentes fixed discount to all line items in an order can now be given through the `AdjustLineItem` benefit through the `DistributedAmount` calculator significantly reducing amministration issues with refunds. 
 
 #### `AdjustLineItem`
 
@@ -119,4 +122,4 @@ SolidusDevSupport::TestingSupport::Factories.load_for(SolidusPromotions::Engine)
 
 ## License
 
-Copyright (c) 2024 Martin Meyerhoff, Solidus Team, released under the New BSD License.
+Copyright (c) 2024 Martin Meyerhoff, Solidus Team, released under the [license of the parent repository](https://github.com/solidusio/solidus/blob/main/LICENSE.md).

data/app/{decorators/models/solidus_promotions/adjustment_decorator.rb → patches/models/solidus_promotions/adjustment_patch.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPromotions
-  module AdjustmentDecorator
+  module AdjustmentPatch
     def self.prepended(base)
       base.scope :solidus_promotion, -> { where(source_type: "SolidusPromotions::Benefit") }
     end

data/app/{decorators/models/solidus_promotions/line_item_decorator.rb → patches/models/solidus_promotions/line_item_patch.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPromotions
-  module LineItemDecorator
+  module LineItemPatch
     def self.prepended(base)
       base.attr_accessor :quantity_setter
       base.belongs_to :managed_by_order_benefit, class_name: "SolidusPromotions::Benefit", optional: true

data/app/{decorators/models/solidus_promotions/order_decorator.rb → patches/models/solidus_promotions/order_patch.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPromotions
-  module OrderDecorator
+  module OrderPatch
     module ClassMethods
       def allowed_ransackable_associations
         super + ["solidus_promotions", "solidus_order_promotions"]

data/app/{decorators/models/solidus_promotions/order_recalculator_decorator.rb → patches/models/solidus_promotions/order_recalculator_patch.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPromotions
-  module OrderRecalculatorDecorator
+  module OrderRecalculatorPatch
     # This is only needed for stores upgrading from the legacy promotion system.
     # Once we've removed support for the legacy promotion system, we can remove this.
     def recalculate

data/app/{decorators/models/solidus_promotions/shipment_decorator.rb → patches/models/solidus_promotions/shipment_patch.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPromotions
-  module ShipmentDecorator
+  module ShipmentPatch
     Spree::Shipment.prepend SolidusPromotions::DiscountableAmount
 
     def reset_current_discounts

data/app/{decorators/models/solidus_promotions/shipping_rate_decorator.rb → patches/models/solidus_promotions/shipping_rate_patch.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPromotions
-  module ShippingRateDecorator
+  module ShippingRatePatch
     def self.prepended(base)
       base.class_eval do
         has_many :discounts,

data/config/locales/promotion_categories.en.yml

@@ -1,6 +1,13 @@
 en:
+  solidus_admin:
+    promotion_categories:
+      title: "Promotion Categories"
   solidus_promotions:
     promotion_categories:
       title: "Promotion Categories"
+      create:
+        success: "Promotion category was successfully created."
+      update:
+        success: "Promotion category was successfully updated."
       destroy:
-        success: "Promotion Categories were successfully removed."
+        success: "Promotion categories were successfully removed."

data/config/locales/promotions.en.yml

@@ -1,4 +1,7 @@
 en:
+  solidus_admin:
+    promotions:
+      title: "Promotions"
   solidus_promotions:
     promotions:
       title: "Promotions"

data/config/routes.rb

@@ -12,7 +12,7 @@ SolidusPromotions::Engine.routes.draw do
                 }) do
       scope :admin do
         scope :solidus do
-          admin_resources :promotion_categories, only: [:index, :destroy]
+          admin_resources :promotion_categories, except: [:show]
           admin_resources :promotions, only: [:index, :destroy]
         end
       end

data/lib/components/admin/solidus_promotions/promotion_categories/edit/component.html.erb

@@ -0,0 +1,16 @@
+<%= turbo_frame_tag :resource_modal, target: "_top" do %>
+  <%= render component("ui/modal").new(title: t(".title")) do |modal| %>
+    <%= form_for @promotion_category, url: form_url, html: { id: form_id } do |f| %>
+      <div class="flex flex-col gap-6 pb-4">
+        <%= render component("ui/forms/field").text_field(f, :name, class: "required") %>
+        <%= render component("ui/forms/field").text_field(f, :code, class: "required") %>
+      </div>
+      <% modal.with_actions do %>
+        <form method="dialog">
+          <%= render component("ui/button").new(scheme: :secondary, text: t('.cancel')) %>
+        </form>
+        <%= render component("ui/button").new(form: form_id, type: :submit, text: t('.submit')) %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/lib/components/admin/solidus_promotions/promotion_categories/edit/component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class SolidusPromotions::PromotionCategories::Edit::Component < SolidusAdmin::BaseComponent
+  def initialize(record)
+    super
+    @promotion_category = record
+  end
+
+  def form_id
+    dom_id(@promotion_category, "#{stimulus_id}_edit_promotion_category_form")
+  end
+
+  def form_url
+    solidus_promotions.promotion_category_path(@promotion_category, **search_filter_params)
+  end
+end

data/lib/components/admin/solidus_promotions/promotion_categories/edit/component.yml

@@ -0,0 +1,4 @@
+en:
+  title: "Edit Promotion Category"
+  cancel: "Cancel"
+  submit: "Update Promotion Category"

data/lib/components/admin/solidus_promotions/promotion_categories/index/component.rb

@@ -5,15 +5,24 @@ class SolidusPromotions::PromotionCategories::Index::Component < SolidusAdmin::U
     SolidusPromotions::PromotionCategory
   end
 
-  def row_url(promotion_category)
-    solidus_promotions.edit_admin_promotion_category_path(promotion_category)
+  def title
+    t('solidus_promotions.promotion_categories.title')
+  end
+
+  def edit_path(record)
+    solidus_promotions.edit_promotion_category_path(record, **search_filter_params)
+  end
+
+  def turbo_frames
+    %w[resource_modal]
   end
 
   def page_actions
     render component("ui/button").new(
       tag: :a,
       text: t(".add"),
-      href: solidus_promotions.new_admin_promotion_category_path,
+      href: solidus_promotions.new_promotion_category_path(**search_filter_params),
+      data: { turbo_frame: :resource_modal },
       icon: "add-line"
     )
   end
@@ -22,7 +31,7 @@ class SolidusPromotions::PromotionCategories::Index::Component < SolidusAdmin::U
     [
       {
         label: t(".batch_actions.delete"),
-        action: solidus_promotions.promotion_categories_path,
+        action: solidus_promotions.promotion_categories_path(**search_filter_params),
         method: :delete,
         icon: "delete-bin-7-line"
       }
@@ -39,8 +48,10 @@ class SolidusPromotions::PromotionCategories::Index::Component < SolidusAdmin::U
   def name_column
     {
       header: :name,
-      data: ->(promotion_category) do
-        content_tag :div, promotion_category.name
+      data: ->(record) do
+        link_to record.name, edit_path(record),
+          data: { turbo_frame: :resource_modal },
+          class: 'body-link'
       end
     }
   end
@@ -48,8 +59,10 @@ class SolidusPromotions::PromotionCategories::Index::Component < SolidusAdmin::U
   def code_column
     {
       header: :code,
-      data: ->(promotion_category) do
-        content_tag :div, promotion_category.code
+      data: ->(record) do
+        link_to record.code, edit_path(record),
+          data: { turbo_frame: :resource_modal },
+          class: 'body-link'
       end
     }
   end

data/lib/components/admin/solidus_promotions/promotion_categories/new/component.html.erb

@@ -0,0 +1,16 @@
+<%= turbo_frame_tag :resource_modal, target: "_top" do %>
+  <%= render component("ui/modal").new(title: t(".title")) do |modal| %>
+    <%= form_for @promotion_category, url: form_url, html: { id: form_id } do |f| %>
+      <div class="flex flex-col gap-6 pb-4">
+        <%= render component("ui/forms/field").text_field(f, :name, class: "required") %>
+        <%= render component("ui/forms/field").text_field(f, :code, class: "required") %>
+      </div>
+      <% modal.with_actions do %>
+        <form method="dialog">
+          <%= render component("ui/button").new(scheme: :secondary, text: t('.cancel')) %>
+        </form>
+        <%= render component("ui/button").new(form: form_id, type: :submit, text: t('.submit')) %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/lib/components/admin/solidus_promotions/promotion_categories/new/component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class SolidusPromotions::PromotionCategories::New::Component < SolidusAdmin::BaseComponent
+  def initialize(record)
+    super
+    @promotion_category = record
+  end
+
+  def form_id
+    dom_id(@promotion_category, "#{stimulus_id}_new_promotion_category_form")
+  end
+
+  def form_url
+    solidus_promotions.promotion_categories_path(**search_filter_params)
+  end
+end

data/lib/components/admin/solidus_promotions/promotion_categories/new/component.yml

@@ -0,0 +1,4 @@
+en:
+  title: "New Promotion Category"
+  cancel: "Cancel"
+  submit: "Add Promotion Category"

data/lib/controllers/admin/solidus_promotions/promotion_categories_controller.rb

@@ -1,32 +1,40 @@
 # frozen_string_literal: true
 
 module SolidusPromotions
-  class PromotionCategoriesController < SolidusAdmin::BaseController
-    include SolidusAdmin::ControllerHelpers::Search
+  class PromotionCategoriesController < SolidusAdmin::ResourcesController
+    private
+
+    def resource_class = SolidusPromotions::PromotionCategory
 
-    def index
-      promotion_categories = apply_search_to(
-        SolidusPromotions::PromotionCategory.all,
-        param: :q
-      )
+    def permitted_resource_params
+      params.require(:promotion_category).permit(:name, :code)
+    end
 
-      set_page_and_extract_portion_from(promotion_categories)
+    def resources_collection = SolidusPromotions::PromotionCategory.unscoped
 
-      respond_to do |format|
-        format.html { render component("solidus_promotions/categories/index").new(page: @page) }
-      end
+    def index_component
+      component("solidus_promotions/categories/index")
     end
 
-    def destroy
-      @promotion_categories = SolidusPromotions::PromotionCategory.where(id: params[:id])
+    def new_component
+      component("solidus_promotions/categories/new")
+    end
 
-      SolidusPromotions::PromotionCategory.transaction { @promotion_categories.destroy_all }
+    def edit_component
+      component("solidus_promotions/categories/edit")
+    end
 
-      flash[:notice] = t(".success")
-      redirect_back_or_to solidus_promotions.promotion_categories_path, status: :see_other
+    def after_create_path
+      solidus_promotions.promotion_categories_path(**search_filter_params)
     end
 
-    private
+    def after_update_path
+      solidus_promotions.promotion_categories_path(**search_filter_params)
+    end
+
+    def after_destroy_path
+      solidus_promotions.promotion_categories_path(**search_filter_params)
+    end
 
     def authorization_subject
       SolidusPromotions::PromotionCategory

data/lib/controllers/backend/solidus_promotions/admin/benefits_controller.rb

@@ -28,7 +28,7 @@ module SolidusPromotions
         if params.dig(:benefit, :calculator_type)
           @benefit.calculator_type = params[:benefit][:calculator_type]
         end
-        render layout: false, status: :unprocessable_entity
+        render layout: false
       end
 
       def update

data/lib/solidus_promotions/engine.rb

@@ -6,6 +6,7 @@ require "solidus_support"
 module SolidusPromotions
   class Engine < Rails::Engine
     include SolidusSupport::EngineExtensions
+    Flickwerk.aliases["Spree::Config.order_recalculator_class"] = Spree::Config.order_recalculator_class_name
 
     isolate_namespace ::SolidusPromotions
 
@@ -40,10 +41,7 @@ module SolidusPromotions
 
     initializer "solidus_promotions.spree_config", after: "spree.load_config_initializers" do
       Spree::Config.adjustment_promotion_source_types << "SolidusPromotions::Benefit"
-
-      Rails.application.config.to_prepare do
-        Spree::Order.line_item_comparison_hooks << :free_from_order_benefit?
-      end
+      Spree::Config.line_item_comparison_hooks << :free_from_order_benefit?
     end
 
     initializer "solidus_promotions.core.pub_sub", after: "spree.core.pub_sub" do |app|
@@ -60,6 +58,8 @@ module SolidusPromotions
 
         SolidusAdmin::Config.components["solidus_promotions/promotions/index"] = "SolidusPromotions::Promotions::Index::Component"
         SolidusAdmin::Config.components["solidus_promotions/categories/index"] = "SolidusPromotions::PromotionCategories::Index::Component"
+        SolidusAdmin::Config.components["solidus_promotions/categories/new"] = "SolidusPromotions::PromotionCategories::New::Component"
+        SolidusAdmin::Config.components["solidus_promotions/categories/edit"] = "SolidusPromotions::PromotionCategories::Edit::Component"
       end
     end
 

data/solidus_promotions.gemspec

@@ -24,12 +24,11 @@ Gem::Specification.new do |spec|
   files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
   spec.files = files.grep_v(%r{^(spec|bin)/})
 
-  spec.add_development_dependency "solidus_legacy_promotions"
-
+  spec.add_dependency "csv", "~> 3.0"
   spec.add_dependency "importmap-rails", "~> 1.2"
   spec.add_dependency "ransack-enum", "~> 1.0"
   spec.add_dependency "solidus_core", [">= 4.0.0", "< 5"]
-  spec.add_dependency "solidus_support", "~> 0.5"
+  spec.add_dependency "solidus_support", ">= 0.12.0"
   spec.add_dependency "stimulus-rails", "~> 1.2"
   spec.add_dependency "turbo-rails", ">= 1.4"
 end

metadata

@@ -1,30 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solidus_promotions
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.5.0
 platform: ruby
 authors:
 - Martin Meyerhoff
 - Solidus Team
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: solidus_legacy_promotions
+  name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
@@ -77,16 +76,16 @@ dependencies:
   name: solidus_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: stimulus-rails
   requirement: !ruby/object:Gem::Requirement
@@ -127,12 +126,6 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/solidus_promotions/manifest.js
-- app/decorators/models/solidus_promotions/adjustment_decorator.rb
-- app/decorators/models/solidus_promotions/line_item_decorator.rb
-- app/decorators/models/solidus_promotions/order_decorator.rb
-- app/decorators/models/solidus_promotions/order_recalculator_decorator.rb
-- app/decorators/models/solidus_promotions/shipment_decorator.rb
-- app/decorators/models/solidus_promotions/shipping_rate_decorator.rb
 - app/helpers/solidus_promotions/admin/benefits_helper.rb
 - app/helpers/solidus_promotions/admin/conditions_helper.rb
 - app/helpers/solidus_promotions/admin/promotions_helper.rb
@@ -217,6 +210,12 @@ files:
 - app/models/solidus_promotions/promotion_handler/coupon.rb
 - app/models/solidus_promotions/promotion_handler/page.rb
 - app/models/solidus_promotions/shipping_rate_discount.rb
+- app/patches/models/solidus_promotions/adjustment_patch.rb
+- app/patches/models/solidus_promotions/line_item_patch.rb
+- app/patches/models/solidus_promotions/order_patch.rb
+- app/patches/models/solidus_promotions/order_recalculator_patch.rb
+- app/patches/models/solidus_promotions/shipment_patch.rb
+- app/patches/models/solidus_promotions/shipping_rate_patch.rb
 - app/subscribers/solidus_promotions/order_promotion_subscriber.rb
 - config/importmap.rb
 - config/locales/en.yml
@@ -247,7 +246,13 @@ files:
 - lib/components/admin/solidus_admin/orders/show/adjustments/index/source/solidus_promotions_benefit/component.rb
 - lib/components/admin/solidus_promotions/orders/index/component.rb
 - lib/components/admin/solidus_promotions/orders/index/component.yml
+- lib/components/admin/solidus_promotions/promotion_categories/edit/component.html.erb
+- lib/components/admin/solidus_promotions/promotion_categories/edit/component.rb
+- lib/components/admin/solidus_promotions/promotion_categories/edit/component.yml
 - lib/components/admin/solidus_promotions/promotion_categories/index/component.rb
+- lib/components/admin/solidus_promotions/promotion_categories/new/component.html.erb
+- lib/components/admin/solidus_promotions/promotion_categories/new/component.rb
+- lib/components/admin/solidus_promotions/promotion_categories/new/component.yml
 - lib/components/admin/solidus_promotions/promotions/index/component.rb
 - lib/components/admin/solidus_promotions/promotions/index/component.yml
 - lib/controllers/admin/solidus_promotions/promotion_categories_controller.rb
@@ -357,7 +362,6 @@ licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/solidusio/solidus/blob/main/promotions/README.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -372,8 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: New promotion system for Solidus
 test_files: []