xml_laborabrechnungsdaten 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41b9e7d17b5ec659b793af6c9ea49ba9c618772382f29ef69a624c364bfe5122
+  data.tar.gz: 33f498a934edce0ee79095cefe442f9a9ac8df5b7f24e1046acec18b2e8d68d8
+SHA512:
+  metadata.gz: bea3aa8536de5573e90148f45434d5053ae139e6c313d6cfd0e868abc38b3e3e4c0c636dbb1f3d33a7fa9a48e2b504512f96ce0b47d49c613444ce7bd49935e0
+  data.tar.gz: 3cb6b16977b4f10e47b293fa5101b9d979e3eed4496e1c88080de5e67861b97f60a8599eecb1a2f8fd2bee506a06c5e79a3794b85e920935b0dbe6682f4e1aa9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    xml_laborabrechnungsdaten (0.1.0)
+      builder (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.3.0)
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.6.1)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.4)
+      date
+      stringio
+    rake (13.2.1)
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.3)
+    stringio (3.1.7)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  debug (>= 1.0.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  xml_laborabrechnungsdaten!
+
+BUNDLED WITH
+   2.5.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 florian2
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# XML Laborabrechnungsdaten
+
+This gem is a ruby implementation of the XML interface for data exchange between dental laboratories and dental practices. It's use for patients with public health insurance has been part of dental billing since January 1, 2012. The interface is maintained and further developed in cooperation between the KZBV, the VDZI, and the VDDS. The goal of their collaboration is to ensure stable and effective processes in dental laboratories and dental practices. 
+
+This gem and or the author are in no way associated with VDDS, KZBV or VDZI.
+
+For more information see https://www.vdds.de/schnittstellen/labor/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xml_laborabrechnungsdaten'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install xml_laborabrechnungsdaten
+
+## Usage
+
+See rspec test case for a usage example.
+
+## 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 the created tag, 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/florian2/xml_laborabrechnungsdaten
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "xml_laborabrechnungsdaten"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xml_laborabrechnungsdaten/member_container.rb

@@ -0,0 +1,68 @@
+module XmlLaborabrechnungsdaten
+  module MemberContainer
+    def self.included(base)
+      base.instance_variable_set :@members, {}
+      base.extend ClassMethods
+    end
+
+    def initialize(**kwargs)
+      self.class.after_initialize.each do |block|
+        instance_eval(&block)
+      end
+
+      kwargs.each do |k, v|
+        self[k] = v
+      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)
+    end
+
+    module ClassMethods
+      # @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)
+        attr_reader member_name
+        setter_name           = :"#{member_name}="
+        @members[member_name] = { optional: optional, setter_name: setter_name }
+
+        if default
+          after_initialize do
+            send(setter_name, default)
+          end
+        end
+
+        define_method setter_name do |in_value|
+          in_value = transform_value.call(in_value) if 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}"
+          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/xml_laborabrechnungsdaten/mwst_gruppe.rb

@@ -0,0 +1,47 @@
+module XmlLaborabrechnungsdaten
+  class MwstGruppe
+    include MemberContainer
+
+    # @!attribute zwischensumme_netto
+    #   @return [String] Net subtotal amount
+    member :zwischensumme_netto, type: String
+
+    # @!attribute mehrwertsteuersatz
+    #   @return [String] VAT rate
+    member :mehrwertsteuersatz, type: String
+
+    # @!attribute mehrwertsteuerbetrag
+    #   @return [String] VAT amount
+    member :mehrwertsteuerbetrag, type: String
+
+    # @!attribute positionen
+    #   @return [Array<Position>] List of positions in this VAT group
+    member :positionen, type: Array, default: []
+
+    # Adds a position to the VAT group
+    # @param position [Position] Position to add
+    # @return [Array<Position>] Updated list of positions
+    def add_position(position)
+      positionen << position
+      positionen
+    end
+
+    # Generates XML representation of the VAT group
+    # @param xml [Builder::XmlMarkup] XML builder instance
+    # @return [void]
+    def to_xml(xml)
+      attributes = {
+        Zwischensumme_netto: zwischensumme_netto,
+        Mehrwertsteuersatz: mehrwertsteuersatz,
+        Mehrwertsteuerbetrag: mehrwertsteuerbetrag
+      }.compact # Removes nil values
+
+      xml.tag!(:"MWST-Gruppe", attributes) do
+        # Add all positions as child elements
+        positionen.each do |position|
+          position.to_xml(xml)
+        end
+      end
+    end
+  end
+end

data/lib/xml_laborabrechnungsdaten/position.rb

@@ -0,0 +1,40 @@
+module XmlLaborabrechnungsdaten
+  class Position
+    include MemberContainer
+
+    # @!attribute art
+    #   @return [String] Type of the position (e.g., "BEL")
+    member :art, type: String
+
+    # @!attribute nummer
+    #   @return [String] Number/identifier of the position
+    member :nummer, type: String
+
+    # @!attribute beschreibung
+    #   @return [String] Description of the position
+    member :beschreibung, type: String
+
+    # @!attribute einzelpreis
+    #   @return [String] Unit price
+    member :einzelpreis, type: String
+
+    # @!attribute menge
+    #   @return [String] Quantity
+    member :menge, type: String
+
+    # Generates XML representation of the position
+    # @param xml [Builder::XmlMarkup] XML builder instance
+    # @return [void]
+    def to_xml(xml)
+      attributes = {
+        Art: art,
+        Nummer: nummer,
+        Beschreibung: beschreibung,
+        Einzelpreis: einzelpreis,
+        Menge: menge
+      }.compact # Removes nil values
+
+      xml.Position(attributes)
+    end
+  end
+end

data/lib/xml_laborabrechnungsdaten/rechnung.rb

@@ -0,0 +1,98 @@
+module XmlLaborabrechnungsdaten
+  class Rechnung
+    include MemberContainer
+
+    # @!attribute laborname
+    #   @return [String]
+    member :laborname, type: String
+
+    # @!attribute labor_id
+    #   @return [String]
+    member :labor_id, type: String
+
+    # @!attribute herstellungsort
+    #   @return [String]
+    member :herstellungsort, type: String
+
+    # @!attribute abrechnungsbereich
+    #   @return [String]
+    member :abrechnungsbereich, type: String
+
+    # @!attribute laborlieferdatum
+    #   @return [String]
+    member :laborlieferdatum, type: String
+
+    # @!attribute laborrechnungsnummer
+    #   @return [String]
+    member :laborrechnungsnummer, type: String
+
+    # @!attribute auftragsnummer
+    #   @return [String]
+    member :auftragsnummer, type: String
+
+    # @!attribute gesamtbetrag_netto
+    #   @return [String]
+    member :gesamtbetrag_netto, type: String
+
+    # @!attribute mehrwertsteuer_gesamt
+    #   @return [String]
+    member :mehrwertsteuer_gesamt, type: String
+
+    # @!attribute gesamtbetrag_brutto
+    #   @return [String]
+    member :gesamtbetrag_brutto, type: String
+
+    # @!attribute laborsoftwarehersteller
+    #   @return [String]
+    member :laborsoftwarehersteller, type: String
+
+    # @!attribute laborsoftware
+    #   @return [String]
+    member :laborsoftware, type: String
+
+    # @!attribute laborsoftwareversion
+    #   @return [String]
+    member :laborsoftwareversion, type: String
+
+    # @!attribute mwst_gruppen
+    #   @return [Array<MwstGruppe>] List of VAT groups in this invoice
+    member :mwst_gruppen, type: Array, default: []
+
+    # Adds a VAT group to the invoice
+    # @param mwst_gruppe [MwstGruppe] VAT group to add
+    # @return [Array<MwstGruppe>] Updated list of VAT groups
+    def add_mwst_gruppe(mwst_gruppe)
+      @mwst_gruppen ||= []
+      @mwst_gruppen << mwst_gruppe
+      @mwst_gruppen
+    end
+
+    # Generates XML representation of the invoice
+    # @param xml [Builder::XmlMarkup] XML builder instance
+    # @return [void]
+    def to_xml(xml)
+      attributes = {
+        Laborsoftwarehersteller: laborsoftwarehersteller,
+        Laborsoftware: laborsoftware,
+        Laborsoftwareversion: laborsoftwareversion,
+        Laborname: laborname,
+        "Labor-ID": labor_id,
+        Herstellungsort: herstellungsort,
+        Abrechnungsbereich: abrechnungsbereich,
+        Laborlieferdatum: laborlieferdatum,
+        Laborrechnungsnummer: laborrechnungsnummer,
+        Auftragsnummer: auftragsnummer,
+        Gesamtbetrag_netto: gesamtbetrag_netto,
+        Mehrwertsteuer_gesamt: mehrwertsteuer_gesamt,
+        Gesamtbetrag_brutto: gesamtbetrag_brutto
+      }.compact # Removes nil values
+
+      xml.Rechnung(attributes) do
+        # Add all VAT groups as child elements
+        mwst_gruppen.each do |mwst_gruppe|
+          mwst_gruppe.to_xml(xml)
+        end
+      end
+    end
+  end
+end

data/lib/xml_laborabrechnungsdaten/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module XmlLaborabrechnungsdaten
+  VERSION = "0.1.0"
+end

data/lib/xml_laborabrechnungsdaten.rb

@@ -0,0 +1,43 @@
+require_relative "xml_laborabrechnungsdaten/version"
+require_relative "xml_laborabrechnungsdaten/member_container"
+require_relative "xml_laborabrechnungsdaten/rechnung"
+require_relative "xml_laborabrechnungsdaten/mwst_gruppe"
+require_relative "xml_laborabrechnungsdaten/position"
+require "builder"
+
+module XmlLaborabrechnungsdaten
+  class Error < StandardError; end
+
+  class Document
+    include MemberContainer
+
+    # @!attribute version
+    #   @return [String] Version of the XML schema
+    member :version, type: String, default: "4.5"
+
+    # @!attribute rechnung
+    #   @return [Rechnung] The invoice details
+    member :rechnung, type: Rechnung
+
+    # Generates the complete XML document
+    # @param indent [Integer] Indentation level for pretty printing
+    # @param target [String, IO] The output target
+    # @return [String] The generated XML
+    def to_xml(indent: 2, target: "")
+      xml = Builder::XmlMarkup.new(indent: indent, target: target)
+      xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
+
+      # Root element with namespaces and schema location
+      xml.Laborabrechnung(
+        "xsi:noNamespaceSchemaLocation" => "Laborabrechnungsdaten_(KZBV-VDZI-VDDS)_(V4-5).xsd",
+        "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+        "Version" => version
+      ) do
+        # Add the invoice if it exists
+        rechnung&.to_xml(xml)
+      end
+
+      target
+    end
+  end
+end

data/sig/vdds_laborabrechnungsdaten_xml.rbs

@@ -0,0 +1,4 @@
+module XmlLaborabrechnungsdaten
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/xml_laborabrechnungsdaten.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/xml_laborabrechnungsdaten/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "xml_laborabrechnungsdaten"
+  spec.version = XmlLaborabrechnungsdaten::VERSION
+  spec.authors = ["Florian Görsdorf"]
+  spec.email = ["florian.goersdorf@dentatool.de"]
+
+  spec.summary = "Library to create XML invoice representations of dental labs invoices following the german VDDS XML exchange standart between dental practices and dental labs"
+  spec.description = "A ruby gem to generate XML for invoice exchange between dental lab and dentist practices following the standard from VDDS, KZBV and VDZI."
+  spec.homepage = "https://github.com/florian2/xml_laborabrechnungsdaten"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "builder", "~> 3.2"
+  spec.add_development_dependency "debug", ">= 1.0.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: xml_laborabrechnungsdaten
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florian Görsdorf
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A ruby gem to generate XML for invoice exchange between dental lab and
+  dentist practices following the standard from VDDS, KZBV and VDZI.
+email:
+- florian.goersdorf@dentatool.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xml_laborabrechnungsdaten.rb
+- lib/xml_laborabrechnungsdaten/member_container.rb
+- lib/xml_laborabrechnungsdaten/mwst_gruppe.rb
+- lib/xml_laborabrechnungsdaten/position.rb
+- lib/xml_laborabrechnungsdaten/rechnung.rb
+- lib/xml_laborabrechnungsdaten/version.rb
+- sig/vdds_laborabrechnungsdaten_xml.rbs
+- xml_laborabrechnungsdaten.gemspec
+homepage: https://github.com/florian2/xml_laborabrechnungsdaten
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/florian2/xml_laborabrechnungsdaten
+  source_code_uri: https://github.com/florian2/xml_laborabrechnungsdaten
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Library to create XML invoice representations of dental labs invoices following
+  the german VDDS XML exchange standart between dental practices and dental labs
+test_files: []