relaton-render 3.0.0.pre.alpha.6 → 3.0.0.pre.alpha.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e6e4911053aee3915882fcee48c182f8bf0d1ca2c879e7201bb0d19cfd48e4b
-  data.tar.gz: 60b845d08886130df02eaef46bfe5811996f208aaab13093fb660221f5f50799
+  metadata.gz: 22dc4e39ee6744154270c700e9b80ff7e72e90929b19275e1705b4f0ab898d6b
+  data.tar.gz: 7f3482bab07cbcc5034ed2e282854caa0d87bcfae05a1185558ab1ec787cff78
 SHA512:
-  metadata.gz: 855419eacf8dc6f71a4c9eaef6b23341328bee50a1a59b0c2138d62420b3295d59176a83d3cac5c52a0c2cb989558ebced170badaf8732f04449fb5a5047cc6d
-  data.tar.gz: 38ace39e42d57252a8eb994cc4ec4a82ea56a5bd6476025db679b6b4a42c6c676b77908d6d076f06442e30768bb406104e284daed8e85dd73dfbb8f7c66aa7fc
+  metadata.gz: 7349c542f2a79dfb2328d9a285ec36feaebfbba45307314dd7524b00e5c7a464c4fe21ff9f12204d9c3e5ca9e739dfd781a0d6fb4c3d43bde70e2c57b6e4c121
+  data.tar.gz: 0c6c6dca299f1870afa8c38b752b4206185441a6315cf7cab2d6ab141b71fc6a4cd4f1e740001556166cab2282db9f8da975c3163fe2f08c1e97c1998e388599

data/lib/relaton/render/general.rb

@@ -62,16 +62,42 @@ module Relaton
             next
           end
           m[item.id] = {
-            id: item.id, ord: i, formattedref: ref,
-            citation: {
-              full: ref,
-              default: item.docidentifier.first&.content.to_s,
-              short: @renderer.citation(item),
-            },
+            id: item.id, ord: i,
+            formattedref: terminate_reference(ref),
+            citation: citation_renderings(item, ref),
           }
         end
       end
 
+      # isodoc's styled citations consume these keys: the default is the
+      # authoritative identifier; the short cite is the style's citation,
+      # falling back to the reference rendering (the 1.x short-cite)
+      FIRST_DELIM = "<span class='fmt-first-biblio-delim'/>"
+
+      # render_all feeds the bibliography list: a reference not ending
+      # in the biblio terminator takes one (the 1.x render1 behaviour;
+      # single-item render stays verbatim)
+      def terminate_reference(ref)
+        return ref if ref.empty? || ref.rstrip.end_with?(".")
+
+        "#{ref}."
+      end
+
+      def citation_renderings(item, ref)
+        short = @renderer.citation(item)
+        short = if short.empty?
+                  @renderer.render_short(item, FIRST_DELIM)
+                else
+                  short
+                end
+
+        {
+          full: ref,
+          default: item.docidentifier.first&.content.to_s,
+          short: short,
+        }
+      end
+
       # isodoc's pref_ref_code_parse reads
       # data[:authoritative_identifier] to build biblio-tag identifiers
       # (presentation_function/docid.rb). Returns [data, self] as the

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

@@ -8,11 +8,12 @@ module Relaton
       # predicate, #render the element's formatting method. Punctuation
       # between elements belongs to the kind/style, not the element.
       class Element
-        def initialize(model, style:, i18n:, kind: nil)
+        def initialize(model, style:, i18n:, kind: nil, short: false)
           @model = model
           @style = style
           @i18n = i18n
           @kind = kind
+          @short = short
         end
 
         def present?
@@ -48,8 +49,12 @@ module Relaton
         end
 
         def org_name(contributor)
+          shown = ->(n) do
+            text = localized(n)
+            @style.scheme.name_form.org_upcase ? text.upcase : text
+          end
           name = Array(contributor.organization&.name)
-            .map { |n| localized(n).upcase }.join(", ")
+            .map(&shown).join(", ")
           abbrev = localized(contributor.organization&.abbreviation)
           return name if name.empty? || abbrev.empty?
 
@@ -95,15 +100,27 @@ module Relaton
         end
 
         def join_names(names)
+          oxford = @i18n.label("oxford_comma")
+          if serial_list? && names.size > 1 && !oxford.empty?
+            return "#{names[0..-2].join(', ')}#{oxford} " \
+              "#{@i18n.label('and')} #{names.last}"
+          end
+
           case names.size
           when 0 then ""
           when 1 then names.first
           when 2 then names.join(" #{@i18n.label('and')} ")
           else
-            "#{names[0..-2].join(', ')}#{@i18n.label('oxford_comma')} " \
+            "#{names[0..-2].join(', ')}#{oxford} " \
             "#{@i18n.label('and')} #{names.last}"
           end
         end
+
+        # Serial list style: the oxford comma appears at every gap of a
+        # name list, including between two names
+        def serial_list?
+          @style.scheme.name_form.list_style == "serial"
+        end
       end
     end
   end

data/lib/relaton/render/iso690/elements/creator.rb

@@ -15,6 +15,8 @@ module Relaton
           end
 
           def render
+            return plain_render if @short
+
             joined = if (form = @style.templates.creators) && !form.empty?
                        ::Relaton::Render::Iso690::Template.new(form).evaluate(
                          "names" => Template::Field[true, join(names)],
@@ -38,6 +40,14 @@ module Relaton
             end
           end
 
+          # The short cite splits after the creators: they render as a
+          # plain join, without the wrap and sentence period (1.x
+          # short-cite templates carried no wrap)
+          def plain_render
+            marker = editors? && creators.size > 1 ? " (#{role_word})" : ''
+            "#{join(names)}#{marker}"
+          end
+
           def role_placement
             @style.scheme.name_form.role_placement || "glue"
           end
@@ -115,21 +125,9 @@ module Relaton
           end
 
           def join(names)
-            oxford = @i18n.label("oxford_comma")
-            if serial_list? && names.size > 1 && !oxford.empty?
-              return "#{names[0..-2].join(', ')}#{oxford} " \
-                "#{@i18n.label('and')} #{names.last}"
-            end
-
             join_names(names)
           end
 
-          # Serial list style: every gap takes the serial form, even
-          # between two names
-          def serial_list?
-            @style.scheme.name_form.list_style == "serial"
-          end
-
           def editors?
             !creators.empty? && creators.all? { |c| has_role?(c, "editor") }
           end

data/lib/relaton/render/iso690/elements/location.rb

@@ -12,7 +12,8 @@ module Relaton
           end
 
           def render
-            text = if (form = @style.templates.uri) && !form.empty?
+            form = uri_form
+            text = if form && !form.empty?
                      ::Relaton::Render::Iso690::Template.new(form).evaluate(
                        "uri" => Template::Field[!uri.empty?, uri],
                      )
@@ -20,11 +21,25 @@ module Relaton
                      uri
                    end
 
-            "#{@i18n.label('available_from')} #{text}".strip
+            label = @short ? "" : "#{@i18n.label('available_from')} "
+            "#{label}#{text}".strip
           end
 
           private
 
+          # The short cite renders the bare uri (1.x short templates),
+          # the reference the declared form
+          def uri_form
+            if @short
+              short_form = @style.templates.uri_short
+              return :bare if short_form.empty?
+
+              return short_form
+            end
+
+            @style.templates.uri
+          end
+
           def uri
             from_accesslocation =
               Array(@model.accesslocation).map(&:to_s).reject(&:empty?)
@@ -32,8 +47,13 @@ module Relaton
               return from_accesslocation.first.to_s
             end
 
-            Array(@model.source).map { |u| u.content.to_s }
-              .reject(&:empty?).first.to_s
+            uris = Array(@model.source).reject do |u|
+              u.content.to_s.strip.empty?
+            end
+            # the citation uri outranks the rest (1.x uri extraction)
+            preferred = uris.find { |u| u.type == "citation" } ||
+              uris.find { |u| u.type == "attachment" } || uris.first
+            preferred&.content.to_s
           end
         end
       end

data/lib/relaton/render/iso690/elements/production.rb

@@ -9,19 +9,28 @@ module Relaton
         # organization contributors.
         class Production < Element
           def present?
-            !places.empty? || !publishers.empty?
+            !places.empty? || !publishers.empty? || no_place_declared?
           end
 
           def render
-            [place_text, publishers.join("; ")]
+            return no_place_production if places.empty? && no_place_declared?
+
+            [places.join("; "), publishers.join("; ")]
               .reject(&:empty?).join(@i18n.punct_fetch("production_sep", ": "))
           end
 
-          def place_text
-            return places.join("; ") unless places.empty?
-
+          # The no-place placeholder keeps the production separator even
+          # when no publisher follows ("n.p.: n.d.")
+          def no_place_production
             label = @i18n.label("no_place")
-            label == "no_place" ? "" : label
+            return "" if label.empty? || label == "no_place"
+
+            pubs = publishers.join("; ")
+            pubs.empty? ? "#{label}:" : "#{label}: #{pubs}"
+          end
+
+          def no_place_declared?
+            @style.type_template_for(item_kind)&.no_place == true
           end
 
           private

data/lib/relaton/render/iso690/elements/title.rb

@@ -14,7 +14,8 @@ module Relaton
           def render
             text = main_title
             return text if analytic?
-            if (form = @style.title_form_for(Kinds.kind_for(@model.type)))
+            if !@short &&
+               (form = @style.title_form_for(Kinds.kind_for(@model.type)))
               text = ::Relaton::Render::Iso690::Template.new(form).evaluate(
                 "title" => Template::Field[!text.empty?, text],
               )

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

@@ -39,8 +39,9 @@ module Relaton
           stddoc: Stddoc,
         }.freeze
 
-        def self.build(name, model, style:, i18n:)
-          CLASSES.fetch(name).new(model, style: style, i18n: i18n)
+        def self.build(name, model, style:, i18n:, short: false)
+          CLASSES.fetch(name).new(model, style: style, i18n: i18n,
+                                  short: short)
         end
       end
     end

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

@@ -14,11 +14,13 @@ module Relaton
           extent access stddoc
         ].freeze
 
-        def initialize(model, style:, i18n:, disambiguator: nil)
+        def initialize(model, style:, i18n:, disambiguator: nil,
+                       short: false)
           @model = model
           @style = style
           @i18n = i18n
           @disambiguator = disambiguator.to_s
+          @short = short
         end
 
         def to_h
@@ -33,7 +35,8 @@ module Relaton
         private
 
         def element_field(slot)
-          element = Elements.build(slot, @model, style: @style, i18n: @i18n)
+          element = Elements.build(slot, @model, style: @style,
+                                   i18n: @i18n, short: @short)
           text = element.render.to_s
           if element.present? && !text.empty?
             return Template::Field[true, text]

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

@@ -25,8 +25,11 @@ module Relaton
         def initialize(style: DEFAULT_STYLE, lang: "en", script: "Latn",
                        labels: {})
           @style = Style.load(style)
-          @i18n = I18n.load(lang).overlay!(@style.scheme.locale)
+          @i18n = I18n.load(lang)
           @i18n.overlay_hash!(labels) unless labels.empty?
+          # The style instance is the citation-style authority: its
+          # declared strings win over the caller's generic i18n hash
+          @i18n.overlay!(@style.scheme.locale)
           @script = script
         end
 
@@ -49,6 +52,19 @@ module Relaton
           Array(model.docidentifier).any? { |d| types.include?(d.type) }
         end
 
+        # The short cite: the reference with the first-biblio marker
+        def render_short(model, delim)
+          kind = Kinds.kind_for(model.type)
+          template = @style.type_template_for(kind)&.short ||
+            @style.template_for(kind, home: home_docid?(model))
+          Template.new(template).evaluate_short(
+            Fields.new(model, style: @style, i18n: @i18n, short: true).to_h,
+            delim,
+          )
+        rescue ::Relaton::Render::Unrenderable
+          ""
+        end
+
         # In-text form: SURNAME, year + disambiguator (name-and-date)
         def citation(model, disambiguator: nil)
           Template.new(@style.templates.citation).evaluate(

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

@@ -23,6 +23,9 @@ module Relaton
           # "serial": the oxford comma appears at every gap of the
           # creator list, including between two names
           attribute :list_style, :string, default: ""
+          # Organization names take the inverted form's casing; small-cap
+          # styles keep the declared case
+          attribute :org_upcase, :boolean, default: -> { true }
           # The inverted form's surname casing: the name-date convention
           # upcases; small-cap styles keep the declared case
           attribute :surname_upcase, :boolean, default: -> { true }
@@ -36,6 +39,7 @@ module Relaton
             map "completenameUpcase", to: :completename_upcase
             map "invertedAll", to: :inverted_all
             map "listStyle", to: :list_style
+            map "orgUpcase", to: :org_upcase
             map "surnameUpcase", to: :surname_upcase
             map "initialsSeparator", to: :initials_separator
           end

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

@@ -16,6 +16,7 @@ module Relaton
           attribute :series, :string, default: ""
           attribute :uri, :string, default: ""
           attribute :creators, :string, default: ""
+          attribute :uri_short, :string, default: ""
 
           key_value do
             map "titleOpen", to: :title_open
@@ -26,6 +27,7 @@ module Relaton
           map "series", to: :series
           map "uri", to: :uri
           map "creators", to: :creators
+          map "uriShort", to: :uri_short
           end
         end
       end

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

@@ -13,6 +13,12 @@ module Relaton
           attribute :title, :string
           attribute :home, :boolean
           attribute :fallbacks, :hash, default: -> { {} }
+          # The short-cite template for this kind; absent falls back to
+          # the reference template in short mode
+          attribute :short, :string
+          # Render the style's no_place label when the publisher has no
+          # place (the book-family templates of some flavors)
+          attribute :no_place, :boolean
 
           key_value do
             map "type", to: :type
@@ -21,6 +27,8 @@ module Relaton
             map "title", to: :title
             map "home", to: :home
             map "fallbacks", to: :fallbacks
+            map "short", to: :short
+            map "noPlace", to: :no_place
           end
         end
       end

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

@@ -22,6 +22,34 @@ module Relaton
           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)
+          rendered = @slots.filter_map do |(name, head, tail)|
+            field = fields[normalise(name)] or next
+            next unless field.present?
+
+            [head, field.text, tail]
+          end
+          return "" if rendered.empty?
+
+          parts = rendered.each_with_index.map do |(head, text, tail), i|
+            if i.zero?
+              # the split marker precedes the component's trailing
+              # punctuation (1.x ret[0] += delim, then join), with the
+              # join's separating space
+              "#{head}#{text}#{delim} #{tail}"
+            elsif i == rendered.size - 1
+              "#{head}#{text}"
+            else
+              "#{head}#{text}#{tail}"
+            end
+          end
+          terminate(parts.join).rstrip
+        end
+
         def evaluate(fields)
           rendered = @slots.filter_map do |(name, head, tail)|
             field = fields[normalise(name)] or next
@@ -57,6 +85,9 @@ module Relaton
         end
 
         def terminate(body)
+          # An element ending in a colon carries its own separator: the
+          # following sentence period collapses (1.x punctuation cleanup)
+          body = body.gsub(/:\s*\.\s*/, ": ")
           return body if @terminator.strip.empty?
           return body if body.rstrip.end_with?(@terminator.strip)
 

data/lib/relaton/render/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Render
-    VERSION = "3.0.0.pre.alpha.6".freeze
+    VERSION = "3.0.0.pre.alpha.8".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.6
+  version: 3.0.0.pre.alpha.8
 platform: ruby
 authors:
 - Ribose Inc.