relaton-render 0.1.0 → 3.0.0.pre.alpha.25

data/lib/parse/parse.rb

@@ -1,54 +0,0 @@
-require "nokogiri"
-require "twitter_cldr"
-require_relative "parse_contributors"
-require_relative "parse_extract"
-
-class Iso690Parse
-  def initialize; end
-
-  def extract(doc)
-    host = doc.at("./relation[@type = 'includedIn']/bibitem")
-    simple_xml2hash(doc).merge(simple_or_host_xml2hash(doc, host))
-      .merge(host_xml2hash(host))
-      .merge(series_xml2hash(doc, host))
-  end
-
-  def simple_xml2hash(doc)
-    creators, role = creatornames(doc)
-    { type: type(doc), title: title(doc), extent_raw: extent(doc),
-      standardidentifier: standardidentifier(doc), uri: uri(doc),
-      status: status(doc), creators: creators, role_raw: role }
-  end
-
-  def simple_or_host_xml2hash(doc, host)
-    { edition_raw: edition(doc, host), medium: medium(doc, host),
-      place: place(doc, host), publisher: publisher(doc, host),
-      distributor: distributor(doc, host),
-      access_location: access_location(doc, host),
-      date: date(doc, host), date_updated: date_updated(doc, host),
-      date_accessed: date_accessed(doc, host) }
-  end
-
-  def host_xml2hash(host)
-    creators, role = creatornames(host)
-    { host_creators: creators, host_role_raw: role, host_title: title(host) }
-  end
-
-  def series_xml2hash(doc, host)
-    series = doc.at("./series[@type = 'main']") ||
-      doc.at("./series[not(@type)]") || doc.at("./series")
-    host and series ||=
-               host.at("./series[@type = 'main']") ||
-               host.at("./series[not(@type)]") || host.at("./series")
-
-    series_xml2hash1(series)
-  end
-
-  def series_xml2hash1(series)
-    return {} unless series
-
-    { series_title: series_title(series), series_abbr: series_abbr(series),
-      series_run: series_run(series), series_num: series_num(series),
-      series_partnumber: series_partnumber(series) }
-  end
-end

data/lib/parse/parse_contributors.rb

@@ -1,96 +0,0 @@
-class Iso690Parse
-  def extract_orgname(org)
-    name = org.at("./name")
-    name&.text
-  end
-
-  def extract_personname(person)
-    surname = person.at("./name/surname") || person.at("./name/completename")
-    given, middle, initials = given_and_middle_name(person)
-    { surname: surname&.text,
-      given: given,
-      middle: middle,
-      initials: initials }
-  end
-
-  def given_and_middle_name(person)
-    forenames = person.xpath("./name/forename")&.map(&:text)
-    initials = person.xpath("./name/initial")&.map(&:text)
-    forenames.empty? and initials.empty? and return [nil, nil, nil]
-    forenames.empty? and forenames = initials.dup
-    initials.empty? and initials = forenames.map { |x| x[0] }
-    [forenames.first, forenames[1..-1], initials]
-  end
-
-  def extractname(contributor)
-    org = contributor.at("./organization")
-    person = contributor.at("./person")
-    return { surname: extract_orgname(org) } if org
-    return extract_personname(person) if person
-
-    nil
-  end
-
-  def contributor_role(contributors)
-    return nil unless contributors.length.positive?
-
-    desc = contributors[0].at("role/description")&.text
-    type = contributors[0].at("role/@type")&.text
-    return nil if %w(author publisher).include?(type) && desc.nil?
-
-    type
-  end
-
-  def creatornames(doc)
-    cr = creatornames1(doc)
-    cr.empty? and return [nil, nil]
-    [cr.map { |x| extractname(x) }, contributor_role(cr)]
-  end
-
-  def creatornames1(doc)
-    cr = []
-    return cr if doc.nil?
-
-    %w(author performer adapter translator editor publisher distributor)
-      .each do |r|
-        add = doc.xpath("./contributor[role/@type = '#{r}']")
-        next if add.empty?
-
-        cr = add and break
-      end
-    cr.empty? and cr = doc.xpath("./contributor")
-    cr
-  end
-
-  def date1(date)
-    on = date.at("./on")
-    from = date.at("./from")
-    to = date.at("./to")
-    return { on: on.text } if on
-    return { from: from.text, to: to&.text } if from
-
-    nil
-  end
-
-  def date(doc, host)
-    x = doc.at("./date[@type = 'issued']") ||
-      doc.at("./date[@type = 'circulated']") ||
-      doc.at("./date") ||
-      host&.at("./date[@type = 'issued']") ||
-      host&.at("./date[@type = 'circulated']") ||
-      host&.at("./date") or return nil
-    date1(x)
-  end
-
-  def date_updated(doc, host)
-    x = doc.at("./date[@type = 'updated']") ||
-      host&.at("./date[@type = 'updated']") or return nil
-    date1(x)
-  end
-
-  def date_accessed(doc, host)
-    x = doc.at("./date[@type = 'accessed']") ||
-      host&.at("./date[@type = 'accessed']") or return nil
-    date1(x)
-  end
-end

data/lib/parse/parse_extract.rb

@@ -1,155 +0,0 @@
-class Iso690Parse
-  def title(doc)
-    doc&.at("./title")&.text
-  end
-
-  def medium(doc, host)
-    x = doc.at("./medium") || host&.at("./medium") or return nil
-
-    %w(content genre form carrier size scale).each_with_object([]) do |i, m|
-      m << x.at("./#{i}")&.text
-    end.compact.join(", ")
-  end
-
-  def blank?(text)
-    text.nil? || text.empty?
-  end
-
-  def edition(doc, host)
-    x = doc.at("./edition") || host&.at("./edition") or return nil
-
-    x.text
-  end
-
-  def place(doc, host)
-    x = doc.at("./place") || host&.at("./place") or return nil
-
-    x.text
-  end
-
-  def publisher(doc, host)
-    x = doc.at("./contributor[role/@type = 'publisher']/organization/name") ||
-      host&.at("./contributor[role/@type = 'publisher']/organization/name") or
-      return nil
-    x.text
-  end
-
-  def distributor(doc, host)
-    x = doc.at("./contributor[role/@type = 'distributor']/organization/name") ||
-      host&.at("./contributor[role/@type = 'distributor']/organization/name") or
-      return nil
-    x.text
-  end
-
-  def series_title(doc)
-    doc&.at("./title")&.text || doc&.at("./formattedref")&.text
-  end
-
-  def series_abbr(doc)
-    doc&.at("./abbreviation")&.text
-  end
-
-  def series_num(doc)
-    doc&.at("./number")&.text
-  end
-
-  def series_partnumber(doc)
-    doc&.at("./partnumber")&.text
-  end
-
-  def series_run(doc)
-    doc&.at("./run")&.text
-  end
-
-  def standardidentifier(doc)
-    doc.xpath("./docidentifier").each_with_object([]) do |id, ret|
-      ret << id.text unless %w(metanorma metanorma-ordinal).include? id["type"]
-    end
-  end
-
-  def uri(doc)
-    uri = doc.at("./uri[@type = 'doi']") || doc.at("./uri[@type = 'uri']") ||
-      doc.at("./uri[@type = 'src']") || doc.at("./uri")
-    uri&.text
-  end
-
-  def access_location(doc, host)
-    x = doc.at("./accessLocation") || host&.at("./accessLocation") or
-      return nil
-    x.text
-  end
-
-  def included(type)
-    ["article", "inbook", "incollection", "inproceedings"].include? type
-  end
-
-  def wrap(text, startdelim = " ", enddelim = ".")
-    return "" if blank?(text)
-
-    "#{startdelim}#{text}#{enddelim}"
-  end
-
-  def type(doc)
-    type = doc.at("./@type") and return type&.text
-    doc.at("./relation[@type = 'includedIn']") and return "inbook"
-    "book"
-  end
-
-  def extent1(localities)
-    localities.each_with_object({}) do |l, ret|
-      ret[(l["type"] || "page").to_sym] = {
-        from: l.at("./referenceFrom")&.text,
-        to: l.at("./referenceTo")&.text,
-      }
-    end
-  end
-
-  def extent0(elem, acc, ret1)
-    case elem.name
-    when "localityStack"
-      acc << ret1
-      ret1 = {}
-      acc << extent1(elem.elements)
-    when "locality" then ret1.merge!(extent1([elem]))
-    when "referenceFrom" then ret1.merge!(extent1([elem.parent]))
-    end
-    [acc, ret1]
-  end
-
-  def extent(doc)
-    ret1 = {}
-    ret = doc.xpath("./extent").each_with_object([]) do |e, acc|
-      e.elements.each do |l|
-        acc, ret1 = extent0(l, acc, ret1)
-        break if l.name == "referenceFrom"
-      end
-    end
-    ret << ret1
-    ret.reject(&:empty?)
-  end
-
-  def draft(doc)
-    dr = doc&.at("./status/stage")&.text
-
-    iterord = iter_ordinal(doc)
-    status = status_print(dr)
-    status = "#{iterord} #{status}" if iterord
-    status
-  end
-
-  def iter_ordinal(isoxml)
-    return nil unless isoxml.at(("./status/iteration"))
-
-    iter = isoxml.at(("./status/iteration"))&.text || "1"
-    iter.to_i.localize.to_rbnf_s("SpelloutRules",
-                                 "spellout-ordinal").capitalize
-  end
-
-  def status_print(status)
-    status
-  end
-
-  def status(doc)
-    doc&.at("./status/stage")&.text
-  end
-end

data/lib/relaton/config.yml

@@ -1,67 +0,0 @@
-nametemplate:
-  one: "{{surname[0] | upcase }}, {{given[0]}} {{middle[0}}"
-  two: "{{surname[0] | upcase}}, {{given[0]}} {{middle[0]}} {{ labels['and'] }} {{given[1]}} {{middle[1]}} {{surname[1] | upcase}}"
-  more: "{{surname[0] | upcase}}, {{given[0]}} {{middle[0}} , {{given[1]}} {{middle[1]}} {{surname[1] | upcase}} {{ labels['and'] }} {{given[2]}} {{middle[2]}} {{surname[2] | upcase}}"
-# disabled the following: they should be provided in inheriting calls
-# etal: "{{surname[0] | upcase}}, {{given[0]}} {{middle[0]}}, {{given[1]}} {{middle[1]}} {{surname[1] | upcase}} <em>et al.</em>"
-# etal_count: 5
-seriestemplate: "{% if series_abbr %}{{series_abbr}}{% else %}{{series_title}}{% endif %} ({{series_run}}) {{series_num}}|({{series_partnumber}})"
-journaltemplate: "<em>{% if series_abbr %}{{series_abbr}}{% else %}{{series_title}}{% endif %}</em> ({{series_run}}) {{ labels['volume'] }}_{{series_num}} {{ labels['part'] }}_{{series_partnumber}}"
-extenttemplate:
-  book: "{{ volume }}_{{ labels['extent']['volume'] }}, {{ page }}_{{ labels['extent']['page'] }}"
-  booklet: book
-  proceedings: book
-  journal: book
-  standard: book
-  techreport: book
-  inbook: "{{ volume }}: {{ page }}"
-  misc: "{{ labels['extent']['volume'] }}_{{ volume }}, {{ labels['extent']['page'] }}_{{ page }}"
-  # TODO: software extent
-language: en
-script: Latn
-template:
-  book: "{{ creatornames }} ({{role}}) . <em>{{ title }}</em> [{{medium}}] . {{ edition | capitalize }}. ({{ series }}.) {{place}}: {{publisher}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ standardidentifier | first }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]. {{extent}}."
-    # TODO: omitted: author ids, subsidiary titles, subsidiary creators, rights metadata, distributor, item attributes, relationships
-  booklet: book
-  manual: book
-  proceedings: book
-  inbook: "{{ creatornames }} ({{role}}) . {{ title }} . {{ labels['in'] | capitalize }}: {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em> [{{medium}}] . {{ edition | capitalize }}. ({{ series }}.) {{place}}: {{publisher}}. {{date}}. {{extent}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ standardidentifier | first }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
-  inproceedings: inbook
-  incollection: inbook
-    # TODO: omitted: author ids, additional info for component part, subsidiary titles of host resource, rights metadata, distributor, relationships
-  journal: "<em>{{ title}}</em> [{{medium}}] . {{ edition | capitalize }}. {{place}}: {{publisher}}. {{date}}. {{extent}}. {{ standardidentifier | first }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
-    # TODO subsidiary titles, rights metadata, item attributes, relationships
-  article: "{{ creatornames }} ({{role}}) . {{ title }}. {{ series }} [{{medium}}] . {{ edition | capitalize }}. {{ extent }}. {{place}}: {{publisher}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ standardidentifier | first }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
-    # TODO: omitted: author ids, subsidiary titles, rights metadata, distributor, item attributes, relationships; newspapers
-  software: "{{ creatornames }} ({{ role}}) . <em>{{ title }}</em> . {{ labels['version'] | capitalize }}_{{ edition_raw }}. {{medium | capitalize}}. {{place}}: {{publisher}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ standardidentifier | first }}. {{ uri }}. {{ extent}}. [{{ labels['viewed'] }}:_{{date_accessed}}]. "
-    # TODO: omitted: author ids, subsidiary titles, subsidiary creators, copyright, license, distributor, system requirements, relationships
-  electronic resource:  software
-  standard: "{{ creatornames }} ({{ role}}) . <em>{{ title }}</em> . {{ labels['in'] | capitalize }}:_{{ series_title }}. {{ medium | capitalize }}. {{ edition | capitalize }}. {{place}}: {{publisher}}. {{date}}. {{ extent }}. {{ standardidentifier | first }}. {{ uri }}. {{ labels['at'] | capitalize}}:_{{ access_location }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
-    # TODO: omitted: author ids, subsidiary titles, rights metadata, distributor, persistent identifier, item attributes, relationships
-  techreport: standard
-  dataset: "{{ creatornames }} ({{ role }}) . <em>{{ title }}</em> . {{ labels['version'] | capitalize }}_{{ edition_raw }}. {{medium | capitalize }}. {{ labels['in'] | capitalize }}:_{{series}}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ standardidentifier | first }}. {{ uri }}. {{ extent}}. [{{ labels['viewed'] }}:_{{date_accessed}}]. "
-    # TODO: omitted: author ids, system requirements, host archive, copyright, license, data source, distributor, usage instructions, relationships, provenance
-  website: "{{ creatornames }} ({{ role }}) . <em>{{ title }}</em> . {{ labels['version'] | capitalize }}_{{ edition_raw }}. {{medium | capitalize }}. {{ place }}: {{ publisher }}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ standardidentifier | first }}. {{ uri }}. [{{ labels['viewed'] }}:_{{date_accessed}}]. "
-    # TODO: omitted: author ids, page title, system requirements, subsidiary creator, rights metadata, distributor, persistent identifier, archive location, archive date and time, relationships
-  webresource: website
-    # TODO: component part
-  unpublished: "{{ creatornames }} ({{ role }}) . <em>{{ title }}</em> . {{ medium | capitalize }}. {{ date }}. {{ labels['at'] | capitalize}}:_{{ access_location }}.  {{ standardidentifier | first }}. {{ uri }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
-    # TODO: omitted: author ids, subsidiary titles, subsidiary creators, host archive, item attributes, relationships
-  presentation: unpublished
-  thesis: "{{ creatornames }} ({{ role }}) . <em>{{ title }}</em> . {{ medium | capitalize }}. {{ place }}: {{ publisher }}. {{ date }}. {{ labels['at'] | capitalize}}:_{{ access_location }}.  {{ standardidentifier | first }}. {{ uri }}. [{{ labels['viewed'] }}:_{{date_accessed}}]."
-  # unsupported types:
-  # map: ""
-  # audiovisual: ""
-  # film: ""
-  # video: ""
-  # broadcast: ""
-  # graphic_work: ""
-  # music: ""
-  # performance: "" (not in Relaton)
-  # patent: ""
-  # archival: ""
-  # social_media: ""
-  # alert: ""
-  # message: ""
-  # conversation: ""
-  # misc: ""

data/lib/relaton/render.rb

@@ -1,123 +0,0 @@
-require_relative "render_classes"
-require_relative "render_fields"
-require "yaml"
-require "liquid"
-require_relative "../isodoc/i18n"
-require_relative "../utils/utils"
-
-module Relaton
-  module Render
-    class General
-      attr_reader :template, :journaltemplate, :seriestemplate, :nametemplate,
-                  :extenttemplate, :lang, :script, :edition, :edition_number,
-                  :date
-
-      def initialize(opt = {})
-        options = YAML.load_file(File.join(File.dirname(__FILE__),
-                                           "config.yml"))
-          .merge(Utils::string_keys(opt))
-        @type = self.class.name.downcase.sub(/relaton::render::/, "")
-        root_initalize(options)
-        render_initialize(options)
-        @parse ||= options["parse"]
-        @i18n ||= options["i18n"]
-      end
-
-      def root_initalize(opt)
-        i18n_initialize(opt)
-        @parse = Iso690Parse.new
-        @nametemplate = Iso690NameTemplate
-          .new(template: opt["nametemplate"], i18n: @i18n)
-        @seriestemplate = Iso690SeriesTemplate
-          .new(template: opt["seriestemplate"], i18n: @i18n)
-        @journaltemplate = Iso690SeriesTemplate
-          .new(template: opt["journaltemplate"], i18n: @i18n)
-        @extenttemplate = extentrenderers(opt)
-      end
-
-      def i18n_initialize(opt)
-        @lang = opt["language"]
-        @script = opt["script"]
-        @i18n = i18n(opt["language"], opt["script"])
-        @edition_number = opt["edition_number"] || @i18n.edition_number
-        @edition = opt["edition"] || @i18n.edition
-        @date = opt["date"] || @i18n.date
-      end
-
-      def render_initialize(opt)
-        case opt["template"]
-        when String
-          @template = Iso690Template.new(template: opt["template"],
-                                         i18n: @i18n)
-        when Hash
-          @render = renderers(opt)
-        end
-      end
-
-      def renderers(opt)
-        template_hash_fill(opt["template"]).each_with_object({}) do |(k, v), m|
-          @type == "general" || @type == k or next
-          m[k] = General.subclass(k)
-            .new(template: v, parse: @parse, i18n: @i18n,
-                 language: @lang, script: @script)
-        end
-      end
-
-      def extentrenderers(opt)
-        Iso690ExtentTemplate
-          .new(template: template_hash_fill(opt["extenttemplate"]), i18n: @i18n)
-      end
-
-      def default_template
-        "{{creatornames}}. {{title}}. {{date}}."
-      end
-
-      def i18n(lang = "en", script = "Latn")
-        ::IsoDoc::I18n.new(lang, script)
-      end
-
-      def render(bib, embedded: false)
-        docxml = Nokogiri::XML(bib)
-        docxml.remove_namespaces!
-        parse(docxml.root, embedded: embedded)
-      end
-
-      def parse(doc, embedded: false)
-        f = doc.at("./formattedref") and
-          return embedded ? f.children.to_xml : doc.to_xml
-
-        ret = parse1(doc)
-        embedded and return ret
-        "<formattedref>#{ret}</formattedref>"
-      end
-
-      def renderer(doc)
-        unless ret = @template || @render[doc["type"]]&.template
-          raise "No renderer defined for #{doc['type']}"
-        end
-        unless @type == "general" || @type == doc["type"]
-          raise "No renderer defined for #{doc['type']}"
-        end
-
-        ret
-      end
-
-      def parse1(doc)
-        r = renderer(doc)
-        data = @parse.extract(doc)
-        data_liquid = Fields.new(renderer: self).compound_fields_format(data)
-        @i18n.l10n(r.render(data_liquid))
-      end
-
-      private
-
-      def template_hash_fill(templates)
-        BIBTYPE.each_with_object({}) do |type, m|
-          template = templates[type] || templates["misc"] || default_template
-          BIBTYPE.include?(template) and template = templates[template]
-          m[type] = template
-        end
-      end
-    end
-  end
-end

data/lib/relaton/render_classes.rb

@@ -1,126 +0,0 @@
-module Relaton
-  module Render
-    BIBTYPE =
-      %w(article book booklet manual proceedings presentation thesis techreport
-         standard unpublished map electronic_resource audiovisual film video
-         broadcast software graphic_work music patent inbook incollection
-         inproceedings journal website webresource dataset archival social_media
-         alert message conversation misc).freeze
-
-    class General
-      singleton_class.send(:attr_reader, :descendants)
-      @descendants = {}
-
-      def self.inherited(subclass) # rubocop:disable Lint/MissingSuper
-        type = subclass.name.downcase.sub(/relaton::render::/, "")
-        General.descendants[type] = subclass
-      end
-
-      def self.subclass(type)
-        @descendants[type]
-      end
-    end
-
-    class Book < General
-    end
-
-    class Journal < General
-    end
-
-    class Booklet < General
-    end
-
-    class Manual < General
-    end
-
-    class Proceedings < General
-    end
-
-    class Presentation < General
-    end
-
-    class Thesis < General
-    end
-
-    class Techreport < General
-    end
-
-    class Standard < General
-    end
-
-    class Unpublished < General
-    end
-
-    class Map < General
-    end
-
-    class Electronic_resource < General
-    end
-
-    class Software < Electronic_resource
-    end
-
-    class Webresource < Electronic_resource
-    end
-
-    class Website < Webresource
-    end
-
-    class Dataset < Electronic_resource
-    end
-
-    class Social_media < Electronic_resource
-    end
-
-    class Alert < Social_media
-    end
-
-    class Message < Social_media
-    end
-
-    class Audiovisual < General
-    end
-
-    class Film < Audiovisual
-    end
-
-    class Video < Audiovisual
-    end
-
-    class Broadcast < Audiovisual
-    end
-
-    class Graphic_work < General
-    end
-
-    class Music < General
-    end
-
-    class Patent < General
-    end
-
-    class Hosted < General
-    end
-
-    class Article < Hosted
-    end
-
-    class InBook < Hosted
-    end
-
-    class InCollection < Hosted
-    end
-
-    class InProceedings < Hosted
-    end
-
-    class Archival < General
-    end
-
-    class Conversation < General
-    end
-
-    class Misc < General
-    end
-  end
-end