ledger_accountable 0.0.6.pre → 0.0.8.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b93a1058b37c11487cfe062e040ef27d0a5f903a3d5b16507183cdc43fbcfded
-  data.tar.gz: 1a865fd912346f3930c08ae7cae387fdaeb31fb29ebb511563f2f7215857f1b2
+  metadata.gz: 1276ff12e3d9530cc0828b419d62138ce14291afe0265be521ae41bbe938a629
+  data.tar.gz: 9895169c6b508de3060d4b0289093332a6df38cb68814a6e822410689579fbed
 SHA512:
-  metadata.gz: bbba69d3d13c3af56660b8ed27ff5eff1ba7df2ad8a2d478bf89e6815e167c314e8521b26b13a662ced307ae868cdc63ceb237c60ea281865b1d37aa75a36a48
-  data.tar.gz: c5312763c5e588b7328a70d732a408464bb7aa8945a5c8a87e262e92b809ca7936beba3eacdf19d1c3d3621d0be53f00d752d1921857517c46438786d41b62fe
+  metadata.gz: 91c8da55c86246f96deb68a530dd94d17249f495cfc3b370e8837418144417c71ea12ef335a6dbd53dacbf67a721455991cd8b67d1f56b9058865653c644ce12
+  data.tar.gz: 1b43cf14d6dfbaca1453e64ab1ddd5cf2a5564dd8de76c82d33f5b94a259759cd266d8e7e5e9031c0d3c489fc42bc31891ab0ddc37e27fda952bf3c9a162dcf1

data/lib/generators/ledger_accountable/templates/ledger_entry.rb

@@ -6,12 +6,17 @@ class LedgerEntry < ActiveRecord::Base
   belongs_to :ledger_item, polymorphic: true, optional: false
 
   enum entry_type: { addition: 0, deletion: 1, modification: 2 }
+  enum transaction_type: { debit: 0, credit: 1 }
 
   store :metadata, coder: JSON
 
+  validates :transaction_type, presence: true
   validates :amount_cents, presence: true
   validates :entry_type, presence: true
 
+  scope :debits, -> { where(transaction_type: :debit) }
+  scope :credits, -> { where(transaction_type: :credit) }
+
   def to_itemized_s(line_type = :line)
     I18n.t! "#{TRANSLATION_PREFIX}.#{ledger_item_type.constantize.model_name.param_key}.#{line_type}",
             metadata.symbolize_keys

data/lib/generators/ledger_accountable/templates/migration.rb

@@ -3,6 +3,7 @@ class CreateLedgerEntries < ActiveRecord::Migration[6.1]
     create_table :ledger_entries do |t|
       t.references :owner, polymorphic: true, null: false
       t.references :ledger_item, polymorphic: true, null: false
+      t.integer :transaction_type, null: false
       t.integer :entry_type, null: false
       t.integer :amount_cents, default: 0, null: false
       t.text :metadata

data/lib/ledger_accountable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LedgerAccountable
-  VERSION = "0.0.6.pre".freeze
+  VERSION = "0.0.8.pre".freeze
 end

data/lib/ledger_accountable.rb

@@ -1,8 +1,8 @@
 # LedgerAccountable adds ledger functionality to any model that acts as an item in a ledger.
 #
 # It supports tracking two types of ledger entries:
-# 1. Debits: items which decrease the ledger balance (for example, an item being sold)
-# 2. Credits: items which increase the ledger balance (for example, a payment taken)
+# 1. Debits: outgoing items which decrease the ledger balance (for example, an item being sold)
+# 2. Credits: incoming items which increase the ledger balance (for example, a payment taken)
 #
 # Usage:
 # Include LedgerAccountable in a model to have it generate ledger entries based on its
@@ -87,7 +87,7 @@ module LedgerAccountable
     # the name of the attribute or method which determines the ledger amount
     class_attribute :ledger_net_amount_method
     # the type of ledger entry to create - debit or credit
-    class_attribute :ledger_type
+    class_attribute :transaction_type
     # attributes of the LedgerAccountable that should trigger a ledger entry when changed
     class_attribute :ledger_attributes
   end
@@ -97,7 +97,7 @@ module LedgerAccountable
     # to be updated when the provided attributes (or ledger owner) are changed
     def track_ledger(ledger_owner, options = {})
       validate_and_assign_ledger_owner(ledger_owner)
-      validate_and_assign_entry_type(options)
+      validate_and_assign_transaction_type(options)
       validate_and_assign_ledger_amount_attribute(options)
       validate_net_amount_method(options)
       validate_and_assign_ledger_attributes(options)
@@ -112,13 +112,13 @@ module LedgerAccountable
       self.ledger_owner = ledger_owner
     end
 
-    def validate_and_assign_entry_type(options)
+    def validate_and_assign_transaction_type(options)
       if options[:type].present?
         raise 'LedgerAccountable type must be :debit or :credit' unless %i[debit credit].include?(options[:type])
 
-        self.ledger_type = options[:type]
+        self.transaction_type = options[:type]
       else
-        self.ledger_type = :credit
+        self.transaction_type = :credit
       end
     end
 
@@ -162,7 +162,6 @@ module LedgerAccountable
             "LedgerAccountable model '#{model_name}' specified #{self.class.ledger_amount_attribute} for track_ledger :amount, but does not implement #{self.class.ledger_amount_attribute}"
     end
 
-    ledger_amount_multiplier = self.class.ledger_type == :credit ? 1 : -1
     ledger_amount_multiplier * (send(self.class.ledger_amount_attribute) || 0)
   end
 
@@ -170,7 +169,8 @@ module LedgerAccountable
   # stored on the LedgerAccountable object
   def net_ledger_amount
     if self.class.ledger_net_amount_method
-      send(self.class.ledger_net_amount_method)
+      net_amount_result = send(self.class.ledger_net_amount_method)
+      ledger_amount_multiplier * net_amount_result
     else
       unless attribute_method?(self.class.ledger_amount_attribute.to_s)
         # if a method is provided to compute ledger_amount,
@@ -179,9 +179,9 @@ LedgerAccountable model '#{model_name}' appears to use a method for track_ledger
 but did not provide an option for :net_amount. This can lead to unexpected ledger entry amounts when modifying #{model_name}.
 "
       end
-      previous_ledger_amount = attribute_was(self.class.ledger_amount_attribute)
-      ledger_amount_multiplier = self.class.ledger_type == :credit ? 1 : -1
-      ledger_amount_multiplier * (ledger_amount - (previous_ledger_amount || 0))
+
+      previous_ledger_amount = ledger_amount_multiplier * attribute_was(self.class.ledger_amount_attribute)
+      ledger_amount - (previous_ledger_amount || 0)
     end
   end
 
@@ -305,6 +305,7 @@ but did not provide an option for :net_amount. This can lead to unexpected ledge
             # which will rollback the attempt to save the LedgerAccountable object
             owner: owner,
             ledger_item: self,
+            transaction_type: self.transaction_type,
             entry_type: entry_type,
             amount_cents: amount,
             metadata: metadata
@@ -352,6 +353,10 @@ but did not provide an option for :net_amount. This can lead to unexpected ledge
     end
   end
 
+  def ledger_amount_multiplier
+    self.class.transaction_type == :credit ? 1 : -1
+  end
+
   # An overrideable method to determine if the object should be persisted in the ledger
   #
   # For example, payments should not be recorded in a ledger until they're finalized
@@ -379,3 +384,4 @@ but did not provide an option for :net_amount. This can lead to unexpected ledge
     @_destroy_callback_already_called ||= false
   end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledger_accountable
 version: !ruby/object:Gem::Version
-  version: 0.0.6.pre
+  version: 0.0.8.pre
 platform: ruby
 authors:
 - Brendan Maclean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord