gnucash 1.0.0

data/spec/gnucash/account_spec.rb

@@ -0,0 +1,40 @@
+module Gnucash
+  describe Account do
+    before(:all) do
+      # just read the file once
+      @book = Gnucash.open("spec/books/sample.gnucash")
+      @checking = @book.find_account_by_full_name("Assets::Current Assets::Checking Account")
+      @salary = @book.find_account_by_full_name("Income::Salary")
+    end
+
+    it "gives access to the account name" do
+      @salary.name.should == "Salary"
+    end
+
+    it "gives access to the fully-qualified account name" do
+      @checking.full_name.should == "Assets::Current Assets::Checking Account"
+    end
+
+    it "gives access to the final balance" do
+      @checking.final_balance.should == Value.new(19743000)
+    end
+
+    describe '.balance_on' do
+      it "returns 0 if the given date is before the account's first transaction" do
+        @checking.balance_on("2006-12-12").should == Value.new(0)
+      end
+
+      it "returns the final balance if the given date is after the account's last transaction" do
+        @checking.balance_on("2013-10-10").should == @checking.final_balance
+      end
+
+      it "returns the balance on the given date" do
+        @checking.balance_on("2012-12-25").should == Value.new(19688000)
+      end
+
+      it "includes transactions that occur on the given date" do
+        @checking.balance_on("2007-03-27").should == Value.new(780000)
+      end
+    end
+  end
+end

data/spec/gnucash/book_spec.rb

@@ -0,0 +1,39 @@
+module Gnucash
+  describe Book do
+    context "with errors" do
+      it "raises an error for unexpected XML" do
+        gr = "gr"
+        Zlib::GzipReader.should_receive(:open).and_return(gr)
+        gr.should_receive(:read).and_return(nil)
+        ng = "ng"
+        Nokogiri.should_receive(:XML).and_return(ng)
+        ng.should_receive(:xpath).with('/gnc-v2/gnc:book').and_return([])
+
+        expect { Gnucash::Book.new('file name') }.to raise_error "Error: Expected to find one gnc:book entry"
+      end
+    end
+
+    context "without errors" do
+      before(:all) do
+        # just open the test file once
+        @subject = Gnucash.open("spec/books/sample.gnucash")
+      end
+
+      it "records the date of the earliest transaction" do
+        @subject.start_date.should == "2007-01-01"
+      end
+
+      it "records the date of the last transaction" do
+        @subject.end_date.should == "2012-12-28"
+      end
+
+      it "lets you find an account by id" do
+        @subject.find_account_by_id("67e6e7daadc35716eb6152769373e974").name.should == "Savings Account"
+      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"
+      end
+    end
+  end
+end

data/spec/gnucash/transaction_spec.rb

@@ -0,0 +1,38 @@
+module Gnucash
+  describe Transaction do
+    context "with errors" do
+      it "raises an error for unexpected XML" do
+        book = "book"
+        node = "node"
+        text = "text"
+        split_node = "split_node"
+        value_text = "value_text"
+        account_text = "account_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)
+        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)
+        split_node.should_receive(:xpath).with("split:account").and_return(account_text)
+        node.should_receive(:xpath).with('trn:description').and_return(text)
+        node.should_receive(:xpath).with('trn:splits/trn:split').and_return([split_node])
+        book.should_receive(:find_account_by_id).and_return(nil)
+
+        expect { Transaction.new(book, node) }.to raise_error /Could not find account/
+      end
+    end
+
+    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
+      end
+
+      it "keeps track of the transaction description" do
+        @txn.description.should == "Opening Balance"
+      end
+    end
+  end
+end

data/spec/gnucash/value_spec.rb

@@ -0,0 +1,96 @@
+module Gnucash
+  describe Value do
+    describe '.zero' do
+      it 'creates a Value object with value 0' do
+        Value.zero.val.should == 0
+      end
+    end
+
+    it "raises an error when an unexpected string is given" do
+      expect { Value.new("1234") }.to raise_error /Unexpected value string/
+    end
+
+    it "raises an error when an unexpected type is given" do
+      expect { Value.new(Object.new) }.to raise_error /Unexpected value type/
+    end
+
+    it "allows construction from a string" do
+      Value.new("5678/100").val.should == 5678
+    end
+
+    it "converts the value to the expected string representation" do
+      Value.new("5678/100").to_s.should == "56.78"
+      Value.new("1000231455/100").to_s.should == "10002314.55"
+    end
+
+    it "allows adding two value objects" do
+      a = Value.new("1234/100")
+      b = Value.new("2345/100")
+      c = a + b
+      c.to_s.should == "35.79"
+    end
+
+    it "allows adding a Value object to a Numeric" do
+      a = Value.new("1234/100")
+      b = 15
+      c = a + b
+      c.should == 27.34
+    end
+
+    it "allows subtracting two value objects" do
+      a = Value.new("-12300/100")
+      b = Value.new("99/100")
+      c = a - b
+      c.to_s.should == "-123.99"
+    end
+
+    it "allows subtracting a Numeric from a Value object" do
+      a = Value.new("890/100")
+      b = 7.8
+      c = a - b
+      c.should == 1.1
+    end
+
+    it "allows multiplying a Value by a Numeric" do
+      a = Value.new("100/100")
+      b = 12
+      c = a * b
+      c.should == 12.00
+    end
+
+    it "allows dividing a Value by a Numeric" do
+      a = Value.new("150000/100")
+      b = 150
+      c = a / b
+      c.should == 10.0
+    end
+
+    it "formats the number with two decimal places" do
+      Value.new("1400/100").to_s.should == "14.00"
+    end
+
+    it "supports comparisons between two Value objects" do
+      Value.new("1234/100").should == Value.new(1234)
+      (Value.new("89/100") < Value.new("100/100")).should be_true
+      (Value.new("1234/100") > Value.new("222/100")).should be_true
+    end
+
+    context "errors" do
+      it "raises an error when attempting to add an unknown object type" do
+        expect { Value.new(33) + nil }.to raise_error /Unexpected argument/i
+      end
+
+      it "raises an error when attempting to subtract an unknown object type" do
+        expect { Value.new(33) - nil }.to raise_error /Unexpected argument/i
+      end
+
+      it "raises an error when attempting to multiply by an unknown object type" do
+        expect { Value.new(33) * nil }.to raise_error /Unexpected argument/i
+      end
+
+      it "raises an error when attempting to divide by an unknown object type" do
+        expect { Value.new(33) / nil }.to raise_error /Unexpected argument/i
+      end
+    end
+  end
+end

data/spec/gnucash_spec.rb

@@ -0,0 +1,12 @@
+describe Gnucash do
+  describe '.open' do
+    it 'opens a gzipped gnucash book' do
+      book = Gnucash.open("spec/books/sample.gnucash")
+      book.is_a?(Gnucash::Book).should be_true
+    end
+    it 'opens a plain text gnucash book' do
+      book = Gnucash.open("spec/books/sample-text.gnucash")
+      book.is_a?(Gnucash::Book).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "simplecov"
+
+SimpleCov.start
+
+require "gnucash"

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: gnucash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Holtrop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby library for extracting data from GnuCash data files
+email:
+- jholtrop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gnucash.gemspec
+- lib/gnucash.rb
+- lib/gnucash/account.rb
+- lib/gnucash/account_transaction.rb
+- lib/gnucash/book.rb
+- lib/gnucash/transaction.rb
+- lib/gnucash/value.rb
+- lib/gnucash/version.rb
+- spec/books/sample-text.gnucash
+- spec/books/sample.gnucash
+- spec/gnucash/account_spec.rb
+- spec/gnucash/book_spec.rb
+- spec/gnucash/transaction_spec.rb
+- spec/gnucash/value_spec.rb
+- spec/gnucash_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Extract data from GnuCash data files
+test_files:
+- spec/books/sample-text.gnucash
+- spec/books/sample.gnucash
+- spec/gnucash/account_spec.rb
+- spec/gnucash/book_spec.rb
+- spec/gnucash/transaction_spec.rb
+- spec/gnucash/value_spec.rb
+- spec/gnucash_spec.rb
+- spec/spec_helper.rb
+has_rdoc: