Class: BibTeX::Value

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Comparable
Defined in:
lib/bibtex/value.rb

Overview

A BibTeX Value is something very much like a string. In BibTeX files it can appear on the right hand side of @string or @entry field assignments or as @preamble contents. In the example below [VALUE] indicates possible occurences of values in BibTeX:

@preamble{ "foo" [VALUE] }
@string{ foo = "foo" [VALUE] }
@book{id,
  author = {John Doe} [VALUE],
  title = foo # "bar" [VALUE]
}

All Values have in common that they can be simple strings in curly braces or double quotes or complex BibTeX string-concatenations (using the ‘#’ symbol).

Generally, Values try to behave as much as normal Ruby strings as possible; If you do not require any of the advanced BibTeX functionality (string replacement or concatentaion) you can simply convert them to strings using to_s. Note that BibTeX Names are special instances of Values which currently do not support string concatenation or replacement.

Direct Known Subclasses

Names

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*arguments) ⇒ Value

Returns a new instance of Value.



58
59
60
61
62
63
 
# File 'lib/bibtex/value.rb', line 58

def initialize(*arguments)
  @tokens = []
  arguments.flatten.compact.each do |argument|
    add(argument)
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



239
240
241
242
243
244
245
 
# File 'lib/bibtex/value.rb', line 239

def method_missing (name, *args)
    if name.to_s =~ /^(?:convert|from)_([a-z]+)(!)?$/
      return $2 ? convert!($1) : convert($1)
    end
    
  super
end

Instance Attribute Details

#tokens ⇒ Object (readonly) Also known as: to_a

Returns the value of attribute tokens.



52
53
54
 
# File 'lib/bibtex/value.rb', line 52

def tokens
  @tokens
end

Instance Method Details

#<=>(other) ⇒ Object 



252
253
254
 
# File 'lib/bibtex/value.rb', line 252

def <=> (other)
  to_s <=> other.to_s
end

#add(argument) ⇒ Object Also known as: <<, push 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/bibtex/value.rb', line 69

def add(argument)
  case argument
  when Value
    @tokens += argument.tokens.dup
  when ::String
    @tokens << argument
  when Symbol
    @tokens << argument
  else
    if argument.respond_to?(:to_s)
      @tokens << argument.to_s
    else
      raise(ArgumentError, "Failed to create Value from argument #{ argument.inspect }; expected String, Symbol or Value instance.")
    end
  end
  self
end

#atomic? ⇒ Boolean

Returns true if the Value is empty or consists of a single token.

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/bibtex/value.rb', line 168

def atomic?
  @tokens.length < 2
end

#convert(filter) ⇒ Object

Returns a new Value with all string values converted according to the given filter.



221
222
223
 
# File 'lib/bibtex/value.rb', line 221

def convert (filter)
  dup.convert!(filter)
end

#convert!(filter) ⇒ Object

Converts all string values according to the given filter.



226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/bibtex/value.rb', line 226

def convert! (filter)
  f = Filters.resolve(filter)

  unless f
    message = "Failed to load filter #{f.inspect}"
    Log.error message
    raise ArgumentError.new(message)
  end
  
  @tokens.map! { |t| f.apply(t) }
  self
end

#date? ⇒ Boolean Also known as: is_date?

Returns true if the Value’s content looks like a date.

Returns:

  • (Boolean) 


185
186
 
# File 'lib/bibtex/value.rb', line 185

def date?
end

#each_token ⇒ Object 



218
 
# File 'lib/bibtex/value.rb', line 218

def each_token; @tokens.each; end

#initialize_copy(other) ⇒ Object 



65
66
67
 
# File 'lib/bibtex/value.rb', line 65

def initialize_copy(other)
  @tokens = other.tokens.dup
end

#inspect ⇒ Object 



163
164
165
 
# File 'lib/bibtex/value.rb', line 163

def inspect
  '<' + @tokens.map(&:inspect).join(', ') + '>'
end

#join ⇒ Object

Returns the Value instance with all consecutive String tokens joined.

call-seq: Value.new(‘foo’, ‘bar’).join #=> <‘foobar’> Value.new(:foo, ‘bar’).join #=> <:foo, ‘bar’>



121
122
123
124
125
126
 
# File 'lib/bibtex/value.rb', line 121

def join
  @tokens = @tokens.inject([]) do |a,b|
    a[-1].is_a?(::String) && b.is_a?(::String) ? a[-1] += b : a << b; a
  end
  self
end

#name? ⇒ Boolean Also known as: names?, is_name?

Returns true if the value is a BibTeX name value.

Returns:

  • (Boolean) 


173
 
# File 'lib/bibtex/value.rb', line 173

def name?; false; end

#numeric? ⇒ Boolean Also known as: is_numeric?

Returns true if the Value’s content is numeric.

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/bibtex/value.rb', line 196

def numeric?
  to_s =~ /^\s*[+-]?\d+[\/\.]?\d*\s*$/
end

#replace(*arguments) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/bibtex/value.rb', line 99

def replace(*arguments)
  return self unless has_symbol?
  arguments.flatten.each do |argument|
    case argument
    when ::String # simulates Ruby's String#replace
      @tokens = [argument]
    when String
      @tokens = @tokens.map { |v| argument.key == v ? argument.value.tokens : v }.flatten
    when Hash
      @tokens = @tokens.map { |v| argument[v] || v }
    end
  end
  self
end

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean) 


247
248
249
 
# File 'lib/bibtex/value.rb', line 247

def respond_to? (method)
  method =~ /^(?:convert|from)_([a-z]+)(!)?$/ || super
end

#symbol? ⇒ Boolean Also known as: has_symbol?

Returns true if the Value contains at least one symbol.

Returns:

  • (Boolean) 


207
208
209
 
# File 'lib/bibtex/value.rb', line 207

def symbol?
  @tokens.detect { |v| v.is_a?(Symbol) }
end

#symbols ⇒ Object

Returns all symbols contained in the Value.



214
215
216
 
# File 'lib/bibtex/value.rb', line 214

def symbols
  @tokens.select { |v| v.is_a?(Symbol) }
end

#to_citeproc(options = {}) ⇒ Object 



202
203
204
 
# File 'lib/bibtex/value.rb', line 202

def to_citeproc (options = {})
  to_s(options)
end

#to_date ⇒ Object

Returns the string as a citeproc date. TODO use edtf format instead.



191
192
193
 
# File 'lib/bibtex/value.rb', line 191

def to_date
  numeric? ? { 'date-parts' => [[to_i]] } : { 'literal' => to_s(:quotes => [])}
end

#to_name ⇒ Object Also known as: to_names 



178
179
180
 
# File 'lib/bibtex/value.rb', line 178

def to_name
  Names.parse(to_s)
end

#to_s(options = {}) ⇒ Object

Returns a the Value as a string. @see #value; the only difference is that single symbols are returned as String, too. If the Value is atomic and the option :quotes is given, the string will be quoted using the quote symbols specified.

If the option :filter is given, the Value will be converted using the filter(s) specified.

call-seq: Value.new(‘foo’).to_s #=> “foo” Value.new(:foo).to_s #=> “foo” Value.new(‘foo’).to_s(:quotes => ‘“’) #=> ”"foo"“ Value.new(‘foo’).to_s(:quotes => [‘”’,‘“’]) #=> ”"foo"“ Value.new(‘foo’).to_s(:quotes => [‘’,‘’]) #=> ”foo“ Value.new(:foo, ‘bar’).to_s #=> ”foo # "bar"“ Value.new(‘foo’, ‘bar’).to_s #=> ”"foo" # "bar"“ Value.new(‘"u’).to_s(:filter => :latex) #=> ”ü“



146
147
148
149
150
151
 
# File 'lib/bibtex/value.rb', line 146

def to_s(options = {})
  return convert(options.delete(:filter)).to_s(options) if options.has_key?(:filter)
  return value.to_s unless options.has_key?(:quotes) && atomic?
  q = [options[:quotes]].flatten
  [q[0], value, q[-1]].compact.join
end

#value ⇒ Object Also known as: v

Returns the Value as a string or, if it consists of a single symbol, as a Symbol instance. If the Value contains multiple tokens, they will be joined by a ‘#’, additionally, all string tokens will be turned into string literals (i.e., delimitted by quotes).



157
158
159
 
# File 'lib/bibtex/value.rb', line 157

def value
  atomic? ? @tokens[0] : @tokens.map { |v|  v.is_a?(::String) ? v.inspect : v }.join(' # ')
end