solidus_admin 0.3.1 → 0.4.0

data/app/components/solidus_admin/users/store_credits/show/component.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::Users::StoreCredits::Show::Component < SolidusAdmin::BaseComponent
+  include SolidusAdmin::Layout::PageHelpers
+  include Spree::Admin::StoreCreditEventsHelper
+
+  def initialize(user:, store_credit:, events:)
+    @user = user
+    @store_credit = store_credit
+    @events = events
+  end
+
+  def model_class
+    Spree::StoreCredit
+  end
+
+  def event_model_class
+    Spree::StoreCreditEvent
+  end
+
+  def tabs
+    [
+      {
+        text: t('.account'),
+        href: solidus_admin.user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.addresses'),
+        href: solidus_admin.addresses_user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.order_history'),
+        href: solidus_admin.orders_user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.items'),
+        href: spree.items_admin_user_path(@user),
+        current: false,
+      },
+      {
+        text: t('.store_credit'),
+        href: solidus_admin.user_store_credits_path(@user),
+        current: true,
+      },
+    ]
+  end
+
+  def form_id
+    @form_id ||= "#{stimulus_id}--form-#{@store_credit.id}"
+  end
+
+  def edit_validity_url
+    solidus_admin.edit_validity_user_store_credit_path(@user, @store_credit, **search_filter_params)
+  end
+
+  def edit_memo_url
+    solidus_admin.edit_memo_user_store_credit_path(@user, @store_credit, **search_filter_params)
+  end
+
+  def edit_amount_url
+    solidus_admin.edit_amount_user_store_credit_path(@user, @store_credit, **search_filter_params)
+  end
+
+  def columns
+    [
+      {
+        header: :date,
+        col: { class: "w-[15%]" },
+        data: ->(event) do
+          content_tag :span, I18n.l(event.created_at, format: :short), class: "text-sm"
+        end
+      },
+      {
+        header: :action,
+        col: { class: "w-[10%]" },
+        data: ->(event) do
+          content_tag :span, store_credit_event_admin_action_name(event), class: "text-sm"
+        end
+      },
+      {
+        header: :credited,
+        col: { class: "w-[10%]" },
+        data: ->(event) do
+          content_tag :span, event.display_amount, class: "text-sm"
+        end
+      },
+      {
+        header: :created_by,
+        col: { class: "w-[20%]" },
+        data: ->(event) do
+          content_tag :span, store_credit_event_originator_link(event), class: "body-link text-sm"
+        end
+      },
+      {
+        header: :total_amount,
+        col: { class: "w-[10%]" },
+        data: ->(event) do
+          content_tag :span, event.display_user_total_amount, class: "text-sm"
+        end
+      },
+      {
+        header: :total_unused,
+        col: { class: "w-[10%]" },
+        data: ->(event) do
+          content_tag :span, event.display_remaining_amount, class: "text-sm"
+        end
+      },
+      {
+        header: :reason_for_updating,
+        col: { class: "w-[25%]" },
+        data: ->(event) do
+          content_tag :span, event.store_credit_reason&.name, class: "text-sm"
+        end
+      },
+    ]
+  end
+end

data/app/components/solidus_admin/users/store_credits/show/component.yml

@@ -0,0 +1,18 @@
+en:
+  title: "Users / %{email} / Store Credit / %{amount}"
+  account: Account
+  addresses: Addresses
+  order_history: Order History
+  items: Items
+  store_credit: Store Credit
+  last_active: Last Active
+  add_store_credit: Add Store Credit
+  edit_amount: Edit Amount
+  edit_memo: Edit Memo
+  invalidate: Invalidate
+  store_credit_history: Store Credit History
+  credited: Credited
+  created_by: Created By
+  type: Type
+  memo: Memo
+  back: Back

data/app/controllers/solidus_admin/adjustment_reasons_controller.rb

@@ -1,115 +1,13 @@
 # frozen_string_literal: true
 
 module SolidusAdmin
-  class AdjustmentReasonsController < SolidusAdmin::BaseController
-    include SolidusAdmin::ControllerHelpers::Search
-
-    before_action :set_adjustment_reason, only: %i[edit update]
-
-    def index
-      set_index_page
-
-      respond_to do |format|
-        format.html { render component('adjustment_reasons/index').new(page: @page) }
-      end
-    end
-
-    def new
-      @adjustment_reason = Spree::AdjustmentReason.new
-
-      set_index_page
-
-      respond_to do |format|
-        format.html { render component('adjustment_reasons/new').new(page: @page, adjustment_reason: @adjustment_reason) }
-      end
-    end
-
-    def create
-      @adjustment_reason = Spree::AdjustmentReason.new(adjustment_reason_params)
-
-      if @adjustment_reason.save
-        respond_to do |format|
-          flash[:notice] = t('.success')
-
-          format.html do
-            redirect_to solidus_admin.adjustment_reasons_path, status: :see_other
-          end
-
-          format.turbo_stream do
-            render turbo_stream: '<turbo-stream action="refresh" />'
-          end
-        end
-      else
-        set_index_page
-
-        respond_to do |format|
-          format.html do
-            page_component = component('adjustment_reasons/new').new(page: @page, adjustment_reason: @adjustment_reason)
-            render page_component, status: :unprocessable_entity
-          end
-        end
-      end
-    end
-
-    def edit
-      set_index_page
-
-      respond_to do |format|
-        format.html { render component('adjustment_reasons/edit').new(page: @page, adjustment_reason: @adjustment_reason) }
-      end
-    end
-
-    def update
-      if @adjustment_reason.update(adjustment_reason_params)
-        respond_to do |format|
-          flash[:notice] = t('.success')
-
-          format.html do
-            redirect_to solidus_admin.adjustment_reasons_path, status: :see_other
-          end
-
-          format.turbo_stream do
-            render turbo_stream: '<turbo-stream action="refresh" />'
-          end
-        end
-      else
-        set_index_page
-
-        respond_to do |format|
-          format.html do
-            page_component = component('adjustment_reasons/edit').new(page: @page, adjustment_reason: @adjustment_reason)
-            render page_component, status: :unprocessable_entity
-          end
-        end
-      end
-    end
-
-    def destroy
-      @adjustment_reason = Spree::AdjustmentReason.find_by!(id: params[:id])
-
-      Spree::AdjustmentReason.transaction { @adjustment_reason.destroy }
-
-      flash[:notice] = t('.success')
-      redirect_back_or_to adjustment_reasons_path, status: :see_other
-    end
-
+  class AdjustmentReasonsController < SolidusAdmin::ResourcesController
     private
 
-    def set_adjustment_reason
-      @adjustment_reason = Spree::AdjustmentReason.find(params[:id])
-    end
+    def resource_class = Spree::AdjustmentReason
 
-    def adjustment_reason_params
+    def permitted_resource_params
       params.require(:adjustment_reason).permit(:name, :code, :active)
     end
-
-    def set_index_page
-      adjustment_reasons = apply_search_to(
-        Spree::AdjustmentReason.order(id: :desc),
-        param: :q,
-      )
-
-      set_page_and_extract_portion_from(adjustment_reasons)
-    end
   end
 end

data/app/controllers/solidus_admin/authentication_adapters/backend.rb

@@ -13,7 +13,7 @@ module SolidusAdmin::AuthenticationAdapters::Backend
   def authenticate_solidus_backend_user!
     return if spree_current_user
 
-    instance_exec(&Spree::Admin::BaseController.unauthorized_redirect)
+    Spree::Backend::Config.unauthorized_redirect_handler_class.new(self).call
   end
 
   def store_location

data/app/controllers/solidus_admin/base_controller.rb

@@ -15,8 +15,19 @@ module SolidusAdmin
     include SolidusAdmin::ComponentsHelper
     include SolidusAdmin::AuthenticationAdapters::Backend if defined?(Spree::Backend)
 
-    layout 'solidus_admin/application'
+    layout :set_layout
+
     helper 'solidus_admin/components'
     helper 'solidus_admin/layout'
+
+    private
+
+    def set_layout
+      if turbo_frame_request?
+        'turbo_rails/frame'
+      else
+        'solidus_admin/application'
+      end
+    end
   end
 end

data/app/controllers/solidus_admin/controller_helpers/search.rb

@@ -7,8 +7,8 @@ module SolidusAdmin::ControllerHelpers::Search
     def search_scope(name, default: false, &block)
       search_scopes << SearchScope.new(
         name: name.to_s,
-        block: block,
-        default: default,
+        block:,
+        default:,
       )
     end
 
@@ -20,8 +20,8 @@ module SolidusAdmin::ControllerHelpers::Search
   private
 
   def apply_search_to(relation, param:)
-    relation = apply_scopes_to(relation, param: param)
-    apply_ransack_search_to(relation, param: param)
+    relation = apply_scopes_to(relation, param:)
+    apply_ransack_search_to(relation, param:)
   end
 
   def apply_ransack_search_to(relation, param:)

data/app/controllers/solidus_admin/properties_controller.rb

@@ -1,33 +1,15 @@
 # frozen_string_literal: true
 
 module SolidusAdmin
-  class PropertiesController < SolidusAdmin::BaseController
-    include SolidusAdmin::ControllerHelpers::Search
+  class PropertiesController < SolidusAdmin::ResourcesController
+    private
 
-    def index
-      properties = apply_search_to(
-        Spree::Property.order(created_at: :desc, id: :desc),
-        param: :q,
-      )
+    def resource_class = Spree::Property
 
-      set_page_and_extract_portion_from(
-        properties,
-      )
-
-      respond_to do |format|
-        format.html { render component('properties/index').new(page: @page) }
-      end
+    def permitted_resource_params
+      params.require(:property).permit(:name, :presentation)
     end
 
-    def destroy
-      @properties = Spree::Property.where(id: params[:id])
-
-      Spree::Property.transaction do
-        @properties.destroy_all
-      end
-
-      flash[:notice] = t('.success')
-      redirect_to properties_path, status: :see_other
-    end
+    def resources_collection = Spree::Property.unscoped
   end
 end

data/app/controllers/solidus_admin/refund_reasons_controller.rb

@@ -1,115 +1,15 @@
 # frozen_string_literal: true
 
 module SolidusAdmin
-  class RefundReasonsController < SolidusAdmin::BaseController
-    include SolidusAdmin::ControllerHelpers::Search
-
-    before_action :set_refund_reason, only: %i[edit update]
-
-    def index
-      set_index_page
-
-      respond_to do |format|
-        format.html { render component('refund_reasons/index').new(page: @page) }
-      end
-    end
-
-    def new
-      @refund_reason = Spree::RefundReason.new
-
-      set_index_page
-
-      respond_to do |format|
-        format.html { render component('refund_reasons/new').new(page: @page, refund_reason: @refund_reason) }
-      end
-    end
-
-    def create
-      @refund_reason = Spree::RefundReason.new(refund_reason_params)
-
-      if @refund_reason.save
-        respond_to do |format|
-          flash[:notice] = t('.success')
-
-          format.html do
-            redirect_to solidus_admin.refund_reasons_path, status: :see_other
-          end
-
-          format.turbo_stream do
-            render turbo_stream: '<turbo-stream action="refresh" />'
-          end
-        end
-      else
-        set_index_page
-
-        respond_to do |format|
-          format.html do
-            page_component = component('refund_reasons/new').new(page: @page, refund_reason: @refund_reason)
-            render page_component, status: :unprocessable_entity
-          end
-        end
-      end
-    end
-
-    def edit
-      set_index_page
-
-      respond_to do |format|
-        format.html { render component('refund_reasons/edit').new(page: @page, refund_reason: @refund_reason) }
-      end
-    end
-
-    def update
-      if @refund_reason.update(refund_reason_params)
-        respond_to do |format|
-          flash[:notice] = t('.success')
-
-          format.html do
-            redirect_to solidus_admin.refund_reasons_path, status: :see_other
-          end
-
-          format.turbo_stream do
-            render turbo_stream: '<turbo-stream action="refresh" />'
-          end
-        end
-      else
-        set_index_page
-
-        respond_to do |format|
-          format.html do
-            page_component = component('refund_reasons/edit').new(page: @page, refund_reason: @refund_reason)
-            render page_component, status: :unprocessable_entity
-          end
-        end
-      end
-    end
-
-    def destroy
-      @refund_reason = Spree::RefundReason.find_by!(id: params[:id])
-
-      Spree::RefundReason.transaction { @refund_reason.destroy }
-
-      flash[:notice] = t('.success')
-      redirect_back_or_to refund_reasons_path, status: :see_other
-    end
-
+  class RefundReasonsController < SolidusAdmin::ResourcesController
     private
 
-    def set_refund_reason
-      @refund_reason = Spree::RefundReason.find(params[:id])
-    end
-
-    def refund_reason_params
-      params.require(:refund_reason).permit(:name, :code, :active)
-    end
+    def resource_class = Spree::RefundReason
 
-    def set_index_page
-      refund_reasons = apply_search_to(
-        Spree::RefundReason.unscoped.order(id: :desc),
-        param: :q,
-      )
+    def resources_collection = Spree::RefundReason.unscoped
 
-      set_page_and_extract_portion_from(refund_reasons)
+    def permitted_resource_params
+      params.require(:refund_reason).permit(:name, :code, :active)
     end
   end
 end

data/app/controllers/solidus_admin/resources_controller.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  class ResourcesController < SolidusAdmin::BaseController
+    include SolidusAdmin::ControllerHelpers::Search
+
+    helper_method :search_filter_params
+
+    before_action :set_paginated_resources, only: %i[index]
+    before_action :set_resource, only: %i[edit update]
+
+    # GET /index
+    #
+    # Uses {set_paginated_resources} to set @resources
+    # and a instance variable with the plural name of the resource.
+    #
+    # Uses the geared_pagination gem to set @page for pagination.
+    #
+    # @see set_paginated_resources
+    # @see resources_collection
+    def index
+      respond_to do |format|
+        format.html { render index_component.new(page: @page) }
+      end
+    end
+
+    def new
+      @resource = resource_class.new
+      render new_component.new(@resource)
+    end
+
+    def create
+      @resource = resource_class.new(permitted_resource_params)
+
+      if @resource.save
+        flash[:notice] = t('.success')
+        redirect_to after_create_path, status: :see_other
+      else
+        page_component = new_component.new(@resource)
+        render_resource_form_with_errors(page_component)
+      end
+    end
+
+    def edit
+      render edit_component.new(@resource)
+    end
+
+    def update
+      if @resource.update(permitted_resource_params)
+        flash[:notice] = t('.success')
+        redirect_to after_update_path, status: :see_other
+      else
+        page_component = edit_component.new(@resource)
+        render_resource_form_with_errors(page_component)
+      end
+    end
+
+    def destroy
+      @resource = resource_class.where(id: params[:id])
+
+      resource_class.transaction { @resource.destroy_all }
+
+      flash[:notice] = t('.success')
+      redirect_back_or_to after_destroy_path, status: :see_other
+    end
+
+    private
+
+    def search_filter_params
+      request.params.slice(:q, :page)
+    end
+
+    def set_paginated_resources
+      @resources ||= apply_search_to(
+        resources_collection,
+          param: :q,
+        ).tap do |resources|
+          instance_variable_set("@#{plural_resource_name}", resources)
+          # sets @page instance variable in geared_pagination gem
+          set_page_and_extract_portion_from(resources, ordered_by: resources_sorting_options)
+        end
+    end
+
+    def resources_sorting_options
+      { id: :desc }
+    end
+
+    def resources_collection
+      resource_class.all
+    end
+
+    def set_resource
+      @resource ||= resource_class.find(params[:id]).tap do |resource|
+          instance_variable_set("@#{resource_name}", resource)
+      end
+    end
+
+    def resource_class
+      raise NotImplementedError,
+        "You must implement the resource_class method in #{self.class}"
+    end
+
+    def resource_name
+      resource_class.model_name.singular_route_key
+    end
+
+    def plural_resource_name
+      resource_class.model_name.route_key
+    end
+
+    def index_component
+      component("#{plural_resource_name}/index")
+    end
+
+    def new_component
+      component("#{plural_resource_name}/new")
+    end
+
+    def edit_component
+      component("#{plural_resource_name}/edit")
+    end
+
+    def render_resource_form_with_errors(page_component)
+      respond_to do |format|
+        format.html do
+          render page_component, status: :unprocessable_entity
+        end
+        format.turbo_stream do
+          render turbo_stream: turbo_stream.replace(:resource_modal, page_component),
+            status: :unprocessable_entity
+        end
+      end
+    end
+
+    def permitted_resource_params
+      raise NotImplementedError,
+        "You must implement the permitted_resource_params method in #{self.class}"
+    end
+
+    def after_create_path
+      solidus_admin.send("#{plural_resource_name}_path", **search_filter_params)
+    end
+
+    def after_update_path
+      solidus_admin.send("#{plural_resource_name}_path", **search_filter_params)
+    end
+
+    def after_destroy_path
+      solidus_admin.send("#{plural_resource_name}_path", **search_filter_params)
+    end
+  end
+end