Use modal UI for solidus_promotions index/add/edit

chaimann · chaimann · commit c9791caf8e9d · 2025-02-11T10:12:36.000+01:00
Introduces changes to new solidus promotions UI based on solidusio#6046. Had to override few methods in controller and components due to differences in routing and naming in solidus_promotions. Copied capybara driver setup from legacy_promotions.
diff --git a/bin/rspec b/bin/rspec
@@ -9,6 +9,7 @@ LIBS = %w[
   core
   sample
   legacy_promotions
+  promotions
 ]
 
 # Ignore line info, e.g. foo/bar.rb:123 would become foo/bar.rb
diff --git a/promotions/MIGRATING.md b/promotions/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
 
diff --git a/promotions/config/locales/promotion_categories.en.yml b/promotions/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."
diff --git a/promotions/config/locales/promotions.en.yml b/promotions/config/locales/promotions.en.yml
@@ -1,4 +1,7 @@
 en:
+  solidus_admin:
+    promotions:
+      title: "Promotions"
   solidus_promotions:
     promotions:
       title: "Promotions"
diff --git a/promotions/config/routes.rb b/promotions/config/routes.rb
@@ -12,7 +12,7 @@
                 }) 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
diff --git a/promotions/lib/components/admin/solidus_promotions/promotion_categories/edit/component.html.erb b/promotions/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 %>
diff --git a/promotions/lib/components/admin/solidus_promotions/promotion_categories/edit/component.rb b/promotions/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
diff --git a/promotions/lib/components/admin/solidus_promotions/promotion_categories/edit/component.yml b/promotions/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"
diff --git a/promotions/lib/components/admin/solidus_promotions/promotion_categories/index/component.rb b/promotions/lib/components/admin/solidus_promotions/promotion_categories/index/component.rb
@@ -5,15 +5,24 @@ def model_class
     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 @@ def batch_actions
     [
       {
         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,17 +48,21 @@ def columns
   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
 
   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
diff --git a/promotions/lib/components/admin/solidus_promotions/promotion_categories/new/component.html.erb b/promotions/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 %>
diff --git a/promotions/lib/components/admin/solidus_promotions/promotion_categories/new/component.rb b/promotions/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
diff --git a/promotions/lib/components/admin/solidus_promotions/promotion_categories/new/component.yml b/promotions/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"
diff --git a/promotions/lib/controllers/admin/solidus_promotions/promotion_categories_controller.rb b/promotions/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
diff --git a/promotions/lib/solidus_promotions/engine.rb b/promotions/lib/solidus_promotions/engine.rb
@@ -60,6 +60,8 @@ class Engine < Rails::Engine
 
         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
 
diff --git a/promotions/spec/rails_helper.rb b/promotions/spec/rails_helper.rb
@@ -74,6 +74,26 @@
 Spree::Config.order_contents_class = "Spree::SimpleOrderContents"
 Spree::Config.promotions = SolidusPromotions.configuration
 ActiveJob::Base.queue_adapter = :test
+
+Capybara.register_driver :selenium_chrome_headless do |app|
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new
+  browser_options.args << '--headless'
+  browser_options.args << '--disable-gpu'
+  browser_options.args << '--window-size=1920,1080'
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end
+
+Capybara.register_driver :selenium_chrome_headless_docker_friendly do |app|
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new
+  browser_options.args << '--headless'
+  browser_options.args << '--disable-gpu'
+  # Sandbox cannot be used inside unprivileged Docker container
+  browser_options.args << '--no-sandbox'
+  browser_options.args << '--window-size=1240,1400'
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end
+
+Capybara.javascript_driver = (ENV['CAPYBARA_DRIVER'] || :selenium_chrome_headless).to_sym
 # Allow Capybara to find elements by aria-label attributes
 Capybara.enable_aria_label = true
 
@@ -85,11 +105,12 @@
   config.include FactoryBot::Syntax::Methods
   config.include Shoulda::Matchers::ActiveRecord, type: :model
 
-  config.around :each, :solidus_admin, :js do |example|
+  config.around :each, :solidus_admin do |example|
     SolidusPromotions.config.use_new_admin = true
     example.run
     SolidusPromotions.config.use_new_admin = false
   end
+
   config.include SolidusAdmin::TestingSupport::FeatureHelpers, type: :feature, solidus_admin: true
 end
 
diff --git a/promotions/spec/requests/solidus_promotions/admin/promotion_categories_spec.rb b/promotions/spec/requests/solidus_promotions/admin/promotion_categories_spec.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'solidus_admin/testing_support/shared_examples/promotion_categories_requests'
+
+RSpec.describe 'SolidusPromotions::PromotionCategoriesController', :solidus_admin, type: :request do
+  include_examples 'promotion categories requests' do
+    let(:promotion_category) { create(:solidus_promotion_category) }
+    let(:url_helpers) { solidus_promotions }
+    let(:model_class) { SolidusPromotions::PromotionCategory }
+  end
+end
diff --git a/promotions/spec/system/solidus_promotions/admin/promotion_categories_spec.rb b/promotions/spec/system/solidus_promotions/admin/promotion_categories_spec.rb
@@ -1,24 +1,12 @@
 # frozen_string_literal: true
 
-require "rails_helper"
+require 'rails_helper'
+require 'solidus_admin/testing_support/shared_examples/promotion_categories_features'
 
 RSpec.describe "Promotion Categories", :js, type: :feature, solidus_admin: true do
-  before { sign_in create(:admin_user, email: "admin@example.com") }
-
-  it "lists promotion categories and allows deleting them" do
-    create(:solidus_promotion_category, name: "test1", code: "code1")
-    create(:solidus_promotion_category, name: "test2", code: "code2")
-
-    visit "/admin/solidus/promotion_categories"
-    expect(page).to have_content("test1")
-    expect(page).to have_content("test2")
-
-    expect(page).to be_axe_clean
-
-    select_row("test1")
-    click_on "Delete"
-    expect(page).to have_content("Promotion Categories were successfully removed.")
-    expect(page).not_to have_content("test1")
-    expect(SolidusPromotions::PromotionCategory.count).to eq(1)
+  include_examples 'promotion categories features' do
+    let(:factory_name) { :solidus_promotion_category }
+    let(:model_class) { SolidusPromotions::PromotionCategory }
+    let(:index_path) { "/admin/solidus/promotion_categories" }
   end
 end
diff --git a/promotions/spec/system/solidus_promotions/backend/promotion_categories_spec.rb b/promotions/spec/system/solidus_promotions/backend/promotion_categories_spec.rb
@@ -2,7 +2,7 @@
 
 require "rails_helper"
 
-RSpec.describe "Promotion Categories", type: :system do
+RSpec.feature "Promotion Categories" do
   stub_authorization!
 
   context "index" do
diff --git a/promotions/spec/system/solidus_promotions/backend/promotions_spec.rb b/promotions/spec/system/solidus_promotions/backend/promotions_spec.rb
@@ -2,7 +2,7 @@
 
 require "rails_helper"
 
-RSpec.describe "Promotions admin", type: :system do
+RSpec.feature "Promotions admin" do
   stub_authorization!
 
   describe "#index" do

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ LIBS = %w[`
`9`	`9`	`core`
`10`	`10`	`sample`
`11`	`11`	`legacy_promotions`
	`12`	`+ promotions`
`12`	`13`	`]`
`13`	`14`
`14`	`15`	`# Ignore line info, e.g. foo/bar.rb:123 would become foo/bar.rb`