Class: IsoDoc::Metadata

Inherits:
Object
  • Object
show all
Defined in:
lib/isodoc/metadata.rb,
lib/isodoc/metadata_date.rb

Constant Summary collapse

DATETYPES =
%w{published accessed created implemented obsoleted confirmed
updated issued received transmitted copied unchanged circulated vote-started
vote-ended}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(lang, script, labels) ⇒ Metadata

Returns a new instance of Metadata.



17
18
19
20
21
22
23
24
# File 'lib/isodoc/metadata.rb', line 17

def initialize(lang, script, labels)
  @metadata = {}
  DATETYPES.each { |w| @metadata["#{w.gsub(/-/, "_")}date".to_sym] = "XXX" }
  @lang = lang
  @script = script
  @c = HTMLEntities.new
  @labels = labels
end

Instance Method Details

#agency(xml) ⇒ Object



105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/isodoc/metadata.rb', line 105

def agency(xml)
  agency = ""
  publisher = []
  xml.xpath(ns("//bibdata/contributor[xmlns:role/@type = 'publisher']/"\
               "organization")).each do |org|
    name = org&.at(ns("./name"))&.text
    agency1 = org&.at(ns("./abbreviation"))&.text || name
    publisher << name if name
    agency = iso?(org) ?  "ISO/#{agency}" : "#{agency}#{agency1}/"
  end
  set(:agency, agency.sub(%r{/$}, ""))
  set(:publisher, multiple_and(publisher, @labels["and"]))
end

#author(xml, _out) ⇒ Object



81
82
83
84
# File 'lib/isodoc/metadata.rb', line 81

def author(xml, _out)
  personal_authors(xml)
  agency(xml)
end

#bibdate(isoxml, _out) ⇒ Object



86
87
88
89
90
# File 'lib/isodoc/metadata.rb', line 86

def bibdate(isoxml, _out)
  isoxml.xpath(ns("//bibdata/date")).each do |d|
    set("#{d['type'].gsub(/-/, "_")}date".to_sym, Common::date_range(d))
  end
end

#docid(isoxml, _out) ⇒ Object



155
156
157
158
# File 'lib/isodoc/metadata.rb', line 155

def docid(isoxml, _out)
  dn = isoxml.at(ns("//bibdata/docidentifier"))
  set(:docnumber, dn&.text)
end

#docnumeric(isoxml, _out) ⇒ Object



160
161
162
163
# File 'lib/isodoc/metadata.rb', line 160

def docnumeric(isoxml, _out)
  dn = isoxml.at(ns("//bibdata/docnumber"))
  set(:docnumeric, dn&.text)
end

#docstatus(isoxml, _out) ⇒ Object



127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/isodoc/metadata.rb', line 127

def docstatus(isoxml, _out)
  docstatus = isoxml.at(ns("//bibdata/status/stage"))
  set(:unpublished, true)
  if docstatus
    set(:stage, status_print(docstatus.text))
    i = isoxml&.at(ns("//bibdata/status/substage"))&.text and
      set(:substage, i)
    i = isoxml&.at(ns("//bibdata/status/iteration"))&.text and
      set(:iteration, i)
    set(:unpublished, unpublished(docstatus.text))
    unpublished(docstatus.text) and
      set(:stageabbr, stage_abbr(docstatus.text))
  end
end

#doctype(isoxml, _out) ⇒ Object



92
93
94
95
96
# File 'lib/isodoc/metadata.rb', line 92

def doctype(isoxml, _out)
  b = isoxml&.at(ns("//bibdata/ext/doctype"))&.text || return
  t = b.split(/[- ]/).map{ |w| w.capitalize }.join(" ")
  set(:doctype, t)
end

#draftinfo(draft, revdate) ⇒ Object



165
166
167
168
169
170
171
172
173
# File 'lib/isodoc/metadata.rb', line 165

def draftinfo(draft, revdate)
  draftinfo = ""
  if draft
    draftinfo = " (#{@labels["draft_label"]} #{draft}"
    draftinfo += ", #{revdate}" if revdate
    draftinfo += ")"
  end
  l10n(draftinfo, @lang, @script)
end

#extract_person_affiliations(authors) ⇒ Object



52
53
54
55
56
57
58
59
60
61
# File 'lib/isodoc/metadata.rb', line 52

def extract_person_affiliations(authors)
  authors.inject([]) do |m, a|
    name = a&.at(ns("./affiliation/organization/name"))&.text
    location = a&.at(ns("./affiliation/organization/address/"\
                        "formattedAddress"))&.text
    m << ((!name.nil? && !location.nil?) ? "#{name}, #{location}" :
      (name || location || ""))
    m
  end
end

#extract_person_names(authors) ⇒ Object



38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/isodoc/metadata.rb', line 38

def extract_person_names(authors)
  authors.inject([]) do |ret, a|
    if a.at(ns("./name/completename"))
      ret << a.at(ns("./name/completename")).text
    else
      fn = []
      forenames = a.xpath(ns("./name/forename"))
      forenames.each { |f| fn << f.text }
      surname = a&.at(ns("./name/surname"))&.text
      ret << fn.join(" ") + " " + surname
    end
  end
end

#extract_person_names_affiliations(authors) ⇒ Object



63
64
65
66
67
68
69
70
71
72
# File 'lib/isodoc/metadata.rb', line 63

def extract_person_names_affiliations(authors)
  names = extract_person_names(authors)
  affils = extract_person_affiliations(authors)
  ret = {}
  affils.each_with_index do |a, i|
    ret[a] ||= []
    ret[a] << names[i]
  end
  ret
end

#getObject



26
27
28
# File 'lib/isodoc/metadata.rb', line 26

def get
  @metadata
end

#iso?(org) ⇒ Boolean

Returns:

  • (Boolean)


98
99
100
101
102
103
# File 'lib/isodoc/metadata.rb', line 98

def iso?(org)
  name = org&.at(ns("./name"))&.text
  abbrev = org&.at(ns("./abbreviation"))&.text
  (abbrev == "ISO" ||
   name == "International Organization for Standardization" )
end

#keywords(isoxml, _out) ⇒ Object



222
223
224
225
226
# File 'lib/isodoc/metadata.rb', line 222

def keywords(isoxml, _out)
  ret = []
  isoxml.xpath(ns("//bibdata/keyword")).each { |kw| ret << kw.text }
  set(:keywords, ret)
end

#l10n(a, b, c) ⇒ Object



13
14
15
# File 'lib/isodoc/metadata.rb', line 13

def l10n(a, b, c)
  IsoDoc::Function::I18n::l10n(a, b, c)
end

#labelsObject



30
31
32
# File 'lib/isodoc/metadata.rb', line 30

def labels
  @labels
end

#MMMddyyyy(isodate) ⇒ Object



27
28
29
30
31
32
33
34
35
36
37
# File 'lib/isodoc/metadata_date.rb', line 27

def MMMddyyyy(isodate)
  return nil if isodate.nil?
  arr = isodate.split("-")
  date = if arr.size == 1 and (/^\d+$/.match isodate)
           Date.new(*arr.map(&:to_i)).strftime("%Y")
         elsif arr.size == 2
           Date.new(*arr.map(&:to_i)).strftime("%B %Y")
         else
           Date.parse(isodate).strftime("%B %d, %Y")
         end
end

#monthsObject



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# File 'lib/isodoc/metadata_date.rb', line 3

def months
{
    "01": @labels["month_january"],
    "02": @labels["month_february"],
    "03": @labels["month_march"],
    "04": @labels["month_april"],
    "05": @labels["month_may"],
    "06": @labels["month_june"],
    "07": @labels["month_july"],
    "08": @labels["month_august"],
    "09": @labels["month_september"],
    "10": @labels["month_october"],
    "11": @labels["month_november"],
    "12": @labels["month_december"],
}
end

#monthyr(isodate) ⇒ Object



20
21
22
23
24
25
# File 'lib/isodoc/metadata_date.rb', line 20

def monthyr(isodate)
  m = /(?<yr>\d\d\d\d)-(?<mo>\d\d)/.match isodate
  return isodate unless m && m[:yr] && m[:mo]
  IsoDoc::Function::I18n::l10n("#{months[m[:mo].to_sym]} #{m[:yr]}",
                               @lang, @script)
end

#multiple_and(names, andword) ⇒ Object



119
120
121
122
123
124
125
# File 'lib/isodoc/metadata.rb', line 119

def multiple_and(names, andword)
  return "" if names.length == 0
  return names[0] if names.length == 1
  names.length == 2 and
    return l10n("#{names[0]} #{andword} #{names[1]}", @lang, @script)
  l10n(names[0..-2].join(", ") + " #{andword} #{names[-1]}", @lang, @script)
end

#ns(xpath) ⇒ Object



9
10
11
# File 'lib/isodoc/metadata.rb', line 9

def ns(xpath)
  Common::ns(xpath)
end

#personal_authors(isoxml) ⇒ Object



74
75
76
77
78
79
# File 'lib/isodoc/metadata.rb', line 74

def personal_authors(isoxml)
  authors = isoxml.xpath(ns("//bibdata/contributor[role/@type = 'author' "\
                            "or xmlns:role/@type = 'editor']/person"))
  set(:authors, extract_person_names(authors))
  set(:authors_affiliations, extract_person_names_affiliations(authors))
end

#relations(isoxml, _out) ⇒ Object



195
196
197
198
# File 'lib/isodoc/metadata.rb', line 195

def relations(isoxml, _out)
  relations_obsoletes(isoxml)
  relations_partof(isoxml)
end

#relations_obsoletes(isoxml) ⇒ Object



206
207
208
209
210
211
212
# File 'lib/isodoc/metadata.rb', line 206

def relations_obsoletes(isoxml)
  std = isoxml.at(ns("//bibdata/relation[@type = 'obsoletes']")) || return
  locality = std.at(ns(".//locality"))
  id = std.at(ns(".//docidentifier"))
  set(:obsoletes, id.text) if id
  set(:obsoletes_part, locality.text) if locality
end

#relations_partof(isoxml) ⇒ Object



200
201
202
203
204
# File 'lib/isodoc/metadata.rb', line 200

def relations_partof(isoxml)
  std = isoxml.at(ns("//bibdata/relation[@type = 'partOf']")) || return
  id = std.at(ns(".//docidentifier"))
  set(:partof, id.text) if id
end

#set(key, value) ⇒ Object



34
35
36
# File 'lib/isodoc/metadata.rb', line 34

def set(key, value)
  @metadata[key] = value
end

#stage_abbr(docstatus) ⇒ Object



142
143
144
145
# File 'lib/isodoc/metadata.rb', line 142

def stage_abbr(docstatus)
  status_print(docstatus).split(/ /).
    map { |s| s[0].upcase }.join("")
end

#status_print(status) ⇒ Object



151
152
153
# File 'lib/isodoc/metadata.rb', line 151

def status_print(status)
  status.split(/-/).map{ |w| w.capitalize }.join(" ")
end

#subtitle(isoxml, _out) ⇒ Object



191
192
193
# File 'lib/isodoc/metadata.rb', line 191

def subtitle(isoxml, _out)
  nil
end

#title(isoxml, _out) ⇒ Object



186
187
188
189
# File 'lib/isodoc/metadata.rb', line 186

def title(isoxml, _out)
  main = isoxml&.at(ns("//bibdata/title[@language='en']"))&.text
  set(:doctitle, main)
end

#unpublished(status) ⇒ Object



147
148
149
# File 'lib/isodoc/metadata.rb', line 147

def unpublished(status)
  !(status.downcase == "published")
end

#url(xml, _out) ⇒ Object



214
215
216
217
218
219
220
# File 'lib/isodoc/metadata.rb', line 214

def url(xml, _out)
  a = xml.at(ns("//bibdata/uri[not(@type)]")) and set(:url, a.text)
  a = xml.at(ns("//bibdata/uri[@type = 'html']")) and set(:html, a.text)
  a = xml.at(ns("//bibdata/uri[@type = 'xml']")) and set(:xml, a.text)
  a = xml.at(ns("//bibdata/uri[@type = 'pdf']")) and set(:pdf, a.text)
  a = xml.at(ns("//bibdata/uri[@type = 'doc']")) and set(:doc, a.text)
end

#version(isoxml, _out) ⇒ Object



175
176
177
178
179
180
181
182
183
184
# File 'lib/isodoc/metadata.rb', line 175

def version(isoxml, _out)
  set(:edition, isoxml&.at(ns("//bibdata/edition"))&.text)
  set(:docyear, isoxml&.at(ns("//bibdata/copyright/from"))&.text)
  set(:draft, isoxml&.at(ns("//version/draft"))&.text)
  revdate = isoxml&.at(ns("//version/revision-date"))&.text
  set(:revdate, revdate)
  set(:revdate_monthyear, monthyr(revdate))
  set(:draftinfo,
      draftinfo(get[:draft], get[:revdate]))
end