gnucash 1.0.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.rb
+spec/books/*.gnucash.*.*
+spec/books/*.LCK

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gnucash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh Holtrop
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Gnucash
+
+Ruby library for extracting data from GnuCash data files
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gnucash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gnucash
+
+## Usage
+
+    book = Gnucash.open("MyBook.gnucash")
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/clean"
+require "rspec/core/rake_task"
+require "rdoc/task"
+require "yard"
+
+CLEAN.include "rdoc"
+CLEAN.include "pkg"
+CLEAN.include "coverage"
+
+YARD::Rake::YardocTask.new do |yard|
+  yard.files = ['lib/**/*.rb']
+end
+
+RSpec::Core::RakeTask.new("spec")
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Ruby library for extracting data from GnuCash data files"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :spec

data/gnucash.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gnucash/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gnucash"
+  gem.version       = Gnucash::VERSION
+  gem.authors       = ["Josh Holtrop"]
+  gem.email         = ["jholtrop@gmail.com"]
+  gem.description   = %q{Ruby library for extracting data from GnuCash data files}
+  gem.summary       = %q{Extract data from GnuCash data files}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "nokogiri"
+
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-core"
+  gem.add_development_dependency "rspec-expectations"
+  gem.add_development_dependency "rspec-mocks"
+end

data/lib/gnucash.rb

@@ -0,0 +1,17 @@
+require "gnucash/account"
+require "gnucash/account_transaction"
+require "gnucash/book"
+require "gnucash/transaction"
+require "gnucash/value"
+require "gnucash/version"
+
+# Namespace module for gnucash gem functionality
+module Gnucash
+  # Open a GnuCash book from file.
+  # The file can be either a plain-text XML file or a gzipped XML file.
+  # === Arguments
+  # +fname+ _String_:: Name of the file to open.
+  def self.open(fname)
+    Book.new(fname)
+  end
+end

data/lib/gnucash/account.rb

@@ -0,0 +1,91 @@
+module Gnucash
+  # Represent a GnuCash account object
+  class Account
+    # _String_: The name of the account (unqualified)
+    attr_accessor :name
+
+    # _String_: The account type (such as "EXPENSE")
+    attr_accessor :type
+
+    # _String_: The GUID of the account
+    attr_accessor :id
+
+    # _Array_: List of _AccountTransaction_ transactions associated with this
+    # account.
+    attr_accessor :transactions
+
+    # Create an Account object.
+    # === Arguments
+    # +book+ _Book_:: The Gnucash::Book containing the account
+    # +node+ _Nokogiri::XML::Node_:: Nokogiri XML node
+    def initialize(book, node)
+      @book = book
+      @node = node
+      @name = node.xpath('act:name').text
+      @type = node.xpath('act:type').text
+      @id = node.xpath('act:id').text
+      @parent_id = node.xpath('act:parent').text
+      @parent_id = nil if @parent_id == ""
+      @transactions = []
+      @balances = []
+    end
+
+    # Return the fully qualified account name
+    def full_name
+      prefix = ""
+      if @parent_id
+        parent = @book.find_account_by_id(@parent_id)
+        if parent and parent.type != 'ROOT'
+          prefix = parent.full_name + "::"
+        end
+      end
+      prefix + name
+    end
+
+    # Internal method used to associate a transaction with the account
+    def add_transaction(act_txn)
+      @transactions << act_txn
+    end
+
+    # Internal method used to complete initialization of the Account after
+    # all transactions have been associated with it.
+    def finalize
+      @transactions.sort! { |a, b| a.date <=> b.date }
+      balance = Value.new(0)
+      @balances = @transactions.map do |act_txn|
+        balance += act_txn.value
+        {
+          date: act_txn.date,
+          value: balance,
+        }
+      end
+    end
+
+    # Return the final balance of the account as a _Gnucash::Value_
+    def final_balance
+      return Value.new(0) unless @balances.size > 0
+      @balances.last[:value]
+    end
+
+    # 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.
+    def balance_on(date)
+      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]
+      imin = 0
+      imax = @balances.size - 2
+      idx = imax / 2
+      until @balances[idx][:date] <= date and @balances[idx + 1][:date] > date
+        if @balances[idx][:date] <= date
+          imin = idx + 1
+        else
+          imax = idx
+        end
+        idx = (imin + imax) / 2
+      end
+      @balances[idx][:value]
+    end
+  end
+end

data/lib/gnucash/account_transaction.rb

@@ -0,0 +1,23 @@
+module Gnucash
+  # Class to link a transaction object to an Account.
+  class AccountTransaction
+    # _Gnucash::Value_: The transaction value for the linked account
+    attr_accessor :value
+
+    # Construct an AccountTransaction object.
+    # This method is used internally when building a Transaction object.
+    # === Arguments
+    # +real_txn+ _Gnucash::Transaction_:: The linked Transaction object
+    # +value+ _Gnucash::Value_::
+    #   The value of the Transaction split for this account
+    def initialize(real_txn, value)
+      @real_txn = real_txn
+      @value = value
+    end
+
+    # Pass through any missing method calls to the linked Transaction object
+    def method_missing(*args)
+      @real_txn.send(*args)
+    end
+  end
+end

data/lib/gnucash/book.rb

@@ -0,0 +1,84 @@
+require "zlib"
+require "nokogiri"
+
+module Gnucash
+  # Represent a GnuCash Book
+  class Book
+    # _Array_ of _Gnucash::Account_ objects in the book
+    attr_accessor :accounts
+
+    # _Array_ of _Gnucash::Transaction_ objects in the book
+    attr_accessor :transactions
+
+    # _String_ in "YYYY-MM-DD" format of the first transaction in the book
+    attr_accessor :start_date
+
+    # _String_ in "YYYY-MM-DD" format of the last transaction in the book
+    attr_accessor :end_date
+
+    # Construct a Book object.
+    # Normally called internally by Gnucash.open()
+    # === Arguments
+    # +fname+ _String_:: The file name of the GnuCash file to open.
+    def initialize(fname)
+      begin
+        @ng = Nokogiri.XML(Zlib::GzipReader.open(fname).read)
+      rescue Zlib::GzipFile::Error
+        @ng = Nokogiri.XML(File.read(fname))
+      end
+      book_nodes = @ng.xpath('/gnc-v2/gnc:book')
+      if book_nodes.count != 1
+        raise "Error: Expected to find one gnc:book entry"
+      end
+      @book_node = book_nodes.first
+      build_accounts
+      build_transactions
+      finalize
+    end
+
+    # Return a handle to the Account object that has the given GUID.
+    # === Arguments
+    # +id+ _String_:: GUID
+    # === Return
+    # _Gnucash::Account_ or +nil+
+    def find_account_by_id(id)
+      @accounts.find { |a| a.id == id }
+    end
+
+    # Return a handle to the Account object that has the given fully-qualified
+    # name.
+    # === Arguments
+    # +full_name+ _String_::
+    #   Fully-qualified account name (ex: "Expenses::Auto::Gas")
+    # === Return
+    # _Gnucash::Account_ or +nil+
+    def find_account_by_full_name(full_name)
+      @accounts.find { |a| a.full_name == full_name }
+    end
+
+    private
+
+    def build_accounts
+      @accounts = @book_node.xpath('gnc:account').map do |act_node|
+        Account.new(self, act_node)
+      end
+    end
+
+    def build_transactions
+      @start_date = nil
+      @end_date = nil
+      @transactions = @book_node.xpath('gnc:transaction').map do |txn_node|
+        Transaction.new(self, txn_node).tap do |txn|
+          @start_date = txn.date if @start_date.nil? or txn.date < @start_date
+          @end_date = txn.date if @end_date.nil? or txn.date > @end_date
+        end
+      end
+    end
+
+    def finalize
+      @accounts.each do |account|
+        account.finalize
+      end
+    end
+  end
+end

data/lib/gnucash/transaction.rb

@@ -0,0 +1,41 @@
+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")
+    attr_accessor :date
+
+    # _String_: The GUID of the transaction
+    attr_accessor :id
+
+    # _String_: The description of the transaction
+    attr_accessor :description
+
+    # Create a new Transaction object
+    # === Arguments
+    # +book+ _Book_:: The Gnucash::Book containing the transaction
+    # +node+ _Nokogiri::XML::Node_:: Nokogiri XML node
+    def initialize(book, node)
+      @book = book
+      @node = node
+      @id = node.xpath('trn:id').text
+      @date = 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)
+        account_id = split_node.xpath('split:account').text
+        account = @book.find_account_by_id(account_id)
+        unless account
+          raise "Could not find account with ID #{account_id} for transaction #{@id}"
+        end
+        account.add_transaction(AccountTransaction.new(self, value))
+        {
+          account_id: account_id,
+          value: value,
+        }
+      end
+    end
+  end
+end

data/lib/gnucash/value.rb

@@ -0,0 +1,97 @@
+module Gnucash
+  # Represent a currency value as an integer so that integer math can be used
+  # for accuracy in computations.
+  class Value
+    include Comparable
+
+    # _Fixnum_:: The raw, undivided integer value
+    attr_accessor :val
+
+    # Create a new Value object with value 0
+    def self.zero
+      Value.new(0)
+    end
+
+    # Construct a Value object
+    # === Arguments
+    # +val+ _String_ or _Fixnum_::
+    #   Either a _String_ in the form "1234/100" or an integer containing the
+    #   raw value
+    # +div+ _Fixnum_::
+    #   The divisor value to use (when +val+ is given as a _Fixnum_)
+    def initialize(val, div = 100)
+      if val.is_a?(String)
+        if val =~ /^(-?\d+)\/(\d+)$/
+          @val = $1.to_i
+          @div = $2.to_i
+        else
+          raise "Unexpected value string: #{val.inspect}"
+        end
+      elsif val.is_a?(Fixnum)
+        @val = val
+        @div = div
+      else
+        raise "Unexpected value type: #{val.class}"
+      end
+    end
+
+    # Add to a Value object
+    # +other+ can be another Value or a Numeric
+    def +(other)
+      if other.is_a?(Value)
+        Value.new(@val + other.val)
+      elsif other.is_a?(Numeric)
+        (to_f + other).round(2)
+      else
+        raise "Unexpected argument"
+      end
+    end
+
+    # Subtract from a Value object
+    # +other+ can be another Value or a Numeric
+    def -(other)
+      if other.is_a?(Value)
+        Value.new(@val - other.val)
+      elsif other.is_a?(Numeric)
+        (to_f - other).round(2)
+      else
+        raise "Unexpected argument"
+      end
+    end
+
+    # Multiply a Value object
+    # +other+ should be a Numeric
+    def *(other)
+      if other.is_a?(Numeric)
+        (to_f * other).round(2)
+      else
+        raise "Unexpected argument"
+      end
+    end
+
+    # Divide a Value object
+    # +other+ should be a Numeric
+    def /(other)
+      if other.is_a?(Numeric)
+        (to_f / other).round(2)
+      else
+        raise "Unexpected argument"
+      end
+    end
+
+    # Represent the Value as a string (two decimal places)
+    def to_s
+      sprintf("%.02f", to_f)
+    end
+
+    # Convert the Value to a Float
+    def to_f
+      @val / @div.to_f
+    end
+
+    # Compare two Value objects
+    def <=>(other)
+      @val <=> other.val
+    end
+  end
+end