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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 900cfb8e591fbbd83ee48c2dfa762a317a15c590fb89844b3ce7a759125d4f94
-  data.tar.gz: 29c15ba8cfe1e2dcfafc8d6a4d9985ed298c4515d4c734e3505dfcca9cb11189
+  metadata.gz: ecdbfb0b1c82700b6c957c9eeb259fd48f48d391a35062b07e4d6d6ede4ccb2e
+  data.tar.gz: 199330b061ce3e07eb3edff0364ffc313773eb27cf6f7b8d0a216bff4caa3cac
 SHA512:
-  metadata.gz: ebd7be4d34144997dcee8593266b75eefca1781341b4f081df290a9df64cbb7d665985c1bd0807c1036b190f68d6877b2bf822281bdc6e7c3a332fce349ac612
-  data.tar.gz: 8392d3b4d8c836b74cbf7a05435f55b274f24ae1004b247151481a34d86c104818926f3452c68f776a0adb521e9404b908f0d0fde25494014958bfd2c28005ac
+  metadata.gz: f21d46a60631252c2011e73096ea2ff321fae8f8f361c9e8bc46b53709d304da350bac73ab3eb44cdf7c5a4ec6a35c74f10875aa5548e417fc9c66afc43a8693
+  data.tar.gz: 2fac8549403467928c30917f75e167fba771a3f175c5128d9c2a1daab37cb813cd29b1feb493746559c985df068b68306d9cdd2cd1cb5fb63b82e0e79445a150

data/.github/workflows/rake.yml

@@ -8,8 +8,11 @@ on:
     tags: [ v* ]
   pull_request:
 
+permissions:
+  contents: write
+
 jobs:
   rake:
-    uses: metanorma/metanorma-build-scripts/.github/workflows/generic-rake.yml@main
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+jobs:
+  release:
+    uses: relaton/support/.github/workflows/release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.RELATON_CI_RUBYGEMS_API_KEY }}
+

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+.vscode/
+bin/rspec

data/.rubocop.yml

@@ -1,10 +1,10 @@
 # Auto-generated by Cimas: Do not edit it manually!
 # See https://github.com/metanorma/cimas
 inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
 
 # local repo-specific modifications
 # ...
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.4

data/Gemfile

@@ -3,6 +3,22 @@ Encoding.default_internal = Encoding::UTF_8
 
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
+
+group :development, :test do
+  gem "canon"
+  gem "relaton", ">= 3.0.0.pre.alpha", "< 4" # the model fixtures; the engine itself is model-agnostic
+  gem "debug"
+  gem "iso-690-test-suite", github: "relaton/iso-690-test-suite"
+  gem "rake", ">= 12.3.3"
+  gem "rspec", "~> 3.0"
+  gem "simplecov"
+end
+
+begin
+  eval_gemfile("Gemfile.devel")
+rescue StandardError
+  nil
+end

data/README.adoc

@@ -1,8 +1,8 @@
 = Relaton Render
 
-image:https://img.shields.io/gem/v/iso690render.svg["Gem Version", link="https://rubygems.org/gems/iso690render"]
-image:https://github.com/metanorma/iso690render/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/iso690render/actions?workflow=rake"]
-image:https://codeclimate.com/github/metanorma/iso690render/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/iso690render"]
+image:https://img.shields.io/gem/v/relaton-render.svg["Gem Version", link="https://rubygems.org/gems/relaton-render"]
+image:https://github.com/metanorma/relaton-render/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/relaton-render/actions?workflow=rake"]
+// image:https://codeclimate.com/github/metanorma/relaton-render/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/relaton-render"]
 
 Gem that takes a https://github.com/relaton/relaton[Relaton] bibliographic description and 
 a configuration, and generates a https://www.metanorma.org[Metanorma] XML rendering of that description.
@@ -13,15 +13,31 @@ a configuration, and generates a https://www.metanorma.org[Metanorma] XML render
 ----
 input = "<bibitem type='...'>....</bibitem>"
 
-Relaton::Render::General.new(template: ..., nametemplate: ..., seriestemplate: ..., language: "en", script: "Latn").render(input)
+r = Relaton::Render::General.new(template: ..., nametemplate: ..., seriestemplate: ..., language: "en", script: "Latn")
+
+r.render(input) == "Author1 and Author2 2000. Title &c."
+
+bibliography = "<references><bibitem id=''>...</bibitem>...<bibitem id=''>...</bibitem></references>"
+
+r.render_all(bibliography, type: "author-cite") ==
+
+{ bibitem["id"] :
+  { author: "Author1 and Author2",
+    date: "2000a",
+    citation: "Author1 and Author2 2000a",
+    formattedref: "Author1 and Author2 2000a. Title &c."
+  }
+}
 ----
 
+The gem processes either Relaton XML, or native Relaton classes.
+
 The gem is intended to be inherited from by Metanorma flavours, which may specialise it with their own
 code. The templates are however intended to determine much of the rendering.
 
-Gems can provide their configurations in YAML files, and parse them before passing them to the call to Iso690Render.
-The built-in values for Iso690Render are given in `/lib/iso690render/config.yml`, and can be overridden by
-the parameters of initialising Iso690Render.
+Gems can provide their configurations in YAML files, and parse them before passing them to the call to Relaton::Render.
+The built-in values for Relaton::Render are given in `/lib/relaton/render/general/config.yml`, and can be overridden by
+the parameters of initialising Relaton::Render.
 
 The parameters are:
 
@@ -29,213 +45,61 @@ The parameters are:
 `script`:: in ISO-15124
 `template`:: templates for rendering different bibliographic types
 `nametemplate`:: templates for rendering personal names
+`authorcitetemplate`:: templates for rendering names for the purpose of author-date citations
 `seriestemplate`:: template for rendering series
 `journaltemplate`:: template for rendering journals in article citations
 `extenttemplate`:: templates for rendering extents
-`edition_number`:: override formatting of edition number
-`edition`:: override formatting of edition 
+`sizetemplate`:: templates for rendering sizes
+`edition_ordinal`:: override formatting of edition with ordinal
 `date`:: default date format (from Twitter CLDR)
+`i18nhash`:: Metanorma internationalisation hash
 
-== Configuration
-
-=== Templates
-
-There is one template provided for each of the bibliographic types recognised by Relaton (`/bibitem/@type`), and a default template:
-
-Currently supported:
-
-* article 
-* book 
-* booklet 
-* manual 
-* proceedings 
-* presentation 
-* thesis 
-* techreport 
-* standard 
-* unpublished 
-* electronic resource 
-* inbook 
-* incollection 
-* inproceedings 
-* journal 
-* website
-* webresource
-* dataset
-
-Not currently supported:
-
-* map 
-* audiovisual 
-* film 
-* video 
-* broadcast 
-* software 
-* graphic_work 
-* music 
-* performance 
-* patent 
-* archival 
-* social_media 
-* alert 
-* message 
-* conversation 
-* misc (default)
-
-
-In Metanorma, not all types are used, but there are exemplars for all of these given on this site, following
-the human-readable style used in ISO 690. These can be overridden by supplying corresponding paramerers in the call
-to initialise Iso690Render.
-
-Each `template` is a string marked up with https://shopify.github.io/liquid/[Liquid Markup], with the following fields
-drawn from the bibliographic item:
-
-|===
-| Field   | Relaton XPath | Multiple | Can come from host | Note
-
-| title   | ./title | | |
-| edition | ./edition | | Y | If numeric value, is given internationalised rendering of "nth edition", as set in edition_numbering. Otherwise, the textual content of the tag is given.
-| edition_raw | ./edition | | Y | The strict textual content of the tag is given.
-| medium  | ./medium | | Y |
-| place   | ./place | | Y |
-| publisher | ./contributor[role/@type = 'publisher']/organization/name | | Y | 
-| distributor | ./contributor[role/@type = 'distributor']/organization/name | | Y | 
-| standardidentifier | ./docidentifier[not(@type = 'metanorma' or @type = 'ordinal')] | Y | |
-| status | ./status | | | Rendering varies by flavour
-| uri | ./uri[@type = 'doi' or @type = 'uri' or @type = 'src' or true] | | |
-| access_location | ./accessLocation | | Y |
-| extent | ./extent | Y | | Render with standard abbreviations for pp, vols, with n-dash, with delimiting of multiple locations
-| creatornames | ./contributor[role/@type = 'author'] \| ./contributor[role/@type = 'performer'] \| ./contributor[role/@type = 'adapter'] \| ./contributor[role/@type = 'translator'] \| ./contributor[role/@type = 'editor'] \| ./contributor[role/@type = 'publisher'] \| ./contributor[role/@type = 'distributor'] \| ./contributor | Y | | <<nametemplate,`nametemplate`>> applied to each name; joining template from internationalisation applied to multiple names
-| role | ./contributor[role/description] \| ./contributor[role/@type] | | | 
-| date | ./date[@type = 'issued'] \| ./date[@type = 'circulated'] \| ./date | | Y |
-| date_updated | ./date[@type = 'updated'] | | Y | 
-| date_accessed | ./date[@type = 'accessed'] | | Y | 
-| series | ./series[@type = 'main' or not(@type) or true] | | Y | <<seriestemplate,`seriestemplate`>> applies to series
-| host_creatornames | ./relation[@type = 'includedIn']/ bibitem/contributor[role/@type = 'author'] | |  Y | Follows options for `creatornames`
-| host_title | ./relation[@type = 'includedIn']/ bibitem/title | Y | Y | Follows options for `creatornames`
-| host_role | ./relation[@type = 'includedIn']/ bibitem/contributor[role/description] \| ./relation[@type = 'includedIn']/ bibitem/contributor[role/@type] | | Y | 
-| type | ./@type | |
-| labels | | | text to be looked up in internationalisation configuration files: "edition", "In", "At", "Vol", "Vols", "p.", "pp" 
-|===
-
-Many fields are populated either by the description of the bibliographic item itself, or by the description of the item containing it (the _host_ item: `./relation[@type = 'includedIn']/bibitem`). For example, in a paper included in an edited volume, the edition will typically be given for the editor volume, rather than for the paper. Those fields are indicated by "Can come from host" in the table.
-
-The Liquid template surrounds each field by preceding and following punctuation.
-
-* Fields are space-delimited. So `<em>{{ title }}</em> [{{medium}}]` are two separate fields.
-* If fields are not space-delimited, this is indicated by inserting `|`. So `{{ title }}|{{ medium}}` is two fields, rendered with no space separation.
-* If the field is empty, its surrounding markup is also removed. So if there is no medium, then `[{{medium}}]` is not rendered, and the brackets will be stripped.
-* Underscore is treated as space, attaching to the preceding or following field. So `,_{{ edition }}_{{ labels['edition'] }}` is treated as the one field.
-* If punctuation is space delimited, it is inserted regardless of preceding content. So `{{ creatornames }} ({{date}}) .` will insert the full stop whether or not the date is present.
-* Space between punctuation and before punctuation is automatically removed.
-
-For example:
-
-....
-"{{ creatornames }} ({{date}}) . <em>{{ title }}</em> [{{medium}}] ,_{{ edition }}_{{ labels['edition'] }} ."
-....
-
-If a type uses another type's template, the type is mapped to the other type's name; e.g.
-
-....
-template:
-  book: ...
-  booklet:  book
-....
-
-[[nametemplate]]
-=== Name templates
-
-The `nametemplate` is a hash of Liquid templates for the formatting of contributor names in particular positions. It
-draws on the following fields drawn from the bibliographic item:
-
-|===
-| Field  | Relaton XPath | Multiple | Note
-
-| surname[0] | ./contributor[1]/person/name/surname \| ./contributor[1]/person/name/completename \| ./contributor[1]/organization/name | | i.e. surname is the name default
-| surname[1] | ./contributor[2]/name/surname | |
-| surname[2] | ./contributor[3]/name/surname | |
-| initials[0] | ./contributor[1]/name/initial | | If not supplied, the first letter of each given name is used instead
-| initials[1] | ./contributor[2]/name/initial | |
-| given[0] | ./contributor[1]/name/forename[1] | | If not supplied, initials are used instead
-| given[1] |  ./contributor[2]/name/forename[1] | |
-| middle[0] | ./contributor[1]/name/forename[not(first())] | Y |
-| middle[1] | ./contributor[2]/name/forename[not(first())] | Y |
-|===
-
-There are at least three distinct `nametemplate` instances that need to be provided, one for a single contributor (`one:`), one for two contributors (`two:`), one for three or more (`more:`), and optionally one for "et al." (`etal:`). The number of contributors for which "et al." starts being used is indicated by `etal_count`.
-
-For example:
-....
-{
-  one: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}",
-  two: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }} &amp; {{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }}",
-  more: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}, {{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }} &amp; {{ given[2] }} {{ middle[2] | slice : 0 }} {{ surname[2] }}",
-  etal: "{{ surname[0] }}, {{ given[0] }} {{ middle[0] | slice : 0 }}, {{ given[1] }} {{ middle[1] | slice : 0 }} {{ surname[1] }} <em>et al.</em>",
-  etal_count: 6
-}
-....
-
-In the case of `more`, the `(name)[1]` entries are repeated for all additional authors above 2 and before the final author.
-
-[[seriestemplate]]
-=== Series template
-
-The `seriestemplate` is a template for the rendering of series information. It draws on the following fields drawn from the bibliographic item:
-
-|===
-| Field  | Relaton XPath | Multiple | Can come from host | Note
-
-| series_title  | ./series[@type = 'main' or not(@type) or true]/name | | Y |
-| series_abbr  | ./series[@type = 'main' or not(@type) or true]/abbreviation | | Y |
-| series_num  | ./series[@type = 'main' or not(@type) or true]/number | | Y |
-| series_partnumber  | ./series[@type = 'main' or not(@type) or true]/partnumber | | Y |
-| series_run  | ./series[@type = 'main' or not(@type) or true]/run | | Y |
-|===
+== Functionality
 
-For example: `{% if series_abbr %}{{series_abbr}}{% else %}{{series_title}}{% endif %} ,_({{series_run}}) {{series_num}}|({{series_partnumber}})`
+=== Rendering single reference
 
-=== Journal template
+Given an Relaton bibitem object (or equivalent Relaton XML), `render(input)` will output a formatted reference for that
+bibitem, following the rules laid out in the configuration. That output can be inserted into the `<formattedref>` element
+of the bibitem by the calling code, and used as the authoritative rendering of the citation.
 
-The `journaltemplate` is a template for the rendering of series information, when they relate to articles in a journal. The template is distinct because of longstanding practice of rendering journal information differently from monograph series information. The template draws on the same fields as the `seriestemplate`, but because the journal title is typically italicised and the numeration is not, any italicisation needs to occur within the template.
+This method does not address how the bibliographic item is to be cited, and does not differentiate citations with the same
+author and date. It should not be used for rendering of references aligned to the author-date citation system. 
 
-For example, the recommended practice in the current edition of ISO 690 is to give explicit volume labels:
+=== Rendering multiple references
 
-`<em>{% if series_abbr %}{{series_abbr}}{% else %}{{series_title}}{% endif %}</em> {{ labels['volume'] }}_{{series_num}} {{ labels['part'] }}_{{series_partnumber}}`
+Given a collection of Relaton bibitem objects (or equivalent Relaton XML, wrapped in `<references>`), 
+`render_all(bibliography, type: type)`
+will output a hash of objects, with information to be used both for rendering references, and for generating citations.
+This method addresses the disambiguation of citations, and changes to rendering of references reflecting that disambiguation
+(e.g. differentiating two works with the same wuthor surname and year: _Jones 1996a_ and _Jones 1996b_).
+For that reason, this method should be used for references using the author-date citation system.
 
-A common template that drops those labels is:
+The `type` argument of `render_all` reflects the citation system to be used. 
 
-`<em>{% if series_abbr %}{{series_abbr}}{% else %}{{series_title}}{% endif %}</em> {{series_num}}|({{series_partnumber}})`
+* If it is set to "author-date", citations with the same author and date will be disambiguated from each other
+by appending a letter to the date, in the order in which they occur in `bibliography`. (That means that any fixed sorting
+of references needs to be applied before the bibliography is presented to the method.)
+* If it is set to nil (as is the default), no such disambiguation occurs.
 
-=== Extent template
+The hash maps from the anchor of each bibitem (`bibitem/@id`), to an object containing the following fields:
 
-The extent of a reference can be expressed differently depending on the type of bibliographic item. For example, the extent of a book is its page count, and is typically expressed as something like _59 pp._ On the other hand, the extent of an article is expressed as _pp. 9–20_, or just _9–20_. 
+`formattedref`:: the formatted reference, as output by `render(input)`, but with the date of the citation disambiguated
+if called with `type: "author-date"`.
+`citation`:: the citation for the reference (Author-Date if called with `type: "author-date"`; `docidentifier` if called with `type: nil`).
+`author`:: the author designation for the reference (if called with `type: "author-date"`)
+`date`:: the date designation for the reference, with disambiguating letter if necessary (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)".
 
-To capture this, a separate template is supplied under `extenttemplate` for each bibliographic item type. For those types where none is supplied, the template given for `misc` is used as the default. 
+=== Parsing single reference
 
-The template draws on the defined types of locality of extents; the most common of these is `page` and `volume`. Locality types are the fields used in the Liquid templates; for example:
+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.
 
-....
-{
-  book: "{{ volume }}_{{ label['extent']['volume'] }}, {{ page }}_{{ label['extent']['page'] }}"
-  inbook: "{{ volume }}: {{ page }}"
-  misc: "{{ label['extent']['volume'] }}_{{ volume }}, {{ label['extent']['page'] }}_{{ page }}"
-}
-....
-
-The internationalisation files define a singular and a plural version of the locality types, under `labels['extent']`
-
-* The plural is always used if the extent is a range (with a `<from>` and `<to>`). 
-* In a host type of bibliographic item, the extent is singular only if the value is `1`, else it is plural (_1 p._, _2 pp._)
-* In an included item (`inbook`, `incollection`, `inproceedings`, `article`, or any item with an `includedIn` relation), 
-the singular is used if the extent is not a range (_pp. 2–4_ vs. _p. 3_)..
+== Configuration
 
-=== Other
+For the configuation YAML used in relaton-render, refer to https://relaton.org/specs/relaton-render 
 
-In addition, the configuration includes different configuration options for rendering:
+== Documentation
 
-The internationalisation file sets the following variables, which can be overridden in configuration parameters:
-`edition_number`:: has following values corresponding to the rule-based number rules defined in https://github.com/twitter/twitter-cldr-rb[Twitter CLDR]
-for a language. For example, English _4th_ is defined as `["OrdinalRules", "digits-ordinal"]`, because under twitter-cldr, `4th` is generated as `4.localize(:en).to_rbnf_s("OrdinalRules", "digits-ordinal")`.
-`edition`:: is the localised expression for edition, with the edition number given as %. So _4th ed.` is generated with `edition` as `% ed.`.
-`date`:: date format default, taken from https://github.com/twitter/twitter-cldr-rb[Twitter CLDR]: `to_full_s`, `to_long_s`, `to_medium_s`, `to_short_s`, or one of the `to_additional_s` formats. One value is given for each of "month_year", "day_month_year", and "date_time"; e.g. `{ month_year: to_long_s, day_month_year: to_long_s, date_time: to_long_s }`.
+* link:docs/citation-style-pack.adoc[Defining a Citation Style: the pack format] — the authoritative spec for CitationStyle YAML packs: resource types, presentation patterns, model presentation templates, locale/punctuation, inheritance and conformance.