gnucash 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 900fd81bad3ba0b11854c9337bc222b535804b02
-  data.tar.gz: 5549a7746596aae5be8f4081a1b6ba322b2f98b0
+  metadata.gz: 52713dfe700ed99ecbde5b43d7c0614e86d3ec34
+  data.tar.gz: d59a7c2b7069bc1c355201e4c4e9f4ec832d1d55
 SHA512:
-  metadata.gz: e5bb85d5c99510c17af02d0b649f637a4c939eb90e2392bddeadc22926699c96a28d11fb7cba43a7114d29e4d38fb413bbfb082611ca2c70f6f9e6fb13f9bd4b
-  data.tar.gz: f0f3934018eb94ae3a989abdbb95c94aaeb3dd8f0a399e3fa85e8f26937184577d55f775b8a38a51334f845942f62ca32225041cbc651139e3db70d252c1b139
+  metadata.gz: ed54f96c4c23bb1960895f8c3df8918faed0b83362e73b5682251501fd8b664b3458797fe0a9abd45d5fb378b81f1dc508c825ff83c2e3b9a1a376c5c1a94e0c
+  data.tar.gz: a92fc8a0fcb6eff1a5e851f9e512fd8c7714aaec0d69053055a879a7548e1036a283ba7cde903c34f52d615dbd2e80076ceb3a532fc840541f293a9823bea4a2

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # ChangeLog
 
+## v1.4.0
+
+- add Account#parent_id and #parent
+- add Value#to_r to convert to Rational
+- override #inspect for several Gnucash objects to improve REPL usage
+
+## v1.3.1
+
+- do not round numeric results of Value computations
+
+## v1.3.0
+
+- allow Value objects to be passed to / and * operators
+
 ## v1.2.2
 
 - Allow mixing Value objects with different divisors - fix #7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gnucash (1.3.1)
+    gnucash (1.4.0)
       nokogiri
 
 GEM
@@ -13,27 +13,27 @@ GEM
     mini_portile2 (2.3.0)
     nokogiri (1.8.1)
       mini_portile2 (~> 2.3.0)
-    rake (12.0.0)
-    rdoc (5.1.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    simplecov (0.15.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    yard (0.9.9)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
@@ -47,4 +47,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.15.0
+   1.16.1

data/gnucash.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.required_ruby_version = ">= 2.0"
+
   gem.add_dependency "nokogiri"
 
   gem.add_development_dependency "simplecov"

data/lib/gnucash.rb

@@ -1,3 +1,4 @@
+require_relative "gnucash/support"
 require_relative "gnucash/account"
 require_relative "gnucash/account_transaction"
 require_relative "gnucash/book"

data/lib/gnucash/account.rb

@@ -1,6 +1,8 @@
 module Gnucash
   # Represent a GnuCash account object.
   class Account
+    include Support::LightInspect
+
     # @return [String] The name of the account (unqualified).
     attr_reader :name
 
@@ -20,6 +22,11 @@ module Gnucash
     # @return [Boolean] Whether the account is a placeholder or not.
     attr_reader :placeholder
 
+    # @since 1.4.0
+    #
+    # @return [String, nil] The GUID of the parent account, if any.
+    attr_reader :parent_id
+
     # Create an Account object.
     #
     # @param book [Book] The {Gnucash::Book} containing the account.
@@ -38,7 +45,7 @@ module Gnucash
       @placeholder = node.xpath("act:slots/slot").find do |slot|
         (slot.xpath("slot:key").first.text == "placeholder" and
          slot.xpath("slot:value").first.text == "true")
-      end
+      end ? true : false
     end
 
     # Return the fully qualified account name.
@@ -48,6 +55,15 @@ module Gnucash
       @full_name ||= calculate_full_name
     end
 
+    # Lookup for the parent account in the book.
+    #
+    # @since 1.4.0
+    #
+    # @return [Account, nil] Account object, or nil if not found.
+    def parent
+      @parent ||= @parent_id ? @book.find_account_by_id(@parent_id) : nil
+    end
+
     # Internal method used to associate a transaction with the account.
     #
     # @return [void]
@@ -105,6 +121,14 @@ module Gnucash
       @balances[idx][:value]
     end
 
+    # Attributes available for inspection
+    #
+    # @return [Array<Symbol>] Attributes used to build the inspection string
+    # @see Gnucash::Support::LightInspect
+    def attributes
+      %i[id name description type placeholder parent_id]
+    end
+
     private
 
     # @return [String] Fully qualified account name.

data/lib/gnucash/account_transaction.rb

@@ -1,6 +1,8 @@
 module Gnucash
   # Class to link a transaction object to an Account.
   class AccountTransaction
+    include Support::LightInspect
+
     # @return [Value] The transaction value for the linked account.
     attr_reader :value
 
@@ -21,5 +23,13 @@ module Gnucash
     def method_missing(*args)
       @real_txn.send(*args)
     end
+
+    # Attributes available for inspection
+    #
+    # @return [Array<Symbol>] Attributes used to build the inspection string
+    # @see Gnucash::Support::LightInspect
+    def attributes
+      %i[value]
+    end
   end
 end

data/lib/gnucash/book.rb

@@ -4,6 +4,8 @@ require "nokogiri"
 module Gnucash
   # Represent a GnuCash Book.
   class Book
+    include Support::LightInspect
+
     # @return [Array<Account>] Accounts in the book.
     attr_reader :accounts
 
@@ -59,6 +61,14 @@ module Gnucash
       @accounts.find { |a| a.full_name == full_name }
     end
 
+    # Attributes available for inspection
+    #
+    # @return [Array<Symbol>] Attributes used to build the inspection string
+    # @see Gnucash::Support::LightInspect
+    def attributes
+      %i[start_date end_date]
+    end
+
     private
 
     # @return [void]

data/lib/gnucash/support.rb

@@ -0,0 +1,8 @@
+require_relative "support/light_inspect"
+
+module Gnucash
+  # Support functionality.
+  module Support
+    include LightInspect
+  end
+end

data/lib/gnucash/support/light_inspect.rb

@@ -0,0 +1,23 @@
+module Gnucash
+  module Support
+    # Allows lightweight inspection os Gnucash models by avoiding fetch XML nodes.
+    module LightInspect
+
+      # Attributes available for inspection
+      #
+      # @return [Array<Symbol>] Attributes used to build the inspection string
+      def attributes
+        []
+      end
+
+      # Custom implementation using only selected attributes.
+      #
+      # @return [String] Stringified version of the object
+      # @see #attributes
+      def inspect
+        inspection = attributes.map { |att| "#{att}: #{send(att)}" }.join(", ")
+        "#<#{self.class} #{inspection}>"
+      end
+    end
+  end
+end

data/lib/gnucash/transaction.rb

@@ -7,6 +7,8 @@ module Gnucash
   # Splits are created as AccountTransaction objects which are associated
   # with an individual account.
   class Transaction
+    include Support::LightInspect
+
     # @return [Date] The date of the transaction.
     attr_reader :date
 
@@ -46,5 +48,13 @@ module Gnucash
         }
       end
     end
+
+    # Attributes available for inspection
+    #
+    # @return [Array<Symbol>] Attributes used to build the inspection string
+    # @see Gnucash::Support::LightInspect
+    def attributes
+      %i[id date description splits]
+    end
   end
 end

data/lib/gnucash/value.rb

@@ -3,6 +3,7 @@ module Gnucash
   # for accuracy in computations.
   class Value
     include Comparable
+    include Support::LightInspect
 
     # @return [Integer] The raw, undivided integer value.
     attr_reader :val
@@ -125,6 +126,15 @@ module Gnucash
       @val / @div.to_f
     end
 
+    # Convert the Value to a Rational.
+    #
+    # @since 1.4.0
+    #
+    # @return [Rational] Value of the value as a Rational.
+    def to_r
+      Rational(@val, @div)
+    end
+
     # Compare two Value objects.
     #
     # @return [Integer] Comparison result.
@@ -141,5 +151,13 @@ module Gnucash
       lcm_div = @div.lcm(other.div)
       (@val * (lcm_div / @div)) == (other.val * (lcm_div / other.div))
     end
+
+    # Attributes available for inspection
+    #
+    # @return [Array<Symbol>] Attributes used to build the inspection string
+    # @see Gnucash::Support::LightInspect
+    def attributes
+      %i[val div]
+    end
   end
 end

data/lib/gnucash/version.rb

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

data/spec/gnucash/account_spec.rb

@@ -3,6 +3,7 @@ module Gnucash
     before(:all) do
       # just read the file once
       @book = Gnucash.open("spec/books/sample.gnucash")
+      @root = @book.find_account_by_full_name("Root Account")
       @assets = @book.find_account_by_full_name("Assets")
       @checking = @book.find_account_by_full_name("Assets:Current Assets:Checking Account")
       @income = @book.find_account_by_full_name("Income")
@@ -21,6 +22,18 @@ module Gnucash
       expect(@checking.full_name).to eq "Assets:Current Assets:Checking Account"
     end
 
+    it "gives access to parent account id" do
+      expect(@salary.parent_id).to eq @income.id
+      expect(@income.parent_id).to eq @root.id
+      expect(@root.parent_id).to eq nil
+    end
+
+    it "gives access to parent account" do
+      expect(@salary.parent).to eq @income
+      expect(@income.parent).to eq @root
+      expect(@root.parent).to eq nil
+    end
+
     it "gives access to the final balance" do
       expect(@checking.final_balance).to eq Value.new(19743000)
     end
@@ -49,5 +62,9 @@ module Gnucash
       expect(@income.placeholder).to be_truthy
       expect(@salary.placeholder).to be_falsey
     end
+
+    it "avoid inspection of heavier attributes" do
+      expect(@salary.inspect).to eq "#<Gnucash::Account id: efebb6cb617971b0a7f62e9d5a204789, name: Salary, description: Salary, type: INCOME, placeholder: false, parent_id: 35ab61d46f5404895bf5d4949f8a5593>"
+    end
   end
 end

data/spec/gnucash/account_transaction_spec.rb

@@ -0,0 +1,16 @@
+module Gnucash
+  describe AccountTransaction 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
+      expect(@txn.description).to eq "Opening Balance"
+    end
+
+    it "avoid inspection of heavier attributes" do
+      expect(@txn.inspect).to eq "#<Gnucash::AccountTransaction value: 100.00>"
+    end
+  end
+end

data/spec/gnucash/book_spec.rb

@@ -34,6 +34,10 @@ module Gnucash
       it "lets you find an account by full name" do
         expect(@subject.find_account_by_full_name("Assets:Current Assets:Savings Account").id).to eq "67e6e7daadc35716eb6152769373e974"
       end
+
+      it "avoid inspection of heavier attributes" do
+        expect(@subject.inspect).to eq "#<Gnucash::Book start_date: 2007-01-01, end_date: 2012-12-28>"
+      end
     end
   end
 end

data/spec/gnucash/support/light_inspect_spec.rb

@@ -0,0 +1,15 @@
+module Gnucash
+  module Support
+    describe LightInspect do
+      class Klass
+        include LightInspect
+      end
+
+      describe "#attributes" do
+        it "returns an empty Array if not overridden" do
+          expect(Klass.new.attributes).to eq([])
+        end
+      end
+    end
+  end
+end

data/spec/gnucash/transaction_spec.rb

@@ -29,11 +29,10 @@ 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
       end
 
-      it "keeps track of the transaction description" do
-        expect(@txn.description).to eq "Opening Balance"
+      it "avoid inspection of heavier attributes" do
+        expect(@book.transactions.first.inspect).to eq "#<Gnucash::Transaction id: 12efba30f14dc6cd4c3ffe2994de8284, date: 2007-01-01, description: Opening Balance, splits: [{:account=>#<Gnucash::Account id: 849f778995e8ecf8d4b96940afbbdcd7, name: Checking Account, description: Checking Account, type: BANK, placeholder: false, parent_id: c8e868259d70f6491f9e70ffdf6634ee>, :value=>#<Gnucash::Value val: 30000, div: 100>}, {:account=>#<Gnucash::Account id: 23bea6468ee7b4acb4db4b3f54598a71, name: Opening Balances, description: Opening Balances, type: EQUITY, placeholder: false, parent_id: ea7fe8b8abd560bef49826f68387ca78>, :value=>#<Gnucash::Value val: -30000, div: 100>}]>"
       end
     end
   end

data/spec/gnucash/value_spec.rb

@@ -1,7 +1,7 @@
 module Gnucash
   describe Value do
-    describe '.zero' do
-      it 'creates a Value object with value 0' do
+    describe ".zero" do
+      it "creates a Value object with value 0" do
         expect(Value.zero.val).to eq 0
       end
     end
@@ -23,6 +23,16 @@ module Gnucash
       expect(Value.new("1000231455/100").to_s).to eq "10002314.55"
     end
 
+    it "converts the value to the expected float representation" do
+      expect(Value.new("5678/100").to_f).to be_within(0.00000001).of(56.78)
+      expect(Value.new("1000231455/100").to_f).to be_within(0.00000001).of(10002314.55)
+    end
+
+    it "converts the value to the expected rational representation" do
+      expect(Value.new("5678/55").to_r).to eq Rational(5678, 55)
+      expect(Value.new("1000231455/49").to_r).to eq Rational(1000231455, 49)
+    end
+
     it "allows adding two value objects" do
       a = Value.new("1234/100")
       b = Value.new("2345/100")
@@ -101,6 +111,10 @@ module Gnucash
       expect(Value.new(80, 100) - Value.new(5, 50)).to eq Value.new(70, 100)
     end
 
+    it "avoid inspection of heavier attributes" do
+      expect(Value.new("1234/10000").inspect).to eq "#<Gnucash::Value val: 1234, div: 10000>"
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnucash
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Josh Holtrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -114,13 +114,17 @@ files:
 - lib/gnucash/account.rb
 - lib/gnucash/account_transaction.rb
 - lib/gnucash/book.rb
+- lib/gnucash/support.rb
+- lib/gnucash/support/light_inspect.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/account_transaction_spec.rb
 - spec/gnucash/book_spec.rb
+- spec/gnucash/support/light_inspect_spec.rb
 - spec/gnucash/transaction_spec.rb
 - spec/gnucash/value_spec.rb
 - spec/gnucash_spec.rb
@@ -137,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -145,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Extract data from XML GnuCash data files
@@ -153,7 +157,9 @@ test_files:
 - spec/books/sample-text.gnucash
 - spec/books/sample.gnucash
 - spec/gnucash/account_spec.rb
+- spec/gnucash/account_transaction_spec.rb
 - spec/gnucash/book_spec.rb
+- spec/gnucash/support/light_inspect_spec.rb
 - spec/gnucash/transaction_spec.rb
 - spec/gnucash/value_spec.rb
 - spec/gnucash_spec.rb