ledgerjournal 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54a88d089772a52d3f2679f0ca80c2d3fed563d7cbadd44531ace686018045df
-  data.tar.gz: f78a221028fd29e7a2553b55431b10fe7ff2ea0cac4fbe4cfb7d62db73f5da3f
+  metadata.gz: 0b5770e988a14b6a2a45ada7b393d3a7ef857a822e17a5c4da2caebb50393257
+  data.tar.gz: 5fa7b153ddbddc3a175566086b6ebb8277f75428ad34ea065e13a524ec53b2a8
 SHA512:
-  metadata.gz: aea34667a60c6560425fa18032ae15b525db1459b741d50e67afed0d52fba9fcce3205163b39ecf01e4d258e59dff21674fdf945f86762df8d9af9296b4a92b5
-  data.tar.gz: 20a2e543860cd3cc7e72ccd9a805d7bdd20e5cbf485f519afd7be24e84d2949de7fdfbc049fdb6a1ef8995d8bcae0c0d0790e36c6843e2577d8d693b6733fe75
+  metadata.gz: d3ce3d96d0e7b9cf22378d8b802b24077be2bcc56f5bffe0005c1b134d1d0621def7f74874ae1f260d5467ce02d7aa06092df30753414b4e59af225f5327fa37
+  data.tar.gz: c70b31078daf4176609859c4751d45d0c153dcee4cea59c22774a317aecd74163024b8b56d5f7f419b32460a7a4f7167f221c8cfd9cf5471fdf07ba8e51dc7ef

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Layout/LineLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/RedundantReturn:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false

data/.travis.yml

@@ -2,6 +2,7 @@
 language: ruby
 cache: bundler
 rvm:
+  - 2.5
   - 2.6
   - 2.7
 before_install:

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ledgerjournal.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ledgerjournal (0.5.0)
+    ledgerjournal (0.5.1)
       nokogiri (~> 1.10)
       open4 (~> 1.3)
 

data/README.md

@@ -1,9 +1,11 @@
 # ledgerjournal
 
+[![Gem Version](https://badge.fury.io/rb/ledgerjournal.svg)](https://badge.fury.io/rb/ledgerjournal)
 [![Build Status](https://travis-ci.org/ralfebert/ledgerjournal.svg?branch=master)](https://travis-ci.org/github/ralfebert/ledgerjournal)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/ledgerjournal/)
 
 ledgerjournal is a Ruby gem to read and write [ledger](https://www.ledger-cli.org/) accounting files.
-For parsing, it uses the xml output from ledger. For outputting, it formats the ledger data to String in custom Ruby code.
+For parsing, it uses the [ledger xml command](https://www.ledger-cli.org/3.0/doc/ledger3.html#The-xml-command). For outputting, it formats the ledger data as String in Ruby.
 The ledger binary needs to be installed to parse and pretty-print.
 
 ## Usage
@@ -11,7 +13,7 @@ The ledger binary needs to be installed to parse and pretty-print.
 Parsing a leger file: 
 
 ```ruby
-journal = Ledger::Journal.new(path: "example_journal_en.txt")
+journal = Ledger::Journal.new(path: "example_journal.txt")
 journal.transactions.each do |tx|
   puts tx.date, tx.payee
 end
@@ -20,11 +22,10 @@ end
 Creating a ledger:
 
 ```ruby
-journal = Ledger::Journal.new(path: "example_journal_en.txt")
+journal = Ledger::Journal.new()
 
 journal.transactions << Ledger::Transaction.new(
   date: Date.new(2020, 1, 2),
-  state: :cleared,
   payee: 'Example Payee',
   metadata: { "Foo" => "Bar", "Description" => "Example Transaction" },
   postings: [
@@ -36,6 +37,19 @@ journal.transactions << Ledger::Transaction.new(
 puts(journal.to_s)
 ```
 
+### Locale-specific settings
+
+By default ledgerjournal expectes the ledger default date format '%Y/%m/%d' and amounts with decimal point (1234.56). This is configurable:
+
+```ruby
+Ledger.defaults = Options.new(date_format: '%d.%m.%Y', decimal_comma: true)
+```
+
+or:
+
+```ruby
+Ledger.defaults = Ledger::Options.for_locale(:de)
+```
 
 ## Installation
 
@@ -59,4 +73,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ralfeb
 
 ## License
 
-libledger is released under the MIT License. See LICENSE.md.
+ledgerjournal is released under the MIT License. See LICENSE.md.

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "ledgerjournal"
+require 'bundler/setup'
+require 'ledgerjournal'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "ledgerjournal"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/ledgerjournal.gemspec

@@ -1,30 +1,35 @@
+# frozen_string_literal: true
+
 require_relative 'lib/ledgerjournal/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ledgerjournal"
+  spec.name          = 'ledgerjournal'
   spec.version       = Ledger::VERSION
   spec.licenses      = ['MIT']
-  spec.authors       = ["Ralf Ebert"]
-  spec.email         = ["ralf.ebert@gmail.com"]
+  spec.authors       = ['Ralf Ebert']
+  spec.email         = ['ralf.ebert@gmail.com']
 
-  spec.summary       = %q{Library to read and write ledger accounting files.}
-  spec.description   = %q{ledgerjournal is a Ruby gem to read and write ledger accounting files.
+  spec.summary       = 'Library to read and write ledger accounting files.'
+  spec.description   = 'ledgerjournal is a Ruby gem to read and write ledger accounting files.
 For parsing, it uses the xml output from ledger. For outputting, it formats the ledger data to String in custom Ruby code.
-The ledger binary needs to be installed to parse and pretty-print.}
-  spec.homepage      = "https://github.com/ralfebert/ledgerjournal"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+The ledger binary needs to be installed to parse and pretty-print.'
+  spec.homepage      = 'https://github.com/ralfebert/ledgerjournal'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/ralfebert/ledgerjournal.git"
+  spec.metadata = {
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => 'https://github.com/ralfebert/ledgerjournal.git',
+    'bug_tracker_uri' => 'https://github.com/ralfebert/ledgerjournal/issues',
+    'documentation_uri' => "https://www.rubydoc.info/gems/ledgerjournal/#{Ledger::VERSION}"
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.require_paths = ["lib"]
-  
+  spec.require_paths = ['lib']
+
   spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'open4', '~> 1.3'
-  
 end

data/lib/ledgerjournal.rb

@@ -1,13 +1,13 @@
-require "ledgerjournal/version"
-require "ledgerjournal/options"
-require "ledgerjournal/journal"
-require "ledgerjournal/transaction"
-require "ledgerjournal/posting"
+# frozen_string_literal: true
+
+require 'ledgerjournal/version'
+require 'ledgerjournal/options'
+require 'ledgerjournal/journal'
+require 'ledgerjournal/transaction'
+require 'ledgerjournal/posting'
 
 # Ledger provides classes to read and write ledger accounting files.
 module Ledger
-
   # Error class for errors handling ledger files
   class Error < StandardError; end
-
 end

data/lib/ledgerjournal/journal.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 require 'nokogiri'
 require 'open4'
+require 'set'
 
 module Ledger
-
   # Represents a ledger journal
   # @see https://www.ledger-cli.org/3.0/doc/ledger3.html#Journal-Format
   class Journal
-
     # @return [Array<Ledger::Transaction>] list of transactions in journal
     attr_accessor :transactions
     # @return [String] path path to ledger file
@@ -20,8 +21,9 @@ module Ledger
       @transactions = []
       if path
         @path = path
-        raise Error.new("#{@path} not found") unless File.exist?(@path)
-        args = ["-f #{@path.shellescape}", ledger_args].compact.join(" ")
+        raise Error, "#{@path} not found" unless File.exist?(@path)
+
+        args = ["-f #{@path.shellescape}", ledger_args].compact.join(' ')
         read_ledger(ledger_args: args)
       end
     end
@@ -29,20 +31,20 @@ module Ledger
     # @param [Ledger::Journal] other
     # @return [Boolean] true if the other journal contains equal transactions
     def ==(other)
-      self.transactions == other.transactions
+      transactions == other.transactions
     end
 
     # @return [String] returns the transactions in the journal formatted as string
     # @param [Boolean] pretty_print calls ledger to format the journal if true
     def to_s(pretty_print: true)
-      str = self.transactions.map(&:to_s).join("\n\n")
+      str = transactions.map(&:to_s).join("\n\n")
       if pretty_print
         begin
-          str = Ledger.defaults.run("-f - print", stdin: str)
-          str = str.lines.map { |line| line.rstrip }.join("\n") + "\n"
-        rescue => error
+          str = Ledger.defaults.run('-f - print', stdin: str)
+          str = str.lines.map(&:rstrip).join("\n") + "\n"
+        rescue StandardError => e
           # return an unformatted string if an error occurs
-          puts "Couldn't format transaction log: #{error}"
+          puts "Couldn't format transaction log: #{e}"
         end
       end
       return str
@@ -50,23 +52,24 @@ module Ledger
 
     # If the journal was opened from a file, save/overwrite the file with the transactions from this journal.
     def save!
-      raise Error.new("Journal was not read from path, cannot save") unless @path
-      File.write(@path, self.to_s)
+      raise Error, 'Journal was not read from path, cannot save' unless @path
+
+      File.write(@path, to_s)
     end
 
-    # returns all transactions that have a posting for the given account
-    # @param [String] account account name
+    # returns all transactions that have a posting for one of the given accounts
+    # @param [String, Array<String>, Set<String>] account account name(s)
     def transactions_with_account(account)
-      @transactions.select {|tx| tx.postings.map(&:account).include?(account) }
+      accounts = account.is_a?(Enumerable) ? Set.new(account) : Set[account]
+      @transactions.select { |tx| accounts.intersect?(Set.new(tx.postings.map(&:account))) }
     end
 
     private
-    def read_ledger(ledger_args: "")
-      xml_result = Ledger.defaults.run(ledger_args + " xml")
+
+    def read_ledger(ledger_args: '')
+      xml_result = Ledger.defaults.run(ledger_args + ' xml')
       xml = Nokogiri::XML(xml_result)
-      @transactions = xml.css("transaction").map { |tx_xml| Transaction.parse_xml(tx_xml) }
+      @transactions = xml.css('transaction').map { |tx_xml| Transaction.parse_xml(tx_xml) }
     end
-
   end
-
 end

data/lib/ledgerjournal/options.rb

@@ -1,10 +1,10 @@
-module Ledger
+# frozen_string_literal: true
 
+module Ledger
   # Options for interaction with ledger-cli
   class Options
-    
     # @param [String] date_format like '%Y/%m/%d' to pass to ledger-cli
-    # @param [Boolean] decimal_comma pass true to use ',' as decimal comma separator
+    # @param [Boolean] decimal_comma pass true to use a comma as decimal separator, otherwise a dot is used
     def initialize(date_format:, decimal_comma:)
       @date_format = date_format
       @decimal_comma = decimal_comma
@@ -20,14 +20,14 @@ module Ledger
       when :de
         Options.new(date_format: '%d.%m.%Y', decimal_comma: true)
       else
-        raise Error.new("Unknown locale for ledger options: #{locale}, supported are :en, :de")
+        raise Error, "Unknown locale for ledger options: #{locale}, supported are :en, :de"
       end
     end
 
     # @param [String] string decimal amount as String (like '12.34')
     # @return [BigDecimal] the given string as BigDecimal, parsed according the decimal_comma setting
     def parse_amount(string)
-      BigDecimal(if @decimal_comma then string.gsub(".", "").gsub(",", ".") else string end)
+      BigDecimal(@decimal_comma ? string.gsub('.', '').gsub(',', '.') : string)
     end
 
     # Formats the given value as String
@@ -41,7 +41,7 @@ module Ledger
         str.gsub!('.', ',') if @decimal_comma
         return str
       else
-        raise Error.new("Unknown value type #{value.class}")
+        raise Error, "Unknown value type #{value.class}"
       end
     end
 
@@ -50,23 +50,23 @@ module Ledger
     # @param [String] stdin stdin text to pass
     # @return [String] stdout result of calling ledger
     def run(args, stdin: nil)
-      output = ""
-      error = ""
+      output = String.new
+      error = String.new
       begin
-        Open4.spawn("ledger #{cmdline_options} #{args}", :stdin => stdin, :stdout => output, :stderr => error)
-      rescue => e
-        raise Error.new("#{e}: #{error}")
+        Open4.spawn("ledger #{cmdline_options} #{args}", stdin: stdin, stdout: output, stderr: error)
+      rescue StandardError => e
+        raise Error, "#{e}: #{error}"
       end
       return output
     end
 
     private
+
     def cmdline_options
-      args = ["--args-only", "--date-format #{@date_format}", "--input-date-format #{@date_format}"]
-      args << "--decimal-comma" if @decimal_comma
-      return args.join(" ")
+      args = ['--args-only', "--date-format #{@date_format}", "--input-date-format #{@date_format}"]
+      args << '--decimal-comma' if @decimal_comma
+      return args.join(' ')
     end
-
   end
 
   @defaults = Options.for_locale(:en)
@@ -75,5 +75,4 @@ module Ledger
     # @attr [Ledger::Options] defaults options to use when interacting with ledger-cli, by default settings for locale :en are used
     attr_accessor :defaults
   end
-
 end

data/lib/ledgerjournal/posting.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'bigdecimal'
 
 module Ledger
-
   # @attr [String] account
   # @attr [String] currency
   # @attr [BigDecimal] amount
   # @attr [BigDecimal] balance_assignment if a balance_assignment is set, ledger-cli checks the balance of the account after this posting
   # @attr [Hash<String, String>] metadata
   class Posting
-    
     attr_accessor :account, :currency, :amount, :balance_assignment, :metadata
-        
+
     def initialize(account:, currency:, amount:, balance_assignment: nil, metadata: {})
       @account = account
       @currency = currency
@@ -19,13 +19,14 @@ module Ledger
       @balance_assignment = balance_assignment
       @metadata = metadata
     end
-    
+
     def self.parse_xml(xml)
       balance_assignment = nil
       currency = xml.xpath('post-amount/amount/commodity/symbol').text
-      if xml_balance = xml.xpath('balance-assignment').first
+      if (xml_balance = xml.xpath('balance-assignment').first)
         balance_currency = xml_balance.xpath('commodity/symbol').text
-        raise Error.new("Posting currency #{currency} doesn't match assignment currency #{balance_currency}") if currency != balance_currency
+        raise Error, "Posting currency #{currency} doesn't match assignment currency #{balance_currency}" if currency != balance_currency
+
         balance_assignment = Ledger.defaults.parse_amount(xml_balance.xpath('quantity').text)
       end
       Posting.new(
@@ -33,31 +34,26 @@ module Ledger
         currency: currency,
         amount: Ledger.defaults.parse_amount(xml.xpath('post-amount/amount/quantity').text),
         balance_assignment: balance_assignment,
-        metadata: Hash[xml.xpath("metadata/value").collect {|m| [m['key'], m.xpath("string").text]}]
+        metadata: Hash[xml.xpath('metadata/value').collect { |m| [m['key'], m.xpath('string').text] }]
       )
     end
-    
+
     def ==(other)
-      self.class == other.class && self.all_fields == other.all_fields
+      self.class == other.class && all_fields == other.all_fields
     end
-    
+
     def to_s
-      posting_line = "#{self.account}      #{self.currency} #{Ledger.defaults.format(self.amount)}"
-      if self.balance_assignment
-        posting_line += " = #{self.currency} #{Ledger.defaults.format(self.balance_assignment)}"
-      end
+      posting_line = "#{account}      #{currency} #{Ledger.defaults.format(amount)}"
+      posting_line += " = #{currency} #{Ledger.defaults.format(balance_assignment)}" if balance_assignment
       lines = [posting_line]
-      unless self.metadata.empty?
-        lines += metadata.to_a.sort {|a,b| a[0].casecmp(b[0]) }.collect{|m| "; #{m[0]}: #{m[1]}" }
-      end
+      lines += metadata.to_a.sort { |a, b| a[0].casecmp(b[0]) }.collect { |m| "; #{m[0]}: #{m[1]}" } unless metadata.empty?
       return lines.join("\n")
     end
-    
+
     protected
+
     def all_fields
-      self.instance_variables.map { |variable| self.instance_variable_get variable }
+      instance_variables.map { |variable| instance_variable_get variable }
     end
-    
   end
-
 end

data/lib/ledgerjournal/transaction.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module Ledger
-
   # @attr [Date] date
   # @attr [Symbol] state state of transaction, can be :cleared or :pending
   # @attr [String] payee
   # @attr [Hash<String, String>] metadata
   # @attr [Array<Ledger::Posting>] postings
   class Transaction
-
     attr_accessor :date, :state, :payee, :metadata, :postings
 
     def initialize(date:, state: :cleared, payee:, metadata: {}, postings:)
@@ -21,44 +21,46 @@ module Ledger
 
     def self.parse_xml(xml)
       Transaction.new(
-          date: Date.strptime(xml.xpath('date').text, '%Y/%m/%d'),
-          payee: xml.xpath('payee').text,
-          state: xml['state'].to_sym,
-          metadata: Hash[xml.xpath("metadata/value").collect { |m| [m['key'], m.xpath("string").text] }],
-          postings: xml.xpath('postings/posting').map { |posting_xml| Posting.parse_xml(posting_xml) }
+        date: Date.strptime(xml.xpath('date').text, '%Y/%m/%d'),
+        payee: xml.xpath('payee').text,
+        state: xml['state'].to_sym,
+        metadata: Hash[xml.xpath('metadata/value').collect { |m| [m['key'], m.xpath('string').text] }],
+        postings: xml.xpath('postings/posting').map { |posting_xml| Posting.parse_xml(posting_xml) }
       )
     end
 
     def ==(other)
-      self.class == other.class && self.all_fields == other.all_fields
+      self.class == other.class && all_fields == other.all_fields
     end
 
     def to_s
-      date_str = Ledger.defaults.format(self.date)
-      states = {:pending => "!", :cleared => "*"}
-      lines = ["#{date_str} #{states[self.state]} #{self.payee}"]
+      date_str = Ledger.defaults.format(date)
+      states = { pending: '!', cleared: '*' }
+      lines = ["#{date_str} #{states[state]} #{payee}"]
 
-      unless self.metadata.empty?
-        lines += metadata.to_a.sort { |a, b| a[0].casecmp(b[0]) }.collect { |m| "    ; #{m[0]}: #{m[1]}" }
-      end
+      lines += metadata.to_a.sort { |a, b| a[0].casecmp(b[0]) }.collect { |m| "    ; #{m[0]}: #{m[1]}" } unless metadata.empty?
 
-      lines += self.postings.map { |posting| posting.to_s.lines.map { |line| "    " + line }.join }
+      lines += postings.map { |posting| posting.to_s.lines.map { |line| '    ' + line }.join }
 
       return lines.join("\n") + "\n"
     end
 
-    # @param [String] account
-    # @return [Ledger::Posting]
-    def posting_for_account(account)
-      postings.select { |posting| posting.account == account }.first
+    # @param [String, Array<String>] accounts name(s)
+    # @return [Ledger::Posting] Returns the first posting that matches one of the given account names
+    def posting_for_account(accounts)
+      accounts = [accounts] unless accounts.is_a?(Enumerable)
+      accounts.each do |account|
+        postings.each do |posting|
+          return posting if account == posting.account
+        end
+      end
+      return nil
     end
 
     protected
 
     def all_fields
-      self.instance_variables.map { |variable| self.instance_variable_get(variable) }
+      instance_variables.map { |variable| instance_variable_get(variable) }
     end
-
   end
-
 end

data/lib/ledgerjournal/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Ledger
   # ledgerjournal version
-  VERSION = "0.5.0"
+  VERSION = '0.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledgerjournal
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ralf Ebert
@@ -49,6 +49,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -70,6 +71,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ralfebert/ledgerjournal
   source_code_uri: https://github.com/ralfebert/ledgerjournal.git
+  bug_tracker_uri: https://github.com/ralfebert/ledgerjournal/issues
+  documentation_uri: https://www.rubydoc.info/gems/ledgerjournal/0.5.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -78,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="