relaton-render 3.0.0.pre.alpha.7 → 3.0.0.pre.alpha.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1765d54a70d5e79ba48d03c848135bad61bfb6f27e439cb142e869054e06b181
-  data.tar.gz: 9d8636b1838f06a8d119ad2052e7c7b7c47f81f6e9d176ca414fb76b1cbc0698
+  metadata.gz: 1b2cc7ff33eb9f42dda9093ce14cfe39a2495d4499d93150e50783da711e8087
+  data.tar.gz: 8be8a9bea072cd0e69307b5ea8fe3674429e302dd8751f1f399b81a5a154c08f
 SHA512:
-  metadata.gz: d4907031dd0d8e1180b3e25221000d58498d5bd18468bf743d372fc84ca79d878518f3b4c966d7faa7dfb3b36c4c5a61fef82d5c508295e3167dfb9cb722485a
-  data.tar.gz: 832213c7c17a9b58dee06a8953c75f30a41b23e568a3ff936cf32d4167a69b69eebe74d9bfbd31b0e7cd22ac3964da999aeb05f2bbd7e30b86473d656b458067
+  metadata.gz: 1101c3d3781e1c51f78728e74a5ea7c3897e2d52407d896057952d6eb0461f7f6dab1344ef7141e0d37bf77348cc203019420e6e4ea9753986746e2261ef344b
+  data.tar.gz: 4be1e8b804b46e08494db403d5bb9100760415af858dc0a96e2d0db30f82cd00d8d53cdd8447a06d434847d6316389b6b3346e7307a5f5630717105b6a3dab06

data/lib/relaton/render/general.rb

@@ -62,7 +62,8 @@ module Relaton
             next
           end
           m[item.id] = {
-            id: item.id, ord: i, formattedref: ref,
+            id: item.id, ord: i,
+            formattedref: terminate_reference(ref),
             citation: citation_renderings(item, ref),
           }
         end
@@ -71,9 +72,24 @@ module Relaton
       # 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 = ref if short.empty?
+        short = if short.empty?
+                  @renderer.render_short(item, FIRST_DELIM)
+                else
+                  short
+                end
 
         {
           full: ref,

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?
@@ -81,17 +82,24 @@ module Relaton
             ""
           end.reject(&:empty?)
           sep = @style.scheme.name_form.initials_separator.to_s
-          return reinitials(localized(person.name&.formatted_initials),
-                            sep) if parts.empty?
-          return parts.map { |p| "#{p[0]}." }.join(sep) if initials?
+          return reinitials(localized(person.name&.formatted_initials)) if
+            parts.empty?
+          return parts.map(&method(:initial)).join(sep) if initials?
 
           parts.join(" ")
         end
 
         # Declared initials are a list in string form; rejoin them with
         # the style's separator
-        def reinitials(raw, sep)
-          raw.split(/\s+/).reject(&:empty?).join(sep)
+        def reinitials(raw)
+          sep = @style.scheme.name_form.initials_separator.to_s
+          dots = @style.scheme.name_form.initials_period
+          raw.split(/\s+/).reject(&:empty?).map { |i| dots ? i : i.delete(".") }
+            .join(sep)
+        end
+
+        def initial(name)
+          @style.scheme.name_form.initials_period ? "#{name[0]}." : name[0]
         end
 
         def initials?
@@ -99,6 +107,11 @@ module Relaton
         end
 
         def join_names(names)
+          # A style with no join word renders a plain serial list
+          if @i18n.label("and").empty? && names.size > 1
+            return names.join(", ")
+          end
+
           oxford = @i18n.label("oxford_comma")
           if serial_list? && names.size > 1 && !oxford.empty?
             return "#{names[0..-2].join(', ')}#{oxford} " \

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # The cited identifier with the item's status beside it and the
+        # list comma ("OGC 05-020r27 (Draft)," / "ISO 712,"): the comma
+        # stays with the identifier whichever side of the status it
+        # follows
+        class Citeid < Element
+          def present?
+            identifier_element.present?
+          end
+
+          def render
+            text = identifier_element.render
+            stage = status_element.present? ? status_element.render : ""
+            stage.empty? ? "#{text}," : "#{text}#{stage},"
+          end
+
+          private
+
+          def identifier_element
+            @identifier_element ||=
+              Identifier.new(@model, style: @style, i18n: @i18n, kind: @kind,
+                                    short: @short)
+          end
+
+          def status_element
+            @status_element ||=
+              Status.new(@model, style: @style, i18n: @i18n, kind: @kind,
+                                 short: @short)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,11 +11,15 @@ module Relaton
         # rendered string.
         class Creator < Element
           def present?
-            !creators.empty?
+            !creators.empty? || !fallback_name.empty?
           end
 
           def render
-            joined = if (form = @style.templates.creators) && !form.empty?
+            return plain_render if @short
+
+            joined = if creators.empty?
+                       fallback_name
+                     elsif (form = @style.templates.creators) && !form.empty?
                        ::Relaton::Render::Iso690::Template.new(form).evaluate(
                          "names" => Template::Field[true, join(names)],
                        )
@@ -26,18 +30,26 @@ module Relaton
             when "afterPeriod"
               # the in-slot trailing space separates the (eds.) marker
               # from the next element, which follows directly in the
-              # template; a lone editor is unmarked
-              if editors? && creators.size > 1
+              # template; a lone editor is unmarked unless declared
+              if editors? && marked?
                 "#{period(joined)} (#{role_word}) "
               else
                 "#{period(joined)} "
               end
             else
-              marker = editors? && creators.size > 1 ? " (#{role_word})" : ''
+              marker = editors? && marked? ? " (#{role_word})" : ''
               "#{joined}#{marker}"
             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
@@ -46,6 +58,10 @@ module Relaton
             text.end_with?(".") ? text : "#{text}."
           end
 
+          def marked?
+            creators.size > 1 || name_form.lone_editor_marked
+          end
+
           def role_word
             @i18n.label(creators.one? ? "ed" : "eds")
           end
@@ -77,6 +93,16 @@ module Relaton
             end
           end
 
+          # The declared creator fallback (e.g. the publisher's
+          # abbreviation for standards with no personal creators)
+          def fallback_name
+            return "" unless name_form.creator_fallback == "publisher_abbrev"
+
+            contributors("publisher").map do |c|
+              localized(c.organization&.abbreviation)
+            end.reject(&:empty?).first.to_s
+          end
+
           def names
             creators.each_with_index
               .map do |contributor, index|

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

@@ -13,16 +13,21 @@ module Relaton
             !identifiers.empty?
           end
 
+
           def render
-            identifiers.map { |d| IdentifierKinds.render(d) }
-              .join(@i18n.punct_fetch("identifier_join", ". "))
+            d = identifiers.first or return ""
+
+            IdentifierKinds.render(d)
           end
 
           private
 
+          # Scoped identifiers (anchor, biblio-tag) are pipeline
+          # artefacts, not cited identifiers
           def identifiers
             Array(@model.docidentifier).reject do |d|
-              INTERNAL_TYPES.include?(d.type) || d.content.to_s.strip.empty?
+              INTERNAL_TYPES.include?(d.type) ||
+                !d.scope.to_s.empty? || d.content.to_s.strip.empty?
             end
           end
         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,14 @@ 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.find { |u| u.type == "src" } || uris.first
+            preferred&.content.to_s
           end
         end
       end

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

@@ -13,10 +13,34 @@ module Relaton
           end
 
           def render
+            if publisher_first?
+              return no_place_production_publisher_first if places.empty? &&
+                no_place_declared?
+
+              return [publishers.join("; "), places.join("; ")]
+                .reject(&:empty?).join(production_sep)
+            end
+
             return no_place_production if places.empty? && no_place_declared?
 
             [places.join("; "), publishers.join("; ")]
-              .reject(&:empty?).join(@i18n.punct_fetch("production_sep", ": "))
+              .reject(&:empty?).join(production_sep)
+          end
+
+          def publisher_first?
+            @i18n.punct_fetch("production_order", "") == "publisher_first"
+          end
+
+          def production_sep
+            @i18n.punct_fetch("production_sep", ": ")
+          end
+
+          def no_place_production_publisher_first
+            label = @i18n.label("no_place")
+            return "" if label.empty? || label == "no_place"
+
+            pubs = publishers.join("; ")
+            pubs.empty? ? label : "#{pubs}, #{label}"
           end
 
           # The no-place placeholder keeps the production separator even

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

@@ -14,7 +14,12 @@ module Relaton
           end
 
           def render
-            range || year&.to_s
+            text = range || year&.to_s
+            return text if (form = @style.templates.date_form).empty?
+
+            ::Relaton::Render::Iso690::Template.new(form).evaluate(
+              "date" => Template::Field[!text.to_s.empty?, text.to_s],
+            )
           end
 
           private

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # The item's status stage, capitalized, parenthesized beside
+        # the identifier ("OGC 05-020r27 (Draft)"); published statuses
+        # are not cited
+        class Status < Element
+          def present?
+            !stage.empty? &&
+              !%w[published retired].include?(stage.downcase)
+          end
+
+          def render
+            " (#{stage})"
+          end
+
+          private
+
+          def stage
+            raw = @model.status&.stage&.content.to_s
+            raw.empty? ? "" : raw.sub(/^\w/) { |c| c.upcase }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,8 @@ module Relaton
         autoload :Extent, "relaton/render/iso690/elements/extent"
         autoload :Access, "relaton/render/iso690/elements/access"
         autoload :Stddoc, "relaton/render/iso690/elements/stddoc"
+        autoload :Status, "relaton/render/iso690/elements/status"
+        autoload :Citeid, "relaton/render/iso690/elements/citeid"
 
         CLASSES = {
           creator: Creator,
@@ -37,10 +39,13 @@ module Relaton
           extent: Extent,
           access: Access,
           stddoc: Stddoc,
+          status: Status,
+          citeid: Citeid,
         }.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

@@ -11,14 +11,16 @@ module Relaton
         ELEMENT_SLOTS = %i[
           creator title edition medium series production
           date numeration component_part identifier location size
-          extent access stddoc
+          extent access stddoc status citeid
         ].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/i18n.rb

@@ -33,6 +33,7 @@ module Relaton
         # Style-instance localized strings win over the language pack.
         def overlay!(locale)
           labels.merge!(locale.label_map)
+          punct.merge!(locale.punct || {})
           self
         end
 

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

@@ -52,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/locale.rb

@@ -17,6 +17,9 @@ module Relaton
           # Arbitrary label overrides (edition words, join punctuation,
           # size units): merged over the language pack verbatim.
           attribute :labels, :hash, default: -> { {} }
+          # Typographic punctuation overrides (production order and
+          # separator), declared as in the language packs
+          attribute :punct, :hash, default: -> { {} }
 
           key_value do
             map "and", to: :conj
@@ -27,6 +30,7 @@ module Relaton
             map "at", to: :at
             map "availableAt", to: :available_at
             map "labels", to: :labels
+            map "punct", to: :punct
           end
 
           LABEL_FOR = {

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

@@ -26,6 +26,13 @@ module Relaton
           # Organization names take the inverted form's casing; small-cap
           # styles keep the declared case
           attribute :org_upcase, :boolean, default: -> { true }
+          # When no personal creator exists, the creator slot falls back
+          # to the publisher's abbreviation ("ISO: ISO 712, ...")
+          attribute :creator_fallback, :string
+          # A lone editor still carries the role marker ("(ed.)")
+          attribute :lone_editor_marked, :boolean, default: -> { false }
+          # Initials without their trailing periods ("Nixon RM")
+          attribute :initials_period, :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 }
@@ -40,6 +47,9 @@ module Relaton
             map "invertedAll", to: :inverted_all
             map "listStyle", to: :list_style
             map "orgUpcase", to: :org_upcase
+            map "creatorFallback", to: :creator_fallback
+            map "loneEditorMarked", to: :lone_editor_marked
+            map "initialsPeriod", to: :initials_period
             map "surnameUpcase", to: :surname_upcase
             map "initialsSeparator", to: :initials_separator
           end

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

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

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

@@ -13,6 +13,9 @@ 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
@@ -24,6 +27,7 @@ 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

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,9 +85,11 @@ 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)
+          # 1.x punctuation cleanup: an element ending in a colon
+          # carries its own separator (the following sentence period
+          # collapses), and spaces collapse before a comma
           body = body.gsub(/:\s*\.\s*/, ": ")
+          body = body.gsub(/ +/, " ").gsub(" ,", ",")
           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.7".freeze
+    VERSION = "3.0.0.pre.alpha.9".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.7
+  version: 3.0.0.pre.alpha.9
 platform: ruby
 authors:
 - Ribose Inc.
@@ -121,6 +121,7 @@ files:
 - lib/relaton/render/iso690/element.rb
 - lib/relaton/render/iso690/elements.rb
 - lib/relaton/render/iso690/elements/access.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
@@ -133,6 +134,7 @@ files:
 - 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/fields.rb