cashflow 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef9f0c7756918829098a92909f3caa7b6ef8e1f9
-  data.tar.gz: f3c2bc0c93ff26b93adcd08c06deb509b05d95f6
+  metadata.gz: 107cc67b642f951260cc80eac4ee26dc91019d8c
+  data.tar.gz: 456365241263c8ef910fe7fe05cea8a7e79bcaf7
 SHA512:
-  metadata.gz: 2341886f04cfbc1d896878d4e5c966354afdef260e428e6f6c3ec3065a1cb124bb41d489b83177cc3bfe32b2b901dfd9c11a863f74a8fe7f2683e401f42324ae
-  data.tar.gz: 510cda8a2669b9e4dcbc68789aba16e5eb5e6c672673543764ba3410d3ea51e9e48a0abf5c7fe76a881470b70a5ca2401956975f6392544eecc8fe6e43fa2683
+  metadata.gz: 16c878c53075f8ea22e660b2ac6db3b8069a057d78ff2574d02fa3e24090d256c28afa56440fad16db4c4571a3d59a53800b33b62ec81e2e734669b3a7258aa0
+  data.tar.gz: d1921429cf9a762ea6ac6b43442167a0416fd51c8b355ea0362a77a0486a5fdeb43a441354085ce61604b82b60e40936c118bc38714d2c35f03c0d29f46c7df6

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 TODO
+db/cashflow.db

data/README.md

@@ -3,7 +3,7 @@ Cashflow
 
 **Compare your latest income & expenses to your average.**
 
-Cashflow is a simple command-line application written in Ruby using [Thor](https://github.com/wycats/thor). It's purpose is simple: to analyse your bank transactions (collecting only the _date_ and _amount_) in order to build an average if your income and expenses over the last few months and compare these with the income and expenses for the current month.
+_Cashflow_ is a simple command-line application written in Ruby using [Thor](https://github.com/wycats/thor). It's purpose is simple: to analyse your bank transactions (collecting only the _date_ and _amount_) in order to build an average if your income and expenses over the last few months and compare these with the income and expenses for the current month.
 
 Only transactions up to the current day of the month are included, so the app gives you good insight into your financial position at this exact point in the month - extremely useful when you have regular monthly transactions such as rent and salary.
 
@@ -12,20 +12,22 @@ By default, only transactions from 4 months prior are factored into the calculat
 Usage
 -----
 
-Basic useage is simple: you load a set of transactions (in OFX format), then print a report.
+Install via rubygems: `gem install cashflow`. Basic useage is simple. You load a set of transactions (in `ofx` format), then print a report.
 
 ![Useage screenshot](https://raw.github.com/6twenty/cashflow/master/screenshot.png)
 
+Note that _Cashflow_ doesn't care about your net position; it only cares about the comparison to your averages. This means that, as in the example above, even if your net position is negative (ie, you've spent more than you've earned), _Cashflow_ will still report a positive outcome provided you have made an improvement on your average.
+
 Commands
 --------
 
 ```
 cashflow help            # Show this help message
-cashflow help [COMMAND]  # Describe available commands or one specific command
+cashflow help COMMAND    # Describe available commands or one specific command
 cashflow load PATH       # Loads the OFX file at the specified PATH
 cashflow report          # Analyses the stored transactions and prints a comparison report
 cashflow flush           # Flushes the database, removing all stored transactions
 cashflow version         # Prints the current version number
 ```
 
-**`cashflow report`** takes a single optional parameter. You can specify the date range for the transactions to compare against by passing "-s" or "--span" followed by a number repensenting the number of months to use.
+`cashflow report` takes optional parameters. You can specify the date range for the transactions to compare against by passing `-s` or `--span` followed by a number repensenting the number of months to use. You can also specify the target day of the month to filter transactions against by passing `-d` or `--day` followed by a number representing the desired day of the month. 

data/lib/cashflow/cli.rb

@@ -16,18 +16,29 @@ module Cashflow
     # Option to factor only up to the day of the month.
     desc "report", "Analyses the stored transactions and prints a comparison report"
     option :span, :type => :numeric, :aliases => "-s", :default => 4
+    option :day, :type => :numeric, :aliases => "-d"
     def report
+      # Normalize the options.
+      months_span = options[:span]
+      if options[:day] && options[:day] <= Date.today.day && options[:day] > 0
+        day_of_month = options[:day]
+      elsif options[:day] && options[:day] <= 0
+        day_of_month = 1
+      else
+        day_of_month = Date.today.day
+      end
+
       # Build report.
-      report = Report.new(options)
-      report.build_report
+      report = Report.new(months_span, day_of_month)
+      report.build_report!
 
       # Define columns widths.
       cols = "%-11s %-11s %-11s %-11s\n"
 
       # Intro.
       say("\n")
-      say("Using transactions up to and including the #{Date.today.day.ordinalize} of the month")
-      say("Transactions begin #{report.start.strftime('%B')} #{report.start.day.ordinalize}, #{report.start.strftime('%Y')}")
+      say("Using transactions up to and including the #{report.end_date.day.ordinalize} of the month")
+      say("Transactions begin #{report.start_date.strftime('%B')} #{report.start_date.day.ordinalize}, #{report.start_date.strftime('%Y')}")
       say("\n")
 
       # Table header.

data/lib/cashflow/report.rb

@@ -7,22 +7,34 @@ module Cashflow
     attr_accessor *TYPES.map { |type| :"#{type}_current_sum" }
     attr_accessor *TYPES.map { |type| :"#{type}_average" }
     attr_accessor *TYPES.map { |type| :"#{type}_diff" }
-    attr_accessor :start
+    attr_accessor :start_date, :end_date
 
-    def initialize(options)
-      date = Date.today << options[:span]
-      @start = Date.new(date.year, date.month, 1)
+    def initialize(months_span, day_of_month)
+      # Set the initial start date to the first of the month,
+      # however many months ago.
+      date = Date.today << months_span
+      date = Date.new(date.year, date.month, 1)
+      # Get the earliest transaction date since the start date (inclusive).
+      date = Transaction.all(date).first.date
+      # If the earliest transaction took place AFTER the target
+      # day of the month, then move to the following month.
+      date = date >> 1 if date.day > day_of_month
+      # Whatever the final date is, ensure it starts at the beginning of the month.
+      @start_date = Date.new(date.year, date.month, 1)
+
+      # Set the end date.
+      @end_date = Date.new(Date.today.year, Date.today.month, day_of_month)
     end
 
     def debits
-      @debits ||= Transaction.merged(Transaction.debits(start))
+      @debits ||= Transaction.merged(Transaction.debits(start_date))
     end
 
     def credits
-      @credits ||= Transaction.merged(Transaction.credits(start))
+      @credits ||= Transaction.merged(Transaction.credits(start_date))
     end
 
-    def build_report
+    def build_report!
       filter_up_to_day_of_the_month!
       separate_current_month!
       group_priors_by_month!
@@ -38,7 +50,7 @@ module Cashflow
     def filter_up_to_day_of_the_month!
       TYPES.each do |type|
         filtered = send(type).select do |transaction|
-          transaction.date.day <= Date.today.day
+          transaction.date.day <= end_date.day
         end
         send("#{type}=", filtered)
       end
@@ -95,7 +107,11 @@ module Cashflow
     # Calculate the average debits & credits based on the prior transactions.
     def calculate_averages!
       TYPES.each do |type|
-        average = send("#{type}_sums").values.inject(0, :+) / send("#{type}_sums").values.length
+        begin
+          average = send("#{type}_sums").values.inject(0, :+) / send("#{type}_sums").values.length
+        rescue
+          average = 0
+        end
         send("#{type}_average=", average)
       end
     end

data/lib/cashflow/version.rb

@@ -1,3 +1,3 @@
 module Cashflow
-  VERSION = "0.0.2"
+  VERSION = "0.0.5".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cashflow
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Mike Fulcher
@@ -111,7 +111,7 @@ files:
 - Rakefile
 - bin/cashflow
 - cashflow.gemspec
-- db/cashflow.db
+- db/.gitkeep
 - lib/cashflow.rb
 - lib/cashflow/cli.rb
 - lib/cashflow/patches.rb