solidus_admin 0.4.0 → 0.5.0

data/app/controllers/solidus_admin/payment_methods_controller.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 module SolidusAdmin
-  class PaymentMethodsController < SolidusAdmin::BaseController
-    include SolidusAdmin::ControllerHelpers::Search
+  class PaymentMethodsController < SolidusAdmin::ResourcesController
+    include SolidusAdmin::Moveable
 
-    before_action :load_payment_method, only: [:move]
+    before_action :initialize_resource, only: [:new]
+    before_action :validate_type, only: [:create, :update]
 
     search_scope(:all)
     search_scope(:active, default: true, &:active)
@@ -12,41 +13,35 @@ module SolidusAdmin
     search_scope(:storefront, &:available_to_users)
     search_scope(:admin, &:available_to_admin)
 
-    def index
-      payment_methods = apply_search_to(
-        Spree::PaymentMethod.ordered_by_position,
-        param: :q,
-      )
+    private
 
-      set_page_and_extract_portion_from(payment_methods)
+    def resource_class = Spree::PaymentMethod
 
-      respond_to do |format|
-        format.html { render component('payment_methods/index').new(page: @page) }
-      end
-    end
+    def resources_collection = resource_class.all
 
-    def move
-      @payment_method.insert_at(params[:position].to_i)
+    def resources_sorting_options = {position: :asc}
 
-      respond_to do |format|
-        format.js { head :no_content }
-      end
+    def permitted_resource_params
+      params.require(:payment_method).permit(:name, :description, :auto_capture, :type, :preference_source,
+        :preferred_server, :preferred_test_mode, :active, :available_to_admin, :available_to_users, store_ids: [])
     end
 
-    def destroy
-      @payment_methods = Spree::PaymentMethod.where(id: params[:id])
-
-      Spree::PaymentMethod.transaction { @payment_methods.destroy_all }
+    def initialize_resource
+      @resource = resource_class.new(stores: [Spree::Store.default])
+    end
 
-      flash[:notice] = t('.success')
-      redirect_back_or_to payment_methods_path, status: :see_other
+    def available_types
+      Rails.application.config.spree.payment_methods.map(&:name)
     end
 
-    private
+    def validate_type
+      unless available_types.include?(params[:payment_method][:type])
+        @resource ||= resource_class.new(permitted_resource_params.except(:type))
+        @resource.errors.add(:type, :invalid)
 
-    def load_payment_method
-      @payment_method = Spree::PaymentMethod.find_by!(id: params[:id])
-      authorize! action_name, @payment_method
+        page_component = @resource.persisted? ? edit_component.new(@resource) : new_component.new(@resource)
+        render_resource_form_with_errors(page_component)
+      end
     end
   end
 end

data/app/controllers/solidus_admin/product_option_types_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::ProductOptionTypesController < SolidusAdmin::BaseController
+  include SolidusAdmin::Moveable
+end

data/app/controllers/solidus_admin/product_taxons_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  class ProductTaxonsController < SolidusAdmin::BaseController
+    before_action :load_product, only: [:new, :create]
+
+    def new
+      render component("products/show/categories/new").new(product: @product)
+    end
+
+    def create
+      init_taxon
+      root_taxon! if @taxon.root?
+      @product.taxons << @taxon
+
+      respond_to do |format|
+        format.html { redirect_to @product, status: :see_other, notice: t(".success") }
+      end
+    rescue ActiveRecord::RecordInvalid
+      component = component("products/show/categories/new").new(product: @product, taxon: @taxon)
+      respond_to do |format|
+        format.html { render component, status: :unprocessable_entity }
+        format.turbo_stream do
+          render turbo_stream: turbo_stream.replace(:new_product_category, component),
+            status: :unprocessable_entity
+        end
+      end
+    end
+
+    private
+
+    def load_product
+      @product = Spree::Product.friendly.find(params[:product_id])
+    end
+
+    def init_taxon
+      @taxon = Spree::Taxon.new(category_params)
+      @taxon.taxonomy_id = @taxon.parent&.taxonomy_id
+    end
+
+    # Parent-less taxons must be associated with a taxonomy of the same name; it's guaranteed that in order to create a
+    # new parent-less taxon we need to create a new taxonomy.
+    def root_taxon!
+      # if Taxonomy.create! fails on the next step, we need validation errors on taxon object
+      # to display them on the form
+      @taxon.validate
+      Spree::Taxonomy.create!(name: @taxon.name, root: @taxon)
+    end
+
+    def authorization_subject
+      Spree::Classification
+    end
+
+    def category_params
+      params.require(:taxon).permit(:name, :parent_id, :description)
+    end
+  end
+end

data/app/controllers/solidus_admin/products_controller.rb

@@ -8,24 +8,25 @@ module SolidusAdmin
     search_scope(:deleted) { _1.with_discarded.discarded }
     search_scope(:discontinued) { _1.where(discontinue_on: ...Time.current) }
     search_scope(:available) { _1.available }
-    search_scope(:in_stock) { _1.where(id: Spree::Variant.in_stock.distinct.select(:product_id)) }
-    search_scope(:out_of_stock) { _1.where.not(id: Spree::Variant.in_stock.distinct.select(:product_id)) }
-
-    before_action :split_params, only: [:update]
+    search_scope(:in_stock) { _1.where(id: Spree::Variant.in_stock.select(:product_id)) }
+    search_scope(:out_of_stock) { _1.where.not(id: Spree::Variant.in_stock.select(:product_id)) }
 
     def index
       products = apply_search_to(
-        Spree::Product.includes(:master, :variants),
+        Spree::Product.includes(
+          :variant_images,
+          master: :prices,
+          variants: :prices,
+          variants_including_master: {stock_items: :stock_location}
+        ),
         param: :q,
+        distinct: false
       )
 
-      set_page_and_extract_portion_from(
-        products,
-        ordered_by: { updated_at: :desc, id: :desc },
-      )
+      @page = paginate(products, ordered_by: {name: :asc})
 
       respond_to do |format|
-        format.html { render component('products/index').new(page: @page) }
+        format.html { render component("products/index").new(page: @page) }
       end
     end
 
@@ -37,25 +38,21 @@ module SolidusAdmin
       @product = Spree::Product.with_discarded.friendly.find(params[:id])
 
       respond_to do |format|
-        format.html { render component('products/show').new(product: @product) }
+        format.html { render component("products/show").new(product: @product) }
       end
     end
 
     def update
       @product = Spree::Product.friendly.find(params[:id])
 
-      if @product.update(params.require(:product).permit!)
-        flash[:success] = t('spree.successfully_updated', resource: [
-          Spree::Product.model_name.human,
-          @product.name.inspect,
-        ].join(' '))
-
+      if @product.update(product_params)
+        flash[:success] = t(".success")
         redirect_to action: :show, status: :see_other
       else
         flash.now[:error] = @product.errors.full_messages.join(", ")
 
         respond_to do |format|
-          format.html { render component('products/show').new(product: @product), status: :unprocessable_entity }
+          format.html { render component("products/show").new(product: @product), status: :unprocessable_entity }
         end
       end
     end
@@ -67,7 +64,7 @@ module SolidusAdmin
         @products.discard_all
       end
 
-      flash[:notice] = t('.success')
+      flash[:notice] = t(".success")
       redirect_to products_path, status: :see_other
     end
 
@@ -79,7 +76,7 @@ module SolidusAdmin
           .update_all(discontinue_on: Time.current)
       end
 
-      flash[:notice] = t('.success')
+      flash[:notice] = t(".success")
       redirect_to products_path, status: :see_other
     end
 
@@ -97,17 +94,16 @@ module SolidusAdmin
           .update_all(discontinue_on: nil)
       end
 
-      flash[:notice] = t('.success')
+      flash[:notice] = t(".success")
       redirect_to products_path, status: :see_other
     end
 
-    def split_params
-      if params[:product][:taxon_ids].present?
-        params[:product][:taxon_ids] = params[:product][:taxon_ids].split(',')
-      end
-      if params[:product][:option_type_ids].present?
-        params[:product][:option_type_ids] = params[:product][:option_type_ids].split(',')
-      end
+    private
+
+    def product_params
+      params.require(:product).permit(:name, :slug, :description, :meta_title, :meta_description, :meta_keywords, :gtin,
+        :condition, :price, :cost_price, :cost_currency, :sku, :shipping_category_id, :tax_category_id,
+        :available_on, :discontinue_on, :promotionable, option_type_ids: [], taxon_ids: [])
     end
   end
 end

data/app/controllers/solidus_admin/reimbursement_types_controller.rb

@@ -7,13 +7,13 @@ module SolidusAdmin
     def index
       reimbursement_types = apply_search_to(
         Spree::ReimbursementType.unscoped.order(id: :desc),
-        param: :q,
+        param: :q
       )
 
-      set_page_and_extract_portion_from(reimbursement_types)
+      @page = paginate(reimbursement_types)
 
       respond_to do |format|
-        format.html { render component('reimbursement_types/index').new(page: @page) }
+        format.html { render component("reimbursement_types/index").new(page: @page) }
       end
     end
 

data/app/controllers/solidus_admin/resources_controller.rb

@@ -2,9 +2,11 @@
 
 module SolidusAdmin
   class ResourcesController < SolidusAdmin::BaseController
+    DEFAULT_PER_PAGE = 20
+
     include SolidusAdmin::ControllerHelpers::Search
 
-    helper_method :search_filter_params
+    helper_method :search_filter_params, :resource_form_frame
 
     before_action :set_paginated_resources, only: %i[index]
     before_action :set_resource, only: %i[edit update]
@@ -14,27 +16,35 @@ module SolidusAdmin
     # 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.
+    # Uses {paginate} 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) }
+        format.json do
+          set_pagination_headers(@page)
+          render json: blueprint.render(@page.records, view: blueprint_view)
+        end
       end
     end
 
     def new
-      @resource = resource_class.new
+      @resource ||= resource_class.new
       render new_component.new(@resource)
     end
 
     def create
-      @resource = resource_class.new(permitted_resource_params)
+      @resource ||= resource_class.new(permitted_resource_params)
 
       if @resource.save
-        flash[:notice] = t('.success')
-        redirect_to after_create_path, status: :see_other
+        flash[:notice] = t(".success")
+
+        respond_to do |format|
+          format.html { redirect_to after_create_path, status: :see_other }
+          format.turbo_stream if prefer_turbo_stream?
+        end
       else
         page_component = new_component.new(@resource)
         render_resource_form_with_errors(page_component)
@@ -42,13 +52,19 @@ module SolidusAdmin
     end
 
     def edit
-      render edit_component.new(@resource)
+      respond_to do |format|
+        format.html { render edit_component.new(@resource) }
+      end
     end
 
     def update
       if @resource.update(permitted_resource_params)
-        flash[:notice] = t('.success')
-        redirect_to after_update_path, status: :see_other
+        flash[:notice] = t(".success")
+
+        respond_to do |format|
+          format.html { redirect_to after_update_path, status: :see_other }
+          format.turbo_stream if prefer_turbo_stream?
+        end
       else
         page_component = edit_component.new(@resource)
         render_resource_form_with_errors(page_component)
@@ -60,8 +76,12 @@ module SolidusAdmin
 
       resource_class.transaction { @resource.destroy_all }
 
-      flash[:notice] = t('.success')
-      redirect_back_or_to after_destroy_path, status: :see_other
+      flash[:notice] = t(".success")
+
+      respond_to do |format|
+        format.html { redirect_back_or_to after_destroy_path, status: :see_other }
+        format.turbo_stream if prefer_turbo_stream?
+      end
     end
 
     private
@@ -73,16 +93,19 @@ module SolidusAdmin
     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
+        param: :q
+      ).tap do |resources|
+        instance_variable_set("@#{plural_resource_name}", resources)
+        @page = paginate(resources, ordered_by: resources_sorting_options, per_page:)
+      end
     end
 
     def resources_sorting_options
-      { id: :desc }
+      {id: :desc}
+    end
+
+    def per_page
+      DEFAULT_PER_PAGE
     end
 
     def resources_collection
@@ -91,7 +114,7 @@ module SolidusAdmin
 
     def set_resource
       @resource ||= resource_class.find(params[:id]).tap do |resource|
-          instance_variable_set("@#{resource_name}", resource)
+        instance_variable_set("@#{resource_name}", resource)
       end
     end
 
@@ -126,7 +149,7 @@ module SolidusAdmin
           render page_component, status: :unprocessable_entity
         end
         format.turbo_stream do
-          render turbo_stream: turbo_stream.replace(:resource_modal, page_component),
+          render turbo_stream: turbo_stream.replace(resource_form_frame, page_component),
             status: :unprocessable_entity
         end
       end
@@ -148,5 +171,21 @@ module SolidusAdmin
     def after_destroy_path
       solidus_admin.send("#{plural_resource_name}_path", **search_filter_params)
     end
+
+    def blueprint
+      raise NotImplementedError,
+        "You must implement the blueprint method in #{self.class}"
+    end
+
+    def blueprint_view
+      raise NotImplementedError,
+        "You must implement the blueprint_view method in #{self.class}"
+    end
+
+    def resource_form_frame
+      :resource_form
+    end
+
+    def prefer_turbo_stream? = false
   end
 end

data/app/controllers/solidus_admin/shipping_methods_controller.rb

@@ -7,13 +7,13 @@ module SolidusAdmin
     def index
       shipping_methods = apply_search_to(
         Spree::ShippingMethod.order(id: :desc),
-        param: :q,
+        param: :q
       )
 
-      set_page_and_extract_portion_from(shipping_methods)
+      @page = paginate(shipping_methods)
 
       respond_to do |format|
-        format.html { render component('shipping_methods/index').new(page: @page) }
+        format.html { render component("shipping_methods/index").new(page: @page) }
       end
     end
 
@@ -22,7 +22,7 @@ module SolidusAdmin
 
       Spree::ShippingMethod.transaction { @shipping_methods.destroy_all }
 
-      flash[:notice] = t('.success')
+      flash[:notice] = t(".success")
       redirect_back_or_to shipping_methods_path, status: :see_other
     end
 

data/app/controllers/solidus_admin/states_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SolidusAdmin
+  class StatesController < SolidusAdmin::ResourcesController
+    skip_before_action :authorize_solidus_admin_user!
+
+    private
+
+    def resource_class
+      Spree::State
+    end
+
+    def resources_sorting_options
+      {name: :asc}
+    end
+
+    def blueprint
+      SolidusAdmin::StateBlueprint
+    end
+
+    def blueprint_view
+      view = params[:view]&.to_sym
+      blueprint.view?(view) ? view : :default
+    end
+
+    def per_page
+      100
+    end
+  end
+end

data/app/controllers/solidus_admin/stock_items_controller.rb

@@ -6,13 +6,13 @@ module SolidusAdmin
 
     search_scope(:all, default: true) { _1 }
     search_scope(:back_orderable) { _1.where(backorderable: true) }
-    search_scope(:out_of_stock) { _1.where('count_on_hand <= 0') }
-    search_scope(:low_stock) { _1.where('count_on_hand > 0 AND count_on_hand < ?', SolidusAdmin::Config[:low_stock_value]) }
-    search_scope(:in_stock) { _1.where('count_on_hand > 0') }
+    search_scope(:out_of_stock) { _1.where("count_on_hand <= 0") }
+    search_scope(:low_stock) { _1.where("count_on_hand > 0 AND count_on_hand < ?", SolidusAdmin::Config.low_stock_value) }
+    search_scope(:in_stock) { _1.where("count_on_hand > 0") }
 
     def index
       respond_to do |format|
-        format.html { render component('stock_items/index').new(page: @page) }
+        format.html { render component("stock_items/index").new(page: @page) }
       end
     end
 
@@ -33,13 +33,18 @@ module SolidusAdmin
 
     def resource_class = Spree::StockItem
 
-    def resources_collection = Spree::StockItem.reorder(nil)
+    def resources_collection
+      Spree::StockItem.reorder(nil).includes(
+        :stock_location,
+        variant: [:product, :images, {option_values: :option_type}]
+      )
+    end
 
     def resources_sorting_options
       {
         variant_id: :desc,
         stock_location_id: :desc,
-        id: :desc,
+        id: :desc
       }
     end
 

data/app/controllers/solidus_admin/stock_locations_controller.rb

@@ -1,35 +1,34 @@
 # frozen_string_literal: true
 
 module SolidusAdmin
-  class StockLocationsController < SolidusAdmin::BaseController
-    include SolidusAdmin::ControllerHelpers::Search
+  class StockLocationsController < SolidusAdmin::ResourcesController
+    private
 
-    def index
-      stock_locations = apply_search_to(
-        Spree::StockLocation.order(id: :desc),
-        param: :q,
+    def resource_class = Spree::StockLocation
+
+    def permitted_resource_params
+      params.require(:stock_location).permit(
+        :name,
+        :admin_name,
+        :code,
+        :address1,
+        :address2,
+        :city, :zipcode,
+        :country_id,
+        :state_name,
+        :state_id,
+        :phone,
+        :email,
+        :active,
+        :default,
+        :backorderable_default,
+        :propagate_all_variants,
+        :restock_inventory,
+        :fulfillable,
+        :check_stock_on_transfer
       )
-
-      set_page_and_extract_portion_from(stock_locations)
-
-      respond_to do |format|
-        format.html { render component('stock_locations/index').new(page: @page) }
-      end
-    end
-
-    def destroy
-      @stock_locations = Spree::StockLocation.where(id: params[:id])
-
-      Spree::StockLocation.transaction { @stock_locations.destroy_all }
-
-      flash[:notice] = t('.success')
-      redirect_back_or_to stock_locations_path, status: :see_other
     end
 
-    private
-
-    def stock_location_params
-      params.require(:stock_location).permit(:stock_location_id, permitted_stock_location_attributes)
-    end
+    def resources_collection = Spree::StockLocation.unscoped
   end
 end

data/app/controllers/solidus_admin/store_credits_controller.rb

@@ -48,7 +48,7 @@ module SolidusAdmin
       return unless ensure_store_credit_category { render_new_with_errors }
 
       if @store_credit.save
-        flash[:notice] = t('.success')
+        flash[:notice] = t(".success")
         redirect_to after_create_path, status: :see_other
       else
         render_new_with_errors
@@ -72,7 +72,7 @@ module SolidusAdmin
       return unless ensure_store_credit_reason { render_edit_with_errors }
 
       if @store_credit.update_amount(permitted_resource_params[:amount], @store_credit_reason, spree_current_user)
-        flash[:notice] = t('.success')
+        flash[:notice] = t(".success")
         redirect_to after_update_path, status: :see_other
       else
         render_edit_with_errors
@@ -84,7 +84,7 @@ module SolidusAdmin
         format.html {
           render component("users/store_credits/edit_memo").new(
             user: @user,
-            store_credit: @store_credit,
+            store_credit: @store_credit
           )
         }
       end
@@ -92,10 +92,10 @@ module SolidusAdmin
 
     def update_memo
       if @store_credit.update(memo: permitted_resource_params[:memo])
-        flash[:notice] = t('.success')
+        flash[:notice] = t(".success")
       else
         # Memo update failures are nearly impossible to trigger due to lack of validation.
-        flash[:error] = t('.failure')
+        flash[:error] = t(".failure")
       end
 
       redirect_to after_update_path, status: :see_other
@@ -117,11 +117,11 @@ module SolidusAdmin
       return unless ensure_store_credit_reason { render_edit_with_errors }
 
       if @store_credit.invalidate(@store_credit_reason, spree_current_user)
-        flash[:notice] = t('.success')
+        flash[:notice] = t(".success")
       else
         # Ensure store_credit_reason handles invalid param/form submissions and modal re-rendering.
         # This is just a fallback error state in case anything goes wrong with StoreCredit#invalidate.
-        flash[:error] = t('.failure')
+        flash[:error] = t(".failure")
       end
 
       redirect_to after_update_path, status: :see_other
@@ -202,7 +202,7 @@ module SolidusAdmin
       @store_credit_reason = Spree::StoreCreditReason.find_by(id: permitted_resource_params[:store_credit_reason_id])
 
       if @store_credit_reason.blank?
-        @store_credit.errors.add(:store_credit_reason_id, "Store Credit reason must be provided")
+        @store_credit.errors.add(:store_credit_reason_id, "Store credit reason must be provided")
         yield if block_given? # Block is for error template rendering on a per-action basis so this can be re-used.
         return false
       end
@@ -213,7 +213,7 @@ module SolidusAdmin
       @store_credit_category = Spree::StoreCreditCategory.find_by(id: permitted_resource_params[:category_id])
 
       if @store_credit_category.blank?
-        @store_credit.errors.add(:category_id, "Store Credit category must be provided")
+        @store_credit.errors.add(:category_id, "Store credit category must be provided")
         yield if block_given? # Block is for error template rendering on a per-action basis so this can be re-used.
         return false
       end