gnucash 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 52713dfe700ed99ecbde5b43d7c0614e86d3ec34
-  data.tar.gz: d59a7c2b7069bc1c355201e4c4e9f4ec832d1d55
+SHA256:
+  metadata.gz: a58f8fe486b5e15eb9481af7c0ae86645334d0122207bd181d39ac52fa388461
+  data.tar.gz: f844443866e2b33cacbb44f3e78ae24c4ccc34a66bd73ee4beeac6911eddbb47
 SHA512:
-  metadata.gz: ed54f96c4c23bb1960895f8c3df8918faed0b83362e73b5682251501fd8b664b3458797fe0a9abd45d5fb378b81f1dc508c825ff83c2e3b9a1a376c5c1a94e0c
-  data.tar.gz: a92fc8a0fcb6eff1a5e851f9e512fd8c7714aaec0d69053055a879a7548e1036a283ba7cde903c34f52d615dbd2e80076ceb3a532fc840541f293a9823bea4a2
+  metadata.gz: d0d09b83dd1d6a88dc82515edcc798680e314cd8def62e69575dbd8d3feb8e3e0ac238c60091753ca50ad229ff59b9c3cbed507d656673fee5a758bb529b3465
+  data.tar.gz: 5dd6b7dabb61890a3c0b3ec1c072b3a6edc816c1824b30b4b353db07d60366b21ccfb1144293fd82d5a02ca0557ee34df903b0fd06a1212a415bf7f1cc31bf5d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # ChangeLog
 
+## v1.5.0
+
+- add options Hash to Account#balance_on with :recursive option
+
 ## v1.4.0
 
 - add Account#parent_id and #parent

data/Gemfile.lock

@@ -1,39 +1,39 @@
 PATH
   remote: .
   specs:
-    gnucash (1.4.0)
+    gnucash (1.5.0)
       nokogiri
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    docile (1.1.5)
+    docile (1.3.1)
     json (2.1.0)
-    mini_portile2 (2.3.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    rake (12.3.0)
-    rdoc (6.0.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.2)
+    rdoc (6.1.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    yard (0.9.12)
+    yard (0.9.18)
 
 PLATFORMS
   ruby

data/README.md

@@ -45,6 +45,10 @@ delta = act.balance_on("#{year}-12-31") - act.balance_on("#{year - 1}-12-31")
 puts "You've saved #{delta} this year so far!"
 ```
 
+To get the balance of an account, use ```act.balance_on("#{year}-12-31")```.
+To get the total balance of an account with all its children accounts,
+use ```act.balance_on("#{year}-12-31", recursive: true)```.
+
 ## Contributing
 
 1. Fork it

data/lib/gnucash/account.rb

@@ -99,13 +99,28 @@ module Gnucash
     # Transactions that occur on the given date are included in the returned
     # balance.
     #
-    # @param date [String, Date] Date on which to query the balance.
+    # @param date [String, Date]
+    #   Date on which to query the balance.
+    # @param options [Hash]
+    #   Optional parameters.
+    # @option options [Boolean] :recursive
+    #   Whether to include children account balances.
     #
-    # @return [Value] Balance of the account as of the date given.
-    def balance_on(date)
+    # @return [Value]
+    #   Balance of the account as of the date given.
+    def balance_on(date, options = {})
       date = Date.parse(date) if date.is_a?(String)
-      return Value.new(0) unless @balances.size > 0
-      return Value.new(0) if @balances.first[:date] > date
+      return_value = Value.new(0)
+
+      if options[:recursive]
+        # Get all child accounts from this account and accumulate the balances of them.
+        @book.accounts.reject { |account| account.parent != self }.each do |child_account|
+          return_value += child_account.balance_on(date, recursive: true)
+        end
+      end
+
+      return return_value unless @balances.size > 0
+      return return_value if @balances.first[:date] > date
       return @balances.last[:value] if date >= @balances.last[:date]
       imin = 0
       imax = @balances.size - 2

data/lib/gnucash/version.rb

@@ -1,4 +1,4 @@
 module Gnucash
   # gem version
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/spec/gnucash/account_spec.rb

@@ -54,6 +54,12 @@ module Gnucash
       it "includes transactions that occur on the given date" do
         expect(@checking.balance_on("2007-03-27")).to eq Value.new(780000)
       end
+
+      describe 'with child accounts' do
+        it "returns the balance with the balance of the child accounts" do
+          expect(@assets.balance_on("2007-03-27", recursive: true)).to eq Value.new(790000)
+        end
+      end
     end
 
     it "stores whether the account was a placeholder" do

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require "simplecov"
 
-SimpleCov.start
+SimpleCov.start do
+  add_filter "/.bundle/"
+end
 
 require "gnucash"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnucash
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Josh Holtrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Extract data from XML GnuCash data files