ledgerous 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a673d0fc9f70df27fe19f549ece32fc75b304932
+  data.tar.gz: 7aa46a23ef8d9a0507729de8daee805d1515dcb2
+SHA512:
+  metadata.gz: da961eed6499572265d9bc054a1b315b46c1f27ed44bcb1b42e6795504bb59c933b2d95cc984d06ff46652373a01bc32ad12046cb606dbe46e7ba3e82198b575
+  data.tar.gz: 3e599c3cc975ae0906d4ca4bd01dfea0cc74d206f439f30c4b07fcfc79a54814b01e869715060df394dc607ced9441d6e5d2f09548dc2338bb7df7473bdfc52b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ledgerous.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Varun Srinivasan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Ledgerous
+
+Ledgerous is an accounting helper that calculates the smallest set of
+payments that will settle open accounts. 
+ 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ledgerous'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ledgerous
+
+## Usage
+
+To use ledgerous, just require it in your project:
+
+	require 'ledgerous'
+
+Let's say that Jane paid for Bob's breakfast, Bob paid for Sue's lunch and Sue
+paid for Jane's dinner. You'd set the transactions up as follows: 
+
+	transactions = []
+	transactions << Transaction.new('Jane', Bob, 20)   # breakfast
+	transactions << Transaction.new('Bob', 'Sue', 50)  # lunch
+	transactions << Transaction.new('Sue', 'Jane', 35) # dinner
+
+Next, create a new ledger, and add each transaction into the ledger: 
+
+	accounts = Ledgerous.new
+	transactions.each { |t| accounts.reconcile(t) }
+
+You can also set a minimum threshold for debts. Any debts equal to or lower 
+than this amount will be discarded:
+
+	accounts.threshold = 2
+
+You can keep adding transactions as they happen. When you're ready to settle accounts, just call: 
+
+	puts accounts.settle
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+

data/ledgerous.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ledgerous/version'
+
+Gem::Specification.new do |s|
+  s.name          = "ledgerous"
+  s.version       = Ledgerous::VERSION
+  s.authors       = ["Varun Srinivasan"]
+  s.email         = ["varunsrin@gmail.com"]
+  s.summary       = %q{Accounting module to settle account balances}
+  s.homepage      = "https://github.com/varunsrin/ledgerous"
+  s.license       = "MIT"
+
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+end

data/lib/ledgerous.rb

@@ -0,0 +1,116 @@
+require "ledgerous/version"
+require "transaction"
+
+class Ledgerous
+
+  attr_reader :accounts, :payments
+
+  attr_accessor :threshold
+
+  def initialize
+    @accounts = Hash.new(0)
+    @threshold = 0
+  end
+
+  # Returns true if there are no open accounts above or below the threshold
+  def empty?
+    @accounts.each do |k, v| 
+      return false if v.abs > @threshold
+    end
+    return true
+  end
+
+  # Returns all accounts with negative balances
+  def debtors
+    @accounts.select {|_, amt| amt < 0}
+  end
+
+  # Returns all accounts wiht positive balances
+  def creditors
+    @accounts.select {|_, amt| amt > 0}
+  end
+
+  # Reconciles the ledgerous with the transaction
+  def reconcile(t)
+    update_or_create_account(t.creditor, t.amount)
+    update_or_create_account(t.debtor, -t.amount)
+  end
+
+  # Returns list of transactions that will settle open accounts
+  def settle
+    s = Marshal.load(Marshal.dump(self))
+    s.settle!
+  end
+
+  # Returns a list of transactions that will settle open accounts, and applies
+  # them to clear accounts
+  def settle!
+    payments = []
+    next_payment do |n|
+      reconcile(n)
+      payments << n.reverse
+    end
+    payments
+  end
+
+  protected
+
+  # Returns the first payment that can clear two accounts
+  def double_clear_payment
+    debtors.each do |d| 
+      creditors.each do |c|
+        return Transaction.new(c[0], d[0], c[1]) if c[1] == -d[1]
+      end
+    end
+    return false
+  end
+
+  # Returns the first payment that clears one account, but will result in two 
+  # accounts being cleared next
+  def double_clear_lookahead
+    s = Marshal.load(Marshal.dump(self))
+    s.single_clears do |p|
+      s.reconcile(p)
+      s.double_clear_payment ? (return p) : s.reconcile(p.reverse)     
+    end
+    return false
+  end
+
+  # Yields payments that will clear one account
+  def single_clears
+    debtors.each do |d|
+      creditors.each do |c|
+        yield Transaction.new(c[0], d[0], [c[1], -d[1]].min)
+      end
+    end
+  end
+
+  # Returns the first payment that will clear one account
+  def single_clear
+    single_clears { |n| return n }
+  end
+
+  private
+
+  # Updates the account, or creates it if it does not exist
+  def update_or_create_account(name, amount)
+    @accounts[name.to_sym] += amount
+  end
+
+  # Finds the next best payment to settle the account
+  #
+  # * Cancel a payment that removes two accounts
+  # * Cancel a payment that removes one account, but will result in two being
+  #   removed on the next payment
+  # * Cancel a payment that removes any account
+  def next_payment
+    until empty?      
+      if double_clear_payment
+        yield double_clear_payment
+        next
+      end
+      yield double_clear_lookahead ? double_clear_lookahead : single_clear
+    end
+  end
+
+end

data/lib/ledgerous/version.rb

@@ -0,0 +1,3 @@
+class Ledgerous
+  VERSION = "0.0.1"
+end

data/lib/transaction.rb

@@ -0,0 +1,27 @@
+# Transaction
+# A single transaction
+
+class Transaction
+
+  attr_reader :debtor, :creditor, :amount
+
+  def initialize(debtor, creditor, amount)
+    @debtor = debtor
+    @creditor = creditor
+    @amount = amount
+  end
+
+  # Returns a transaction that is the reverse of the current one
+  def reverse
+    Transaction.new(@creditor, @debtor, @amount)
+  end
+
+  def ==(obj)
+    (
+      obj.amount == self.amount && 
+      obj.creditor == self.creditor && 
+      obj.debtor == self.debtor
+    )
+  end
+
+end

data/spec/ledgerous_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Ledgerous do
+  subject { Ledgerous.new }
+
+  describe '#empty?' do
+
+    it 'returns true if the ledger is empty' do
+      expect(subject.empty?).to eq(true)
+    end
+
+    it 'returns false if the ledger has any accounts' do
+      subject.reconcile(Transaction.new('A', 'B', 5))
+      expect(subject.empty?).to eq(false)
+    end
+
+    it 'returns true if no accounts are greater than the threshold' do
+      subject.reconcile(Transaction.new('A', 'B', 5))
+      subject.threshold = 5
+      expect(subject.empty?).to eq(true)
+    end
+
+  end
+
+  describe '#reconcile' do
+
+    before :each do
+      subject.reconcile(Transaction.new('A', 'B', 20))
+    end
+
+    it 'adds two accounts to the ledger' do
+      expect(subject.accounts.length).to eq(2)
+      expect(subject.accounts[:A]).to eq(-20)
+      expect(subject.accounts[:B]).to eq(20)
+    end
+
+    it 'updates accounts if they already exist' do
+      subject.reconcile(Transaction.new('A', 'B', 20))
+      expect(subject.accounts.length).to eq(2)
+      expect(subject.accounts[:A]).to eq(-40)
+      expect(subject.accounts[:B]).to eq(40)
+    end
+
+    it 'eliminates transitive debts' do
+      subject.reconcile(Transaction.new('B', 'C', 20))
+      expect(subject.debtors.length && subject.creditors.length).to eq(1)
+    end
+  end
+
+
+  describe '#settle' do
+
+    before do 
+      # A: 10, B: -2, C: -12, D:4, E: 25, F: 50, G: -75, H: 7, I: -7
+      subject.reconcile(Transaction.new('B', 'A', 2))
+      subject.reconcile(Transaction.new('C', 'A', 8))
+      subject.reconcile(Transaction.new('G', 'E', 25))
+      subject.reconcile(Transaction.new('G', 'F', 50))
+      subject.reconcile(Transaction.new('C', 'D', 4))
+      subject.reconcile(Transaction.new('I', 'H', 7))
+      @payments = subject.settle
+    end
+
+    it 'chooses one payment that cancels two accounts first' do
+      expect(@payments[0]).to eq(Transaction.new(:I, :H, 7))
+    end
+
+    it 'chooses two payments that cancel three accounts second' do
+      expect(@payments[1]).to eq(Transaction.new(:G, :E, 25))
+      expect(@payments[2]).to eq(Transaction.new(:G, :F, 50))
+    end
+
+    it 'chooses one payment that cancels one account next' do 
+      expect(@payments[3]).to eq(Transaction.new(:B, :A, 2))
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'ledgerous'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ledgerous
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Varun Srinivasan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- varunsrin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ledgerous.gemspec
+- lib/ledgerous.rb
+- lib/ledgerous/version.rb
+- lib/transaction.rb
+- spec/ledgerous_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/varunsrin/ledgerous
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Accounting module to settle account balances
+test_files:
+- spec/ledgerous_spec.rb
+- spec/spec_helper.rb