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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 724379f5109fee2907541af1ab2c85bd98b97f46619e2663829d4a14a444ad7d
-  data.tar.gz: 82197910f99adf267de3d04d2ef3563eaf65b8f0165a5cd384fa6f33a6a14721
+  metadata.gz: d8d567a54651ce75901eeb043077a17b840e9a9d9d00e95d3afcde793bfc6795
+  data.tar.gz: 3b6019abeef370c32db6e855238b4500c1be2a785eb726eb6577b6e454588d4b
 SHA512:
-  metadata.gz: 052f44dff5733b567a7ec3b800545313059ef644bd1cc5278cc3f9991dedf52a419729e5a68b7e0f2c2f352700bc795c19def617549692971ed3571121964d0e
-  data.tar.gz: 75d27bcae28df048b265dfb750d799dab388797ea81b53659f103d8681e619714c6cbbfce902a3207bc6463d12227aafa18fd82259c51157ef364f854a302397
+  metadata.gz: c75141af4b07759f64a7c12ed491509ddfc2cd88595ea6484587a0bb753e333b633906188bf03e765912a06c4fd6e7a1812e0a886486c3c1b3f8435488f376b6
+  data.tar.gz: 2d8b040b077067944c76dd2149af2272bb536811fe228c940d91e5e79c0b42de0f3c4360b9586f0c6a369507eddf01e96246f334b169e4c1e2c5ea1df3507ee5

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/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

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Date of publication (ISO 690 clause 7.7). The relaton model
+        # provides typed date values (StringDate::Value#to_date); years
+        # come from the model, never from string manipulation. A from/to
+        # pair renders as a range (closed or open).
+        class PubDate < Element
+          def present?
+            !render.nil?
+          end
+
+          def render
+            range || year&.to_s
+          end
+
+          private
+
+          def publication_date
+            Array(@model.date).find(&:published) ||
+              Array(@model.date).find { |d| d.type.nil? }
+          end
+
+          def publication_date_value
+            d = publication_date or return nil
+            d.from || d.at || d.to
+          end
+
+          def range
+            d = publication_date or return nil
+            dash = @i18n.label("date_range")
+            if d.from && d.to
+              "#{d.from.to_date.year}#{dash}#{d.to.to_date.year}"
+            elsif d.from
+              "#{d.from.to_date.year}#{dash}"
+            end
+          end
+
+          def year
+            publication_date_value.to_date.year
+          rescue ArgumentError, TypeError, NoMethodError
+            nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Series title and number (ISO 690 clause 7.10)
+        class Series < Element
+          def present?
+            !series_title.empty?
+          end
+
+          def render
+            base = "#{@style.templates.title_open}#{series_title}" \
+                   "#{@style.templates.title_close}"
+            if number.empty?
+              base
+            else
+              "#{base}, #{@i18n.label('series_no')} #{number}"
+            end
+          end
+
+          private
+
+          def series
+            Array(@model.series).first
+          end
+
+          def series_title
+            Array(series&.title).map { |t| localized(t) }.join(" ").strip
+          end
+
+          def number
+            series&.number.to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      module Elements
+        # Title of the resource (ISO 690 clause 7.3), emphasised by the
+        # style's declared title markers
+        class Title < Element
+          def present?
+            !main_title.empty?
+          end
+
+          def render
+            "#{@style.templates.title_open}#{main_title}" \
+              "#{@style.templates.title_close}"
+          end
+
+          private
+
+          def main_title
+            t = Array(@model.title).find { |x| (x.type || "main") == "main" } ||
+              Array(@model.title).first
+            localized(t)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      # Element registry (ISO 690 clause 7 vocabulary)
+      module Elements
+        autoload :Creator, "relaton/render/iso690/elements/creator"
+        autoload :Title, "relaton/render/iso690/elements/title"
+        autoload :Edition, "relaton/render/iso690/elements/edition"
+        autoload :Medium, "relaton/render/iso690/elements/medium"
+        autoload :Series, "relaton/render/iso690/elements/series"
+        autoload :Production, "relaton/render/iso690/elements/production"
+        autoload :PubDate, "relaton/render/iso690/elements/pub_date"
+        autoload :Identifier, "relaton/render/iso690/elements/identifier"
+        autoload :Location, "relaton/render/iso690/elements/location"
+        autoload :Numeration, "relaton/render/iso690/elements/numeration"
+        autoload :ComponentPart, "relaton/render/iso690/elements/component_part"
+
+        CLASSES = {
+          creator: Creator,
+          title: Title,
+          edition: Edition,
+          medium: Medium,
+          series: Series,
+          production: Production,
+          date: PubDate,
+          identifier: Identifier,
+          location: Location,
+          numeration: Numeration,
+          component_part: ComponentPart,
+        }.freeze
+
+        def self.build(name, model, style:, i18n:)
+          CLASSES.fetch(name).new(model, style: style, i18n: i18n)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Relaton
+  module Render
+    module Iso690
+      # Field resolver: builds the template evaluator's field table from a
+      # relaton model instance. Slots resolve to ISO 690 clause 7 data
+      # elements, to name-form fields of the principal creator, or to the
+      # disambiguator supplied by the citation caller.
+      class Fields
+        ELEMENT_SLOTS = %i[
+          creator title edition medium series production
+          date numeration component_part identifier location
+        ].freeze
+
+        def initialize(model, style:, i18n:, disambiguator: nil)
+          @model = model
+          @style = style
+          @i18n = i18n
+          @disambiguator = disambiguator.to_s
+        end
+
+        def to_h
+          table = {}
+          ELEMENT_SLOTS.each do |slot|
+            key = slot.to_s.delete("_").downcase
+            table[key] = element_field(slot)
+          end
+          table.merge(name_fields)
+        end
+
+        private
+
+        def element_field(slot)
+          element = Elements.build(slot, @model, style: @style, i18n: @i18n)
+          text = element.render.to_s
+          Template::Field[element.present? && !text.empty?, text]
+        end
+
+        def name_fields
+          creator = Elements.build(:creator, @model, style: @style, i18n: @i18n)
+          {
+            "surname" => Template::Field[creator.present?, creator.in_text],
+            "givennames" => Template::Field[!creator.principal_given.empty?,
+                                            creator.principal_given],
+            "disambiguator" => Template::Field[!@disambiguator.empty?,
+                                               @disambiguator],
+          }
+        end
+      end
+    end
+  end
+end

data/lib/relaton/render/iso690/i18n/en.yml

@@ -0,0 +1,13 @@
+lang: en
+labels:
+  edition: "ed"
+  series_no: "no."
+  report_no: "Report no."
+  available_from: "Available from:"
+  in: "In:"
+  and: "and"
+  oxford_comma: ","
+  ed: "ed."
+  eds: "eds."
+  date_range: "–"
+punct: {}