Class: BibTeX::Entry

Inherits:
Element show all
Extended by:
Forwardable
Includes:
Enumerable
Defined in:
lib/bibtex/entry.rb

Overview

Represents a regular BibTeX entry.

Constant Summary collapse

REQUIRED_FIELDS =

Defines the required fields of the standard entry types

Hash.new([]).merge({
  :article       => [:author,:title,:journal,:year],
  :book          => [[:author,:editor],:title,:publisher,:year],
  :booklet       => [:title],
  :conference    => [:author,:title,:booktitle,:year],
  :inbook        => [[:author,:editor],:title,[:chapter,:pages],:publisher,:year],
  :incollection  => [:author,:title,:booktitle,:publisher,:year],
  :inproceedings => [:author,:title,:booktitle,:year],
  :manual        => [:title],
  :mastersthesis => [:author,:title,:school,:year],
  :misc          => [],
  :phdthesis     => [:author,:title,:school,:year],
  :proceedings   => [:title,:year],
  :techreport    => [:author,:title,:institution,:year],
  :unpublished   => [:author,:title,:note]
}).freeze
FIELD_ALIASES =

Defines the default fallbacks for values defined in cross-references

{
  :booktitle => :title,
  # :editor => :author
}.freeze
NAME_FIELDS =
[:author,:editor,:translator].freeze
DATE_FIELDS =
[:year,:month].freeze
MONTHS =
[:jan,:feb,:mar,:apr,:may,:jun,:jul,:aug,:sep,:oct,:nov,:dec].freeze
MONTHS_FILTER =
Hash.new do |h,k|
  case k.to_s.strip
  when /^(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)/i
    h[k] = Value.new(k.to_s[0,3].downcase.to_sym)
  when /^\d\d?$/
    h[k] = Value.new(MONTHS[k.to_i - 1] || k)
  else
    h[k] = Value.new(k)
  end
end
CSL_FILTER =
Hash.new {|h,k|k}.merge(Hash[*%w{
  date      issued
  isbn      ISBN
  booktitle container-title
  journal   container-title
  series    collection-title
  address   publisher-place
  pages     page
  number    issue
  url       URL
  doi       DOI
  year      issued
}.map(&:intern)]).freeze
CSL_FIELDS =
%w{ abstract annote archive archive_location archive-place
  authority call-number chapter-number citation-label citation-number
  collection-title container-title DOI edition event event-place
  first-reference-note-number genre ISBN issue jurisdiction keyword locator 
  medium note number number-of-pages number-of-volumes original-publisher
  original-publisher-place original-title page page-first publisher
  publisher-place references section status title URL version volume
  year-suffix accessed container event-date issued original-date
  author editor translator recipient interviewer publisher composer
  original-publisher original-author container-author collection-editor
}.map(&:intern).freeze
CSL_TYPES =
Hash.new {|h,k|k}.merge(Hash[*%w{
  booklet        pamphlet
  conference     paper-conference
  inbook         chapter
  incollection   chapter
  inproceedings  paper-conference
  manual         book
  mastersthesis  thesis
  misc           article
  phdthesis      thesis
  proceedings    paper-conference
  techreport     report
  unpublished    manuscript
  article        article-journal
}.map(&:intern)]).freeze
BIBO_FIELDS =
Hash[*%w{
  pages      pages
  number     issue
  isbn       isbn
  issn       issn
  doi        doi
  edition    edition
  abstract   abstract
  volume     volume
}.map(&:intern)].freeze
BIBO_TYPES =
Hash.new(:Document).merge(Hash[*%w{
  booklet        Book
  book           Book
  conference     Conference
  inbook         Article
  incollection   Article
  inproceedings  Article
  manual         Manual
  mastersthesis  Thesis
  phdthesis      Thesis
  proceedings    Proceedings
  techreport     Report
  journal        Journal
  periodical     Periodical
  unpublished    Manuscript
  article        Article
}.map(&:intern)]).freeze

Instance Attribute Summary collapse

Attributes inherited from Element

#bibliography

Instance Method Summary collapse

Methods inherited from Element

#inspect, #matches?, #meets?, parse, #to_json, #to_yaml

Constructor Details

#initialize(attributes = {}) {|_self| ... } ⇒ Entry

Creates a new instance. If a hash is given, the entry is populated accordingly.

Yields:

  • (_self)

Yield Parameters:

  • _self (BibTeX::Entry)

    the object that the method was called on



145
146
147
148
149
150
151
152
153
154
# File 'lib/bibtex/entry.rb', line 145

def initialize(attributes = {})
  @fields = {}

  self.type = attributes.delete(:type) if attributes.has_key?(:type)
  self.key = attributes.delete(:key) if attributes.has_key?(:key)
  
  add(attributes)
  
  yield self if block_given?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object



313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/bibtex/entry.rb', line 313

def method_missing(name, *args, &block)
  case
  when fields.has_key?(name)
    fields[name]
  when name.to_s =~ /^(.+)=$/
    send(:add, $1.to_sym, args[0])      
  when name =~ /^(?:convert|from)_([a-z]+)(!)?$/
    $2 ? convert!($1, &block) : convert($1, &block)
  when has_parent? && parent.provides?(name)
    parent.provide(name)
  else
    super
  end
end

Instance Attribute Details

#fieldsObject (readonly)

Returns the value of attribute fields.



140
141
142
# File 'lib/bibtex/entry.rb', line 140

def fields
  @fields
end

#typeObject

Returns the value of attribute type.



140
141
142
# File 'lib/bibtex/entry.rb', line 140

def type
  @type
end

Instance Method Details

#<=>(other) ⇒ Object



598
599
600
# File 'lib/bibtex/entry.rb', line 598

def <=>(other)
  type != other.type ? type <=> other.type : key != other.key ? key <=> other.key : to_s <=> other.to_s
end

#[](name) ⇒ Object Also known as: get

Returns the value of the field with the given name. If the value is not defined and the entry has cross-reference, returns the cross-referenced value instead.



356
357
358
# File 'lib/bibtex/entry.rb', line 356

def [](name)
  fields[name.to_sym] || parent && parent.provide(name)
end

#[]=(name, value) ⇒ Object

Adds a new field (name-value pair) to the entry. Returns the new value.



368
369
370
# File 'lib/bibtex/entry.rb', line 368

def []=(name, value)
  add(name.to_sym, value)
end

#add(*arguments) ⇒ Object Also known as: <<

Adds a new field (name-value pair) or multiple fields to the entry. Returns the entry for chainability.

call-seq: add(:author, “Edgar A. Poe”) add(:author, “Edgar A. Poe”, :title, “The Raven”) add([:author, “Edgar A. Poe”, :title, “The Raven”]) add(:author => “Edgar A. Poe”, :title => “The Raven”) add(:author => Names.new(Name.new(:first => ‘Edgar A.’, :last => ‘Poe’)))



391
392
393
394
395
396
397
# File 'lib/bibtex/entry.rb', line 391

def add(*arguments)
  Hash[*arguments.flatten].each_pair do |name, value|
    fields[name.to_sym] = Value.create(value)
  end
  
  self
end

#added_to_bibliography(bibliography) ⇒ Object

Called when the element was added to a bibliography.



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
# File 'lib/bibtex/entry.rb', line 433

def added_to_bibliography(bibliography)
  super

  @key = register(key)
  
  [:parse_names, :parse_months].each do |parser|
    send(parser) if bibliography.options[parser]
  end
  
  if bibliography.options.has_key?(:filter)
[*bibliography.options[:filter]].each do |filter|
    	convert!(filter)
end
  end
  
  self
end

#aliasesObject

Returns the Entry’s field name aliases.



188
189
190
# File 'lib/bibtex/entry.rb', line 188

def aliases
  @aliases ||= FIELD_ALIASES.dup
end

#childrenObject Also known as: cross_referenced_by

Returns a list of all entries in the Bibliography containing a cross-reference to this entry or [] if there are no references to this entry.



559
560
561
# File 'lib/bibtex/entry.rb', line 559

def children
  bibliography && bibliography.q("@entry[crossref=#{key}]") or []
end

#contained?Boolean

Returns true if this entry is published inside a book, collection or journal

Returns:

  • (Boolean)


578
579
580
# File 'lib/bibtex/entry.rb', line 578

def contained?
  has_field?(:booktitle, :container, :journal)
end

#container_titleObject



565
566
567
# File 'lib/bibtex/entry.rb', line 565

def container_title
  get(:booktitle) || get(:journal) || get(:container)
end

#content(options = {}) ⇒ Object

Returns a string of all the entry’s fields.



604
605
606
# File 'lib/bibtex/entry.rb', line 604

def content(options = {})
  fields.map { |k,v| "#{k} = #{ fields[k].to_s(options) }" }.join(",\n")
end

#convert(filter) ⇒ Object

Returns a duplicate entry with all values converted using the filter. If an optional block is given, only those values will be converted where the block returns true (the block will be called with each key-value pair).

See Also:



588
589
590
# File 'lib/bibtex/entry.rb', line 588

def convert(filter)
  block_given? ? dup.convert!(filter, &Proc.new) : dup.convert!(filter)
end

#convert!(filter) ⇒ Object

In-place variant of @see #convert



593
594
595
596
# File 'lib/bibtex/entry.rb', line 593

def convert!(filter)
  fields.each_pair { |k,v| !block_given? || yield(k,v) ? v.convert!(filter) : v }
  self
end

#dateObject



499
500
501
# File 'lib/bibtex/entry.rb', line 499

def date
  get(:date) || get(:year)
end

#delete(name) ⇒ Object

Removes the field with a given name from the entry. Returns the value of the deleted field; nil if the field was not set.



403
404
405
# File 'lib/bibtex/entry.rb', line 403

def delete(name)
  fields.delete(name.to_sym)
end

#eachObject Also known as: each_pair

call-seq:

entry.each      { |key, value| block } -> entry
entry.each_pair { |key, value| block } -> entry
entry.each                             -> an_enumerator
entry.each_pair                        -> an_enumerator

Calls block once for each key in entry, passing the key-value pair as parameters.

If no block is given, an enumerator is returned instead.



175
176
177
178
179
180
181
182
# File 'lib/bibtex/entry.rb', line 175

def each
  if block_given?
    fields.each(&Proc.new)
    self
  else
    to_enum
  end
end

#fetch(name, default = nil) ⇒ Object



362
363
364
# File 'lib/bibtex/entry.rb', line 362

def fetch(name, default = nil)
  get(name) || block_given? ? yield(name) : default
end

#field_names(filter = [], include_inherited = true) ⇒ Object

Returns a sorted list of the Entry’s field names. If a filter is passed as argument, returns all field names that are also defined by the filter. If the filter is empty, returns all field names.

If the second optional argument is true (default) and the Entry contains a cross-reference, the list will include all inherited fields.



286
287
288
289
290
291
292
293
294
295
296
297
298
299
# File 'lib/bibtex/entry.rb', line 286

def field_names(filter = [], include_inherited = true)
  names = fields.keys
  
  if include_inherited && has_parent?
    names.concat(inherited_fields)
  end
  
  unless filter.empty?
    names = names & filter.map(&:to_sym)
  end
  
  names.sort!
  names
end

#generate_hash(filter = []) ⇒ Object



415
416
417
# File 'lib/bibtex/entry.rb', line 415

def generate_hash(filter = [])
  Digest::MD5.hexdigest(field_names(filter).map { |k| [k, fields[k]] }.flatten.join)
end

#has_children?Boolean Also known as: cross_referenced?

Returns true if the entry is cross-referenced by another entry in the Bibliography.

Returns:

  • (Boolean)


550
551
552
# File 'lib/bibtex/entry.rb', line 550

def has_children?
  !children.empty?
end

#has_field?(*names) ⇒ Boolean Also known as: field?

Returns:

  • (Boolean)


230
231
232
233
234
# File 'lib/bibtex/entry.rb', line 230

def has_field?(*names)
  names.flatten.any? do |name|
    name.respond_to?(:to_sym) ? fields.has_key?(name.to_sym) : false
  end
end

#has_parent?Boolean Also known as: has_cross_reference?

Returns true if the Entry has a valid cross-reference in the Bibliography.

Returns:

  • (Boolean)


525
526
527
# File 'lib/bibtex/entry.rb', line 525

def has_parent?
  !parent.nil?
end

#has_type?(type) ⇒ Boolean Also known as: type?

Returns:

  • (Boolean)


223
224
225
# File 'lib/bibtex/entry.rb', line 223

def has_type?(type)
  type.to_s.match(/^(?:entry|\*)$/i) || @type == type.to_sym || super
end

#identifierObject



419
420
421
422
423
424
425
426
427
428
429
430
# File 'lib/bibtex/entry.rb', line 419

def identifier
  case
  when provides?(:doi)
    "info:doi/#{get(:doi)}"
  when provides?(:isbn)
    "urn:isbn:#{get(:isbn)}"
  when provides?(:issn)
    "urn:issn:#{get(:issn)}"
  else
    "urn:bibtex:#{key}"
  end
end

#inherited_fieldsObject

Returns a sorted list of all field names referenced by this Entry’s cross-reference.



302
303
304
305
306
307
308
309
310
# File 'lib/bibtex/entry.rb', line 302

def inherited_fields
  return [] unless has_parent?
  
  names = parent.fields.keys - fields.keys
  names.concat(parent.aliases.reject { |k,v| !parent.has_field?(v) }.keys)
  names.sort!
  
  names
end

#inherits?(*names) ⇒ Boolean

Returns:

  • (Boolean)


238
239
240
241
242
# File 'lib/bibtex/entry.rb', line 238

def inherits?(*names)
  names.flatten.any? do |name|
    !has_field(name) && has_parent? && parent.provides?(name)
  end
end

#initialize_copy(other) ⇒ Object



156
157
158
159
160
161
162
163
# File 'lib/bibtex/entry.rb', line 156

def initialize_copy (other)
  @fields = {}
  
  self.type = other.type
  self.key = other.key
  
  add(other.fields)
end

#issuedObject Also known as: citeproc_date



637
638
639
640
641
642
# File 'lib/bibtex/entry.rb', line 637

def issued
  m = MONTHS.find_index(fields[:month].to_s.intern)
  m = m + 1 unless m.nil?
  
  Hash['date-parts', [[fields[:year],m].compact.map(&:to_i)]]
end

#joinObject



483
484
485
486
# File 'lib/bibtex/entry.rb', line 483

def join
  fields.values.each(&:join)
  self
end

#keyObject Also known as: id



211
212
213
# File 'lib/bibtex/entry.rb', line 211

def key
  @key ||= default_key
end

#key=(key) ⇒ Object Also known as: id=

Sets the Entry’s key. If the Entry is currently registered with a Bibliography, re-registers the Entry with the new key; note that this may change the key value if another Entry is already regsitered with the same key.

Returns the new key.



198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/bibtex/entry.rb', line 198

def key=(key)
  key = key.to_s
  
  if registered?
    bibliography.entries.delete(@key)
    key = register(key)
  end

  @key = key
rescue => e
  raise BibTeXError, "failed to set key to #{key.inspect}: #{e.message}"
end

#month=(month) ⇒ Object



488
489
490
# File 'lib/bibtex/entry.rb', line 488

def month=(month)
  fields[:month] = MONTHS_FILTER[month]
end

#namesObject

Returns a list of all names (authors, editors, translators).



519
520
521
# File 'lib/bibtex/entry.rb', line 519

def names
  NAME_FIELDS.map { |k| has_field?(k) ? @fields[k].tokens : nil }.flatten.compact
end

#pages_fromObject



569
570
571
# File 'lib/bibtex/entry.rb', line 569

def pages_from
  fetch(:pages, '').split(/\D+/)[0]
end

#pages_toObject



573
574
575
# File 'lib/bibtex/entry.rb', line 573

def pages_to
  fetch(:pages, '').split(/\D+/)[-1]
end

#parentObject Also known as: cross_reference

Returns the cross-referenced Entry from the Bibliography or nil if this Entry does define a cross-reference.



541
542
543
# File 'lib/bibtex/entry.rb', line 541

def parent
  bibliography && bibliography[fields[:crossref]]
end

#parent_missing?Boolean Also known as: cross_reference_missing?

Returns true if the Entry cross-references an Entry which is not registered in the current Bibliography.

Returns:

  • (Boolean)


533
534
535
# File 'lib/bibtex/entry.rb', line 533

def parent_missing?
  has_field?(:crossref) && !has_parent?
end

#parse_monthObject Also known as: parse_months



492
493
494
495
# File 'lib/bibtex/entry.rb', line 492

def parse_month
  fields[:month] = MONTHS_FILTER[fields[:month]] if has_field?(:month)
  self
end

#parse_namesObject

Parses all name values of the entry. Tries to replace and join the value prior to parsing.



505
506
507
508
509
510
511
512
513
514
515
516
# File 'lib/bibtex/entry.rb', line 505

def parse_names
  strings = bibliography ? bibliography.strings.values : []

  NAME_FIELDS.each do |key|
    if name = fields[key]
      name = name.dup.replace(strings).join.to_name
      fields[key] = name unless name.nil?
    end
  end

  self
end

#provide(name) ⇒ Object

Returns the field value referenced by the passed-in name. For example, this will return the ‘title’ value for ‘booktitle’ if a corresponding alias is defined.



262
263
264
265
266
# File 'lib/bibtex/entry.rb', line 262

def provide(name)
  return nil unless name.respond_to?(:to_sym)
  name = name.to_sym      
  fields[name] || fields[aliases[name]]
end

#provides?(*names) ⇒ Boolean

Returns true if the Entry has a field (or alias) for any of the passed-in names.

Returns:

  • (Boolean)


245
246
247
248
249
250
251
252
253
# File 'lib/bibtex/entry.rb', line 245

def provides?(*names)
  names.flatten.any? do |name|
    if name.respond_to?(:to_sym)
      has_field?(name) || has_field?(aliases[name.to_sym])
    else
      false
    end
  end
end

#provides_or_inherits?(*names) ⇒ Boolean

Returns:

  • (Boolean)


255
256
257
# File 'lib/bibtex/entry.rb', line 255

def provides_or_inherits?(*names)
  provides?(names) || inherits?(names)
end

#register(key) ⇒ Object

Registers this Entry in the associated Bibliographies entries hash. This method may change the Entry’s key, if another entry is already registered with the current key.

Returns the key or nil if the Entry is not associated with a Bibliography.



468
469
470
471
472
473
474
475
# File 'lib/bibtex/entry.rb', line 468

def register(key)
  return nil if bibliography.nil?
  
  k = key.dup
  k.succ! while bibliography.has_key?(k)
  bibliography.entries[k] = self
  k
end

#registered?Boolean

Returns true if the Entry is currently registered with the associated Bibliography.

Returns:

  • (Boolean)


459
460
461
# File 'lib/bibtex/entry.rb', line 459

def registered?
  !!(bibliography && bibliography.entries[key].equal?(self))
end

#removed_from_bibliography(bibliography) ⇒ Object

Called when the element was removed from a bibliography.



452
453
454
455
456
# File 'lib/bibtex/entry.rb', line 452

def removed_from_bibliography(bibliography)
  super
  bibliography.entries.delete(key)
  self
end

#rename(*arguments) ⇒ Object Also known as: rename_fields

Returns a copy of the Entry with all the field names renamed.



334
335
336
# File 'lib/bibtex/entry.rb', line 334

def rename(*arguments)
  dup.rename!(*arguments)
end

#rename!(*arguments) ⇒ Object Also known as: rename_fields!

Renames the given field names unless a field with the new name already exists.



340
341
342
343
344
345
346
347
348
# File 'lib/bibtex/entry.rb', line 340

def rename!(*arguments)
  Hash[*arguments.flatten].each_pair do |from,to|
    if fields.has_key?(from) && !fields.has_key?(to)
      fields[to] = fields[from]
      fields.delete(from)
    end
  end
  self
end

#replace(*arguments) ⇒ Object



477
478
479
480
481
# File 'lib/bibtex/entry.rb', line 477

def replace(*arguments)
  arguments = bibliography.q('@string') if arguments.empty?
  fields.values.each { |v| v.replace(*arguments) }
  self
end

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean)


328
329
330
331
# File 'lib/bibtex/entry.rb', line 328

def respond_to?(method)
  provides?(method.to_sym) || method.to_s.match(/=$/) ||
    method =~ /^(?:convert|from)_([a-z]+)(!)?$/ || (has_parent? && parent.respond_to?(method)) || super
end

#save_inherited_fieldsObject

If the Entry has a cross-reference, copies all referenced all inherited values from the parent.

Returns the Entry.



272
273
274
275
276
277
278
# File 'lib/bibtex/entry.rb', line 272

def save_inherited_fields
  inherited_fields.each do |name|
    fields[name] = parent.provide(name)
  end
  
  self
end

#to_citeproc(options = {}) ⇒ Object



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
# File 'lib/bibtex/entry.rb', line 621

def to_citeproc(options = {})
  options[:quotes] ||= []

  parse_names
  parse_month
  
  hash = { 'id' => key.to_s, 'type' => CSL_TYPES[type].to_s }

  each_pair do |k,v|
    hash[CSL_FILTER[k].to_s] = v.to_citeproc(options) unless DATE_FIELDS.include?(k)
  end

  hash['issued'] = citeproc_date
  hash
end

#to_hash(options = {}) ⇒ Object



614
615
616
617
618
619
# File 'lib/bibtex/entry.rb', line 614

def to_hash(options = {})
  options[:quotes] ||= %w({ })
  hash = { :key => key, :type => type }
  each_pair { |k,v| hash[k] = v.to_s(options) }
  hash
end

#to_rdf(options = {}) ⇒ Object Also known as: to_bibo

Returns a RDF::Graph representation of the entry using the BIBO ontology. TODO: improve level of detail captured by export



672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'lib/bibtex/entry.rb', line 672

def to_rdf(options = {})
  require 'rdf'
  
  bibo = RDF::Vocabulary.new('http://purl.org/ontology/bibo/')
  
  graph = RDF::Graph.new
  entry = RDF::URI.new(identifier)

  graph << [entry, RDF.type, bibo[BIBO_TYPES[type]]]
  
  [:title, :language].each do |key|        
    graph << [entry, RDF::DC[key], get(key).to_s] if field?(key)
  end

  graph << [entry, RDF::DC.date, get(:year).to_s] if field?(:year)
  
  if field?(:publisher)
    address = RDF::Vocabulary.new('http://schemas.talis.com/2005/address/schema#')
    pub = RDF::Node.new

    graph << [pub, RDF.type, RDF::FOAF[:Organization]]
    graph << [pub, RDF::FOAF.name, get(:publisher)]
    
    graph << [pub, address[:localityName], get(:address)] if field?(:address)
    
    graph << [entry, RDF::DC.published, pub]
  end

  [:doi, :edition, :volume].each do |key|        
    graph << [entry, bibo[key], get(key).to_s] if field?(key)
  end
  
  if has_field?(:pages)
    if get(:pages).to_s =~ /^\s*(\d+)\s*-+\s*(\d+)\s*$/
      graph << [entry, bibo[:pageStart], $1]
      graph << [entry, bibo[:pageEnd], $2]
    else
      graph << [entry, bibo[:pages], get(:pages).to_s]
    end
  end

  if has_field?(:author)
    seq = RDF::Node.new

    graph << [seq, RDF.type, RDF[:Seq]]
    graph << [entry, bibo[:authorList], seq]
    
    authors.each do |author|
      a = RDF::Node.new
    
      graph << [a, RDF.type, RDF::FOAF[:Person]]
      
      if author.is_a?(Name)       
        [:given, :family, :prefix, :suffix].each do |part|
          graph << [a, bibo["#{part}Name"], author.send(part).to_s]
        end
      else
        graph << [a, RDF::FOAF.name, author.to_s]
      end

      graph << [entry, RDF::DC.creator, a]
      graph << [seq, RDF.li, a]
    end
  end

  if has_field?(:editor)
    seq = RDF::Node.new

    graph << [seq, RDF.type, RDF[:Seq]]
    graph << [entry, bibo[:editorList], seq]

    editors.each do |editor|
      e = RDF::Node.new

      graph << [e, RDF.type, RDF::FOAF[:Person]]

      if editor.is_a?(Name)
        [:given, :family, :prefix, :suffix].each do |part|
          graph << [e, bibo["#{part}Name"], editor.send(part).to_s]
        end
      else
        graph << [e, RDF::FOAF.name, editor.to_s]
      end

      graph << [entry, bibo.editor, a]
      graph << [seq, RDF.li, e]
    end
  end
  
  graph
rescue LoadError
  BibTeX.log.error "Please gem install rdf for RDF support."
end

#to_s(options = {}) ⇒ Object

Returns a string representation of the entry.



609
610
611
612
# File 'lib/bibtex/entry.rb', line 609

def to_s(options = {})
  options[:quotes] ||= %w({ })
  ["@#{type}{#{key},", content(options).gsub(/^/,'  '), "}\n"].join("\n")
end

#to_xml(options = {}) ⇒ Object



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
# File 'lib/bibtex/entry.rb', line 646

def to_xml(options = {})
  require 'rexml/document'
  
  xml = REXML::Element.new('bibtex:entry')
  xml.attributes['id'] = key

  entry = REXML::Element.new("bibtex:#{type}")

  fields.each do |key, value|
    field = REXML::Element.new("bibtex:#{key}")
    
    if options[:extended] && value.name?
      value.each { |n| entry.add_element(n.to_xml) }
    else
      field.text = value.to_s(options)
    end
    
    entry.add_element(field)
  end

  xml.add_element(entry)
  xml
end

#valid?Boolean

Returns false if the entry is one of the standard entry types and does not have definitions of all the required fields for that type.

Returns:

  • (Boolean)


409
410
411
412
413
# File 'lib/bibtex/entry.rb', line 409

def valid?
  REQUIRED_FIELDS[@type].all? do |f|
    f.is_a?(Array) ? !(f & fields.keys).empty? : !fields[f].nil?
  end
end