Class: RelatonBib::Affiliation

Inherits:

Object

• Object
• RelatonBib::Affiliation

Includes:

RelatonBib

Defined in:

lib/relaton_bib/contributor.rb

Overview

Affiliation.

Constant Summary

Constants included from RelatonBib

VERSION

Instance Attribute Summary

• #name ⇒ RelatonBib::LocalizedString^? readonly
• #organization ⇒ RelatonBib::Organization readonly

Instance Method Summary

• #description(lang = nil) ⇒ Object

  Get description.

• #description_xml(builder) ⇒ Object
• #initialize(organization: nil, name: nil, description: []) ⇒ Affiliation constructor

  A new instance of Affiliation.

• #name_xml(builder) ⇒ Object
• #to_asciibib(prefix = "", count = 1) ⇒ String
• #to_hash ⇒ Hash

  Render affiliation as hash.

• #to_xml(**opts) ⇒ Object

Methods included from RelatonBib

array, format_date, grammar_hash, parse_date, parse_yaml

Methods included from Config

#configuration, #configure

Constructor Details

#initialize(organization: nil, name: nil, description: []) ⇒ Affiliation

Returns a new instance of Affiliation.

Parameters:

• organization (RelatonBib::Organization, nil) (defaults to: nil)
• name (RelatonBib::LocalizedString, nil) (defaults to: nil)
• description (Array<RelatonBib::FormattedString>) (defaults to: [])

# File 'lib/relaton_bib/contributor.rb', line 141

def initialize(organization: nil, name: nil, description: [])
  @name = name
  @organization = organization
  @description  = description
end

Instance Attribute Details

#name ⇒ RelatonBib::LocalizedString^? (readonly)

Returns:

• (RelatonBib::LocalizedString, nil)

# File 'lib/relaton_bib/contributor.rb', line 133

def name
  @name
end

#organization ⇒ RelatonBib::Organization (readonly)

Returns:

• (RelatonBib::Organization)

# File 'lib/relaton_bib/contributor.rb', line 136

def organization
  @organization
end

Instance Method Details

#description(lang = nil) ⇒ Object

Get description.

Parameters:

• lang (String, nil) (defaults to: nil) —

  language if nil return all description

# File 'lib/relaton_bib/contributor.rb', line 175

def description(lang = nil)
  return @description unless lang

  @description.select { |d| d.language&.include? lang }
end

#description_xml(builder) ⇒ Object

# File 'lib/relaton_bib/contributor.rb', line 164

def description_xml(builder)
  description.each { |d| builder.description { d.to_xml builder } }
end

#name_xml(builder) ⇒ Object

# File 'lib/relaton_bib/contributor.rb', line 160

def name_xml(builder)
  builder.name { name.to_xml builder } if name
end

#to_asciibib(prefix = "", count = 1) ⇒ String

Parameters:

• prefix (String) (defaults to: "")
• count (Integer) (defaults to: 1)

Returns:

• (String)

# File 'lib/relaton_bib/contributor.rb', line 198

def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize
  pref = prefix.empty? ? prefix : "#{prefix}."
  out = count > 1 ? "#{pref}affiliation::\n" : ""
  out += name.to_asciibib "#{pref}affiliation.name" if name
  description.each do |d|
    out += d.to_asciibib "#{pref}affiliation.description", description.size
  end
  out += organization.to_asciibib "#{pref}affiliation.*" if organization
  out
end

#to_hash ⇒ Hash

Render affiliation as hash.

Returns:

• (Hash)

# File 'lib/relaton_bib/contributor.rb', line 186

def to_hash
  hash = organization&.to_hash || {}
  hash["name"] = name.to_hash if name
  if description&.any?
    hash["description"] = single_element_array(description)
  end
  hash
end

#to_xml(**opts) ⇒ Object

Parameters:

• opts (Hash)

Options Hash (**opts):

• :builder (Nokogiri::XML::Builder) —

  XML builder

• :lang (String) —

  language

# File 'lib/relaton_bib/contributor.rb', line 150

def to_xml(**opts)
  return unless organization || name || description&.any?

  opts[:builder].affiliation do |builder|
    name_xml builder
    description_xml builder
    organization&.to_xml(**opts)
  end
end