bibtex-ruby 1.3.5 → 1.3.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bibtex-ruby (1.3.5)
+    bibtex-ruby (1.3.6)
 
 GEM
   remote: http://rubygems.org/
@@ -11,7 +11,7 @@ GEM
       watchr
     builder (3.0.0)
     columnize (0.3.2)
-    cucumber (0.10.5)
+    cucumber (0.10.6)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
       gherkin (~> 2.4.0)
@@ -32,6 +32,7 @@ GEM
       term-ansicolor (>= 1.0.4)
     racc (1.4.6)
     rake (0.9.2)
+    rdoc (3.6.1)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
@@ -64,6 +65,7 @@ DEPENDENCIES
   mynyml-redgreen (>= 0.7)
   racc (>= 1.4)
   rake (>= 0.8)
+  rdoc (>= 3.6)
   ruby-debug
   ruby-debug19
   ruby-prof (>= 0.10)

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.3.6 / 2011-06-11
+
+* Refactored lexer and parser for speed
+* Added support for @strings with braced values (fixes #10)
+
 === 1.3.5 / 2011-06-07
 
 * Removed debugger initialisation

data/Manifest

@@ -7,6 +7,7 @@ README.md
 Rakefile
 auto.watchr
 bibtex-ruby.gemspec
+doc
 examples
 examples/bib2html.rb
 examples/bib2yaml.rb
@@ -15,9 +16,11 @@ features
 features/bibtex.feature
 features/entries.feature
 features/issues
+features/issues/braced_strings.feature
 features/issues/number_keys.feature
 features/issues/parse_months.feature
 features/issues/slash_keys.feature
+features/issues/trailing_comma.feature
 features/names.feature
 features/preambles.feature
 features/query.feature
@@ -54,6 +57,7 @@ test/bibtex
 test/bibtex/test_bibliography.rb
 test/bibtex/test_elements.rb
 test/bibtex/test_entry.rb
+test/bibtex/test_lexer.rb
 test/bibtex/test_names.rb
 test/bibtex/test_parser.rb
 test/bibtex/test_string.rb

data/README.md

@@ -43,18 +43,15 @@ many styles:
 
     >> require 'citeproc'  # requires the citeproc-ruby gem
     => true
-		>> CiteProc.process b[:pickaxe].to_citeproc, :style => :apa
-		=> "Thomas, D., Fowler, C., & Hunt, A. (2009). Programming Ruby 1.9:
-		  The Pragmatic Programmer's Guide. The Facets of Ruby.
-		  Raleigh, North Carolina: The Pragmatic Bookshelf."
-		>> CiteProc.process b[:pickaxe].to_citeproc, :style => 'chicago-author-date'
-		=> "Thomas, Dave, Chad Fowler, and Andy Hunt. 2009. Programming Ruby 1.9:
-		  The Pragmatic Programmer's Guide. The Facets of Ruby.
-		  Raleigh, North Carolina: The Pragmatic Bookshelf."
-		>> CiteProc.process b[:pickaxe].to_citeproc, :style => :mla
-		=> "Thomas, Dave, Chad Fowler, and Andy Hunt. Programming Ruby 1.9:
-		  The Pragmatic Programmer's Guide. Raleigh, North Carolina:
-		  The Pragmatic Bookshelf, 2009."
+    >> CiteProc.process b[:pickaxe].to_citeproc, :style => :apa
+    => "Thomas, D., Fowler, C., & Hunt, A. (2009). Programming Ruby 1.9: The Pragmatic Programmer's
+      Guide. The Facets of Ruby. Raleigh, North Carolina: The Pragmatic Bookshelf."
+    >> CiteProc.process b[:pickaxe].to_citeproc, :style => 'chicago-author-date'
+    => "Thomas, Dave, Chad Fowler, and Andy Hunt. 2009. Programming Ruby 1.9: The Pragmatic
+      Programmer's Guide. The Facets of Ruby.Raleigh, North Carolina: The Pragmatic Bookshelf."
+    >> CiteProc.process b[:pickaxe].to_citeproc, :style => :mla
+    => "Thomas, Dave, Chad Fowler, and Andy Hunt. Programming Ruby 1.9: The Pragmatic Programmer's
+      Guide. Raleigh, North Carolina: The Pragmatic Bookshelf, 2009."
 
 
 Installation

data/bibtex-ruby.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('json', ['>= 1.5'])
   s.add_development_dependency('ruby-prof', ['>= 0.10'])
   s.add_development_dependency('gnuplot', ['>= 2.3'])
+  s.add_development_dependency('rdoc', ['>= 3.6'])
 
   s.files             = File.open('Manifest').readlines.map(&:chomp)
   s.test_files        = Dir.glob('test/**/test*.rb')

data/features/issues/braced_strings.feature

@@ -0,0 +1,48 @@
+Feature: BibTeX Braced Strings
+	As a hacker who works with bibliographies
+	I want to be able to parse BibTeX files containing string definitions using braced expressions
+	Because applications such as BibDesk produce that format
+
+	@string
+	Scenario: A simple string assignment
+		When I parse the following file:
+		"""
+		@string{ foo = {foo} }
+		"""
+		Then my bibliography should contain 1 string
+		
+	@string @replacement
+	Scenario: A BibTeX file with string assignments
+		When I parse the following file:
+		"""
+		Simple strings:
+		@string{ foo1 = {foo} }
+		@string{ foo2 = {foo}}
+		@string{ foo3 ={foo}}
+		@string{foo4={foo}}
+		@string{ foo5 = {"foo" bar} }
+		@string{ foo6 = {"foo" bar{"}} }
+		
+		Compound strings:
+		@string{ foo7 = foo1 }
+		@string{ foo8 = foo1 # {bar} }
+		@string{ foo9 = {foo } # {bar} }
+		
+		"""
+		Then my bibliography should contain 9 strings
+		And my bibliography should contain these strings:
+			| value            |
+			| foo              |
+			| foo              |
+			| foo              |
+			| foo              |
+			| "foo" bar        |
+			| "foo" bar{"}     |
+			| foo1             |
+			| foo1 # "bar"     |
+			| "foo " # "bar"   |
+		When I replace and join all strings in my bibliography
+		Then the string "foo7" should be "foo"
+		And the string "foo8" should be "foobar"
+		And the string "foo9" should be "foo bar"
+		

data/features/issues/trailing_comma.feature

@@ -0,0 +1,21 @@
+Feature: Parse BibTeX files with trailing commas
+	As a hacker who works with bibliographies
+	I want to be able to parse BibTeX files with a trailing comma
+
+	Scenario: A BibTeX file with lots of objects and comments
+		When I parse the following file:
+		"""
+		@article{rb2011,
+		  author = {Keil, Sylvester},
+		  title  = "BibTeX-Ruby",
+		  year   = 2011,
+		},
+
+		@article{key03,
+				year = 2000,
+		    title = "A {bunch {of} braces {in}} title",
+		},
+		"""
+		Then my bibliography should contain an entry with key "rb2011"
+		And my bibliography should contain 1 articles published in 2011
+		And my bibliography should contain an entry with key "key03"

data/features/step_definitions/bibtex_steps.rb

@@ -71,10 +71,18 @@ Then /^there should be exactly (\d+) match(?:es)?$/ do |matches|
 end
 
 
+Then /^my bibliography should contain (\d+) (\w+)$/ do |count, type|
+  assert_equal count.to_i, @bibliography.q("@#{type.chomp('s')}").length
+end
+
 Then /^my bibliography should contain (\d+) (\w+) published in (\d+)$/ do |count, type, year|
-  assert_equal @bibliography.q("@#{type.chomp!('s')}[year=#{year}]").length, count.to_i
+  assert_equal count.to_i, @bibliography.q("@#{type.chomp('s')}[year=#{year}]").length
 end
 
 Then /^my bibliography should contain an? (\w+) with id "([^"]*)"$/ do |type, id|
   assert_equal @bibliography[id.to_sym].type, type.to_sym
 end
+
+Then /^the string "([^"]*)" should be "([^"]*)"$/ do |key, value|
+  assert_equal value, @bibliography.strings[key.to_sym].v.to_s
+end

data/features/strings.feature

@@ -2,6 +2,7 @@ Feature: BibTeX Strings
 	As a hacker who works with bibliographies
 	I want to be able to parse BibTeX files containing string assignments
 
+	@string
 	Scenario: A BibTeX file with string assignments
 		When I parse the following file:
 		"""

data/lib/bibtex/bibliography.rb

@@ -30,7 +30,9 @@ module BibTeX
     
     include Enumerable
     include Comparable
-        
+    
+    DEFAULTS = { :parse_names => true, :parse_months => true }.freeze
+    
     class << self    
 
       # Opens and parses the `.bib' file at the given +path+. Returns
@@ -40,7 +42,11 @@ module BibTeX
       # to specify a save path other than the path from where the file is
       # loaded).
       #
-      # The options argument is passed on to BibTeX::Parser.new.
+      # The options argument is passed on to BibTeX::Parser.new. Additional
+      # option parameters are:
+      #
+      # -:parse_names: set to false to disable automatic name parsing
+      # -:parse_months: set to false to disable automatic month conversion
       #
       def open(path, options = {})
         b = parse(Kernel.open(path).read, options)
@@ -55,10 +61,7 @@ module BibTeX
 
       # Parses the given string and returns a corresponding Bibliography instance.
       def parse(bibtex, options = {})
-        b = Parser.new(options).parse(bibtex)
-        b.parse_names unless b.nil? || options[:parse_names] == false
-        b.parse_months unless b.nil? || options[:parse_months] == false
-        b
+        Parser.new(options).parse(bibtex)
       end
       
       #
@@ -73,7 +76,7 @@ module BibTeX
     end
   
     attr_accessor :path
-    attr_reader :data, :strings, :entries, :errors
+    attr_reader :data, :strings, :entries, :errors, :options
 
     attr_by_type :article, :book, :journal, :collection, :preamble, :comment, :meta_content
     
@@ -81,13 +84,13 @@ module BibTeX
 
     
     #
-    # Creates a new bibliography; empty if no data attribute is specified.
+    # Creates a new bibliography.
     #
-    def initialize(data = [])
-      @data = []
-      @strings = {}
-      @entries = {}
-      add(data)
+    def initialize(options = {})
+      @options = DEFAULTS.merge(options)
+      @data, @strings, @entries = [], {}, {}
+
+      yield self if block_given?
     end
     
     # Adds a new element, or a list of new elements to the bibliography.
@@ -100,8 +103,8 @@ module BibTeX
       self
     end
     
-    alias :<< :add
-    alias :push :add
+    alias << add
+    alias push add
     
     # Saves the bibliography to the current path.
     def save(options = {})
@@ -116,12 +119,12 @@ module BibTeX
     end
     
     def parse_names
-      q('@entry') { |e| e.parse_names }
+      @entries.values.each { |e| e.parse_names }
       self
     end
     
     def parse_months
-      q('@entry') { |e| e.parse_month }
+      @entries.values.each { |e| e.parse_month }
       self
     end
     
@@ -139,8 +142,8 @@ module BibTeX
       objects.length == 1 ? objects[0] : objects
     end
     
-    alias :remove :delete
-    alias :rm :delete
+    alias remove delete
+    alias rm delete
 
     #
     # Returns an element or a list of elements according to the given index,
@@ -221,7 +224,7 @@ module BibTeX
       self
     end
     
-    alias :join_strings :join
+    alias join_strings join
 
     def rename(*arguments, &block)
       q('@entry') { |e| e.rename(*arguments, &block) }
@@ -300,13 +303,13 @@ module BibTeX
       send(query_handler(selector), &filter)
     end
     
-    alias :q :query
+    alias q query
         
     def find_by_type(*types, &block)
       q(types.flatten.compact.map { |t| "@#{t}" }.join(', '), &block)
     end
     
-    alias :find_by_types :find_by_type
+    alias find_by_types find_by_type
 
     def <=>(other)
       other.respond_to?(:to_a) ? to_a <=> other.to_a : nil

data/lib/bibtex/bibtex.y

@@ -30,7 +30,7 @@ expect 0
 
 rule
 
-  bibliography : /* empty */                       { result = BibTeX::Bibliography.new }
+  bibliography : /* empty */                       { result = BibTeX::Bibliography.new(@options) }
                | objects                           { result = val[0] }
 
   objects : object                                 { result = BibTeX::Bibliography.new << val[0] }
@@ -60,6 +60,7 @@ rule
                | string_value SHARP string_literal { result << val[2] }
 
   string_literal : NAME                            { result = val[0].downcase.to_sym }
+                 | LBRACE content RBRACE           { result = val[1] }
                  | STRING_LITERAL                  { result = val[0] }
 
   entry : entry_head assignments RBRACE            { result = val[0] << val[1] }
@@ -79,7 +80,6 @@ rule
 
   value : string_value                             { result = val[0] }
         | NUMBER                                   { result = val[0] }
-        | LBRACE content RBRACE                    { result = val[1] }
 
 end
 
@@ -88,43 +88,31 @@ require 'bibtex/lexer'
 
 ---- inner
 
-  attr_reader :lexer
+  attr_reader :lexer, :options
   
+	DEFAULTS = { :include => [:errors], :debug => ENV['DEBUG'] == true }.freeze
+	
   def initialize(options = {})
-		self.options.merge!(options)
+		@options = DEFAULTS.merge(options)
     @lexer = Lexer.new(@options)
   end
 
-	def options
-		@options ||= { :include => [:errors], :debug => ENV['DEBUG'] == true }
-	end
-	
   def parse(input)
-    @yydebug = debug?
-    
-    @lexer.data = input
-    @lexer.analyse
+    @yydebug = debug?   
+    @lexer.analyse(input)
     
     do_parse
+		#yyparse(@lexer,:each)
   end
   
   def next_token
-    token = @lexer.next_token
-    if token[0] == :ERROR
-      include_errors? ? token : next_token
-    else
-      [token[0],token[1][0]]
-    end
+    @lexer.next_token
   end
   
   def debug?
     @options[:debug] == true
   end
-  
-  def include_errors?
-    @options[:include].include?(:errors)
-  end
-  
+    
   def on_error(tid, val, vstack)
     Log.error("Failed to parse BibTeX on value %s (%s) %s" % [val.inspect, token_to_str(tid) || '?', vstack.inspect])
     #raise(ParseError, "Failed to parse BibTeX on value %s (%s) %s" % [val.inspect, token_to_str(tid) || '?', vstack.inspect])

data/lib/bibtex/elements.rb

@@ -38,9 +38,7 @@ module BibTeX
     end
     
 		# Returns a string containing the object's content.
-		def content(options = {})
-			''
-		end
+		def content(options = {}); ''; end
 
     # Invokes BibTeX string replacement on this element.
     def replace(*arguments); self; end
@@ -70,28 +68,28 @@ module BibTeX
     
     # Returns true if the element matches the given query.
     def matches?(query)
-      return true if query.nil? || query.respond_to?(:empty?) && query.empty?
+      return true if !query || query.respond_to?(:empty?) && query.empty?
       
       case query
-      when Element
-        self == query
       when Symbol
-        id == query
+        query == id
+      when Element
+        query == self
       when Regexp
         to_s.match(query)
-      when /^\/(.+)\/$/
-        to_s.match(Regexp.new($1))
       when /@(\w+)(?:\[([^\]]*)\])?/
         query.scan(/@(\w+)(?:\[([^\]]*)\])?/).any? do |type, condition|
           has_type?(type) && ( condition.nil? || meets?(condition.split(/,\s*/)) )
         end
+      when /^\/(.+)\/$/
+        to_s.match(Regexp.new($1))
       else
         id == query.to_sym
       end      
     end
     
-    alias :=== :matches?
-    alias :match? :matches?
+    alias === matches?
+    alias match? matches?
     
     # Returns true if the element meets all of the given conditions.
     def meets?(*conditions)
@@ -101,9 +99,9 @@ module BibTeX
       end
     end
     
-    alias :meet? :meets?
+    alias meet? meets?
     
-		alias :to_s :content
+		alias to_s content
 		
 		def to_hash(options = {})
 		  { type => content }