Test surcharges

Author: monorkin

README.md

@@ -16,7 +16,7 @@ Croatia is a gem that contains various utilities for performing Croatia-specific
     - [x] Taxes
       - [x] Types
       - [x] Categories
-    - [ ] Surcharges _(Naknade)_
+    - [x] Surcharges _(Naknade)_
     - [ ] Margins _(Marza)_
 - [x] Payment barcodes
   - [x] HUB3 standard 2D barcode generation
@@ -174,12 +174,26 @@ invoice.add_line_item do |line_item|
 
   # Clear all taxes
   # line_item.clear_taxes
+
+  # Add surcharges (naknade)
+  line_item.add_surcharge(name: "Refundable deposit", amount: 2.50)
+  line_item.add_surcharge do |surcharge|
+    surcharge.name = "Handling fee"
+    surcharge.amount = 1.25
+  end
+
+  # Remove a surcharge
+  # line_item.remove_surcharge("Refundable deposit")
+
+  # Clear all surcharges
+  # line_item.clear_surcharges
 end
 
 invoice.subtotal # => BigDecimal("200.00")
 invoice.tax # => BigDecimal("62.50")
-invoice.total # => BigDecimal("262.50")
-invoice.total_cents # => 26250
+invoice.surcharge # => BigDecimal("3.75")
+invoice.total # => BigDecimal("266.25")
+invoice.total_cents # => 26625
 
 invoice.number # => "64/HQ1/123"
 

lib/croatia/invoice.rb

@@ -10,6 +10,7 @@ class Croatia::Invoice
   autoload :Payable, "croatia/invoice/payable"
   autoload :Party, "croatia/invoice/party"
   autoload :Tax, "croatia/invoice/tax"
+  autoload :Surcharge, "croatia/invoice/surcharge"
   autoload :LineItem, "croatia/invoice/line_item"
 
   include Croatia::Enum
@@ -55,6 +56,10 @@ def tax
     line_items.sum(&:tax).to_d
   end
 
+  def surcharge
+    line_items.sum(&:surcharge).to_d
+  end
+
   def total
     line_items.sum(&:total).to_d
   end

lib/croatia/invoice/line_item.rb

@@ -104,7 +104,7 @@ def tax
   end
 
   def surcharge
-    surcharges.values.sum(&:amount).round(2, BigDecimal::ROUND_HALF_UP)
+    surcharges.values.sum(&:amount).to_d.round(2, BigDecimal::ROUND_HALF_UP)
   end
 
   def total

test/croatia/invoice/line_item_test.rb

@@ -396,4 +396,194 @@ def test_floating_point_with_discounts
     # total: 3.14 + 0.69 = 3.83
     assert_equal BigDecimal("3.83"), line_item.total
   end
+
+  def test_add_surcharge_with_options
+    line_item = Croatia::Invoice::LineItem.new(description: "Test")
+
+    surcharge = line_item.add_surcharge(name: "Environmental fee", amount: 2.50)
+
+    assert_instance_of Croatia::Invoice::Surcharge, surcharge
+    assert_equal "Environmental fee", surcharge.name
+    assert_equal BigDecimal("2.50"), surcharge.amount
+    assert_equal 1, line_item.surcharges.length
+  end
+
+  def test_add_surcharge_with_block
+    line_item = Croatia::Invoice::LineItem.new(description: "Test")
+
+    surcharge = line_item.add_surcharge(name: "Recycling fee", amount: 1.25) do |s|
+      s.amount = 2.50  # Override the amount
+    end
+
+    assert_instance_of Croatia::Invoice::Surcharge, surcharge
+    assert_equal "Recycling fee", surcharge.name
+    assert_equal BigDecimal("2.50"), surcharge.amount
+    assert_equal 1, line_item.surcharges.length
+  end
+
+  def test_add_surcharge_with_object
+    line_item = Croatia::Invoice::LineItem.new(description: "Test")
+    surcharge_obj = Croatia::Invoice::Surcharge.new(name: "Handling fee", amount: 3.75)
+
+    result = line_item.add_surcharge(surcharge_obj)
+
+    assert_equal surcharge_obj, result
+    assert_equal 1, line_item.surcharges.length
+    assert_equal surcharge_obj, line_item.surcharges.values.first
+  end
+
+  def test_remove_surcharge
+    line_item = Croatia::Invoice::LineItem.new(description: "Test")
+    line_item.add_surcharge(name: "Delivery fee", amount: 5.0)
+    line_item.add_surcharge(name: "Service fee", amount: 2.0)
+
+    assert_equal 2, line_item.surcharges.length
+
+    line_item.remove_surcharge("Delivery fee")
+
+    assert_equal 1, line_item.surcharges.length
+    assert_nil line_item.surcharges["Delivery fee"]
+    refute_nil line_item.surcharges["Service fee"]
+  end
+
+  def test_clear_surcharges
+    line_item = Croatia::Invoice::LineItem.new(description: "Test")
+    line_item.add_surcharge(name: "Fee 1", amount: 1.0)
+    line_item.add_surcharge(name: "Fee 2", amount: 2.0)
+
+    assert_equal 2, line_item.surcharges.length
+
+    line_item.clear_surcharges
+
+    assert_equal 0, line_item.surcharges.length
+  end
+
+  def test_surcharge_calculation_single_surcharge
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      quantity: 2,
+      unit_price: 10.0
+    )
+    line_item.add_surcharge(name: "Environmental fee", amount: 2.50)
+
+    assert_equal BigDecimal("2.50"), line_item.surcharge
+  end
+
+  def test_surcharge_calculation_multiple_surcharges
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      quantity: 2,
+      unit_price: 10.0
+    )
+    line_item.add_surcharge(name: "Environmental fee", amount: 2.50)
+    line_item.add_surcharge(name: "Handling fee", amount: 1.75)
+
+    assert_equal BigDecimal("4.25"), line_item.surcharge
+  end
+
+  def test_surcharge_calculation_no_surcharges
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      quantity: 2,
+      unit_price: 10.0
+    )
+
+    assert_equal BigDecimal("0.00"), line_item.surcharge
+  end
+
+  def test_total_calculation_with_surcharges
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      quantity: 2,
+      unit_price: 10.0
+    )
+    line_item.add_tax(rate: 0.25)
+    line_item.add_surcharge(name: "Environmental fee", amount: 3.0)
+
+    # subtotal: 20.0, tax: 5.0, surcharge: 3.0, total: 28.0
+    assert_equal BigDecimal("20.00"), line_item.subtotal
+    assert_equal BigDecimal("5.00"), line_item.tax
+    assert_equal BigDecimal("3.00"), line_item.surcharge
+    assert_equal BigDecimal("28.00"), line_item.total
+  end
+
+  def test_total_calculation_with_taxes_and_multiple_surcharges
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      quantity: 1,
+      unit_price: 100.0
+    )
+    line_item.add_tax(rate: 0.25)
+    line_item.add_surcharge(name: "Environmental fee", amount: 5.0)
+    line_item.add_surcharge(name: "Handling fee", amount: 2.50)
+
+    # subtotal: 100.0, tax: 25.0, surcharge: 7.5, total: 132.5
+    assert_equal BigDecimal("100.00"), line_item.subtotal
+    assert_equal BigDecimal("25.00"), line_item.tax
+    assert_equal BigDecimal("7.50"), line_item.surcharge
+    assert_equal BigDecimal("132.50"), line_item.total
+  end
+
+  def test_surcharge_with_discount_and_tax
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      quantity: 2,
+      unit_price: 10.0
+    )
+    line_item.discount_rate = 0.1
+    line_item.add_tax(rate: 0.25)
+    line_item.add_surcharge(name: "Service fee", amount: 1.5)
+
+    # gross: 20.0, discount: 2.0, subtotal: 18.0
+    # tax: 18.0 * 0.25 = 4.5, surcharge: 1.5
+    # total: 18.0 + 4.5 + 1.5 = 24.0
+    assert_equal BigDecimal("20.00"), line_item.gross
+    assert_equal BigDecimal("2.00"), line_item.discount
+    assert_equal BigDecimal("18.00"), line_item.subtotal
+    assert_equal BigDecimal("4.50"), line_item.tax
+    assert_equal BigDecimal("1.50"), line_item.surcharge
+    assert_equal BigDecimal("24.00"), line_item.total
+  end
+
+  def test_surcharge_with_reverse_line_item
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      quantity: 2,
+      unit_price: 10.0
+    )
+    line_item.add_tax(rate: 0.25)
+    line_item.add_surcharge(name: "Fee", amount: 3.0)
+    line_item.reverse
+
+    # After reverse, quantity is negative but surcharge remains positive
+    assert_equal BigDecimal("-2"), line_item.quantity
+    assert_equal BigDecimal("-20.00"), line_item.subtotal
+    assert_equal BigDecimal("-5.00"), line_item.tax
+    assert_equal BigDecimal("3.00"), line_item.surcharge  # Surcharge stays positive
+    assert_equal BigDecimal("-22.00"), line_item.total    # -20 + (-5) + 3 = -22
+  end
+
+  def test_surcharge_bigdecimal_precision
+    line_item = Croatia::Invoice::LineItem.new(description: "Test")
+    line_item.add_surcharge(name: "Precision test", amount: 1.234567)
+
+    surcharge = line_item.surcharges["Precision test"]
+    assert_instance_of BigDecimal, surcharge.amount
+    assert_equal BigDecimal("1.234567"), surcharge.amount
+
+    # Test that surcharge total is rounded to 2 decimal places
+    assert_equal BigDecimal("1.23"), line_item.surcharge
+    assert_equal 2, line_item.surcharge.scale
+  end
+
+  def test_initialize_with_surcharges
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Initial fee", amount: 2.0)
+    line_item = Croatia::Invoice::LineItem.new(
+      description: "Test item",
+      surcharges: { surcharge.name => surcharge }
+    )
+
+    assert_equal 1, line_item.surcharges.length
+    assert_equal surcharge, line_item.surcharges["Initial fee"]
+  end
 end

test/croatia/invoice/surcharge_test.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Croatia::Invoice::SurchargeTest < Minitest::Test
+  def test_initialize
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Environmental fee", amount: 2.50)
+
+    assert_equal "Environmental fee", surcharge.name
+    assert_equal BigDecimal("2.50"), surcharge.amount
+  end
+
+  def test_initialize_with_string_amount
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Handling fee", amount: "3.75")
+
+    assert_equal "Handling fee", surcharge.name
+    assert_equal BigDecimal("3.75"), surcharge.amount
+  end
+
+  def test_initialize_with_integer_amount
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Service fee", amount: 5)
+
+    assert_equal "Service fee", surcharge.name
+    assert_equal BigDecimal("5"), surcharge.amount
+  end
+
+  def test_name_validation_nil
+    assert_raises(ArgumentError, "Name cannot be nil") do
+      Croatia::Invoice::Surcharge.new(name: nil, amount: 1.0)
+    end
+  end
+
+  def test_amount_validation_nil
+    assert_raises(ArgumentError, "Amount cannot be nil") do
+      Croatia::Invoice::Surcharge.new(name: "Test", amount: nil)
+    end
+  end
+
+  def test_name_setter
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Original", amount: 1.0)
+    surcharge.name = "Updated"
+
+    assert_equal "Updated", surcharge.name
+  end
+
+  def test_name_setter_with_whitespace
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Original", amount: 1.0)
+    surcharge.name = "  Trimmed  "
+
+    assert_equal "Trimmed", surcharge.name
+  end
+
+  def test_name_setter_with_number
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Original", amount: 1.0)
+    surcharge.name = 123
+
+    assert_equal "123", surcharge.name
+  end
+
+  def test_name_setter_nil_validation
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Original", amount: 1.0)
+
+    assert_raises(ArgumentError, "Name cannot be nil") do
+      surcharge.name = nil
+    end
+  end
+
+  def test_amount_setter
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Test", amount: 1.0)
+    surcharge.amount = 5.25
+
+    assert_equal BigDecimal("5.25"), surcharge.amount
+  end
+
+  def test_amount_setter_with_string
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Test", amount: 1.0)
+    surcharge.amount = "7.50"
+
+    assert_equal BigDecimal("7.50"), surcharge.amount
+  end
+
+  def test_amount_setter_with_integer
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Test", amount: 1.0)
+    surcharge.amount = 10
+
+    assert_equal BigDecimal("10"), surcharge.amount
+  end
+
+  def test_amount_setter_nil_validation
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Test", amount: 1.0)
+
+    assert_raises(ArgumentError, "Amount cannot be nil") do
+      surcharge.amount = nil
+    end
+  end
+
+  def test_bigdecimal_precision
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Precision test", amount: 1.123456789)
+
+    assert_instance_of BigDecimal, surcharge.amount
+    assert_equal BigDecimal("1.123456789"), surcharge.amount
+  end
+
+  def test_negative_amounts_allowed
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Credit", amount: -2.50)
+
+    assert_equal BigDecimal("-2.50"), surcharge.amount
+  end
+
+  def test_zero_amount_allowed
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Free", amount: 0)
+
+    assert_equal BigDecimal("0"), surcharge.amount
+  end
+
+  def test_enum_inclusion
+    surcharge = Croatia::Invoice::Surcharge.new(name: "Test", amount: 1.0)
+
+    assert_includes surcharge.class.ancestors, Croatia::Enum
+  end
+end