moneymanager 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d12b2140748dad9d3d6eda4bdc9bb3000932eeba
-  data.tar.gz: 59f8c42433720e5875a1098a40a49b2a2572323a
+  metadata.gz: c07fde9f3699dfb8fe2264cfd3fbe5d935bc3e57
+  data.tar.gz: 596525dc60a1324c392f750a047e31165d349aa0
 SHA512:
-  metadata.gz: 57ae82ff42ba946498532d090b752293eaf5134e3a63afb986de516a7df120df2a92516ec3ce481a36f7823047c7249320863880f451b991f4ee89f8d0a2b0af
-  data.tar.gz: 489c85decc4ae67e7d2ec5314681a2088a1e6ce0fc8f84e43339fa885b35036305050e872b064f9ccb9bf6ddacd19c3a24262755f23a993e19f85081a17ccc63
+  metadata.gz: e3f41e6655efd33ee4e8f187bd73553f7d3d5fca7162fd90374d9db44f352bb5bcf2373e0c6e441c5e91e2af9a8a4455687c9174d6d816c9926edc3d05529b3a
+  data.tar.gz: 1b73623c3070702ecaff7fb6042d7e6a08fe6b5ebf6501f6b973038a13f395af8d2837c6df1c3781da7d824d6b8f3e28b1dd90aa16145873eaf66d8f1338f4dd

data/README.md

@@ -1,24 +1,34 @@
 # Moneymanager
 
-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)
+This is ruby app I wrote to help me managing my personal finance. My needs are quite basic:
+
+- Review all the bank transactions to find any fraud or issue
+- Tags the important expenses and incomes to monitor the trend overtime
+
+I wrote my own tool instead of using MoneyWiz because I like writing ruby code and all the commercial apps are overcomplicated for me
 
 ## Features
 
 * 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.
+* The import process is idempotent, the already imported transactions are just skipped.
 * 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.
+* Review the transaction and put a checkmarks on the approved ones.
+* Tag the transactions
+* Analize the transaction with the reports
+
+## Reports
+
+* Total income
+* Total expense
+* All incomes grouped by category
+* All expenses grouped by category
+* Trend of tag overtime
 
 ## Why you shouldn't use this
 
+* Probably your needs are different from mine.
 * The database is just a plain, non-encrypted file. 
-* There are no fancy charts.
-* The filter is _monthly_ based. If you have undreds of transaction per month this tool can be tedious.
-* 
+* There are no fancy charts (so far)
 
 ## Usage
 
@@ -77,7 +87,7 @@ Flag all the approved transaction.
 
 #### Tag each transaction
 
-Assign a tag to each (or not) transaction. To generate hierarchy of tags, use a `/` like `Car/Insurance`s
+Assign a tag to a transaction. To generate hierarchy of tags, use a `/` like `Car/Insurance`
 
 	$ mm tag
 	+----------+------------------------------------------------------+
@@ -117,7 +127,9 @@ Assign a tag to each (or not) transaction. To generate hierarchy of tags, use a
 
 ## Reporting
 
-#### Total
+#### Total (Incomes or Expenses)
+
+Print the total of the incomes or expenses on the whole archive or on the selected month
 
 	$ mm report --month 8
 
@@ -135,9 +147,11 @@ Assign a tag to each (or not) transaction. To generate hierarchy of tags, use a
 	| 99999.0 € |
 	+-----------+
 
+
 #### All Incomes/Expenses
 
-    
+Print the list of all the incomes (or expenses) grouped by tag. The entries without a tag are grouped into the `Unknown` tag.
+ 
      $ mm report
     Which type of report? (Use arrow keys, press Enter to select)
       Total (Incomes)
@@ -151,10 +165,10 @@ Assign a tag to each (or not) transaction. To generate hierarchy of tags, use a
     Which type of report? All Incomes
 	+--------------+----------+
 	| Kindergeld   |  999.0 € |
-	| Rimborsi     |  998.0 € |
-	| Stipendio    | 8998.0 € |
+	| Salary       |  999.0 € |
+	| Investments  | 9999.0 € |
 	| Stockoptions | 9999.0 € |
-	| Unknown      |  888.0 € |
+	| Unknown      |  999.0 € |
 	+--------------+----------+
 	|             9999999.0 € |
 	+--------------+----------+
@@ -162,6 +176,7 @@ Assign a tag to each (or not) transaction. To generate hierarchy of tags, use a
 
 #### 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)
@@ -178,25 +193,28 @@ Assign a tag to each (or not) transaction. To generate hierarchy of tags, use a
       Car/Insurance
       Car/Tire
     
-	Select a tag. Kita
-	+---+---------+
-	| 8 | -99.0 € |
-	| 9 | -99.0 € |
-	+---+---------+
-	|    -198.0 € |
-	+---+---------+
+	Select a tag. Heating
+	+-----------+---------+
+	| August    | -99.0 € |
+	| September | -99.0 € |
+	+-----------+---------+
+	|            -198.0 € |
+	+-----------+---------+
 
 
 
 
 ## To do
 
+* [x] Filter by one single entry
+* [x] Report for one tag splitted by month
 * [ ] Report for nested tags ( Car/Gasoline, Car/Insurance etc)
 * [ ] Multiple tags
-* [x] Report for one tag splitted by month
 * [ ] Add a backup options
 * [ ] Manage multiple banck account
 * [ ] Exclude account transfer from the list of expenses/incomes
+* [ ] Print fancy chart in html
+
 
 ## Contributing
 

data/exe/mm

@@ -32,8 +32,9 @@ command :print do |c|
   c.syntax = 'mm print [--month <month>]'
   c.description = 'Print the list of transactions'
   c.option '--month INTEGER', Integer, 'Specify the month to print.'
+  c.option '--entry STRING', String, 'Specify the entry to print.'
   c.action do |_args, options|
-    entries = get_entries(options.month)
+    entries = get_entries(options.month, options.entry)
     Layout.print_multiple(entries)
   end
 end
@@ -42,8 +43,9 @@ command :tag do |c|
   c.syntax = 'mm tags'
   c.description = 'Print the list of transactions'
   c.option '--month INTEGER', Integer, 'Specify the month to tag.'
+  c.option '--entry STRING', String, 'Specify the entry to tag.'
   c.action do |_args, options|
-    entries = get_entries(options.month)
+    entries = get_entries(options.month, options.entry)
     Tagger.new.retag(entries)
   end
 end
@@ -52,8 +54,9 @@ command :review do |c|
   c.syntax = 'mm review'
   c.description = 'Start the review process'
   c.option '--month INTEGER', Integer, 'Specify the month to review.'
+  c.option '--entry STRING', String, 'Specify the entry to review.'
   c.action do |_args, options|
-    entries = get_entries(options.month)
+    entries = get_entries(options.month, options.entry)
     Reviewer.new.review(entries)
   end
 end
@@ -63,7 +66,7 @@ command :report do |c|
   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)
+    entries = get_entries(options.month, nil)
 
     prompt = TTY::Prompt.new
     command = prompt.select('Which type of report?') do |menu|
@@ -88,17 +91,27 @@ command :report do |c|
       tags = archiver.tags.sort!
       tag = prompt.select('Select a tag.', tags, per_page: 30)
       report.print_group_by_month_report(entries,tag)
-      end
+    end
   end
 end
 
 
 
-def get_entries(month)
+def get_entries(month, entry_id)
   archiver = Moneymanager::Archiver.new
-  if month.nil?
-    archiver.all_entries
-  else
-    archiver.all_entries_per_month(month)
+  result = archiver.all_entries
+
+  unless month.nil?
+    result = result.select do |entry|
+      entry.date.month == month
+    end
   end
+
+  unless entry_id.nil?
+    result = result.select do |entry|
+      entry.digest.start_with?(entry_id)
+    end
+  end
+  result
 end
+

data/lib/moneymanager/archiver.rb

@@ -50,12 +50,6 @@ module Moneymanager
       @db[:entries].sort_by(&:date)
     end
 
-    def all_entries_per_month(month)
-      @db[:entries].sort_by(&:date).select do |entry|
-        entry.date.month == month
-      end
-    end
-
     def tags
       @db[:tags]
     end

data/lib/moneymanager/layout.rb

@@ -1,16 +1,21 @@
 class Layout
   def self.print_multiple(entries)
-    clear
-    rows = entries.map { |entry| [entry.formatted_approved, entry.date.strftime('%y/%m/%d'), entry.tag, entry.reason[0...50], entry.formatted_amount] }
+    if entries.count == 1
+      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]] }
 
-    table = Terminal::Table.new headings: ['✔/✖︎', 'Date', 'Tag', 'Reason', 'Amount'], rows: rows
-    table.align_column(4, :right)
-    table.align_column(0, :center)
+      table = Terminal::Table.new headings: ['✔/✖︎', 'Date', 'Tag', 'Reason', 'Amount', 'SHA1'], rows: rows
+      table.align_column(4, :right)
+      table.align_column(0, :center)
 
-    puts table
+      puts table
+    end
   end
 
   def self.print_single(entry)
+    clear
     hash = {
       date: entry.date,
       reason: entry.reason,
@@ -24,7 +29,7 @@ class Layout
   end
 
   def self.formatted_amount(amount)
-    s = amount.to_s + ' €'
+    s = sprintf('%.2f €', amount)
     amount < 0 ? s.red : s.green
   end
 

data/lib/moneymanager/parser.rb

@@ -33,7 +33,7 @@ module Moneymanager
         entry = Entry.new
         entry.date = Date.strptime(row[:buchungstag], '%d.%m.%y')
         entry.reason = row[:verwendungszweck].squeeze(' ')
-        entry.amount = row[:betrag].to_f
+        entry.amount = row[:betrag].to_s.gsub(',', '.').to_f
         entry.company = row[:beguenstigterzahlungspflichtiger].squeeze(' ')
         entry.raw = row.to_csv.squeeze(' ')
         entries << entry

data/lib/moneymanager/report.rb

@@ -27,7 +27,7 @@ class Report
     entries = entries.select { |entry|
       entry.tag == tag
     }.each_with_object(Hash.new(0)) { | current, sum |
-      month = current.date.month
+      month = current.date.strftime("%B")
       sum[month] += current.amount
     }
     Layout.print_generic_rows(entries)

data/lib/moneymanager/reviewer.rb

@@ -2,7 +2,6 @@ class Reviewer
   def review(entries)
     archiver = Moneymanager::Archiver.new
     entries.each do |entry|
-      Layout.clear
       Layout.print_single(entry)
       prompt = TTY::Prompt.new
       action = prompt.select('Do you recognize?', %i[yes no skip abort], per_page: 30)

data/lib/moneymanager/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moneymanager
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - ignazioc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-15 00:00:00.000000000 Z
+date: 2017-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander