Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Feature: admin stock movements view (#13876)

Damian Legawiecc6d9c02c6496
diff --git a/spree/admin/app/controllers/spree/admin/stock_movements_controller.rb b/spree/admin/app/controllers/spree/admin/stock_movements_controller.rb
new file mode 100644
index 0000000000..0bea326740
--- /dev/null
+++ b/spree/admin/app/controllers/spree/admin/stock_movements_controller.rb
@@ -0,0 +1,37 @@
+module Spree
+ module Admin
+ class StockMovementsController < ResourceController
+ include ProductsBreadcrumbConcern
+ include TableConcern
+
+ before_action :add_breadcrumbs
+
+ private
+
+ def collection_default_sort
+ 'created_at desc'
+ end
+
+ def scope
+ super.joins(stock_item: [:variant, :stock_location]).
+ merge(current_store.variants.eligible).
+ reorder('')
+ end
+
+ def collection_includes
+ {
+ stock_item: {
+ stock_location: [],
+ variant: [option_values: :option_type, product: [variants: [:images], master: [:images]], images: []]
+ },
+ originator: []
+ }
+ end
+
+ def add_breadcrumbs
+ add_breadcrumb Spree.t(:stock), spree.admin_stock_items_path
+ add_breadcrumb Spree.t(:stock_movements), spree.admin_stock_movements_path
+ end
+ end
+ end
+end
diff --git a/spree/admin/app/views/spree/admin/stock_movements/index.html.erb b/spree/admin/app/views/spree/admin/stock_movements/index.html.erb
new file mode 100644
index 0000000000..a5cf0d3405
--- /dev/null
+++ b/spree/admin/app/views/spree/admin/stock_movements/index.html.erb
@@ -0,0 +1,15 @@
+<% content_for :page_title do %>
+ <%= Spree.t(:stock) %>
+<% end %>
+
+<% content_for :page_tabs do %>
+ <%= render "spree/admin/shared/stock_nav" %>
+<% end %>
+
+<% content_for :page_actions do %>
+ <%= render_admin_partials(:stock_movements_actions_partials) %>
+<% end %>
+
+<%= render_admin_partials(:stock_movements_header_partials) %>
+
+<%= render_table @collection, :stock_movements, edit_object_url: nil %>
diff --git a/spree/admin/app/views/spree/admin/tables/columns/_stock_movement_originator.html.erb b/spree/admin/app/views/spree/admin/tables/columns/_stock_movement_originator.html.erb
new file mode 100644
index 0000000000..ee820e7a89
--- /dev/null
+++ b/spree/admin/app/views/spree/admin/tables/columns/_stock_movement_originator.html.erb
@@ -0,0 +1,28 @@
+<%# locals: (record:, column:, value:) %>
+<% originator = record.originator %>
+<% if originator.is_a?(Spree::StockTransfer) %>
+ <%= originator.class.model_name.human %>
+ <% if can?(:show, originator) %>
+ <%= link_to originator.number, spree.admin_stock_transfer_path(originator), data: { turbo_frame: '_top' } %>
+ <% else %>
+ <%= originator.number %>
+ <% end %>
+<% elsif originator.is_a?(Spree::Shipment) %>
+ <%= originator.class.model_name.human %>
+ <% if can?(:show, originator.order) %>
+ <%= link_to originator.number, spree.edit_admin_order_path(originator.order), data: { turbo_frame: '_top' } %>
+ <% else %>
+ <%= originator.number %>
+ <% end %>
+<% elsif originator.is_a?(Spree::ReturnAuthorization) %>
+ <%= originator.class.model_name.human %>
+ <% if can?(:show, originator.order) %>
+ <%= link_to originator.number, spree.edit_admin_order_path(originator.order), data: { turbo_frame: '_top' } %>
+ <% else %>
+ <%= originator.number %>
+ <% end %>
+<% elsif originator.present? %>
+ <%= originator.class.model_name.human %>
+<% else %>
+ <span class="text-gray-400"><%= Spree.t(:manual) %></span>
+<% end %>
diff --git a/spree/admin/config/initializers/spree_admin_navigation.rb b/spree/admin/config/initializers/spree_admin_navigation.rb
index 9927de2892..68989b71b9 100644
--- a/spree/admin/config/initializers/spree_admin_navigation.rb
+++ b/spree/admin/config/initializers/spree_admin_navigation.rb
@@ -107,8 +107,8 @@ Rails.application.config.after_initialize do
label: :stock,
url: :admin_stock_items_path,
position: 20,
- active: -> { %w[stock_items stock_transfers].include?(controller_name) },
- if: -> { can?(:manage, Spree::StockItem) || can?(:manage, Spree::StockTransfer) }
+ active: -> { %w[stock_items stock_movements stock_transfers].include?(controller_name) },
+ if: -> { can?(:manage, Spree::StockItem) || can?(:manage, Spree::StockMovement) || can?(:manage, Spree::StockTransfer) }
# Translations
products.add :translations,
@@ -419,10 +419,17 @@ Rails.application.config.after_initialize do
active: -> { controller_name == 'stock_items' },
if: -> { can?(:manage, Spree::StockItem) }
+ stock_tabs_nav.add :stock_movements,
+ label: :stock_movements,
+ url: :admin_stock_movements_path,
+ position: 20,
+ active: -> { controller_name == 'stock_movements' },
+ if: -> { can?(:manage, Spree::StockMovement) }
+
stock_tabs_nav.add :stock_transfers,
label: :stock_transfers,
url: :admin_stock_transfers_path,
- position: 20,
+ position: 30,
active: -> { controller_name == 'stock_transfers' },
if: -> { can?(:manage, Spree::StockTransfer) }
diff --git a/spree/admin/config/initializers/spree_admin_tables.rb b/spree/admin/config/initializers/spree_admin_tables.rb
index c98742c609..8185d0bec8 100644
--- a/spree/admin/config/initializers/spree_admin_tables.rb
+++ b/spree/admin/config/initializers/spree_admin_tables.rb
@@ -933,6 +933,69 @@ Rails.application.config.after_initialize do
default: false,
position: 70
+ # Register Stock Movements table
+ Spree.admin.tables.register(:stock_movements, model_class: Spree::StockMovement, search_param: :stock_item_variant_product_name_cont, row_actions: false, new_resource: false)
+
+ Spree.admin.tables.stock_movements.add :variant,
+ label: :variant,
+ type: :custom,
+ sortable: false,
+ filterable: true,
+ default: true,
+ position: 10,
+ ransack_attribute: 'stock_item_variant_product_name',
+ partial: 'spree/admin/variants/variant',
+ partial_locals: ->(record) { { variant: record.variant } }
+
+ Spree.admin.tables.stock_movements.add :stock_location,
+ label: :stock_location,
+ type: :custom,
+ filter_type: :autocomplete,
+ sortable: false,
+ filterable: true,
+ default: true,
+ position: 20,
+ ransack_attribute: 'stock_item_stock_location_id',
+ operators: %i[eq],
+ search_url: ->(view_context) { view_context.spree.admin_stock_locations_select_options_path(format: :json) },
+ partial: 'spree/admin/tables/columns/stock_item_location',
+ partial_locals: ->(record) { { record: record.stock_item } }
+
+ Spree.admin.tables.stock_movements.add :quantity,
+ label: :quantity,
+ type: :number,
+ sortable: true,
+ filterable: false,
+ default: true,
+ position: 30
+
+ Spree.admin.tables.stock_movements.add :originator,
+ label: :originator,
+ type: :custom,
+ filter_type: :select,
+ sortable: false,
+ filterable: true,
+ default: true,
+ position: 40,
+ ransack_attribute: 'originator_type',
+ operators: %i[eq],
+ value_options: -> {
+ [
+ { value: 'Spree::Shipment', label: Spree::Shipment.model_name.human },
+ { value: 'Spree::StockTransfer', label: Spree::StockTransfer.model_name.human },
+ { value: 'Spree::ReturnAuthorization', label: Spree::ReturnAuthorization.model_name.human }
+ ]
+ },
+ partial: 'spree/admin/tables/columns/stock_movement_originator'
+
+ Spree.admin.tables.stock_movements.add :created_at,
+ label: :created_at,
+ type: :datetime,
+ sortable: true,
+ filterable: true,
+ default: true,
+ position: 50
+
# Register Metafield Definitions table
Spree.admin.tables.register(:metafield_definitions, model_class: Spree::MetafieldDefinition, search_param: :search, row_actions: true)
diff --git a/spree/admin/config/routes.rb b/spree/admin/config/routes.rb
index 2e7bfd0092..14d08121dc 100644
--- a/spree/admin/config/routes.rb
+++ b/spree/admin/config/routes.rb
@@ -31,6 +31,7 @@ Spree::Core::Engine.add_routes do
resources :product_translations, only: [:index]
# stock
resources :stock_items, only: [:index, :update, :destroy]
+ resources :stock_movements, only: [:index]
resources :stock_transfers, except: [:edit, :update]
# price lists
resources :price_lists do
diff --git a/spree/admin/lib/spree/admin/engine.rb b/spree/admin/lib/spree/admin/engine.rb
index 71d1d240a5..42359fc0b2 100644
--- a/spree/admin/lib/spree/admin/engine.rb
+++ b/spree/admin/lib/spree/admin/engine.rb
@@ -96,6 +96,8 @@ module Spree
:stock_items_header_partials,
:stock_locations_actions_partials,
:stock_locations_header_partials,
+ :stock_movements_actions_partials,
+ :stock_movements_header_partials,
:stock_nav_partials,
:stock_transfers_actions_partials,
:stock_transfers_filters_partials,
diff --git a/spree/admin/spec/controllers/spree/admin/stock_movements_controller_spec.rb b/spree/admin/spec/controllers/spree/admin/stock_movements_controller_spec.rb
new file mode 100644
index 0000000000..4113c52c17
--- /dev/null
+++ b/spree/admin/spec/controllers/spree/admin/stock_movements_controller_spec.rb
@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::StockMovementsController, type: :controller do
+ stub_authorization!
+ render_views
+
+ describe '#index' do
+ let!(:stock_location_1) { create(:stock_location, name: 'Stock location 1') }
+ let!(:stock_location_2) { create(:stock_location, name: 'Stock location 2') }
+
+ let!(:variant_1) { create(:variant, create_stock: false, sku: 'shirt-1', product: create(:base_product, name: 'Shirt')) }
+ let!(:stock_item_1) { create(:stock_item, variant: variant_1, stock_location: stock_location_1) }
+
+ let!(:variant_2) { create(:variant, create_stock: false, sku: 'shoes-2', product: create(:base_product, name: 'Shoes')) }
+ let!(:stock_item_2) { create(:stock_item, variant: variant_2, stock_location: stock_location_2) }
+
+ let!(:movement_1) { create(:stock_movement, stock_item: stock_item_1, quantity: 10, action: 'received') }
+ let!(:movement_2) { create(:stock_movement, stock_item: stock_item_2, quantity: -2, action: 'sold') }
+
+ subject(:index) { get :index, params: params }
+
+ let(:params) { {} }
+
+ it 'lists all stock movements' do
+ index
+ expect(response).to be_ok
+
+ expect(assigns[:collection]).to contain_exactly(movement_1, movement_2)
+ end
+
+ describe 'search' do
+ let(:params) do
+ {
+ q: {
+ stock_item_variant_product_name_cont: 'shoe'
+ }
+ }
+ end
+
+ it 'lists stock movements searched by the variant name' do
+ index
+ expect(response).to be_ok
+
+ expect(assigns[:collection]).to contain_exactly(movement_2)
+ end
+ end
+
+ describe 'filters' do
+ let(:params) { { q: q } }
+
+ context 'when filtering by stock location' do
+ let(:q) { { stock_item_stock_location_id_eq: stock_location_1.id } }
+
+ it 'lists stock movements filtered by the stock location' do
+ index
+ expect(response).to be_ok
+
+ expect(assigns[:collection]).to contain_exactly(movement_1)
+ end
+ end
+ end
+ end
+end
diff --git a/spree/core/app/models/spree/stock_movement.rb b/spree/core/app/models/spree/stock_movement.rb
index d6163ba85d..d4fe03502d 100644
--- a/spree/core/app/models/spree/stock_movement.rb
+++ b/spree/core/app/models/spree/stock_movement.rb
@@ -31,7 +31,8 @@ module Spree
delegate :variant, :variant_id, to: :stock_item, allow_nil: true
delegate :product, to: :variant
- self.whitelisted_ransackable_attributes = ['quantity']
+ self.whitelisted_ransackable_attributes = %w[quantity action created_at stock_item_id originator_type]
+ self.whitelisted_ransackable_associations = %w[stock_item]
def readonly?
persisted?
diff --git a/spree/core/spec/models/spree/stock_movement_spec.rb b/spree/core/spec/models/spree/stock_movement_spec.rb
index 37e953aabc..9478e93e5e 100644
--- a/spree/core/spec/models/spree/stock_movement_spec.rb
+++ b/spree/core/spec/models/spree/stock_movement_spec.rb
@@ -56,7 +56,7 @@ describe Spree::StockMovement, type: :model do
describe 'whitelisted ransackable attributes' do
it 'returns amount attribute' do
- expect(Spree::StockMovement.whitelisted_ransackable_attributes).to eq(['quantity'])
+ expect(Spree::StockMovement.whitelisted_ransackable_attributes).to eq(%w[quantity action created_at stock_item_id originator_type])
end
end