ledgerjournal 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b5770e988a14b6a2a45ada7b393d3a7ef857a822e17a5c4da2caebb50393257
-  data.tar.gz: 5fa7b153ddbddc3a175566086b6ebb8277f75428ad34ea065e13a524ec53b2a8
+  metadata.gz: 3b96cd33913d69368fc316ef97ee6654b2c663960d198cccebaa8400d5d5f9b6
+  data.tar.gz: c24c388fd31134bf04638828b10d2215da2f2f94dc05c9606d220bde0415326b
 SHA512:
-  metadata.gz: d3ce3d96d0e7b9cf22378d8b802b24077be2bcc56f5bffe0005c1b134d1d0621def7f74874ae1f260d5467ce02d7aa06092df30753414b4e59af225f5327fa37
-  data.tar.gz: c70b31078daf4176609859c4751d45d0c153dcee4cea59c22774a317aecd74163024b8b56d5f7f419b32460a7a4f7167f221c8cfd9cf5471fdf07ba8e51dc7ef
+  metadata.gz: bb15f01ae7d43c8a83ad9fbc76434149210e6447d59faef804b0b7245c3c1445c4013b54008550a622d4e454a4e9240e608979937a9c409cfd33729733bcda1d
+  data.tar.gz: 064c993bddf12b87f20f001d16d9bd19df988d26b7ad64c6072e0e6ba1a7db83cfbf8f59819786418552bb0048e5d43ad2a2e2cf550a5693cbb6b71f15d589d6

data/.rubocop.yml

@@ -4,6 +4,9 @@ Layout/LineLength:
 Metrics/MethodLength:
   Max: 30
 
+Metrics/ClassLength:
+  Max: 300
+  
 Style/RedundantReturn:
   Enabled: false
 

data/Gemfile

@@ -6,4 +6,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'minitest', '~> 5.0'
-gem 'rake', '~> 12.0'
+gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -1,27 +1,42 @@
 PATH
   remote: .
   specs:
-    ledgerjournal (0.5.1)
+    ledgerjournal (0.6.0)
+      bigdecimal
       nokogiri (~> 1.10)
       open4 (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
+    bigdecimal (3.2.2)
+    docile (1.4.1)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
+    nokogiri (1.18.10)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
     open4 (1.3.4)
-    rake (12.3.3)
+    racc (1.8.1)
+    rake (13.3.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
 
 PLATFORMS
   ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   ledgerjournal!
   minitest (~> 5.0)
-  rake (~> 12.0)
+  rake (~> 13.0)
+  simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.6.8

data/README.md

@@ -10,16 +10,16 @@ The ledger binary needs to be installed to parse and pretty-print.
 
 ## Usage
 
-Parsing a leger file: 
+Parsing a ledger journal file: 
 
 ```ruby
-journal = Ledger::Journal.new(path: "example_journal.txt")
+journal = Ledger::Journal.new(path: "example_journal.dat")
 journal.transactions.each do |tx|
   puts tx.date, tx.payee
 end
 ```
 
-Creating a ledger:
+Creating a ledger file from scratch:
 
 ```ruby
 journal = Ledger::Journal.new()
@@ -37,9 +37,30 @@ journal.transactions << Ledger::Transaction.new(
 puts(journal.to_s)
 ```
 
+Appending to a ledger journal: 
+
+```ruby
+journal = Ledger::Journal.new(path: "example_journal.dat")
+journal.transactions << Ledger::Transaction.new(
+  date: Date.new(2020, 1, 2),
+  payee: 'Example Payee',
+  postings: [
+    Ledger::Posting.new(account: "Expenses:Unknown", currency: "EUR", amount: BigDecimal('1234.56')),
+    Ledger::Posting.new(account: "Assets:Checking", currency: "EUR", amount: BigDecimal('-1234.56'))
+  ]
+)
+journal.save!
+```
+
+Running ledger commands:
+
+```ruby
+puts Ledger.defaults.run('--version')
+```
+
 ### 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:
+By default ledgerjournal expects the 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)

data/ledgerjournal.gemspec

@@ -17,10 +17,9 @@ The ledger binary needs to be installed to parse and pretty-print.'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   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}"
+    'documentation_uri' => 'https://www.rubydoc.info/gems/ledgerjournal/'
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -32,4 +31,6 @@ The ledger binary needs to be installed to parse and pretty-print.'
 
   spec.add_dependency 'nokogiri', '~> 1.10'
   spec.add_dependency 'open4', '~> 1.3'
+  spec.add_dependency 'bigdecimal'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/ledgerjournal/journal.rb

@@ -23,8 +23,7 @@ module Ledger
         @path = path
         raise Error, "#{@path} not found" unless File.exist?(@path)
 
-        args = ["-f #{@path.shellescape}", ledger_args].compact.join(' ')
-        read_ledger(ledger_args: args)
+        read_ledger(ledger_args: ["-f #{@path.shellescape}", ledger_args].compact.join(' '))
       end
     end
 
@@ -38,6 +37,8 @@ module Ledger
     # @param [Boolean] pretty_print calls ledger to format the journal if true
     def to_s(pretty_print: true)
       str = transactions.map(&:to_s).join("\n\n")
+      # add a newline at the end of the file - see https://github.com/ledger/ledger/issues/516
+      str += "\n"
       if pretty_print
         begin
           str = Ledger.defaults.run('-f - print', stdin: str)
@@ -69,7 +70,7 @@ module Ledger
     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.xpath('ledger/transactions/transaction').map { |tx_xml| Transaction.parse_xml(tx_xml) }
     end
   end
 end

data/lib/ledgerjournal/options.rb

@@ -3,6 +3,9 @@
 module Ledger
   # Options for interaction with ledger-cli
   class Options
+    attr_reader :date_format
+    attr_reader :decimal_comma
+
     # @param [String] date_format like '%Y/%m/%d' to pass to ledger-cli
     # @param [Boolean] decimal_comma pass true to use a comma as decimal separator, otherwise a dot is used
     def initialize(date_format:, decimal_comma:)

data/lib/ledgerjournal/posting.rb

@@ -43,10 +43,11 @@ module Ledger
     end
 
     def to_s
-      posting_line = "#{account}      #{currency} #{Ledger.defaults.format(amount)}"
+      posting_line = "#{account}   "
+      posting_line += "#{currency} #{Ledger.defaults.format(amount)}".rjust(48 - posting_line.length, ' ')
       posting_line += " = #{currency} #{Ledger.defaults.format(balance_assignment)}" if balance_assignment
       lines = [posting_line]
-      lines += metadata.to_a.sort { |a, b| a[0].casecmp(b[0]) }.collect { |m| "; #{m[0]}: #{m[1]}" } unless metadata.empty?
+      lines += metadata.to_a.collect { |m| "; #{m[0]}: #{m[1]}" } unless metadata.empty?
       return lines.join("\n")
     end
 

data/lib/ledgerjournal/transaction.rb

@@ -21,7 +21,7 @@ module Ledger
 
     def self.parse_xml(xml)
       Transaction.new(
-        date: Date.strptime(xml.xpath('date').text, '%Y/%m/%d'),
+        date: Date.strptime(xml.xpath('date').text, Ledger.defaults.date_format),
         payee: xml.xpath('payee').text,
         state: xml['state'].to_sym,
         metadata: Hash[xml.xpath('metadata/value').collect { |m| [m['key'], m.xpath('string').text] }],
@@ -38,11 +38,11 @@ module Ledger
       states = { pending: '!', cleared: '*' }
       lines = ["#{date_str} #{states[state]} #{payee}"]
 
-      lines += metadata.to_a.sort { |a, b| a[0].casecmp(b[0]) }.collect { |m| "    ; #{m[0]}: #{m[1]}" } unless metadata.empty?
+      lines += metadata.to_a.collect { |m| "    ; #{m[0]}: #{m[1]}" } unless metadata.empty?
 
       lines += postings.map { |posting| posting.to_s.lines.map { |line| '    ' + line }.join }
 
-      return lines.join("\n") + "\n"
+      return lines.join("\n")
     end
 
     # @param [String, Array<String>] accounts name(s)

data/lib/ledgerjournal/version.rb

@@ -2,5 +2,5 @@
 
 module Ledger
   # ledgerjournal version
-  VERSION = '0.5.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ledgerjournal
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ralf Ebert
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,6 +37,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 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.
@@ -69,11 +96,9 @@ homepage: https://github.com/ralfebert/ledgerjournal
 licenses:
 - MIT
 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: 
+  documentation_uri: https://www.rubydoc.info/gems/ledgerjournal/
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Library to read and write ledger accounting files.
 test_files: []