Class: RelatonBib::LocalizedString

Inherits:
Object
  • Object
show all
Includes:
RelatonBib
Defined in:
lib/relaton_bib/localized_string.rb

Overview

Localized string.

Direct Known Subclasses

Forename, FormattedString

Constant Summary

Constants included from RelatonBib

VERSION

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from RelatonBib

array, format_date, grammar_hash, parse_date, parse_yaml

Methods included from Config

#configuration, #configure

Constructor Details

#initialize(content, language = nil, script = nil) ⇒ LocalizedString

Returns a new instance of LocalizedString.

Parameters:

  • content (String, Array<RelatonBib::LocalizedString>)
  • language (String) (defaults to: nil) —

    language code Iso639

  • script (String) (defaults to: nil) —

    script code Iso15924



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/relaton_bib/localized_string.rb', line 20

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

Instance Attribute Details

#content ⇒ String, Array<RelatonBib::LocalizedString>

Returns:



15
16
17
 
# File 'lib/relaton_bib/localized_string.rb', line 15

def content
  @content
end

#language ⇒ Array<String> (readonly)

Returns language Iso639 code.

Returns:

  • (Array<String>) —

    language Iso639 code



9
10
11
 
# File 'lib/relaton_bib/localized_string.rb', line 9

def language
  @language
end

#script ⇒ Array<String> (readonly)

Returns script Iso15924 code.

Returns:

  • (Array<String>) —

    script Iso15924 code



12
13
14
 
# File 'lib/relaton_bib/localized_string.rb', line 12

def script
  @script
end

Instance Method Details

#cleanup(str) ⇒ String

Should be implemented in subclass.

Parameters:

  • str (String) —

    content

Returns:

  • (String) —

    cleaned content



139
140
141
 
# File 'lib/relaton_bib/localized_string.rb', line 139

def cleanup(str)
  str
end

#empty? ⇒ Boolean

Returns true if content is empty.

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/relaton_bib/localized_string.rb', line 54

def empty?
  content.empty?
end

#encode(cnt) ⇒ String

Encode content.

Parameters:

  • cnt (String) —

    content

Returns:

  • (String) —

    encoded content



78
79
80
 
# File 'lib/relaton_bib/localized_string.rb', line 78

def encode(cnt) # rubocop:disable Metrics/MethodLength
  escp cnt
end

#escp(str) ⇒ String

Escope HTML entities.

Parameters:

  • str (String) —

    input string

Returns:

  • (String) —

    output string



89
90
91
92
93
94
 
# File 'lib/relaton_bib/localized_string.rb', line 89

def escp(str)
  return unless str

  coder = HTMLEntities.new
  coder.encode coder.decode(str.dup.force_encoding("UTF-8"))
end

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

Parameters:

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

    number of elements

Returns:

  • (String) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/relaton_bib/localized_string.rb', line 113

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

#to_hash ⇒ Hash+

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/relaton_bib/localized_string.rb', line 97

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

#to_s ⇒ String

String representation.

Returns:

  • (String) 


45
46
47
 
# File 'lib/relaton_bib/localized_string.rb', line 45

def to_s
  content.is_a?(Array) ? content.first.to_s : content.to_s
end

#to_xml(builder) ⇒ Object

Parameters:

  • builder (Nokogiri::XML::Builder) 


59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/relaton_bib/localized_string.rb', line 59

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