Class: RelatonBib::BibliographicItem

Inherits:
Object
  • Object
show all
Defined in:
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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BibliographicItem

Returns a new instance of BibliographicItem.

Parameters:



192
193
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
# File 'lib/relaton_bib/bibliographic_item.rb', line 192

def initialize(**args)
  if args[:type] && !TYPES.include?(args[:type])
    raise ArgumentError, %{Type "#{args[:type]}" is invalid.}
  end

  @title = (args[:titles] || []).map do |t|
    t.is_a?(Hash) ? TypedTitleString.new(t) : t
  end

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

  @contributors = (args[:contributors] || []).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[:roles])
    else c
    end
  end

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

  if args[:copyright]
    @copyright = if args[:copyright].is_a?(Hash)
                   CopyrightAssociation.new args[:copyright]
                 else args[:copyright]
                 end
  end

  @id             = args[:id]
  @formattedref   = args[:formattedref] if title.empty?
  @type           = args[:type]
  @docidentifier  = args[:docid] || []
  @docnumber      = args[:docnumber]
  @edition        = args[:edition]
  @version        = args[:version]
  @biblionote     = args.fetch :biblionote, []
  @language       = args.fetch :language, []
  @script         = args.fetch :script, []
  @status         = args[:docstatus]
  @relations      = DocRelationCollection.new(args[:relations] || [])
  @link           = args.fetch(:link, []).map { |s| s.is_a?(Hash) ? TypedUri.new(s) : s }
  @series         = args[:series]
  @medium         = args[:medium]
  @place          = args.fetch(:place, [])
  @extent         = args[:extent] || []
  @accesslocation = args.fetch :accesslocation, []
  @classification = args[:classification]
  @validity       = args[:validity]
  @fetched        = args.fetch :fetched, nil # , Date.today # we should pass the fetched arg from scrappers
end

Instance Attribute Details

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

Parameters:

  • lang (String) (defaults to: nil)

    language code Iso639

Returns:



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


#accesslocationArray<Strig> (readonly)

Returns:

  • (Array<Strig>)


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

def accesslocation
  @accesslocation
end

#biblionoteArray<RelatonBib::FormattedString>, NilClass (readonly)

Returns:



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

def biblionote
  @biblionote
end

#classificationRelaton::Classification, NilClass (readonly)

Returns:

  • (Relaton::Classification, NilClass)


138
139
140
# File 'lib/relaton_bib/bibliographic_item.rb', line 138

def classification
  @classification
end

#contributorsArray<RelatonBib::ContributionInfo> (readonly)

Returns:



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

def contributors
  @contributors
end


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

def copyright
  @copyright
end

#datesArray<RelatonBib::BibliographicDate> (readonly)

Returns:



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

def dates
  @dates
end

#docidentifierArray<RelatonBib::DocumentIdentifier> (readonly)

Returns:



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

def docidentifier
  @docidentifier
end

#docnumberString (readonly)

Returns docnumber.

Returns:

  • (String)

    docnumber



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

def docnumber
  @docnumber
end

#editionString, NillClass (readonly)

Returns:

  • (String, NillClass)


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

def edition
  @edition
end

#extentArray<RelatonBib::BibItemLocality> (readonly)

Returns:



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

def extent
  @extent
end

#fetchedDate (readonly)

Returns:

  • (Date)


144
145
146
# File 'lib/relaton_bib/bibliographic_item.rb', line 144

def fetched
  @fetched
end

#formattedrefRelatonBib::FormattedRef (readonly)



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

def formattedref
  @formattedref
end

#idString (readonly)

Returns:

  • (String)


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

def id
  @id
end

#languageArray<String> (readonly)

Returns language Iso639 code.

Returns:

  • (Array<String>)

    language Iso639 code



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

def language
  @language
end

Returns:



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

def link
  @link
end

#mediumRelatonBib::Medium, NilClass (readonly)

Returns:



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

def medium
  @medium
end

#placeArray<String> (readonly)

Returns:

  • (Array<String>)


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

def place
  @place
end

#relationsRelatonBib::DocRelationCollection (readonly)



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

def relations
  @relations
end

#scriptArray<String> (readonly)

Returns script Iso15924 code.

Returns:

  • (Array<String>)

    script Iso15924 code



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

def script
  @script
end

#seriesArray<RelatonBib::Series> (readonly)

Returns:



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

def series
  @series
end

#statusRelatonBib::DocumentStatus (readonly)



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

def status
  @status
end

#titleArray<RelatonBib::TypedTitleString> (readonly)

Returns:



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

def title
  @title
end

#typeString (readonly)

Returns:

  • (String)


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

def type
  @type
end

#validityRelatonBib:Validity, NilClass (readonly)

Returns:

  • (RelatonBib:Validity, NilClass)


141
142
143
# File 'lib/relaton_bib/bibliographic_item.rb', line 141

def validity
  @validity
end

#versionRelatonBib::BibliongraphicItem::Version (readonly)

Returns:

  • (RelatonBib::BibliongraphicItem::Version)


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

def version
  @version
end

Instance Method Details

#makeid(id, attribute) ⇒ Object



259
260
261
262
263
264
265
266
267
268
269
# File 'lib/relaton_bib/bibliographic_item.rb', line 259

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

  id ||= @docidentifier.reject { |i| i.type == "DOI" }[0]
  # contribs = publishers.map { |p| p&.entity&.abbreviation }.join '/'
  # idstr = "#{contribs}#{delim}#{id.project_number}"
  # idstr = id.project_number.to_s
  idstr = id.id.gsub(/:/, "-")
  # if id.part_number&.size&.positive? then idstr += "-#{id.part_number}"
  idstr.strip
end

#shortref(identifier, **opts) ⇒ String

Returns:

  • (String)


272
273
274
275
276
277
278
279
280
# File 'lib/relaton_bib/bibliographic_item.rb', line 272

def shortref(identifier, **opts)
  pubdate = dates.select { |d| d.type == "published" }
  year = if opts[:no_year] || pubdate.empty? then ""
         else ":" + pubdate&.first&.on&.year.to_s
         end
  year += ": All Parts" if opts[:all_parts] || @all_parts

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

#to_xml(builder = nil, root = "bibitem", &block) ⇒ String

Parameters:

  • builder (Nokogiri::XML::Builder, NillClass) (defaults to: nil)

    (nil)

Returns:

  • (String)


284
285
286
287
288
289
290
291
292
# File 'lib/relaton_bib/bibliographic_item.rb', line 284

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