relaton-render 0.1.0 → 3.0.0.pre.alpha.25

data/lib/relaton/render/iso690/template.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      # A citation template as declared in a style instance: literal text
+      # interleaved with {{slot}} placeholders resolved against the ISO 690
+      # data element inventory. A leading literal attaches to the first
+      # slot, and a literal between two slots to the preceding one, so an
+      # absent field never orphans punctuation around it. The last rendered
+      # slot gives up its trailing literal in favour of the template
+      # terminator, appended once when any field rendered and the output
+      # does not already end with it.
+      class Template
+        SLOT = /\{\{\s*([\w-]+)\s*\}\}/.freeze
+
+        Field = Struct.new(:present?, :text)
+
+        def initialize(source)
+          @chunks = []
+          @terminator = ""
+          scan(source.to_s)
+        end
+
+        # The short cite renders the reference with the first-biblio
+        # marker appended to its first component: isodoc's styled
+        # references (eref2linkshort) split there (the 1.x
+        # fmt-first-biblio-delim)
+        def evaluate_short(fields, delim)
+          present = present_indices(fields)
+          return "" if present.empty?
+
+          # The split marker follows the leading run of present slots
+          # (the 1.x first SEGMENT: "{{creator}}{{role}}" splits after
+          # the role), before the first literal that follows it
+          lead_slots = []
+          @chunks.each_with_index do |(kind, _value), i|
+            break if kind != :slot || !present.include?(i)
+
+            lead_slots << i
+          end
+          split_at = lead_slots.last ? lead_slots.last + 1 : nil
+
+          out = +""
+          @chunks.each_with_index do |(kind, value), i|
+            text =
+              case kind
+              when :slot
+                field = fields[normalise(value)]
+                next unless field&.present?
+
+                field.text
+              else
+                next unless bridged?(i, present)
+
+                value
+              end
+            if split_at == i
+              out << fieldless(lead_slots, fields) if false
+              out << delim.to_s
+              split_at = nil
+            end
+            out << text unless text.nil?
+          end
+          out << delim.to_s if split_at == @chunks.length
+          terminate(out).rstrip
+        end
+
+        # 1.x segment-join semantics: present elements joined with the
+        # template's separators — a literal renders only when it
+        # separates (a run of absent elements between) two present
+        # elements; leading and trailing literals drop with the
+        # elements they would have attached to
+        def evaluate(fields)
+          present = present_indices(fields)
+          return "" if present.empty?
+
+          out = +"".dup
+          # Parenthetical groups balance on the template's literal
+          # parens alone: data text (a series run "(N.S.)", a host
+          # creator's closing paren) carries parens of its own that
+          # are no part of the template's group structure
+          paren_balance = 0
+          @chunks.each_with_index do |(kind, value), i|
+            if kind == :slot
+              field = fields[normalise(value)]
+              out << field.text if field&.present?
+            elsif value.to_s.match?(/\A[）)]/)
+              # Symmetric close: with no pending open the close-paren
+              # drops, and any trailing punctuation bridges normally
+              closes = value.to_s[/\A[）)]+/]
+              emitted = [paren_balance, closes.size].min
+              if emitted.positive?
+                out << closes[0, emitted] +
+                  value.to_s[closes.size..].to_s
+                paren_balance -= emitted
+              else
+                rest = value.to_s.sub(/\A[）)]+/, "")
+                # the trailing separator of a dropped group bridges as
+                # though the group were never there
+                if !rest.empty? && present.any? { |j| j > i } &&
+                   group_gap?(i, present)
+                  out << rest
+                end
+              end
+            elsif value.to_s.match?(/[（(]\z/)
+              # A literal opening a parenthetical group ("({{series}})",
+              # "。（{{series}}）") attaches its paren to the slot it
+              # opens — the pair drops with an absent element, while
+              # any leading punctuation bridges normally
+              lead, paren = value.to_s.match(/\A(.*)([（(])\z/).captures
+              out << lead if bridged_text?(i, lead, present)
+              if present.include?(i + 1)
+                out << paren
+                paren_balance += 1
+              end
+            elsif bridged?(i, present) ||
+                  (value.include?("<") && present.any? { |j| j < i })
+              # markup attaches to the element it closes
+              out << value
+            elsif close_pending_paren?(out, value)
+              out << value
+            end
+          end
+          terminate(out).rstrip
+        end
+
+        private
+
+        def scan(source)
+          rest = source
+          while (slot = SLOT.match(rest))
+            @chunks << [:text, rest[0...slot.begin(0)]] if
+              slot.begin(0).positive?
+            @chunks << [:slot, slot[1]]
+            rest = rest[slot.end(0)..]
+          end
+          @terminator = rest
+        end
+
+        def present_indices(fields)
+          @chunks.each_index.select do |i|
+            kind, value = @chunks[i]
+            next false unless kind == :slot
+
+            field = fields[normalise(value)]
+            !field.nil? && field.present?
+          end
+        end
+
+        # The texts between this close and the last present slot are
+        # all parenthetical-group parts (each dropped or partial)
+        def group_gap?(index, present)
+          left = present.select { |i| i < index }.max
+          @chunks[(left + 1)...index].all? do |(_, text)|
+            text.to_s.match?(/\A[）)]|[（(]\z/)
+          end
+        end
+
+        # The leading punctuation of a paren-opening literal bridges
+        # per the segment-join rule (a bare paren has no lead)
+        def bridged_text?(index, lead, present)
+          return true if lead.empty?
+
+          first_slot = @chunks.index { |(kind, _)| kind == :slot }
+          return present.include?(first_slot) if index < first_slot
+
+          left = present.select { |i| i < index }.max
+          left && present.any? { |i| i > index } &&
+            !@chunks[(left + 1)...index].any? do |(kind, _)|
+              kind == :text
+            end
+        end
+
+        # A literal is the trailing separator of the element that
+        # precedes it: it renders when that element renders and a
+        # later element renders, and it is the FIRST literal of its
+        # gap (the 1.x segment join — absent elements between two
+        # present ones leave the single separator that follows the
+        # earlier present element; an absent slot directly before a
+        # present one, as "{{date}}{{disambiguator}}, {{access}}",
+        # does not swallow it). A leading literal (no slot precedes
+        # it) attaches to the first slot, emitting only when that
+        # slot is present.
+        def bridged?(index, present)
+          first_slot = @chunks.index { |(kind, _)| kind == :slot }
+          return present.include?(first_slot) if index < first_slot
+
+          left = present.select { |i| i < index }.max
+          left && present.any? { |i| i > index } &&
+            !@chunks[(left + 1)...index].any? do |(kind, _)|
+              kind == :text
+            end
+        end
+
+        # A template's paired literal ("({{production}})") closes even
+        # when nothing follows the present element it wraps. Fullwidth
+        # parens (CJK) pair the same way
+        def close_pending_paren?(out, value)
+          return false unless value.start_with?(")", "\uFF09")
+
+          opens = out.count("(") + out.count("\uFF08")
+          closes = out.count(")") + out.count("\uFF09")
+          opens > closes
+        end
+
+        def terminate(body)
+          # 1.x punctuation cleanup: a sentence period before a spaced
+          # comma yields to the comma (", 2013" over ". , 2013"; an
+          # initials period before a comma ("P.,") stands, being
+          # unspaced), and stacked separators around absent elements
+          # collapse into one (". : ." into ". "); an empty pair left
+          # by an absent element drops
+          body = body.gsub(/:\s*\.\s*/, ": ")
+          body = body.gsub(/\.\s+,/, ",")
+          body = body.gsub(/(?:[.,:;]\s+)+[.,:;]/, ". ")
+          body = body.gsub(/\.\s*\./, ". ")
+          body = body.gsub(/:\s*\.\s*/, ": ")
+          body = body.gsub(/\(\s*\)/, "")
+          body = body.gsub(/ +/, " ").gsub(" ,", ",")
+          terminator = unbalanced_close(body, @terminator)
+          return body if terminator.strip.empty?
+          if terminator !~ /[<\w]/ && body.rstrip.end_with?(terminator.strip)
+            return body
+          end
+
+          "#{body}#{terminator}"
+        end
+
+        # The terminator's closing parens stand only when the body
+        # opened them (their "(" died with an absent element)
+        def unbalanced_close(body, terminator)
+          return terminator unless terminator.start_with?(")")
+
+          open = body.count("(") - body.count(")")
+          return terminator.sub(/\A\)+/) { |closes| closes[0, open] } if
+            open.positive?
+
+          terminator.sub(/\A\)+/, "")
+        end
+
+        def normalise(slot)
+          slot.to_s.delete("_").downcase
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    # Citation rendering per the ISO 690 architecture: a style instance
+    # places the inventory's data elements (clause 7) in each resource
+    # kind's order (clause 8); the engine is a template evaluator over a
+    # field resolver and holds no styles, no vocabularies, no i18n.
+    # The v1 compatibility facade (relaton-render#90): isodoc's
+    # render-isodoc subclasses Relaton::Render::General.
+    autoload :General, "relaton/render/general"
+
+    module Iso690
+      autoload :Element, "relaton/render/iso690/element"
+      autoload :Elements, "relaton/render/iso690/elements"
+      autoload :Fields, "relaton/render/iso690/fields"
+      autoload :I18n, "relaton/render/iso690/i18n"
+      autoload :IndexRenderer, "relaton/render/iso690/index_renderer"
+      autoload :IdentifierKinds, "relaton/render/iso690/identifier_kinds"
+      autoload :Kinds, "relaton/render/iso690/kinds"
+      autoload :Renderer, "relaton/render/iso690/renderer"
+      autoload :Style, "relaton/render/iso690/style"
+      autoload :Template, "relaton/render/iso690/template"
+    end
+  end
+end

data/lib/relaton/render/version.rb

@@ -0,0 +1,5 @@
+module Relaton
+  module Render
+    VERSION = "3.0.0.pre.alpha.25".freeze
+  end
+end

data/lib/relaton-render.rb

@@ -1,6 +1,13 @@
-require "relaton/version"
-require "relaton/render"
-require "parse/parse"
-require "template/template"
-require "isodoc/i18n"
+# frozen_string_literal: true
 
+require "relaton/render/version"
+require "relaton/render/iso690"
+
+module Relaton
+  module Render
+    # A bibliographic item whose style template resolves to nothing: the
+    # single-item API raises, the batch API skips
+    class Unrenderable < StandardError; end
+
+  end
+end

data/relaton-render.gemspec

@@ -1,6 +1,6 @@
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "relaton/version"
+require "relaton/render/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "relaton-render"
@@ -19,17 +19,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "debug"
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov"
-
-  spec.add_dependency "isodoc-i18n"
-  spec.add_dependency "liquid", "~> 4"
+  spec.add_dependency "htmlentities"
+  spec.add_development_dependency "relaton-bib"
+  spec.add_dependency "liquid", "~> 5"
+  spec.add_dependency "lutaml-model"
   spec.add_dependency "nokogiri"
   spec.add_dependency "twitter_cldr"
+  # spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: relaton-render
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 3.0.0.pre.alpha.25
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2026-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debug
+  name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,63 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: isodoc-i18n
+  name: lutaml-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: liquid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +102,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
 - ".hound.yml"
 - ".rubocop.yml"
 - Gemfile
@@ -167,25 +113,50 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
-- lib/isodoc-yaml/i18n-ar.yaml
-- lib/isodoc-yaml/i18n-de.yaml
-- lib/isodoc-yaml/i18n-en.yaml
-- lib/isodoc-yaml/i18n-es.yaml
-- lib/isodoc-yaml/i18n-fr.yaml
-- lib/isodoc-yaml/i18n-ru.yaml
-- lib/isodoc-yaml/i18n-zh-Hans.yaml
-- lib/isodoc/i18n.rb
-- lib/parse/parse.rb
-- lib/parse/parse_contributors.rb
-- lib/parse/parse_extract.rb
+- docs/citation-style-pack.adoc
 - lib/relaton-render.rb
-- lib/relaton/config.yml
-- lib/relaton/render.rb
-- lib/relaton/render_classes.rb
-- lib/relaton/render_fields.rb
-- lib/relaton/version.rb
-- lib/template/template.rb
-- lib/utils/utils.rb
+- lib/relaton/render/general.rb
+- lib/relaton/render/iso690.rb
+- lib/relaton/render/iso690/element.rb
+- lib/relaton/render/iso690/elements.rb
+- lib/relaton/render/iso690/elements/access.rb
+- lib/relaton/render/iso690/elements/authorizer.rb
+- lib/relaton/render/iso690/elements/citeid.rb
+- lib/relaton/render/iso690/elements/component_part.rb
+- lib/relaton/render/iso690/elements/creator.rb
+- lib/relaton/render/iso690/elements/edition.rb
+- lib/relaton/render/iso690/elements/extent.rb
+- lib/relaton/render/iso690/elements/identifier.rb
+- lib/relaton/render/iso690/elements/location.rb
+- lib/relaton/render/iso690/elements/medium.rb
+- lib/relaton/render/iso690/elements/numeration.rb
+- lib/relaton/render/iso690/elements/production.rb
+- lib/relaton/render/iso690/elements/pub_date.rb
+- lib/relaton/render/iso690/elements/series.rb
+- lib/relaton/render/iso690/elements/size.rb
+- lib/relaton/render/iso690/elements/status.rb
+- lib/relaton/render/iso690/elements/stddoc.rb
+- lib/relaton/render/iso690/elements/title.rb
+- lib/relaton/render/iso690/elements/updated.rb
+- lib/relaton/render/iso690/fields.rb
+- lib/relaton/render/iso690/i18n.rb
+- lib/relaton/render/iso690/i18n/en.yml
+- lib/relaton/render/iso690/i18n/fr.yml
+- lib/relaton/render/iso690/i18n/ja.yml
+- lib/relaton/render/iso690/identifier_kinds.rb
+- lib/relaton/render/iso690/index_renderer.rb
+- lib/relaton/render/iso690/kinds.rb
+- lib/relaton/render/iso690/renderer.rb
+- lib/relaton/render/iso690/style.rb
+- lib/relaton/render/iso690/style/locale.rb
+- lib/relaton/render/iso690/style/name_form.rb
+- lib/relaton/render/iso690/style/scheme.rb
+- lib/relaton/render/iso690/style/sort_rule.rb
+- lib/relaton/render/iso690/style/template_map.rb
+- lib/relaton/render/iso690/style/type_template.rb
+- lib/relaton/render/iso690/styles/author-date.yml
+- lib/relaton/render/iso690/template.rb
+- lib/relaton/render/version.rb
 - relaton-render.gemspec
 homepage: https://github.com/relaton/relaton-render
 licenses:
@@ -199,14 +170,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Rendering of ISO 690 XML

data/lib/isodoc/i18n.rb

@@ -1,24 +0,0 @@
-require "yaml"
-require "isodoc-i18n"
-
-module IsoDoc
-  class I18n
-    def load_yaml1(lang, script)
-      case lang
-      when "en", "fr", "ru", "de", "es", "ar"
-        load_yaml2(lang)
-      when "zh"
-        if script == "Hans" then load_yaml2("zh-Hans")
-        else load_yaml2("en")
-        end
-      else
-        load_yaml2("en")
-      end
-    end
-
-    def load_yaml2(str)
-      YAML.load_file(File.join(File.dirname(__FILE__),
-                               "../isodoc-yaml/i18n-#{str}.yaml"))
-    end
-  end
-end

data/lib/isodoc-yaml/i18n-ar.yaml

@@ -1,2 +0,0 @@
-in:  في
-at: في

data/lib/isodoc-yaml/i18n-de.yaml

@@ -1,2 +0,0 @@
-in: in
-at: bei

data/lib/isodoc-yaml/i18n-en.yaml

@@ -1,22 +0,0 @@
-in: in
-at: at
-and: and
-updated: updated
-viewed: viewed
-version: version
-date:
-  month_year: to_long_s
-  day_month_year: to_long_s
-  date_time: to_long_s
-edition_number: ["OrdinalRules", "digits-ordinal"]
-edition: "% edition"
-editor:
-  sg: ed.
-  pl: eds.
-extent:
-  page:
-    sg: p.
-    pl: pp.
-  volume:
-    sg: vol.
-    pl: vols.

data/lib/isodoc-yaml/i18n-es.yaml

@@ -1,2 +0,0 @@
-in: en
-at: en

data/lib/isodoc-yaml/i18n-fr.yaml

@@ -1,2 +0,0 @@
-in: dans
-at: à

data/lib/isodoc-yaml/i18n-ru.yaml

@@ -1,23 +0,0 @@
-in: в
-at: в
-and: и
-updated: обновлен
-viewed: просмотрено
-version: версия
-date:
-  month_year: to_long_s
-  day_month_year: to_long_s
-  date_time: to_long_s
-edition_number: ["SpelloutRules", "spellout-ordinal-neuter"]
-edition: "% издание"
-editor:
-  sg: изд.
-  pl: изд.
-extent:
-  page:
-    sg: стр.
-    pl: стр.
-  volume:
-    sg: т.
-    pl: тт.
-

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -1,2 +0,0 @@
-in: 在
-at: 在