zipdatev 0.1.0

data/lib/zipdatev/validators/date_range_validator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "active_model"
+require "date"
+
+# Validates that a date is within the DATEV-allowed range.
+#
+# DATEV requires dates to be between 1753-01-01 and 9999-12-31.
+# This validator enforces that constraint.
+#
+# @example Validate date is in DATEV range
+#   validates :date, date_range: true
+#
+# @example Allow nil values
+#   validates :due_date, date_range: true, allow_nil: true
+class DateRangeValidator < ActiveModel::EachValidator
+  MIN_DATE = Date.new(1753, 1, 1)
+  MAX_DATE = Date.new(9999, 12, 31)
+
+  def validate_each(record, attribute, value)
+    return if value.nil?
+
+    unless value.is_a?(Date)
+      record.errors.add(attribute, options[:message] || "must be a valid date")
+      return
+    end
+
+    if value < MIN_DATE
+      record.errors.add(
+        attribute,
+        options[:message] || "must be on or after #{MIN_DATE}"
+      )
+    end
+
+    return unless value > MAX_DATE
+
+    record.errors.add(
+      attribute,
+      options[:message] || "must be on or before #{MAX_DATE}"
+    )
+  end
+end

data/lib/zipdatev/validators/decimal_precision_validator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "active_model"
+require "bigdecimal"
+
+# Validates that a decimal value has exactly the specified number of decimal places.
+#
+# DATEV requires specific precision for different field types:
+# - Amount fields: 2 decimal places
+# - Tax percentages: 2 decimal places
+# - Exchange rates: 6 decimal places
+# - Cost amounts: 4 decimal places
+#
+# @example Validate amount has 2 decimal places
+#   validates :amount, decimal_precision: { places: 2 }
+#
+# @example Allow nil values
+#   validates :tax, decimal_precision: { places: 2 }, allow_nil: true
+class DecimalPrecisionValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.nil?
+
+    places = options.fetch(:places, 2)
+
+    return if has_exact_decimal_places?(value, places)
+
+    record.errors.add(
+      attribute,
+      options[:message] || "must have exactly #{places} decimal places"
+    )
+  end
+
+  private
+
+  def has_exact_decimal_places?(value, places)
+    # Convert to BigDecimal for consistent handling
+    decimal = value.is_a?(BigDecimal) ? value : BigDecimal(value.to_s)
+
+    # Use string representation to check decimal places
+    # Format with many decimal places to avoid rounding
+    str = format("%.#{places + 10}f", decimal)
+    parts = str.split(".")
+
+    return places.zero? if parts.length == 1
+
+    # Get the decimal part
+    decimal_part = parts[1]
+
+    # Strip trailing zeros beyond the required places
+    significant_decimals = decimal_part.sub(/0+\z/, "")
+
+    # Check if the significant decimals fit within the required places
+    significant_decimals.length <= places
+  end
+end

data/lib/zipdatev/validators/discount_dates_validator.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+module ZipDatev
+  module Validators
+    # Validates the chronological ordering of discount-related dates.
+    #
+    # DATEV requires discount dates to be in a specific order:
+    # 1. invoice date < discount_payment_date
+    # 2. discount_payment_date < discount_payment_date_2
+    # 3. discount_payment_date_2 < due_date
+    #
+    # Also validates that delivery_date is not after invoice date.
+    #
+    # @example Apply to Invoice or LineItem
+    #   validates_with ZipDatev::Validators::DiscountDatesValidator
+    class DiscountDatesValidator < ActiveModel::Validator
+      def validate(record)
+        validate_delivery_date(record)
+        validate_dates_after_invoice(record)
+        validate_discount_ordering(record)
+        validate_due_date_ordering(record)
+      end
+
+      private
+
+      def validate_delivery_date(record)
+        return unless record.date && record.delivery_date
+        return unless record.delivery_date > record.date
+
+        record.errors.add(:delivery_date, "must not be after invoice date")
+      end
+
+      def validate_dates_after_invoice(record)
+        invoice_date = record.date
+        return unless invoice_date
+
+        validate_date_after_invoice(record, :discount_payment_date, invoice_date)
+        validate_date_after_invoice(record, :discount_payment_date_2, invoice_date)
+        validate_date_after_invoice(record, :due_date, invoice_date)
+      end
+
+      def validate_date_after_invoice(record, field, invoice_date)
+        date_value = record.public_send(field)
+        return unless date_value && date_value <= invoice_date
+
+        record.errors.add(field, "must be after invoice date")
+      end
+
+      def validate_discount_ordering(record)
+        discount_1 = record.discount_payment_date
+        discount_2 = record.discount_payment_date_2
+        return unless discount_1 && discount_2 && discount_1 >= discount_2
+
+        record.errors.add(:discount_payment_date_2, "must be after discount_payment_date")
+      end
+
+      def validate_due_date_ordering(record)
+        due_date = record.due_date
+        return unless due_date
+
+        discount_2 = record.discount_payment_date_2
+        discount_1 = record.discount_payment_date
+
+        if discount_2 && discount_2 >= due_date
+          record.errors.add(:due_date, "must be after discount_payment_date_2")
+        elsif discount_1 && !discount_2 && discount_1 >= due_date
+          record.errors.add(:due_date, "must be after discount_payment_date")
+        end
+      end
+    end
+  end
+end

data/lib/zipdatev/validators/payment_conditions_validator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+module ZipDatev
+  module Validators
+    # Validates that payment_conditions_id and manual discount fields are mutually exclusive.
+    #
+    # DATEV rule: If payment_conditions_id is set, no manual discount fields are allowed.
+    # The manual discount fields include:
+    # - discount_amount
+    # - discount_percentage
+    # - discount_payment_date
+    # - discount_amount_2
+    # - discount_percentage_2
+    # - discount_payment_date_2
+    # - due_date
+    #
+    # @example Apply to Invoice or LineItem
+    #   validates_with PaymentConditionsValidator
+    class PaymentConditionsValidator < ActiveModel::Validator
+      DISCOUNT_FIELDS = %i[
+        discount_amount
+        discount_percentage
+        discount_payment_date
+        discount_amount_2
+        discount_percentage_2
+        discount_payment_date_2
+        due_date
+      ].freeze
+
+      def validate(record)
+        return unless record.payment_conditions_id
+
+        present_discount_fields = DISCOUNT_FIELDS.select do |field|
+          record.public_send(field).present?
+        end
+
+        return if present_discount_fields.empty?
+
+        record.errors.add(
+          :payment_conditions_id,
+          "cannot be combined with manual discount fields " \
+          "(#{present_discount_fields.join(", ")})"
+        )
+      end
+    end
+  end
+end

data/lib/zipdatev/version.rb

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

data/lib/zipdatev.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "zipdatev/version"
+require_relative "zipdatev/errors"
+require_relative "zipdatev/constants"
+require_relative "zipdatev/validators/decimal_precision_validator"
+require_relative "zipdatev/validators/date_range_validator"
+require_relative "zipdatev/validators/discount_dates_validator"
+require_relative "zipdatev/validators/payment_conditions_validator"
+require_relative "zipdatev/validators/consolidation_validator"
+require_relative "zipdatev/line_item"
+require_relative "zipdatev/invoice"
+require_relative "zipdatev/document"
+require_relative "zipdatev/repository"
+require_relative "zipdatev/package"
+require_relative "zipdatev/generators/base"
+require_relative "zipdatev/generators/ledger_xml"
+require_relative "zipdatev/generators/document_xml"
+require_relative "zipdatev/schema_validator"
+
+# ZipDatev provides functionality for creating DATEV-compliant ZIP packages
+# for incoming invoices (Eingangsrechnungen). It generates XML files according
+# to the DATEV Belegverwaltung online interface specification (version 6.0).
+#
+# @example Creating a simple package
+#   package = ZipDatev.create_package(
+#     generator_info: "MyCompany",
+#     generating_system: "MyApp"
+#   )
+#
+#   invoice = ZipDatev::Invoice.new(
+#     date: Date.today,
+#     amount: 1190.00,
+#     currency_code: "EUR",
+#     invoice_id: "INV-001"
+#   )
+#
+#   package.add_document(invoice: invoice, attachments: ["invoice.pdf"])
+#   package.build("output.zip")
+#
+module ZipDatev
+  class << self
+    # Create a new package with the given configuration.
+    #
+    # @param generator_info [String] Generator information (company name)
+    # @param generating_system [String] System identifier
+    # @return [Package] A new package instance
+    def create_package(generator_info:, generating_system:)
+      Package.new(
+        generator_info: generator_info,
+        generating_system: generating_system
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: zipdatev
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dexter Team
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: A Ruby gem for creating DATEV-compliant ZIP packages for incoming invoices.
+  Generates document.xml and ledger XML files per DATEV XML interface v6.0.
+email:
+- team@getdexter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/zipdatev.rb
+- lib/zipdatev/constants.rb
+- lib/zipdatev/document.rb
+- lib/zipdatev/errors.rb
+- lib/zipdatev/generators/base.rb
+- lib/zipdatev/generators/document_xml.rb
+- lib/zipdatev/generators/ledger_xml.rb
+- lib/zipdatev/invoice.rb
+- lib/zipdatev/line_item.rb
+- lib/zipdatev/package.rb
+- lib/zipdatev/repository.rb
+- lib/zipdatev/schema_validator.rb
+- lib/zipdatev/schemas/Belegverwaltung_online_ledger_import_v060.xsd
+- lib/zipdatev/schemas/Belegverwaltung_online_ledger_types_v060.xsd
+- lib/zipdatev/schemas/Document_types_v060.xsd
+- lib/zipdatev/schemas/Document_v060.xsd
+- lib/zipdatev/validators/consolidation_validator.rb
+- lib/zipdatev/validators/date_range_validator.rb
+- lib/zipdatev/validators/decimal_precision_validator.rb
+- lib/zipdatev/validators/discount_dates_validator.rb
+- lib/zipdatev/validators/payment_conditions_validator.rb
+- lib/zipdatev/version.rb
+homepage: https://github.com/getdexter/zipdatev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/getdexter/zipdatev
+  source_code_uri: https://github.com/getdexter/zipdatev
+  changelog_uri: https://github.com/getdexter/zipdatev/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Generate DATEV-compliant ZIP packages for incoming invoices
+test_files: []