relaton-render 0.10.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c6e30101b76eed2c22bd59d2ade5df753bb32798cd491c2aa6cb3bf868e5de
-  data.tar.gz: b1239be6d95b16fad99fe26e68fe0d13045cc8d28f040b652ec09d4f48117d83
+  metadata.gz: 9cec3f38cf2f0d1a1551a569b758e55e26114ff09e57dfe1d56042fc6f90d9c0
+  data.tar.gz: 8d5c2413e975f8c27c12a9ec9a4b906e714de5b8a3d58c24f378f1ad30de9d9d
 SHA512:
-  metadata.gz: 96b7b92de4706a3ae7fbe4c227ef388bc1358d719dbdd8bea1ce102134759bcad0a4b087bcce7b3d3abf3183d900d5b49526c3b976f381c0f239fc41371bcdc8
-  data.tar.gz: c7700ca4eb364f0e7c27d4bc077a4a2c5db839bd013814d1d9669029af957abe5db0602614722408dad9dd1cceda8558e2a0b1695d54942b2e7afb09cc7ea8dd
+  metadata.gz: 363654ad4adf20d8330ad8f17d398051b410962351763ea7d25b1489cfc32675b770237d5c20951e954bb155c01ca378d9b770a043a315d78cfe4eee7962075b
+  data.tar.gz: a3e7c9f9015ee5bf9a0e380432d01d0bf9139a523c4c2a6a95d57d0776fa9097cc7c08fe1ab8b47be1ff6d5fee10573b3995e84164c367af4f70589668feaf65

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

@@ -15,6 +15,7 @@ date_formats:
 ordinal_keys: []
 OrdinalRules: digits-ordinal
 edition_ordinal: "الطبعة؜ {{ var1 | ordinal_num: 'edition', '' }}"
+edition_cardinal: "الطبعة؜ {{ var }}"
 edition: الطبعة؜ ؜
 draft: "مشروع؜ %؜"
 editor:
@@ -43,10 +44,11 @@ size:
   issue:
     sg: "% عدد"
     pl: "% عدد"
-qq-open: «
-qq-close: »
-q-open: 
-q-close: 
+punct:
+  open-title: «
+  close-title: »
+  open-secondary-title: 
+  close-secondary-title: 
 inflection:
   الطبعة؜:
     grammar:

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

@@ -14,6 +14,7 @@ date_formats:
   date_time: to_long_s
 draft: "Entwurf %"
 edition_ordinal: "{{ var1 }} Ausg."
+edition_cardinal: "Ausg. {{ var1 }}"
 ordinal_keys: []
 edition: Ausgabe
 editor:
@@ -29,10 +30,11 @@ extent:
   issue:
     sg: "Nr. %"
     pl: "Nr. %"
-qq-open: <em>
-qq-close: </em>
-q-open:
-q-close: 
+punct:
+  open-title: <em>
+  close-title: </em>
+  open-secondary-title:
+  close-secondary-title: 
 stage:
   valid: Gültig
   withdrawn: Zurückgezogen

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

@@ -16,14 +16,16 @@ ordinal_keys: []
 OrdinalRules: digits-ordinal
 edition: edition
 edition_ordinal: "{{ var1 | ordinal_num: '', '' }} edition"
+edition_cardinal: "Edition {{ var1 }}"
 draft: "draft %"
 editor:
   sg: ed.
   pl: eds.
-qq-open: <em>
-qq-close: </em>
-q-open:
-q-close:
+punct:
+  open-title: <em>
+  close-title: </em>
+  open-secondary-title:
+  close-secondary-title:
 stage:
   valid: Valid
   withdrawn: Withdrawn

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

@@ -17,15 +17,17 @@ OrdinalRules:
   m: digits-ordinal-masculine
   f: digits-ordinal-feminine
 edition_ordinal: "{{ var1 | ordinal_num: 'edition', '' }} ed."
+edition_cardinal: "Ed. {{ var1 }}"
 edition: edición
 draft: "borrador %"
 editor:
   sg: ed.
   pl: eds.
-qq-open: <em>
-qq-close: </em>
-q-open:
-q-close:
+punct:
+  open-title: <em>
+  close-title: </em>
+  open-secondary-title:
+  close-secondary-title:
 stage:
   valid: Válido
   withdrawn: Retirado

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

@@ -19,15 +19,17 @@ OrdinalRules:
   m.pl: digits-ordinal-masculine-plural
   f.pl: digits-ordinal-feminine-plural
 edition_ordinal: "{{ var1 | ordinal_num: 'edition', '' }} édition"
+edition_cardinal: "Édition {{ var1 }}"
 edition: édition
 draft: "brouillon %"
 editor:
   sg: éd.
   pl: éd.
-qq-open: <em>
-qq-close: </em>
-q-open:
-q-close:
+punct:
+  open-title: <em>
+  close-title: </em>
+  open-secondary-title:
+  close-secondary-title:
 stage:
   valid: Valide
   withdrawn: Retiré

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

@@ -16,14 +16,17 @@ ordinal_keys: []
 OrdinalRules: digits-ordinal
 edition: 版
 edition_ordinal: "第{{ var1 }}版"
+edition_cardinal: "第{{ var1 }}版"
 draft: "下書き %"
 editor:
   sg: 編
   pl: 編
-qq-open: 
-qq-close: 
-q-open:
-q-close:
+punct:
+  open-title:
+  close-title:
+  open-secondary-title:
+  close-secondary-title:
+  biblio-terminator: "。"
 stage:
   valid: 有効です
   withdrawn: 取り消されました

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

@@ -21,15 +21,17 @@ SpelloutRules:
   f.pl: spellout-ordinal-plural
   n.pl: spellout-ordinal-plural
 edition_ordinal: "{{ var1 | ordinal_word: 'edition', '' }} издание"
+edition_cardinal: "Издание {{ var1 }}"
 edition: издание
 draft: "проект %"
 editor:
   sg: изд.
   pl: изд.
-qq-open: <em>
-qq-close: </em>
-q-open:
-q-close:
+punct:
+  open-title: <em>
+  close-title: </em>
+  open-secondary-title:
+  close-secondary-title:
 stage:
   valid: Действительный
   withdrawn: Снято

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

@@ -16,15 +16,18 @@ ordinal_keys: []
 OrdinalRules: digits-ordinal
 SpelloutRules: spellout-ordinal
 edition_ordinal: "第{{ var1 | ordinal_num: '', '' }}版"
+edition_cardinal: "第{{ var1 }}版"
 edition: 版
 draft: "草案%"
 editor:
   sg: 编
   pl: 编
-qq-open: 《
-qq-close: 》
-q-open: 〈
-q-close: 〉
+punct:
+  open-title: 《
+  close-title: 》
+  open-secondary-title: 〈
+  close-secondary-title: 〉
+  biblio-terminator: "。"
 stage:
   valid: 有效
   withdrawn: 已撤回

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

@@ -15,15 +15,18 @@ date_formats:
 ordinal_keys: []
 OrdinalRules: digits-ordinal
 edition_ordinal: "第{{ var1 | ordinal_num: '', '' }}版"
+edition_cardinal: "第{{ var1 }}版"
 edition: 版
 draft: "草案%"
 editor:
   sg: 編輯
   pl: 編輯
-qq-open: <underline style="wavy">
-qq-close: </underline>
-q-open: 〈
-q-close: 〉
+punct:
+  open-title: <underline style="wavy">
+  close-title: </underline>
+  open-secondary-title: 〈
+  close-secondary-title: 〉
+  biblio-terminator: "。"
 stage:
   valid: 有效的
   withdrawn: 取消

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

@@ -14,6 +14,7 @@ module Relaton
         render1(granularity)
       end
 
+      # @r.date is using document language setting, not citation-specific
       def render1(format)
         datef = dateparse(format, @r.lang.to_sym)
         case @r.date[format]

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

@@ -7,81 +7,114 @@ module Relaton
         @r = options[:renderer]
       end
 
+      # the @i18n.select choices here need to rely on
+      # fields already present, they can't rely on fields they are yet to build
       def compound_fields_format(hash)
         name_fields_format(hash)
         role_fields_format(hash)
         date_fields_format(hash)
         edition_fields_format(hash)
+        place_fields_format(hash)
+        series_fields_format(hash)
         misc_fields_format(hash)
       end
 
+      def comma(hash)
+        "#{@r.i18n.select(hash).get.dig('punct', 'comma') || ','} "
+      end
+
+      def place_fields_format(hash)
+        hash[:place_raw]&.map! do |p|
+          # TODO use enum-comma?
+          if p.is_a?(Array)
+            p.join(comma(hash))
+          else p
+          end
+        end
+        hash[:place] =
+          nameformat(hash[:place_raw].map { |x| { nonpersonal: x } }, hash)
+      end
+
       def name_fields_format(hash)
         [%i(creatornames creators), %i(host_creatornames host_creators),
          %i(publisher publisher_raw), %i(distributor distributor_raw),
          %i(authorizer authorizer_raw)]
           .each do |k|
-          hash[k[0]] = nameformat(hash[k[1]])
+          hash[k[0]] = nameformat(hash[k[1]], hash)
         end
-        hash[:publisher_abbrev] = hash[:publisher_abbrev_raw]&.join(", ")
-        hash[:authorcite] = authorciteformat(hash[:creators])
-        place_format(hash)
-      end
-
-      def place_format(hash)
-        hash[:place] =
-          nameformat(hash[:place_raw].map { |x| { nonpersonal: x } })
+        hash[:publisher_abbrev] = hash[:publisher_abbrev_raw]&.join(comma(hash))
+        hash[:authorcite] = authorciteformat(hash[:creators], hash)
       end
 
       def role_fields_format(hash)
-        hash[:role] = role_inflect(hash[:creators], hash[:role_raw])
+        hash[:role] = role_inflect(hash[:creators], hash[:role_raw], hash)
         hash[:host_role] =
-          role_inflect(hash[:host_creators], hash[:host_role_raw])
+          role_inflect(hash[:host_creators], hash[:host_role_raw], hash)
       end
 
       def edition_fields_format(hash)
-        hash[:edition] = editionformat(hash[:edition_raw], hash[:edition_num])
+        hash[:edition] =
+          editionformat(hash[:edition_raw], hash[:edition_num], hash)
         hash[:draft] = draftformat(hash[:draft_raw], hash)
       end
 
       def misc_fields_format(hash)
-        hash[:series] = seriesformat(hash)
-        hash[:medium] = mediumformat(hash[:medium_raw])
+        hash[:medium] = mediumformat(hash[:medium_raw], hash)
         hash[:extent] = extentformat(hash[:extent_raw], hash)
         hash[:size] = sizeformat(hash[:size_raw], hash)
         hash[:uri] = uriformat(hash[:uri_raw])
+        hash[:status] = statusformat(hash[:status_raw], hash)
+        hash[:other_identifier] =
+          otheridentifierformat(hash[:other_identifier_raw], hash)
         hash
       end
 
+      def otheridentifierformat(otherids, _hash)
+        otherids&.map do |i|
+          # ret = "#{i[0]}: <esc>#{i[1]}</esc>"
+          # @r.i18n.select(hash).l10n(ret) # no i18n!
+          "#{i[0]}: #{i[1]}"
+        end
+      end
+
+      def statusformat(status, hash)
+        status.nil? and return
+        @r.i18n.select(hash).get.dig("stage", status) || status
+      end
+
       def date_fields_format(hash)
         [%i(date date), %i(date_updated date_updated),
          %i(date_accessed date_accessed)].each do |k|
           hash[k[0]] = dateformat(hash[k[1]], hash, k)
           k[0] == :date &&
             !%w(standard webresource website).include?(hash[:type]) and
-            hash[k[0]] ||= @r.i18n.get["no_date"]
+            hash[k[0]] ||= @r.i18n.select(nil).get["no_date"]
         end
       end
 
-      # TODO is not being i18n-alised
-      def mediumformat(hash)
-        hash.nil? and return nil
-        %w(content genre form carrier size scale).each_with_object([]) do |i, m|
-          m << hash[i] if hash[i]
+      def mediumformat(medium, hash)
+        medium.nil? and return nil
+        ret = %w(content genre form carrier size
+                 scale).each_with_object([]) do |i, m|
+          m << "<esc>#{medium[i]}</esc>" if medium[i]
           m
-        end.compact.join(", ")
+        end.compact
+        i = @r.i18n.select(hash)
+        i.l10n(ret.join(comma(hash)))
       end
 
-      def seriesformat(hash)
-        parts = %i(series_title series_abbr series_num series_partnumber
-                   series_run series_formatted series_dates series_place series_org)
+      def series_fields_format(hash)
+        parts =
+          %i(series_title series_abbr series_num series_partnumber
+             series_run series_formatted series_dates series_place series_org)
         series_out = parts.each_with_object({}) do |i, m|
           m[i] = hash[i]
         end
         t = hash[:type] == "article" ? @r.journaltemplate : @r.seriestemplate
-        t.render(series_out)
+        hash[:series] = t.render(series_out, hash)
       end
 
-      def nameformat(names)
+      def nameformat(names, hash)
         names.nil? and return names
         parts = %i(surname initials given middle nonpersonal)
         names_out = names.each_with_object({}) do |n, m|
@@ -90,10 +123,10 @@ module Relaton
             m[i] << n[i]
           end
         end
-        @r.nametemplate.render(names_out)
+        @r.nametemplate.render(names_out, hash)
       end
 
-      def authorciteformat(names)
+      def authorciteformat(names, hash)
         names.nil? || @r.authorcitetemplate.nil? and return names
         parts = %i(surname initials given middle nonpersonal)
         names_out = names.each_with_object({}) do |n, m|
@@ -102,48 +135,53 @@ module Relaton
             m[i] << n[i]
           end
         end
-        @r.authorcitetemplate.render(names_out)
+        @r.authorcitetemplate.render(names_out, hash)
       end
 
-      def role_inflect(contribs, role)
+      def role_inflect(contribs, role, hash)
         role.nil? || contribs.empty? ||
           %w(author publisher distributor
              authorizer).include?(role) and return nil
         number = contribs.size > 1 ? "pl" : "sg"
-        x = @r.i18n.get[role]
+        x = @r.i18n.select(hash).get[role]
         x.is_a?(Hash) or return role
         x[number] || role
       end
 
-      def editionformat(edn, num)
-        num || /^\d+$/.match?(edn) or return edn
-        @r.i18n.populate("edition_ordinal", { "var1" => num || edn.to_i })
+      def editionformat(edn, num, hash)
+        num || edn && !edn.empty? or return
+        edn_num = edn&.gsub(/<\/?esc>/, "")
+        num || /^\d+$/.match?(edn_num) and
+          return @r.i18n.select(hash)
+              .populate("edition_ordinal", { "var1" => num || edn_num.to_i })
+        @r.i18n.select(hash).populate("edition_cardinal", { "var1" => edn })
       end
 
-      def draftformat(num, _hash)
+      def draftformat(num, hash)
         num.nil? ||
           (num.is_a?(Hash) && num[:status].nil? &&
             num[:iteration].nil?) and return nil
-        @r.i18n.draft.sub("%", num)
+        @r.i18n.select(hash).draft.sub("%", num)
       end
 
       def extentformat(extent, hash)
         extent.map do |stack|
-        stack.map do |e|
-          e1 = e.transform_values { |v| v.is_a?(Hash) ? range(v) : v }
-          ret = e.each_with_object({}) do |(k, v), m|
-            extentformat1(k, v, m, e1)
-            m
-          end
-          @r.extenttemplate.render(hash.merge(ret))
-        end.join(" ")
+          stack.map do |e|
+            e1 = e.transform_values { |v| v.is_a?(Hash) ? range(v) : v }
+            ret = e.each_with_object({}) do |(k, v), m|
+              extentformat1(k, v, m, e1, hash)
+              m
+            end
+            @r.extenttemplate.render(hash.merge(ret), hash)
+          end.join(" ")
         end.join("; ")
       end
 
-      def extentformat1(key, val, hash, norm_hash)
+      def extentformat1(key, val, hash, norm_hash, context)
         if %i(volume issue page).include?(key)
           hash["#{key}_raw".to_sym] = norm_hash[key]
-          hash[key] = pagevolformat(norm_hash[key], val, key.to_s, false)
+          hash[key] =
+            pagevolformat(norm_hash[key], val, key.to_s, false, context)
         end
       end
 
@@ -159,25 +197,27 @@ module Relaton
       def sizeformat(size, hash)
         return nil unless size
 
-        ret = size.transform_values { |v| @r.i18n.l10n(v.join(" + ")) }
+        ret = size.transform_values do |v|
+          @r.i18n.select(hash).l10n(v.join(" + "))
+        end
           .each_with_object({}) do |(k, v), m|
-            sizeformat1(k, v, m)
+            sizeformat1(k, v, m, hash)
             m
           end
-        @r.sizetemplate.render(ret.merge(type: hash[:type]))
+        @r.sizetemplate.render(ret.merge(type: hash[:type]), hash)
       end
 
-      def sizeformat1(key, val, hash)
+      def sizeformat1(key, val, hash, context)
         case key
         when "volume", "issue", "page"
           hash["#{key}_raw".to_sym] = val
-          hash[key.to_sym] = pagevolformat(val, nil, key, true)
+          hash[key.to_sym] = pagevolformat(val, nil, key, true, context)
         when "data" then hash[:data] = val
         when "duration" then hash[:duration] = val
         end
       end
 
-      def pagevolformat(value, value_raw, type, is_size)
+      def pagevolformat(value, value_raw, type, is_size, hash)
         value.nil? and return nil
         num = "pl"
         if is_size
@@ -185,8 +225,9 @@ module Relaton
         else
           value_raw[:to] or num = "sg"
         end
-        @r.i18n.l10n(@r.i18n.get[is_size ? "size" : "extent"][type][num]
-          .sub("%", value))
+        i = @r.i18n.select(hash)
+        i.l10n(i.get[is_size ? "size" : "extent"][type][num]
+        .sub("%", value))
       end
 
       def date_range(hash)

data/lib/relaton/render/general/citations.rb

@@ -2,17 +2,21 @@ module Relaton
   module Render
     class Citations
       def initialize(opt = {})
-        @type = opt[:type]
+        # invoking i18n hash, but we preference the specific renderer's i18n
         @i18n = opt[:i18n]
+        @lang = opt[:lang] # document lang and script
+        @script = opt[:script]
+        # hash of renderers, to be applied to specific citation by selector
         @renderer = opt[:renderer]
       end
 
-      # takes array of { id, type, author, date, ord, data_liquid }
+      def renderer(_cite)
+        @renderer[:default]
+      end
+
+      # takes array of { id, type, author, date, ord, data }
       def render(ret)
         cites = citations(ret)
-        cites.each_value do |v|
-          v[:renderer] = @renderer.renderer(v[:type] || "misc")
-        end
         enhance_data(cites)
         cites.each_key do |k|
           cites[k] = render1(cites[k])
@@ -38,8 +42,8 @@ module Relaton
       end
 
       def extract_uri_for_lookup(cite)
-        t = cite[:renderer].template_raw
-        c = cite[:data_liquid]
+        t = renderer(cite).renderer(cite[:type] || "misc").template_raw
+        c = cite[:data]
         t.is_a?(String) or return
         (/\{\{\s*date_accessed\s*\}\}/.match?(t) &&
         /\{\{\s*uri\s*\}\}/.match?(t) &&
@@ -47,46 +51,72 @@ module Relaton
         c[:uri_raw]
       end
 
-      def add_date_accessed(data, uri, status)
+      def add_date_accessed(cite, uri, status)
+        r = renderer(cite)
         if status
-          data[:data_liquid][:date_accessed] = { on: ::Date.today.to_s }
-          data[:data_liquid] = @renderer.fieldsklass.new(renderer: @renderer)
-            .compound_fields_format(data[:data_liquid])
+          cite[:data][:date_accessed] = { on: ::Date.today.to_s }
+          cite[:data] = r.fieldsklass.new(renderer: r)
+            .compound_fields_format(cite[:data])
         else
-          @renderer.url_warn(uri)
+          r.url_warn(uri)
         end
       end
 
       def render1(cit)
+        ref, ref1, r = render1_prep(cit)
+        i = @i18n.select(cit[:data])
         cit[:formattedref] =
-          @renderer.valid_parse(
-            @i18n.l10n(cit[:renderer].render(cit[:data_liquid])),
-          )
-        %i(type data_liquid renderer).each { |x| cit.delete(x) }
+          r.valid_parse(i.l10n(ref1))
+        cit[:citation][:full] = r.valid_parse(i.l10n(ref))
+        %i(type data renderer).each { |x| cit.delete(x) }
         cit
       end
 
+      def use_terminator?(ref, final, _cit)
+        !ref || ref.empty? and return false
+        !ref.end_with?(final)
+      end
+
+      def render1_prep(cit)
+        r = renderer(cit)
+        ref = r.renderer(cit[:type] || "misc").render(cit[:data], cit[:data])
+        final = @i18n.select(cit[:data]).get
+          .dig("punct", "biblio-terminator") || "."
+        ref1 = ref
+        use_terminator?(ref, final, cit) and ref1 += final
+        [ref, ref1, r]
+      end
+
+      # TODO: configure how multiple ids are joined, from template?
       def citations(ret)
-        case @type
-        when "author-date" then disambig_author_date_citations(ret)
-        when nil then generic_citation(ret)
-        else raise "Unimplemented citation type"
+        ret = disambig_author_date_citations(ret)
+        ret.each_value do |b|
+          i = @i18n.select(b[:data])
+          b[:citation][:default] =
+            i.l10n(b[:data][:authoritative_identifier]&.first || "")
+          b[:citation][:short] = i.l10n(renderer(b).citeshorttemplate
+            .render(b[:data].merge(citestyle: "short"), b[:data]))
+          citations_iterate_cite_styles(b, i)
         end
+        ret
       end
 
-      def generic_citation(ret)
-        ret.each_with_object({}) do |b, m|
-          m[b[:id]] = { data_liquid: b[:data_liquid], type: b[:type],
-                        citation: @i18n.l10n(b[:data_liquid][:docidentifier]) }
+      def citations_iterate_cite_styles(bib, i18n)
+        r = renderer(bib)
+        r.citetemplate.citation_styles.each do |style|
+          bib[:citation][style] =
+            i18n.l10n(r.citetemplate
+            .render(bib.merge(citestyle: style)
+            .merge(bib[:data]), bib[:data]))
         end
       end
 
-      # takes array of { id, type, author, date, ord, data_liquid }
+      # takes array of { id, type, author, date, ord, data }
       def disambig_author_date_citations(ret)
-        to_hash(suffix_date(sort_ord(breakdown(ret))))
+        author_date_to_hash(suffix_date(sort_ord(author_date_breakdown(ret))))
       end
 
-      def breakdown(ret)
+      def author_date_breakdown(ret)
         ret.each_with_object({}) do |b, m|
           m[b[:author]] ||= {}
           m[b[:author]][b[:date]] ||= []
@@ -114,21 +144,21 @@ module Relaton
       end
 
       def suffix_date1(ret, key1, key2)
+        key1.nil? and return
         ret[key1][key2].each_with_index do |b, i|
-          next if b[:date].nil?
-
+          b[:date].nil? and next
           b[:date] += ("a".ord + i).chr.to_s
-          b[:data_liquid][:date] = b[:date]
+          b[:data][:date] = b[:date]
         end
       end
 
-      def to_hash(ret)
+      def author_date_to_hash(ret)
         ret.each_with_object({}) do |(_k, v), m|
           v.each_value do |v1|
             v1.each do |b|
-              m[b[:id]] = { author: @i18n.l10n(b[:author]), date: b[:date],
-                            citation: @i18n.l10n("#{b[:author]} #{b[:date]}"),
-                            data_liquid: b[:data_liquid], type: b[:type] }
+              m[b[:id]] = { author: @i18n.select(b[:data]).l10n(b[:author]),
+                            date: b[:date], citation: {},
+                            data: b[:data], type: b[:type] }
             end
           end
         end