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

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.24".freeze
+    VERSION = "3.0.0.pre.alpha.26".freeze
   end
 end

data/lib/relaton-render.rb

@@ -9,14 +9,5 @@ module Relaton
     # single-item API raises, the batch API skips
     class Unrenderable < StandardError; end
 
-    # Deprecated 1.x engine leaves, restored so flavor gems that still
-    # subclass them load against this line. Superseded by the Iso690
-    # engine; removed when the flavors have migrated to CitationStyle
-    # instances. Referencing a constant loads its tree on demand.
-    autoload :Parse, "relaton/render/parse/parse"
-    autoload :Fields, "relaton/render/fields/fields"
-    autoload :Date, "relaton/render/fields/date"
-    autoload :Template, "relaton/render/template/template"
-    autoload :Citations, "relaton/render/legacy/citations"
   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.24
+  version: 3.0.0.pre.alpha.26
 platform: ruby
 authors:
 - Ribose Inc.
@@ -113,9 +113,8 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
+- docs/citation-style-pack.adoc
 - lib/relaton-render.rb
-- lib/relaton/render/fields/date.rb
-- lib/relaton/render/fields/fields.rb
 - lib/relaton/render/general.rb
 - lib/relaton/render/iso690.rb
 - lib/relaton/render/iso690/element.rb
@@ -148,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
@@ -155,17 +155,12 @@ 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/legacy/citations.rb
-- lib/relaton/render/parse/parse.rb
-- lib/relaton/render/parse/parse_contributors.rb
-- lib/relaton/render/parse/parse_extract.rb
-- lib/relaton/render/parse/parse_id.rb
-- lib/relaton/render/template/hash_utils.rb
-- lib/relaton/render/template/liquid.rb
-- lib/relaton/render/template/subclasses.rb
-- lib/relaton/render/template/template.rb
 - lib/relaton/render/version.rb
 - relaton-render.gemspec
 homepage: https://github.com/relaton/relaton-render

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

@@ -1,48 +0,0 @@
-module Relaton
-  module Render
-    class Date
-      def initialize(date, options)
-        @date = date
-        @r = options[:renderer]
-        @type = options[:type]
-        @bibitem = options[:bibitem]
-      end
-
-      def render
-        return @date if @date.nil? || /^\d+$/.match?(@date)
-
-        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]
-        when "to_full_s", "to_long_s", "to_medium_s", "to_short_s"
-          datef.send @r.date[format]
-        else
-          datef.to_additional_s(@r.date[format])
-        end
-      end
-
-      def granularity
-        case @date
-        when /^\d+-\d+$/ then "month_year"
-        when /^\d+-\d+-\d+$/ then "day_month_year"
-        else "date_time"
-        end
-      end
-
-      def dateparse(format, lang)
-        case format
-        when "date_time"
-          DateTime.parse(@date).localize(lang, timezone: "Zulu")
-        when "day_month_year"
-          DateTime.parse(@date).localize(lang, timezone: "Zulu").to_date
-        when "month_year"
-          DateTime.parse("#{@date}-01").localize(lang, timezone: "Zulu").to_date
-        end
-      end
-    end
-  end
-end

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

@@ -1,266 +0,0 @@
-require_relative "date"
-
-module Relaton
-  module Render
-    class Fields
-      def initialize(options)
-        @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)
-        end
-        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)
-        hash[:host_role] =
-          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)
-        hash[:draft] = draftformat(hash[:draft_raw], hash)
-      end
-
-      def misc_fields_format(hash)
-        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
-
-      # date => disambiguated_date, the disambiguation happens in citations/
-      def date_fields_format(hash)
-        [%i(date date), %i(disambiguated_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[1] == :date &&
-            !%w(standard webresource website).include?(hash[:type]) and
-            hash[k[0]] ||= @r.i18n.select(nil).get["no_date"]
-        end
-      end
-
-      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
-        i = @r.i18n.select(hash)
-        i.l10n(ret.join(comma(hash)))
-      end
-
-      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
-        hash[:series] = t.render(series_out, hash)
-      end
-
-      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|
-          parts.each do |i|
-            m[i] ||= []
-            m[i] << n[i]
-          end
-        end
-        @r.nametemplate.render(names_out, hash)
-      end
-
-      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|
-          parts.each do |i|
-            m[i] ||= []
-            m[i] << n[i]
-          end
-        end
-        @r.authorcitetemplate.render(names_out, hash)
-      end
-
-      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.select(hash).get[role]
-        x.is_a?(Hash) or return role
-        x[number] || role
-      end
-
-      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)
-        num.nil? ||
-          (num.is_a?(Hash) && num[:status].nil? &&
-            num[:iteration].nil?) and return nil
-        @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, hash)
-              m
-            end
-            @r.extenttemplate.render(hash.merge(ret), hash)
-          end.join(" ")
-        end.join("; ")
-      end
-
-      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, context)
-        end
-      end
-
-      def range(hash)
-        hash[:on] and return hash[:on]
-        hash.has_key?(:from) && hash[:from].nil? and return nil
-        !hash[:from] and return hash
-        hash[:to] && hash[:to] != hash[:from] and
-          return "#{hash[:from]}&#x2013;#{hash[:to]}"
-        hash[:from]
-      end
-
-      def sizeformat(size, hash)
-        return nil unless size
-
-        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, hash)
-            m
-          end
-        @r.sizetemplate.render(ret.merge(type: hash[:type]), hash)
-      end
-
-      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, context)
-        when "data" then hash[:data] = val
-        when "duration" then hash[:duration] = val
-        end
-      end
-
-      def pagevolformat(value, value_raw, type, is_size, hash)
-        value.nil? and return nil
-        num = "pl"
-        if is_size
-          value == "1" and num = "sg"
-        else
-          value_raw[:to] or num = "sg"
-        end
-        i = @r.i18n.select(hash)
-        i.l10n(i.get[is_size ? "size" : "extent"][type][num]
-        .sub("%", value))
-      end
-
-      def date_range(hash)
-        hash[:from] && !hash[:to] and return "#{hash[:from]}&#x2013;"
-        range(hash)
-      end
-
-      def dateformat(date, hash, type)
-        date.nil? and return nil
-        date.is_a?(String) and return date
-        %i(from to on).each do |k|
-          date[k] = @r.dateklass
-            .new(date[k], renderer: @r, bibitem: hash, type: type).render
-        end
-        date_range(date)
-      end
-
-      def uriformat(uri)
-        uri.nil? || uri.empty? and return nil
-        # do not process uri contents in l10n
-        "<fmt-link target='#{uri}'><esc>#{uri}</esc></fmt-link>"
-      end
-
-      private
-
-      def tw_cldr_lang
-        if @r.lang != "zh" then @r.lang.to_sym
-        elsif @r.script == "Hant" then :"zh-tw"
-        else :"zh-cn"
-        end
-      end
-    end
-  end
-end

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

@@ -1,178 +0,0 @@
-module Relaton
-  module Render
-    class Citations
-      def initialize(opt = {})
-        # 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
-
-      def renderer(_cite)
-        @renderer[:default]
-      end
-
-      # takes array of { id, type, author, date, ord, data }
-      def render(ret)
-        cites = citations(ret)
-        enhance_data(cites)
-        cites.each_key do |k|
-          cites[k] = render1(cites[k])
-        end
-        cites
-      end
-
-      def enhance_data(cites)
-        ret = extract_uris_for_lookup(cites)
-        ret.empty? and return
-        # functionality removed: date needs to be given explicitly
-        # @renderer.urls_exist_concurrent(ret.keys).each do |k, v|
-        # ret[k].each { |u| add_date_accessed(cites[u], k, v) }
-        # end
-      end
-
-      def extract_uris_for_lookup(cites)
-        cites.each_with_object({}) do |(k, v), m|
-          u = extract_uri_for_lookup(v) or next
-          m[u] ||= []
-          m[u] << k
-        end
-      end
-
-      def extract_uri_for_lookup(cite)
-        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) &&
-        c[:uri_raw] && !c[:date_accessed]) or return
-        c[:uri_raw]
-      end
-
-      def add_date_accessed(cite, uri, status)
-        r = renderer(cite)
-        if status
-          cite[:data][:date_accessed] = { on: ::Date.today.to_s }
-          cite[:data] = r.fieldsklass.new(renderer: r)
-            .compound_fields_format(cite[:data])
-        else
-          r.url_warn(uri)
-        end
-      end
-
-      def render1(cit)
-        ref, ref1, r = render1_prep(cit)
-        i = @i18n.select(cit[:data])
-        cit[:formattedref] =
-          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)
-        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 || "")
-          d = b[:data].merge(citestyle: "short")
-          b[:citation][:short] = i.l10n(renderer(b).citeshorttemplate.render(d, d))
-          citations_iterate_cite_styles(b, i)
-        end
-        ret
-      end
-
-      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 }
-      def disambig_author_date_citations(ret)
-        author_date_to_hash(suffix_date(sort_ord(author_date_breakdown(ret))))
-      end
-
-      def author_date_breakdown(ret)
-        ret.each_with_object({}) do |b, m|
-          m[b[:author]] ||= {}
-          m[b[:author]][b[:date]] ||= []
-          m[b[:author]][b[:date]] << b
-        end
-      end
-
-      def sort_ord(ret)
-        ret.each do |author, v|
-          v.each_key do |date|
-            ret[author][date].sort_by! { |a| a[:ord] }
-          end
-        end
-      end
-
-      def suffix_date(ret)
-        ret.each do |k, v|
-          v.each do |k1, v1|
-            s =  v1.reject { |b| b[:date].nil? }.size
-            s.zero? || k.nil? and next
-            suffix_date1(ret, k, k1, s)
-            copy_date_fields(ret, k, k1)
-          end
-        end
-        ret
-      end
-
-      def suffix_date1(ret, key1, key2, size)
-        size > 1 or return
-        ret[key1][key2].each_with_index do |b, i|
-          b[:date].nil? and next
-          b[:disambiguated_date] = b[:date] + ("a".ord + i).chr.to_s
-        end
-      end
-
-      def copy_date_fields(ret, key1, key2)
-        ret[key1][key2].each do |b|
-          b[:date].nil? and next
-          b[:data][:date] = b[:date]
-          b[:disambiguated_date] ||= b[:date]
-          b[:data][:disambiguated_date] = b[:disambiguated_date]
-        end
-      end
-
-      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.select(b[:data]).l10n(b[:author]),
-                            date: b[:disambiguated_date] || b[:date],
-                            citation: {},
-                            data: b[:data], type: b[:type] }
-            end
-          end
-        end
-      end
-    end
-  end
-end