owemegod 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rbx/*
+coverage

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@owemegod

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in owemegod.gemspec
+gemspec
+
+group :development do
+  gem 'growl'
+  gem 'guard'
+  gem 'guard-minitest', :git => 'git://github.com/aspiers/guard-minitest.git'
+  gem 'guard-spinach'
+  gem 'simplecov'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end
+
+guard 'spinach' do
+  watch(%r|^features/(.*)\.feature|)
+  watch(%r|^features/steps/(.*)([^/]+)\.rb|) do |m|
+    "features/#{m[1]}#{m[2]}.feature"
+  end
+end

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+desc "Runs spinach"
+task :spinach do
+  exec 'spinach'
+end
+
+task :default => [:test, :spinach]

data/Readme.md

@@ -0,0 +1,53 @@
+# Owemegod
+
+Owemegod is a tool made for distributing costs of events or parties among a bunch of people.
+
+## Usage
+
+### Set up a bunch of people
+
+```ruby
+me = Owemegod::Person.new(name: "Josep Jaume")
+petula = Owemegod::Person.new(name: "Petula Clark")
+chaplin = Owemegod::Person.new(name: "Charles Chaplin")
+napoleon = Owemegod::Person.new(name: "Napoleon Dynamite")
+```
+
+### Assign them a bunch of expenses
+
+```ruby
+me.add_expense("Food", 50)
+me.add_expense("Bitches", 100)
+petula.add_expense("Drinks", 40)
+```
+
+### Create a group
+
+```ruby
+group = Owemegod::Group.new [me, petula, chaplin]
+```
+
+### Distribute the costs
+
+```ruby
+distribution = group.distribute
+```
+
+### Inspect the results
+
+```ruby
+puts distribution.debts.inspect
+=> [[#<Owemegod::Person name="Petula Clark">, #<Owemegod::Person name="Josep Jaume">, 7.5], [#<Owemegod::Person name="Napoleon Dynamite">, #<Owemegod::Person name="Josep Jaume">, 47.5], [#<Owemegod::Person name="Charles Chaplin">, #<Owemegod::Person name="Josep Jaume">, 47.5]]
+```
+
+## Todo
+
+* Create a prettier API
+* Create prettier output
+* Simplify internals (refactoring)
+* Add documentation
+* Create a web interface
+
+## License
+
+MIT License. Copyright 2011 Josep Jaume

data/features/debt_distribution.feature

@@ -0,0 +1,27 @@
+Feature: Debt distribution
+  In order to distribute the cost of an event among friends
+  As the organizer
+  I want Owemegod to suggest a debt distribution
+
+  Scenario: I organize a party and pay for all
+    Given I'm organizing a party
+    And I invited 5 of my friends
+    And I paid for all for an amount of 120eur
+    When I use Owemegod to distribute the costs
+    Then everyone should pay me 20eur
+    And I should not pay a thing
+
+  Scenario: Someone organizes a party and each one pays the same amount
+    Given I'm organizing a party
+    And I invited 5 of my friends
+    And each one of us paid 15eur
+    When I use Owemegod to distribute the costs
+    Then no one should pay a thing
+
+  Scenario: Someone organizes a party and someone didn't pay for anything
+    Given I'm organizing a party
+    And I invited 5 of my friends
+    And each one of us paid 15eur except me
+    When I use Owemegod to distribute the costs
+    Then I should pay 2.5eur to everyone
+    And no one else should pay anything

data/features/steps/debt_distribution.rb

@@ -0,0 +1,75 @@
+class DebtDistribution < Spinach::FeatureSteps
+  feature 'Debt distribution'
+  Given 'I\'m organizing a party' do
+    @me = Owemegod::Person.new(name: 'John Doe')
+    @group = Owemegod::Group.new
+    @group.add_person @me
+  end
+
+  And 'I invited 5 of my friends' do
+    @friends = []
+    5.times do |i|
+      friend = Owemegod::Person.new(name: "Friend #{i}")
+      @group.add_person friend
+      @friends << friend
+    end
+  end
+
+  And 'I paid for all for an amount of 120eur' do
+    @me.add_expense("Food", 50)
+    @me.add_expense("Equipment", 50)
+    @me.add_expense("Other", 20)
+  end
+
+  When 'I use Owemegod to distribute the costs' do
+    @distribution = @group.distribute
+  end
+
+  Then 'everyone should pay me 20eur' do
+    @friends.each do |friend|
+      debts = @distribution.outgoing_debts(friend)
+      debts.length.must_equal 1
+      debt = debts.first
+      debt[1].name.must_equal "John Doe"
+      debt[2].must_equal 20
+    end
+  end
+
+  And 'I should not pay a thing' do
+    @distribution.outgoing_debts(@me).length.must_equal 0
+  end
+
+  And 'each one of us paid 15eur' do
+    (@friends + [@me]).each do |person|
+      person.add_expense("Food", 10)
+    end
+  end
+
+  And 'no one should pay a thing' do
+    (@friends + [@me]).each do |person|
+      @distribution.outgoing_debts(person).length.must_equal 0
+    end
+  end
+
+  And 'each one of us paid 15eur except me' do
+    @friends.each do |person|
+      person.add_expense("Food", 15)
+    end
+  end
+
+  Then 'I should pay 2.5eur to everyone' do
+    debts = @distribution.outgoing_debts(@me)
+    debts.length.must_equal 5
+    @friends.each do |friend|
+      friend_debts = debts.select{|d| d[1] == friend}
+      friend_debts.length.must_equal 1
+      friend_debts.first[2].must_equal 2.5
+    end
+  end
+
+  And 'no one else should pay anything' do
+    @friends.each do |friend|
+      @distribution.outgoing_debts(friend).length.must_equal 0
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+rescue nil
+end
+
+require 'owemegod'
+require 'minitest/spec'

data/lib/owemegod.rb

@@ -0,0 +1,5 @@
+require "owemegod/version"
+require 'owemegod/group'
+require 'owemegod/person'
+require 'owemegod/expense'
+require 'owemegod/expense_collection'

data/lib/owemegod/debt.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+
+module Owemegod
+  class Debt < OpenStruct
+  end
+end

data/lib/owemegod/debt_distribution.rb

@@ -0,0 +1,81 @@
+module Owemegod
+  class DebtDistribution
+    attr_accessor :people, :debts
+
+    def initialize(people)
+      self.people = people
+    end
+
+    def average_expenses
+      total_amount = people.reduce(0.0) do |sum, person|
+        sum += person.total_expenses
+      end
+      total_amount / people.length
+    end
+
+    def debts
+      @debts ||= []
+    end
+
+    def add_debt(from, to, amount)
+      debts << [from, to, amount]
+    end
+
+    def outgoing_debts(person)
+      debts.select do |debt|
+        debt[0] == person
+      end
+    end
+
+    def outgoing_debts_amount(person)
+      outgoing_debts(person).inject(0.0) do |sum, debt|
+        sum += debt[2]
+      end
+    end
+
+    def incoming_debts(person)
+      debts.select do |debt|
+        debt[1] == person
+      end
+    end
+
+    def incoming_debts_amount(person)
+      incoming_debts(person).inject(0.0) do |sum, debt|
+        sum += debt[2]
+      end
+    end
+
+    def balance_for(person)
+      person = people.find{|p| p == person}
+      raise "#{person.name} isn't in this distribution" unless person
+      initial_balance = average_expenses - person.total_expenses
+      initial_balance += incoming_debts_amount(person)
+      initial_balance -= outgoing_debts_amount(person)
+    end
+
+    def calculate
+      while(!even?)
+        from = most_positive_balance
+        to = most_negative_balance
+
+        if balance_for(from) > -balance_for(to)
+          add_debt(from, to, -balance_for(to))
+        else
+          add_debt(from, to, balance_for(from))
+        end
+      end
+    end
+
+    def most_positive_balance
+      people.shuffle.select{|p| balance_for(p) > 0}.max{|p| balance_for(p)}
+    end
+
+    def most_negative_balance
+      people.shuffle.select{|p| balance_for(p) < 0}.min{|p| balance_for(p)}
+    end
+
+    def even?
+      people.all?{|p| balance_for(p) >= 0}
+    end
+  end
+end

data/lib/owemegod/expense.rb

@@ -0,0 +1,11 @@
+require 'ostruct'
+
+module Owemegod
+  class Expense < OpenStruct
+    include Comparable
+
+    def <=>(another)
+      self.value <=> another.value
+    end
+  end
+end

data/lib/owemegod/expense_collection.rb

@@ -0,0 +1,25 @@
+require 'owemegod/expense'
+
+module Owemegod
+  class ExpenseCollection
+    include Enumerable
+
+    def expenses
+      @expenses ||= []
+    end
+
+    def add_expense(name, value)
+      expenses << Expense.new(name: name, value: value)
+    end
+
+    def value
+      inject(0){|sum, expense|  sum + expense.value}
+    end
+
+    def each(&block)
+      expenses.each do |expense|
+        block.call expense
+      end
+    end
+  end
+end

data/lib/owemegod/group.rb

@@ -0,0 +1,26 @@
+require 'owemegod/debt_distribution'
+
+module Owemegod
+  class Group
+
+    attr_accessor :people
+
+    # Initializes an event with a certain array of people
+    def initialize(people = [])
+      @people ||= []
+      people.each do |person|
+        add_person person
+      end
+    end
+
+    def add_person(person)
+      people << person
+    end
+
+    def distribute
+      distribution = DebtDistribution.new(people)
+      distribution.calculate
+      distribution
+    end
+  end
+end

data/lib/owemegod/person.rb

@@ -0,0 +1,25 @@
+require 'ostruct'
+require 'owemegod/expense_collection'
+
+module Owemegod
+  class Person < OpenStruct
+    attr_accessor :expenses
+
+    def initialize(*args)
+      super
+      self.expenses = ExpenseCollection.new
+    end
+
+    def expenses
+      @expenses
+    end
+
+    def add_expense(name, amount)
+      expenses.add_expense(name, amount)
+    end
+
+    def total_expenses
+      expenses.value
+    end
+  end
+end

data/lib/owemegod/version.rb

@@ -0,0 +1,3 @@
+module Owemegod
+  VERSION = "0.0.1"
+end

data/owemegod.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "owemegod/version"
+
+Gem::Specification.new do |s|
+  s.name        = "owemegod"
+  s.version     = Owemegod::VERSION
+  s.authors     = ["Josep Jaume"]
+  s.email       = ["josepjaume@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A gem for easily distribute debts among friends}
+  s.description = %q{A gem for easily distribute debts among friends}
+
+  s.rubyforge_project = "owemegod"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "spinach"
+  s.add_development_dependency "minitest-reporters"
+  s.add_development_dependency "ansi"
+end

data/spec/owemegod/debt_distribution_spec.rb

@@ -0,0 +1,95 @@
+require_relative '../spec_helper'
+require 'owemegod/debt_distribution'
+require 'ostruct'
+
+describe Owemegod::DebtDistribution do
+  subject{ Owemegod::DebtDistribution.new(people) }
+
+  let(:james) { OpenStruct.new(name: 'James', total_expenses: 15) }
+  let(:john)  { OpenStruct.new(name: 'John' , total_expenses: 5)  }
+  let(:alex)  { OpenStruct.new(name: 'Alex' , total_expenses: 0)  }
+  let(:sally) { OpenStruct.new(name: 'Sally', total_expenses: 10)  }
+  let(:people){ [james, john, alex, sally] }
+
+  before do
+    subject.add_debt(alex, james, 5)
+    subject.add_debt(john, sally, 1)
+    subject.add_debt(john, james, 1)
+  end
+
+
+  describe "#average_expenses" do
+    it "should return the average expenses" do
+      subject.average_expenses.must_equal 30.0 / 4
+    end
+  end
+
+  describe "debts" do
+    describe "#outgoing_debts" do
+      it "returns a list of all the debts for a person" do
+        subject.outgoing_debts(alex).length.must_equal 1
+        subject.outgoing_debts(james).length.must_equal 0
+        subject.outgoing_debts(john).length.must_equal 2
+      end
+    end
+
+    describe "#outgoing_debts_amount" do
+      it "returns the total amount of the debts of a person" do
+        subject.outgoing_debts_amount(alex).must_equal 5
+        subject.outgoing_debts_amount(john).must_equal 2
+      end
+    end
+
+    describe "#incoming_debts" do
+      it "returns a list of all the debts for a person" do
+        subject.incoming_debts(james).length.must_equal 2
+        subject.incoming_debts(john).length.must_equal 0
+        subject.incoming_debts(sally).length.must_equal 1
+      end
+    end
+
+    describe "#incoming_debts_amount" do
+      it "returns the total amount of debts other people have with a person" do
+        subject.incoming_debts_amount(james).must_equal 6
+        subject.incoming_debts_amount(sally).must_equal 1
+        subject.incoming_debts_amount(alex).must_equal 0
+      end
+    end
+  end
+
+  describe "#balance_for" do
+    describe "when there's no debt" do
+      before do
+        subject.debts = []
+      end
+
+      it "returns the starting balance for that person" do
+        subject.balance_for(james).must_equal -7.5
+        subject.balance_for(john).must_equal 2.5
+        subject.balance_for(alex).must_equal 7.5
+        subject.balance_for(sally).must_equal -2.5
+      end
+    end
+
+    describe "when there are some debts" do
+      it "returns the actual balance for that person" do
+        subject.balance_for(james).must_equal -1.5
+        subject.balance_for(john).must_equal 0.5
+        subject.balance_for(alex).must_equal 2.5
+        subject.balance_for(sally).must_equal -1.5
+      end
+    end
+  end
+
+  describe "#calculate" do
+    before do
+      subject.debts = nil
+    end
+    it "sets the balance of everyone to 0" do
+      subject.calculate
+      subject.people.each do |person|
+        subject.balance_for(person).must_equal 0
+      end
+    end
+  end
+end

data/spec/owemegod/expense_collection_spec.rb

@@ -0,0 +1,55 @@
+require_relative '../spec_helper'
+require 'owemegod/expense_collection'
+
+require 'ostruct'
+
+module Owemegod
+  describe Owemegod::ExpenseCollection do
+    subject { Owemegod::ExpenseCollection.new }
+    describe "#first" do
+      it "is nil when there's no expenses" do
+        subject.first.must_equal nil
+      end
+
+      it "returns the first expense when there's more expenses" do
+        subject.add_expense 'Foo', 2
+        subject.add_expense 'Bar', 3
+        subject.first.name.must_equal 'Foo'
+        subject.first.value.must_equal 2
+      end
+    end
+
+    describe "#total" do
+      it "returns 0 when there's no expense" do
+        subject.value.must_equal 0
+      end
+
+      it "returns the total amount of expenses" do
+        subject.add_expense "Foo", 5
+        subject.add_expense "Bar", 10
+        subject.value.must_equal 15
+      end
+    end
+
+    describe "#max" do
+      it "returns nil if there's no expense" do
+        subject.max.must_equal nil
+      end
+
+      it "returns the max expense" do
+        subject.add_expense "Foo", 5
+        subject.add_expense "Bar", 10
+        subject.max.value.must_equal 10
+        subject.max.name.must_equal "Bar"
+      end
+    end
+
+    describe "#to_a" do
+      it "returns a comprehensible array of expenses" do
+        subject.add_expense "Foo", 5
+        subject.add_expense "Bar", 10
+        subject.to_a[0].value.must_equal 5
+      end
+    end
+  end
+end

data/spec/owemegod/expense_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+require 'owemegod/expense'
+
+describe Owemegod::Expense do
+  describe "#initializer" do
+    it "sets the expense value" do
+      expense = Owemegod::Expense.new(value: 50)
+      expense.value.must_equal 50
+    end
+  end
+end

data/spec/owemegod/group_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../spec_helper'
+require 'owemegod/group'
+
+module Owemegod
+  describe Group do
+    describe "#initializer" do
+      it "initializes an array of people" do
+        person1 = Object.new
+        person2 = Object.new
+        event = Group.new [person1, person2]
+        event.people.must_include person1
+        event.people.must_include person2
+      end
+    end
+  end
+end

data/spec/owemegod/person_spec.rb

@@ -0,0 +1,19 @@
+require_relative '../spec_helper'
+require 'owemegod/person'
+
+describe Owemegod::Person do
+  subject{ Owemegod::Person.new(name: 'Josep Jaume')}
+  describe "#name" do
+    it "has a name" do
+      subject.name.must_equal "Josep Jaume"
+    end
+  end
+
+  describe "#total_expenses" do
+    describe "when there's no expense" do
+      it "returns 0" do
+        subject.total_expenses.must_equal 0
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+rescue nil
+end
+
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'minitest/reporters'
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::ProgressReporter.new

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: owemegod
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josep Jaume
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70365355724080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70365355724080
+- !ruby/object:Gem::Dependency
+  name: spinach
+  requirement: &70365355723440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70365355723440
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: &70365355723000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70365355723000
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: &70365355722500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70365355722500
+description: A gem for easily distribute debts among friends
+email:
+- josepjaume@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- Rakefile
+- Readme.md
+- features/debt_distribution.feature
+- features/steps/debt_distribution.rb
+- features/support/env.rb
+- lib/owemegod.rb
+- lib/owemegod/debt.rb
+- lib/owemegod/debt_distribution.rb
+- lib/owemegod/expense.rb
+- lib/owemegod/expense_collection.rb
+- lib/owemegod/group.rb
+- lib/owemegod/person.rb
+- lib/owemegod/version.rb
+- owemegod.gemspec
+- spec/owemegod/debt_distribution_spec.rb
+- spec/owemegod/expense_collection_spec.rb
+- spec/owemegod/expense_spec.rb
+- spec/owemegod/group_spec.rb
+- spec/owemegod/person_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: owemegod
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: A gem for easily distribute debts among friends
+test_files:
+- features/debt_distribution.feature
+- features/steps/debt_distribution.rb
+- features/support/env.rb
+- spec/owemegod/debt_distribution_spec.rb
+- spec/owemegod/expense_collection_spec.rb
+- spec/owemegod/expense_spec.rb
+- spec/owemegod/group_spec.rb
+- spec/owemegod/person_spec.rb
+- spec/spec_helper.rb