relaton-bib 1.20.7 → 2.0.0.pre.alpha.1

data/lib/relaton_bib/document_identifier.rb

@@ -1,118 +0,0 @@
-module RelatonBib
-  # Document identifier.
-  class DocumentIdentifier
-    # @return [String]
-    attr_reader :id
-
-    # @return [String, nil]
-    attr_reader :type, :scope, :language, :script
-
-    # @param type [Boolean, nil]
-    attr_reader :primary
-
-    # @param id [String]
-    # @param type [String, nil]
-    # @param scope [String, nil]
-    # @param primary [Bolean, nil]
-    # @param language [String, nil]
-    def initialize(**args)
-      @id       = args[:id]
-      @type     = args[:type]
-      @scope    = args[:scope]
-      @primary  = args[:primary]
-      @language = args[:language]
-      @script   = args[:script]
-    end
-
-    # in docid manipulations, assume ISO as the default: id-part:year
-    def remove_part
-      case @type
-      when "Chinese Standard" then @id.sub!(/\.\d+/, "")
-      when "URN" then remove_urn_part
-      else @id.sub!(/-[^:]+/, "")
-      end
-    end
-
-    def remove_date
-      case @type
-      when "Chinese Standard" then @id.sub!(/-[12]\d\d\d/, "")
-      when "URN"
-        @id.sub!(/^(urn:iec:std:[^:]+:[^:]+:)[^:]*/, '\1')
-      else @id.sub!(/:[12]\d\d\d/, "")
-      end
-    end
-
-    def all_parts
-      if type == "URN"
-        @id.sub!(%r{^(urn:iec:std(?::[^:]*){4}).*}, '\1:ser')
-      else
-        @id += " (all parts)"
-      end
-    end
-
-    #
-    # Add docidentifier xml element
-    #
-    # @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/CyclomaticComplexity, Metrics/PerceivedComplexity
-      lid = if type == "URN" && opts[:lang]
-              id.sub %r{(?<=:)(?:\w{2},)*?(#{opts[:lang]})(?:,\w{2})*}, '\1'
-            else id
-            end
-      element = opts[:builder].docidentifier { |b| b.parent.inner_html = lid }
-      element[:type] = type if type
-      element[:scope] = scope if scope
-      element[:primary] = primary if primary
-      element[:language] = language if language
-      element[:script] = script if script
-    end
-
-    # @return [Hash]
-    def to_hash # rubocop:disable Metrics/AbcSize
-      hash = { "id" => id }
-      hash["type"] = type if type
-      hash["scope"] = scope if scope
-      hash["primary"] = primary if primary
-      hash["language"] = language if language
-      hash["script"] = script if script
-      hash
-    end
-
-    # @param prefix [String]
-    # @param count [Integer] number of docids
-    # @return [String]
-    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
-      pref = prefix.empty? ? prefix : "#{prefix}."
-      return "#{pref}docid:: #{id}\n" unless type || scope
-
-      out = count > 1 ? "#{pref}docid::\n" : ""
-      out += "#{pref}docid.type:: #{type}\n" if type
-      out += "#{pref}docid.scope:: #{scope}\n" if scope
-      out += "#{pref}docid.primary:: #{primary}\n" if primary
-      out += "#{pref}docid.language:: #{language}\n" if language
-      out += "#{pref}docid.script:: #{script}\n" if script
-      out + "#{pref}docid.id:: #{id}\n"
-    end
-
-    private
-
-    def remove_urn_part # rubocop:disable Metrics/MethodLength
-      @id.sub!(%r{^
-        (urn:iso:std:[^:]+ # ISO prefix and originator
-          (?::(?:data|guide|isp|iwa|pas|r|tr|ts|tta)) # type
-          ?:\d+) # docnumber
-        (?::-[^:]+)? # partnumber
-        (?::(draft|cancelled|stage-[^:]+))? # status
-        (?::ed-\d+)?(?::v[^:]+)? # edition and version
-        (?::\w{2}(?:,\w{2})*)? # langauge
-      }x, '\1') # remove partnumber, status, version, and language
-      @id.sub!(%r{^
-        (urn:iec:std:[^:]+ # IEC prefix and originator
-          :\d+) # docnumber
-        (?:-[^:]+)? # partnumber
-      }x, '\1') # remove partnumber
-    end
-  end
-end

data/lib/relaton_bib/document_relation.rb

@@ -1,95 +0,0 @@
-module RelatonBib
-  # Documett relation
-  class DocumentRelation
-    include RelatonBib
-
-    TYPES = %w[
-      includes includedIn hasPart partOf merges mergedInto splits splitInto
-      instanceOf hasInstance exemplarOf hasExemplar manifestationOf
-      hasManifestation reproductionOf hasReproduction reprintOf hasReprint
-      expressionOf hasExpression translatedFrom hasTranslation arrangementOf
-      hasArrangement abridgementOf hasAbridgement annotationOf hasAnnotation
-      draftOf hasDraft editionOf hasEdition updates updatedBy derivedFrom
-      derives describes describedBy catalogues cataloguedBy hasSuccessor
-      successorOf adaptedFrom hasAdaptation adoptedFrom adoptedAs reviewOf
-      hasReview commentaryOf hasCommentary related hasComplement complementOf
-      obsoletes obsoletedBy cites isCitedIn
-    ].freeze
-
-    # @return [String]
-    attr_accessor :type
-
-    # @return [RelatonBib::FormattedString, nil]
-    attr_reader :description
-
-    # @return [String]
-    # attr_reader :identifier, :url
-
-    # @return [RelatonBib::BibliographicItem]
-    attr_reader :bibitem
-
-    # @return [Array<RelatonBib::Locality, RelatonBib::LocalityStack>]
-    attr_reader :locality
-
-    # @return [Array<RelatonBib::SourceLocality,
-    #   RelatonBib::SourceLocalityStack>]
-    attr_reader :source_locality
-
-    # @param type [String]
-    # @param description [RelatonBib::FormattedString, nil]
-    # @param bibitem [RelatonBib::BibliographicItem,
-    #   RelatonIso::IsoBibliographicItem]
-    # @param locality [Array<RelatonBib::Locality>]
-    # @param locality_stack [Array<RelatonBib::LocalityStack>]
-    # @param source_locality [Array<RelatonBib::SourceLocality,
-    #   RelatonBib::SourceLocalityStack>]
-    def initialize(type:, bibitem:, **args)
-      type = "obsoletes" if type == "Now withdrawn"
-      unless self.class::TYPES.include? type
-        Util.warn "Invalid relation type: `#{type}`"
-      end
-      @type = type
-      @description = args[:description]
-      @locality = args[:locality] || args[:locality_stack] || []
-      @source_locality = args[:source_locality] || args[:source_locality_stack] || []
-      @bibitem = bibitem
-    end
-
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder, **opts)
-      opts.delete :bibdata
-      opts.delete :note
-      builder.relation(type: type) do
-        builder.description { description.to_xml builder } if description
-        bibitem.to_xml(**opts.merge(builder: builder, embedded: true))
-        locality.each { |l| l.to_xml builder }
-        source_locality.each { |l| l.to_xml builder }
-      end
-    end
-
-    # @return [Hash]
-    def to_hash # rubocop:disable Metrics/AbcSize
-      hash = { "type" => type, "bibitem" => bibitem.to_hash(embedded: true) }
-      hash["description"] = description.to_hash if description
-      locality.each_with_object(hash) do |l, obj|
-        k, v = l.to_hash.first
-        hash[k] ||= []
-        hash[k] << v
-      end
-      if source_locality&.any?
-        hash["source_locality"] = single_element_array(source_locality)
-      end
-      hash
-    end
-
-    # @param prefix [String]
-    # @return [String]
-    def to_asciibib(prefix = "")
-      pref = prefix.empty? ? prefix : prefix + "."
-      out = "#{prefix}.type:: #{type}\n"
-      out += description.to_asciibib "#{pref}desctiption" if description
-      out += bibitem.to_asciibib "#{pref}bibitem" if bibitem
-      out
-    end
-  end
-end

data/lib/relaton_bib/document_relation_collection.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module RelatonBib
-  # Document relation collection
-  class DocRelationCollection
-    extend Forwardable
-
-    def_delegators :@array, :<<, :[], :first, :last, :empty?, :any?, :size,
-                   :each, :detect, :map, :reduce, :length, :unshift, :max_by
-
-    # @param relation [Array<RelatonBib::DocumentRelation, Hash>]
-    # @option relation [String] :type
-    # @option relation [String] :identifier
-    # @option relation [String, NIllClass] :url (nil)
-    # @option relation [Array<RelatonBib::Locality, RelatonBib::LocalityStack>] :locality
-    # @option relation [Array<RelatonBib::SourceLocality, RelatonBib::SourceLocalityStack>] :source_locality
-    # @option relation [RelatonBib::BibliographicItem, nil] :bibitem (nil)
-    def initialize(relation)
-      @array = relation.map { |r| r.is_a?(Hash) ? DocumentRelation.new(**r) : r }
-    end
-
-    #
-    # Returns new DocumentRelationCollection with selected relations.
-    #
-    # @example Select relations with type "obsoletes"
-    #   relations.select { |r| r.type == "obsoletes" }
-    #   #=> <RelatonBib::DocRelationCollection:0x00007f9a0191d5f0 @array=[...]>
-    #
-    # @return [RelatonBib::DocRelationCollection] new DocumentRelationCollection
-    #   with selected relations
-    #
-    def select(&block)
-      arr = @array.select(&block)
-      self.class.new arr
-    end
-
-    # @todo We don't have replace type anymore. Suppose we should update this
-    #   method or delete it.
-    #
-    # @return [RelatonBib::DocRelationCollection]
-    def replaces
-      DocRelationCollection.new(@array.select { |r| r.type == "replace" })
-    end
-
-    # @param prefix [String]
-    # @return [String]
-    def to_asciibib(prefix = "")
-      pref = prefix.empty? ? "relation" : "#{prefix}.relation"
-      out = ""
-      @array.each do |r|
-        out += size > 1 ? "#{pref}::\n" : ""
-        out += r.to_asciibib pref
-      end
-      out
-    end
-  end
-end

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