comee_core 0.3.38 → 0.3.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f24bf85150707bf055d33beb60ab6255121975d0287b6dcf0a0f2c5301ee24dc
-  data.tar.gz: 59f736afd6f9c4919a9123672d40f3aa2abda42f9ccc4c0ec50279f5e645b72e
+  metadata.gz: 7c5bd7ecb372cda637b779b831f195910cb1d8e7a6a4a7a9687d58f6e5063f34
+  data.tar.gz: 2b66ca4edc892cfacdd239973330ea4ac1ea10ed9c0c749ffa8a67f0e2751621
 SHA512:
-  metadata.gz: 14f20b4731201268d259c432ed1bf8c1f949f04ea3be5aab30161b3205ecf8c2d5ca934aa35ea2f25f8498304820209b7f4d2059869c0ccc50172ecca2cd4927
-  data.tar.gz: f42dbab7b458ff1d8aaeb7f87eea054698e619b4098d459b61c857b6cc30dccc52f010ecc899cff53dadca9a38683da9a939dad5a4b205ae03e3aea2c8781370
+  metadata.gz: 3b23ad79739cf108028d62e244e2cee673f6bca41142c29956eeb903c565ace12997baad341c75c9936f49f44607d28d339a5890dbc976f05fd47203f64a0ca9
+  data.tar.gz: a4ab86afb792d939cf67d7eb880d1ad5ed1680d7edb9db68e6353de5531fa23fc70405ed22b1bbc2bb53680002805de0b8673cf5b1532747d3d38f610dcf8e31

data/app/models/comee/core/credit_note.rb

@@ -0,0 +1,54 @@
+module Comee
+  module Core
+    class CreditNote < ApplicationRecord
+      before_validation :generate_credit_note_no, if: proc { |note| note.credit_note_no.nil? }
+
+      belongs_to :invoice
+      has_many :credit_note_items
+      has_many :credit_note_additional_items
+
+      enum :status, {draft: 0, approved: 1, issued: 2}
+
+      validates :credit_note_no, presence: true, uniqueness: true
+      validates :status, presence: true
+      validates :total_price, numericality: {greater_than_or_equal_to: 0, allow_nil: true}
+      validate :validate_total_price
+
+      def calculate_total_price
+        self.total_price = calculate_total
+      end
+
+      def calculate_total
+        items = CreditNoteItem.where(credit_note_id: id)
+        additionals = CreditNoteAdditionalItem.where(credit_note_id: id)
+        (items.sum(:total_price) + additionals.sum(:total_price)).round(2)
+      end
+
+      def generate_credit_note_no
+        year = Date.current.year.to_s
+        self.credit_note_no = Util.generate_number("CreditNote", "credit_note_no", year, "-", 100001)
+      end
+
+      def validate_total_price
+        return unless total_price && invoice
+
+        balance = invoice.total_price - invoice.amount_paid
+        errors.add(:total_price, "exceeds invoice unpaid amount") if total_price > balance
+      end
+
+      def self.ransackable_attributes(_auth_object = nil)
+        %w[
+          id
+          invoice_id
+          credit_note_no
+          created_at
+          status
+        ]
+      end
+
+      def self.ransackable_associations(_auth_object = nil)
+        ["invoice"]
+      end
+    end
+  end
+end

data/app/models/comee/core/credit_note_additional_item.rb

@@ -0,0 +1,19 @@
+module Comee
+  module Core
+    class CreditNoteAdditionalItem < ApplicationRecord
+      before_save { self.total_price = unit_price * quantity }
+      after_save :update_credit_note
+      after_destroy :update_credit_note
+
+      belongs_to :credit_note
+
+      validates :description, presence: true
+      validates :quantity, :unit_price, presence: true, numericality: {greater_than: 0}
+
+      def update_credit_note
+        credit_note.calculate_total_price
+        credit_note.save!
+      end
+    end
+  end
+end

data/app/models/comee/core/credit_note_item.rb

@@ -0,0 +1,20 @@
+module Comee
+  module Core
+    class CreditNoteItem < ApplicationRecord
+      before_save { self.total_price = unit_price * quantity }
+      after_save :update_credit_note
+      after_destroy :update_credit_note
+
+      belongs_to :credit_note
+      belongs_to :invoice_item
+
+      validates :quantity, :unit_price, presence: true, numericality: {greater_than: 0}
+      validates :total_price, numericality: {greater_than_or_equal_to: 0, allow_nil: true}
+
+      def update_credit_note
+        credit_note.calculate_total_price
+        credit_note.save!
+      end
+    end
+  end
+end

data/app/models/comee/core/invoice.rb

@@ -46,6 +46,11 @@ module Comee
         (items.sum(:total_price) + additionals.sum(:total_price)).round(2)
       end
 
+      def calculate_amount_paid
+        payments = Payment.where(invoice_id: id)
+        payments.sum(:amount)
+      end
+
       def self.ransackable_attributes(_auth_object = nil)
         %w[
           id

data/app/models/comee/core/payment.rb

@@ -1,6 +1,7 @@
 module Comee
   module Core
     class Payment < ApplicationRecord
+      after_save :calculate_amount_paid
       belongs_to :invoice
       belongs_to :payment_deposit
 
@@ -24,6 +25,11 @@ module Comee
         error = "Amount exceeded. The maximum amount you can set is #{remaining}"
         errors.add(:base, error) if amount > remaining
       end
+
+      def calculate_amount_paid
+        invoice.amount_paid = invoice.calculate_amount_paid
+        invoice.save!
+      end
     end
   end
 end

data/db/migrate/20240731075328_create_comee_core_credit_notes.rb

@@ -0,0 +1,19 @@
+class CreateComeeCoreCreditNotes < ActiveRecord::Migration[7.1]
+  def change
+    create_table :comee_core_credit_notes do |t|
+      t.string :credit_note_no, null: false
+      t.references :invoice,
+                   null: false,
+                   index: {name: "invoice_on_cccn_indx"},
+                   foreign_key: {to_table: :comee_core_invoices}
+      t.float :total_price
+      t.float :vat, default: 0
+      t.integer :status, null: false, default: 0
+      t.date :date_issued
+      t.string :remark
+
+      t.timestamps
+    end
+    add_index :comee_core_credit_notes, :credit_note_no, unique: true
+  end
+end

data/db/migrate/20240731080746_create_comee_core_credit_note_items.rb

@@ -0,0 +1,19 @@
+class CreateComeeCoreCreditNoteItems < ActiveRecord::Migration[7.1]
+  def change
+    create_table :comee_core_credit_note_items do |t|
+      t.references :credit_note,
+                   null: false,
+                   index: {name: "cn_on_cccni_indx"},
+                   foreign_key: {to_table: :comee_core_credit_notes}
+      t.references :invoice_item,
+                   null: false,
+                   index: {name: "ii_on_cccni_indx"},
+                   foreign_key: {to_table: :comee_core_invoice_items}
+      t.float :quantity, null: false
+      t.float :unit_price, null: false
+      t.float :total_price
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20240731081502_create_comee_core_credit_note_additional_items.rb

@@ -0,0 +1,16 @@
+class CreateComeeCoreCreditNoteAdditionalItems < ActiveRecord::Migration[7.1]
+  def change
+    create_table :comee_core_credit_note_additional_items do |t|
+      t.references :credit_note,
+                   null: false,
+                   index: {name: "cn_on_cccnai_indx"},
+                   foreign_key: {to_table: :comee_core_credit_notes}
+      t.string :description, null: false
+      t.float :quantity, null: false
+      t.float :unit_price, null: false
+      t.float :total_price, null: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/comee/core/version.rb

@@ -1,5 +1,5 @@
 module Comee
   module Core
-    VERSION = "0.3.38".freeze
+    VERSION = "0.3.39".freeze
   end
 end

data/spec/factories/comee/core/credit_note_additional_items.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :credit_note_additional_item, class: "Comee::Core::CreditNoteAdditionalItem" do
+    credit_note
+    description { Faker::Name.name }
+    quantity { 1.5 }
+    unit_price { 1.5 }
+    total_price { quantity * unit_price }
+
+    after(:build) do |item, _|
+      item.credit_note.invoice.total_price = 100
+    end
+  end
+end

data/spec/factories/comee/core/credit_note_items.rb

@@ -0,0 +1,17 @@
+FactoryBot.define do
+  factory :credit_note_item, class: "Comee::Core::CreditNoteItem" do
+    transient do
+      invoice { create(:invoice) }
+    end
+    # association :credit_note, invoice: :invoice
+    # association :invoice_item, invoice: :invoice
+    quantity { 10 }
+    unit_price { 2 }
+    total_price { quantity * unit_price }
+
+    after(:build) do |item, evaluator|
+      item.credit_note ||= create(:credit_note, invoice: evaluator.invoice)
+      item.invoice_item ||= create(:invoice_item, invoice: evaluator.invoice)
+    end
+  end
+end

data/spec/factories/comee/core/credit_notes.rb

@@ -0,0 +1,11 @@
+FactoryBot.define do
+  factory :credit_note, class: "Comee::Core::CreditNote" do
+    credit_note_no { nil }
+    invoice
+    total_price { 0 }
+    vat { 0 }
+    status { Comee::Core::CreditNote.statuses[:draft] }
+    date_issued { Date.current }
+    remark { Faker::Lorem.sentence }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comee_core
 version: !ruby/object:Gem::Version
-  version: 0.3.38
+  version: 0.3.39
 platform: ruby
 authors:
 - Henock L.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -337,6 +337,9 @@ files:
 - app/models/comee/core/client_price.rb
 - app/models/comee/core/client_warehouse.rb
 - app/models/comee/core/contact.rb
+- app/models/comee/core/credit_note.rb
+- app/models/comee/core/credit_note_additional_item.rb
+- app/models/comee/core/credit_note_item.rb
 - app/models/comee/core/currency.rb
 - app/models/comee/core/customer_order.rb
 - app/models/comee/core/customer_order_item.rb
@@ -528,6 +531,9 @@ files:
 - db/migrate/20240718103456_make_delivery_note_no_and_goods_issue_date_optional.rb
 - db/migrate/20240720091730_add_use_alias_field_to_line_items.rb
 - db/migrate/20240721035647_add_invoice_address_to_invoice.rb
+- db/migrate/20240731075328_create_comee_core_credit_notes.rb
+- db/migrate/20240731080746_create_comee_core_credit_note_items.rb
+- db/migrate/20240731081502_create_comee_core_credit_note_additional_items.rb
 - lib/comee/core.rb
 - lib/comee/core/engine.rb
 - lib/comee/core/version.rb
@@ -545,6 +551,9 @@ files:
 - spec/factories/comee/core/client_warehouses.rb
 - spec/factories/comee/core/clients.rb
 - spec/factories/comee/core/contacts.rb
+- spec/factories/comee/core/credit_note_additional_items.rb
+- spec/factories/comee/core/credit_note_items.rb
+- spec/factories/comee/core/credit_notes.rb
 - spec/factories/comee/core/currencies.rb
 - spec/factories/comee/core/customer_order_items.rb
 - spec/factories/comee/core/customer_orders.rb