xrechnung 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b1e46debbb386e29b8d5acf9fff32ce97a374b613ca3359a9f694ea55d58e9
-  data.tar.gz: 0f81126b1f1fa3d921736970c21f63c130e9d6655913e3fb306f3ccf1d5892b2
+  metadata.gz: bb95657d503486400ca7f7ff6664ae22a0cbbeb4e6e6588ed9edab03ebd31ee9
+  data.tar.gz: '0926fa0b0dfb0ffd51cc271cfca28897936bbe9b5a93a38c577a17da415925fe'
 SHA512:
-  metadata.gz: d03ff9707832f949b7fb51d33b73af0c5d9ef9ce8d07719fb1222aeb907477bf260eb408b5a24ba736d195a845461c744bd706a62a93154e258888a7e8f36d9a
-  data.tar.gz: b1ae9c060ac8651af67bac032c028e1a48281f6710b0ca53c1f9ab8ba934bfa566a63b405c12f3d80754379cabda493727604aaf2966e4e5e2fca09d6e8f8976
+  metadata.gz: 84a2cc18d6ace05c0355154f0ae0addd91d23516d5654f50f11d9ea6c01d94e12ac8ea7d615d5feaf18d2e90fb20bc7fe9b9f700f93351c0ae6aa43272f057ae
+  data.tar.gz: edb7fb59d4435c67acd2e54bce2222a534d0752cb17572873005de1e99f44fabc06cecd8d4b328ccd05be70b0ac62ae75b68e3183bd9dff957429c587f3905b2

data/.github/workflows/rspec.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:  ['2.7', '3.0', '3.2']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run rspec
+      run: bundle exec rake spec

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

@@ -1,13 +1,13 @@
 name: Validate spec fixtures
 
-on: push
+on: [push, pull_request]
 
 jobs:
   validate:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - uses: actions/setup-java@v2
       with:
@@ -16,7 +16,7 @@ jobs:
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version:  "2.7"
+        ruby-version:  "3.2"
         bundler-cache: true
 
     - name: Prepare validator
@@ -25,7 +25,7 @@ jobs:
     - name: Run validator
       run: bundle exec rake validator:run
 
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v4
       if: failure()
       with:
         name: validation-results

data/Gemfile.lock

@@ -1,65 +1,81 @@
 PATH
   remote: .
   specs:
-    xrechnung (0.1.3)
+    xrechnung (0.3.0)
       builder (~> 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    builder (3.2.4)
-    diff-lcs (1.4.4)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
+    builder (3.3.0)
+    csv (3.3.0)
+    diff-lcs (1.5.1)
+    httparty (0.22.0)
+      csv
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.5)
     multi_xml (0.6.0)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    parallel (1.25.1)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+      racc
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.1)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-rspec (2.2.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    rubyzip (2.3.0)
-    unicode-display_width (2.0.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-rspec (2.31.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  httparty
+  httparty (~> 0.22)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop-rspec (~> 2.1)
@@ -67,4 +83,4 @@ DEPENDENCIES
   xrechnung!
 
 BUNDLED WITH
-   2.2.15
+   2.4.19

data/Rakefile

@@ -14,7 +14,7 @@ namespace :validator do
     },
     scenarios: {
       filename:    "validator/scenarios.xml",
-      release_url: "https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/download/release-2020-12-31/validator-configuration-xrechnung_2.0.1_2020-12-31.zip",
+      release_url: "https://github.com/itplr-kosit/validator-configuration-xrechnung/releases/download/release-2023-05-12/validator-configuration-xrechnung_2.3.1_2023-05-12.zip",
     }
   }
 

data/lib/xrechnung/invoice_line.rb

@@ -1,3 +1,5 @@
+require "xrechnung/invoice_period"
+
 module Xrechnung
   class InvoiceLine
     include MemberContainer
@@ -14,6 +16,10 @@ module Xrechnung
     #   @return [Xrechnung::Currency]
     member :line_extension_amount, type: Xrechnung::Currency
 
+    # @!attribute invoice_period
+    #   @return [Xrechnung::InvoicePeriod]
+    member :invoice_period, type: Xrechnung::InvoicePeriod, optional: true
+
     # @!attribute item
     #   @return [Xrechnung::Item]
     member :item, type: Xrechnung::Item
@@ -23,7 +29,9 @@ module Xrechnung
     member :price, type: Xrechnung::Price
 
     def initialize(**kwargs)
-      kwargs[:line_extension_amount] = Currency::EUR(kwargs[:line_extension_amount])
+      unless kwargs[:line_extension_amount].is_a?(Currency)
+        kwargs[:line_extension_amount] = Currency::EUR(kwargs[:line_extension_amount])
+      end
       super(**kwargs)
     end
 
@@ -33,6 +41,10 @@ module Xrechnung
         xml.cbc :ID, id
         xml.cbc :InvoicedQuantity, invoiced_quantity.amount_to_s, unitCode: invoiced_quantity.unit_code
         xml.cbc :LineExtensionAmount, *line_extension_amount.xml_args
+
+        unless self.class.members[:invoice_period].optional && invoice_period.nil?
+          invoice_period&.to_xml(xml)
+        end
         item&.to_xml(xml)
         price&.to_xml(xml)
       end

data/lib/xrechnung/invoice_period.rb

@@ -0,0 +1,20 @@
+module Xrechnung
+  class InvoicePeriod
+    include MemberContainer
+
+    # @!attribute start_date
+    #   @return [Date]
+    member :start_date, type: Date
+
+    # @!attribute end_date
+    #   @return [Date]
+    member :end_date, type: Date
+
+    def to_xml(xml)
+      xml.cac :InvoicePeriod do
+        xml.cbc :StartDate, start_date
+        xml.cbc :EndDate, end_date
+      end
+    end
+  end
+end

data/lib/xrechnung/legal_monetary_total.rb

@@ -3,7 +3,7 @@ module Xrechnung
     include MemberContainer
 
     transform_currency = ->(v) {
-      Currency::EUR(v)
+      v.is_a?(Currency) ? v : Currency::EUR(v)
     }
 
     # @!attribute line_extension_amount
@@ -40,10 +40,10 @@ module Xrechnung
 
     # noinspection RubyResolve
     def to_xml(xml)
-      members.each do |member, _options|
-        next if self[member].nil?
+      self.class.members.each_key do |name|
+        next if self[name].nil?
 
-        xml.cbc :"#{member.to_s.split("_").map(&:capitalize).join}", *self[member].xml_args
+        xml.cbc :"#{name.to_s.split("_").map(&:capitalize).join}", *self[name].xml_args
       end
       xml.target!
     end

data/lib/xrechnung/member_container.rb

@@ -6,8 +6,9 @@ module Xrechnung
     end
 
     def initialize(**kwargs)
-      self.class.after_initialize.each do |block|
-        instance_eval(&block)
+      # initialize default values
+      self.class.members.each do |name, member|
+        self[name] = member.default.dup unless member.default.nil?
       end
 
       kwargs.each do |k, v|
@@ -15,54 +16,44 @@ module Xrechnung
       end
     end
 
-    def members
-      self.class.instance_variable_get :@members
-    end
-
     def [](key)
       send(key)
     end
 
     def []=(key, value)
-      send(members[key].fetch(:setter_name), value)
+      send("#{key}=", value)
     end
 
+    Member = Struct.new(:type, :default, :optional, :transform_value, keyword_init: true)
+
     module ClassMethods
+      def members
+        @members
+      end
+
       # @param [String] member_name
       # @param [Array<Class>, Class] type
       # @param [Object] default
       # @param [TrueClass, FalseClass] optional When true, omits tag rather than rendering an empty tag on nil
       # @param [Proc] transform_value A Proc which is called with the input value to perform type conversion.
-      def member(member_name, type: nil, default: nil, optional: false, transform_value: nil)
+      def member(member_name, **kwargs)
         attr_reader member_name
-        setter_name           = :"#{member_name}="
-        @members[member_name] = { optional: optional, setter_name: setter_name }
+        kwargs[:default].freeze
 
-        if default
-          after_initialize do
-            send(setter_name, default)
-          end
-        end
+        setter_name           = :"#{member_name}="
+        member                = Member.new(**kwargs)
+        @members[member_name] = member
 
         define_method setter_name do |in_value|
-          in_value = transform_value.call(in_value) if transform_value
+          in_value = member.transform_value.call(in_value) if member.transform_value
 
-          if type && !in_value.nil? && Array(type).none? { |t| in_value.is_a?(t) }
-            raise ArgumentError, "expected #{type} for :#{member_name}, got: #{in_value.class}"
+          if member.type && !in_value.nil? && Array(member.type).none? { |t| in_value.is_a?(t) }
+            raise ArgumentError, "expected #{member.type} for :#{member_name}, got: #{in_value.class}"
           end
 
           instance_variable_set :"@#{member_name}", in_value
         end
       end
-
-      def after_initialize(&block)
-        @after_initialize_blocks ||= []
-        if block
-          @after_initialize_blocks << block
-        else
-          @after_initialize_blocks
-        end
-      end
     end
   end
 end

data/lib/xrechnung/party_legal_entity.rb

@@ -2,6 +2,10 @@ module Xrechnung
   class PartyLegalEntity
     include MemberContainer
 
+    # @!attribute company_id
+    #   @return [String]
+    member :company_id, type: String
+
     # @!attribute registration_name
     #   @return [String]
     member :registration_name, type: String
@@ -9,6 +13,7 @@ module Xrechnung
     # noinspection RubyResolve
     def to_xml(xml)
       xml.cac :PartyLegalEntity do
+        xml.cbc(:CompanyID, company_id) unless company_id.nil?
         xml.cbc :RegistrationName, registration_name
       end
     end

data/lib/xrechnung/price.rb

@@ -15,7 +15,9 @@ module Xrechnung
     member :allowance_charge, type: Xrechnung::AllowanceCharge
 
     def initialize(**kwargs)
-      kwargs[:price_amount] = Currency::EUR(kwargs[:price_amount])
+      unless kwargs[:price_amount].is_a?(Currency)
+        kwargs[:price_amount] = Currency::EUR(kwargs[:price_amount])
+      end
       super(**kwargs)
     end
 
@@ -23,7 +25,7 @@ module Xrechnung
     def to_xml(xml)
       xml.cac :Price do
         xml.cbc :PriceAmount, *price_amount.xml_args
-        xml.cbc :BaseQuantity, *base_quantity.xml_args
+        xml.cbc(:BaseQuantity, *base_quantity.xml_args) unless base_quantity.nil?
         allowance_charge&.to_xml(xml)
       end
     end

data/lib/xrechnung/tax_category.rb

@@ -29,6 +29,14 @@ module Xrechnung
     #   @return [String]
     member :tax_scheme_id, type: String, default: "VAT"
 
+    # @!attribute tax_exemption_reason_code
+    #   @return [String]
+    member :tax_exemption_reason_code, type: String
+
+    # @!attribute tax_exemption_reason
+    #   @return [String]
+    member :tax_exemption_reason, type: String
+
     # noinspection RubyResolve
     def to_xml(xml, root_tag_name: :TaxCategory)
       xml.cac root_tag_name do
@@ -37,6 +45,11 @@ module Xrechnung
         xml.cac :TaxScheme do
           xml.cbc :ID, tax_scheme_id
         end
+
+        unless tax_exemption_reason_code.nil?
+          xml.cbc :TaxExemptionReasonCode, tax_exemption_reason_code
+          xml.cbc :TaxExemptionReason, tax_exemption_reason
+        end
       end
     end
   end

data/lib/xrechnung/version.rb

@@ -1,3 +1,3 @@
 module Xrechnung
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end

data/lib/xrechnung.rb

@@ -21,6 +21,7 @@ require "xrechnung/allowance_charge"
 require "xrechnung/price"
 require "xrechnung/invoice_line"
 require "xrechnung/invoice_document_reference"
+require "xrechnung/invoice_period"
 require "builder"
 
 module Xrechnung
@@ -168,6 +169,10 @@ module Xrechnung
     #   @return [Xrechnung::InvoiceDocumentReference]
     member :billing_reference, type: Xrechnung::InvoiceDocumentReference, optional: true
 
+    # @!attribute invoice_period
+    #   @return [Xrechnung::InvoicePeriod]
+    member :invoice_period, type: Xrechnung::InvoicePeriod, optional: true
+
     # Contract reference BT-12
     #
     # Eine eindeutige Bezeichnung des Vertrages (z. B. Vertragsnummer).
@@ -250,7 +255,7 @@ module Xrechnung
         "xmlns:cbc"          => "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2",
         "xmlns:xsi"          => "http://www.w3.org/2001/XMLSchema-instance",
         "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" do
-        xml.cbc :CustomizationID, "urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.0"
+        xml.cbc :CustomizationID, "urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.3"
         xml.cbc :ID, id
         xml.cbc :IssueDate, issue_date
         xml.cbc :DueDate, due_date
@@ -260,19 +265,23 @@ module Xrechnung
           xml.cbc :Note, note
         end
 
-        xml.cbc :TaxPointDate, tax_point_date
+        xml.cbc :TaxPointDate, tax_point_date unless tax_point_date.nil?
         xml.cbc :DocumentCurrencyCode, document_currency_code
         xml.cbc :TaxCurrencyCode, tax_currency_code
         xml.cbc :BuyerReference, buyer_reference
 
+        unless self.class.members[:invoice_period].optional && invoice_period.nil?
+          invoice_period&.to_xml(xml)
+        end
+
         xml.cac :OrderReference do
           xml.cbc :ID, purchase_order_reference
-          unless members[:sales_order_reference][:optional] && sales_order_reference.nil?
+          unless self.class.members[:sales_order_reference].optional && sales_order_reference.nil?
             xml.cbc :SalesOrderID, sales_order_reference
           end
         end
 
-        unless members[:billing_reference][:optional] && billing_reference.nil?
+        unless self.class.members[:billing_reference].optional && billing_reference.nil?
           xml.cac :BillingReference do
             billing_reference&.to_xml(xml)
           end
@@ -294,7 +303,7 @@ module Xrechnung
           accounting_customer_party&.to_xml(xml)
         end
 
-        unless members[:tax_representative_party][:optional] && tax_representative_party.nil?
+        unless self.class.members[:tax_representative_party].optional && tax_representative_party.nil?
           xml.cac :TaxRepresentativeParty do
             tax_representative_party&.to_xml(xml)
           end

data/xrechnung.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "builder", "~> 3.2"
 
-  spec.add_development_dependency "httparty"
+  spec.add_development_dependency "httparty", "~> 0.22"
   spec.add_development_dependency "rubyzip", "~> 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xrechnung
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Julian Kornberger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -28,16 +28,16 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -52,13 +52,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - jk+github@digineo.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".github/workflows/validate-fixtures.yml"
 - ".gitignore"
 - ".rspec"
@@ -78,6 +79,7 @@ files:
 - lib/xrechnung/id.rb
 - lib/xrechnung/invoice_document_reference.rb
 - lib/xrechnung/invoice_line.rb
+- lib/xrechnung/invoice_period.rb
 - lib/xrechnung/item.rb
 - lib/xrechnung/legal_monetary_total.rb
 - lib/xrechnung/member_container.rb
@@ -101,7 +103,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/digineo/xrechnung
   source_code_uri: https://github.com/digineo/xrechnung
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Library to create invoices in the XRechnung format.
 test_files: []