dcc 0.2.0 → 0.2.2

data/lib/dcc.rb

@@ -41,6 +41,7 @@ module Dcc
   autoload :QuantityFormat, "dcc/quantity_format"
   autoload :QuantityMath, "dcc/quantity_math"
   autoload :Signature, "dcc/signature"
+  autoload :Streaming, "dcc/streaming"
   autoload :Transform, "dcc/transform"
   autoload :Validate, "dcc/validate"
   autoload :Server, "dcc/server"
@@ -74,16 +75,63 @@ module Dcc
     # Build a new DCC programmatically using the builder DSL.
     # @yield [Dcc::Builder::Session] builder session
     # @param version [Integer, nil] major DCC version (default: 3).
-    def build(version: 3, &block)
-      Builder.call(version: version, &block)
+    def build(version: 3, &)
+      Builder.call(version: version, &)
     end
 
-    # Migrate a parsed DCC object from one schema version to another.
-    # @param dcc [Dcc::V2::DigitalCalibrationCertificate, Dcc::V3::DigitalCalibrationCertificate]
+    # Load plugin gems by name.
+    #
+    # A gem name maps to its entry file the usual way: "dcc-audit" loads
+    # "dcc/audit". A slash-separated path is accepted unchanged.
+    #
+    # @param names [Array<String, Symbol>] plugin gem names.
+    # @raise [Dcc::PluginError] if a plugin's entry file cannot be loaded.
+    # @return [Array<String>] the entry-file path for each name given.
+    #   A plugin already loaded is left alone and its path still returned.
+    #
+    # A plugin whose own `require` fails raises from inside a file we did
+    # find. Reporting that as a missing entry file points the author at the
+    # wrong problem, so only the entry path's own LoadError is wrapped.
+    def load_plugins(*names)
+      names.flatten.map do |name|
+        path = plugin_path(name)
+        require path
+        path
+      rescue ::LoadError => e
+        raise unless e.path == path
+
+        raise PluginError, "could not load plugin #{name}: tried " \
+                           "require #{path.inspect} (#{e.message})"
+      end
+    end
+
+    # "dcc-audit" is a gem name and maps to "dcc/audit". Anything already
+    # carrying a slash is a require path and is left alone, hyphens included.
+    def plugin_path(name)
+      text = name.to_s
+      text.include?("/") ? text : text.tr("-", "/")
+    end
+    private :plugin_path
+
+    # Migrate a DCC from one schema version to another.
+    #
+    # Prefer passing the source XML. A parsed model has to be serialized back
+    # to XML before the transform runs, so anything the model could not
+    # round-trip is already gone and cannot be migrated or reported.
+    #
+    # @param input [String, IO, Dcc::V2::DigitalCalibrationCertificate,
+    #   Dcc::V3::DigitalCalibrationCertificate] DCC source XML, or a parsed DCC.
     # @param from [String] source version, e.g. "2.3.0".
     # @param to [String] target version, e.g. "3.3.0".
-    def migrate(dcc, from:, to:)
-      Migrate.call(dcc, from: from, to: to)
+    # @param on_loss [#call, nil] callable receiving each message describing a
+    #   construct the migration changed or discarded (a String per loss).
+    #   When given, the messages go to the callable and nothing is sent to
+    #   `Kernel.warn`; when nil (the default), each loss report is warned to
+    #   stderr as before.
+    # @return [Dcc::V2::DigitalCalibrationCertificate,
+    #   Dcc::V3::DigitalCalibrationCertificate] always a parsed DCC.
+    def migrate(input, from:, to:, on_loss: nil)
+      Migrate.call(input, from: from, to: to, on_loss: on_loss)
     end
 
     # Return the parser module for the given major version.
@@ -94,7 +142,8 @@ module Dcc
       when 2 then V2
       when 3 then V3
       else
-        raise UnknownVersionError, "Unsupported DCC version: #{version.inspect} (expected 2 or 3)"
+        raise UnknownVersionError,
+              "Unsupported DCC version: #{version.inspect} (expected 2 or 3)"
       end
     end
 
@@ -103,9 +152,18 @@ module Dcc
     # @return [Integer] 2 or 3.
     def detect_version(input)
       str = read_input(input)
-      match = str.match(/schemaVersion\s*=\s*["'](\d+)\./)
-      major = match && match[1] ? match[1].to_i : 3
-      major == 2 ? 2 : 3
+      match = str.match(/schemaVersion\s*=\s*["'](\d+\.)/)
+      major_version_from(match && match[1])
+    end
+
+    # Map a `schemaVersion` attribute value to its major DCC version.
+    # Only a leading run of digits followed by a dot counts; anything else
+    # (missing, malformed, or an unsupported major) resolves to 3.
+    # @param schema_version [String, nil] e.g. "2.3.0".
+    # @return [Integer] 2 or 3.
+    def major_version_from(schema_version)
+      match = schema_version.to_s.match(/\A(\d+)\./)
+      match && match[1].to_i == 2 ? 2 : 3
     end
 
     # Read an input that may be a String or an IO-like object.

data/sample_dcc.xml

@@ -0,0 +1,140 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<dcc:digitalCalibrationCertificate
+    xmlns:dcc="https://ptb.de/dcc"
+    xmlns:si="https://ptb.de/si"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://ptb.de/dcc https://ptb.de/dcc/v3.3.0/dcc.xsd"
+    schemaVersion="3.3.0">
+
+  <dcc:administrativeData>
+    <dcc:dccSoftware>
+      <dcc:software>
+        <dcc:name><dcc:content lang="en">DCC Validator Builder</dcc:content></dcc:name>
+        <dcc:release>0.1.0</dcc:release>
+      </dcc:software>
+    </dcc:dccSoftware>
+
+    <dcc:coreData>
+      <dcc:countryCodeISO3166_1>DE</dcc:countryCodeISO3166_1>
+      <dcc:usedLangCodeISO639_1>en</dcc:usedLangCodeISO639_1>
+      <dcc:usedLangCodeISO639_1>de</dcc:usedLangCodeISO639_1>
+      <dcc:mandatoryLangCodeISO639_1>en</dcc:mandatoryLangCodeISO639_1>
+      <dcc:uniqueIdentifier>PTB-A0123-2026</dcc:uniqueIdentifier>
+      <dcc:beginPerformanceDate>2026-07-23</dcc:beginPerformanceDate>
+      <dcc:endPerformanceDate>2026-07-23</dcc:endPerformanceDate>
+    </dcc:coreData>
+
+    <dcc:items>
+      <dcc:item>
+        <dcc:name><dcc:content lang="en">Precision Resistance Decade 10 kΩ</dcc:content></dcc:name>
+        <dcc:manufacturer><dcc:name><dcc:content lang="en">Burster Präzisionsmesstechnik GmbH</dcc:content></dcc:name></dcc:manufacturer>
+        <dcc:model>BURSTER 1424</dcc:model>
+      </dcc:item>
+    </dcc:items>
+
+    <dcc:calibrationLaboratory>
+      <dcc:calibrationLaboratoryCode>DE1</dcc:calibrationLaboratoryCode>
+      <dcc:contact>
+        <dcc:name><dcc:content lang="en">Physikalisch-Technische Bundesanstalt</dcc:content></dcc:name>
+        <dcc:eMail>calibration@ptb.de</dcc:eMail>
+      </dcc:contact>
+    </dcc:calibrationLaboratory>
+
+    <dcc:respPersons>
+      <dcc:respPerson>
+        <dcc:person>
+          <dcc:name><dcc:content lang="en">Dr. Klaus-Dieter Sommer</dcc:content></dcc:name>
+          <dcc:eMail>k.sommer@ptb.de</dcc:eMail>
+        </dcc:person>
+        <dcc:mainSigner>true</dcc:mainSigner>
+      </dcc:respPerson>
+    </dcc:respPersons>
+
+    <dcc:customer>
+      <dcc:name><dcc:content lang="en">Burster Präzisionsmesstechnik GmbH</dcc:content></dcc:name>
+    </dcc:customer>
+  </dcc:administrativeData>
+
+  <dcc:measurementResults>
+    <dcc:measurementResult>
+      <dcc:name><dcc:content lang="en">Calibration Results</dcc:content></dcc:name>
+      <dcc:results>
+        <dcc:result>
+          <dcc:name><dcc:content lang="en">Resistance calibration at 1 kΩ</dcc:content></dcc:name>
+          <dcc:data>
+          <dcc:quantity>
+            <dcc:name><dcc:content lang="en">Actual resistance</dcc:content></dcc:name>
+            <si:real>
+              <si:value>999.982</si:value>
+              <si:unit>\ohm</si:unit>
+                  <si:expandedMU>
+                    <si:valueExpandedMU>0.012</si:valueExpandedMU>
+                    <si:coverageFactor>2</si:coverageFactor>
+                    <si:coverageProbability>0.95</si:coverageProbability>
+                  </si:expandedMU>
+            </si:real>
+          </dcc:quantity>
+          <dcc:quantity>
+            <dcc:name><dcc:content lang="en">Temperature coefficient</dcc:content></dcc:name>
+            <si:real>
+              <si:value>5.2e-6</si:value>
+              <si:unit>\per\kelvin</si:unit>
+                  <si:expandedMU>
+                    <si:valueExpandedMU>0.3e-6</si:valueExpandedMU>
+                    <si:coverageFactor>2</si:coverageFactor>
+                    <si:coverageProbability>0.95</si:coverageProbability>
+                  </si:expandedMU>
+            </si:real>
+          </dcc:quantity>
+          </dcc:data>
+        </dcc:result>
+        <dcc:result>
+          <dcc:name><dcc:content lang="en">Resistance calibration at 10 kΩ</dcc:content></dcc:name>
+          <dcc:data>
+          <dcc:quantity>
+            <dcc:name><dcc:content lang="en">Actual resistance</dcc:content></dcc:name>
+            <si:real>
+              <si:value>10000.04</si:value>
+              <si:unit>\kilo\ohm</si:unit>
+                  <si:expandedMU>
+                    <si:valueExpandedMU>0.03</si:valueExpandedMU>
+                    <si:coverageFactor>2</si:coverageFactor>
+                    <si:coverageProbability>0.95</si:coverageProbability>
+                  </si:expandedMU>
+            </si:real>
+          </dcc:quantity>
+          </dcc:data>
+        </dcc:result>
+        <dcc:result>
+          <dcc:name><dcc:content lang="en">Environmental conditions</dcc:content></dcc:name>
+          <dcc:data>
+          <dcc:quantity>
+            <dcc:name><dcc:content lang="en">Ambient temperature</dcc:content></dcc:name>
+            <si:real>
+              <si:value>23.0</si:value>
+              <si:unit>\degreeCelsius</si:unit>
+                  <si:expandedMU>
+                    <si:valueExpandedMU>0.2</si:valueExpandedMU>
+                    <si:coverageFactor>2</si:coverageFactor>
+                    <si:coverageProbability>0.95</si:coverageProbability>
+                  </si:expandedMU>
+            </si:real>
+          </dcc:quantity>
+          <dcc:quantity>
+            <dcc:name><dcc:content lang="en">Relative humidity</dcc:content></dcc:name>
+            <si:real>
+              <si:value>48</si:value>
+              <si:unit>\percent</si:unit>
+                  <si:expandedMU>
+                    <si:valueExpandedMU>2</si:valueExpandedMU>
+                    <si:coverageFactor>2</si:coverageFactor>
+                    <si:coverageProbability>0.95</si:coverageProbability>
+                  </si:expandedMU>
+            </si:real>
+          </dcc:quantity>
+          </dcc:data>
+        </dcc:result>
+      </dcc:results>
+    </dcc:measurementResult>
+  </dcc:measurementResults>
+</dcc:digitalCalibrationCertificate>

data/web/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8" />
+<meta name="viewport" content="width=device-width,initial-scale=1.0" />
+<title>DCC Validator</title>
+</head>
+<body>
+<div id="app"></div>
+<script type="module" src="/src/main.ts"></script>
+</body>
+</html>