Class: RelatonBib::BibliographicItem

Inherits:
Object
  • Object
show all
Includes:
RelatonBib
Defined in:
lib/relaton_bib/biblio_version.rb,
lib/relaton_bib/bibliographic_item.rb

Overview

Bibliographic item

Defined Under Namespace

Classes: Version

Constant Summary collapse

TYPES = 
%W[article book booklet conference manual proceedings presentation
thesis techreport standard unpublished map electronic\sresource
audiovisual film video broadcast graphic_work music patent
inbook incollection inproceedings journal software website
webresource dataset archival social_media alert message
conversation misc].freeze

Constants included from RelatonBib

VERSION

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RelatonBib

parse_date

Constructor Details

#initialize(**args) ⇒ BibliographicItem

Returns a new instance of BibliographicItem.

Parameters:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 201

def initialize(**args)
  if args[:type] && !TYPES.include?(args[:type])
    warn %{[relaton-bib] document type "#{args[:type]}" is invalid.}
  end

  @title = TypedTitleStringCollection.new(args[:title])

  @date = (args[:date] || []).map do |d|
    d.is_a?(Hash) ? BibliographicDate.new(**d) : d
  end

  @contributor = (args[:contributor] || []).map do |c|
    if c.is_a? Hash
      e = c[:entity].is_a?(Hash) ? Organization.new(**c[:entity]) : c[:entity]
      ContributionInfo.new(entity: e, role: c[:role])
    else c
    end
  end

  @abstract = (args[:abstract] || []).map do |a|
    a.is_a?(Hash) ? FormattedString.new(**a) : a
  end

  @copyright = args.fetch(:copyright, []).map do |c|
    c.is_a?(Hash) ? CopyrightAssociation.new(**c) : c
  end

  @docidentifier  = args[:docid] || []
  @formattedref   = args[:formattedref] if title.empty?
  @id             = args[:id] || makeid(nil, false)
  @type           = args[:type]
  @docnumber      = args[:docnumber]
  @edition        = args[:edition]
  @version        = args[:version]
  @biblionote     = args.fetch :biblionote, BiblioNoteCollection.new([])
  @language       = args.fetch :language, []
  @script         = args.fetch :script, []
  @status         = args[:docstatus]
  @relation       = DocRelationCollection.new(args[:relation] || [])
  @link           = args.fetch(:link, []).map do |s|
    case s
    when Hash then TypedUri.new(**s)
    when String then TypedUri.new(content: s)
    else s
    end
  end
  @series         = args.fetch :series, []
  @medium         = args[:medium]
  @place          = args.fetch(:place, []).map do |pl|
    pl.is_a?(String) ? Place.new(name: pl) : pl
  end
  @extent         = args[:extent] || []
  @size           = args[:size]
  @accesslocation = args.fetch :accesslocation, []
  @classification = args.fetch :classification, []
  @validity       = args[:validity]
  # we should pass the fetched arg from scrappers
  @fetched        = args.fetch :fetched, nil
  @keyword        = (args[:keyword] || []).map do |kw|
    LocalizedString.new(kw)
  end
  @license        = args.fetch :license, []
  @doctype        = args[:doctype]
  @subdoctype     = args[:subdoctype]
  @editorialgroup = args[:editorialgroup]
  @ics            = args.fetch :ics, []
  @structuredidentifier = args[:structuredidentifier]
end

Instance Attribute Details

#abstract(lang: nil) ⇒ RelatonBib::FormattedString+

Parameters:

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

    language code Iso639

Returns:




# File 'lib/relaton_bib/bibliographic_item.rb', line 80

#accesslocation ⇒ Array<Strig> (readonly)

Returns:



105
106
107
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 105

def accesslocation
  @accesslocation
end

#all_parts ⇒ TrueClass, ...

Returns:

  • (TrueClass, FalseClass, NilClass) 


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

def all_parts
  @all_parts
end

#biblionote ⇒ RelatonBib::BiblioNoteCollection (readonly)

Returns:



69
70
71
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 69

def biblionote
  @biblionote
end

#classification ⇒ Array<Relaton::Classification> (readonly)

Returns:

  • (Array<Relaton::Classification>) 


108
109
110
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 108

def classification
  @classification
end

#contributor ⇒ Array<RelatonBib::ContributionInfo> (readonly)

Returns:



63
64
65
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 63

def contributor
  @contributor
end

#copyright ⇒ Array<RelatonBib::CopyrightAssociation> (readonly)

Returns:



87
88
89
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 87

def copyright
  @copyright
end

#date ⇒ Array<RelatonBib::BibliographicDate>

Returns:



60
61
62
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 60

def date
  @date
end

#docidentifier ⇒ Array<RelatonBib::DocumentIdentifier> (readonly)

Returns:



57
58
59
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 57

def docidentifier
  @docidentifier
end

#docnumber ⇒ String, NilClass (readonly)

Returns:

  • (String, NilClass) 


48
49
50
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 48

def docnumber
  @docnumber
end

#doctype ⇒ String, NilClass (readonly)

Returns:

  • (String, NilClass) 


48
49
50
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 48

def doctype
  @doctype
end

#edition ⇒ String, NilClass (readonly)

Returns:

  • (String, NilClass) 


48
49
50
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 48

def edition
  @edition
end

#editorialgroup ⇒ RelatonBib::EditorialGroup? (readonly)

Returns:



120
121
122
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 120

def editorialgroup
  @editorialgroup
end

#extent ⇒ Array<RelatonBib::Locality, RelatonBib::LocalityStack> (readonly)

Returns:



102
103
104
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 102

def extent
  @extent
end

#fetched ⇒ Date (readonly)

Returns:

  • (Date) 


114
115
116
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 114

def fetched
  @fetched
end

#formattedref ⇒ RelatonBib::FormattedRef, NilClass (readonly)

Returns:



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

def formattedref
  @formattedref
end

#ics ⇒ Array<RelatonBib:ICS> (readonly)

Returns:

  • (Array<RelatonBib:ICS>) 


123
124
125
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 123

def ics
  @ics
end

#id ⇒ String, NilClass (readonly)

Returns:

  • (String, NilClass) 


48
49
50
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 48

def id
  @id
end

#keyword ⇒ Array<RelatonBib::LocalizedString> (readonly)

Returns:



117
118
119
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 117

def keyword
  @keyword
end

#language ⇒ Array<String> (readonly)

Returns language Iso639 code.

Returns:

  • (Array<String>) —

    language Iso639 code



72
73
74
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 72

def language
  @language
end

#license ⇒ Array<Strig> (readonly)

Returns:



105
106
107
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 105

def license
  @license
end

#link ⇒ Array<RelatonBib::TypedUri> (readonly)

Returns:



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

def link
  @link
end

#medium ⇒ RelatonBib::Medium, NilClass (readonly)

Returns:



96
97
98
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 96

def medium
  @medium
end

#place ⇒ Array<RelatonBib::Place> (readonly)

Returns:



99
100
101
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 99

def place
  @place
end

#relation ⇒ RelatonBib::DocRelationCollection (readonly)

Returns:



90
91
92
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 90

def relation
  @relation
end

#script ⇒ Array<String> (readonly)

Returns script Iso15924 code.

Returns:

  • (Array<String>) —

    script Iso15924 code



75
76
77
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 75

def script
  @script
end

#series ⇒ Array<RelatonBib::Series> (readonly)

Returns:



93
94
95
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 93

def series
  @series
end

#size ⇒ RelatonBib::BibliographicSize? (readonly)

Returns:



129
130
131
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 129

def size
  @size
end

#status ⇒ RelatonBib::DocumentStatus, NilClass (readonly)

Returns:



84
85
86
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 84

def status
  @status
end

#structuredidentifier ⇒ RelatonBib::StructuredIdentifierCollection (readonly)

Returns:



126
127
128
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 126

def structuredidentifier
  @structuredidentifier
end

#subdoctype ⇒ String, NilClass (readonly)

Returns:

  • (String, NilClass) 


48
49
50
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 48

def subdoctype
  @subdoctype
end

#title(lang: nil) ⇒ RelatonIsoBib::TypedTitleStringCollection (readonly)

Parameters:

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

    language code Iso639

Returns:

  • (RelatonIsoBib::TypedTitleStringCollection) 



# File 'lib/relaton_bib/bibliographic_item.rb', line 50

#type ⇒ String, NilClass (readonly)

Returns:

  • (String, NilClass) 


48
49
50
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 48

def type
  @type
end

#validity ⇒ RelatonBib:Validity, NilClass (readonly)

Returns:

  • (RelatonBib:Validity, NilClass) 


111
112
113
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 111

def validity
  @validity
end

#version ⇒ RelatonBib::BibliographicItem::Version, NilClass (readonly)

Returns:



66
67
68
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 66

def version
  @version
end

Class Method Details

.from_hash(hash) ⇒ RelatonBipm::BipmBibliographicItem

Parameters:

  • hash (Hash)

Returns:

  • (RelatonBipm::BipmBibliographicItem) 


274
275
276
277
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 274

def self.from_hash(hash)
  item_hash = Object.const_get(name.split("::")[0])::HashConverter.hash_to_bib(hash)
  new(**item_hash)
end

Instance Method Details

#deep_clone ⇒ Object 



444
445
446
447
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 444

def deep_clone
  dump = Marshal.dump self
  Marshal.load dump # rubocop:disable Security/MarshalLoad
end

#disable_id_attribute ⇒ Object 



449
450
451
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 449

def disable_id_attribute
  @id_attribute = false
end

#makeid(id, attribute) ⇒ String

Parameters:

Returns:

  • (String) 


292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 292

def makeid(id, attribute)
  return nil if attribute && !@id_attribute

  id ||= @docidentifier.reject { |i| i.type == "DOI" }[0]
  return unless id

  # contribs = publishers.map { |p| p&.entity&.abbreviation }.join '/'
  # idstr = "#{contribs}#{delim}#{id.project_number}"
  # idstr = id.project_number.to_s
  idstr = id.id.gsub(/:/, "-").gsub(/\s/, "")
  # if id.part_number&.size&.positive? then idstr += "-#{id.part_number}"
  idstr.strip
end

#revdate ⇒ String, NilClass

If revision_date exists then returns it else returns published date or nil

Returns:

  • (String, NilClass) 


497
498
499
500
501
502
503
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 497

def revdate # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
  @revdate ||= if version&.revision_date
                 version.revision_date
               else
                 date.detect { |d| d.type == "published" }&.on&.to_s
               end
end

#shortref(identifier, **opts) ⇒ String

Parameters:

Returns:

  • (String) 


311
312
313
314
315
316
317
318
319
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 311

def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
  pubdate = date.select { |d| d.type == "published" }
  year = if opts[:no_year] || pubdate.empty? then ""
         else ":#{pubdate&.first&.on(:year)}"
         end
  year += ": All Parts" if opts[:all_parts] || @all_parts

  "#{makeid(identifier, false)}#{year}"
end

#to_all_parts ⇒ Object

remove title part components and abstract



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 454

def to_all_parts # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength,Metrics/PerceivedComplexity
  me = deep_clone
  me.disable_id_attribute
  me.relation << DocumentRelation.new(type: "instance", bibitem: self)
  me.language.each do |l|
    me.title.delete_title_part!
    ttl = me.title.select do |t|
      t.type != "main" && t.title.language&.include?(l)
    end
    tm_en = ttl.map { |t| t.title.content }.join " – "
    me.title.detect do |t|
      t.type == "main" && t.title.language&.include?(l)
    end&.title&.content = tm_en
  end
  me.abstract = []
  me.docidentifier.each(&:remove_part)
  me.docidentifier.each(&:all_parts)
  me.structuredidentifier.remove_part
  me.structuredidentifier.all_parts
  me.docidentifier.each &:remove_date
  me.structuredidentifier&.remove_date
  me.all_parts = true
  me
end

#to_asciibib(prefix = "") ⇒ String

Parameters:

  • prefix (String) (defaults to: "")

Returns:

  • (String) 


507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 507

def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
  pref = prefix.empty? ? prefix : "#{prefix}."
  out = prefix.empty? ? "[%bibitem]\n== {blank}\n" : ""
  out += "#{pref}id:: #{id}\n" if id
  out += "#{pref}fetched:: #{fetched}\n" if fetched
  title.each { |t| out += t.to_asciibib(prefix, title.size) }
  out += "#{pref}type:: #{type}\n" if type
  docidentifier.each do |di|
    out += di.to_asciibib prefix, docidentifier.size
  end
  out += "#{pref}docnumber:: #{docnumber}\n" if docnumber
  out += "#{pref}edition:: #{edition}\n" if edition
  language.each { |l| out += "#{pref}language:: #{l}\n" }
  script.each { |s| out += "#{pref}script:: #{s}\n" }
  out += version.to_asciibib prefix if version
  biblionote&.each { |b| out += b.to_asciibib prefix, biblionote.size }
  out += status.to_asciibib prefix if status
  date.each { |d| out += d.to_asciibib prefix, date.size }
  abstract.each do |a|
    out += a.to_asciibib "#{pref}abstract", abstract.size
  end
  copyright.each { |c| out += c.to_asciibib prefix, copyright.size }
  link.each { |l| out += l.to_asciibib prefix, link.size }
  out += medium.to_asciibib prefix if medium
  place.each { |pl| out += pl.to_asciibib prefix, place.size }
  extent.each { |ex| out += ex.to_asciibib "#{pref}extent", extent.size }
  out += size.to_asciibib pref if size
  accesslocation.each { |al| out += "#{pref}accesslocation:: #{al}\n" }
  classification.each do |cl|
    out += cl.to_asciibib prefix, classification.size
  end
  out += validity.to_asciibib prefix if validity
  contributor.each do |c|
    out += c.to_asciibib "contributor.*", contributor.size
  end
  out += relation.to_asciibib prefix if relation
  series.each { |s| out += s.to_asciibib prefix, series.size }
  out += "#{pref}doctype:: #{doctype}\n" if doctype
  out += "#{pref}subdoctype:: #{subdoctype}\n" if subdoctype
  out += "#{pref}formattedref:: #{formattedref}\n" if formattedref
  keyword.each { |kw| out += kw.to_asciibib "#{pref}keyword", keyword.size }
  out += editorialgroup.to_asciibib prefix if editorialgroup
  ics.each { |i| out += i.to_asciibib prefix, ics.size }
  out += structuredidentifier.to_asciibib prefix if structuredidentifier
  out
end

#to_bibtex(bibtex = nil) ⇒ String

Reander BibTeX

Parameters:

  • bibtex (BibTeX::Bibliography, nil) (defaults to: nil)

Returns:

  • (String) 


413
414
415
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 413

def to_bibtex(bibtex = nil)
  bibtext_item(bibtex).to_s
end

#to_bibxml(builder = nil, include_keywords: false) ⇒ String, Nokogiri::XML::Builder::NodeBuilder

Render BibXML (RFC)

Parameters:

  • builder (Nokogiri::XML::Builder, nil) (defaults to: nil)
  • include_keywords (Boolean) (defaults to: false) —

    (false)

Returns:

  • (String, Nokogiri::XML::Builder::NodeBuilder) —

    XML



345
346
347
348
349
350
351
352
353
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 345

def to_bibxml(builder = nil, include_keywords: false)
  if builder
    render_bibxml builder, include_keywords
  else
    Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
      render_bibxml xml, include_keywords
    end.doc.root.to_xml
  end
end

#to_citeproc(bibtex = nil) ⇒ Hash

Render citeproc

Parameters:

  • bibtex (BibTeX::Bibliography, nil) (defaults to: nil)

Returns:

  • (Hash) —

    citeproc



424
425
426
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 424

def to_citeproc(bibtex = nil)
  bibtext_item(bibtex).to_citeproc.map { |cp| cp.transform_keys(&:to_s) }
end

#to_hash ⇒ Hash

Returns:

  • (Hash) 


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 356

def to_hash # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
  hash = {}
  hash["id"] = id if id
  hash["title"] = single_element_array(title) if title&.any?
  hash["link"] = single_element_array(link) if link&.any?
  hash["type"] = type if type
  hash["docid"] = single_element_array(docidentifier) if docidentifier&.any?
  hash["docnumber"] = docnumber if docnumber
  hash["date"] = single_element_array(date) if date&.any?
  if contributor&.any?
    hash["contributor"] = single_element_array(contributor)
  end
  hash["edition"] = edition if edition
  hash["version"] = version.to_hash if version
  hash["revdate"] = revdate if revdate
  hash["biblionote"] = single_element_array(biblionote) if biblionote&.any?
  hash["language"] = single_element_array(language) if language&.any?
  hash["script"] = single_element_array(script) if script&.any?
  hash["formattedref"] = formattedref.to_hash if formattedref
  hash["abstract"] = single_element_array(abstract) if abstract&.any?
  hash["docstatus"] = status.to_hash if status
  hash["copyright"] = single_element_array(copyright) if copyright&.any?
  hash["relation"] = single_element_array(relation) if relation&.any?
  hash["series"] = single_element_array(series) if series&.any?
  hash["medium"] = medium.to_hash if medium
  hash["place"] = single_element_array(place) if place&.any?
  hash["extent"] = single_element_array(extent) if extent&.any?
  hash["size"] = size.to_hash if size&.any?
  if accesslocation&.any?
    hash["accesslocation"] = single_element_array(accesslocation)
  end
  if classification&.any?
    hash["classification"] = single_element_array(classification)
  end
  hash["validity"] = validity.to_hash if validity
  hash["fetched"] = fetched.to_s if fetched
  hash["keyword"] = single_element_array(keyword) if keyword&.any?
  hash["license"] = single_element_array(license) if license&.any?
  hash["doctype"] = doctype if doctype
  hash["subdoctype"] = subdoctype if subdoctype
  if editorialgroup&.presence?
    hash["editorialgroup"] = editorialgroup.to_hash
  end
  hash["ics"] = single_element_array ics if ics.any?
  if structuredidentifier&.presence?
    hash["structuredidentifier"] = structuredidentifier.to_hash
  end
  hash
end

#to_most_recent_reference ⇒ Object

convert ISO:yyyy reference to reference to most recent instance of reference, removing date-specific infomration: date of publication, abstracts. Make dated reference Instance relation of the redacated document



483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 483

def to_most_recent_reference
  me = deep_clone
  disable_id_attribute
  me.relation << DocumentRelation.new(type: "instance", bibitem: self)
  me.abstract = []
  me.date = []
  me.docidentifier.each &:remove_date
  me.structuredidentifier&.remove_date
  me.id&.sub!(/-[12]\d\d\d/, "")
  me
end

#to_xml(**opts, &block) ⇒ String

Returns XML.

Parameters:

  • opts (Hash)

Options Hash (**opts):

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

    XML builder

  • :bibdata (Boolean)
  • :date_format (Symbol, NilClass) — default: :short —

    , :full

  • :lang (String, Symbol) —

    language

Returns:

  • (String) —

    XML



327
328
329
330
331
332
333
334
335
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 327

def to_xml(**opts, &block)
  if opts[:builder]
    render_xml(**opts, &block)
  else
    Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
      render_xml builder: xml, **opts, &block
    end.doc.root.to_xml
  end
end

#url(type = :src) ⇒ String

Parameters:

  • type (Symbol) (defaults to: :src) —

    type of url, can be :src/:obp/:rss

Returns:

  • (String) 


436
437
438
 
# File 'lib/relaton_bib/bibliographic_item.rb', line 436

def url(type = :src)
  @link.detect { |s| s.type == type.to_s }&.content&.to_s
end