moneymanager 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c6ed2a51631e896adc9d37ccd801863666e3daf
-  data.tar.gz: 90e85ddbf9508dc3b504adac53a1c78f2fbadfeb
+  metadata.gz: 39450e9d5be4a772dec12a2db8fb9d0067ead553
+  data.tar.gz: 0db1716715290873ac2c5a903ef24a0ca9cef7ef
 SHA512:
-  metadata.gz: 0b0d80d711e1f45d17faaf0c7b9ba502cd4b06c7eae31d70720c58ea6efffa5f3a1110b4592c4d4cc87ddbf9477f28d35e2627feb7e94648472449b4a62b2c89
-  data.tar.gz: bc74ae900f4f5cd0ed978ece2b34f454f09d6aa4e0dbe3b2c95fe9bfc81ecc723497c4a2056b0d30d38d7a83c3595172a7663f28b9bd83ed830b3592e9513796
+  metadata.gz: 79a578a780c6c0f523665c2b4da019912cc45588fc9ccaf76abb58e56a146a8998f2d8247b3165c91fc172ef0d19460b844eaf6a1e7faf3298b3f9b6289a9451
+  data.tar.gz: 0c3112832a722691da332cd101b5fbe39a721551b2e9135984f39cae1451444f1c21f45f9735eac9b7b889317df84e7beebfe2927d7f924668270704915f47cb

data/README.md

@@ -1,34 +1,199 @@
 # Moneymanager
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/moneymanager`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is ruby app I wrote to help me managing my personal finance. Some features are still missing, I'll add in the future.
+I ended up writing my own tool instead of using MoneyWiz et simila is that all the tools I tried are either overcomplicated or dont'have the basic information I need (and also because I like writing Ruby code)
 
-TODO: Delete this and the text above, and describe your gem
+## Features
 
-## Installation
+* Import transactions from a `CSV - CAMT` file. I'm not sure about your bank, but SparkasseBerlin has this option.
+* The import process is idempotent. Import same transaction multiple times doesn't get duplicate.
+* Print the list of transacions.
+* Review the transaction and flag all the approved ones.
+* Tag the transaction and assign a tag to each one
+* Print the summary of income/expense general or divided by category.
+* All the actions have an options to consider only a specific month.
 
-Add this line to your application's Gemfile:
+## Why you shouldn't use this
 
-```ruby
-gem 'moneymanager'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install moneymanager
+* The database is just a plain, non-encrypted file. 
+* There are no fancy charts.
+* The `print/review/tag` taks are _monthly_ based. If you have undreds of transaction per month using this tool can be tedious.
+* 
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### Install the gem
+
+	$ gem install moneymanager
+
+#### Import your CSV FILE
+
+	$ mm add exported.csv
+	Parsed:   99
+	Skipped:   0
+	Inserted: 99
+	# If executed twice, the entries are not duplicated
+	$ mm add exported.csv
+	Parsed:   99
+	Skipped:  99
+	Inserted: 0
+
+#### Print the transactions
+By default all the transactions are printed. A month can be specified with the `--month` parameter
+
+	$ mm print
+	+-----+----------+--------------+----------------------------------------------------+-------------+
+	| ✔/✖︎ | Date     | Tag          | Reason                                             | Amount      |
+	+-----+----------+--------------+----------------------------------------------------+-------------+
+	|  ✖︎︎  | 17/08/01 |              | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✖︎  | 17/08/01 |              | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✖︎  | 17/08/01 |              | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✖︎  | 17/08/01 |              | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✖︎  | 17/08/01 |              | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✖︎  | 17/08/02 |              | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✖︎  | 17/08/31 |              | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	+-----+----------+--------------+----------------------------------------------------+-------------+
+
+
+#### Review and approve the transactions
+Flag all the approved transaction.
+
+	$ mm review
+	+----------+------------------------------------------------------+
+	| Date     | 2017-08-01                                           |
+	| Reason   | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎   |
+	| Amount   | -999.0 €                                             |
+	| Company  | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎   |
+	| Approved | ✖                                                    |
+	| Tag      |                                                      |
+	+----------+------------------------------------------------------+
+	Do you recognize? (Use arrow keys, press Enter to select)
+	‣ yes
+	  no
+	  skip
+	  abort
+
+
+
+#### Tag each transaction
+
+Assign a tag to each (or not) transaction. To generate hierarchy of tags, use a `/` like `Car/Insurance`s
+
+	$ mm tag
+	+----------+------------------------------------------------------+
+	| Date     | 2017-08-01                                           |
+	| Reason   | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎   |
+	| Amount   | -99.0 €                                              |
+	| Company  | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎   |
+	| Approved | ✔︎                                                    |
+	| Tag      |                                                      |
+	+----------+------------------------------------------------------+
+	Do you want add a tags? (Use arrow keys, press Enter to select)
+	‣ 1. Skip
+	  2. Abort
+	  3. Create
+	  Car/Gasoline
+	  Car/Insurance
+	  Car/Tire
+	  Heating
+	  Mortage
+	  
+
+
+#### Enjoi the list of transaction
+
+	$ mm print
+	+-----+----------+------------------------+--------------------------------------------------+-------------+
+	| ✔/✖︎ | Date     | Tag                    | Reason                                           | Amount      |
+	+-----+----------+------------------------+--------------------------------------------------+-------------+
+	|  ✔︎  | 17/08/01 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/01 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/01 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/31 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/31 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/31 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/31 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	+-----+----------+------------------------+--------------------------------------------------+-------------+
+
+## Reporting
+
+#### Global Incomes/Expenses
+
+	$ mm report --month 8
+
+    $ mm report --month 8
+    Which type of report? (Use arrow keys, press Enter to select)
+    ‣ Global Incomes/Expenses
+      All categories
+      One category
+
+
+    +---------+-----------+
+    |       Summary       |
+    +---------+-----------+
+    | Income  |  1234.0 € |
+    | Expense | -5678.0 € |
+    | Delta   |  9999.0 € |
+    +---------+-----------+
+
+#### Global Incomes/Expenses
+
+    
+     $ mm report
+    Which type of report? (Use arrow keys, press Enter to select)
+      Global Incomes/Expenses
+    ‣ All categories
+      One category
+    
+    
+    +------------+----------+
+    |        Incomes        |
+    +------------+----------+
+    | Salary     |  999.0 € |
+    | Investment |  999.0 € |
+    | Rent       |  999.0 € |
+    +------------+----------+
+    +-------------------+-----------+
+    |           Expenses            |
+    +-------------------+-----------+
+    | Heating           |   -99.0 € |
+    | Mortage           |   -99.0 € |
+    | Car/Gasoline      |   -99.0 € |
+    | Car/Insurace      | -9999.0 € |
+    | Car/Tire          |  -999.0 € |
+    +-------------------+-----------+
+    
+
+#### Report for one Tag
+
+
+     $ mm report
+    Which type of report? (Use arrow keys, press Enter to select)
+      Global Incomes/Expenses
+      All categories
+    ‣ One category
+    
+    Select a tag. (Use arrow keys, press Enter to select)
+    ‣ Heating
+      Mortage
+      Car/Gasoline
+      Car/Insurance
+      Car/Tire
+    
+    +-----------------+---------+
+    |         Expenses          |
+    +-----------------+---------+
+    | Heating         | -99.0 € |
+    +-----------------+---------+
+
+
+
+
+## Next release
+
+* Report for nested tags ( Car/Gasoline, Car/Insurance etc)
+* Multiple tags
+* Report for one tag splitted by month
 
 ## Contributing
 

data/exe/mm

@@ -18,6 +18,16 @@ command :add do |c|
   end
 end
 
+command :reset do |c|
+  c.syntax = 'mm reset'
+  c.description = 'Delete the current archive (danger zone!)'
+  c.action do |_args, _options|
+    if agree('Do you really want to delete everything?')
+      Moneymanager::Archiver.reset
+    end
+  end
+end
+
 command :print do |c|
   c.syntax = 'mm print [--month <month>]'
   c.description = 'Print the list of transactions'
@@ -48,21 +58,69 @@ command :review do |c|
   end
 end
 
-command :summary do |c|
-  c.syntax = 'mm summary'
-  c.description = 'Print the sum of the revenue, the sum of the expenses and the differences'
-  c.option '--month INTEGER', Integer, 'Specify the month to review.'
+command :report do |c|
+  c.syntax = 'mm report'
+  c.description = 'Print all the revenues and all the expenses grouped by tag'
+  c.option '--month INTEGER', Integer, 'Specify the month to report.'
   c.action do |_args, options|
     entries = get_entries(options.month)
-    expenses =  entries.reject(&:is_income).map(&:amount).reduce(:+)
-    incomes = entries.reject(&:is_expense).map(&:amount).reduce(:+)
-    Layout.print_summary(incomes, expenses)
 
+    prompt = TTY::Prompt.new
+    command = prompt.select('Which type of report?') do |menu|
+      menu.choice 'Global Incomes/Expenses', :global
+      menu.choice 'All categories', :all
+      menu.choice 'Specific Tag', :one
+    end
+
+    case command
+    when :global
+      print_global_report(entries)
+    when :all
+      print_all_categories_report(entries)
+    when :one
+      archiver = Moneymanager::Archiver.new
+      tags = archiver.tags.sort!
+      tag = prompt.select('Select a tag.', tags, per_page: 30)
+      print_one_category_report(entries, tag)
+      end
   end
 end
 
+def print_global_report(entries)
+  expenses = entries.reject(&:income?).map(&:amount).reduce(:+)
+  incomes = entries.reject(&:expense?).map(&:amount).reduce(:+)
+  Layout.print_summary(incomes, expenses)
+end
+
+def print_all_categories_report(entries)
+  expenses = entries.reject(&:income?).each_with_object(Hash.new(0)) do |current, sum|
+    tag = current.tag ||= 'Unknown'
+    sum[tag] += current.amount
+  end
+  incomes = entries.reject(&:expense?).each_with_object(Hash.new(0)) do |current, sum|
+    tag = current.tag ||= 'Unknown'
+    sum[tag] += current.amount
+  end
+
+  incomes = incomes.map { |x, v| [x, v] }
+  Layout.print_summary_per_category('Incomes', incomes)
+
+  expenses = expenses.map { |x, v| [x, v] }
+  Layout.print_summary_per_category('Expenses', expenses)
+end
+
+def print_one_category_report(entries, tag)
+  entries = entries.select do |entry|
+    entry.tag == tag
+  end
+  print_all_categories_report(entries)
+end
+
 def get_entries(month)
-  month ||= Date.today.month
   archiver = Moneymanager::Archiver.new
-  archiver.all_entries_per_month(month)
+  if month.nil?
+    archiver.all_entries
+  else
+    archiver.all_entries_per_month(month)
+  end
 end

data/lib/moneymanager/archiver.rb

@@ -16,10 +16,10 @@ module Moneymanager
     end
 
     def initialize
-      @db = if File.exist? Archiver.archive_path
-        YAML.load_file(Archiver.archive_path)
+      if File.exist? Archiver.archive_path
+        @db = YAML.load_file(Archiver.archive_path)
       else
-        Archiver.empty_archive
+        @db = Archiver.empty_archive
       end
     end
 
@@ -59,6 +59,7 @@ module Moneymanager
     def tags
       @db[:tags]
     end
+
     def store_tag(tag)
       @db[:tags] << tag
       save

data/lib/moneymanager/entry.rb

@@ -28,12 +28,12 @@ module Moneymanager
       amount < 0 ? s.red : s.green
     end
 
-    def is_expense
+    def expense?
       amount < 0
     end
-    def is_income
-      !is_expense
+
+    def income?
+      !expense?
     end
-    
   end
 end

data/lib/moneymanager/layout.rb

@@ -24,8 +24,8 @@ class Layout
   end
 
   def self.formatted_amount(amount)
-      s = amount.to_s + ' €'
-      amount < 0 ? s.red : s.green
+    s = amount.to_s + ' €'
+    amount < 0 ? s.red : s.green
   end
 
   def self.print_summary(income, expenses)
@@ -36,7 +36,21 @@ class Layout
       t << ['Delta', formatted_amount(delta)]
     end
     table.align_column(1, :right)
-    table.title = "Summary"
+    table.title = 'Summary'
+    puts table
+  end
+
+  def self.print_summary_per_category(title, rows)
+    return unless rows.count > 0
+    rows = rows.sort! { |r1, r2| r1.first <=> r2.first }
+    rows = rows.map do |row|
+      row[-1] = formatted_amount(row.last)
+      row
+    end
+    table = Terminal::Table.new rows: rows
+    table.align_column(1, :right)
+    table.title = title
+
     puts table
   end
 

data/lib/moneymanager/tagger.rb

@@ -6,13 +6,11 @@ class Tagger
   def retag(entries)
     archiver = Moneymanager::Archiver.new
 
-
-
     prompt = TTY::Prompt.new
     entries.each do |entry|
       Layout.clear
       Layout.print_single(entry)
-      options = default_options.concat(archiver.tags)
+      options = default_options.concat(archiver.tags.sort!)
       action = prompt.select('Do you want add a tags?', options, per_page: 30)
 
       if action == default_options[0]

data/lib/moneymanager/version.rb

@@ -1,3 +1,3 @@
 module Moneymanager
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/moneymanager.rb

@@ -1,7 +1,7 @@
 require 'terminal-table'
 require 'colorize'
 require 'tty-prompt'
-require "moneymanager/version"
+require 'moneymanager/version'
 require 'moneymanager/archiver'
 require 'moneymanager/layout'
 require 'moneymanager/parser'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moneymanager
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - ignazioc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander