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.

Open source tax rates management (#12421)

Łukasz Adamczykcc68ea7f0404
diff --git a/admin/app/controllers/spree/admin/tax_rates_controller.rb b/admin/app/controllers/spree/admin/tax_rates_controller.rb
new file mode 100644
index 0000000000..e227aa3a51
--- /dev/null
+++ b/admin/app/controllers/spree/admin/tax_rates_controller.rb
@@ -0,0 +1,20 @@
+module Spree
+ module Admin
+ class TaxRatesController < ResourceController
+ before_action :load_data
+ before_action :set_defaults, only: :new
+
+ private
+
+ def set_defaults
+ @object.calculator_type = 'Spree::Calculator::DefaultTax'
+ end
+
+ def load_data
+ @available_zones = Spree::Zone.order(:name)
+ @available_categories = Spree::TaxCategory.order(:name)
+ @calculators = Spree::TaxRate.calculators.sort_by(&:name)
+ end
+ end
+ end
+end
diff --git a/admin/app/views/spree/admin/tax_rates/_form.html.erb b/admin/app/views/spree/admin/tax_rates/_form.html.erb
new file mode 100644
index 0000000000..a061e0a84f
--- /dev/null
+++ b/admin/app/views/spree/admin/tax_rates/_form.html.erb
@@ -0,0 +1,48 @@
+<div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title">
+ <%= Spree.t(:general_settings) %>
+ </h5>
+ </div>
+
+ <div class="card-body">
+ <div class="row">
+ <div class="col-12 col-lg-6">
+ <div class="form-group">
+ <%= f.label :name, Spree.t(:name) %>
+ <%= f.text_field :name, class: 'form-control', required: true %>
+ <%= f.error_message_on :name %>
+ </div>
+ <div class="form-group">
+ <%= f.label :amount, Spree.t(:rate) %>
+ <%= f.number_field :amount, class: 'form-control', min: 0, step: 0.0001, required: true %>
+ <%= f.error_message_on :amount %>
+ <small class="form-text text-muted">
+ <%= Spree.t(:tax_rate_amount_explanation) %>
+ </small>
+ </div>
+ <div class="custom-control custom-checkbox mb-3">
+ <%= f.check_box :included_in_price, class: 'custom-control-input' %>
+ <%= f.label :included_in_price, class: 'custom-control-label' %>
+ </div>
+ </div>
+
+ <div class="col-12 col-lg-6">
+ <div class="form-group">
+ <%= f.label :zone_id, Spree.t(:zone) %>
+ <%= f.collection_select(:zone_id, @available_zones, :id, :name, {}, { class: 'custom-select' }) %>
+ </div>
+ <div class="form-group">
+ <%= f.label :tax_category_id, Spree.t(:tax_category) %>
+ <%= f.collection_select(:tax_category_id, @available_categories,:id, :name, {}, { class: 'custom-select' }) %>
+ </div>
+ <div class="custom-control custom-checkbox">
+ <%= f.check_box :show_rate_in_label, class: 'custom-control-input' %>
+ <%= f.label :show_rate_in_label, class: 'custom-control-label' %>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+<%= render 'spree/admin/shared/calculator_fields', f: f %>
diff --git a/admin/app/views/spree/admin/tax_rates/_tax_rate.html.erb b/admin/app/views/spree/admin/tax_rates/_tax_rate.html.erb
new file mode 100644
index 0000000000..c2b3d37bfb
--- /dev/null
+++ b/admin/app/views/spree/admin/tax_rates/_tax_rate.html.erb
@@ -0,0 +1,15 @@
+<tr id="<%= spree_dom_id tax_rate %>" data-controller="row-link" class="cursor-pointer">
+ <td class="w-25" data-action="click->row-link#openLink"><%= tax_rate.name %></td>
+ <td class="w-15" data-action="click->row-link#openLink">
+ <%= tax_rate.tax_category.try(:name) || Spree.t(:not_available) %>
+ </td>
+ <td class="w-15" data-action="click->row-link#openLink">
+ <%= tax_rate.zone.try(:name) || Spree.t(:not_available) %>
+ </td>
+ <td class="w-15" data-action="click->row-link#openLink"><%= number_to_percentage(tax_rate.amount * 100) %></td>
+ <td class="w-10" data-action="click->row-link#openLink"><%= active_badge(tax_rate.included_in_price?) %></td>
+ <td class="w-10" data-action="click->row-link#openLink"><%= active_badge(tax_rate.show_rate_in_label?) %></td>
+ <td class="w-10 actions">
+ <%= link_to_edit(tax_rate, data: { row_link_target: 'link' }) if can? :edit, tax_rate %>
+ </td>
+</tr>
diff --git a/admin/app/views/spree/admin/tax_rates/edit.html.erb b/admin/app/views/spree/admin/tax_rates/edit.html.erb
new file mode 100644
index 0000000000..1884f60e11
--- /dev/null
+++ b/admin/app/views/spree/admin/tax_rates/edit.html.erb
@@ -0,0 +1,11 @@
+<% content_for :page_title do %>
+ <%= page_header_back_button spree.admin_tax_rates_path %>
+ <%= @tax_rate.name %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @tax_rate } %>
+
+<%= form_for [:admin, @tax_rate] do |f| %>
+ <%= render 'form', f: f %>
+ <%= render 'spree/admin/shared/edit_resource_links', f: f %>
+<% end %>
diff --git a/admin/app/views/spree/admin/tax_rates/index.html.erb b/admin/app/views/spree/admin/tax_rates/index.html.erb
new file mode 100644
index 0000000000..51ec555071
--- /dev/null
+++ b/admin/app/views/spree/admin/tax_rates/index.html.erb
@@ -0,0 +1,32 @@
+<% content_for :page_title do %>
+ <%= Spree.t(:taxes) %>
+<% end %>
+
+<% content_for :page_actions do %>
+ <%= button_link_to Spree.t(:new_tax_rate), new_object_url, class: "btn-primary", icon: 'plus' %>
+<% end if can? :create, Spree::TaxRate %>
+
+<%= render partial: 'spree/admin/shared/tax_nav' %>
+
+<% if @tax_rates.any? %>
+ <div class="table-responsive card-lg p-0">
+ <table class="table" id='listing_tax_rates'>
+ <thead class="text-muted">
+ <tr data-hook="rate_header">
+ <th><%= Spree.t(:name) %></th>
+ <th><%= Spree.t(:tax_category) %></th>
+ <th><%= Spree.t(:zone) %></th>
+ <th><%= Spree.t(:amount) %></th>
+ <th><%= Spree.t(:included_in_price) %></th>
+ <th><%= Spree.t(:show_rate_in_label) %></th>
+ <th></th>
+ </tr>
+ </thead>
+ <tbody>
+ <%= render partial: 'spree/admin/tax_rates/tax_rate', collection: @tax_rates, cached: spree_base_cache_scope %>
+ </tbody>
+ </table>
+ </div>
+<% else %>
+ <%= render 'spree/admin/shared/no_resource_found' %>
+<% end %>
diff --git a/admin/app/views/spree/admin/tax_rates/new.html.erb b/admin/app/views/spree/admin/tax_rates/new.html.erb
new file mode 100644
index 0000000000..70431d0a34
--- /dev/null
+++ b/admin/app/views/spree/admin/tax_rates/new.html.erb
@@ -0,0 +1,14 @@
+<% content_for :page_title do %>
+ <%= page_header_back_button spree.admin_tax_rates_path %>
+ <%= Spree.t(:new_tax_rate) %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @tax_rate } %>
+
+<%= form_for [:admin, @tax_rate] do |f| %>
+ <fieldset>
+ <%= render 'form', f: f %>
+
+ <%= render 'spree/admin/shared/new_resource_links' %>
+ </fieldset>
+<% end %>
diff --git a/admin/spec/controllers/spree/admin/tax_rates_controller_spec.rb b/admin/spec/controllers/spree/admin/tax_rates_controller_spec.rb
new file mode 100644
index 0000000000..51fa209e5b
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/tax_rates_controller_spec.rb
@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::TaxRatesController, type: :controller do
+ stub_authorization!
+ render_views
+
+ describe 'GET #index' do
+ let!(:tax_rates) { create_list(:tax_rate, 3) }
+
+ it 'renders the list of tax rates' do
+ get :index
+
+ expect(response).to be_successful
+ expect(response).to render_template(:index)
+
+ expect(assigns(:tax_rates)).to contain_exactly(*tax_rates)
+ end
+ end
+
+ describe 'GET #new' do
+ it 'renders the new tax rate form' do
+ get :new
+
+ expect(response).to be_successful
+ expect(response).to render_template(:new)
+ end
+ end
+
+ describe 'POST #create' do
+ let!(:zone) { create(:zone) }
+ let!(:tax_category) { create(:tax_category) }
+ let!(:calculator) { Spree::TaxRate.calculators.first }
+
+ let(:tax_rate_params) do
+ {
+ name: 'General Tax',
+ amount: 0.1, zone_id: zone.id,
+ tax_category_id: tax_category.id,
+ calculator_type: calculator.name
+ }
+ end
+
+ let(:tax_rate) { Spree::TaxRate.last }
+
+ it 'creates a new tax rate' do
+ post :create, params: { tax_rate: tax_rate_params }
+
+ expect(response).to redirect_to(spree.edit_admin_tax_rate_path(tax_rate))
+
+ expect(tax_rate).to be_persisted
+ expect(tax_rate.name).to eq('General Tax')
+ expect(tax_rate.amount).to eq(0.1)
+ expect(tax_rate.zone).to eq(zone)
+ expect(tax_rate.tax_category).to eq(tax_category)
+ expect(tax_rate.calculator_type).to eq(calculator.name)
+ end
+ end
+
+ describe 'GET #edit' do
+ let!(:tax_rate) { create(:tax_rate) }
+
+ it 'renders the edit tax rate form' do
+ get :edit, params: { id: tax_rate.id }
+
+ expect(response).to be_successful
+ expect(response).to render_template(:edit)
+ end
+ end
+
+ describe 'PUT #update' do
+ let!(:tax_rate) { create(:tax_rate, name: 'General Tax') }
+
+ it 'updates the tax rate' do
+ put :update, params: { id: tax_rate.id, tax_rate: { name: 'EU Tax' } }
+
+ expect(response).to redirect_to(spree.edit_admin_tax_rate_path(tax_rate))
+ expect(tax_rate.reload.name).to eq('EU Tax')
+ end
+ end
+
+ describe 'DELETE #destroy' do
+ let!(:tax_rate) { create(:tax_rate) }
+
+ it 'deletes the tax rate' do
+ delete :destroy, params: { id: tax_rate.id }
+
+ expect(response).to redirect_to(spree.admin_tax_rates_path)
+ expect(tax_rate.reload).to be_deleted
+ end
+ end
+end