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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecdbfb0b1c82700b6c957c9eeb259fd48f48d391a35062b07e4d6d6ede4ccb2e
-  data.tar.gz: 199330b061ce3e07eb3edff0364ffc313773eb27cf6f7b8d0a216bff4caa3cac
+  metadata.gz: e2d52f05f42c17071799e1cc19e71d0b84f84a0550430d287e4d8cf4dee389a6
+  data.tar.gz: 4170319d650b7d3de48553d5fcddb15857b24939e9a6e008d7f74c095f849f60
 SHA512:
-  metadata.gz: f21d46a60631252c2011e73096ea2ff321fae8f8f361c9e8bc46b53709d304da350bac73ab3eb44cdf7c5a4ec6a35c74f10875aa5548e417fc9c66afc43a8693
-  data.tar.gz: 2fac8549403467928c30917f75e167fba771a3f175c5128d9c2a1daab37cb813cd29b1feb493746559c985df068b68306d9cdd2cd1cb5fb63b82e0e79445a150
+  metadata.gz: 021e4859ac3ba1f2dda762db881d1322677578359dc0f9a7c319435d7692a36fb6dcc1b96b9b068ca3ed65f9a621648da698962e49d2d2b132adbf5ea2ee66ff
+  data.tar.gz: ad7e119b111cac93e1c70fd0af76431a33dc9e95a5508ca866ab556c7b7e3484e7ae31c1981778f2a86ad6c35ba5ecfdfee9799b2a8c1e21480184f81915bc98

data/docs/citation-style-pack.adoc

@@ -320,7 +320,10 @@ instances (never ad-hoc hash merges):
 * `perType`, `types`: merge **per type key** — a delta's `article`
   entry overlays the base's; the base's other entries survive.
 * `labels`, `punct`, `fallbacks`: per-key merge.
-* `nameForm` knobs, `templates.*`, rule selections: replace.
+* `nameForm` knobs, `templates.*`, rule selections: replace — with
+  the caveat that a knob left at its model default counts as unset and
+  inherits (a Lutaml model cannot distinguish an explicit default from
+  an absent key).
 * `sortKey`, `requires`: union.
 
 The forcing test: PLATEAU's four near-copy styles (document-language

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

@@ -24,8 +24,8 @@ module Relaton
 
         def initialize(style: DEFAULT_STYLE, lang: "en", script: "Latn",
                        labels: {}, elements: {})
-          @elements = elements
           @style = Style.load(style)
+          @elements = Rules.resolve(@style.rules, elements)
           @i18n = I18n.load(lang)
           @i18n.overlay_hash!(labels) unless labels.empty?
           # The style instance is the citation-style authority: its

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      # The named-rule registry: presentation-of-models implementations
+      # the engine ships once, addressable from pack data as
+      # rules: { slot: rule_name }. Flavors migrate their ELEMENTS maps
+      # onto registered rules; nothing references a flavor class.
+      module Rules
+        REGISTRY = {}
+
+        class << self
+          def register(name, klass)
+            REGISTRY[name.to_s] = klass
+          end
+
+          # A pack's rule selections become the renderer's element map;
+          # caller-supplied elements win over the pack's selections
+          def resolve(rules, elements = {})
+            Array(rules).to_h { |slot, name| [slot.to_sym, fetch(name)] }
+              .merge(elements || {})
+          end
+
+          private
+
+          def fetch(name)
+            REGISTRY.fetch(name.to_s) do
+              raise ArgumentError, "unknown citation style rule #{name}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,6 +19,21 @@ module Relaton
         autoload :TypeTemplate, "relaton/render/iso690/style/type_template"
 
         attribute :name, :string
+        # The citation-style family the pack belongs to (iso690 | lncs |
+        # chicago | ieee-sa | apa): selects the presentation-of-models
+        # conventions the templates address
+        attribute :family, :string, default: "iso690"
+        # A named pack this one deltas over; resolved at load with the
+        # documented merge semantics (#merge_delta)
+        attribute :extends, :string
+        # Engine capabilities the pack addresses; a resolver that lacks
+        # one fails loudly instead of mis-rendering
+        attribute :requires, :string, collection: true, default: []
+        # Pack-declared taxonomy: wire type -> kind (aliasing or
+        # fallthrough), consulted before the engine's Kinds table
+        attribute :types, :hash, default: -> { {} }
+        # Presentation-of-models selections: slot -> named engine rule
+        attribute :rules, :hash, default: -> { {} }
         attribute :scheme, Scheme, default: -> { Scheme.new }
         attribute :templates, TemplateMap, default: -> { TemplateMap.new }
         attribute :per_type, TypeTemplate, collection: true, default: []
@@ -26,6 +41,11 @@ module Relaton
 
         key_value do
           map "name", to: :name
+          map "family", to: :family
+          map "extends", to: :extends
+          map "requires", to: :requires
+          map "types", to: :types
+          map "rules", to: :rules
           map "scheme", to: :scheme
           map "templates", to: :templates
           map "perType", to: :per_type
@@ -44,6 +64,12 @@ module Relaton
         # the style's declared kind for types the vocabulary does not
         # map (a flavor whose untyped items are not reports)
         def kind_for(type)
+          declared_type = types[type.to_s]
+          unless declared_type.to_s.empty?
+            return Kinds.mapped?(declared_type) ? Kinds.kind_for(declared_type) :
+              declared_type
+          end
+
           return Kinds.kind_for(type) if Kinds.mapped?(type)
 
           declared = scheme.default_kind.to_s
@@ -97,11 +123,88 @@ module Relaton
           )
         end
 
+        # The documented delta merge: perType entries merge per type
+        # key (a delta re-declaring `article` never drops the base's
+        # `monograph`); hash sections merge per key; scalars, templates
+        # and rule selections replace; sortKey and requires union.
+        # Deterministic and engine-portable.
+        def merge_delta(base)
+          merged_per_type = base.per_type.dup
+          per_type.each do |delta|
+            index = merged_per_type.find_index do |b|
+              b.type == delta.type && (b.home || false) == (delta.home || false)
+            end
+            index ? merged_per_type[index] = delta : merged_per_type << delta
+          end
+          self.per_type = merged_per_type
+          self.types = base.types.merge(types)
+          self.rules = base.rules.merge(rules)
+          merge_scheme(base)
+          merge_templates(base)
+          self.sort_key = (base.sort_key + sort_key).uniq
+          self.requires = (base.requires + requires).uniq
+          self
+        end
+
+        private
+
+        def merge_scheme(base)
+          fresh = NameForm.new
+          NameForm.attributes.each_key do |attr|
+            val = scheme.name_form.send(attr)
+            next unless val == fresh.send(attr)
+
+            base_val = base.scheme.name_form.send(attr)
+            scheme.name_form.send("#{attr}=", base_val) if
+              base_val != fresh.send(attr)
+          end
+
+          scheme.system = base.scheme.system if scheme.system.to_s.empty?
+          scheme.short_from_reference = base.scheme.short_from_reference unless
+            scheme.short_from_reference
+          scheme.home_docid_type = base.scheme.home_docid_type if
+            Array(scheme.home_docid_type).empty?
+          scheme.default_kind = base.scheme.default_kind if
+            scheme.default_kind.to_s.empty?
+
+          locale = scheme.locale
+          base_locale = base.scheme.locale
+          locale.conj ||= base_locale.conj
+          locale.others ||= base_locale.others
+          locale.no_date ||= base_locale.no_date
+          locale.no_author ||= base_locale.no_author
+          locale.in_str ||= base_locale.in_str
+          locale.at ||= base_locale.at
+          locale.available_at ||= base_locale.available_at
+          locale.labels.merge!(base_locale.label_map) { |_k, _b, d| d }
+          locale.punct = (base_locale.punct || {}).merge(locale.punct || {})
+        end
+
+        def merge_templates(base)
+          fresh = TemplateMap.new
+          TemplateMap.attributes.each_key do |attr|
+            val = templates.send(attr)
+            base_val = base.templates.send(attr)
+            next unless val == fresh.send(attr) && base_val != fresh.send(attr)
+
+            templates.send("#{attr}=", base_val)
+          end
+        end
+
         class << self
-          def load(name_or_path)
+          def load(name_or_path, seen = [])
             path = style_path(name_or_path) or
               raise ArgumentError, "unknown style #{name_or_path}"
-            from_yaml(File.read(path))
+            style = from_yaml(File.read(path))
+            return style if style.extends.to_s.empty?
+
+            style.extends.split(/\s+/).each do |base_name|
+              raise ArgumentError,
+                    "circular extends #{base_name}" if seen.include?(base_name)
+
+              style.merge_delta(load(base_name, seen + [base_name]))
+            end
+            style
           end
 
           private

data/lib/relaton/render/iso690/styles/apa.yml

@@ -0,0 +1,45 @@
+# American Psychological Association (7th ed.) reference forms: all
+# author names invert with initials ("Author, A. B."), the date
+# follows the authors in parentheses, article titles take no marks
+# (sentence case is the author's), and only book titles and journal
+# names carry italics. The reference list joins with a comma and ampersand.
+name: "APA (7th edition) references"
+family: apa
+scheme:
+  system: name-date
+  nameForm:
+    initials: true
+    initialsSeparator: " "
+    initialsPeriod: true
+    invertedAll: true
+    givenNameFirst: false
+    editorsMarked: false
+    surnameUpcase: false
+    subsequentSurnameUpcase: false
+  locale:
+    "in": "In"
+    labels:
+      "and": "&"
+      oxford_comma: ","
+      oxford_comma: ","
+templates:
+  titleOpen: ""
+  titleClose: ""
+  citation: "{{surname}}, {{date}}"
+  reference: "{{creator}} ({{date}}). {{title}}. {{series}}. {{production}}. {{extent}}"
+  name: "{{surname}}, {{givenNames}}"
+  identifierMode: all
+perType:
+  - type: report
+    home: true
+    template: "{{title}}"
+  - type: report
+    template: "{{identifier}}. {{title}}. {{production}}."
+  - type: monograph
+    title: "<em>{{title}}</em>"
+    template: "{{creator}} ({{date}}). {{title}}. {{production}}."
+  - type: component_part
+    template: "{{creator}} ({{date}}). {{title}}. {{componentpart}} ({{extent}}). {{production}}."
+  - type: continuing
+    series: "<em>{{seriestitle}}, {{serienumber}}</em>"
+    template: "{{creator}} ({{date}}). {{title}}. {{series}} {{extent}}. {{location}}"

data/lib/relaton/render/iso690/styles/chicago.yml

@@ -0,0 +1,48 @@
+# Chicago Manual of Style (17th ed.), bibliography forms: the notes
+# system's reference list. Only the first author name inverts ("Peck,
+# R. B., W. E. Hanson, and T. H. Thornburn"), article titles carry
+# quotation marks, book titles are set in italics, and production runs
+# "Place: Publisher".
+name: "Chicago Manual of Style (bibliography)"
+family: chicago
+requires:
+  - extent_units
+scheme:
+  system: name-date
+  nameForm:
+    initials: false
+    initialsSeparator: " "
+    initialsPeriod: true
+    invertedAll: false
+    givenNameFirst: false
+    editorsMarked: true
+    loneEditorMarked: true
+    surnameUpcase: false
+    subsequentSurnameUpcase: false
+  locale:
+    "in": "in"
+    labels:
+      "and": "and"
+      oxford_comma: ","
+      series_no: "no."
+templates:
+  titleOpen: "\""
+  titleClose: "\""
+  citation: "{{surname}}, {{date}}"
+  reference: "{{creator}}. {{title}}. {{edition}}. {{series}}. {{production}}, {{date}}. {{extent}}."
+  name: "{{surname}}, {{givenNames}}"
+  identifierMode: all
+perType:
+  - type: report
+    home: true
+    template: "{{title}}"
+  - type: report
+    template: "{{creator}}. {{title}}. {{edition}}. {{production}}, {{date}}."
+  - type: monograph
+    title: "<em>{{title}}</em>"
+    template: "{{creator}}. {{title}}. {{edition}}. {{production}}, {{date}}. {{extent}}."
+  - type: component_part
+    template: "{{creator}}. \"{{title}}.\" {{componentpart}}. {{production}}, {{date}}. {{extent}}."
+  - type: continuing
+    series: "<em>{{seriestitle}}</em>"
+    template: "{{creator}}. \"{{title}}.\" {{series}} {{extent}} ({{date}}). {{location}}"

data/lib/relaton/render/iso690/styles/ieee-sa.yml

@@ -0,0 +1,45 @@
+# IEEE-SA Standards Style Manual bibliography forms (clause 17): a
+# standard's entry is its designation and title, nothing else - no
+# authors, no publisher, no place; articles and books follow the
+# Chicago-derived forms, with only the first author name inverting and
+# the in-text citation carrying the designation and the [B#] number.
+name: "IEEE-SA standards bibliography"
+family: ieee-sa
+scheme:
+  system: designation
+  nameForm:
+    initials: true
+    initialsSeparator: " "
+    initialsPeriod: true
+    invertedAll: false
+    givenNameFirst: false
+    editorsMarked: false
+    surnameUpcase: false
+    subsequentSurnameUpcase: false
+  locale:
+    labels:
+      "and": "and"
+      oxford_comma: ","
+templates:
+  titleOpen: ""
+  titleClose: ""
+  citation: "{{identifier}}"
+  reference: "{{creator}}, {{title}}. {{series}}. {{extent}}. {{date}}."
+  name: "{{surname}}, {{givenNames}}"
+  identifierMode: first
+perType:
+  - type: report
+    home: true
+    template: "{{title}}"
+  - type: report
+    template: "{{identifier}}, {{title}}"
+  - type: monograph
+    title: "<em>{{title}}</em>"
+    template: "{{creator}}, {{title}}, {{edition}}. {{production}}, {{date}}, {{extent}}."
+  - type: component_part
+    title: "\"{{title}},\""
+    template: "{{creator}}, {{title}} {{componentpart}}, {{extent}}, {{date}}."
+  - type: continuing
+    title: "\"{{title}},\""
+    series: "<em>{{seriestitle}}</em>"
+    template: "{{creator}}, {{title}} {{series}}, {{extent}}, {{date}}."

data/lib/relaton/render/iso690/styles/lncs.yml

@@ -0,0 +1,54 @@
+# Springer LNCS citation style, an instance of the relaton-models
+# CitationStyle model. The LNCS shape: "Author, A.B.: Title. In:
+# Editor, E. (ed.), Proceedings. LNCS 1234, pp. 10-20. Springer,
+# Heidelberg (2010)" - the creator list closes on a colon, the year
+# closes the entry in parentheses, publishers precede places, and a
+# standard with no personal authors leads with the publisher's
+# abbreviation.
+name: "Springer LNCS"
+family: lncs
+requires:
+  - production_order
+  - extent_units
+scheme:
+  system: name-date
+  nameForm:
+    initials: true
+    initialsSeparator: ""
+    initialsPeriod: true
+    invertedAll: true
+    givenNameFirst: false
+    editorsMarked: true
+    loneEditorMarked: true
+    creatorFallback: publisher_abbrev
+    surnameUpcase: false
+    subsequentSurnameUpcase: false
+  locale:
+    "in": "In"
+    availableAt: ""
+    labels:
+      "and": ""
+      oxford_comma: ""
+      series_no: ""
+    punct:
+      production_order: publisher_first
+      production_sep: ", "
+templates:
+  titleOpen: ""
+  titleClose: ""
+  citation: "{{surname}}, {{date}}"
+  reference: "{{creator}}: {{title}}. {{series}}. {{production}} {{dategroup}}. {{location}}"
+  name: "{{surname}}, {{givenNames}}"
+  identifierMode: first
+perType:
+  - type: report
+    home: true
+    template: "{{title}}"
+  - type: report
+    template: "{{creator}}: {{identifier}}, {{title}}. {{production}} {{dategroup}}."
+  - type: monograph
+    template: "{{creator}}: {{title}}. {{series}} {{production}} {{dategroup}}"
+  - type: component_part
+    template: "{{creator}}: {{title}}. {{componentpart}} {{extent}} {{production}} {{dategroup}}"
+  - type: continuing
+    template: "{{creator}}: {{title}}. {{series}} {{extent}} {{dategroup}}"

data/lib/relaton/render/iso690.rb

@@ -19,6 +19,7 @@ module Relaton
       autoload :IdentifierKinds, "relaton/render/iso690/identifier_kinds"
       autoload :Kinds, "relaton/render/iso690/kinds"
       autoload :Renderer, "relaton/render/iso690/renderer"
+        autoload :Rules, "relaton/render/iso690/rules"
       autoload :Style, "relaton/render/iso690/style"
       autoload :Template, "relaton/render/iso690/template"
     end

data/lib/relaton/render/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relaton-render
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.alpha.25
+  version: 3.0.0.pre.alpha.26
 platform: ruby
 authors:
 - Ribose Inc.
@@ -147,6 +147,7 @@ files:
 - lib/relaton/render/iso690/index_renderer.rb
 - lib/relaton/render/iso690/kinds.rb
 - lib/relaton/render/iso690/renderer.rb
+- lib/relaton/render/iso690/rules.rb
 - lib/relaton/render/iso690/style.rb
 - lib/relaton/render/iso690/style/locale.rb
 - lib/relaton/render/iso690/style/name_form.rb
@@ -154,7 +155,11 @@ files:
 - 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/apa.yml
 - lib/relaton/render/iso690/styles/author-date.yml
+- lib/relaton/render/iso690/styles/chicago.yml
+- lib/relaton/render/iso690/styles/ieee-sa.yml
+- lib/relaton/render/iso690/styles/lncs.yml
 - lib/relaton/render/iso690/template.rb
 - lib/relaton/render/version.rb
 - relaton-render.gemspec