From 403088ed53e2564b06d0e4a56edc321635350dd1 Mon Sep 17 00:00:00 2001 From: Regene27 Date: Mon, 29 Jan 2024 11:59:19 +0700 Subject: [PATCH] Close #1037 Add Quantity to Customer and Add Query or Create Variant in Subscription --- .../spree/billing/subscriptions_controller.rb | 38 +++++++ .../spree_cm_commissioner/subscription.rb | 3 + .../variant_decorator.rb | 2 + .../spree_cm_commissioner/sku_generator.rb | 31 ++++++ .../spree_cm_commissioner/variant_checker.rb | 30 +++++ .../spree_cm_commissioner/variant_creator.rb | 35 ++++++ .../spree/billing/customers/_form.html.erb | 5 + .../spree/billing/shared/_invoice.html.erb | 16 ++- .../billing/subscriptions/_form.html.erb | 104 +++++++++++++++--- .../subscriptions/_variant_form.html.erb | 33 ++++++ config/locales/en.yml | 1 + config/routes.rb | 10 +- ...0119110257_add_quantity_to_cm_customers.rb | 5 + .../sku_generator_spec.rb | 17 +++ .../variant_checker_spec.rb | 34 ++++++ .../variant_creator_spec.rb | 23 ++++ 16 files changed, 369 insertions(+), 18 deletions(-) create mode 100644 app/services/spree_cm_commissioner/sku_generator.rb create mode 100644 app/services/spree_cm_commissioner/variant_checker.rb create mode 100644 app/services/spree_cm_commissioner/variant_creator.rb create mode 100644 app/views/spree/billing/subscriptions/_variant_form.html.erb create mode 100644 db/migrate/20240119110257_add_quantity_to_cm_customers.rb create mode 100644 spec/services/spree_cm_commissioner/sku_generator_spec.rb create mode 100644 spec/services/spree_cm_commissioner/variant_checker_spec.rb create mode 100644 spec/services/spree_cm_commissioner/variant_creator_spec.rb diff --git a/app/controllers/spree/billing/subscriptions_controller.rb b/app/controllers/spree/billing/subscriptions_controller.rb index 488d304b0..35e8ec339 100644 --- a/app/controllers/spree/billing/subscriptions_controller.rb +++ b/app/controllers/spree/billing/subscriptions_controller.rb @@ -3,6 +3,27 @@ module Billing class SubscriptionsController < Spree::Billing::BaseController before_action :load_customer before_action :load_subscription, if: -> { member_action? } + before_action :load_product, only: %i[create] + + def variant_form + load_product + @variant = @product.variants.build + + render partial: 'variant_form' + end + + def create + find_or_create_variant + + @subscription = @variant.subscriptions.new(subscription_params.merge(variant_id: @variant.id)) + + if @subscription.save + flash[:success] = flash_message_for(@subscription, :successfully_created) + else + flash[:error] = flash_message_for(@subscription, :not_created) + end + redirect_to billing_customer_subscriptions_url(@customer) + end protected @@ -13,6 +34,11 @@ def collection @collection = @search.result.page(page).per(per_page) end + def load_product + product_id = params[:product_id] || params.dig(:variant, :product_id) + @product = Spree::Product.find(product_id) + end + def load_customer customer end @@ -21,6 +47,10 @@ def load_subscription @subscription = @object end + def find_or_create_variant + @variant = SpreeCmCommissioner::VariantChecker.new(@product, variant_params, current_vendor).find_or_create_variant + end + def customer @customer ||= SpreeCmCommissioner::Customer.find(params[:customer_id]) end @@ -39,6 +69,14 @@ def object_name def collection_url(options = {}) billing_customer_subscriptions_url(options) end + + def variant_params + params.require(:variant).permit(:product_id, :sku, :price, option_value_ids: []) + end + + def subscription_params + params.require(:spree_cm_commissioner_subscription).permit(:start_date, :customer_id, :status) + end end end end diff --git a/app/models/spree_cm_commissioner/subscription.rb b/app/models/spree_cm_commissioner/subscription.rb index 159bda4cc..dc148ca1c 100644 --- a/app/models/spree_cm_commissioner/subscription.rb +++ b/app/models/spree_cm_commissioner/subscription.rb @@ -6,6 +6,7 @@ class Subscription < SpreeCmCommissioner::Base belongs_to :variant, class_name: 'Spree::Variant' belongs_to :customer, class_name: 'SpreeCmCommissioner::Customer' + belongs_to :product, class_name: 'Spree::Product' has_many :orders, -> { order(:created_at) }, class_name: 'Spree::Order', dependent: :nullify has_many :line_items, through: :orders, class_name: 'Spree::LineItem' @@ -23,6 +24,8 @@ class Subscription < SpreeCmCommissioner::Base after_create :create_order after_commit :update_customer_active_subscriptions_count + accepts_nested_attributes_for :variant + def create_order SpreeCmCommissioner::SubscribedOrderCreator.call(subscription: self) end diff --git a/app/models/spree_cm_commissioner/variant_decorator.rb b/app/models/spree_cm_commissioner/variant_decorator.rb index 754f5afae..8eb1d3396 100644 --- a/app/models/spree_cm_commissioner/variant_decorator.rb +++ b/app/models/spree_cm_commissioner/variant_decorator.rb @@ -8,6 +8,8 @@ def self.prepended(base) base.validate :validate_option_types base.scope :subscribable, -> { active.joins(:product).where(product: { subscribable: true, status: :active }) } + + base.has_many :subscriptions, class_name: 'SpreeCmCommissioner::Subscription', dependent: :destroy end def selected_option_value_ids diff --git a/app/services/spree_cm_commissioner/sku_generator.rb b/app/services/spree_cm_commissioner/sku_generator.rb new file mode 100644 index 000000000..d58c6ee9c --- /dev/null +++ b/app/services/spree_cm_commissioner/sku_generator.rb @@ -0,0 +1,31 @@ +module SpreeCmCommissioner + class SkuGenerator + def initialize(product, variant_params) + @product = product + @variant_params = variant_params + end + + def generate_sku + load_product + + return if @variant_params.nil? || @variant_params.blank? + + option_values = @variant_params[:option_value_ids].map { |id| Spree::OptionValue.find(id) } + sku_parts = [@product.name] + + option_values.each do |option_value| + sku_parts << "#{option_value.option_type.name}-#{option_value.name}" + end + + sku_parts << "price-#{@variant_params[:price]}" + + sku_parts.join('-').gsub(' ', '-').downcase + end + + private + + def load_product + @product ||= Spree::Product.find(@variant_params[:product_id]) + end + end +end diff --git a/app/services/spree_cm_commissioner/variant_checker.rb b/app/services/spree_cm_commissioner/variant_checker.rb new file mode 100644 index 000000000..059a3ebc7 --- /dev/null +++ b/app/services/spree_cm_commissioner/variant_checker.rb @@ -0,0 +1,30 @@ +module SpreeCmCommissioner + class VariantChecker + attr_reader :variant + + def initialize(product, variant_params, current_vendor) + @product = product + @variant_params = variant_params + @current_vendor = current_vendor + end + + def find_or_create_variant + find_variant_by_sku || create_variant + end + + def find_variant_by_sku + @variant = @product.variants.find_by(sku: variant_sku) + end + + def create_variant + variant_creator = SpreeCmCommissioner::VariantCreator.new(@product, @variant_params, @current_vendor) + variant_creator.create_variant + @variant = variant_creator.variant + end + + def variant_sku + sku_generator = SpreeCmCommissioner::SkuGenerator.new(@product, @variant_params) + sku_generator.generate_sku + end + end +end diff --git a/app/services/spree_cm_commissioner/variant_creator.rb b/app/services/spree_cm_commissioner/variant_creator.rb new file mode 100644 index 000000000..5c27c10a7 --- /dev/null +++ b/app/services/spree_cm_commissioner/variant_creator.rb @@ -0,0 +1,35 @@ +module SpreeCmCommissioner + class VariantCreator + attr_reader :variant + + def initialize(product, variant_params, current_vendor) + @product = product + @variant_params = variant_params + @current_vendor = current_vendor + end + + def create_variant + @variant = @product.variants.build + generate_sku + set_variant_attributes + save_variant + end + + private + + def generate_sku + sku_generator = SpreeCmCommissioner::SkuGenerator.new(@product, @variant_params) + @variant.sku = sku_generator.generate_sku + end + + def set_variant_attributes + @variant.option_value_ids = @variant_params[:option_value_ids] + @variant.price = @variant_params[:price] + @variant.stock_items.new(stock_location_id: @current_vendor.id, count_on_hand: 1) + end + + def save_variant + @variant.save + end + end +end diff --git a/app/views/spree/billing/customers/_form.html.erb b/app/views/spree/billing/customers/_form.html.erb index 8f8f5cc9e..e0a695365 100644 --- a/app/views/spree/billing/customers/_form.html.erb +++ b/app/views/spree/billing/customers/_form.html.erb @@ -31,5 +31,10 @@ <%= f.collection_select(:taxon_id, Spree::Taxon.where(depth: 1), :id, :name, { include_blank: Spree.t('match_choices.none') }, { class: 'select2', required: true })%> <%= f.error_message_on :taxon_id %> <% end %> + <%= f.field_container :quantity do %> + <%= f.label :quantity, I18n.t('activerecord.attributes.spree/order.quantity') %> + <%= f.number_field :quantity, class: 'form-control', required: true %> + <%= f.error_message_on :quantity %> + <% end %> diff --git a/app/views/spree/billing/shared/_invoice.html.erb b/app/views/spree/billing/shared/_invoice.html.erb index b5ad7c154..e508ad06a 100644 --- a/app/views/spree/billing/shared/_invoice.html.erb +++ b/app/views/spree/billing/shared/_invoice.html.erb @@ -8,8 +8,10 @@ @email = @vendor.notification_email @note = @vendor.note + @quantity = @customer.quantity @product = @invoice.order.line_items.first.variant.sku @price = @invoice.order.line_items.first.display_price + @total_price = @price.to_s.gsub(/[^\d.]/, '').to_d * @quantity @total = @invoice.order.display_total @from_date = @invoice.order.line_items.first.to_date.strftime("%B %Y") @date = @invoice.date.strftime('%Y-%m-%d') @@ -92,8 +94,10 @@ ល.រ​​​ / N បរិយាយ / Description + ចំនួន / Quantity ប្រចាំខែ / Month ទឹកប្រាក់​ / Amount + ទឹកប្រាក់​សរុប / Total Amount @@ -104,6 +108,11 @@
  • <%= @product %>
    • + + + + + + <% @order.adjustments.each do |adjustment| %> @@ -142,7 +156,7 @@

    ទឹកប្រាក់​ត្រូវទូទាត់​​ / Total Amount due

    - <%= @total %> + <%= @total_price %>

    diff --git a/app/views/spree/billing/subscriptions/_form.html.erb b/app/views/spree/billing/subscriptions/_form.html.erb index b8d6267f7..6dce75cb9 100644 --- a/app/views/spree/billing/subscriptions/_form.html.erb +++ b/app/views/spree/billing/subscriptions/_form.html.erb @@ -1,22 +1,94 @@
    -
    +
    <%= f.hidden_field :customer_id, value: @customer.id %> - <%= f.field_container :variant_id do %> - <%= f.label :variant, Spree.t(:variant) %> - <%= f.collection_select(:variant_id, @customer.subscribable_variants, :id, :display_variant, { include_blank: false }, { class: 'select2' ,disabled: @subscription.persisted?}) %> - <%= f.error_message_on :product_id %> - <% end %> - <%= f.field_container :start_date do %> - <%= f.label :start_date, Spree.t(:start_date) %> - <%= f.date_field :start_date, class: 'form-control', disabled: @subscription.persisted? %> - <%= f.error_message_on :start_date %> - <% end %> - <% if @subscription.id.present? %> - <%= f.field_container :status do %> - <%= f.label :status, Spree.t(:status) %> - <%= f.select :status, SpreeCmCommissioner::Subscription.statuses.keys, {}, class: 'select2' %> - <%= f.error_message_on :status %> + +
    + <%= f.field_container :product do %> + <%= f.label :product, Spree:t(:product) %> + <%= f.select :product, options_for_select(Spree::Product.joins(:taxons) + .where(spree_taxons: { id: @customer.taxon_id }) + .map{ |product| [product.name, product.id] }), + if @subscription.persisted? + { placeholder: @subscription.variant.product.name } + else + { include_blank: true } + end, + { class: "select2-clear", disabled: @subscription.persisted? } %> + <%= f.error_message_on :product %> <% end %> +
    + + <% if @subscription.id.present? %> +
    + <%= f.field_container :variant_id do %> + <%= f.label :variant_id, Spree:t(:variant) %> + <%= f.select :variant_id, options_for_select(Spree::Variant.joins(:subscriptions).where(cm_subscriptions: { customer_id: @customer.id }) + .map{ |variant| [variant.sku, variant.id] }), + if @subscription.persisted? + { placeholder: @subscription.variant.sku } + else + { include_blank: true } + end, + { class: "select2-clear", disabled: @subscription.persisted? } %> + <%= f.error_message_on :product %> + <% end %> +
    + <% else %> +
    +
    <% end %> + +
    + <%= f.field_container :start_date do %> + <%= f.label :start_date, Spree.t(:start_date) %> + <%= f.date_field :start_date, class: 'form-control', disabled: @subscription.persisted? %> + <%= f.error_message_on :start_date %> + <% end %> +
    + +
    + <% if @subscription.id.present? %> + <%= f.field_container :status do %> + <%= f.label :status, Spree.t(:status) %> + <%= f.select :status, SpreeCmCommissioner::Subscription.statuses.keys, {}, class: 'select2' %> + <%= f.error_message_on :status %> + <% end %> + <% end %> +
    + + \ No newline at end of file diff --git a/app/views/spree/billing/subscriptions/_variant_form.html.erb b/app/views/spree/billing/subscriptions/_variant_form.html.erb new file mode 100644 index 000000000..594c8ec25 --- /dev/null +++ b/app/views/spree/billing/subscriptions/_variant_form.html.erb @@ -0,0 +1,33 @@ +<%= fields_for @variant do |f| %> +
    +
    +
    <%= Spree.t(:variant) %>
    +
    + <%= f.hidden_field :product_id, value: @product.id %> + +
    +
    +
    +
    + <%= f.label :price, Spree.t(:price) %> + <%= f.text_field :price, value: number_to_currency(@variant.price, unit: ''), class: 'form-control' %> +
    +
    +
    +
    + <% @product.option_types.each do |option_type| %> +
    + <%= label :new_variant, option_type.presentation %> + <% if option_type.name == 'color' %> + <%= f.collection_select 'option_value_ids', option_type.option_values, :id, :name, + { include_blank: true }, { name: 'variant[option_value_ids][]', class: 'select2-clear form-control', id: "option_value_ids-#{option_type.id}" } %> + <% else %> + <%= f.collection_select 'option_value_ids', option_type.option_values, :id, :presentation, + { include_blank: true }, { name: 'variant[option_value_ids][]', class: 'select2-clear form-control', id: "option_value_ids-#{option_type.id}" } %> + <% end %> +
    + <% end %> +
    +
    +
    +<% end %> diff --git a/config/locales/en.yml b/config/locales/en.yml index 590b8f39d..ba28c1164 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -266,6 +266,7 @@ en: type: "Type" select_date: "Select Date" taxon: "Taxon" + quantity: "Quantity" spree/report: cashier: "Cashier" errors: diff --git a/config/routes.rb b/config/routes.rb index ba0197da3..2f9e77943 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -172,7 +172,11 @@ end resources :vendors resources :customers do - resources :subscriptions + resources :subscriptions do + collection do + get :variant_form + end + end resources :addresses end resources :roles @@ -219,6 +223,10 @@ resources :homepage_section_relatable_options end + namespace :billing do + resources :variants, only: %i[index show] + end + namespace :storefront do resource :cart, controller: :cart, only: %i[show create destroy] do patch :restart_checkout_flow diff --git a/db/migrate/20240119110257_add_quantity_to_cm_customers.rb b/db/migrate/20240119110257_add_quantity_to_cm_customers.rb new file mode 100644 index 000000000..77c34a9a4 --- /dev/null +++ b/db/migrate/20240119110257_add_quantity_to_cm_customers.rb @@ -0,0 +1,5 @@ +class AddQuantityToCmCustomers < ActiveRecord::Migration[7.0] + def change + add_column :cm_customers, :quantity, :integer, default: 1, if_not_exists: true + end +end diff --git a/spec/services/spree_cm_commissioner/sku_generator_spec.rb b/spec/services/spree_cm_commissioner/sku_generator_spec.rb new file mode 100644 index 000000000..ca212c56e --- /dev/null +++ b/spec/services/spree_cm_commissioner/sku_generator_spec.rb @@ -0,0 +1,17 @@ +require 'spec_helper' + +RSpec.describe SpreeCmCommissioner::SkuGenerator do + let(:product) { create(:product, name: "Waste Collection") } + let(:option_types) { [create(:option_type, name: "Month"), create(:option_type, name: "Due Date"), create(:option_type, name: "Payment Method")] } + let(:option_values) { [create(:option_value, name: "1", option_type: option_types[0]), create(:option_value, name: "1", option_type: option_types[1]), create(:option_value, name: "pre-paid", option_type: option_types[2])] } + let(:variant_params) { { product_id: product.id, option_value_ids: option_values.map(&:id), price: 10.0 } } + let(:sku_generator) { described_class.new(product, variant_params) } + + describe '.generate_sku' do + it 'returns the generated sku' do + generated_sku = sku_generator.generate_sku + + expect(generated_sku).to eq "waste-collection-month-1-due-date-1-payment-method-pre-paid-price-10.0" + end + end +end diff --git a/spec/services/spree_cm_commissioner/variant_checker_spec.rb b/spec/services/spree_cm_commissioner/variant_checker_spec.rb new file mode 100644 index 000000000..1c4cf3d06 --- /dev/null +++ b/spec/services/spree_cm_commissioner/variant_checker_spec.rb @@ -0,0 +1,34 @@ +require 'spec_helper' + +RSpec.describe SpreeCmCommissioner::VariantChecker do + let!(:product) { create(:product, name: "Island Waste Collection") } + let!(:option_types) { [create(:option_type, name: "Month"), create(:option_type, name: "Due Date"), create(:option_type, name: "Payment Method")] } + let!(:option_values) { [create(:option_value, name: "1", id: 1, option_type: option_types[0]), create(:option_value, name: "1", id: 2, option_type: option_types[1]), create(:option_value, name: "pre-paid", id: 3, option_type: option_types[2])] } + let!(:variant_params) { { product_id: product.id, option_value_ids: option_values.map(&:id), price: 10.0 } } + let!(:current_vendor) { create(:user) } + + describe '#find_or_create_variant' do + context 'when the variant already exists' do + let!(:variant1) { described_class.new(product, variant_params, current_vendor).create_variant } + + it 'returns the existing variant' do + variant_checker = described_class.new(product, variant_params, current_vendor) + variant = variant_checker.find_or_create_variant + + expect(variant).to be_persisted + expect(variant).to eq(variant1) + end + end + + context 'when the variant does not exist' do + it 'creates a new variant' do + variant_checker = described_class.new(product, variant_params, current_vendor) + variant = variant_checker.find_variant_by_sku + expect(variant).to eq nil + + variant = variant_checker.find_or_create_variant + expect(variant).to be_a Spree::Variant + end + end + end +end diff --git a/spec/services/spree_cm_commissioner/variant_creator_spec.rb b/spec/services/spree_cm_commissioner/variant_creator_spec.rb new file mode 100644 index 000000000..eaae835b5 --- /dev/null +++ b/spec/services/spree_cm_commissioner/variant_creator_spec.rb @@ -0,0 +1,23 @@ +require 'spec_helper' + +RSpec.describe SpreeCmCommissioner::VariantCreator do + describe '#create_variant' do + let(:product) { create(:product, name: "Waste Collection") } + let(:option_types) { [create(:option_type, name: "Month"), create(:option_type, name: "Due Date"), create(:option_type, name: "Payment Method")] } + let(:option_values) { [create(:option_value, name: "1", id: 1, option_type: option_types[0]), create(:option_value, name: "1", id: 2, option_type: option_types[1]), create(:option_value, name: "pre-paid", id: 3, option_type: option_types[2])] } + let(:variant_params) { { product_id: product.id, option_value_ids: option_values.map(&:id), price: 10.0 } } + let(:sku_generator) { described_class.new(product, variant_params) } + let(:current_vendor) { create(:user) } + + it 'creates a variant with the expected attributes' do + variant_creator = SpreeCmCommissioner::VariantCreator.new(product, variant_params, current_vendor) + variant_creator.create_variant + variant = variant_creator.variant + + expect(variant.sku).to eq("waste-collection-month-1-due-date-1-payment-method-pre-paid-price-10.0") + expect(variant.option_value_ids).to eq([1, 2, 3]) + expect(variant.price).to eq(10) + expect(variant.stock_items.first.count_on_hand).to eq(1) + end + end +end