Class: Pubid::Core::Renderer::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/pubid/core/renderer/base.rb

Direct Known Subclasses

Urn

Constant Summary collapse

LANGUAGES =
{
  "ru" => "R",
  "fr" => "F",
  "en" => "E",
  "ar" => "A",
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params) ⇒ Base

Returns a new instance of Base.



12
13
14
# File 'lib/pubid/core/renderer/base.rb', line 12

def initialize(params)
  @params = params
end

Instance Attribute Details

#paramsObject

Returns the value of attribute params.



3
4
5
# File 'lib/pubid/core/renderer/base.rb', line 3

def params
  @params
end

Instance Method Details

#prerender(**opts) ⇒ Renderer::Base

Prerender parameters and store in @prerendered_params

Parameters:

  • opts (Hash)

    options for render method, eg. { with_language_code: :single, with_date: true }

Returns:



19
20
21
22
23
# File 'lib/pubid/core/renderer/base.rb', line 19

def prerender(**opts)
  @prerendered_params = prerender_params(@params, opts)
  @prerendered_params.default = ""
  self
end

#prerender_params(params, opts) ⇒ Object



32
33
34
35
36
37
38
39
40
41
# File 'lib/pubid/core/renderer/base.rb', line 32

def prerender_params(params, opts)
  params.map do |key, value|
    next unless value
    if respond_to?("render_#{key}")
      [key, send("render_#{key}", value, opts, params)]
    else
      [key, value]
    end
  end.compact.to_h
end

#render(with_date: true, with_language_code: :iso, **args) ⇒ Object

Render identifier

Parameters:

  • with_date (Boolean) (defaults to: true)

    include year in output

  • with_language_code (:iso, :single) (defaults to: :iso)

    render document language as 2-letter ISO 639-1 language code or single code



75
76
77
78
79
80
81
# File 'lib/pubid/core/renderer/base.rb', line 75

def render(with_date: true, with_language_code: :iso, **args)
  if %i(amd cor).include? @params[:type]&.type
    render_supplement(@params, **args.merge({ with_date: with_date, with_language_code: with_language_code}))
  else
    render_base_identifier(**args.merge({ with_date: with_date, with_language_code: with_language_code})) + @prerendered_params[:language].to_s
  end
end

#render_amendments(amendments, _opts, _params) ⇒ Object



102
103
104
# File 'lib/pubid/core/renderer/base.rb', line 102

def render_amendments(amendments, _opts, _params)
  amendments.sort.map(&:render_pubid).join("+")
end

#render_base(params, prefix = "") ⇒ Object



83
84
85
# File 'lib/pubid/core/renderer/base.rb', line 83

def render_base(params, prefix = "")
  "%{publisher}%{copublisher}#{prefix} %{number}" % params
end

#render_base_identifier(**args) ⇒ Object



25
26
27
28
29
# File 'lib/pubid/core/renderer/base.rb', line 25

def render_base_identifier(**args)
  prerender(**args)

  render_identifier(@prerendered_params)
end

#render_copublisher(copublisher, _opts, _params) ⇒ Object



91
92
93
94
95
96
97
98
99
100
# File 'lib/pubid/core/renderer/base.rb', line 91

def render_copublisher(copublisher, _opts, _params)
  # ([email protected]_a?(Array) && [@copublisher]) || @copublisher
  if copublisher.is_a?(Array)
    copublisher.map(&:to_s).sort.map do |copublisher|
      "/#{copublisher.gsub('-', '/')}"
    end.join
  else
    "/#{copublisher}"
  end
end

#render_corrigendums(corrigendums, _opts, _params) ⇒ Object



106
107
108
# File 'lib/pubid/core/renderer/base.rb', line 106

def render_corrigendums(corrigendums, _opts, _params)
  corrigendums.sort.map(&:render_pubid).join("+")
end

#render_identifier(params) ⇒ Object



87
88
89
# File 'lib/pubid/core/renderer/base.rb', line 87

def render_identifier(params)
  render_base(params)
end

#render_language(language, opts, _params) ⇒ Object



119
120
121
122
123
124
125
# File 'lib/pubid/core/renderer/base.rb', line 119

def render_language(language, opts, _params)
  if opts[:with_language_code] == :single
    "(#{LANGUAGES[language]})"
  else
    "(#{language})"
  end
end

#render_part(part, opts, _params) ⇒ Object



111
112
113
# File 'lib/pubid/core/renderer/base.rb', line 111

def render_part(part, opts, _params)
  "-#{part}"
end

#render_supplement(supplement_params, **args) ⇒ Object

Renders amendment and corrigendum when applied through identifier type



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/pubid/core/renderer/base.rb', line 44

def render_supplement(supplement_params, **args)
  if supplement_params[:base].type == :amd
    # render inner amendment (cor -> amd -> base)
    render_supplement(supplement_params[:base].get_params, **args)
  else
    self.class.new(supplement_params[:base].get_params).render_base_identifier(
      # always render year for identifiers with supplement
      **args.merge({ with_date: true }),
    )
  end +
    case supplement_params[:type].type
    when :amd
      render_amendments(
        [Pubid::Iso::Amendment.new(**supplement_params.slice(:number, :year, :stage, :edition, :iteration))],
        args,
        nil,
      )
    when :cor
      render_corrigendums(
        [Pubid::Iso::Corrigendum.new(**supplement_params.slice(:number, :year, :stage, :edition, :iteration))],
        args,
        nil,
      )
      # copy parameters from Identifier only supported by Corrigendum
    end +
    (supplement_params[:base].language ? render_language(supplement_params[:base].language, args, nil) : "")
end

#render_year(year, opts, _params) ⇒ Object



115
116
117
# File 'lib/pubid/core/renderer/base.rb', line 115

def render_year(year, opts, _params)
  opts[:with_date] && ":#{year}" || ""
end