xrechnung 0.6.5 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcb000b6c51385ec97931308733407e6400186d86a632db4a30d79adab353bda
-  data.tar.gz: e94c31a304cda4d231b3adb69b6cd331cb50616f2655c68e369f7ebc3824dea4
+  metadata.gz: c12b2ff2f51a6c12f63a584dddc23fd38d5c67f7c153c6c3457622438a82b348
+  data.tar.gz: ed9e52088c5c6a821de9022b89cd201b3ef44de4591e781bee40c8bcf43ff990
 SHA512:
-  metadata.gz: d948ae1c1ea11cec41beb17eccd81b59183995b6015a78303dd8a4adf004ef4c713c040b918002bfd3fdafaa6bdd5d309b102b1e1ffbe1138cc1a8442ce25580
-  data.tar.gz: a44907195bf5a95cf8154fc743e225046c1f9b5c2ab29671c03175f69ea6b4cb37928a67602e3c68d8d9913bef5374f77f0a8e942e40547546a9bf458986bcb0
+  metadata.gz: b58288653e2945cfd22d578e8a069b4f6b9d4a932e4b07331f03d71bf02c79aa5dc31760912fada8c3cd6314365a2f89fe27e83c0a1fd3531b9e3adc37f20cec
+  data.tar.gz: 37465df554df646bdc974f1a0c056866f30afc6f711d88a9886330e08546e2817342ea5a1367b3b576590d3a9c753dda51dc91c8d7ed74f01a929916af7edf95

data/.github/workflows/rspec.yml

@@ -8,7 +8,7 @@ jobs:
     name: Ruby ${{ matrix.ruby }}
     strategy:
       matrix:
-        ruby:  ['3.2', '3.3', '3.4']
+        ruby:  ['3.2', '3.3', '3.4', '4.0']
 
     steps:
     - uses: actions/checkout@v6

data/.github/workflows/validate-fixtures.yml

@@ -11,12 +11,12 @@ jobs:
 
     - uses: actions/setup-java@v5
       with:
-        distribution: "adopt"
-        java-version: "17"
+        distribution: "temurin"
+        java-version: "25"
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version:  "3.4"
+        ruby-version:  "4.0"
         bundler-cache: true
 
     - name: Prepare validator

data/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in xrechnung.gemspec
 gemspec
 
+gem "debug"
 gem "rake"
 gem "rspec"
 gem "rubocop-rspec"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xrechnung (0.6.5)
+    xrechnung (0.7.2)
       activesupport
       base64
       bigdecimal
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (8.1.2)
+    activesupport (8.1.3.1)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -25,37 +25,62 @@ GEM
       uri (>= 0.13.1)
     ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.2)
     builder (3.3.0)
-    concurrent-ruby (1.3.6)
+    concurrent-ruby (1.3.8)
     connection_pool (3.0.2)
-    csv (3.3.5)
+    csv (3.3.6)
+    debug (1.11.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     diff-lcs (1.6.2)
     drb (2.2.3)
+    erb (6.0.6)
     httparty (0.24.2)
       csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.14.8)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
-    json (2.18.0)
-    language_server-protocol (3.17.0.5)
+    io-console (0.8.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.21.2)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     mini_mime (1.1.5)
-    minitest (6.0.1)
+    minitest (6.0.6)
+      drb (~> 2.0)
       prism (~> 1.5)
-    multi_xml (0.8.1)
+    multi_xml (0.9.1)
       bigdecimal (>= 3.1, < 5)
-    parallel (1.27.0)
-    parser (3.3.10.1)
+    parallel (1.28.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.9.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.1)
-    regexp_parser (2.11.3)
+    rake (13.4.2)
+    rbs (4.1.1)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -65,33 +90,35 @@ GEM
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.84.0)
+    rubocop (1.88.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
       rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.49.0)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
       prism (~> 1.7)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.9.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.81)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
-    rubyzip (3.2.2)
+    rubyzip (3.4.1)
     securerandom (0.4.1)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
@@ -103,6 +130,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  debug
   httparty
   rake
   rspec

data/README.md

@@ -1,44 +1,5 @@
 # Xrechnung
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xrechnung`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'xrechnung'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install xrechnung
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/digineo/xrechnung. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/digineo/xrechnung/blob/master/CODE_OF_CONDUCT.md).
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Xrechnung project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/digineo/xrechnung/blob/master/CODE_OF_CONDUCT.md).
+This repository has been archived.
+Please migrate to https://github.com/AlexZeitler/zugpferd
+which supports XRechnung and ZUGFeRD.

data/Rakefile

@@ -9,45 +9,46 @@ RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
+Source = Data.define(:filename, :release_url)
+
 VALIDATOR_SOURCES = {
-  tool:      {
-    filename:    "validator/validator-1.6.0-standalone.jar",
-    release_url: "https://github.com/itplr-kosit/validator/releases/download/v1.6.0/validator-1.6.0.zip",
-  },
-  scenarios: {
-    filename:    "validator/scenarios.xml",
-    release_url: "https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/download/release-2025-07-10/validator-configuration-xrechnung_3.0.2_2025-07-10.zip",
-  },
+  tool:      Source.new(
+    "validator/validator-1.6.2-standalone.jar",
+    "https://github.com/itplr-kosit/validator/releases/download/v1.6.2/validator-1.6.2-standalone.jar",
+  ),
+  scenarios: Source.new(
+    "validator/scenarios.xml",
+    "https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/download/v2026-01-31/xrechnung-3.0.2-validator-configuration-2026-01-31.zip",
+  ),
 }.freeze
 
 namespace :validator do
   VALIDATOR_SOURCES.each_value do |v|
-    base    = Pathname.new(__dir__).join("validator")
-    zipfile = base.join(File.basename(v[:release_url]))
+    base = Pathname.new(__dir__).join("validator").tap(&:mkpath)
 
-    file zipfile do
-      base.mkpath unless base.exist?
+    file v.filename do
+      basename = base.join(File.basename(v.release_url))
 
-      res = HTTParty.get(v[:release_url], follow_redirects: true)
-      File.binwrite(zipfile, res.body)
-    end
+      res = HTTParty.get(v.release_url, follow_redirects: true)
+      File.binwrite(basename, res.body)
 
-    file v[:filename] => zipfile do
-      Zip::File.foreach(zipfile) do |entry|
-        entry.extract destination_directory: base
+      if basename.extname == ".zip"
+        Zip::File.foreach(basename) do |entry|
+          entry.extract destination_directory: base
+        end
       end
     end
   end
 
   desc "Download official validator and scenarios"
-  task download: VALIDATOR_SOURCES.map { |_, v| v[:filename] }
+  task download: VALIDATOR_SOURCES.values.map(&:filename)
 
   desc "Run validator on test fixtures"
   task run: :download do
     fixtures  = Pathname.new(__dir__).join("spec/fixtures/*.xml")
     output    = Pathname.new(__dir__).join("validator/results").tap(&:mkpath)
-    tool      = VALIDATOR_SOURCES[:tool][:filename]
-    scenarios = VALIDATOR_SOURCES[:scenarios][:filename]
+    tool      = VALIDATOR_SOURCES[:tool].filename
+    scenarios = VALIDATOR_SOURCES[:scenarios].filename
 
     sh "java -jar #{tool} -r validator -s #{scenarios} --output-directory #{output} --html #{fixtures}"
   end

data/lib/xrechnung/allowance_charge.rb

@@ -8,7 +8,7 @@ module Xrechnung
 
     # @!attribute allowance_charge_reason_code
     #   @return [String]
-    member :allowance_charge_reason_code, type: Integer
+    member :allowance_charge_reason_code, type: String
 
     # @!attribute allowance_charge_reason
     #   @return [String]
@@ -31,15 +31,13 @@ module Xrechnung
     member :tax_category, type: Xrechnung::TaxCategory
 
     def initialize(**kwargs)
-      unless kwargs[:amount].is_a?(Currency)
-        kwargs[:amount] = Currency::EUR(kwargs[:amount])
-      end
+      kwargs[:amount] = Currency::EUR(kwargs[:amount]) unless kwargs[:amount].is_a?(Currency)
 
       unless kwargs[:base_amount].is_a?(Currency) || kwargs[:base_amount].nil?
         kwargs[:base_amount] = Currency::EUR(kwargs[:base_amount])
       end
 
-      super(**kwargs)
+      super
     end
 
     # noinspection RubyResolve
@@ -47,23 +45,15 @@ module Xrechnung
       xml.cac :AllowanceCharge do
         xml.cbc :ChargeIndicator, charge_indicator
 
-        if allowance_charge_reason_code
-          xml.cbc :AllowanceChargeReasonCode, allowance_charge_reason_code
-        end
+        xml.cbc :AllowanceChargeReasonCode, allowance_charge_reason_code if allowance_charge_reason_code
 
-        if allowance_charge_reason
-          xml.cbc :AllowanceChargeReason, allowance_charge_reason
-        end
+        xml.cbc :AllowanceChargeReason, allowance_charge_reason if allowance_charge_reason
 
-        if multiplier_factor_numeric
-          xml.cbc :MultiplierFactorNumeric, format("%.2f", multiplier_factor_numeric)
-        end
+        xml.cbc :MultiplierFactorNumeric, format("%.2f", multiplier_factor_numeric) if multiplier_factor_numeric
 
         xml.cbc :Amount, *amount.xml_args
 
-        if base_amount
-          xml.cbc :BaseAmount, *base_amount.xml_args
-        end
+        xml.cbc :BaseAmount, *base_amount.xml_args if base_amount
 
         tax_category&.to_xml(xml)
       end

data/lib/xrechnung/currency.rb

@@ -10,6 +10,22 @@ module Xrechnung
     def xml_args
       [value_to_s, { currencyID: currency_id }]
     end
+
+    def self.check_matching_attributes(one, other)
+      raise ArgumentError, "other must be a Currency" unless one.is_a? Currency
+      raise ArgumentError, "other must be a Currency" unless other.is_a? Currency
+      raise ArgumentError, "currency_id must match" unless one.currency_id == other.currency_id
+    end
+
+    def +(other)
+      self.class.check_matching_attributes(self, other)
+      Currency.new(currency_id: currency_id, value: value + other.value)
+    end
+
+    def -(other)
+      self.class.check_matching_attributes(self, other)
+      Currency.new(currency_id: currency_id, value: value - other.value)
+    end
   end
 
   class << Currency

data/lib/xrechnung/member_container.rb

@@ -24,7 +24,7 @@ module Xrechnung
       send("#{key}=", value)
     end
 
-    Member = Struct.new(:type, :default, :optional, :transform_value, keyword_init: true)
+    Member = Struct.new(:type, :default, :optional, :is_private, :transform_value, keyword_init: true)
 
     module ClassMethods
       def members
@@ -53,6 +53,11 @@ module Xrechnung
 
           instance_variable_set :"@#{member_name}", in_value
         end
+
+        return unless member.is_private
+
+        private member_name
+        private setter_name
       end
     end
   end

data/lib/xrechnung/tax_category.rb

@@ -43,6 +43,16 @@ module Xrechnung
     #   @return [String]
     member :tax_exemption_reason, type: String
 
+    def ==(other)
+      return false unless other.is_a?(Xrechnung::TaxCategory)
+
+      id == other.id &&
+        percent == other.percent &&
+        tax_scheme_id == other.tax_scheme_id &&
+        tax_exemption_reason_code == other.tax_exemption_reason_code &&
+        tax_exemption_reason == other.tax_exemption_reason
+    end
+
     # noinspection RubyResolve
     def to_xml(xml, root_tag_name: :TaxCategory)
       xml.cac root_tag_name do

data/lib/xrechnung/tax_subtotal.rb

@@ -32,6 +32,7 @@ module Xrechnung
 
     def initialize(**kwargs)
       super
+      self.tax_amount     ||= Currency::EUR(0)
       self.taxable_amount ||= Currency::EUR(0)
     end
 
@@ -43,5 +44,11 @@ module Xrechnung
         tax_category&.to_xml(xml)
       end
     end
+
+    def update_amount
+      value           = taxable_amount.value * tax_category.percent / 100
+      self.tax_amount = Currency::EUR(value)
+      value
+    end
   end
 end

data/lib/xrechnung/tax_total.rb

@@ -42,5 +42,21 @@ module Xrechnung
       end
       xml.target!
     end
+
+    def update_amounts
+      value           = tax_subtotals.sum(&:update_amount)
+      self.tax_amount = Xrechnung::Currency::EUR(value)
+    end
+
+    def get_tax_subtotal(tax_category)
+      element = tax_subtotals.find { _1.tax_category == tax_category }
+
+      unless element
+        element = Xrechnung::TaxSubtotal.new(tax_category: tax_category)
+        tax_subtotals << element
+      end
+
+      element
+    end
   end
 end

data/lib/xrechnung/version.rb

@@ -1,3 +1,3 @@
 module Xrechnung
-  VERSION = "0.6.5".freeze
+  VERSION = "0.7.3".freeze
 end

data/lib/xrechnung.rb

@@ -172,6 +172,9 @@ module Xrechnung
     #   @return [String]
     member :tax_currency_code, type: String
 
+    # Buyer accounting reference BT-19
+    member :buyer_accounting_reference, type: String, optional: true
+
     # Buyer reference BT-10
     #
     # Ein vom Erwerber zugewiesener und für interne Lenkungszwecke benutzter Bezeichner.
@@ -262,7 +265,7 @@ module Xrechnung
     #
     # @!attribute tax_total
     #   @return [Xrechnung::TaxTotal]
-    member :tax_total, type: Xrechnung::TaxTotal
+    member :tax_total, type: Xrechnung::TaxTotal, is_private: true
 
     # DOCUMENT TOTALS BG-22
     #
@@ -271,7 +274,7 @@ module Xrechnung
     #
     # @!attribute legal_monetary_total
     #   @return [Xrechnung::LegalMonetaryTotal]
-    member :legal_monetary_total, type: Xrechnung::LegalMonetaryTotal
+    member :legal_monetary_total, type: Xrechnung::LegalMonetaryTotal, is_private: true
 
     # INVOICE LINE BG-25
     #
@@ -301,7 +304,18 @@ module Xrechnung
       "xsi:schemaLocation" => "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2 http://docs.oasis-open.org/ubl/os-UBL-2.1/xsd/maindoc/UBL-Invoice-2.1.xsd",
     }.freeze
 
+    def initialize(...)
+      super
+      self.legal_monetary_total ||= Xrechnung::LegalMonetaryTotal.new
+    end
+
+    def prepaid_amount=(value)
+      legal_monetary_total.prepaid_amount = value
+    end
+
     def to_xml(indent: 2, target: "")
+      update_amounts
+
       xml = Builder::XmlMarkup.new(indent: indent, target: target)
       xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
 
@@ -320,6 +334,7 @@ module Xrechnung
         xml.cbc :TaxPointDate, tax_point_date unless tax_point_date.nil?
         xml.cbc :DocumentCurrencyCode, document_currency_code
         xml.cbc :TaxCurrencyCode, tax_currency_code unless tax_currency_code.nil?
+        xml.cbc :AccountingCost, buyer_accounting_reference unless buyer_accounting_reference.nil?
         xml.cbc :BuyerReference, buyer_reference
 
         invoice_period&.to_xml(xml) unless self.class.members[:invoice_period].optional && invoice_period.nil?
@@ -368,8 +383,10 @@ module Xrechnung
           end
         end
 
-        xml.cac :PaymentMeans do
-          payment_means&.to_xml(xml)
+        if payment_means
+          xml.cac :PaymentMeans do
+            payment_means&.to_xml(xml)
+          end
         end
 
         payee_party&.to_xml(xml) unless self.class.members[:payee_party].optional && payee_party.nil?
@@ -395,5 +412,48 @@ module Xrechnung
 
       target
     end
+
+    def update_amounts
+      self.tax_total = Xrechnung::TaxTotal.new
+
+      invoice_lines.each do |invoice_line|
+        tax_total.get_tax_subtotal(invoice_line.item.classified_tax_category).taxable_amount += invoice_line.line_extension_amount
+      end
+
+      allowance_charges.each do |ac|
+        element = tax_total.get_tax_subtotal(ac.tax_category)
+        if ac.charge_indicator
+          element.taxable_amount += ac.amount
+        else
+          element.taxable_amount -= ac.amount
+        end
+      end
+
+      tax_total.update_amounts
+
+      currency_id = tax_total.tax_amount.currency_id
+      zero        = Xrechnung::Currency.new(currency_id: currency_id, value: BigDecimal(0))
+
+      legal_monetary_total.line_extension_amount  = zero
+      legal_monetary_total.allowance_total_amount = zero
+      legal_monetary_total.charge_total_amount    = zero
+      legal_monetary_total.prepaid_amount       ||= zero
+
+      invoice_lines.each do |line|
+        legal_monetary_total.line_extension_amount += line.line_extension_amount
+      end
+
+      allowance_charges.each do |ac|
+        if ac.charge_indicator
+          legal_monetary_total.charge_total_amount += ac.amount
+        else
+          legal_monetary_total.allowance_total_amount += ac.amount
+        end
+      end
+
+      legal_monetary_total.tax_exclusive_amount = legal_monetary_total.line_extension_amount + legal_monetary_total.charge_total_amount - legal_monetary_total.allowance_total_amount
+      legal_monetary_total.tax_inclusive_amount = legal_monetary_total.tax_exclusive_amount + tax_total.tax_amount
+      legal_monetary_total.payable_amount       = legal_monetary_total.tax_inclusive_amount - legal_monetary_total.prepaid_amount
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xrechnung
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.3
 platform: ruby
 authors:
 - Julian Kornberger
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.13
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Library to create invoices in the XRechnung format.
 test_files: []