gnucash 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTlmNWViYWRiZWVmNzlhYWE2NDdmODc1ZGIyYmFmZTEzNzBiOGJkYg==
+  data.tar.gz: !binary |-
+    YmFmZGY1YmQ0NzkxYTRlMGEzYjBiNjVjZDE0ZTBjNDU2MGQxMGVjMQ==
+SHA512:
+  metadata.gz: !binary |-
+    NzExNTNlOTgxZjk3MjI2ZWQ4ZmFlMDIwZDEwOTQ1YzZmN2I4MmEyM2E1YTlm
+    MGNlMjU1NzE2MjdkZTVmZDdmZWM5YzkzNDU3YmM2MThhNzk0NzMyYzViMzBk
+    Y2E0MTM4ZTNmYWIzOGUzNzk1ZDkwYWJjMjU2ZGYyYzEwNzBhNmE=
+  data.tar.gz: !binary |-
+    ZjY0NzY5YjZhN2Y0OWMyNTNmNzRmMjE3MTE0MjFhNjM0YWUzNTcxY2Y1ZmM1
+    ODg2Y2UzMzJhODJjODNiZDIxNDAwOTllMDFhOTVkNTZiYWEwYmIzZWRjYTZk
+    ZTQ1MTU4ODBlZDQ4ZTcxOTkxZWZhNjA5Y2M3ZGQzNGYwN2U0Mzg=

data/README.md

@@ -2,6 +2,8 @@
 
 Ruby library for extracting data from GnuCash data files
 
+[![Gem Version](https://badge.fury.io/rb/gnucash.png)](http://badge.fury.io/rb/gnucash)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +28,7 @@ Or install it yourself as:
       puts "#{account.full_name}: #{account.final_balance}"
     end
 
-    act = book.find_account_by_full_name("Assets::Checking")
+    act = book.find_account_by_full_name("Assets:Checking")
     balance = Gnucash::Value.zero
     act.transactions.each do |txn|
       balance += txn.value
@@ -37,6 +39,20 @@ Or install it yourself as:
                            txn.description))
     end
 
+## Release Notes
+
+### v1.2.0
+
+- use Date objects instead of formatted strings for dates
+- use a single colon instead of a double colon in account names
+- use 'require_relative' instead of 'require'
+
+### v1.1.0
+
+- store and provide access to the account description
+- change many attributes to read-only
+- add 'placeholder' Account attribute
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,3 +1,9 @@
+require "bundler"
+begin
+    Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+    raise LoadError.new("Unable to Bundler.setup(): You probably need to run `bundle install`: #{e.message}")
+end
 require "bundler/gem_tasks"
 require "rake/clean"
 require "rspec/core/rake_task"

data/gnucash.gemspec

@@ -25,4 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec-core"
   gem.add_development_dependency "rspec-expectations"
   gem.add_development_dependency "rspec-mocks"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rdoc"
+  gem.add_development_dependency "yard"
 end

data/lib/gnucash.rb

@@ -1,9 +1,9 @@
-require "gnucash/account"
-require "gnucash/account_transaction"
-require "gnucash/book"
-require "gnucash/transaction"
-require "gnucash/value"
-require "gnucash/version"
+require_relative "gnucash/account"
+require_relative "gnucash/account_transaction"
+require_relative "gnucash/book"
+require_relative "gnucash/transaction"
+require_relative "gnucash/value"
+require_relative "gnucash/version"
 
 # Namespace module for gnucash gem functionality
 module Gnucash

data/lib/gnucash/account.rb

@@ -74,7 +74,9 @@ module Gnucash
     # Return the balance of the account as of the date given as a
     # _Gnucash::Value_. Transactions that occur on the given date are included
     # in the returned balance.
+    # date can be a _String_ ("YYYY-MM-DD") or _Date_ object.
     def balance_on(date)
+      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 @balances.last[:value] if date >= @balances.last[:date]
@@ -99,7 +101,7 @@ module Gnucash
       if @parent_id
         parent = @book.find_account_by_id(@parent_id)
         if parent and parent.type != 'ROOT'
-          prefix = parent.full_name + "::"
+          prefix = parent.full_name + ":"
         end
       end
       prefix + name

data/lib/gnucash/book.rb

@@ -10,10 +10,10 @@ module Gnucash
     # _Array_ of _Gnucash::Transaction_ objects in the book
     attr_reader :transactions
 
-    # _String_ in "YYYY-MM-DD" format of the first transaction in the book
+    # _Date_ of the first transaction in the book
     attr_reader :start_date
 
-    # _String_ in "YYYY-MM-DD" format of the last transaction in the book
+    # _Date_ of the last transaction in the book
     attr_reader :end_date
 
     # Construct a Book object.

data/lib/gnucash/transaction.rb

@@ -1,10 +1,12 @@
+require "date"
+
 module Gnucash
   # Represent a GnuCash transaction.
   # Transactions have multiple splits with individual values.
   # Splits are created as AccountTransaction objects which are associated
   # with an individual account.
   class Transaction
-    # _String_: The date of the transaction, in ISO format ("YYYY-MM-DD")
+    # _Date_: The date of the transaction
     attr_reader :date
 
     # _String_: The GUID of the transaction
@@ -24,7 +26,7 @@ module Gnucash
       @book = book
       @node = node
       @id = node.xpath('trn:id').text
-      @date = node.xpath('trn:date-posted/ts:date').text.split(' ').first
+      @date = Date.parse(node.xpath('trn:date-posted/ts:date').text.split(' ').first)
       @description = node.xpath('trn:description').text
       @splits = node.xpath('trn:splits/trn:split').map do |split_node|
         value = Value.new(split_node.xpath('split:value').text)

data/lib/gnucash/version.rb

@@ -1,4 +1,4 @@
 module Gnucash
   # gem version
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/gnucash/account_spec.rb

@@ -4,9 +4,9 @@ module Gnucash
       # just read the file once
       @book = Gnucash.open("spec/books/sample.gnucash")
       @assets = @book.find_account_by_full_name("Assets")
-      @checking = @book.find_account_by_full_name("Assets::Current Assets::Checking Account")
+      @checking = @book.find_account_by_full_name("Assets:Current Assets:Checking Account")
       @income = @book.find_account_by_full_name("Income")
-      @salary = @book.find_account_by_full_name("Income::Salary")
+      @salary = @book.find_account_by_full_name("Income:Salary")
     end
 
     it "gives access to the account name" do
@@ -18,7 +18,7 @@ module Gnucash
     end
 
     it "gives access to the fully-qualified account name" do
-      @checking.full_name.should == "Assets::Current Assets::Checking Account"
+      @checking.full_name.should == "Assets:Current Assets:Checking Account"
     end
 
     it "gives access to the final balance" do

data/spec/gnucash/book_spec.rb

@@ -20,11 +20,11 @@ module Gnucash
       end
 
       it "records the date of the earliest transaction" do
-        @subject.start_date.should == "2007-01-01"
+        @subject.start_date.should == Date.parse("2007-01-01")
       end
 
       it "records the date of the last transaction" do
-        @subject.end_date.should == "2012-12-28"
+        @subject.end_date.should == Date.parse("2012-12-28")
       end
 
       it "lets you find an account by id" do
@@ -32,7 +32,7 @@ module Gnucash
       end
 
       it "lets you find an account by full name" do
-        @subject.find_account_by_full_name("Assets::Current Assets::Savings Account").id.should == "67e6e7daadc35716eb6152769373e974"
+        @subject.find_account_by_full_name("Assets:Current Assets:Savings Account").id.should == "67e6e7daadc35716eb6152769373e974"
       end
     end
   end

data/spec/gnucash/transaction_spec.rb

@@ -8,10 +8,12 @@ module Gnucash
         split_node = "split_node"
         value_text = "value_text"
         account_text = "account_text"
+        date_text = "date_text"
 
-        node.should_receive(:xpath).with('trn:id').and_return(text)
         text.stub(:text) {"hi there"}
-        node.should_receive(:xpath).with('trn:date-posted/ts:date').and_return(text)
+        node.should_receive(:xpath).with('trn:id').and_return(text)
+        date_text.should_receive(:text).and_return("2014-01-20")
+        node.should_receive(:xpath).with('trn:date-posted/ts:date').and_return(date_text)
         value_text.should_receive(:text).and_return("1177/100")
         account_text.should_receive(:text).and_return("a1s2d3f4")
         split_node.should_receive(:xpath).with("split:value").and_return(value_text)
@@ -27,7 +29,7 @@ module Gnucash
     context "without errors" do
       before(:all) do
         @book = Gnucash.open("spec/books/sample.gnucash")
-        @txn = @book.find_account_by_full_name("Assets::Current Assets::Cash in Wallet").transactions.first
+        @txn = @book.find_account_by_full_name("Assets:Current Assets:Cash in Wallet").transactions.first
       end
 
       it "keeps track of the transaction description" do

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: gnucash
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Josh Holtrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,48 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -139,27 +168,26 @@ files:
 homepage: https://github.com/holtrop/ruby-gnucash
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Extract data from GnuCash data files
 test_files:
 - spec/books/sample-text.gnucash