relaton-bib 1.20.8 → 2.0.0

data/lib/relaton_bib/document_status.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-module RelatonBib
-  # Document status.
-  class DocumentStatus
-    # @return [RelatonBib::DocumentStatus::Stage]
-    attr_reader :stage
-
-    # @return [RelatonBib::DocumentStatus::Stage, nil]
-    attr_reader :substage
-
-    # @return [String, nil]
-    attr_reader :iteration
-
-    # @param stage [String, Hash, RelatonBib::DocumentStatus::Stage]
-    # @param substage [String, Hash, nil, RelatonBib::DocumentStatus::Stage]
-    # @param iteration [String, nil]
-    def initialize(stage:, substage: nil, iteration: nil)
-      @stage = stage_new stage
-      @substage = stage_new substage
-      @iteration = iteration
-    end
-
-    # @param [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      builder.status do
-        # FormattedString.instance_method(:to_xml).bind(status).call builder
-        builder.stage { |b| stage.to_xml b }
-        builder.substage { |b| substage.to_xml b } if substage
-        builder.iteration iteration unless iteration.to_s.empty?
-      end
-    end
-
-    # @return [Hash]
-    def to_hash
-      hash = { "stage" => stage.to_hash }
-      hash["substage"] = substage.to_hash if substage
-      hash["iteration"] = iteration if iteration
-      hash
-    end
-
-    # @param prefix [String]
-    # @return [String]
-    def to_asciibib(prefix = "")
-      pref = prefix.empty? ? prefix : "#{prefix}."
-      out = "#{pref}docstatus.stage:: #{stage.value}\n"
-      out += "#{pref}docstatus.substage:: #{substage.value}\n" if substage
-      out += "#{pref}docstatus.iteration:: #{iteration}\n" if iteration
-      out
-    end
-
-    private
-
-    # @param stg [RelatonBib::DocumentStatus::Stage, Hash, String, nil]
-    # @return [RelatonBib::DocumentStatus::Stage]
-    def stage_new(stg)
-      case stg
-      when Stage then stg
-      when Hash then self.class::Stage.new(**stg)
-      when String then self.class::Stage.new(value: stg)
-      end
-    end
-
-    class Stage
-      # @return [String]
-      attr_reader :value
-
-      # @return [String, nil]
-      attr_reader :abbreviation
-
-      # @param value [String]
-      # @param abbreviation [String, nil]
-      def initialize(value:, abbreviation: nil)
-        @value = value
-        @abbreviation = abbreviation
-      end
-
-      # @param [Nokogiri::XML::Builder]
-      def to_xml(builder)
-        builder.parent[:abbreviation] = abbreviation if abbreviation
-        builder.text value
-      end
-
-      # @return [Hash]
-      def to_hash
-        hash = { "value" => value }
-        hash["abbreviation"] = abbreviation if abbreviation
-        hash
-      end
-    end
-  end
-end

data/lib/relaton_bib/document_type.rb

@@ -1,52 +0,0 @@
-module RelatonBib
-  class DocumentType
-    attr_reader :type, :abbreviation
-
-    #
-    # Initialize a DocumentType.
-    #
-    # @param [String] type document type
-    # @param [String, nil] abbreviation type abbreviation
-    #
-    def initialize(type:, abbreviation: nil)
-      @type = type
-      @abbreviation = abbreviation
-    end
-
-    #
-    # Build XML representation of the document type.
-    #
-    # @param [Nokogiri::XML::Builder] builder XML builder
-    #
-    def to_xml(builder)
-      xml = builder.doctype @type
-      xml[:abbreviation] = @abbreviation if @abbreviation
-    end
-
-    #
-    # Hash representation of the document type.
-    #
-    # @return [Hash]
-    #
-    def to_hash
-      hash = { "type" => @type }
-      hash["abbreviation"] = @abbreviation if @abbreviation
-      hash
-    end
-
-    #
-    # Asciibib representation of the document type.
-    #
-    # @param [String] prefix prefix
-    #
-    # @return [String] AsciiBib representation
-    #
-    def to_asciibib(prefix = "")
-      pref = prefix.empty? ? prefix : "#{prefix}."
-      pref += "doctype."
-      out = "#{pref}type:: #{@type}\n"
-      out += "#{pref}abbreviation:: #{@abbreviation}\n" if @abbreviation
-      out
-    end
-  end
-end

data/lib/relaton_bib/edition.rb

@@ -1,55 +0,0 @@
-module RelatonBib
-  class Edition
-    # @return [String] edition
-    attr_reader :content
-
-    # @return [String, nil] number
-    attr_reader :number
-
-    #
-    # Initialize edition.
-    #
-    # @param [String, Integer, Float] content edition
-    # @param [String, Integer, Float, nil] number number
-    #
-    def initialize(content:, number: nil)
-      @content = content.to_s
-      @number = number&.to_s
-    end
-
-    #
-    # Render edition as XML.
-    #
-    # @param [Nokogiri::XML::Builder] builder XML builder
-    #
-    def to_xml(builder)
-      node = builder.edition(content)
-      node[:number] = number if number
-    end
-
-    #
-    # Return edition as hash.
-    #
-    # @return [Hash] edition as hash.
-    #
-    def to_hash
-      hash = { "content" => content }
-      hash["number"] = number if number
-      hash
-    end
-
-    #
-    # Render edition as AsciiBib.
-    #
-    # @param [String] prefix prefix
-    #
-    # @return [String] edition as AsciiBib.
-    #
-    def to_asciibib(prefix = "")
-      pref = prefix.empty? ? "edition" : "#{prefix}.edition"
-      out = "#{pref}.content:: #{content}\n"
-      out += "#{pref}.number:: #{number}\n" if number
-      out
-    end
-  end
-end

data/lib/relaton_bib/editorial_group.rb

@@ -1,41 +0,0 @@
-require "relaton_bib/technical_committee"
-
-module RelatonBib
-  class EditorialGroup
-    include RelatonBib
-
-    # @return [Array<RelatonBib::TechnicalCommittee>]
-    attr_accessor :technical_committee
-
-    # @param technical_committee [Array<RelatonBib::TechnicalCommittee>]
-    def initialize(technical_committee)
-      @technical_committee = technical_committee
-    end
-
-    # @param builder [Nokogigi::XML::Builder]
-    def to_xml(builder)
-      builder.editorialgroup do |b|
-        technical_committee.each { |tc| tc.to_xml b }
-      end
-    end
-
-    # @return [Hash]
-    def to_hash
-      single_element_array technical_committee
-    end
-
-    # @param prefix [String]
-    # @return [String]
-    def to_asciibib(prefix = "")
-      pref = prefix.empty? ? "editorialgroup" : "#{prefix}.editorialgroup"
-      technical_committee.map do |tc|
-        tc.to_asciibib pref, technical_committee.size
-      end.join
-    end
-
-    # @return [true]
-    def presence?
-      technical_committee.any?
-    end
-  end
-end

data/lib/relaton_bib/extent.rb

@@ -1,39 +0,0 @@
-module RelatonBib
-  class Extent
-    attr_accessor :locality
-
-    #
-    # @param [Array<RelatonBib::Locality, RelatonBib::LocalityStack>] locality
-    #
-    def initialize(locality)
-      @locality = locality
-    end
-
-    def to_xml(builder)
-      builder.extent do |b|
-        locality.each { |l| l.to_xml(b) }
-      end
-    end
-
-    def to_hash
-      hash = Hash.new { |h, k| h[k] = [] }
-      locality.each_with_object(hash) do |l, obj|
-        k, v = l.to_hash.first
-        obj[k] << v
-      end
-    end
-
-    def to_asciibib(prefix = "", count = 1)
-      pref = prefix.empty? ? "extent" : "#{prefix}.extent"
-      out = count > 1 ? "#{pref}::\n" : ""
-      locality.each do |l|
-        out += l.to_asciibib(pref, locality.size)
-      end
-      out
-    end
-
-    def to_bibtex(item)
-      locality.map { |l| l.to_bibtex(item) }.join
-    end
-  end
-end

data/lib/relaton_bib/forename.rb

@@ -1,65 +0,0 @@
-module RelatonBib
-  class Forename < LocalizedString
-    # @return [String, nil]
-    attr_accessor :initial
-
-    #
-    # Initialize Forename instance
-    #
-    # @param [String] content content of forename, can be empty
-    # @param [Array<String>] language languages, `en`, `fr`, `de` etc.
-    # @param [Array<String>] script scripts `Latn`, `Cyrl` etc.
-    # @param [String, nil] initial initial of forename
-    #
-    def initialize(content: nil, language: [], script: [], initial: nil)
-      @initial = initial
-      super content, language, script
-    end
-
-    def ==(other)
-      super && initial == other.initial
-    end
-
-    def to_s
-      content.nil? ? initial : super
-    end
-
-    #
-    # Render forename to XML
-    #
-    # @param [Nokogiri::XML::Builder] builder XML builder
-    #
-    def to_xml(builder)
-      node = builder.forename { super }
-      node[:initial] = initial if initial
-    end
-
-    #
-    # Render forename to hash
-    #
-    # @return [Hash, String] forename hash or string representation
-    #
-    def to_hash
-      ls = super
-      hash = ls.is_a?(Hash) ? ls : { "content" => ls }
-      hash["initial"] = initial if initial
-      hash
-    end
-
-    #
-    # Render forename to asciibib
-    #
-    # @param [String] pref prefix
-    # @param [Integer] count size of array
-    #
-    # @return [String] asciibib string
-    #
-    def to_asciibib(pref, count = 1)
-      prf = pref.empty? ? pref : "#{pref}."
-      prf += "forename"
-      out = super prf, count
-      out += "#{prf}.initial:: #{initial}\n" if initial
-      out
-    end
-  end
-end

data/lib/relaton_bib/formatted_ref.rb

@@ -1,17 +0,0 @@
-require "relaton_bib/formatted_string"
-
-module RelatonBib
-  class FormattedRef < FormattedString
-    # @param [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      builder.formattedref { super }
-    end
-
-    # @param prefix [String]
-    # @return [String]
-    def to_asciibib(prefix = "")
-      pref = prefix.empty? ? "formattedref" : "#{prefix}.formattedref"
-      super pref
-    end
-  end
-end

data/lib/relaton_bib/formatted_string.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-require "relaton_bib/localized_string"
-
-module RelatonBib
-  # Formatted string
-  class FormattedString < LocalizedString
-    FORMATS = %w[text/plain text/html application/docbook+xml
-                 application/tei+xml text/x-asciidoc text/markdown
-                 application/x-metanorma+xml].freeze
-
-    # @return [String]
-    attr_reader :format
-
-    # @param content [String, Array<RelatonBib::LocalizedString>]
-    # @param language [String, nil] language code Iso639
-    # @param script [String, nil] script code Iso15924
-    # @param format [String] the content type
-    def initialize(content: "", language: nil, script: nil, format: "text/plain")
-      # if format && !FORMATS.include?(format)
-      #   raise ArgumentError, %{Format "#{format}" is invalid.}
-      # end
-
-      @format = format
-      super(content, language, script)
-    end
-
-    def ==(other)
-      super && format == other.format
-    end
-
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      builder.parent["format"] = format if format
-      super
-    end
-
-    #
-    # Encode content.
-    #
-    # @param [String] cnt content
-    #
-    # @return [String] encoded content
-    #
-    def encode(cnt) # rubocop:disable Metrics/MethodLength
-      return escp(cnt) unless format == "text/html"
-
-      parts = cnt.scan(%r{
-        <(?<tago>\w+)(?<attrs>[^>]*)> | # tag open
-        </(?<tagc>\w+)> | # tag close
-        (?<cmt><!--.*?-->) | # comment
-        (?<cnt>.+?)(?=<|$) # content
-        }x)
-      scan_xml parts
-    end
-
-    #
-    # Scan XML and escape HTML entities.
-    #
-    # @param [Array<Array<String,nil>>] parts XML parts
-    #
-    # @return [String] output string
-    #
-    def scan_xml(parts) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
-      return "" unless parts.any?
-
-      out = ""
-      while parts.any? && (parts.first[3] || parts.first[4])
-        _, _, _, cmt, cnt = parts.shift
-        out += "#{cmt}#{escp(cnt)}"
-      end
-      unless out.empty?
-        out += scan_xml(parts) if parts.any? && parts.first[0]
-        return out
-      end
-
-      tago, attrs, tagc, = parts.shift
-      out = if tago && attrs && attrs[-1] == "/"
-              "<#{tago}#{attrs}>"
-            elsif tago
-              inr = scan_xml parts
-              _, _, tagc, = parts.shift
-              if tago == tagc
-                "<#{tago}#{attrs}>#{inr}</#{tagc}>"
-              else
-                "#{escp("<#{tago}#{attrs}>")}#{inr}#{escp("</#{tagc}>")}"
-              end
-            end
-      out += scan_xml(parts) if parts.any? && (parts.first[0] || parts.first[3] || parts.first[4])
-      out
-    end
-
-    # @return [Hash]
-    def to_hash
-      hash = super
-      return hash unless format
-
-      hash = { "content" => hash } unless hash.is_a? Hash
-      hash["format"] = format
-      hash
-    end
-
-    # @param prefix [String]
-    # @param count [Integer] number of elements
-    # @return [String]
-    def to_asciibib(prefix = "", count = 1, has_attrs = false)
-      has_attrs ||= !(format.nil? || format.empty?)
-      pref = prefix.empty? ? prefix : "#{prefix}."
-      # out = count > 1 ? "#{prefix}::\n" : ""
-      out = super
-      out += "#{pref}format:: #{format}\n" if format
-      out
-    end
-
-    #
-    # Remove HTML tags except <em>, <strong>, <stem>, <sup>, <sub>, <tt>, <br>, <p>.
-    # Replace <i> with <em>, <b> with <strong>.
-    #
-    # @param [String] str content
-    #
-    # @return [String] cleaned content
-    #
-    def cleanup(str)
-      return str unless format == "text/html"
-
-      str.gsub(/(?<=<)\w+:(?=\w+>)/, "").gsub(/(?<=<\/)\w+:(?=\w+>)/, "")
-        .gsub(/<i>/, "<em>").gsub(/<\/i>/, "</em>")
-        .gsub(/<b>/, "<strong>").gsub(/<\/b>/, "</strong>")
-        .gsub(/<(?!\/?(em|strong|stem|sup|sub|tt|br\s?\/|p|ol|ul|li))[^\s!]\/?.*?>/i, "")
-        .gsub(/\s+([.,:;!?<])/, "\\1").strip.squeeze(" ")
-    end
-  end
-end

data/lib/relaton_bib/full_name.rb

@@ -1,108 +0,0 @@
-module RelatonBib
-  # Person's full name
-  class FullName
-    include RelatonBib
-
-    # @return [Array<RelatonBib::Forename>]
-    attr_accessor :forename
-
-    # @return [Array<RelatonBib::LocalizedString>]
-    attr_accessor :initials, :addition, :prefix
-
-    # @return [RelatonBib::LocalizedString, nil]
-    attr_accessor :surname, :abbreviation, :completename
-
-    #
-    # Initialize FullName instance
-    #
-    # @param surname [RelatonBib::LocalizedString, nil] surname or completename should be present
-    # @param abbreviation [RelatonBib::LocalizedString, nil] abbreviation
-    # @param forename [Array<RelatonBib::Forename>] forename
-    # @param initials [RelatonBib::LocalizedString, String, nil] string of initials
-    # @param addition [Array<RelatonBib::LocalizedString>] array of additions
-    # @param prefix [Array<RelatonBib::LocalizedString>] array of prefixes
-    # @param completename [RelatonBib::LocalizedString, nil] completename or surname should be present
-    #
-    def initialize(**args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
-      unless args[:surname] || args[:completename]
-        raise ArgumentError, "Should be given :surname or :completename"
-      end
-
-      @surname      = args[:surname]
-      @abbreviation = args[:abbreviation]
-      @forename     = args[:forename] || []
-      @initials     = args[:initials].is_a?(String) ? LocalizedString.new(args[:initials]) : args[:initials]
-      @addition     = args[:addition] || []
-      @prefix       = args[:prefix] || []
-      @completename = args[:completename]
-    end
-
-    def ==(other) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
-      surname == other.surname && abbreviation == other.abbreviation &&
-        completename == other.completename && forename == other.forename &&
-        initials == other.initials && addition == other.addition &&
-        prefix == other.prefix
-    end
-
-    # @param opts [Hash]
-    # @option opts [Nokogiri::XML::Builder] :builder XML builder
-    # @option opts [String] :lang language
-    def to_xml(**opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-      opts[:builder].name do |builder|
-        builder.abbreviation { abbreviation.to_xml builder } if abbreviation
-        if completename
-          builder.completename { completename.to_xml builder }
-        else
-          pref = prefix.select { |p| p.language&.include? opts[:lang] }
-          pref = prefix unless pref.any?
-          pref.each { |p| builder.prefix { p.to_xml builder } }
-          frnm = forename.select { |f| f.language&.include? opts[:lang] }
-          frnm = forename unless frnm.any?
-          frnm.each { |f| f.to_xml builder }
-          builder.send(:"formatted-initials") { initials.to_xml builder } if initials
-          builder.surname { surname.to_xml builder }
-          addn = addition.select { |a| a.language&.include? opts[:lang] }
-          addn = addition unless addn.any?
-          addn.each { |a| builder.addition { a.to_xml builder } }
-        end
-      end
-    end
-
-    # @return [Hash]
-    def to_hash # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
-      hash = {}
-      hash["abbreviation"] = abbreviation.to_hash if abbreviation
-      if forename.any? || initials
-        hash["given"] = {}
-        hash["given"]["forename"] = single_element_array(forename) if forename&.any?
-        hash["given"]["formatted_initials"] = initials.to_hash if initials
-      end
-      hash["surname"] = surname.to_hash if surname
-      hash["addition"] = single_element_array(addition) if addition&.any?
-      hash["prefix"] = single_element_array(prefix) if prefix&.any?
-      hash["completename"] = completename.to_hash if completename
-      hash
-    end
-
-    # @param pref [String]
-    # @return [String]
-    def to_asciibib(pref) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-      prf = pref.empty? ? pref : "#{pref}."
-      prf += "name"
-      out = ""
-      out += abbreviation.to_asciibib "#{prf}.abbreviation" if abbreviation
-      given = "#{pref}.given"
-      out += forename.map do |fn|
-        fn.to_asciibib given, forename.size
-      end.join
-      out += initials.to_asciibib "#{given}.formatted-initials" if initials
-      out += surname.to_asciibib "#{prf}.surname" if surname
-      addition.each do |ad|
-        out += ad.to_asciibib "#{prf}.addition", addition.size
-      end
-      prefix.each { |pr| out += pr.to_asciibib "#{prf}.prefix", prefix.size }
-      out += completename.to_asciibib "#{prf}.completename" if completename
-      out
-    end
-  end
-end