solidus_admin 0.4.1 → 0.5.0

data/app/components/solidus_admin/zones/index/component.rb

@@ -5,6 +5,10 @@ class SolidusAdmin::Zones::Index::Component < SolidusAdmin::UI::Pages::Index::Co
     Spree::Zone
   end
 
+  def title
+    t("solidus_admin.zones.title")
+  end
+
   def search_key
     :name_or_description_cont
   end
@@ -13,28 +17,33 @@ class SolidusAdmin::Zones::Index::Component < SolidusAdmin::UI::Pages::Index::Co
     solidus_admin.zones_path
   end
 
-  def row_url(zone)
-    spree.edit_admin_zone_path(zone)
+  def edit_path(zone)
+    solidus_admin.edit_zone_path(zone, **search_filter_params)
+  end
+
+  def turbo_frames
+    %w[resource_form]
   end
 
   def page_actions
     render component("ui/button").new(
       tag: :a,
-      text: t('.add'),
-      href: spree.new_admin_zone_path,
+      text: t(".add"),
+      href: solidus_admin.new_zone_path(**search_filter_params),
+      data: {turbo_frame: :resource_form},
       icon: "add-line",
-      class: "align-self-end w-full",
+      class: "align-self-end w-full"
     )
   end
 
   def batch_actions
     [
       {
-        label: t('.batch_actions.delete'),
+        label: t(".batch_actions.delete"),
         action: solidus_admin.zones_path,
         method: :delete,
-        icon: 'delete-bin-7-line',
-      },
+        icon: "delete-bin-7-line"
+      }
     ]
   end
 
@@ -48,16 +57,46 @@ class SolidusAdmin::Zones::Index::Component < SolidusAdmin::UI::Pages::Index::Co
 
   def columns
     [
-      :name,
-      :description,
-      {
-        header: :kind,
-        data: -> { component('ui/badge').new(name: _1.kind, color: _1.kind == 'country' ? :green : :blue) },
-      },
-      {
-        header: :zone_members,
-        data: -> { _1.zone_members.map(&:zoneable).map(&:name).to_sentence },
-      },
+      name_column,
+      description_column,
+      kind_column,
+      zone_members_column
     ]
   end
+
+  def name_column
+    {
+      header: :name,
+      data: ->(zone) do
+        link_to zone.name, edit_path(zone),
+          data: {turbo_frame: :resource_form},
+          class: "body-link"
+      end
+    }
+  end
+
+  def description_column
+    {
+      header: :description,
+      data: ->(zone) do
+        link_to zone.description, edit_path(zone),
+          data: {turbo_frame: :resource_form},
+          class: "body-link"
+      end
+    }
+  end
+
+  def kind_column
+    {
+      header: :kind,
+      data: -> { component("ui/badge").new(name: _1.kind, color: (_1.kind == "country") ? :green : :blue) }
+    }
+  end
+
+  def zone_members_column
+    {
+      header: :zone_members,
+      data: -> { _1.zone_members.map(&:zoneable).map(&:name).to_sentence }
+    }
+  end
 end

data/app/components/solidus_admin/zones/new/component.html.erb

@@ -0,0 +1 @@
+<%= render component("zones/form").new(zone: @zone, form_url:, form_id:) %>

data/app/components/solidus_admin/zones/new/component.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::Zones::New::Component < SolidusAdmin::Resources::New::Component
+end

data/app/controllers/concerns/solidus_admin/moveable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusAdmin::Moveable
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :load_moveable, only: [:move]
+  end
+
+  def move
+    @moveable.insert_at(params.require(:position).to_i)
+
+    respond_to do |format|
+      format.js { head :no_content }
+    end
+  end
+
+  private
+
+  def load_moveable
+    @moveable = moveable_class.find(params.require(:id))
+    authorize! action_name, @moveable
+  end
+
+  def moveable_class
+    "Spree::#{self.class.name.demodulize.remove("Controller").singularize}".constantize
+  rescue NameError
+    raise NameError,
+      "could not infer model class from #{self.class.name}. Please override `moveable_class` to specify it explicitly."
+  end
+end

data/app/controllers/solidus_admin/addresses_controller.rb

@@ -10,11 +10,11 @@ module SolidusAdmin
     def show
       respond_to do |format|
         format.html do
-          render component('orders/show/address').new(
+          render component("orders/show/address").new(
             order: @order,
             user: @order.user,
             address: @address,
-            type: address_type,
+            type: address_type
           )
         end
       end
@@ -27,7 +27,7 @@ module SolidusAdmin
     def update
       if @order.contents.update_cart(order_params)
         respond_to do |format|
-          flash[:notice] = t('.success')
+          flash[:notice] = t(".success")
 
           format.html { redirect_to order_path(@order), status: :see_other }
           format.turbo_stream { render turbo_stream: '<turbo-stream action="refresh" />' }
@@ -37,11 +37,11 @@ module SolidusAdmin
 
         respond_to do |format|
           format.html do
-            render component('orders/show/address').new(
+            render component("orders/show/address").new(
               order: @order,
               user: @order.user,
               address: @order.send("#{address_type}_address"),
-              type: address_type,
+              type: address_type
             ), status: :unprocessable_entity
           end
         end
@@ -51,13 +51,11 @@ module SolidusAdmin
     private
 
     def load_address
-      if params[:address_id].present? && @order.user
-        @address =
-          @order.user.addresses.find_by(id: params[:address_id]) ||
+      @address = if params[:address_id].present? && @order.user
+        @order.user.addresses.find_by(id: params[:address_id]) ||
           @order.user.addresses.build(country: default_country)
       else
-        @address =
-          @order.public_send("#{address_type}_address") ||
+        @order.public_send("#{address_type}_address") ||
           @order.public_send("build_#{address_type}_address", country: default_country)
       end
     end
@@ -68,7 +66,7 @@ module SolidusAdmin
 
     def validate_address_type
       unless address_type
-        flash[:error] = t('.errors.address_type_invalid')
+        flash[:error] = t(".errors.address_type_invalid")
         redirect_to spree.admin_order_url(@order)
       end
     end

data/app/controllers/solidus_admin/adjustments_controller.rb

@@ -5,13 +5,12 @@ class SolidusAdmin::AdjustmentsController < SolidusAdmin::BaseController
 
   def index
     load_adjustments
-    set_page_and_extract_portion_from(@adjustments)
 
     respond_to do |format|
       format.html do
-        render component('orders/show/adjustments/index').new(
+        render component("orders/show/adjustments/index").new(
           order: @order,
-          adjustments: @adjustments,
+          adjustments: @adjustments
         )
       end
     end
@@ -20,7 +19,7 @@ class SolidusAdmin::AdjustmentsController < SolidusAdmin::BaseController
   def lock
     @adjustments = @order.all_adjustments.not_finalized.where(id: params[:id])
     @adjustments.each(&:finalize!)
-    flash[:success] = t('.success')
+    flash[:notice] = t(".success")
 
     redirect_to order_adjustments_path(@order), status: :see_other
   end
@@ -28,7 +27,7 @@ class SolidusAdmin::AdjustmentsController < SolidusAdmin::BaseController
   def unlock
     @adjustments = @order.all_adjustments.finalized.where(id: params[:id])
     @adjustments.each(&:unfinalize!)
-    flash[:success] = t('.success')
+    flash[:notice] = t(".success")
 
     redirect_to order_adjustments_path(@order), status: :see_other
   end
@@ -36,7 +35,7 @@ class SolidusAdmin::AdjustmentsController < SolidusAdmin::BaseController
   def destroy
     @adjustments = @order.all_adjustments.where(id: params[:id])
     @adjustments.destroy_all
-    flash[:success] = t('.success')
+    flash[:notice] = t(".success")
 
     redirect_to order_adjustments_path(@order), status: :see_other
   end

data/app/controllers/solidus_admin/base_controller.rb

@@ -1,32 +1,33 @@
 # frozen_string_literal: true
 
-require 'geared_pagination'
-
 module SolidusAdmin
   class BaseController < ApplicationController
     include ActiveStorage::SetCurrent
     include Spree::Core::ControllerHelpers::Store
-    include GearedPagination::Controller
 
     include SolidusAdmin::ControllerHelpers::Authentication
     include SolidusAdmin::ControllerHelpers::Authorization
     include SolidusAdmin::ControllerHelpers::Locale
+    include SolidusAdmin::ControllerHelpers::Pagination
     include SolidusAdmin::ControllerHelpers::Theme
     include SolidusAdmin::ComponentsHelper
     include SolidusAdmin::AuthenticationAdapters::Backend if defined?(Spree::Backend)
+    # Guarded so that solidus_admin can be released ahead of solidus_core
+    include Spree::Core::ControllerHelpers::Timezone if defined?(Spree::Core::ControllerHelpers::Timezone)
 
     layout :set_layout
 
-    helper 'solidus_admin/components'
-    helper 'solidus_admin/layout'
+    helper "solidus_admin/components"
+    helper "solidus_admin/layout"
+    helper "solidus_admin/flash"
 
     private
 
     def set_layout
       if turbo_frame_request?
-        'turbo_rails/frame'
+        "turbo_rails/frame"
       else
-        'solidus_admin/application'
+        "solidus_admin/application"
       end
     end
   end

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

@@ -7,7 +7,7 @@ module SolidusAdmin::ControllerHelpers::Authorization
     before_action :authorize_solidus_admin_user!
 
     rescue_from CanCan::AccessDenied do
-      render 'unauthorized', status: :forbidden
+      render "unauthorized", status: :forbidden
     end
   end
 

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

@@ -17,7 +17,7 @@ module SolidusAdmin::ControllerHelpers::Locale
     if requested_locale.to_sym != user_locale
       session[set_user_language_locale_key] = requested_locale
 
-      flash[:notice] = t('spree.locale_changed')
+      flash[:notice] = t("spree.locale_changed")
       redirect_to params.except(:switch_to_locale).permit!.to_h.merge(account_menu_open: true)
     end
   end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  module ControllerHelpers
+    module Pagination
+      DEFAULT_PER_PAGE = 20
+
+      def paginate(records, ordered_by: nil, per_page: DEFAULT_PER_PAGE)
+        records = records.order(with_primary_key_tiebreaker(records, ordered_by)) if ordered_by
+        records.page(params[:page]).per(per_page)
+      end
+
+      def set_pagination_headers(page)
+        response.headers["X-Total-Count"] = page.total_count.to_s
+        response.headers["Link"] = %(<#{page_url(page.next_page)}>; rel="next") if page.next_page
+      end
+
+      private
+
+      def page_url(number)
+        uri = URI.parse(request.url)
+        uri.query = request.query_parameters.merge("page" => number).to_query
+        uri.to_s
+      end
+
+      # Offset pagination needs a unique sort, or rows with equal values (e.g. two
+      # products with the same name) can repeat or go missing across pages.
+      def with_primary_key_tiebreaker(records, ordered_by)
+        ordered_by = ordered_by.to_h.symbolize_keys
+        primary_key = records.klass.primary_key.to_sym
+        return ordered_by if ordered_by.key?(primary_key)
+
+        ordered_by.merge(primary_key => ordered_by.values.last)
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module SolidusAdmin::ControllerHelpers::Search
       search_scopes << SearchScope.new(
         name: name.to_s,
         block:,
-        default:,
+        default:
       )
     end
 
@@ -19,15 +19,15 @@ module SolidusAdmin::ControllerHelpers::Search
 
   private
 
-  def apply_search_to(relation, param:)
+  def apply_search_to(relation, param:, distinct: true)
     relation = apply_scopes_to(relation, param:)
-    apply_ransack_search_to(relation, param:)
+    apply_ransack_search_to(relation, param:, distinct:)
   end
 
-  def apply_ransack_search_to(relation, param:)
+  def apply_ransack_search_to(relation, param:, distinct: true)
     relation
       .ransack(params[param]&.except(:scope))
-      .result(distinct: true)
+      .result(distinct:)
   end
 
   def apply_scopes_to(relation, param:)

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

@@ -13,13 +13,13 @@ module SolidusAdmin::ControllerHelpers::Theme
     requested_theme = params[:switch_to_theme].presence or return
 
     # Avoid interpolating user content into the session key
-    system_theme = params[:system_theme].presence == "dark" ? "dark" : "light"
+    system_theme = (params[:system_theme].presence == "dark") ? "dark" : "light"
     session_key = :"admin_#{system_theme}_theme"
 
     if theme_is_available?(requested_theme) && requested_theme.to_sym != session[session_key]
       session[session_key] = requested_theme
 
-      flash[:notice] = t('spree.theme_changed')
+      flash[:notice] = t("spree.theme_changed")
       redirect_to params.except(:switch_to_theme, :system_theme).permit!.to_h.merge(account_menu_open: true)
     end
   end

data/app/controllers/solidus_admin/customers_controller.rb

@@ -6,16 +6,16 @@ class SolidusAdmin::CustomersController < SolidusAdmin::BaseController
   def show
     respond_to do |format|
       format.html do
-        render component('orders/show/email').new(order: @order)
+        render component("orders/show/email").new(order: @order)
       end
     end
   end
 
   def destroy
     if @order.update(user: nil)
-      flash[:success] = t('.success')
+      flash[:notice] = t(".success")
     else
-      flash[:error] = t('.error')
+      flash[:error] = t(".error")
     end
 
     redirect_to order_path(@order), status: :see_other

data/app/controllers/solidus_admin/line_items_controller.rb

@@ -8,7 +8,7 @@ module SolidusAdmin
 
       @line_item.destroy!
 
-      redirect_to order_path(@order), status: :see_other, notice: t('.success')
+      redirect_to order_path(@order), status: :see_other, notice: t(".success")
     end
 
     def create
@@ -17,7 +17,7 @@ module SolidusAdmin
       @variant = Spree::Variant.find(variant_id)
       @line_item = @order.contents.add(@variant)
 
-      redirect_to order_path(@order), status: :see_other, notice: t('.success')
+      redirect_to order_path(@order), status: :see_other, notice: t(".success")
     end
 
     def update
@@ -28,7 +28,7 @@ module SolidusAdmin
 
       @line_item = @order.contents.add(@line_item.variant, desired_quantity - @line_item.quantity)
 
-      redirect_to order_path(@order), status: :see_other, notice: t('.success')
+      redirect_to order_path(@order), status: :see_other, notice: t(".success")
     end
 
     private

data/app/controllers/solidus_admin/option_types_controller.rb

@@ -1,46 +1,25 @@
 # frozen_string_literal: true
 
 module SolidusAdmin
-  class OptionTypesController < SolidusAdmin::BaseController
-    include SolidusAdmin::ControllerHelpers::Search
+  class OptionTypesController < SolidusAdmin::ResourcesController
+    include SolidusAdmin::Moveable
 
-    before_action :load_option_type, only: [:move]
-
-    def index
-      option_types = apply_search_to(
-        Spree::OptionType.all,
-        param: :q,
-      )
-
-      set_page_and_extract_portion_from(option_types)
-
-      respond_to do |format|
-        format.html { render component('option_types/index').new(page: @page) }
-      end
-    end
-
-    def move
-      @option_type.insert_at(params[:position].to_i)
+    private
 
-      respond_to do |format|
-        format.js { head :no_content }
-      end
+    def after_create_path
+      solidus_admin.edit_option_type_path(@resource)
     end
 
-    def destroy
-      @option_types = Spree::OptionType.where(id: params[:id])
+    def resource_class = Spree::OptionType
 
-      Spree::OptionType.transaction { @option_types.destroy_all }
-
-      flash[:notice] = t('.success')
-      redirect_back_or_to option_types_path, status: :see_other
+    def permitted_resource_params
+      params.require(:option_type).permit(:name, :presentation)
     end
 
-    private
+    def resources_collection = Spree::OptionType.unscoped
 
-    def load_option_type
-      @option_type = Spree::OptionType.find(params[:id])
-      authorize! action_name, @option_type
+    def resources_sorting_options
+      {position: :asc}
     end
   end
 end

data/app/controllers/solidus_admin/option_values_controller.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  class OptionValuesController < SolidusAdmin::ResourcesController
+    include SolidusAdmin::Moveable
+
+    before_action :set_option_type, only: [:new, :create, :destroy]
+
+    def new
+      @resource = @option_type.option_values.build
+      super
+    end
+
+    def create
+      @resource = @option_type.option_values.build(permitted_resource_params)
+      super
+    end
+
+    private
+
+    def prefer_turbo_stream?
+      case params[:action]
+      when "create", "update", "destroy" then true
+      else false
+      end
+    end
+
+    def resource_class = Spree::OptionValue
+
+    def permitted_resource_params
+      params.require(:option_value).permit(:name, :presentation)
+    end
+
+    def resource_form_frame
+      :option_value_modal
+    end
+
+    def after_create_path
+      solidus_admin.edit_option_type_path(@option_type)
+    end
+
+    def after_update_path
+      solidus_admin.edit_option_type_path(@option_value.option_type)
+    end
+
+    def after_destroy_path
+      solidus_admin.edit_option_type_path(@option_type)
+    end
+
+    def set_option_type
+      @option_type = Spree::OptionType.find(params[:option_type_id])
+    end
+  end
+end

data/app/controllers/solidus_admin/orders_controller.rb

@@ -5,22 +5,23 @@ module SolidusAdmin
     include Spree::Core::ControllerHelpers::StrongParameters
     include SolidusAdmin::ControllerHelpers::Search
 
-    search_scope(:completed, default: true) { _1.complete }
-    search_scope(:canceled) { _1.canceled }
-    search_scope(:returned) { _1.with_state(:returned) }
-    search_scope(:in_progress) { _1.with_state([:cart] + _1.checkout_step_names) }
-    search_scope(:all) { _1 }
+    search_scope(:completed, default: true) { _1.complete.order(completed_at: :desc) }
+    search_scope(:canceled) { _1.canceled.order(completed_at: :desc) }
+    search_scope(:returned) { _1.with_state(:returned).order(completed_at: :desc) }
+    search_scope(:in_progress) { _1.with_state([:cart] + _1.checkout_step_names).order(id: :desc) }
+    search_scope(:all) { _1.order(id: :desc) }
 
     def index
       orders = apply_search_to(
-        Spree::Order.order(created_at: :desc, id: :desc),
+        Spree::Order.includes(:line_items),
         param: :q,
+        distinct: false
       )
 
-      set_page_and_extract_portion_from(orders)
+      @page = paginate(orders)
 
       respond_to do |format|
-        format.html { render component('orders/index').new(page: @page) }
+        format.html { render component("orders/index").new(page: @page) }
       end
     end
 
@@ -35,23 +36,27 @@ module SolidusAdmin
     end
 
     def show
-      load_order
+      load_order(Spree::Order.includes(line_items: {variant: [:images, {product: :variant_images, option_values: :option_type}]}))
 
       respond_to do |format|
-        format.html { render component('orders/show').new(order: @order) }
+        format.html { render component("orders/show").new(order: @order) }
       end
     end
 
     def update
       load_order
 
+      if order_params[:user_id].present? && order_params[:user_id].to_s != @order.user_id.to_s
+        Spree.user_class.accessible_by(current_ability, :show).find(order_params[:user_id])
+      end
+
       @order.assign_attributes(order_params)
-      @order.email ||= @order.user.email if @order.user && @order.user.changed?
+      @order.email ||= @order.user.email if @order.user&.changed?
 
       if @order.save
-        flash[:notice] = t('.success')
+        flash[:notice] = t(".success")
       else
-        flash[:error] = t('.error')
+        flash[:error] = t(".error")
       end
 
       respond_to do |format|
@@ -71,7 +76,7 @@ module SolidusAdmin
       # We need to eager load active storage attachments when using it
       if Spree::Image.include?(Spree::Image::ActiveStorageAttachment)
         image_includes = {
-          attachment_attachment: { blob: { variant_records: { image_attachment: :blob } } }
+          attachment_attachment: {blob: {variant_records: {image_attachment: :blob}}}
         }
       end
 
@@ -84,11 +89,11 @@ module SolidusAdmin
           :prices,
           images: image_includes || {},
           option_values: :option_type,
-          stock_items: :stock_location,
+          stock_items: :stock_location
         )
 
       respond_to do |format|
-        format.html { render component('orders/cart/result').with_collection(@variants, order: @order), layout: false }
+        format.html { render component("orders/cart/result").with_collection(@variants, order: @order), layout: false }
       end
     end
 
@@ -96,6 +101,7 @@ module SolidusAdmin
       load_order
 
       @users = Spree.user_class
+        .accessible_by(current_ability, :show)
         .where.not(id: @order.user_id)
         .order(created_at: :desc, id: :desc)
         .ransack(params[:q])
@@ -104,14 +110,14 @@ module SolidusAdmin
         .limit(10)
 
       respond_to do |format|
-        format.html { render component('orders/show/customer_search/result').with_collection(@users, order: @order), layout: false }
+        format.html { render component("orders/show/customer_search/result").with_collection(@users, order: @order), layout: false }
       end
     end
 
     private
 
-    def load_order
-      @order = Spree::Order.find_by!(number: params[:id])
+    def load_order(scope = Spree::Order)
+      @order = scope.find_by!(number: params[:id])
       authorize! action_name, @order
     end