relaton-render 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ae7431472a2a411d6fbb2e0d68e7a8b32c647cf839886c347e34000576a11c
-  data.tar.gz: 5ede0d93ad108c2add767f4b9a5cec9b483ee9a1b6dd2db60ef51ee2959e65ab
+  metadata.gz: 6b7a094cb951866a90ce67736e150d7723366ad8f4693ac62de82fbd90fccbdc
+  data.tar.gz: 5041e1e397d38d30c6e48b06fa0b78e09afb987c519393c7ba771a892cfb653f
 SHA512:
-  metadata.gz: 0a2c1ff06584f6dddaedd7fab2d58467f3f4e54330107ff300529f26094f67331d09a19838743185af859c9d1deadbe4219ecec1e562f23bd320d87d4359bc1d
-  data.tar.gz: 2da0c615b6cb5a610d9d4d14c892d22131eb3317595b5b2e131baf7d8f985cb0a8fc76a66f22ab550fc83b37005d9b29c6817ded7bc0b0b50ef3519a1c6ea769
+  metadata.gz: 758a2f69ce87e0b258a0e7f5920f29f347a9fd311a11bb31199baaaaa8f7cd4d6fc46fcfdad5b8567072372b908a13fd1b1816056da0967cefb90bf6b79f0e84
+  data.tar.gz: a0fcbecba3f10f74b5a4dbd8ca056554c19527e5fa0277b39b007102cec98121bdfda1bc6211aa12cc8d69afbdc5e602a862015153e30b1658b4bb2a37e6f244

data/README.adoc

@@ -90,6 +90,11 @@ if called with `type: "author-date"`.
 The author and date are differentiated so that consumers can separate them in citations -- e.g. "Jones (1996) claims", 
 "(Jones 1996, 1997)".
 
+=== Parsing single reference
+
+Given an Relaton bibitem object (or equivalent Relaton XML), `parse(input)` will output the hash of fields that is passed into the
+Liquid templates described below for rendering: it is the hash of bibliographic fields extracted by the gem.
+
 == Configuration
 
 === Templates

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

@@ -14,6 +14,7 @@ date_formats:
   date_time: to_long_s
 ordinal_keys: []
 OrdinalRules: digits-ordinal
+SpelloutRules: spellout-ordinal
 edition_ordinal: "第{{ var1 | ordinal_num: '', '' }}版"
 edition: 版
 draft: "草案%"

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

@@ -23,6 +23,7 @@ module Relaton
         root_initalize(options)
         render_initialize(options)
         @parse ||= options["parse"]
+        @urlcache = {}
       end
 
       def read_config
@@ -108,22 +109,23 @@ module Relaton
       end
 
       def render(bib, embedded: false)
-        if bib.is_a?(String) && Nokogiri::XML(bib).errors.empty?
-          bib = RelatonBib::XMLParser.from_xml bib
-        end
-        parse(bib, embedded: embedded)
+        bib = xml2relaton(bib)
+        f = bib.formattedref and
+          return embedded ? f.content : fmtref(f.content)
+        ret = render1(bib) or return nil
+        embedded and return ret
+        fmtref(ret)
       end
 
-      def fmtref(doc)
-        "<formattedref>#{doc}</formattedref>"
+      def xml2relaton(bib)
+        bib.is_a?(Nokogiri::XML::Element) and
+          bib = bib.to_xml
+        bib.is_a?(String) && Nokogiri::XML(bib).errors.empty? and
+          bib = RelatonBib::XMLParser.from_xml(bib) or bib
       end
 
-      def parse(doc, embedded: false)
-        f = doc.formattedref and
-          return embedded ? f.content : fmtref(f.content)
-        ret = parse1(doc) or return nil
-        embedded and return ret
-        fmtref(ret)
+      def fmtref(doc)
+        "<formattedref>#{doc}</formattedref>"
       end
 
       def renderer(type)
@@ -135,20 +137,30 @@ module Relaton
         ret
       end
 
-      def parse1(doc)
+      def render1(doc)
         r = doc.relation.select { |x| x.type == "hasRepresentation" }
-          .map { |x| @i18n.also_pub_as + parse_single_bibitem(x.bibitem) }
-        out = [parse_single_bibitem(doc)] + r
+          .map { |x| @i18n.also_pub_as + render_single_bibitem(x.bibitem) }
+        out = [render_single_bibitem(doc)] + r
         @i18n.l10n(out.join(". ").gsub(".. ", ". "))
       end
 
-      def parse_single_bibitem(doc)
+      def render_single_bibitem(doc)
+        data_liquid, r = parse(doc)
+        liquid(data_liquid, r)
+      end
+
+      def liquid(data_liquid, renderer)
+        valid_parse(@i18n.l10n(renderer.render(data_liquid)))
+      end
+
+      def parse(doc)
+        doc = xml2relaton(doc)
         r = renderer(doc.type || "misc")
         data = @parse.extract(doc)
         enhance_data(data, r.template_raw)
         data_liquid = @fieldsklass.new(renderer: self)
           .compound_fields_format(data)
-        valid_parse(@i18n.l10n(r.render(data_liquid)))
+        [data_liquid, r]
       end
 
       def valid_parse(ret)
@@ -214,20 +226,32 @@ module Relaton
       end
 
       def url_exist?(url_string)
-        res = access_url(url_string)
+        url = URI.parse(url_string)
+        url.host or return true # allow file URLs
+        res = access_url(url) or return false
         res.is_a?(Net::HTTPRedirection) and return url_exist?(res["location"])
         res.code[0] != "4"
       rescue Errno::ENOENT, SocketError
         false # false if can't find the server
       end
 
-      def access_url(url_string)
-        url = URI.parse(url_string)
-        req = Net::HTTP.new(url.host, url.port)
-        req.use_ssl = (url.scheme == "https")
+      def access_url(url)
         path = url.path or return false
         path.empty? and path = "/"
-        req.request_head(path)
+        @urlcache.key?(url.to_s) and return @urlcache[url.to_s]
+        @urlcache[url.to_s] = url_head(url, path)
+        @urlcache[url.to_s]
+      rescue => e
+        warn e.backtrace
+        false
+      end
+
+      def url_head(url, path)
+        Net::HTTP.start(url.host, url.port,
+                        read_timeout: 2, open_timeout: 2,
+                        use_ssl: url.scheme == "https") do |http|
+          http.request_head(path)
+        end
       end
     end
   end

data/lib/relaton/render/parse/parse.rb

@@ -2,6 +2,7 @@ require "nokogiri"
 require "twitter_cldr"
 require_relative "parse_contributors"
 require_relative "parse_extract"
+require_relative "parse_id"
 
 module Relaton
   module Render
@@ -65,6 +66,12 @@ module Relaton
           series_org: series_org(series, doc),
           series_dates: series_dates(series, doc) }
       end
+
+      private
+
+      def blank?(text)
+        text.nil? || text.empty?
+      end
     end
   end
 end

data/lib/relaton/render/parse/parse_contributors.rb

@@ -61,8 +61,7 @@ module Relaton
       end
 
       def contributor_role(contributors)
-        return nil unless contributors.length.positive?
-
+        contributors.length.positive? or return nil
         desc = contributors[0].role.first.description.join("\n")
         type = contributors[0].role.first.type
         desc.empty? ? type : desc
@@ -80,12 +79,10 @@ module Relaton
 
       def creatornames1(doc)
         cr = []
-        return [] if doc.nil?
-
+        doc.nil? and return []
         creatornames_roles_allowed.each do |r|
           add = pick_contributor(doc, r)
-          next if add.nil?
-
+          add.nil? and next
           cr = add and break
         end
         cr.nil? and cr = doc.contributor
@@ -93,14 +90,12 @@ module Relaton
       end
 
       def datepick(date)
-        return nil if date.nil?
-
+        date.nil? and return nil
         on = date.on
         from = date.from
         to = date.to
-        return { on: on } if on
-        return { from: from, to: to } if from
-
+        on and return { on: on }
+        from and return { from: from, to: to }
         nil
       end
 
@@ -165,6 +160,13 @@ module Relaton
         x.nil? and return nil
         x.map { |c| extractname(c) }
       end
+
+      def pick_contributor(doc, role)
+        ret = doc.contributor.select do |c|
+          c.role.any? { |r| r.type == role }
+        end
+        ret.empty? ? nil : ret
+      end
     end
   end
 end

data/lib/relaton/render/parse/parse_extract.rb

@@ -17,7 +17,6 @@ module Relaton
 
       def medium(doc, host)
         x = doc.medium || host&.medium or return nil
-
         %w(content genre form carrier size scale).each_with_object({}) do |i, m|
           m[i] = x.send i
         end.compact
@@ -47,10 +46,11 @@ module Relaton
       end
 
       def place1(place)
-        place.city.nil? && place.region.empty? && place.country.empty? and
-          return place.name
-        ret = [place.city] + place.region.map(&:name) +
-          place.country.map(&:name)
+        c = place.city
+        r = place.region
+        n = place.country
+        c.nil? && r.empty? && n.empty? and return place.name
+        ret = [c] + r.map(&:name) + n.map(&:name)
         @i18n.l10n(ret.compact.join(", "))
       end
 
@@ -105,68 +105,6 @@ module Relaton
         "#{f}–#{t}"
       end
 
-      def authoritative_identifier(doc)
-        out = doc.docidentifier.each_with_object([]) do |id, ret|
-          id.primary && !authoritative_identifier_exclude.include?(id.type) and
-            ret << id.id
-        end
-        out.empty? and out = doc.docidentifier.each_with_object([]) do |id, ret|
-          authoritative_identifier_exclude.include?(id_type_norm(id)) or
-            ret << id.id
-        end
-        out
-      end
-
-      def authoritative_identifier_exclude
-        %w(metanorma metanorma-ordinal) + other_identifier_include
-      end
-
-      def other_identifier(doc)
-        doc.docidentifier.each_with_object([]) do |id, ret|
-          type = id_type_norm(id)
-          other_identifier_include.include? type or next
-          ret << @i18n.l10n("#{type}: #{id.id}")
-        end
-      end
-
-      def other_identifier_include
-        %w(ISSN ISBN DOI)
-      end
-
-      def doi(doc)
-        out = doc.docidentifier.each_with_object([]) do |id, ret|
-          type = id.type&.sub(/^(DOI)\..*$/i, "\\1") or next
-          type.casecmp("doi").zero? or next
-          ret << id.id
-        end
-        out.empty? ? nil : out
-      end
-
-      def id_type_norm(id)
-        id.type&.sub(/^(ISBN|ISSN)\..*$/i) { $1.upcase }
-      end
-
-      def uri(doc)
-        uri = nil
-        %w(citation uri src).each do |t|
-          uri = uri_type_select(doc, t) and break
-        end
-        uri ||= doc.link.detect do |u|
-          u.language == @lang && !u.type&.casecmp("doi")&.zero?
-        end
-        uri ||= doc.link.detect { |u| !u.type&.casecmp("doi")&.zero? }
-        uri or return nil
-        uri.content.to_s.strip
-      end
-
-      def uri_type_select(doc, type)
-        uri = doc.link.detect do |u|
-          u.type&.downcase == type && u.language == @lang
-        end and return uri
-        uri = doc.link.detect { |u| u.type&.downcase == type } and return uri
-        nil
-      end
-
       def access_location(doc, host)
         x = doc.accesslocation || host&.accesslocation or
           return nil
@@ -192,6 +130,13 @@ module Relaton
         end
       end
 
+      def localized_string_or_text(str)
+        case str
+        when RelatonBib::LocalizedString then content(str)
+        when String then str
+        end
+      end
+
       def extent(doc)
         doc.extent.each_with_object([]) do |e, acc|
           case e
@@ -209,34 +154,13 @@ module Relaton
       end
 
       def iter_ordinal(doc)
-        return nil unless iter = doc&.status&.iteration
-
+        iter = doc&.status&.iteration or return nil
         iter
       end
 
       def status(doc)
         doc&.status&.stage&.value
       end
-
-      private
-
-      def blank?(text)
-        text.nil? || text.empty?
-      end
-
-      def pick_contributor(doc, role)
-        ret = doc.contributor.select do |c|
-          c.role.any? { |r| r.type == role }
-        end
-        ret.empty? ? nil : ret
-      end
-
-      def localized_string_or_text(str)
-        case str
-        when RelatonBib::LocalizedString then content(str)
-        when String then str
-        end
-      end
     end
   end
 end

data/lib/relaton/render/parse/parse_id.rb

@@ -0,0 +1,119 @@
+module Relaton
+  module Render
+    class Parse
+      # filter applied across full list of auth_id
+      def auth_id_filter(ids)
+        id_scope_filter(ids)
+      end
+
+      def id_scope_filter(ids)
+        ids.detect(&:scope) or return ids
+        id_sort_by_scope(ids).each_with_object([]) do |(k, v), m|
+          case k
+          when "IEEE"
+            m << id_extract_by_scope(v, "trademark")
+          else
+            m << id_extract_by_scope(v, nil)
+          end
+        end.flatten
+      end
+
+      def id_sort_by_scope(ids)
+        ids.each_with_object({}) do |i, m|
+          m[i.type] ||= {}
+          m[i.type][i.scope] ||= []
+          m[i.type][i.scope] << i
+        end
+      end
+
+      def id_extract_by_scope(idents, key)
+        if idents.key?(key) && idents.keys.size > 1
+          idents[key]
+        else
+          idents.each_with_object([]) { |(_, v), m| m << v }.flatten
+        end
+      end
+
+      # list of successive filters on individual auth_id instances
+      def auth_id_allow
+        [->(x) { x.language == @lang && x.primary },
+         ->(x) { x.primary },
+         ->(x) { x.language == @lang },
+         ->(_x) { true }]
+      end
+
+      def authoritative_identifier(doc)
+        out = []
+        [auth_id_filter(doc.docidentifier), doc.docidentifier].each do |a|
+          out = authoritative_identifier_select(a)
+          out.empty? or break
+        end
+        out.map(&:id)
+      end
+
+      def authoritative_identifier_select(idents)
+        out = []
+        auth_id_allow.each do |p|
+          out = idents.select do |x|
+            p.call(x) &&
+              !authoritative_identifier_exclude.include?(id_type_norm(x))
+          end
+          out.empty? or break
+        end
+        out
+      end
+
+      def authoritative_identifier_exclude
+        %w(METANORMA METANORMA-ORDINAL) + other_identifier_include
+      end
+
+      def other_identifier(doc)
+        doc.docidentifier.each_with_object([]) do |id, ret|
+          type = id_type_norm(id)
+          other_identifier_include.include? type or next
+          ret << @i18n.l10n("#{type}: #{id.id}")
+        end
+      end
+
+      def other_identifier_include
+        %w(ISSN ISBN DOI)
+      end
+
+      def doi(doc)
+        out = doc.docidentifier.each_with_object([]) do |id, ret|
+          type = id.type&.sub(/^(DOI)\..*$/i, "\\1") or next
+          type.casecmp("doi").zero? or next
+          ret << id.id
+        end
+        out.empty? ? nil : out
+      end
+
+      def id_type_norm(id)
+        id.type or return nil
+        m = /^(ISBN|ISSN)\./i.match(id.type) or return id.type.upcase
+        m[1].upcase
+      end
+
+      def uri(doc)
+        uri = nil
+        %w(citation uri src).each do |t|
+          uri = uri_type_select(doc, t) and break
+        end
+        uri ||= doc.link.detect do |u|
+          u.language == @lang && !u.type&.casecmp("doi")&.zero?
+        end
+        uri ||= doc.link.detect { |u| !u.type&.casecmp("doi")&.zero? }
+        uri or return nil
+        uri.content.to_s.strip
+      end
+
+      def uri_type_select(doc, type)
+        uri = doc.link.detect do |u|
+          u.type&.downcase == type && u.language == @lang
+        end and return uri
+        uri = doc.link.detect { |u| u.type&.downcase == type } and return uri
+        nil
+      end
+    end
+  end
+end

data/lib/relaton/render/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Render
-    VERSION = "0.7.0".freeze
+    VERSION = "0.7.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-render
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -216,6 +216,7 @@ files:
 - 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/liquid.rb
 - lib/relaton/render/template/template.rb
 - lib/relaton/render/utils/utils.rb