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 manual proceedings presentation
thesis techreport standard unpublished map electronic\sresource
audiovisual film video broadcast software graphic_work music
patent inbook incollection inproceedings journal website
webresource dataset archival social_media alert message
conversation misc internal].freeze

Constants included from RelatonBib

VERSION

Instance Attribute Summary collapse

Class Method 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(**args) ⇒ BibliographicItem

Returns a new instance of BibliographicItem.

Parameters:



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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/relaton_bib/bibliographic_item.rb', line 208

def initialize(**args)
  if args[:type] && !TYPES.include?(args[:type])
    Util.warn %{Type `#{args[:type]}` is invalid.}
  end

  @title = if args[:title].is_a?(TypedTitleStringCollection)
             args[:title]
           else
             TypedTitleStringCollection.new(args[:title])
           end

  @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        = case args[:edition]
                    when Hash then Edition.new(**args[:edition])
                    when String, Integer, Float
                      Edition.new(content: args[:edition].to_s)
                    when Edition then args[:edition]
                    end
  @version        = args.fetch :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|
    case kw
    when Hash then LocalizedString.new(kw[:content], kw[:language], kw[:script])
    when String then LocalizedString.new(kw)
    else kw
    end
  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 87

#accesslocationArray<Strig> (readonly)

Returns:



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

def accesslocation
  @accesslocation
end

#all_partsBoolean?

Returns:

  • (Boolean, nil)


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

def all_parts
  @all_parts
end

#biblionoteRelatonBib::BiblioNoteCollection (readonly)



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

def biblionote
  @biblionote
end

#classificationArray<Relaton::Classification> (readonly)

Returns:

  • (Array<Relaton::Classification>)


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

def classification
  @classification
end

#contributorArray<RelatonBib::ContributionInfo> (readonly)



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

def contributor
  @contributor
end


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

def copyright
  @copyright
end

#date(type: nil) ⇒ Array<RelatonBib::BibliographicDate>

Parameters:

  • type (String, nil) (defaults to: nil)

    if nil return all dates else return dates with type

Returns:



322
323
324
# File 'lib/relaton_bib/bibliographic_item.rb', line 322

def date(type: nil)
  type ? @date.select { |d| d.type == type } : @date
end

#docidentifierArray<RelatonBib::DocumentIdentifier> (readonly)



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

def docidentifier
  @docidentifier
end

#docnumberString? (readonly)

Returns:

  • (String, nil)


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

def docnumber
  @docnumber
end

#doctypeRelatonBib::DocumentType (readonly)

Returns document type.

Returns:



52
53
54
# File 'lib/relaton_bib/bibliographic_item.rb', line 52

def doctype
  @doctype
end

#editionRelatonBib::Edition? (readonly)

Returns edition.

Returns:



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

def edition
  @edition
end

#editorialgroupRelatonBib::EditorialGroup? (readonly)

Returns:



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

def editorialgroup
  @editorialgroup
end

#extentArray<RelatonBib::Locality, RelatonBib::LocalityStack> (readonly)



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

def extent
  @extent
end

#fetchedDate

Returns:

  • (Date)


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

def fetched
  @fetched
end

#formattedrefRelatonBib::FormattedRef? (readonly)

Returns:



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

def formattedref
  @formattedref
end

#icsArray<RelatonBib:ICS> (readonly)

Returns:

  • (Array<RelatonBib:ICS>)


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

def ics
  @ics
end

#idString? (readonly)

Returns:

  • (String, nil)


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

def id
  @id
end

#keywordArray<RelatonBib::LocalizedString> (readonly)



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

def keyword
  @keyword
end

#languageArray<String> (readonly)

Returns language Iso639 code.

Returns:

  • (Array<String>)

    language Iso639 code



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

def language
  @language
end

#licenseArray<Strig> (readonly)

Returns:



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

def license
  @license
end


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

def link
  @link
end

#mediumRelatonBib::Medium? (readonly)

Returns:



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

def medium
  @medium
end

#placeArray<RelatonBib::Place> (readonly)

Returns:



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

def place
  @place
end

#relationRelatonBib::DocRelationCollection (readonly)



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

def relation
  @relation
end

#scriptArray<String> (readonly)

Returns script Iso15924 code.

Returns:

  • (Array<String>)

    script Iso15924 code



82
83
84
# File 'lib/relaton_bib/bibliographic_item.rb', line 82

def script
  @script
end

#seriesArray<RelatonBib::Series> (readonly)



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

def series
  @series
end

#sizeRelatonBib::BibliographicSize? (readonly)



136
137
138
# File 'lib/relaton_bib/bibliographic_item.rb', line 136

def size
  @size
end

#statusRelatonBib::DocumentStatus? (readonly)

Returns:



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

def status
  @status
end

#structuredidentifierRelatonBib::StructuredIdentifierCollection (readonly)



133
134
135
# File 'lib/relaton_bib/bibliographic_item.rb', line 133

def structuredidentifier
  @structuredidentifier
end

#subdoctypeString? (readonly)

Returns:

  • (String, nil)


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

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 57

#typeString? (readonly)

Returns:

  • (String, nil)


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

def type
  @type
end

#validityRelatonBib:Validity? (readonly)

Returns:

  • (RelatonBib:Validity, nil)


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

def validity
  @validity
end

#versionArray<RelatonBib::BibliographicItem::Version> (readonly)



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

def version
  @version
end

Class Method Details

.from_hash(hash) ⇒ RelatonBipm::BipmBibliographicItem

Parameters:

  • hash (Hash)

Returns:

  • (RelatonBipm::BipmBibliographicItem)


312
313
314
315
# File 'lib/relaton_bib/bibliographic_item.rb', line 312

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_cloneObject



485
486
487
488
# File 'lib/relaton_bib/bibliographic_item.rb', line 485

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

#disable_id_attributeObject



490
491
492
# File 'lib/relaton_bib/bibliographic_item.rb', line 490

def disable_id_attribute
  @id_attribute = false
end

#makeid(identifier, attribute) ⇒ String

Parameters:

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
# File 'lib/relaton_bib/bibliographic_item.rb', line 339

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

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

  idstr = identifier.id.gsub(/[:\/]/, "-").gsub(/[\s\(\)]/, "")
  idstr.strip
end

#revdateString?

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

Returns:

  • (String, nil)


540
541
542
543
544
545
546
# File 'lib/relaton_bib/bibliographic_item.rb', line 540

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

#schemaString

Fetch schema version

Returns:

  • (String)

    schema version



297
298
299
# File 'lib/relaton_bib/bibliographic_item.rb', line 297

def schema
  @schema ||= schema_versions["relaton-models"]
end

#schema_versionsHash{String=>String}

Read schema versions from file

Returns:

  • (Hash{String=>String})

    schema versions



306
307
308
# File 'lib/relaton_bib/bibliographic_item.rb', line 306

def schema_versions
  JSON.parse File.read(File.join(__dir__, "../../grammars/versions.json"))
end

#shortref(identifier, **opts) ⇒ String

Parameters:

Returns:

  • (String)


354
355
356
357
358
359
360
361
362
# File 'lib/relaton_bib/bibliographic_item.rb', line 354

def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
  pubdate = date.select { |d| d.type == "published" || d.type == "issued" }
  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_partsObject

remove title part components and abstract



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
# File 'lib/relaton_bib/bibliographic_item.rb', line 495

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: "instanceOf", 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
    next if ttl.empty?

    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)


550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
# File 'lib/relaton_bib/bibliographic_item.rb', line 550

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 += edition.to_asciibib(prefix) if edition
  language.each { |l| out += "#{pref}language:: #{l}\n" }
  script.each { |s| out += "#{pref}script:: #{s}\n" }
  version.each { |v| out += v.to_asciibib prefix, version.size }
  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 += doctype.to_asciibib prefix 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)


452
453
454
# File 'lib/relaton_bib/bibliographic_item.rb', line 452

def to_bibtex(bibtex = nil)
  Renderer::BibtexBuilder.build(self, 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



388
389
390
# File 'lib/relaton_bib/bibliographic_item.rb', line 388

def to_bibxml(builder = nil, include_keywords: false)
  Renderer::BibXML.new(self).render builder: builder, include_keywords: include_keywords
end

#to_citeproc(bibtex = nil) ⇒ Hash

Render citeproc

Parameters:

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

Returns:

  • (Hash)

    citeproc



463
464
465
466
467
# File 'lib/relaton_bib/bibliographic_item.rb', line 463

def to_citeproc(bibtex = nil)
  Renderer::BibtexBuilder.build(self, bibtex).to_citeproc.map do |cp|
    cp.transform_keys(&:to_s)
  end
end

#to_hash(embedded: false) ⇒ Hash

Returns:

  • (Hash)


393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
# File 'lib/relaton_bib/bibliographic_item.rb', line 393

def to_hash(embedded: false) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
  hash = {}
  hash["schema-version"] = schema unless embedded
  hash["id"] = id if id
  hash["title"] = title.to_hash 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.to_hash if edition
  hash["version"] = version.map &:to_hash if version.any?
  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.to_hash 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["ext"] = { "schema-version" => ext_schema } if !embedded && respond_to?(:ext_schema) && ext_schema
  hash
end

#to_most_recent_referenceObject

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



526
527
528
529
530
531
532
533
534
535
536
# File 'lib/relaton_bib/bibliographic_item.rb', line 526

def to_most_recent_reference
  me = deep_clone
  disable_id_attribute
  me.relation << DocumentRelation.new(type: "instanceOf", 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, nil) — default: :short

    , :full

  • :lang (String, Symbol)

    language

Returns:

  • (String)

    XML



370
371
372
373
374
375
376
377
378
# File 'lib/relaton_bib/bibliographic_item.rb', line 370

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, nil)


477
478
479
# File 'lib/relaton_bib/bibliographic_item.rb', line 477

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