relaton-bib 1.20.8 → 2.0.0

data/lib/relaton_bib/hit_collection.rb

@@ -1,105 +0,0 @@
-require "forwardable"
-
-module RelatonBib
-  class HitCollection
-    extend Forwardable
-
-    def_delegators :@array, :<<, :[], :first, :empty?, :any?, :size, :each,
-                   :each_slice, :reduce, :map
-
-    # @return [TrueClass, FalseClass]
-    attr_reader :fetched
-
-    # @return [String]
-    attr_reader :text
-
-    # @return [String]
-    attr_reader :year
-
-    # @param text [String] reference to search
-    def initialize(text, year = nil)
-      @array = []
-      @text = text
-      @year = year
-      @fetched = false
-    end
-
-    #
-    # Fetches hits from the data source
-    #
-    # @return [self] self object
-    #
-    def fetch
-      workers = WorkersPool.new 4
-      workers.worker(&:fetch)
-      each do |hit|
-        workers << hit
-      end
-      workers.end
-      workers.result
-      @fetched = true
-      self
-    end
-
-    #
-    # Renders the collection as XML
-    #
-    # @param opts [Hash] options
-    # @option opts [Nokogiri::XML::Builder] :builder XML builder
-    # @option opts [Boolean] :bibdata render bibdata if true
-    # @option opts [String, Symbol] :lang language
-    #
-    # @return [String] XML representation of the collection
-    #
-    def to_xml(**opts)
-      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-        xml.documents do
-          @array.each do |hit|
-            hit.fetch
-            hit.to_xml(**opts.merge(builder: xml))
-          end
-        end
-      end
-      builder.to_xml
-    end
-
-    #
-    # Selects matching hits and returns a new collection
-    #
-    # @param [Proc] &block proc to select hits
-    #
-    # @return [RelatonBib::HitCollection] new hit collection
-    #
-    def select(&block)
-      me = deep_dup
-      array_dup = instance_variable_get(:@array).deep_dup
-      me.instance_variable_set(:@array, array_dup)
-      array_dup.select!(&block)
-      array_dup.each { |h| h.hit_collection = WeakRef.new me }
-      me
-    end
-
-    def reduce!(sum, &block)
-      @array = @array.reduce sum, &block
-      self
-    end
-
-    #
-    # Returns String representation of the collection
-    #
-    # @return [String] String representation of the collection
-    #
-    def to_s
-      inspect
-    end
-
-    #
-    # Returns String representation of the collection
-    #
-    # @return [String] String representation of the collection
-    #
-    def inspect
-      "<#{self.class}:#{format('%#.14x', object_id << 1)} @ref=#{@text} @fetched=#{@fetched}>"
-    end
-  end
-end

data/lib/relaton_bib/ics.rb

@@ -1,42 +0,0 @@
-module RelatonBib
-  class ICS
-    # @return [String]
-    attr_reader :code
-
-    # @return [String, nil]
-    attr_reader :text
-
-    # @param code [String]
-    # @param text [String, nil]
-    def initialize(code:, text: nil)
-      @code = code
-      @text = text
-    end
-
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      builder.ics do |b|
-        b.code code
-        b.text_ text if text
-      end
-    end
-
-    # @return [Hash]
-    def to_hash
-      hash = { "code" => code }
-      hash["text"] = text if text
-      hash
-    end
-
-    # @param prefix [String]
-    # @param count [Integer] number of ics
-    # @return [String]
-    def to_asciibib(prefix = "", count = 1)
-      pref = prefix.empty? ? "ics" : "#{prefix}.ics"
-      out = count > 1 ? "#{pref}::\n" : ""
-      out += "#{pref}.code:: #{code}\n"
-      out += "#{pref}.text:: #{text}\n" if text
-      out
-    end
-  end
-end

data/lib/relaton_bib/image.rb

@@ -1,95 +0,0 @@
-module RelatonBib
-  class Image
-    # @return [String]
-    attr_accessor :src, :mimetype
-
-    # @return [String, nil]
-    attr_accessor :id, :filename, :width, :height, :alt, :title, :longdesc
-
-    #
-    # Initializes a new Image object.
-    #
-    # @param src [String] the source URL of the image
-    # @param mimetype [String] the MIME type of the image
-    # @param args [Hash] additional arguments
-    # @option id [String, nil] the ID of the image
-    # @option args [String, nil] :filename the filename of the image
-    # @option args [String, nil] :width the width of the image
-    # @option args [String, nil] :height the height of the image
-    # @option args [String, nil] :alt the alternative text for the image
-    # @option args [String, nil] :title the title of the image
-    # @option args [String, nil] :longdesc the long description of the image
-    #
-    def initialize(src:, mimetype:, **args)
-      @src = src
-      @mimetype = mimetype
-      args.each { |k, v| send "#{k}=", v }
-    end
-
-    def ==(other)
-      other.is_a?(Image) && id == other.id && src == other.src && mimetype == other.mimetype &&
-        filename == other.filename && width == other.width && height == other.height &&
-        alt == other.alt && title == other.title && longdesc == other.longdesc
-    end
-
-    #
-    # Converts the image object to XML format.
-    #
-    # @param [Nokogiri::XML::Builder] builder The XML builder object.
-    #
-    # @return [void]
-    #
-    def to_xml(builder) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
-      builder.image do
-        builder.parent[:id] = id if id
-        builder.parent[:src] = src
-        builder.parent[:mimetype] = mimetype
-        builder.parent[:filename] = filename if filename
-        builder.parent[:width] = width if width
-        builder.parent[:height] = height if height
-        builder.parent[:alt] = alt if alt
-        builder.parent[:title] = title if title
-        builder.parent[:longdesc] = longdesc if longdesc
-      end
-    end
-
-    #
-    # Converts the Image object to a hash representation.
-    #
-    # @return [Hash] The hash representation of the Image object.
-    #
-    def to_hash # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
-      hash = { "image" => { "src" => src, "mimetype" => mimetype } }
-      hash["image"]["id"] = id if id
-      hash["image"]["filename"] = filename if filename
-      hash["image"]["width"] = width if width
-      hash["image"]["height"] = height if height
-      hash["image"]["alt"] = alt if alt
-      hash["image"]["title"] = title if title
-      hash["image"]["longdesc"] = longdesc if longdesc
-      hash
-    end
-
-    #
-    # Converts the image object to AsciiBib format.
-    #
-    # @param prefix [String] The prefix to be added to the AsciiBib output.
-    #
-    # @return [String] The image object converted to AsciiBib format.
-    #
-    def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
-      pref = prefix.empty? ? "image." : "#{prefix}.image."
-      out = ""
-      out += "#{pref}id:: #{id}\n" if id
-      out += "#{pref}src:: #{src}\n"
-      out += "#{pref}mimetype:: #{mimetype}\n"
-      out += "#{pref}filename:: #{filename}\n" if filename
-      out += "#{pref}width:: #{width}\n" if width
-      out += "#{pref}height:: #{height}\n" if height
-      out += "#{pref}alt:: #{alt}\n" if alt
-      out += "#{pref}title:: #{title}\n" if title
-      out += "#{pref}longdesc:: #{longdesc}\n" if longdesc
-      out
-    end
-  end
-end

data/lib/relaton_bib/localized_string.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-module RelatonBib
-  # Localized string.
-  class LocalizedString
-    include RelatonBib
-
-    # @return [Array<String>] language Iso639 code
-    attr_reader :language
-
-    # @return [Array<String>] script Iso15924 code
-    attr_reader :script
-
-    # @return [String, Array<RelatonBib::LocalizedString>]
-    attr_accessor :content
-
-    # @param content [String, Array<RelatonBib::LocalizedString>]
-    # @param language [String] language code Iso639
-    # @param script [String] script code Iso15924
-    def initialize(content, language = nil, script = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-      if content.is_a?(Array) && content.none?
-        raise ArgumentError, "LocalizedString content is empty"
-      end
-
-      @language = language.is_a?(String) ? [language] : language
-      @script = script.is_a?(String) ? [script] : script
-      @content = if content.is_a?(Array)
-                   content.map do |c|
-                     case c
-                     when Hash
-                       LocalizedString.new c[:content], c[:language], c[:script]
-                     when String then LocalizedString.new c
-                     else c
-                     end
-                   end
-                 else cleanup content
-                 end
-    end
-
-    def ==(other)
-      return false unless other.is_a? LocalizedString
-
-      content == other.content && language == other.language && script == other.script
-    end
-
-    #
-    # String representation.
-    #
-    # @return [String]
-    #
-    def to_s
-      content.is_a?(Array) ? content.first.to_s : content.to_s
-    end
-
-    #
-    # Returns true if content is empty.
-    #
-    # @return [Boolean]
-    #
-    def empty?
-      content.empty?
-    end
-
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-      return unless content
-
-      if content.is_a?(Array)
-        content.each { |c| builder.variant { c.to_xml builder } }
-      else
-        builder.parent["language"] = language.join(",") if language&.any?
-        builder.parent["script"]   = script.join(",") if script&.any?
-        builder.parent.inner_html = encode content
-      end
-    end
-
-    #
-    # Encode content.
-    #
-    # @param [String] cnt content
-    #
-    # @return [String] encoded content
-    #
-    def encode(cnt)
-      escp cnt
-    end
-
-    #
-    # Escope HTML entities.
-    #
-    # @param [String] str input string
-    #
-    # @return [String] output string
-    #
-    def escp(str)
-      return unless str
-
-      coder = HTMLEntities.new
-      coder.encode coder.decode(str.dup.force_encoding("UTF-8"))
-    end
-
-    # @return [Hash, Array<Hash>]
-    def to_hash # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-      if content.nil? || content.is_a?(String)
-        # return content unless language || script
-
-        hash = {}
-        hash["content"] = content # unless content.nil? || content.empty?
-        hash["language"] = single_element_array(language) if language&.any?
-        hash["script"] = single_element_array(script) if script&.any?
-        hash
-      else content&.map &:to_hash
-      end
-    end
-
-    # @param prefix [String]
-    # @param count [Integer] number of elements
-    # @return [String]
-    def to_asciibib(prefix = "", count = 1, has_attrs = false) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
-      pref = prefix.empty? ? prefix : "#{prefix}."
-      case content
-      when String
-        unless language&.any? || script&.any? || has_attrs
-          return "#{prefix}:: #{content}\n"
-        end
-
-        out = count > 1 ? "#{prefix}::\n" : ""
-        out += "#{pref}content:: #{content}\n"
-        language&.each { |l| out += "#{pref}language:: #{l}\n" }
-        script&.each { |s| out += "#{pref}script:: #{s}\n" }
-        out
-      when Array
-        content.map { |c| c.to_asciibib "#{pref}variant", content.size }.join
-      else count > 1 ? "#{prefix}::\n" : ""
-      end
-    end
-
-    #
-    # Should be implemented in subclass.
-    #
-    # @param [String] str content
-    #
-    # @return [String] cleaned content
-    #
-    def cleanup(str)
-      str
-    end
-  end
-end

data/lib/relaton_bib/medium.rb

@@ -1,76 +0,0 @@
-module RelatonBib
-  class Medium
-    # @return [String, nil]
-    attr_reader :content, :genre, :form, :carrier, :size, :scale
-
-    #
-    # Initialize a Medium object.
-    #
-    # @param content [String, nil] content of the medium
-    # @param genre [String, nil] genre of the medium
-    # @param form [String, nil] form of the medium
-    # @param carrier [String, nil] carrier of the medium
-    # @param size [String, nil] size of the medium
-    # @param scale [String, nil]
-    #
-    def initialize(**args)
-      @content = args[:content]
-      @genre   = args[:genre]
-      @form    = args[:form]
-      @carrier = args[:carrier]
-      @size    = args[:size]
-      @scale   = args[:scale]
-    end
-
-    #
-    # Render Medium object to XML.
-    #
-    # @param builder [Nokogiri::XML::Builder]
-    #
-    def to_xml(builder) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-      builder.medium do
-        builder.content content if content
-        builder.genre genre if genre
-        builder.form form if form
-        builder.carrier carrier if carrier
-        builder.size size if size
-        builder.scale scale if scale
-      end
-    end
-
-    #
-    # Render Medium object to hash.
-    #
-    # @return [Hash]
-    #
-    def to_hash # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
-      hash = {}
-      hash["content"] = content if content
-      hash["genre"] = genre if genre
-      hash["form"] = form if form
-      hash["carrier"] = carrier if carrier
-      hash["size"] = size if size
-      hash["scale"] = scale if scale
-      hash
-    end
-
-    #
-    # Render Medium object to AsciiBib.
-    #
-    # @param prefix [String]
-    #
-    # @return [String]
-    #
-    def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      pref = prefix.empty? ? "medium." : "#{prefix}.medium."
-      out = ""
-      out += "#{pref}content:: #{content}\n" if content
-      out += "#{pref}genre:: #{genre}\n" if genre
-      out += "#{pref}form:: #{form}\n" if form
-      out += "#{pref}carrier:: #{carrier}\n" if carrier
-      out += "#{pref}size:: #{size}\n" if size
-      out += "#{pref}scale:: #{scale}\n" if scale
-      out
-    end
-  end
-end

data/lib/relaton_bib/organization.rb

@@ -1,165 +0,0 @@
-# frozen_string_literal: true
-
-require "relaton_bib/contributor"
-
-module RelatonBib
-  # Organization identifier.
-  class OrgIdentifier
-    # ORCID = "orcid"
-    # URI   = "uri"
-
-    # @return [String]
-    attr_reader :type
-
-    # @return [String]
-    attr_reader :value
-
-    # @param type [String]
-    # @param value [String]
-    def initialize(type, value)
-      # unless [ORCID, URI].include? type
-      #   raise ArgumentError, 'Invalid type. It should be "orsid" or "uri".'
-      # end
-
-      @type  = type
-      @value = value
-    end
-
-    def ==(other)
-      type == other.type && value == other.value
-    end
-
-    # @param builder [Nokogiri::XML::Builder]
-    def to_xml(builder)
-      builder.identifier(value, type: type)
-    end
-
-    # @return [Hash]
-    def to_hash
-      { "type" => type, "id" => value }
-    end
-
-    # @param prefix [String]
-    # @param count [Integer]
-    # @return [String]
-    def to_asciibib(prefix = "", count = 1)
-      pref = prefix.empty? ? prefix : "#{prefix}."
-      out = count > 1 ? "#{pref}identifier::\n" : ""
-      out += "#{pref}identifier.type:: #{type}\n"
-      out += "#{pref}identifier.value:: #{value}\n"
-      out
-    end
-  end
-
-  # Organization.
-  class Organization < Contributor
-    # @return [Array<RelatonBib::LocalizedString>]
-    attr_reader :name
-
-    # @return [RelatonBib::LocalizedString, nil]
-    attr_reader :abbreviation
-
-    # @return [Array<RelatonBib::LocalizedString>]
-    attr_reader :subdivision
-
-    # @return [Array<RelatonBib::OrgIdentifier>]
-    attr_reader :identifier
-
-    # @return [RelatonBib::Image, nil]
-    attr_reader :logo
-
-    # @param name [String, Hash, Array<String, Hash>]
-    # @param abbreviation [RelatoBib::LocalizedString, String]
-    # @param subdivision [Array<RelatoBib::LocalizedString>]
-    # @param url [String]
-    # @param identifier [Array<RelatonBib::OrgIdentifier>]
-    # @param contact [Array<RelatonBib::Address, RelatonBib::Contact>]
-    # @param logo [RelatonBib::Image, nil]
-    def initialize(**args) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
-      raise ArgumentError, "missing keyword: name" unless args[:name]
-
-      super(url: args[:url], contact: args[:contact] || [])
-
-      @name = if args[:name].is_a?(Array)
-                args[:name].map { |n| localized_string(n) }
-              else
-                [localized_string(args[:name])]
-              end
-
-      @abbreviation = localized_string args[:abbreviation]
-      @subdivision  = (args[:subdivision] || []).map do |sd|
-        localized_string sd
-      end
-      @identifier = args[:identifier] || []
-      @logo = args[:logo]
-    end
-
-    def ==(other)
-      name == other.name && abbreviation == other.abbreviation &&
-        subdivision == other.subdivision && identifier == other.identifier &&
-        logo == other.logo && super
-    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/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
-      opts[:builder].organization do |builder|
-        nm = name.select { |n| n.language&.include? opts[:lang] }
-        nm = name unless nm.any?
-        nm.each { |n| builder.name { |b| n.to_xml b } }
-        sbdv = subdivision.select { |sd| sd.language&.include? opts[:lang] }
-        sbdv = subdivision unless sbdv.any?
-        sbdv.each { |sd| builder.subdivision { sd.to_xml builder } }
-        builder.abbreviation { |a| abbreviation.to_xml a } if abbreviation
-        builder.uri url if uri
-        identifier.each { |identifier| identifier.to_xml builder }
-        super builder
-        builder.logo { |b| logo.to_xml b } if logo
-      end
-    end
-
-    # @return [Hash]
-    def to_hash # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
-      hash = { "name" => single_element_array(name) }
-      hash["abbreviation"] = abbreviation.to_hash if abbreviation
-      hash["identifier"] = single_element_array(identifier) if identifier&.any?
-      if subdivision&.any?
-        hash["subdivision"] = single_element_array(subdivision)
-      end
-      hash["logo"] = logo.to_hash if logo
-      { "organization" => hash.merge(super) }
-    end
-
-    # @param prefix [String]
-    # @param count [Integer]
-    # @return [String]
-    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-      pref = prefix.sub(/\*$/, "organization")
-      out = count > 1 ? "#{pref}::\n" : ""
-      name.each { |n| out += n.to_asciibib "#{pref}.name", name.size }
-      out += abbreviation.to_asciibib "#{pref}.abbreviation" if abbreviation
-      subdivision.each do |sd|
-        out += "#{pref}.subdivision::" if subdivision.size > 1
-        out += sd.to_asciibib "#{pref}.subdivision"
-      end
-      identifier.each { |n| out += n.to_asciibib pref, identifier.size }
-      out += super pref
-      out += logo.to_asciibib "#{pref}.logo" if logo
-      out
-    end
-
-    private
-
-    # @param arg [String, Hash, RelatoBib::LocalizedString]
-    # @return [RelatoBib::LocalizedString]
-    def localized_string(arg)
-      case arg
-      when String then LocalizedString.new(arg)
-      when Hash
-        LocalizedString.new(arg[:content], arg[:language], arg[:script])
-      when LocalizedString then arg
-      end
-    end
-  end
-end