moneymanager 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c07fde9f3699dfb8fe2264cfd3fbe5d935bc3e57
-  data.tar.gz: 596525dc60a1324c392f750a047e31165d349aa0
+  metadata.gz: b48c22d9b20b8fb3a2079e37481b02312fb33dd9
+  data.tar.gz: 4798bf1ef13e3b70e7a9abf2e396e8780c7d3a94
 SHA512:
-  metadata.gz: e3f41e6655efd33ee4e8f187bd73553f7d3d5fca7162fd90374d9db44f352bb5bcf2373e0c6e441c5e91e2af9a8a4455687c9174d6d816c9926edc3d05529b3a
-  data.tar.gz: 1b73623c3070702ecaff7fb6042d7e6a08fe6b5ebf6501f6b973038a13f395af8d2837c6df1c3781da7d824d6b8f3e28b1dd90aa16145873eaf66d8f1338f4dd
+  metadata.gz: 5cda47c9009ade56c80330082717e72bd6b679d1c152f123f9d96efeb910d781810e39f8a20baf2ecbd3169273e63ef2a7b69b851f4253d6e4f09b5a5d54e969
+  data.tar.gz: a7c7d07db40d9155aba911407e030778b9d26ca13568ef0c43cd9ef0924cf5a181e2bab2322acf3d3fdef2a729788ef36b76e4c5dc1a91e29a0a88939b165e1d

data/README.md

@@ -22,6 +22,7 @@ I wrote my own tool instead of using MoneyWiz because I like writing ruby code a
 * Total expense
 * All incomes grouped by category
 * All expenses grouped by category
+* All the entries with a specific tag
 * Trend of tag overtime
 
 ## Why you shouldn't use this
@@ -125,6 +126,15 @@ Assign a tag to a transaction. To generate hierarchy of tags, use a `/` like `Ca
 	|  ✔︎  | 17/08/31 | ◼◼◼◼◼◼ Censored ◼◼◼◼◼◼ | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
 	+-----+----------+------------------------+--------------------------------------------------+-------------+
 
+
+#### Mark a transaction as bank transfer in order to be skipped on the normal reports
+
+The edit command supports only one option so far.
+
+    $ mm edit --entry c88f92
+    Select one option: (Use arrow keys, press Enter to select)
+    ‣ Toggle banck transfer state
+
 ## Reporting
 
 #### Total (Incomes or Expenses)
@@ -140,6 +150,7 @@ Print the total of the incomes or expenses on the whole archive or on the select
 	  All Incomes
 	  All Expenses
 	  Specific Tag
+	  Specific Tag (grouped by month)
 
 
 	Which type of report? Total (Incomes)
@@ -159,6 +170,7 @@ Print the list of all the incomes (or expenses) grouped by tag. The entries with
 	‣ All Incomes
 	  All Expenses
 	  Specific Tag
+	  Specific Tag (grouped by month)
     
       
     
@@ -173,7 +185,6 @@ Print the list of all the incomes (or expenses) grouped by tag. The entries with
 	|             9999999.0 € |
 	+--------------+----------+
     
-
 #### One tag grouped by month
 
 Print al list in which the entries with the selected tag are grouped by month. This is the report you want to use to understand if your heating bill is becoming bigger overtime.
@@ -185,6 +196,37 @@ Print al list in which the entries with the selected tag are grouped by month. T
 	  All Incomes
 	  All Expenses
 	‣ Specific Tag
+	  Specific Tag (grouped by month)
+    
+    Select a tag. (Use arrow keys, press Enter to select)
+    ‣ Heating
+      Mortage
+      Car/Gasoline
+      Car/Insurance
+      Car/Tire
+    
+	Select a tag. Heating
+	+-----+----------+---------+--------------------------------------------------+-------------+
+	| ✔/✖︎ | Date     | Tag     | Reason                                           | Amount      |
+	+-----+----------+---------+--------------------------------------------------+-------------+
+	|  ✔︎  | 17/08/01 | Heating | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/01 | Heating | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	|  ✔︎  | 17/08/31 | Heating | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € |
+	+-----+----------+---------+--------------------------------------------------+-------------+
+
+
+#### One tag grouped by month
+
+Print al list in which the entries with the selected tag are grouped by month. This is the report you want to use to understand if your heating bill is becoming bigger overtime.
+
+     $ mm report
+    Which type of report? (Use arrow keys, press Enter to select)
+      Total (Incomes)
+	  Total (Expenses)
+	  All Incomes
+	  All Expenses
+	  Specific Tag
+	‣ Specific Tag (grouped by month)
     
     Select a tag. (Use arrow keys, press Enter to select)
     ‣ Heating
@@ -201,19 +243,38 @@ Print al list in which the entries with the selected tag are grouped by month. T
 	|            -198.0 € |
 	+-----------+---------+
 
+#### One tag grouped by month
 
+If you're moving some money to/from a different account of yours, the related entries should be marked as "bank transfer" in order to not compromise your income/expense reports. This specific report can be used to print only the bank transfers entries
 
+    Which type of report? (Use arrow keys, press Enter to select)
+    ‣ Total (Incomes)
+      Total (Expenses)
+      All Incomes
+      All Expenses
+      Specific Tag
+      Specific Tag (grouped by month)
+      Bank transfers
+
+     +-----+---+----------+--------+-------------------------------------------------+--------------+--------+
+     | ✔/✖︎ | ♻︎ | Date     | Tag    | Reason                                          | Amount       | SHA1   |
+     +-----+---+----------+--------+-------------------------------------------------+--------------+--------+
+     |  ✔︎  | ♻︎ | 01/01/17 | Invest | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € | 2949af |
+     |  ✔︎  | ♻︎ | 01/02/17 | Invest | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € | 002862 |
+     |  ✔︎  | ♻︎ | 01/03/17 | Invest | ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼ C E N S O R E D ◼◼◼◼◼◼◼◼◼◼◼◼◼◼◼︎ |  99999.99 € | c88f92 |
+     +-----+---+----------+--------+-------------------------------------------------+--------------+--------+
 
 ## To do
 
 * [x] Filter by one single entry
 * [x] Report for one tag splitted by month
+* [x] Add a backup options
+* [x] Exclude account transfers from the list of expenses/incomes
 * [ ] Report for nested tags ( Car/Gasoline, Car/Insurance etc)
 * [ ] Multiple tags
-* [ ] Add a backup options
-* [ ] Manage multiple banck account
-* [ ] Exclude account transfer from the list of expenses/incomes
+* [ ] Manage multiple bank account
 * [ ] Print fancy chart in html
+* [ ] Add more parameters to directly generate the reports avoid the manual selection.
 
 
 ## Contributing

data/exe/mm

@@ -18,13 +18,20 @@ command :add do |c|
   end
 end
 
+command :backup do |c|
+  c.syntax = 'mm backup'
+  c.description = 'Create a backup copy of your archive (~/.moneymanager)'
+  c.action do |_args, _options|
+    archiver = Moneymanager::Archiver.new
+    archiver.backup
+  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
+    Moneymanager::Archiver.reset if agree('Do you really want to delete everything?')
   end
 end
 
@@ -39,6 +46,31 @@ command :print do |c|
   end
 end
 
+command :edit do |c|
+  c.syntax = 'mm edit --entry SHA1'
+  c.description = 'Edit the selected entry'
+  c.option '--entry STRING', String, 'Specify the entry to edit.'
+  c.action do |_args, options|
+    raise ArgumentError, '--entry is required!' unless options.entry
+    entry = get_entries(nil, options.entry).first
+    prompt = TTY::Prompt.new
+    command = prompt.select('Select one option:') do |menu|
+      menu.choice 'Toggle bank transfer state', :toggle_bank_transfer
+      menu.choice 'Delete', :delete_transaction
+    end
+    case command
+    when :toggle_bank_transfer
+      archiver = Moneymanager::Archiver.new
+      entry.bank_transfer = !entry.bank_transfer
+      archiver.update(entry)
+    when :delete_transaction
+      archiver = Moneymanager::Archiver.new
+      Layout.print_single(entry)
+      archiver.delete(entry) if agree('Delete?')
+    end
+  end
+end
+
 command :tag do |c|
   c.syntax = 'mm tags'
   c.description = 'Print the list of transactions'
@@ -69,12 +101,14 @@ command :report do |c|
     entries = get_entries(options.month, nil)
 
     prompt = TTY::Prompt.new
-    command = prompt.select('Which type of report?') do |menu|
+    command = prompt.select('Which type of report?', per_page: 30) do |menu|
       menu.choice 'Total (Incomes)', :global_incomes
       menu.choice 'Total (Expenses)', :global_expenses
       menu.choice 'All Incomes', :all_incomes
       menu.choice 'All Expenses', :all_expenses
       menu.choice 'Specific Tag', :one_tag
+      menu.choice 'Specific Tag (grouped by month)', :one_tag_grouped_by_month
+      menu.choice 'Bank transfers', :bank_transfers
     end
     report = Report.new
     case command
@@ -86,17 +120,24 @@ command :report do |c|
       report.print_group_by_categories_report(entries, true)
     when :all_expenses
       report.print_group_by_categories_report(entries, false)
+    when :one_tag_grouped_by_month
+      archiver = Moneymanager::Archiver.new
+      tags = archiver.tags.sort!
+      tag = prompt.select('Select a tag.', tags, per_page: 30)
+      report.print_group_by_month_report(entries, tag)
     when :one_tag
       archiver = Moneymanager::Archiver.new
       tags = archiver.tags.sort!
       tag = prompt.select('Select a tag.', tags, per_page: 30)
-      report.print_group_by_month_report(entries,tag)
+      report.print_only_matching_tag(entries, tag)
+    when :bank_transfers
+      archiver = Moneymanager::Archiver.new
+      entries = archiver.all_bank_transfers
+      Layout.print_multiple(entries)
     end
   end
 end
 
-
-
 def get_entries(month, entry_id)
   archiver = Moneymanager::Archiver.new
   result = archiver.all_entries
@@ -114,4 +155,3 @@ def get_entries(month, entry_id)
   end
   result
 end
-

data/lib/moneymanager/archiver.rb

@@ -1,9 +1,21 @@
 require 'yaml'
+require 'fileutils'
 
 module Moneymanager
   class Archiver
-    def self.archive_path
-      File.join(Dir.home, '.moneymanager')
+    attr_accessor :home_folder
+
+    def base_path
+      File.join(home_folder, '.moneymanager')
+    end
+
+    def archive_path
+      File.join(base_path, 'archive')
+    end
+
+    def backup_path
+      date_filename = Time.now.to_i.to_s
+      File.join(base_path, date_filename)
     end
 
     def self.empty_archive
@@ -15,16 +27,23 @@ module Moneymanager
       File.write(Archiver.archive_path, Archiver.empty_archive.to_yaml)
     end
 
-    def initialize
-      if File.exist? Archiver.archive_path
-        @db = YAML.load_file(Archiver.archive_path)
-      else
-        @db = Archiver.empty_archive
-      end
+    def backup
+      File.write(backup_path, @db.to_yaml)
+    end
+
+    def initialize(home_folder = Dir.home)
+      self.home_folder = home_folder
+
+      FileUtils.mkdir_p(base_path)
+      @db = if File.exist? archive_path
+              YAML.load_file(archive_path)
+            else
+              Archiver.empty_archive
+            end
     end
 
     def save
-      File.write(Archiver.archive_path, @db.to_yaml)
+      File.write(archive_path, @db.to_yaml)
     end
 
     def store(entries)
@@ -46,10 +65,20 @@ module Moneymanager
       save
     end
 
+    def delete(entry)
+      puts entry
+      @db[:entries].delete_if { |obj| obj.digest == entry.digest }
+      save
+    end
+
     def all_entries
       @db[:entries].sort_by(&:date)
     end
 
+    def all_bank_transfers
+      @db[:entries].sort_by(&:date).select(&:bank_transfer)
+    end
+
     def tags
       @db[:tags]
     end

data/lib/moneymanager/entry.rb

@@ -1,10 +1,12 @@
 require 'digest/sha1'
 module Moneymanager
   class Entry
-    attr_accessor :date, :reason, :amount, :company, :raw, :approved, :tag
+    attr_accessor :id, :date, :reason, :amount, :company, :raw, :approved, :tag, :bank_transfer
 
     def initialize
+      @amount = 0
       @approved = false
+      @bank_transfer = false
     end
 
     def digest
@@ -23,17 +25,29 @@ module Moneymanager
       end
     end
 
+    def formatted_is_bank_tranfer
+      if bank_transfer
+        '♻︎'.yellow
+      else
+        ''
+      end
+    end
+
     def formatted_amount
       s = amount.to_s + ' €'
       amount < 0 ? s.red : s.green
     end
 
     def expense?
-      amount < 0
+      amount < 0 && !bank_transfer
     end
 
     def income?
-      !expense?
+      amount > 0 && !bank_transfer
+    end
+
+    def bank_transfer?
+      bank_transfer
     end
   end
 end

data/lib/moneymanager/layout.rb

@@ -4,10 +4,10 @@ class Layout
       print_single(entries.first)
     else
       clear
-      rows = entries.map { |entry| [entry.formatted_approved, entry.date.strftime('%y/%m/%d'), entry.tag, entry.reason[0...50], entry.formatted_amount, entry.digest[0...6]] }
+      rows = entries.map { |entry| [entry.formatted_approved, entry.formatted_is_bank_tranfer, entry.date.strftime('%d/%m/%y'), entry.tag, entry.reason[0...50], entry.formatted_amount, entry.digest[0...6]] }
 
-      table = Terminal::Table.new headings: ['✔/✖︎', 'Date', 'Tag', 'Reason', 'Amount', 'SHA1'], rows: rows
-      table.align_column(4, :right)
+      table = Terminal::Table.new headings: ['✔/✖︎', '♻︎', 'Date', 'Tag', 'Reason', 'Amount', 'SHA1'], rows: rows
+      table.align_column(5, :right)
       table.align_column(0, :center)
 
       puts table
@@ -22,6 +22,7 @@ class Layout
       amount: entry.formatted_amount,
       company: entry.company,
       approved: entry.formatted_approved,
+      bank_transfer: entry.formatted_is_bank_tranfer,
       tag: entry.tag
     }
     rows = hash.map { |k, v| [k.to_s.capitalize, v] }
@@ -29,7 +30,7 @@ class Layout
   end
 
   def self.formatted_amount(amount)
-    s = sprintf('%.2f €', amount)
+    s = format('%.2f €', amount)
     amount < 0 ? s.red : s.green
   end
 
@@ -43,15 +44,16 @@ class Layout
 
   def self.print_generic_rows(rows)
     return unless rows.count > 0
-    sum = rows.reduce(0) { |  tot, row | tot + row.last }
+    sum = rows.reduce(0) { |tot, row| tot + row.last }
     table = Terminal::Table.new
-    rows = rows.each { |row|
+    rows.each do |row|
       table.add_row [
-        { :value => row[0], :alignment => :left},
-      { :value => formatted_amount(row.last), :alignment => :right }]
-    }
+        { value: row[0], alignment: :left },
+        { value: formatted_amount(row.last), alignment: :right }
+      ]
+    end
     table.add_separator
-    table.add_row [{ :value => formatted_amount(sum), :colspan => 2, :alignment => :right }]
+    table.add_row [{ value: formatted_amount(sum), colspan: 2, alignment: :right }]
 
     puts table
   end

data/lib/moneymanager/parser.rb

@@ -29,15 +29,21 @@ module Moneymanager
     def parse
       options = { headers: true, return_headers: false, header_converters: :symbol, converters: :all, col_sep: ';' }
       entries = []
+      invalid = 0
       CSV.foreach(@local_file, options) do |row|
-        entry = Entry.new
-        entry.date = Date.strptime(row[:buchungstag], '%d.%m.%y')
-        entry.reason = row[:verwendungszweck].squeeze(' ')
-        entry.amount = row[:betrag].to_s.gsub(',', '.').to_f
-        entry.company = row[:beguenstigterzahlungspflichtiger].squeeze(' ')
-        entry.raw = row.to_csv.squeeze(' ')
-        entries << entry
+        if row[:info] == 'Umsatz gebucht'
+          entry = Entry.new
+          entry.date = Date.strptime(row[:buchungstag], '%d.%m.%y')
+          entry.reason = row[:verwendungszweck].squeeze(' ')
+          entry.amount = row[:betrag].to_s.tr(',', '.').to_f
+          entry.company = row[:beguenstigterzahlungspflichtiger].squeeze(' ')
+          entry.raw = row.to_csv.gsub(/\s+/, "")
+          entries << entry
+        else
+          invalid += 1
+        end
       end
+      puts "Invalid: #{invalid}"
       entries
     end
   end

data/lib/moneymanager/report.rb

@@ -1,35 +1,43 @@
 class Report
-
-  def print_total_report(entries, onlyIncome)
-    total = 0
-    if (onlyIncome)
-      total = entries.reject(&:expense?).map(&:amount).reduce(:+)
-    else
-      total = entries.reject(&:income?).map(&:amount).reduce(:+)
-    end
+  def print_total_report(entries, only_income)
+    total = if only_income
+              entries.select(&:income?).map(&:amount).reduce(:+)
+            else
+              entries.select(&:expense?).map(&:amount).reduce(:+)
+            end
     Layout.print_single_value(total)
   end
 
-  def print_group_by_categories_report(entries, onlyIncome)
-
-    entries = entries.select { |entry|
-      entry.income? == onlyIncome
-    }.each_with_object(Hash.new(0)) { |current, sum|
+  def print_group_by_categories_report(entries, only_income)
+    entries = entries.select do |entry|
+      if only_income
+        entry.income?
+      else
+        entry.expense?
+      end
+    end.each_with_object(Hash.new(0)) do |current, sum|
       tag = current.tag ||= 'Unknown'
       sum[tag] += current.amount
-    }.map { |x, v|
+    end.map do |x, v|
       [x, v]
-    }.sort! { |r1, r2| r1.first <=> r2.first }
+    end.sort! { |r1, r2| r1.first <=> r2.first }
     Layout.print_generic_rows(entries)
   end
 
   def print_group_by_month_report(entries, tag)
-    entries = entries.select { |entry|
+    entries = entries.select do |entry|
       entry.tag == tag
-    }.each_with_object(Hash.new(0)) { | current, sum |
-      month = current.date.strftime("%B")
+    end.each_with_object(Hash.new(0)) do |current, sum|
+      month = current.date.strftime('%B')
       sum[month] += current.amount
-    }
+    end
     Layout.print_generic_rows(entries)
   end
+
+  def print_only_matching_tag(entries, tag)
+    entries = entries.select do |entry|
+      entry.tag == tag
+    end
+    Layout.print_multiple(entries)
+  end
 end

data/lib/moneymanager/version.rb

@@ -1,3 +1,3 @@
 module Moneymanager
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moneymanager
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - ignazioc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Import dta from your bank and manage your money