Class: RelatonBib::BibliographicItem
- 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].freeze
Constants included from RelatonBib
Instance Attribute Summary collapse
- #abstract(lang: nil) ⇒ RelatonBib::FormattedString+
- #accesslocation ⇒ Array<Strig> readonly
- #all_parts ⇒ TrueClass, ...
- #biblionote ⇒ RelatonBib::BiblioNoteCollection readonly
- #classification ⇒ Array<Relaton::Classification> readonly
- #contributor ⇒ Array<RelatonBib::ContributionInfo> readonly
- #copyright ⇒ Array<RelatonBib::CopyrightAssociation> readonly
- #date ⇒ Array<RelatonBib::BibliographicDate>
- #docidentifier ⇒ Array<RelatonBib::DocumentIdentifier> readonly
- #docnumber ⇒ String, NilClass readonly
- #doctype ⇒ String, NilClass readonly
- #edition ⇒ String, NilClass readonly
- #editorialgroup ⇒ RelatonBib::EditorialGroup? readonly
- #extent ⇒ Array<RelatonBib::BibItemLocality> readonly
- #fetched ⇒ Date readonly
- #formattedref ⇒ RelatonBib::FormattedRef, NilClass readonly
- #ics ⇒ Array<RelatonBib:ICS> readonly
- #id ⇒ String, NilClass readonly
- #keyword ⇒ Array<RelatonBib::LocalizedString> readonly
-
#language ⇒ Array<String>
readonly
Language Iso639 code.
- #license ⇒ Array<Strig> readonly
- #link ⇒ Array<RelatonBib::TypedUri> readonly
- #medium ⇒ RelatonBib::Medium, NilClass readonly
- #place ⇒ Array<RelatonBib::Place> readonly
- #relation ⇒ RelatonBib::DocRelationCollection readonly
-
#script ⇒ Array<String>
readonly
Script Iso15924 code.
- #series ⇒ Array<RelatonBib::Series> readonly
- #status ⇒ RelatonBib::DocumentStatus, NilClass readonly
- #structuredidentifier ⇒ RelatonBib::StructuredIdentifierCollection readonly
- #subdoctype ⇒ String, NilClass readonly
- #title(lang: nil) ⇒ RelatonIsoBib::TypedTitleStringCollection readonly
- #type ⇒ String, NilClass readonly
- #validity ⇒ RelatonBib:Validity, NilClass readonly
- #version ⇒ RelatonBib::BibliographicItem::Version, NilClass readonly
Class Method Summary collapse
Instance Method Summary collapse
- #deep_clone ⇒ Object
- #disable_id_attribute ⇒ Object
-
#initialize(**args) ⇒ BibliographicItem
constructor
A new instance of BibliographicItem.
- #makeid(id, attribute) ⇒ String
-
#revdate ⇒ String, NilClass
If revision_date exists then returns it else returns published date or nil.
- #shortref(identifier, **opts) ⇒ String
-
#to_all_parts ⇒ Object
remove title part components and abstract.
- #to_asciibib(prefix = "") ⇒ String
- #to_bibtex(bibtex = nil) ⇒ String
-
#to_bibxml(builder = nil) ⇒ String, Nokogiri::XML::Builder::NodeBuilder
Render BibXML (RFC).
- #to_hash ⇒ Hash
-
#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.
-
#to_xml(**opts, &block) ⇒ String
XML.
- #url(type = :src) ⇒ String
Methods included from RelatonBib
Constructor Details
#initialize(**args) ⇒ BibliographicItem
Returns a new instance of BibliographicItem.
194 195 196 197 198 199 200 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 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 194 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] || [] @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+
|
# File 'lib/relaton_bib/bibliographic_item.rb', line 77
|
#accesslocation ⇒ Array<Strig> (readonly)
102 103 104 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 102 def accesslocation @accesslocation end |
#all_parts ⇒ TrueClass, ...
42 43 44 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 42 def all_parts @all_parts end |
#biblionote ⇒ RelatonBib::BiblioNoteCollection (readonly)
66 67 68 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 66 def biblionote @biblionote end |
#classification ⇒ Array<Relaton::Classification> (readonly)
105 106 107 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 105 def classification @classification end |
#contributor ⇒ Array<RelatonBib::ContributionInfo> (readonly)
60 61 62 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 60 def contributor @contributor end |
#copyright ⇒ Array<RelatonBib::CopyrightAssociation> (readonly)
84 85 86 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 84 def copyright @copyright end |
#date ⇒ Array<RelatonBib::BibliographicDate>
57 58 59 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 57 def date @date end |
#docidentifier ⇒ Array<RelatonBib::DocumentIdentifier> (readonly)
54 55 56 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 54 def docidentifier @docidentifier end |
#docnumber ⇒ String, NilClass (readonly)
45 46 47 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 45 def docnumber @docnumber end |
#doctype ⇒ String, NilClass (readonly)
45 46 47 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 45 def doctype @doctype end |
#edition ⇒ String, NilClass (readonly)
45 46 47 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 45 def edition @edition end |
#editorialgroup ⇒ RelatonBib::EditorialGroup? (readonly)
117 118 119 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 117 def editorialgroup @editorialgroup end |
#extent ⇒ Array<RelatonBib::BibItemLocality> (readonly)
99 100 101 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 99 def extent @extent end |
#fetched ⇒ Date (readonly)
111 112 113 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 111 def fetched @fetched end |
#formattedref ⇒ RelatonBib::FormattedRef, NilClass (readonly)
75 76 77 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 75 def formattedref @formattedref end |
#ics ⇒ Array<RelatonBib:ICS> (readonly)
120 121 122 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 120 def ics @ics end |
#id ⇒ String, NilClass (readonly)
45 46 47 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 45 def id @id end |
#keyword ⇒ Array<RelatonBib::LocalizedString> (readonly)
114 115 116 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 114 def keyword @keyword end |
#language ⇒ Array<String> (readonly)
Returns language Iso639 code.
69 70 71 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 69 def language @language end |
#license ⇒ Array<Strig> (readonly)
102 103 104 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 102 def license @license end |
#link ⇒ Array<RelatonBib::TypedUri> (readonly)
51 52 53 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 51 def link @link end |
#medium ⇒ RelatonBib::Medium, NilClass (readonly)
93 94 95 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 93 def medium @medium end |
#place ⇒ Array<RelatonBib::Place> (readonly)
96 97 98 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 96 def place @place end |
#relation ⇒ RelatonBib::DocRelationCollection (readonly)
87 88 89 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 87 def relation @relation end |
#script ⇒ Array<String> (readonly)
Returns script Iso15924 code.
72 73 74 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 72 def script @script end |
#series ⇒ Array<RelatonBib::Series> (readonly)
90 91 92 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 90 def series @series end |
#status ⇒ RelatonBib::DocumentStatus, NilClass (readonly)
81 82 83 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 81 def status @status end |
#structuredidentifier ⇒ RelatonBib::StructuredIdentifierCollection (readonly)
123 124 125 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 123 def structuredidentifier @structuredidentifier end |
#subdoctype ⇒ String, NilClass (readonly)
45 46 47 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 45 def subdoctype @subdoctype end |
#title(lang: nil) ⇒ RelatonIsoBib::TypedTitleStringCollection (readonly)
|
# File 'lib/relaton_bib/bibliographic_item.rb', line 47
|
#type ⇒ String, NilClass (readonly)
45 46 47 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 45 def type @type end |
#validity ⇒ RelatonBib:Validity, NilClass (readonly)
108 109 110 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 108 def validity @validity end |
#version ⇒ RelatonBib::BibliographicItem::Version, NilClass (readonly)
63 64 65 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 63 def version @version end |
Class Method Details
.from_hash(hash) ⇒ RelatonBipm::BipmBibliographicItem
266 267 268 269 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 266 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
438 439 440 441 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 438 def deep_clone dump = Marshal.dump self Marshal.load dump # rubocop:disable Security/MarshalLoad end |
#disable_id_attribute ⇒ Object
443 444 445 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 443 def disable_id_attribute @id_attribute = false end |
#makeid(id, attribute) ⇒ String
284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 284 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
491 492 493 494 495 496 497 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 491 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
303 304 305 306 307 308 309 310 311 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 303 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
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 448 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
501 502 503 504 505 506 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 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 501 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 } 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
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 398 def to_bibtex(bibtex = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength item = BibTeX::Entry.new item.type = bibtex_type item.key = id bibtex_title item item.edition = edition if edition item bibtex_contributor item item.address = place.first.name if place.any? bibtex_note item bibtex_relation item bibtex_extent item bibtex_date item bibtex_series item bibtex_classification item item.keywords = keyword.map(&:content).join(", ") if keyword.any? bibtex_docidentifier item item. = fetched.to_s if fetched bibtex_link item bibtex ||= BibTeX::Bibliography.new bibtex << item bibtex.to_s end |
#to_bibxml(builder = nil) ⇒ String, Nokogiri::XML::Builder::NodeBuilder
Render BibXML (RFC)
336 337 338 339 340 341 342 343 344 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 336 def to_bibxml(builder = nil) if builder render_bibxml builder else Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml| render_bibxml xml end.doc.root.to_xml end end |
#to_hash ⇒ Hash
347 348 349 350 351 352 353 354 355 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 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 347 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? 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
477 478 479 480 481 482 483 484 485 486 487 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 477 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.
319 320 321 322 323 324 325 326 327 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 319 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
430 431 432 |
# File 'lib/relaton_bib/bibliographic_item.rb', line 430 def url(type = :src) @link.detect { |s| s.type == type.to_s }&.content&.to_s end |