solidus_admin 0.0.2 → 0.1.0

data/app/components/solidus_admin/return_reasons/index/component.html.erb

@@ -0,0 +1,31 @@
+<%= render component('refunds_and_returns').new(current_class: Spree::ReturnReason) do |layout| %>
+  <% layout.with_actions do %>
+    <%= render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_return_reason_path,
+      icon: "add-line",
+      class: "align-self-end w-full",
+    ) %>
+  <% end %>
+  <%= render component('ui/table').new(
+    id: stimulus_id,
+    data: {
+      class: Spree::ReturnReason,
+      rows: @page.records,
+      url: ->(return_reason) { spree.edit_admin_return_reason_path(return_reason) },
+      prev: prev_page_path,
+      next: next_page_path,
+      columns: columns,
+      batch_actions: batch_actions,
+    },
+    search: {
+      name: :q,
+      value: params[:q],
+      url: solidus_admin.return_reasons_path,
+      searchbar_key: :name_cont,
+      scopes: scopes,
+      filters: filters,
+    },
+  ) %>
+<% end %>

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::ReturnReasons::Index::Component < SolidusAdmin::BaseComponent
+  include SolidusAdmin::Layout::PageHelpers
+
+  def initialize(page:)
+    @page = page
+  end
+
+  def title
+    Spree::ReturnReason.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
+    [
+      {
+        display_name: t('.batch_actions.delete'),
+        action: solidus_admin.return_reasons_path,
+        method: :delete,
+        icon: 'delete-bin-7-line',
+      },
+    ]
+  end
+
+  def scopes
+    []
+  end
+
+  def filters
+    []
+  end
+
+  def columns
+    [
+      :name,
+      {
+        header: :active,
+        data: ->(return_reason) do
+          return_reason.active? ? component('ui/badge').yes : component('ui/badge').no
+        end
+      },
+    ]
+  end
+end

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

@@ -0,0 +1,4 @@
+en:
+  add: 'Add new'
+  batch_actions:
+    delete: 'Delete'

data/app/components/solidus_admin/shipping/component.html.erb

@@ -0,0 +1,30 @@
+<%= page do %>
+  <%= page_header do %>
+    <%= page_header_title safe_join([
+      tag.div(t(".title")),
+      tag.div(t(".subtitle"), class: "font-normal text-sm text-gray-500"),
+    ]) %>
+  <% end %>
+
+  <%= page_header do %>
+    <% title = capture do %>
+      <% tabs.each do |tab_class, href|%>
+        <%= render component('ui/button').new(
+          tag: :a,
+          scheme: :ghost,
+          href: href,
+          text: tab_class.model_name.human.pluralize,
+          "aria-current" => tab_class == @current_class,
+        ) %>
+      <% end %>
+    <% end %>
+
+    <%= page_header_title title %>
+
+    <%= page_header_actions do %>
+      <%= actions %>
+    <% end %>
+  <% end %>
+
+  <%= content %>
+<% end %>

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::Shipping::Component < SolidusAdmin::BaseComponent
+  include SolidusAdmin::Layout::PageHelpers
+  renders_one :actions
+
+  def initialize(current_class:)
+    @current_class = current_class
+  end
+
+  def tabs
+    {
+      Spree::ShippingMethod => solidus_admin.shipping_methods_path,
+      Spree::ShippingCategory => solidus_admin.shipping_categories_path,
+      Spree::StockLocation => solidus_admin.stock_locations_path,
+    }
+  end
+end

data/app/components/solidus_admin/shipping/component.yml

@@ -0,0 +1,3 @@
+en:
+  title: "Shipping"
+  subtitle: "Configure shipping methods, categories, and stock locations for customer orders."

data/app/components/solidus_admin/shipping_categories/index/component.html.erb

@@ -0,0 +1,32 @@
+<%= render component('shipping').new(current_class: Spree::ShippingCategory) do |layout| %>
+  <% layout.with_actions do %>
+    <%= render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_shipping_category_path,
+      icon: "add-line",
+      class: "align-self-end w-full",
+    ) %>
+  <% end %>
+
+  <%= render component('ui/table').new(
+    id: stimulus_id,
+    data: {
+      class: Spree::ShippingCategory,
+      rows: @page.records,
+      url: ->(shipping_category) { spree.edit_admin_shipping_category_path(shipping_category) },
+      prev: prev_page_path,
+      next: next_page_path,
+      columns: columns,
+      batch_actions: batch_actions,
+    },
+    search: {
+      name: :q,
+      value: params[:q],
+      url: solidus_admin.shipping_categories_path,
+      searchbar_key: :name_or_description_cont,
+      scopes: scopes,
+      filters: filters,
+    },
+  ) %>
+<% end %>

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::ShippingCategories::Index::Component < SolidusAdmin::BaseComponent
+  include SolidusAdmin::Layout::PageHelpers
+
+  def initialize(page:)
+    @page = page
+  end
+
+  def title
+    Spree::ShippingCategory.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
+    [
+      {
+        display_name: t('.batch_actions.delete'),
+        action: solidus_admin.shipping_categories_path,
+        method: :delete,
+        icon: 'delete-bin-7-line',
+      },
+    ]
+  end
+
+  def scopes
+    []
+  end
+
+  def filters
+    []
+  end
+
+  def columns
+    [
+      :name
+    ]
+  end
+end

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

@@ -0,0 +1,4 @@
+en:
+  add: 'Add new'
+  batch_actions:
+    delete: 'Delete'

data/app/components/solidus_admin/shipping_methods/index/component.html.erb

@@ -0,0 +1,32 @@
+<%= render component('shipping').new(current_class: Spree::ShippingMethod) do |layout| %>
+  <% layout.with_actions do %>
+    <%= render component("ui/button").new(
+      tag: :a,
+      text: t('.add'),
+      href: spree.new_admin_shipping_method_path,
+      icon: "add-line",
+      class: "align-self-end w-full",
+    ) %>
+  <% end %>
+
+  <%= render component('ui/table').new(
+    id: stimulus_id,
+    data: {
+      class: Spree::ShippingMethod,
+      rows: @page.records,
+      url: ->(shipping_method) { spree.edit_admin_shipping_method_path(shipping_method) },
+      prev: prev_page_path,
+      next: next_page_path,
+      columns: columns,
+      batch_actions: batch_actions,
+    },
+    search: {
+      name: :q,
+      value: params[:q],
+      url: solidus_admin.shipping_methods_path,
+      searchbar_key: :name_or_description_cont,
+      scopes: scopes,
+      filters: filters,
+    },
+  ) %>
+<% end %>

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::ShippingMethods::Index::Component < SolidusAdmin::BaseComponent
+  include SolidusAdmin::Layout::PageHelpers
+
+  def initialize(page:)
+    @page = page
+  end
+
+  def title
+    Spree::ShippingMethod.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
+    [
+      {
+        display_name: t('.batch_actions.delete'),
+        action: solidus_admin.shipping_methods_path,
+        method: :delete,
+        icon: 'delete-bin-7-line',
+      },
+    ]
+  end
+
+  def scopes
+    []
+  end
+
+  def filters
+    []
+  end
+
+  def columns
+    [
+      {
+        header: :name,
+        data: -> { [_1.admin_name.presence, _1.name].compact.join(' / ') },
+      },
+      {
+        header: :zone,
+        data: -> { _1.zones.pluck(:name).to_sentence },
+      },
+      {
+        header: :calculator,
+        data: -> { _1.calculator&.description },
+      },
+      {
+        header: :available_to_users,
+        data: -> { _1.available_to_users? ? component('ui/badge').yes : component('ui/badge').no },
+      },
+    ]
+  end
+end

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

@@ -0,0 +1,4 @@
+en:
+  add: 'Add new'
+  batch_actions:
+    delete: 'Delete'

data/app/components/solidus_admin/stock_items/edit/component.html.erb

@@ -0,0 +1,89 @@
+<div
+  data-controller="<%= stimulus_id %>"
+  data-<%= stimulus_id %>-initial-count-on-hand-value="<%= @stock_item.count_on_hand_was || @stock_item.count_on_hand %>"
+  data-action="input-><%= stimulus_id %>#updateCountOnHand"
+>
+  <%= render component("ui/modal").new(title: t(".title"), close_path: solidus_admin.stock_items_path(page: params[:page], q: permitted_query_params)) do |modal| %>
+    <%= form_for @stock_item, url: solidus_admin.stock_item_path(@stock_item), html: { id: form_id } do |f| %>
+      <div class="flex flex-col gap-6 pb-4">
+        <div class="flex gap-4">
+          <%= link_to spree.edit_admin_product_variant_path(
+            @stock_item.variant.product,
+            @stock_item.variant,
+          ), class: 'hover:bg-gray-25 rounded p-1 w-1/2 border border-gray-100' do %>
+            <%= render component("ui/resource_item").new(
+              thumbnail:
+                (
+                  @stock_item.variant.images.first ||
+                    @stock_item.variant.product.gallery.images.first
+                )&.url(:small),
+              title: @stock_item.variant.name,
+              subtitle:
+                "#{@stock_item.variant.sku}#{@stock_item.variant.options_text.presence&.prepend(" - ")}",
+            ) %>
+          <% end %>
+          <%= link_to spree.edit_admin_stock_location_path(@stock_item.stock_location), class: 'hover:bg-gray-25 rounded p-1 w-1/2 border border-gray-100' do %>
+            <%= render component("ui/resource_item").new(
+              title: @stock_item.stock_location.name,
+              subtitle: "#{Spree::StockLocation.model_name.human} #{@stock_item.stock_location.code}",
+            ) %>
+          <% end %>
+        </div>
+
+        <%= render component("ui/forms/field").text_field(
+          f,
+          :count_on_hand,
+          disabled: true,
+          value: @stock_item.count_on_hand_was || @stock_item.count_on_hand,
+          "data-#{stimulus_id}-target": 'countOnHand',
+        ) %>
+        <%= render component("ui/forms/field").new(
+          label: t(".quantity_adjustment"),
+          hint: t(".quantity_adjustment_hint_html"),
+        ) do %>
+          <%= render component("ui/forms/input").new(
+            value: params[:quantity_adjustment] || 0,
+            name: :quantity_adjustment,
+            type: :number,
+            step: 1,
+            "data-#{stimulus_id}-target": 'quantityAdjustment',
+          ) %>
+        <% end %>
+
+        <%= render component("ui/forms/switch_field").new(
+          name: "#{f.object_name}[backorderable]",
+          label: Spree::StockItem.human_attribute_name(:backorderable),
+          error: f.object.errors[:backorderable],
+          hint: t(".backorderable_hint_html"),
+          checked: f.object.backorderable?,
+          include_hidden: true,
+        ) %>
+
+        <% if params[:q] %>
+          <%= f.hidden_field :q, value: params[:q].to_json, id: false %>
+        <% end %>
+
+        <% if params[:page] %>
+          <%= f.hidden_field :page, value: params[:page], id: false %>
+        <% end %>
+      </div>
+    <% end %>
+
+    <% modal.with_actions do %>
+      <%= render component("ui/button").new(
+        tag: :a,
+        scheme: :secondary,
+        text: t(".cancel"),
+        href: solidus_admin.stock_items_path(page: params[:page], q: params[:q]),
+      ) %>
+
+      <%= render component("ui/button").new(
+        tag: :button,
+        text: t(".submit"),
+        form: form_id,
+      ) %>
+    <% end %>
+  <% end %>
+
+  <%= render component("stock_items/index").new(page: @page) %>
+</div>

data/app/components/solidus_admin/stock_items/edit/component.js

@@ -0,0 +1,17 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  static values = {
+    initialCountOnHand: Number,
+  }
+
+  static targets = ['countOnHand', 'quantityAdjustment']
+
+  connect() {
+    this.updateCountOnHand()
+  }
+
+  updateCountOnHand() {
+    this.countOnHandTarget.value = parseInt(this.initialCountOnHandValue) + parseInt(this.quantityAdjustmentTarget.value)
+  }
+}

data/app/components/solidus_admin/stock_items/edit/component.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::StockItems::Edit::Component < SolidusAdmin::BaseComponent
+  def initialize(stock_item:, page:)
+    @stock_item = stock_item
+    @page = page
+  end
+
+  def title
+    [
+      "#{Spree::StockLocation.model_name.human}: #{@stock_item.stock_location.name}",
+    ].join(' / ')
+  end
+
+  def form_id
+    "#{stimulus_id}-#{dom_id(@stock_item)}"
+  end
+
+  def permitted_query_params
+    return params[:q].permit! if params[:q].respond_to?(:permit)
+    {}
+  end
+end

data/app/components/solidus_admin/stock_items/edit/component.yml

@@ -0,0 +1,10 @@
+en:
+  submit: "Save"
+  cancel: "Cancel"
+  title: "Edit Stock Levels"
+  quantity_adjustment: "Quantity Adjustment"
+  quantity_adjustment_hint_html: |
+    Enter a positive number to increase the stock level, or a negative number to decrease the stock level.
+  backorderable_hint_html: |
+    Enable to allow customers to place orders even when the product is out of stock.<br>
+    When ordering the product customers will know that the product will be delivered at a later date, once it becomes available again.

data/app/components/solidus_admin/stock_items/index/component.html.erb

@@ -0,0 +1,26 @@
+<%= page do %>
+  <%= page_header do %>
+    <%= page_header_title title %>
+  <% end %>
+
+  <%= render component('ui/table').new(
+    id: stimulus_id,
+    data: {
+      class: Spree::StockItem,
+      rows: @page.records,
+      prev: prev_page_path,
+      next: next_page_path,
+      columns: columns,
+      batch_actions: batch_actions,
+      url: -> { solidus_admin.edit_stock_item_path(_1, page: params[:page], q: permitted_query_params) },
+    },
+    search: {
+      name: :q,
+      value: permitted_query_params,
+      url: solidus_admin.stock_items_path,
+      searchbar_key: :variant_product_name_or_variant_sku_or_variant_option_values_name_or_variant_option_values_presentation_cont,
+      scopes: scopes,
+      filters: filters,
+    },
+  ) %>
+<% end %>

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

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::StockItems::Index::Component < SolidusAdmin::BaseComponent
+  include SolidusAdmin::Layout::PageHelpers
+
+  def initialize(page:)
+    @page = page
+  end
+
+  def title
+    Spree::StockItem.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
+    []
+  end
+
+  def scopes
+    [
+      { label: t('.scopes.all_stock_items'), name: 'all', default: true },
+      { label: t('.scopes.back_orderable'), name: 'back_orderable' },
+      { label: t('.scopes.out_of_stock'), name: 'out_of_stock' },
+      { label: t('.scopes.low_stock'), name: 'low_stock' },
+      { label: t('.scopes.in_stock'), name: 'in_stock' },
+    ]
+  end
+
+  def filters
+    [
+      {
+        presentation: t('.filters.stock_locations'),
+        combinator: 'or',
+        attribute: "stock_location_id",
+        predicate: "eq",
+        options: Spree::StockLocation.all.map do |stock_location|
+          [
+            stock_location.name.titleize,
+            stock_location.id
+          ]
+        end
+      },
+      {
+        presentation: t('.filters.variants'),
+        combinator: 'or',
+        attribute: "variant_id",
+        predicate: "eq",
+        options: Spree::Variant.all.map do |variant|
+          [
+            variant.descriptive_name,
+            variant.id
+          ]
+        end
+      },
+    ]
+  end
+
+  def columns
+    [
+      image_column,
+      name_column,
+      sku_column,
+      variant_column,
+      stock_location_column,
+      back_orderable_column,
+      count_on_hand_column,
+      stock_movements_column,
+    ]
+  end
+
+  def image_column
+    {
+      col: { class: "w-[72px]" },
+      header: tag.span('aria-label': Spree::Image.model_name.human, role: 'text'),
+      data: ->(stock_item) do
+        image = stock_item.variant.gallery.images.first or return
+
+        render(
+          component('ui/thumbnail').new(
+            src: image.url(:small),
+            alt: stock_item.variant.name
+          )
+        )
+      end
+    }
+  end
+
+  def name_column
+    {
+      header: :name,
+      data: ->(stock_item) do
+        content_tag :div, stock_item.variant.name
+      end
+    }
+  end
+
+  def sku_column
+    {
+      header: :sku,
+      data: ->(stock_item) do
+        content_tag :div, stock_item.variant.sku
+      end
+    }
+  end
+
+  def variant_column
+    {
+      header: :variant,
+      data: ->(stock_item) do
+        content_tag(:div, class: "space-y-0.5") do
+          safe_join(
+            stock_item.variant.option_values.sort_by(&:option_type_name).map do |option_value|
+              render(component('ui/badge').new(name: "#{option_value.option_type_presentation}: #{option_value.presentation}"))
+            end
+          )
+        end
+      end
+    }
+  end
+
+  def stock_location_column
+    {
+      header: :stock_location,
+      data: ->(stock_item) { stock_item.stock_location.name },
+    }
+  end
+
+  # Cache the stock movement counts to avoid N+1 queries
+  def stock_movement_counts
+    @stock_movement_counts ||= Spree::StockMovement.where(stock_item_id: @page.records.ids).group(:stock_item_id).count
+  end
+
+  def stock_movements_column
+    {
+      header: :stock_movements,
+      data: -> do
+        count = stock_movement_counts[_1.id] || 0
+
+        link_to(
+          "#{count} #{Spree::StockMovement.model_name.human(count: count).downcase}",
+          spree.admin_stock_location_stock_movements_path(
+            _1.stock_location.id,
+            q: { variant_sku_eq: _1.variant.sku },
+          ),
+          class: 'body-link'
+        )
+      end
+    }
+  end
+
+  def back_orderable_column
+    {
+      header: :back_orderable,
+      data: ->(stock_item) do
+        stock_item.backorderable? ? component('ui/badge').yes : component('ui/badge').no
+      end
+    }
+  end
+
+  def count_on_hand_column
+    {
+      header: :count_on_hand,
+      data: ->(stock_item) do
+        content_tag :div, stock_item.count_on_hand
+      end
+    }
+  end
+
+  def permitted_query_params
+    return params[:q].permit! if params[:q].respond_to?(:permit)
+    {}
+  end
+end

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

@@ -0,0 +1,10 @@
+en:
+  filters:
+    stock_locations: Stock Locations
+    variants: Variants
+  scopes:
+    all_stock_items: All
+    back_orderable: Back Orderable
+    out_of_stock: Out Of Stock
+    low_stock: Low Stock
+    in_stock: In Stock