solidus_admin 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e93504045b4612199721f629e4a151aaeea3dd2e3ceba7bcf32864d33d50f0b
-  data.tar.gz: 073d45e7bec2c812c967da18724617e1300ca463f9267f1fc5d36d5a47036b65
+  metadata.gz: 28b57ee7cd36b6042c6a1f7a735587aaba8a9e78d6050744ff6687b3799154fc
+  data.tar.gz: de8a6150a3b9c7445d4b572cc4cd6af8aba87e6be2ffcd81582b7bdfd96b2b8a
 SHA512:
-  metadata.gz: 71e431ef5f2de8b7395df11e1189ebb8a30678ee064ecda72af0473531ac0f09feb2ecf6a11e56b572e16ab01742db687470f2f1f8da7ea0b6db22143dc45bd2
-  data.tar.gz: 7cc238704bd7b7b9a040b7892cf1a929eda2e037fe18896118033785584e42987f817b43caf6e29806282f2f75b7811801870c3ef6f3eff9d33c4b0cdd24e85f
+  metadata.gz: 9db4b1349c35d1778bad7f922951a8c9f9d35e97e90c25a78c71d97a7e3ec6f772c9411490f6b66a1323c016e94a283ed2311ff11c4a142891fee2695bee6ba4
+  data.tar.gz: f24a6d904d75739bd41ef956f40489459b281e9aa9b3aa9981affdbe260865019a75c2200f56e201a0dd6f647d6d48d92483766ec5b6e99cc9e2f1d133924c65

data/README.md

@@ -26,6 +26,6 @@ bin/rails admin g solidus_admin:component foo
 ## Releasing
 
 1. Update the version in `lib/solidus_admin/version.rb`
-2. Commit the changes with the message `Release v1.2.3`
+2. Commit the changes with the message `Release solidus_admin/v1.2.3`
 3. `cd admin; bundle exec rake release`
 4. Manually release on GitHub

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

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::AdjustmentReasons::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
-
-  def initialize(page:)
-    @page = page
+class SolidusAdmin::AdjustmentReasons::Index::Component < SolidusAdmin::RefundsAndReturns::Component
+  def model_class
+    Spree::AdjustmentReason
   end
 
-  def title
-    Spree::AdjustmentReason.model_name.human.pluralize
+  def search_url
+    solidus_admin.adjustment_reasons_path
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def search_key
+    :name_or_code_cont
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def row_url(adjustment_reason)
+    spree.edit_admin_adjustment_reason_path(adjustment_reason)
   end
 
   def batch_actions
@@ -30,14 +28,6 @@ class SolidusAdmin::AdjustmentReasons::Index::Component < SolidusAdmin::BaseComp
     ]
   end
 
-  def scopes
-    []
-  end
-
-  def filters
-    []
-  end
-
   def columns
     [
       :name,

data/app/components/solidus_admin/base_component.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "view_component/version"
+require "view_component/translatable"
+
 module SolidusAdmin
   # BaseComponent is the base class for all components in Solidus Admin.
   class BaseComponent < ViewComponent::Base
@@ -10,12 +13,37 @@ module SolidusAdmin
       render component("ui/icon").new(name: name, **attrs)
     end
 
+    module InheritableTranslations
+      def build_i18n_backend
+        return if compiled?
+
+        # We need to load the translations files from the ancestors so a component
+        # can inherit translations from its parent and is able to overwrite them.
+        translation_files = ancestors.reverse_each.with_object([]) do |ancestor, files|
+          if ancestor.is_a?(Class) && ancestor < ViewComponent::Base
+            files.concat(ancestor.sidecar_files(%w[yml yaml].freeze))
+          end
+        end
+
+        # In development it will become nil if the translations file is removed
+        self.i18n_backend = if translation_files.any?
+          ViewComponent::Translatable::I18nBackend.new(
+            i18n_scope: i18n_scope,
+            load_paths: translation_files
+          )
+        end
+      end
+    end
+
+    # Can be removed once https://github.com/ViewComponent/view_component/pull/1934 is released
+    extend InheritableTranslations unless Gem::Version.new(ViewComponent::VERSION::STRING) >= Gem::Version.new("3.9")
+
     def missing_translation(key, options)
       keys = I18n.normalize_keys(options[:locale] || I18n.locale, key, options[:scope])
 
       logger.debug "  [#{self.class}] Missing translation: #{keys.join('.')}"
 
-      if options[:locale] != :en
+      if (options[:locale] || I18n.default_locale) != :en
         t(key, **options, locale: :en)
       else
         "translation missing: #{keys.join('.')}"

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

@@ -1,14 +1,28 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::OptionTypes::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
+class SolidusAdmin::OptionTypes::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    Spree::OptionType
+  end
+
+  def row_url(option_type)
+    spree.edit_admin_option_type_path(option_type)
+  end
 
-  def initialize(page:)
-    @page = page
+  def sortable_options
+    {
+      url: ->(option_type) { solidus_admin.move_option_type_path(option_type) },
+      param: 'position',
+    }
   end
 
-  def title
-    Spree::OptionType.model_name.human.pluralize
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_option_type_path,
+      icon: "add-line",
+    )
   end
 
   def prev_page_path

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

@@ -1,28 +1,33 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::Orders::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
-
-  def initialize(page:)
-    @page = page
+class SolidusAdmin::Orders::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    Spree::Order
   end
 
-  class_attribute :row_fade, default: ->(order) { order.paid? && order.shipped? }
+  def search_key
+    :number_or_shipments_number_or_bill_address_name_or_email_cont
+  end
 
-  def title
-    Spree::Order.model_name.human.pluralize
+  def search_url
+    solidus_admin.orders_path(scope: params[:scope])
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def row_url(order)
+    spree.edit_admin_order_path(order)
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def row_fade(order)
+    order.paid? && order.shipped?
   end
 
-  def batch_actions
-    []
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_order_path,
+      icon: "add-line",
+    )
   end
 
   def scopes
@@ -100,7 +105,7 @@ class SolidusAdmin::Orders::Index::Component < SolidusAdmin::BaseComponent
     {
       header: :order,
       data: ->(order) do
-        if !row_fade.call(order)
+        if !row_fade(order)
           content_tag :div, order.number, class: 'font-semibold'
         else
           content_tag :div, order.number

data/app/components/solidus_admin/orders/index/component.yml

@@ -1,5 +1,4 @@
 en:
-  create_order: 'Create Order'
   columns:
     items:
       one: 1 Item

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

@@ -1,22 +1,36 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::PaymentMethods::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
+class SolidusAdmin::PaymentMethods::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    Spree::PaymentMethod
+  end
+
+  def search_key
+    :name_or_description_cont
+  end
 
-  def initialize(page:)
-    @page = page
+  def search_url
+    solidus_admin.payment_methods_path
   end
 
-  def title
-    Spree::PaymentMethod.model_name.human.pluralize
+  def row_url(payment_method)
+    spree.edit_admin_payment_method_path(payment_method)
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def sortable_options
+    {
+      url: ->(payment_method) { solidus_admin.move_payment_method_path(payment_method) },
+      param: 'position',
+    }
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_payment_method_path,
+      icon: "add-line",
+    )
   end
 
   def batch_actions
@@ -40,10 +54,6 @@ class SolidusAdmin::PaymentMethods::Index::Component < SolidusAdmin::BaseCompone
     ]
   end
 
-  def filters
-    []
-  end
-
   def columns
     [
       {
@@ -62,9 +72,9 @@ class SolidusAdmin::PaymentMethods::Index::Component < SolidusAdmin::BaseCompone
         header: :available_to_users,
         data: ->(payment_method) do
           if payment_method.available_to_users?
-            component('ui/badge').new(name: t('.yes'), color: :green)
+            component('ui/badge').yes
           else
-            component('ui/badge').new(name: t('.no'), color: :graphite_light)
+            component('ui/badge').no
           end
         end
       },
@@ -72,9 +82,9 @@ class SolidusAdmin::PaymentMethods::Index::Component < SolidusAdmin::BaseCompone
         header: :available_to_admin,
         data: ->(payment_method) do
           if payment_method.available_to_admin?
-            component('ui/badge').new(name: t('.yes'), color: :green)
+            component('ui/badge').yes
           else
-            component('ui/badge').new(name: t('.no'), color: :graphite_light)
+            component('ui/badge').no
           end
         end
       },

data/app/components/solidus_admin/payment_methods/index/component.yml

@@ -1,7 +1,4 @@
 en:
-  add: 'Add new'
-  "yes": "Yes"
-  "no": "No"
   status:
     active: Active
     inactive: Inactive
@@ -11,5 +8,3 @@ en:
     admin: Admin
     storefront: Storefront
     all: All
-  batch_actions:
-    delete: 'Delete'

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

@@ -1,22 +1,29 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::Products::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
+class SolidusAdmin::Products::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    Spree::Product
+  end
 
-  def initialize(page:)
-    @page = page
+  def search_key
+    :name_or_variants_including_master_sku_cont
   end
 
-  def title
-    Spree::Product.model_name.human.pluralize
+  def search_url
+    solidus_admin.products_path
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def row_url(product)
+    solidus_admin.product_path(product)
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_product_path,
+      icon: "add-line",
+    )
   end
 
   def batch_actions

data/app/components/solidus_admin/products/index/component.yml

@@ -1,8 +1,6 @@
 en:
   image: 'Image'
-  add: 'Add new'
   batch_actions:
-    delete: 'Delete'
     discontinue: 'Discontinue'
     activate: 'Activate'
   filters:

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

@@ -1,22 +1,21 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::PromotionCategories::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
-
-  def initialize(page:)
-    @page = page
-  end
-
-  def title
-    Spree::PromotionCategory.model_name.human.pluralize
+class SolidusAdmin::PromotionCategories::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    Spree::PromotionCategory
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def row_url(promotion_category)
+    spree.edit_admin_promotion_category_path(promotion_category)
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_promotion_category_path,
+      icon: "add-line",
+    )
   end
 
   def batch_actions

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

@@ -1,22 +1,29 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::Promotions::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
+class SolidusAdmin::Promotions::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    Spree::Promotion
+  end
 
-  def initialize(page:)
-    @page = page
+  def search_key
+    :name_or_codes_value_or_path_or_description_cont
   end
 
-  def title
-    Spree::Promotion.model_name.human.pluralize
+  def search_url
+    solidus_admin.promotions_path
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def row_url(promotion)
+    spree.admin_promotion_path(promotion)
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_promotion_path,
+      icon: "add-line",
+    )
   end
 
   def batch_actions

data/app/components/solidus_admin/promotions/index/component.yml

@@ -1,8 +1,4 @@
 en:
-  promotion_image: 'Image'
-  add: 'Add new'
-  batch_actions:
-    delete: 'Delete'
   scopes:
     active: Active
     draft: Draft

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

@@ -1,22 +1,29 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::Properties::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
+class SolidusAdmin::Properties::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    Spree::Property
+  end
 
-  def initialize(page:)
-    @page = page
+  def search_key
+    :name_cont
   end
 
-  def title
-    Spree::Property.model_name.human.pluralize
+  def search_url
+    solidus_admin.properties_path
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def row_url(property)
+    spree.admin_property_path(property)
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_property_path,
+      icon: "add-line",
+    )
   end
 
   def batch_actions
@@ -30,14 +37,6 @@ class SolidusAdmin::Properties::Index::Component < SolidusAdmin::BaseComponent
     ]
   end
 
-  def scopes
-    []
-  end
-
-  def filters
-    []
-  end
-
   def columns
     [
       name_column,

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

@@ -1,22 +1,30 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::RefundReasons::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
+class SolidusAdmin::RefundReasons::Index::Component < SolidusAdmin::RefundsAndReturns::Component
+  def model_class
+    Spree::RefundReason
+  end
 
-  def initialize(page:)
-    @page = page
+  def search_url
+    solidus_admin.refund_reasons_path
   end
 
-  def title
-    Spree::RefundReason.model_name.human.pluralize
+  def search_key
+    :name_or_code_cont
   end
 
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
+  def row_url(refund_reason)
+    spree.edit_admin_refund_reason_path(refund_reason)
   end
 
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
+  def actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_refund_reason_path,
+      icon: "add-line",
+      class: "align-self-end w-full",
+    )
   end
 
   def batch_actions
@@ -30,14 +38,6 @@ class SolidusAdmin::RefundReasons::Index::Component < SolidusAdmin::BaseComponen
     ]
   end
 
-  def scopes
-    []
-  end
-
-  def filters
-    []
-  end
-
   def columns
     [
       :name,

data/app/components/solidus_admin/refunds_and_returns/component.rb

@@ -1,20 +1,40 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::RefundsAndReturns::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
-  renders_one :actions
-
-  def initialize(current_class:)
-    @current_class = current_class
+class SolidusAdmin::RefundsAndReturns::Component < SolidusAdmin::UI::Pages::Index::Component
+  def title
+    page_header_title safe_join([
+      tag.div(t(".title")),
+      tag.div(t(".subtitle"), class: "font-normal text-sm text-gray-500"),
+    ])
   end
 
   def tabs
-    {
-      Spree::RefundReason => solidus_admin.refund_reasons_path,
-      Spree::ReimbursementType => solidus_admin.reimbursement_types_path,
-      Spree::ReturnReason => solidus_admin.return_reasons_path,
-      Spree::AdjustmentReason => solidus_admin.adjustment_reasons_path,
-      Spree::StoreCreditReason => solidus_admin.store_credit_reasons_path,
-    }
+    [
+      {
+        text: Spree::RefundReason.model_name.human(count: 2),
+        href: solidus_admin.refund_reasons_path,
+        current: model_class == Spree::RefundReason,
+      },
+      {
+        text: Spree::ReimbursementType.model_name.human(count: 2),
+        href: solidus_admin.reimbursement_types_path,
+        current: model_class == Spree::ReimbursementType,
+      },
+      {
+        text: Spree::ReturnReason.model_name.human(count: 2),
+        href: solidus_admin.return_reasons_path,
+        current: model_class == Spree::ReturnReason,
+      },
+      {
+        text: Spree::AdjustmentReason.model_name.human(count: 2),
+        href: solidus_admin.adjustment_reasons_path,
+        current: model_class == Spree::AdjustmentReason,
+      },
+      {
+        text: Spree::StoreCreditReason.model_name.human(count: 2),
+        href: solidus_admin.store_credit_reasons_path,
+        current: model_class == Spree::StoreCreditReason,
+      },
+    ]
   end
 end

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

@@ -1,34 +1,16 @@
 # frozen_string_literal: true
 
-class SolidusAdmin::ReimbursementTypes::Index::Component < SolidusAdmin::BaseComponent
-  include SolidusAdmin::Layout::PageHelpers
-
-  def initialize(page:)
-    @page = page
-  end
-
-  def title
-    Spree::ReimbursementType.model_name.human.pluralize
-  end
-
-  def prev_page_path
-    solidus_admin.url_for(**request.params, page: @page.number - 1, only_path: true) unless @page.first?
-  end
-
-  def next_page_path
-    solidus_admin.url_for(**request.params, page: @page.next_param, only_path: true) unless @page.last?
-  end
-
-  def batch_actions
-    []
+class SolidusAdmin::ReimbursementTypes::Index::Component < SolidusAdmin::RefundsAndReturns::Component
+  def model_class
+    Spree::ReimbursementType
   end
 
-  def scopes
-    []
+  def search_url
+    solidus_admin.reimbursement_types_path
   end
 
-  def filters
-    []
+  def search_key
+    :name_cont
   end
 
   def columns