relaton-render 1.2.2 → 1.4.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece7911d68f25665c109d3a9420e30aab669c880655c5bb15b4146c8acee4f43
-  data.tar.gz: 1ba627049f678c0b817da7a93af4420b74e34579965a65eeaeb0f80126abed02
+  metadata.gz: d8d567a54651ce75901eeb043077a17b840e9a9d9d00e95d3afcde793bfc6795
+  data.tar.gz: 3b6019abeef370c32db6e855238b4500c1be2a785eb726eb6577b6e454588d4b
 SHA512:
-  metadata.gz: 92ad5ab36726f3b857ff9d792cce3ae2ba3ba0b8adba21308b0596da88822f16e4131b92c7047b31105036c534c552815d12e10b3e0773cbf04634769713c8f5
-  data.tar.gz: 790abb7747575c3b990fdb6a4ed579c3fc2269d35b1e05f0d3ab6c0869686784b4b91dfd8c0f9d7a006516c681e1821604f6351e91918fd210df78c9f106e760
+  metadata.gz: c75141af4b07759f64a7c12ed491509ddfc2cd88595ea6484587a0bb753e333b633906188bf03e765912a06c4fd6e7a1812e0a886486c3c1b3f8435488f376b6
+  data.tar.gz: 2d8b040b077067944c76dd2149af2272bb536811fe228c940d91e5e79c0b42de0f3c4360b9586f0c6a369507eddf01e96246f334b169e4c1e2c5ea1df3507ee5

data/.github/workflows/rake.yml

@@ -8,6 +8,11 @@ on:
     tags: [ v* ]
   pull_request:
 
+permissions:
+  contents: write
+
 jobs:
   rake:
-    uses: relaton/support/.github/workflows/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

@@ -14,7 +14,6 @@ on:
   repository_dispatch:
     types: [ do-release ]
 
-
 jobs:
   release:
     uses: relaton/support/.github/workflows/release.yml@main
@@ -22,3 +21,4 @@ jobs:
       next_version: ${{ github.event.inputs.next_version }}
     secrets:
       rubygems-api-key: ${{ secrets.RELATON_CI_RUBYGEMS_API_KEY }}
+

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,9 +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
 
-eval_gemfile("Gemfile.devel") rescue nil
+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/lib/isodoc-yaml/i18n-ar.yaml

@@ -1,5 +1,11 @@
-in:  في
-at: في
+at_url: متاح في
+at_venue: في
+at_institution: في
+at_time: في
+at_location: في
+in_document: في
+in_series: في
+in_archive: في
 and: و
 author_and: و
 updated: محدث

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

@@ -1,5 +1,11 @@
-in: in
-at: bei
+at_url: unter
+at_venue: bei
+at_institution: bei
+at_time: um
+at_location: in
+in_document: in
+in_series: in
+in_archive: in
 and: und
 author_and: und
 updated: aktualisiert

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

@@ -1,5 +1,11 @@
-in: in
-at: at
+at_url: at
+at_venue: at
+at_institution: at
+at_time: at
+at_location: at
+in_document: in
+in_series: in
+in_archive: in
 and: and
 author_and: and
 updated: updated

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

@@ -1,5 +1,11 @@
-in: en
-at: en
+at_url: en
+at_venue: en
+at_institution: en
+at_time: a las
+at_location: en
+in_document: en
+in_series: en
+in_archive: en
 and: y
 author_and: y
 updated: actualizado

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

@@ -1,5 +1,11 @@
-in: dans
-at: à
+at_url: à
+at_venue: lors de
+at_institution: à
+at_time: à
+at_location: à
+in_document: dans
+in_series: dans
+in_archive: dans
 and: et
 author_and: et
 updated: mise à jour

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

@@ -1,5 +1,11 @@
-in: 
-at: 
+at_url: より入手可能
+at_venue: にて
+at_institution: 所蔵
+at_time: 時点で
+at_location: 所在
+in_document: 所載
+in_series: 所収
+in_archive: 所蔵
 and: と
 author_and: ","
 updated: 更新しました
@@ -7,7 +13,7 @@ viewed: 参照
 version: 
 also_pub_as: 次のようにも出版されています
 no_date: 日付なし。
-no_place: 都市はありません。
+no_place: 出版地不明
 date_formats:
   month_year: yMMMM
   day_month_year: to_long_s
@@ -38,8 +44,8 @@ extent:
     sg: "巻%"
     pl: "巻%"
   issue:
-    sg: "いいえ%"
-    pl: "いいえ%"
+    sg: "%号"
+    pl: "%号"
 size:
   page:
     sg: "%頁"
@@ -48,5 +54,5 @@ size:
     sg: "巻%"
     pl: "巻%"
   issue:
-    sg: "いいえ%"
-    pl: "いいえ%"
+    sg: "%号"
+    pl: "%号"

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

@@ -1,5 +1,11 @@
-in: в
-at: в
+at_url: доступно по
+at_venue: на
+at_institution: в
+at_time: в
+at_location: в
+in_document: в
+in_series: в
+in_archive: в
 and: и
 author_and: и
 updated: обновлен

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

@@ -1,5 +1,11 @@
-in: 在
-at: 在
+at_url: 可访问
+at_venue: 于
+at_institution: 收藏于
+at_time: 于
+at_location: 位于
+in_document: 载于
+in_series: 收录于
+in_archive: 藏于
 and: 和
 author_and: 和
 updated: 更新

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

@@ -1,5 +1,11 @@
-in: 在
-at: 在
+at_url: 可訪問
+at_venue: 於
+at_institution: 收藏於
+at_time: 於
+at_location: 位於
+in_document: 載於
+in_series: 收錄於
+in_archive: 藏於
 and: 和
 author_and: 與
 updated: 更新

data/lib/relaton/render/iso690/element.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      # Base data element (ISO 690 clause 7). An element wraps typed data
+      # taken from the relaton model instance; #present? is the omission
+      # predicate, #render the element's formatting method. Punctuation
+      # between elements belongs to the kind/style, not the element.
+      class Element
+        def initialize(model, style:, i18n:)
+          @model = model
+          @style = style
+          @i18n = i18n
+        end
+
+        def present?
+          false
+        end
+
+        def render
+          nil
+        end
+
+        private
+
+        def localized(value)
+          value&.content.to_s
+        end
+
+        def contributors(role)
+          Array(@model.contributor).select { |c| has_role?(c, role) }
+        end
+
+        def has_role?(contributor, role)
+          Array(contributor.role).any? do |r|
+            r.is_a?(String) ? r == role : r.type == role
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/component_part.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Component part within a host (ISO 690 clause 7.4): "In: host
+        # title, edition of host". Host data comes from the typed
+        # partOf relation.
+        class ComponentPart < Element
+          def present?
+            !host_title.empty?
+          end
+
+          def render
+            "#{@i18n.label('in')} " \
+              "#{@style.templates.title_open}#{host_title}" \
+              "#{@style.templates.title_close}" \
+              "#{host_edition}"
+          end
+
+          private
+
+          def relation
+            Array(@model.relation).find { |r| r.type == "partOf" }
+          end
+
+          def host
+            relation&.bibitem
+          end
+
+          def host_title
+            return localized(relation&.description) if host.nil?
+
+            Array(host.title).map { |t| localized(t) }.join(" ").strip
+          end
+
+          def host_edition
+            return "" if host.nil?
+
+            edition = Edition.new(host, style: @style, i18n: @i18n)
+            return "" unless edition.present?
+
+            ". #{edition.render}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/creator.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Name(s) of creator(s) (ISO 690 clause 7.2). The first creator is
+        # given inverted per the style's name form (SURNAME, forenames),
+        # subsequent creators in direct order (forenames SURNAME); name
+        # parts come from the typed model, never decomposed from a
+        # rendered string.
+        class Creator < Element
+          def present?
+            !creators.empty?
+          end
+
+          def render
+            "#{join(names)}#{role_suffix}"
+          end
+
+          # In-text (name-and-date) form: the principal creator only
+          def in_text
+            principal = creators.first or return ""
+            person = principal.person or return org_name(principal)
+            completename(person) || surname(person)&.upcase || ""
+          end
+
+          # The principal creator's given names, as the name form declares
+          def principal_given
+            principal = creators.first or return ""
+            person = principal.person or return ""
+            complete = completename(person)
+            return "" if complete
+
+            given_names(person)
+          end
+
+          private
+
+          def creators
+            @creators ||= begin
+              found = contributors("author")
+              found = contributors("editor") if found.empty?
+              found
+            end
+          end
+
+          def names
+            creators.each_with_index
+              .map do |contributor, index|
+              format(contributor,
+                     first: index.zero?)
+            end
+          end
+
+          def format(contributor, first:)
+            person = contributor.person or return org_name(contributor)
+            name = completename(person) ||
+              personal_name(person, first: first)
+            name.empty? ? org_name(contributor) : name
+          end
+
+          def personal_name(person, first:)
+            surname = surname(person).to_s
+            given = given_names(person)
+            if first && !name_form.given_name_first
+              @style.render_name(surname: surname, given: given)
+            else
+              [given, surname.upcase].reject(&:empty?).join(" ")
+            end
+          end
+
+          def name_form
+            @style.scheme.name_form
+          end
+
+          def join(names)
+            case names.size
+            when 0 then ""
+            when 1 then names.first
+            when 2 then names.join(" #{@i18n.label('and')} ")
+            else
+              "#{names[0..-2].join(', ')}#{@i18n.label('oxford_comma')} " \
+              "#{@i18n.label('and')} #{names.last}"
+            end
+          end
+
+          def role_suffix
+            return "" unless editors?
+
+            suffix = creators.one? ? @i18n.label("ed") : @i18n.label("eds")
+            " (#{suffix})"
+          end
+
+          def editors?
+            !creators.empty? && creators.all? { |c| has_role?(c, "editor") }
+          end
+
+          def completename(person)
+            value = localized(person.name&.completename)
+            value.empty? ? nil : value
+          end
+
+          def surname(person)
+            value = localized(person.name&.surname)
+            value.empty? ? nil : value
+          end
+
+          def given_names(person)
+            names = Array(person.name&.forename).map { |f| localized(f) }
+              .reject(&:empty?)
+            return names.map { |n| "#{n[0]}." }.join(" ") if name_form.initials
+
+            names.join(" ")
+          end
+
+          def org_name(contributor)
+            name = Array(contributor.organization&.name)
+              .map { |n| localized(n).upcase }.join(", ")
+            abbrev = localized(contributor.organization&.abbreviation)
+            return name if name.empty? || abbrev.empty?
+
+            "#{name} (#{abbrev})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/edition.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Edition and version (ISO 690 clause 7.6). The model numbers the
+        # edition through Edition#number (falling back to its content).
+        class Edition < Element
+          def present?
+            !number.zero?
+          end
+
+          def render
+            "#{ordinalize(number)} #{@i18n.label('edition')}"
+          end
+
+          private
+
+          def number
+            raw = @model.edition&.number || @model.edition&.content
+            Integer(raw)
+          rescue ArgumentError, TypeError
+            0
+          end
+
+          def ordinalize(num)
+            "#{num}#{ordinal_suffix(num)}"
+          end
+
+          def ordinal_suffix(num)
+            case num % 100
+            when 11, 12, 13 then "th"
+            else
+              case num % 10
+              when 1 then "st"
+              when 2 then "nd"
+              when 3 then "rd"
+              else "th"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/identifier.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Standard and persistent identifiers, rendered by kind
+        class Identifier < Element
+          INTERNAL_TYPES = %w[metanorma metanorma-ordinal metanorma-objid]
+            .freeze
+
+          def present?
+            !identifiers.empty?
+          end
+
+          def render
+            identifiers.map { |d| IdentifierKinds.render(d) }
+              .join(@i18n.punct_fetch("identifier_join", ". "))
+          end
+
+          private
+
+          def identifiers
+            Array(@model.docidentifier).reject do |d|
+              INTERNAL_TYPES.include?(d.type) || d.content.to_s.strip.empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/location.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Availability and location (ISO 690 clause 7.12): access location
+        # (URI) of the resource
+        class Location < Element
+          def present?
+            !uri.empty?
+          end
+
+          def render
+            "#{@i18n.label('available_from')} #{uri}"
+          end
+
+          private
+
+          def uri
+            Array(@model.accesslocation).reject(&:empty?).first.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/medium.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Medium designation (ISO 690 clause 7.5), bracketed per the
+        # standard's worked examples, e.g. "[online]"
+        class Medium < Element
+          def present?
+            !medium.empty?
+          end
+
+          def render
+            "[#{medium}]"
+          end
+
+          private
+
+          def medium
+            localized(@model.medium)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/numeration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Numeration within a series (ISO 690 clause 7.9): report numbers
+        class Numeration < Element
+          def present?
+            !docnumber.to_s.empty?
+          end
+
+          def render
+            "#{@i18n.label('report_no')} #{docnumber}"
+          end
+
+          private
+
+          def docnumber
+            @model.docnumber
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/elements/production.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Production information: place and publisher (ISO 690 clause 7.8).
+        # Place comes from the model's typed city; publishers from
+        # organization contributors.
+        class Production < Element
+          def present?
+            !places.empty? || !publishers.empty?
+          end
+
+          def render
+            [places.join("; "), publishers.join("; ")]
+              .reject(&:empty?).join(@i18n.punct_fetch("production_sep", ": "))
+          end
+
+          private
+
+          def places
+            Array(@model.place).map { |p| p.city.to_s }
+              .reject { |c| c.strip.empty? }
+          end
+
+          def publishers
+            contributors("publisher").map do |c|
+              Array(c.organization&.name).map { |n| localized(n) }.join(", ")
+            end.reject(&:empty?)
+          end
+        end
+      end
+    end
+  end
+end