idml 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6cd95e24b0c6610673ad2c95308314a391471fa3912d28a660b8381d46f7b81
-  data.tar.gz: f33fdd9480345a9de8f8fa0e60536b87423978a09732031ab7a4587b99fae59e
+  metadata.gz: d7defde95ef6dc98c93c16a27f09b93c17aaea161a6878b1b130b58b3d8ba9cd
+  data.tar.gz: 603a52445ffcb85e2e384e097d74810a302b045aecfaf4937af10d763c076c2d
 SHA512:
-  metadata.gz: 26f80da839299b0fad35c4380511bca3c91d61aabb29c8699f82a50ee7f7a02d5a9ae314643d596a5e0847f91dcbd7782da2bf73892004995578f8d129c52521
-  data.tar.gz: d416cb234f968d95ed9a5f23fecf7ddbe19a171986e58a98f8eee1483a09db4588496a674bfbcfe52be077c2c8c117978b35314ff335e5498e6cc70367dc11de
+  metadata.gz: da8441f49894dcce6656d429357421ee101c59061738e73527b9dc574d8905adf68b8a2fb78a5cc6bd5a4b67d2f4774893d96c9608ea7e6b91d945a1189b8e20
+  data.tar.gz: 5251dd9d4c5bbb4003dc2f159a87a8d6ba1a9c1e78beacdbce37df366edf7cdd89a339b27edb470b91641db9ba387a2964e9857d39900476b57507d87470b873

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    idml (0.4.0)
+    idml (0.4.1)
       bigdecimal
       lutaml-model (~> 0.8.18)
       pdfrb
@@ -11,7 +11,7 @@ PATH
 PATH
   remote: /Users/mulgogi/src/claricle/pdfrb
   specs:
-    pdfrb (0.5.0)
+    pdfrb (0.6.0)
       thor
 
 GEM
@@ -183,7 +183,7 @@ CHECKSUMS
   ffi (1.17.4-x86_64-darwin) sha256=aa70390523cf3235096cf64962b709b4cfbd5c082a2cb2ae714eb0fe2ccda496
   ffi (1.17.4-x86_64-linux-gnu) sha256=9d3db14c2eae074b382fa9c083fe95aec6e0a1451da249eab096c34002bc752d
   ffi (1.17.4-x86_64-linux-musl) sha256=3fdf9888483de005f8ef8d1cf2d3b20d86626af206cbf780f6a6a12439a9c49e
-  idml (0.4.0)
+  idml (0.4.1)
   json (2.21.2) sha256=1f1d3b7cf2b3ba1a69beca0bb6db13d5438b80bff3cd54cdaaa620b9b07c1c6a
   language_server-protocol (3.17.0.6) sha256=5ef2c0c138f8267e1bc631d3328347d354f96724b0af22f2c79516120443b7f0
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
@@ -203,7 +203,7 @@ CHECKSUMS
   paint (2.3.0) sha256=327d623e4038619d5bd99ae5db07973859cd78400c7f0329eea283cef8e83be5
   parallel (2.1.0) sha256=b35258865c2e31134c5ecb708beaaf6772adf9d5efae28e93e99260877b09356
   parser (3.3.12.0) sha256=21a6d7f755d5a24dfbdc6e6b772e4e879a52e7631a88bc5a3a134606052c9828
-  pdfrb (0.5.0)
+  pdfrb (0.6.0)
   prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
   racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
   rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a

data/TODO.pdf/83-pipeline-decomposition.md

@@ -0,0 +1,38 @@
+# TODO PDF 83: Pipeline decomposition
+
+## Status: DONE
+
+## What was done
+
+Extracted metadata assembly from `Pipeline` into a dedicated
+`Render::MetadataBuilder` class. Pipeline now calls
+`MetadataBuilder.new(@package).build` instead of inlining the XMP
+parsing, date conversion, and defaults logic.
+
+## Why
+
+Pipeline had five private methods dedicated to metadata
+(`combined_metadata`, `xmp_metadata`, `default_metadata`,
+`pdf_date_string`, `pdf_date`). Each was a single responsibility
+unrelated to the pipeline's core orchestration role. Moving them
+into a focused class:
+
+- Shrinks Pipeline by ~55 lines.
+- Makes MetadataBuilder independently testable.
+- Makes Pipeline's intent clearer: orchestrate, not parse.
+- Lets future metadata sources (e.g., IDML document properties,
+custom user metadata) plug in without touching Pipeline.
+
+## Verification
+
+- `lib/idml/render/metadata_builder.rb` — extracted class.
+- `lib/idml/render/pipeline.rb:25` — single-call usage.
+- `spec/idml/render/metadata_builder_spec.rb` — 5 specs covering
+  defaults, XMP extraction, and the no-XMP fallback.
+
+## Acceptance criteria
+
+- [x] MetadataBuilder extracted as a separate class.
+- [x] Pipeline no longer contains XMP/date helpers.
+- [x] Existing pipeline specs still pass.
+- [x] MetadataBuilder has dedicated specs.

data/lib/idml/elements/character_style_range.rb

@@ -296,6 +296,8 @@ module Idml
       attribute :character_style_range, Idml::Elements::CharacterStyleRange,
                 collection: true
       attribute :content, Idml::Elements::Content, collection: true
+      attribute :hyperlink_text_source, Idml::Elements::HyperlinkTextSource,
+                collection: true
       attribute :xml_element, Idml::Elements::XmlElement, collection: true
 
       xml do
@@ -649,6 +651,7 @@ module Idml
         map_attribute "UpperLevel", to: :upper_level
         map_element "CharacterStyleRange", to: :character_style_range
         map_element "Content", to: :content
+        map_element "HyperlinkTextSource", to: :hyperlink_text_source
         map_element "XMLElement", to: :xml_element
       end
 

data/lib/idml/elements/hyperlink_text_source.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Idml
+  module Elements
+    # `<HyperlinkTextSource>` — source anchor of a hyperlink in a
+    # story. Per `HyperlinkTextSource_Object` in
+    # `reference-docs/schemas/package/Stories/Story.rnc`. The `Self`
+    # attribute is referenced by `<Hyperlink Source="...">` in the
+    # document designmap.
+    #
+    # Note on text range: IDML's HyperlinkTextSource wraps the
+    # character content it covers (it is a sibling of `<Content>`
+    # inside a `<CharacterStyleRange>`). The wrapper's position in
+    # the story flow determines the range — there is no explicit
+    # `StartIndex`/`EndIndex` on the element itself.
+    class HyperlinkTextSource < Lutaml::Model::Serializable
+      attribute :self_attr, :string
+      attribute :name, :string
+      attribute :hidden, :boolean
+      attribute :applied_character_style, :string
+
+      xml do
+        root "HyperlinkTextSource"
+        map_attribute "Self", to: :self_attr
+        map_attribute "Name", to: :name
+        map_attribute "Hidden", to: :hidden
+        map_attribute "AppliedCharacterStyle", to: :applied_character_style
+      end
+    end
+  end
+end

data/lib/idml/elements.rb

@@ -64,6 +64,8 @@ module Idml
     autoload :Hyperlink, "idml/elements/hyperlink"
     autoload :HyperlinkPageDestination,
              "idml/elements/hyperlink_page_destination"
+    autoload :HyperlinkTextSource,
+             "idml/elements/hyperlink_text_source"
     autoload :HyperlinkURLDestination,
              "idml/elements/hyperlink_url_destination"
     autoload :Image, "idml/elements/image"

data/lib/idml/render/hyperlink_emitter.rb

@@ -12,11 +12,12 @@ module Idml
     # the source's TextRange. Precise per-range rects require deeper
     # integration with the text engine — see TODO 78.
     class HyperlinkEmitter
-      def initialize(writer:, package:, page_height:)
+      def initialize(writer:, package:, page_height:, layer_filter: nil)
         @writer = writer
         @package = package
         @resolver = HyperlinkResolver.new(package)
         @page_height = page_height
+        @layer_filter = layer_filter
       end
 
       def emit_for(spread, page_index)
@@ -29,7 +30,10 @@ module Idml
 
       def each_text_frame_on(spread)
         spread.each_page_item do |item|
-          yield item if item.is_a?(Idml::Elements::TextFrame)
+          next unless item.is_a?(Idml::Elements::TextFrame)
+          next if @layer_filter && !@layer_filter.visible?(item)
+
+          yield item
         end
       end
 

data/lib/idml/render/metadata_builder.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "time"
+
+module Idml
+  module Render
+    # Builds the PDF Info-dict metadata hash by merging XMP-extracted
+    # values from `META-INF/metadata.xml` over sensible defaults.
+    # Extracted from `Pipeline` for SRP — Pipeline orchestrates
+    # rendering, this module owns metadata assembly.
+    class MetadataBuilder
+      XMP_PATH = "META-INF/metadata.xml"
+
+      def initialize(package)
+        @package = package
+      end
+
+      # Returns a hash with Producer/CreationDate defaults, overridden
+      # by any XMP-supplied fields (Title, Author, Subject, Keywords,
+      # Creator, CreationDate, ModDate). XMP dates are converted from
+      # ISO 8601 to PDF `D:YYYYMMDDHHmmss` format.
+      def build
+        defaults.merge(xmp_fields) { |_key, default, xmp| xmp || default }
+      end
+
+      private
+
+      def defaults
+        {
+          Producer: "idml gem v#{Idml::VERSION}",
+          CreationDate: pdf_date(Time.now.utc),
+        }
+      end
+
+      def xmp_fields
+        return {} unless xmp_packet
+
+        {
+          Title: xmp_packet.title,
+          Author: xmp_packet.author,
+          Subject: xmp_packet.description,
+          Keywords: xmp_packet.keywords,
+          Creator: xmp_packet.creator_tool,
+          CreationDate: pdf_date_string(xmp_packet.create_date),
+          ModDate: pdf_date_string(xmp_packet.modify_date),
+        }.compact
+      end
+
+      def xmp_packet
+        return nil unless @package.has_part?(XMP_PATH)
+
+        @xmp_packet ||= begin
+          xml = @package.read_part(XMP_PATH)
+          Parts::XmpMeta.from_xml(xml).rdf
+        rescue StandardError
+          nil
+        end
+      end
+
+      def pdf_date_string(iso8601)
+        return nil unless iso8601
+
+        pdf_date(Time.iso8601(iso8601))
+      rescue ArgumentError
+        nil
+      end
+
+      def pdf_date(time)
+        time.strftime("D:%Y%m%d%H%M%S+00'00'")
+      end
+    end
+  end
+end

data/lib/idml/render/pipeline.rb

@@ -21,7 +21,7 @@ module Idml
 
       def call
         writer = PdfrbWriter.new
-        metadata = combined_metadata
+        metadata = MetadataBuilder.new(@package).build
         writer.set_info(metadata)
         writer.enable_tagged if @tagged
         if pdfa_requested?
@@ -95,14 +95,16 @@ module Idml
                                           page_height: dims[:height],
                                           image_refs: image_refs,
                                           page_index: current)
-          emit_hyperlinks(writer, spread, current)
+          emit_hyperlinks(writer, spread, current, layer_filter)
         end
         current
       end
 
-      def emit_hyperlinks(writer, spread, page_index)
+      def emit_hyperlinks(writer, spread, page_index, layer_filter)
         HyperlinkEmitter.new(writer: writer, package: @package,
-                             page_height: DEFAULT_HEIGHT).emit_for(spread, page_index)
+                             page_height: DEFAULT_HEIGHT,
+                             layer_filter: layer_filter)
+          .emit_for(spread, page_index)
       rescue StandardError
         nil
       end
@@ -167,60 +169,6 @@ module Idml
         end
         nil
       end
-
-      def combined_metadata
-        defaults = default_metadata
-        xmp_metadata.each do |key, value|
-          next if value.nil? || value.empty?
-
-          defaults[key] = value
-        end
-        defaults
-      end
-
-      def xmp_metadata
-        return {} unless @package.has_part?(XMP_PATH)
-
-        xml = @package.read_part(XMP_PATH)
-        meta = Parts::XmpMeta.from_xml(xml)
-        rdf = meta.rdf
-        return {} unless rdf
-
-        {
-          Title: rdf.title,
-          Author: rdf.author,
-          Subject: rdf.description,
-          Keywords: rdf.keywords,
-          Creator: rdf.creator_tool,
-          CreationDate: pdf_date_string(rdf.create_date),
-          ModDate: pdf_date_string(rdf.modify_date),
-        }
-      rescue StandardError
-        {}
-      end
-
-      def pdf_date_string(iso8601)
-        return nil unless iso8601
-
-        time = Time.iso8601(iso8601)
-        pdf_date(time)
-      rescue ArgumentError
-        nil
-      end
-
-      def default_metadata
-        {
-          Producer: "idml gem v#{Idml::VERSION}",
-          CreationDate: pdf_date(Time.now.utc),
-        }
-      end
-
-      def pdf_date(time)
-        time.strftime("D:%Y%m%d%H%M%S+00'00'")
-      end
-
-      XMP_PATH = "META-INF/metadata.xml"
-      private_constant :XMP_PATH
     end
   end
 end

data/lib/idml/render.rb

@@ -23,6 +23,7 @@ module Idml
     autoload :BookmarkResolver,    "#{__dir__}/render/bookmark_resolver"
     autoload :HyperlinkResolver,   "#{__dir__}/render/hyperlink_resolver"
     autoload :HyperlinkEmitter,    "#{__dir__}/render/hyperlink_emitter"
+    autoload :MetadataBuilder,     "#{__dir__}/render/metadata_builder"
     autoload :StoryThreader,       "#{__dir__}/render/story_threader"
     autoload :PdfrbWriter, "#{__dir__}/render/pdfrb_writer"
     autoload :SpreadRenderer,      "#{__dir__}/render/spread_renderer"

data/lib/idml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Idml
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idml
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ribose
@@ -209,6 +209,7 @@ files:
 - TODO.pdf/80-paragraph-alignment.md
 - TODO.pdf/81-pdfa-icc-output-intent.md
 - TODO.pdf/82-table-cell-text.md
+- TODO.pdf/83-pipeline-decomposition.md
 - TODO.pdf/README.md
 - exe/idml
 - idml.gemspec
@@ -255,6 +256,7 @@ files:
 - lib/idml/elements/group.rb
 - lib/idml/elements/hyperlink.rb
 - lib/idml/elements/hyperlink_page_destination.rb
+- lib/idml/elements/hyperlink_text_source.rb
 - lib/idml/elements/hyperlink_url_destination.rb
 - lib/idml/elements/image.rb
 - lib/idml/elements/ink.rb
@@ -390,6 +392,7 @@ files:
 - lib/idml/render/image.rb
 - lib/idml/render/image_collector.rb
 - lib/idml/render/layer_filter.rb
+- lib/idml/render/metadata_builder.rb
 - lib/idml/render/page_item_renderer.rb
 - lib/idml/render/pdfa_packet.rb
 - lib/idml/render/pdfrb_writer.rb