moneybook 0.1.8 → 0.2.0

data/README.md

@@ -0,0 +1,130 @@
+INTRO
+=====
+MoneyBook is a simple ruby command line application to track group expenses
+and know exactly how much each one of your friends owes you from your last trip!
+
+It's not super easy to use, nor is it meant to be (since I wrote it for myself), but
+it's meant to be powerful and useful.
+
+QUICK START
+===========
+
+to install simply do:
+    gem install moneybook
+    
+now to create your first moneybook file do:
+    moneybook new TITLE
+    
+and follow the onscreen instructions (give title, list of people in the group and optionally a currency exchange)
+next edit the file as you wish and, when you want to know how things stand (how much
+each one has to give/receive) simply do this:
+    moneybook parse moneybook_file.txt
+    
+If you want to see intermediate results (they will give you a better
+understanding of the whys..) simply add a -i option, like this:
+    moneybook parse -i moneybook_file.txt
+    
+To see other available options do this:
+    moneybook parse --help
+
+EXAMPLE FILE
+============
+
+    ### trip to paris ###
+    #### 2011-01-10 #####
+    #####################
+    
+    PEOPLE: Jack Mary Kevin
+    
+    # Jack payed 120$ for the tickets for all three..
+    flight tickets (120Jack)
+    
+    # Jack payed 50$ and Mary 30$ for the dinner at hotel, and they didn't all spend the same:
+    # Kev got a dessert! He spent 10$ more than the others..
+    dinner at hotel (50Jack 30Mary) +10Kevin
+    
+    # The museum was payed by Mary, and Kevin will pay only 5$ since he's a student.. Mary and 
+    # Jack will then pay the rest (10$ each). Names can be abbrev: Kevin -> Kev -> K
+    museum (25Mary) 5Kev
+    
+    # Knowing he was in debt, Kevin decides to give 50$ to Jack to start paying him back..
+    50Kevin -> Jack
+
+the output to the example file above is:
+
+    ### trip to paris ###
+    #### 2011-01-10 #####
+    #####################
+        
+    
+    # Jack payed 120$ for the tickets for all three..
+    ==== flight tickets (120Jack) ====
+    total: 120.0
+    +-------+-------+-------+
+    | jack  | kevin | mary  |
+    +-------+-------+-------+
+    | 120.0 |       |       |
+    | 40.0  | 40.0  | 40.0  |
+    +-------+-------+-------+
+    | 80.0  | -40.0 | -40.0 |
+    +-------+-------+-------+
+    | 80.0  | -40.0 | -40.0 |
+    +-------+-------+-------+
+    
+    # Jack payed 50$ and Mary 30$ for the dinner at hotel, and they didn't all spend the same:
+    # Kev got a dessert! He spent 10$ more than the others..
+    ==== dinner at hotel (50Jack 30Mary) +10Kevin ====
+    total: 80.0
+    +-------+-------+-------+
+    | jack  | kevin | mary  |
+    +-------+-------+-------+
+    | 50.0  |       | 30.0  |
+    | 23.3  | 33.3  | 23.3  |
+    +-------+-------+-------+
+    | 26.7  | -33.3 | 6.7   |
+    +-------+-------+-------+
+    | 106.7 | -73.3 | -33.3 |
+    +-------+-------+-------+
+    
+    # The museum was payed by Mary, and Kevin will pay only 5$ since he's a student.. Mary and 
+    # Jack will then pay the rest (10$ each). Names can be abbrev: Kevin -> Kev -> K
+    ==== museum (25Mary) 5Kev ====
+    total: 25.0
+    +-------+-------+-------+
+    | jack  | kevin | mary  |
+    +-------+-------+-------+
+    |       |       | 25.0  |
+    | 10.0  | 5.0   | 10.0  |
+    +-------+-------+-------+
+    | -10.0 | -5.0  | 15.0  |
+    +-------+-------+-------+
+    | 96.7  | -78.3 | -18.3 |
+    +-------+-------+-------+
+    
+    # Knowing he was in debt, Kevin decides to give 50$ to Jack to start paying him back..
+    ==== 50Kevin -> Jack ====
+    total: 50.0
+    +-------+-------+-------+
+    | jack  | kevin | mary  |
+    +-------+-------+-------+
+    |       | 50.0  |       |
+    | 50.0  |       |       |
+    +-------+-------+-------+
+    | -50.0 | 50.0  |       |
+    +-------+-------+-------+
+    | 46.7  | -28.3 | -18.3 |
+    +-------+-------+-------+
+    jack  	 receives      46.67 spent    73.33 given   170.00
+    mary  	 gives        -18.33 spent    73.33 given    55.00
+    kevin 	 gives        -28.33 spent    78.33 given    50.00
+
+
+
+each table is the result of each line in the source file, in each table there are 4 lines:
+the first line is what's been payed [given], the second line is who should have payed it [spent], 
+then third line is the difference (so if the number is negative, the person owes money to
+those whose number is positive), and the fourth line is the total balance that far.
+
+At the end the total balance is also printed in words, kevin and mary both give something
+to jack! And for each one is said how much he spent and how much he actually gave. The balance
+is the difference: given - (spent + paybacks). Paybacks are not considered in the spent field. 

data/Rakefile

@@ -13,7 +13,7 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "moneybook"
-  gem.homepage = "http://github.com/vircheck/moneybook"
+  gem.homepage = "http://github.com/vircheck/MoneyBook"
   gem.license = "MIT"
   gem.summary = "keep track of money in a group"
   gem.description = "keep track of money in a group"

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.2.0

data/bin/moneybook

@@ -11,6 +11,9 @@ require 'date'
 require 'abbrev'
 require 'pp'
 
+REGEXP_COMP_LINE = /^\s*([\w\ \']+?)\s*\((.+)\)\s*(.+)?/
+REGEXP_PAYBACK_LINE = /\A\s*(.+)\s*\-+\>\s*(.+)\Z/
+
 class Array
   def normalize_length
     max = self.inject{|longest, current| longest.to_s.length > current.to_s.length ? longest : current }.to_s.length
@@ -31,6 +34,14 @@ def process_command(cmd)
       opts.on("-i", "--[no-]intermediate", "Show intermediate computations") do |i|
         options[:intermediate] = i
       end
+      opts.on("-t", "--tail NUMBER", Integer, "Show intermediate computations only on last NUMBER lines") do |t|
+        options[:tail] = true
+        options[:tail_number] = t
+      end
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
     end.parse!(args)
     command_parse(options, args.last)
   else
@@ -96,27 +107,36 @@ def command_parse(options, filename)
   people_abbreviations = []
   sq = [] #big table to make the computations..
   f=File.open(filename,'r').read
+  ### in case it's a UTF-16LE file...
   if f[0]==255 && f[1]==254 then
     f=Iconv.iconv('UTF-8', 'UTF-16LE', f)[0][3..-1]
     puts "converting from UTF-16LE..."
   end
+  ### count number of computational lines (for the --tail option)
+  number_of_computational_lines = f.to_a.count{|x|x =~ REGEXP_PAYBACK_LINE || x =~ REGEXP_COMP_LINE}
+  reached_tail = !options[:tail]
+  current_comp_line = 0
+  ### start computation
   f.each_line{|line|
     if line =~ /^\s*\#/ || line =~ /\A\s*\Z/
       # this is interpreted as a comment line
-      puts line if intermediate
+      puts line if intermediate && reached_tail
     elsif (m = line.match(/\A\s*PEOPLE\s*\:?\s*((\s+\w+)+)\s*\Z/).andand[1].andand.split(/\s+/).andand.delete_if{|x|x==""}) != nil then
       m.each{|z|people<<z.to_s.downcase}
       people_abbreviations = people.abbrev
+      puts "[people in list: #{people.join(', ')}]" if intermediate
     elsif (currency_change == 0) && ((m = line.match(/\A\s*CHANGE\s*\:\s*([\.\d]+)\s*\Z/).andand[1].to_f) != 0) then
       currency_change = m
-      puts "currency change is #{currency_change}"
+      puts "[currency change is #{currency_change}]" if intermediate
     else
+      current_comp_line += 1
+      reached_tail = true if options[:tail] && current_comp_line > number_of_computational_lines - options[:tail_number]
       original_str = false
-      if temp=line.match(/\A\s*(.+)\s*\-+\>\s*(.+)\Z/) then
+      if temp=line.match(REGEXP_PAYBACK_LINE) then
         original_str = line.strip
         line = "PAYBACK (#{temp[1].to_s}) #{temp[2].to_s}"
       end
-      x = line.strip.match(/^\s*([\w\ \']+?)\s*\((.+)\)\s*(.+)?/).to_a.map{|z| z.to_s}
+      x = line.strip.match(REGEXP_COMP_LINE).to_a.map{|z| z.to_s}
       sq << {:name => x[1].to_s, :original_str => original_str || line.strip, :true_str => x[2].to_s, :virtual_str => x[3].to_s, :true => {}, :virtual => {}, :balance => {},
       :true_total => 0, :virtual_total => 0}
       c=sq.last
@@ -190,8 +210,8 @@ def command_parse(options, filename)
         c[:balance][person] = c[:true][person] - c[:virtual][person]
       }
       ### PRINT INTERMEDIATE RESULTS ###
-      if intermediate then
-        puts "==== #{c[:original_str].to_s} ===="
+      if intermediate && reached_tail then
+        puts "==== #{"%2d: " % current_comp_line} #{c[:original_str].to_s} ===="
         puts "total: #{c[:true_total].to_s}"
         mytable = table do |t|
           t.headings = people.sort
@@ -210,16 +230,16 @@ def command_parse(options, filename)
   }
   ### PRINT FINAL RESULTS ###
   final = get_final(sq, people)
-  puts "in local currency:" if currency_change > 0
+  puts "=== in local currency:" if currency_change > 0
   people_to_print = people.normalize_length
   people.each_index{|i|
     person = people[i]
-    puts "#{people_to_print[i]} \t #{final[0][person] > 0 ? 'receives' : 'gives   '}   #{"% 8.2f" % final[0][person]} spent #{"% 8.2f" % final[1][person]} given #{"% 8.2f" % final[2][person]}"
+    puts "#{people_to_print[i]}  #{final[0][person] > 0 ? 'receives' : 'gives   '}   #{"% 8.2f" % final[0][person]} spent #{"% 8.2f" % final[1][person]} given #{"% 8.2f" % final[2][person]}"
   }
-  puts "in converted currency:" if currency_change > 0
+  puts "=== in converted currency (multiplying by #{currency_change}):" if currency_change > 0
   people.each_index{|i|
     person = people[i]
-    puts "#{people_to_print[i]} \t #{final[0][person] > 0 ? 'receives' : 'gives   '}   #{"% 8.2f" % (final[0][person]*currency_change)} spent #{"% 8.2f" % (final[1][person]*currency_change)} given #{"% 8.2f" % (final[2][person]*currency_change)}" if currency_change > 0
+    puts "#{people_to_print[i]}  #{final[0][person] > 0 ? 'receives' : 'gives   '}   #{"% 8.2f" % (final[0][person]*currency_change)} spent #{"% 8.2f" % (final[1][person]*currency_change)} given #{"% 8.2f" % (final[2][person]*currency_change)}" if currency_change > 0
   }
 end
 

data/moneybook.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{moneybook}
-  s.version = "0.1.7"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["luca cioria"]
@@ -16,14 +16,14 @@ Gem::Specification.new do |s|
   s.executables = ["moneybook"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/moneybook",
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
     "test/helper.rb",
     "test/test_moneybook.rb"
   ]
-  s.homepage = %q{http://github.com/vircheck/moneybook}
+  s.homepage = %q{http://github.com/vircheck/MoneyBook}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.4.2}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: moneybook
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 8
-  version: 0.1.8
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - luca cioria
@@ -128,13 +128,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
 files: 
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/moneybook
@@ -143,7 +143,7 @@ files:
 - test/helper.rb
 - test/test_moneybook.rb
 has_rdoc: true
-homepage: http://github.com/vircheck/moneybook
+homepage: http://github.com/vircheck/MoneyBook
 licenses: 
 - MIT
 post_install_message: 

data/README.rdoc

@@ -1,19 +0,0 @@
-= moneybook
-
-Simple program to keep track of money in a ground, for example during a trip
-
-== Contributing to moneybook
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 luca cioria. See LICENSE.txt for
-further details.
-