bibtex-ruby 1.2.1 → 1.3.0

data/Rakefile

@@ -18,15 +18,28 @@ Rake::RDocTask.new(:rdoc_task) do |rd|
 end
 
 Rake::TestTask.new(:test_task) do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test_*.rb']
+  t.libs << 'lib' << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
   t.verbose = true
 end
 
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress"
+  end
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+
 task :default => ['racc']
 
 desc 'Generates the BibTeX parser'
-task :racc => ['lib/bibtex/parser.rb']
+task :racc => ['lib/bibtex/parser.rb','lib/bibtex/name_parser.rb']
 
 desc 'Generates RDoc documentation for BibTeX-Ruby'
 task :rdoc => ['clean','racc','rdoc_task']
@@ -35,7 +48,13 @@ task :test => ['racc','test_task']
 
 file 'lib/bibtex/parser.output' => ['lib/bibtex/parser.rb']
 file 'lib/bibtex/parser.rb' => ['lib/bibtex/bibtex.y'] do
-  sh 'racc -v -g -o lib/bibtex/parser.rb lib/bibtex/bibtex.y'
+  # sh 'racc -v -g -o lib/bibtex/parser.rb lib/bibtex/bibtex.y'
+  sh 'racc -v -o lib/bibtex/parser.rb lib/bibtex/bibtex.y'
+end
+
+file 'lib/bibtex/name_parser.rb' => ['lib/bibtex/names.y'] do
+  # sh 'racc -v -g -o lib/bibtex/name_parser.rb lib/bibtex/names.y'
+  sh 'racc -v -o lib/bibtex/name_parser.rb lib/bibtex/names.y'
 end
 
 desc 'Updates the Manifest file'
@@ -52,11 +71,13 @@ end
 
 desc 'Pushes the gem file to rubygems.org'
 task :release => ['build'] do
-  system "gem push bibtex-ruby-#{BibTeX::Version::STRING}"
+  system "gem push bibtex-ruby-#{BibTeX::Version::STRING}.gem"
 end
 
 CLEAN.include('lib/bibtex/parser.rb')
 CLEAN.include('lib/bibtex/parser.output')
+CLEAN.include('lib/bibtex/name_parser.rb')
+CLEAN.include('lib/bibtex/name_parser.output')
 CLEAN.include('doc/html')
 CLEAN.include('*.gem')
 

data/auto.watchr

@@ -0,0 +1,6 @@
+require 'autowatchr'
+
+Autowatchr.new(self) do |config|
+	config.lib_dir  = 'lib'
+	config.test_dir = 'test'
+end

data/bibtex-ruby.gemspec

@@ -12,18 +12,21 @@ Gem::Specification.new do |s|
   s.email             = 'http://sylvester.keil.or.at'
   s.homepage          = 'http://inukshuk.github.com/bibtex-ruby'
   s.summary           = 'A BibTeX parser and converter written in Ruby.'
-  s.description       = 'A (fairly complete) BibTeX parser written in Ruby. Supports regular BibTeX entries, @comments, string replacement via @string. Allows for easy export/conversion to formats such as YAML, JSON, and XML.'
+  s.description       = 'A (fairly complete) BibTeX library and parser written in Ruby. Includes a name parser and supports regular BibTeX entries, @comments, string replacement via @string. Allows for easy export/conversion to formats such as YAML, JSON, and XML.'
   s.date              = Time.now
 
   s.required_rubygems_version = '>= 1.3.6'
   s.rubyforge_project = s.name
 
-  s.add_development_dependency('racc', ['>= 1.4.6'])
-  s.add_development_dependency('minitest', ['>= 2.0.2'])
-  s.add_development_dependency('json', ['>= 1.5.0'])
+  s.add_development_dependency('racc', ['>= 1.4'])
+  s.add_development_dependency('mini_shoulda', ['>= 0.3'])
+  s.add_development_dependency('mynyml-redgreen', ['>= 0.7'])
+  s.add_development_dependency('autowatchr', ['>= 0.1'])
+  s.add_development_dependency('cucumber', ['>= 0.10'])
+  s.add_development_dependency('json', ['>= 1.5'])
 
   s.files             = File.open('Manifest').readlines.map(&:chomp)
-  s.test_files        = Dir.glob('test/test*.rb')
+  s.test_files        = Dir.glob('test/**/test*.rb')
   s.executables       = []
   s.require_path      = 'lib'
 

data/examples/bib2html.rb

@@ -3,26 +3,36 @@ require 'bibtex'
 
 
 # Open a bibliography file
-bib = BibTeX.open(File.expand_path('../markdown.bib',__FILE__),
-  :include => [:meta_comments])
+bib = BibTeX.open File.expand_path('../markdown.bib',__FILE__),
+  :include => [:meta_content]
 
 
-# Convert the BibTeX entries into a simple text format
-content = bib.data.map do |d|
-  result = ''
-  
-  if d.class == BibTeX::Entry
-    d.replace!(bib.strings)
-    result = [d.author, '. ', d.title, '. ', d.publisher, ': ', d.address, ', ', d.year, '.'].join
-  end
-  
-  if d.class == BibTeX::MetaComment
-    result = d.to_s
+# Replaces all strings in the Bibliography and then
+# converts each BibTeX entries to a string using Chicago style
+# (all other elements are mapped to simple strings)
+
+# TODO 1.3.1
+# begin
+#   require 'citeproc'
+# rescue LoadError
+#   puts 'this example depends on the citeproc-ruby gem'
+#   exit
+# end
+
+content = bib.replace.q('@entry, @meta_content').map do |b|
+  if b.entry?  
+    [b.author, '. ', b.title, '. ', b.publisher, ': ', b.address, ', ', b.year, '.'].join
+  else
+    b.to_s
   end
-  
-  result
 end
 
-# Convert all non BibTeX text (i.e., the `meta comments') using the maruku gem
-require 'maruku'
-puts Maruku.new(content.join).to_html_document
+
+begin
+  require 'redcarpet'
+rescue LoadError
+  puts 'this example depends on the redcarpet gem'
+  exit
+end
+
+puts Redcarpet.new(content.join).to_html

data/features/bibtex.feature

@@ -0,0 +1,96 @@
+Feature: Parse BibTeX files
+	As a hacker who works with bibliographies
+	I want to be able to parse BibTeX files using Ruby
+
+	Scenario: A BibTeX file with lots of objects and comments
+		When I parse the following file:
+		"""
+		%%
+		%% This BibTeX file contains all the examples of valid BibTeX objects
+		%% in Xavier Decoret's `A summary of BibTeX' at
+		%% http://artis.imag.fr/~Xavier.Decoret/resources/xdkbibtex/bibtex_summary.html
+		%%
+
+		@Article{py03,
+		  author = {Xavier D\'ecoret},
+		  title  = "PyBiTex",
+		  year   = 2003
+		}
+
+		@Article{key03,
+		    title = "A {bunch {of} braces {in}} title"
+		}
+
+		@Article{key01,
+		    author = "Simon {"}the {saint"} Templar", 
+		    }
+
+		@Article{key01,
+		    title = "The history of @ sign"
+		}
+
+		Some {{comments} with unbalanced braces
+		....and a "commented" entry...
+
+		Book{landru21,
+		  author =   {Landru, Henri D\'esir\'e},
+		  title =  {A hundred recipes for you wife},
+		  publisher =  {Culinary Expert Series},
+		  year =   1921
+		}
+
+		..some other comments..before a valid entry...
+
+		@Book{steward03,
+		  author =   { Martha Steward },
+		  title =  {Cooking behind bars},
+		  publisher =  {Culinary Expert Series},
+		  year =   2003
+		}
+
+		...and finally an entry commented by the use of the special Comment entry type.
+
+		@Comment{steward04,
+		  author =   {Martha Steward},
+		  title =  {Cooking behind bars},
+		  publisher =  {Culinary Expert Series},
+		  year =   2004
+		}
+		[Note: here BibTeX-Ruby differs from bibtex in that it does not parse
+		the nested book as an object, but treats it as a comment!]
+		@Comment{
+		  @Book{steward04,
+		    author =   {Martha Steward},
+		    title =  {Cooking behind bars},
+		    publisher =  {Culinary Expert Series},
+		    year =   2004
+		  }
+		}
+
+		@String{mar = "march"}
+
+		@Book{sweig42,
+		  Author =   { Stefan Sweig },
+		  title =  { The impossible book },
+		  publisher =  { Dead Poet Society},
+		  year =   1942,
+		  month =      "1~" # mar
+		}
+
+
+		@String {firstname = "Xavier"}
+		@String {lastname  = "Decoret"}
+		@String {email      = firstname # "." # lastname # "@imag.fr"}
+
+		@preamble {"This bibliography was generated on \today"}
+
+		@String {maintainer = "Xavier D\'ecoret"}
+
+		@preamble { "Maintained by " # maintainer }
+
+		"""
+		Then my bibliography should contain the following numbers of elements:
+			| article | book | comment | string | preamble | total |
+			| 4       | 2    | 2       | 5      | 2        | 15    |
+		And my bibliography should contain an entry with key "sweig42"
+		But my bibliography should not contain an entry with key "steward04"

data/features/entries.feature

@@ -0,0 +1,67 @@
+Feature: Parse BibTeX preambles
+	As a hacker who works with bibliographies
+	I want to be able to parse BibTeX files with entries
+	Because that's what BibTeX is all about
+
+	Scenario: A BibTeX file with three books
+		When I parse the following file:
+		"""
+		%% This BibTeX bibliography file was created using BibDesk.
+		%% http://bibdesk.sourceforge.net/
+
+
+		%% Created for Sylvester Keil at 2010-08-05 10:07:07 +0200 
+
+
+		%% Saved with string encoding Unicode (UTF-8) 
+
+
+
+		@book{rails,
+			Address = {Raleigh, North Carolina},
+			Author = {Ruby, Sam, and Thomas, Dave, and Hansson Heinemeier, David},
+			Booktitle = {Agile Web Development with Rails},
+			Date-Added = {2010-08-05 10:01:36 +0200},
+			Date-Modified = {2010-08-05 10:06:46 +0200},
+			Edition = {third},
+			Isbn = {978-1-9343561-6-6},
+			Keywords = {ruby, rails},
+			Publisher = {The Pragmatic Bookshelf},
+			Series = {The Facets of Ruby},
+			Title = {Agile Web Development with Rails},
+			Year = {2009}
+		}
+
+		@book{dragon,
+			Address = {Boston},
+			Author = {Aho, Alfred V., and Lam, Monica S., and Ullman, Jeffrey D.},
+			Booktitle = {Compilers: Principles, Techniques, and Tools},
+			Date-Added = {2010-08-05 09:57:15 +0200},
+			Date-Modified = {2010-08-05 10:06:32 +0200},
+			Edition = {second},
+			Keywords = {compiler, lex, yacc},
+			Publisher = {Addison Wesley},
+			Title = {Compilers: Principles, Techniques, and Tools},
+			Year = {2007}
+		}
+
+		@book{pickaxe,
+			Address = {Raleigh, North Carolina},
+			Author = {Thomas, Dave, and Fowler, Chad, and Hunt, Andy},
+			Date-Added = {2010-08-05 09:54:07 +0200},
+			Date-Modified = {2010-08-05 10:07:01 +0200},
+			Keywords = {ruby},
+			Publisher = {The Pragmatic Bookshelf},
+			Series = {The Facets of Ruby},
+			Title = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
+			Year = {2009}
+		}
+		"""
+		Then my bibliography should contain these books:
+			| title                                                  | author                                                   | publisher               | year |
+			| Agile Web Development with Rails                       | Ruby, Sam and Thomas, Dave and Hansson Heinemeier, David | The Pragmatic Bookshelf | 2009 |
+			| Compilers: Principles, Techniques, and Tools           | Aho, Alfred V. and Lam, Monica S. and Ullman, Jeffrey D. | Addison Wesley          | 2007 |
+			| Programming Ruby 1.9: The Pragmatic Programmer's Guide | Thomas, Dave and Fowler, Chad and Hunt, Andy             | The Pragmatic Bookshelf | 2009 |
+		And my bibliography should contain 2 books published in 2009
+		And my bibliography should contain a book with id "pickaxe"
+		And my bibliography should contain a book with id "dragon"

data/features/issues/slash_keys.feature

@@ -0,0 +1,21 @@
+Feature: Keys containing '/' symbols
+	As a hacker who works with bibliographies
+	I want to parse BibTeX entries with keys containing slashes
+	Because they frequently occur in key naming schemes
+	
+	Scenario: An entry taken from the DBLP
+		When I parse the following file:
+		"""
+		@article{DBLP:journals/dq/RossinK99,
+		  author    = {Donald F. Rossin and
+		               Barbara D. Klein},
+		  title     = {Data Errors in Neural Network and Linear Regression Models:
+		               An Experimental Comparison},
+		  journal   = {Data Quality Journal},
+		  volume    = {5},
+		  year      = {1999},
+		  ee        = {http://www.dataquality.com/999KR.htm},
+		  bibsource = {DBLP, http://dblp.uni-trier.de}
+		}
+		"""
+		Then my bibliography should contain an article with id "DBLP:journals/dq/RossinK99"

data/features/names.feature

@@ -0,0 +1,72 @@
+Feature: BibTeX Names
+	As a hacker who works with bibliographies
+	I want to be able to access individual parts of names in a BibTeX file
+	
+	Scenario Outline: Name splitting
+		When I parse the name "<name>"
+		Then the parts should be:
+			|  first  |  von  |  last  |  jr  |
+			| <first> | <von> | <last> | <jr> |
+	
+	@display
+	Scenarios: Decoret test suite (display order)
+		| name            | first      | von        | last    | jr |
+		| AA BB           | AA         |            | BB      |    |
+		| AA BB CC        | AA BB      |            | CC      |    |
+		| AA              |            |            | AA      |    |
+		| AA bb           | AA         |            | bb      |    |
+		| aa              |            |            | aa      |    |
+		| aa bb           |            | aa         | bb      |    |
+		| aa BB           |            | aa         | BB      |    |
+		| AA bb CC        | AA         | bb         | CC      |    |
+		| AA bb CC dd EE  | AA         | bb CC dd   | EE      |    |
+		| AA 1B cc dd     | AA 1B      | cc         | dd      |    |
+		| AA 1b cc dd     | AA         | 1b cc      | dd      |    |
+		| AA {b}B cc dd   | AA {b}B    | cc         | dd      |    |
+		| AA {b}b cc dd   | AA         | {b}b cc    | dd      |    |
+		| AA {B}b cc dd   | AA         | {B}b cc    | dd      |    |
+		| AA {B}B cc dd   | AA {B}B    | cc         | dd      |    |
+		| AA \BB{b} cc dd | AA \\BB{b} | cc         | dd      |    |
+		| AA \bb{b} cc dd | AA         | \\bb{b} cc | dd      |    |
+		| AA {bb} cc DD   | AA {bb}    | cc         | DD      |    |
+		| AA bb {cc} DD   | AA         | bb         | {cc} DD |    |
+		| AA {bb} CC      | AA {bb}    |            | CC      |    |
+
+	@sort
+	Scenarios: Decoret test suite (sort order)
+		| name            | first      | von        | last    | jr |
+		| bb CC, AA       | AA         | bb         | CC      |    |
+		| bb CC, aa       | aa         | bb         | CC      |    |
+		| bb CC dd EE, AA | AA         | bb CC dd   | EE      |    |
+		| bb, AA          | AA         |            | bb      |    |
+		| BB,             |            |            | BB      |    |
+		| bb CC,XX, AA    | AA         | bb         | CC      | XX |
+		| bb CC,xx, AA    | AA         | bb         | CC      | xx |
+		| BB,, AA         | AA         |            | BB      |    |
+		
+	Scenarios: Decoret further remarks
+		| name                              | first                | von            | last                    | jr |
+		# | Paul \'Emile Victor               | Paul \'Emile        |                | Victor                  |    |
+		# | Paul {\'E}mile Victor             | Paul {\'E}mile      |                | Victor                  |    |
+		# | Paul \'emile Victor               | Paul \'emile        |                | Victor                  |    |
+		# | Paul {\'e}mile Victor             | Paul {\'e}mile      |                | Victor                  |    |
+		# | Victor, Paul \'Emile              | Paul \'Emile        |                | Victor                  |    |
+		# | Victor, Paul {\'E}mile            | Paul {\'E}mile      |                | Victor                  |    |
+		# | Victor, Paul \'emile              | Paul \'emile        |                | Victor                  |    |
+		# | Victor, Paul {\'e}mile            | Paul {\'e}mile      |                | Victor                  |    |
+		| Dominique Galouzeau de Villepin    | Dominique Galouzeau  | de             | Villepin                |    |
+		| Dominique {G}alouzeau de Villepin  | Dominique            | {G}alouzeau de | Villepin                |    |
+		| Galouzeau {de} Villepin, Dominique | Dominique            |                | Galouzeau {de} Villepin |    |
+
+	Scenarios: Some actual names
+		| name                              | first                   | von            | last                           | jr  |
+		| John Paul Jones                   | John Paul               |                | Jones                          |     |
+		| Ludwig von Beethoven              | Ludwig                  | von            | Beethoven                      |     |
+		| von Beethoven, Ludwig             | Ludwig                  | von            | Beethoven                      |     |
+		| {von Beethoven}, Ludwig           | Ludwig                  |                | {von Beethoven}                |     |
+		| Ford, Jr., Henry                  | Henry                   |                | Ford                           | Jr. |
+    | Brinch Hansen, Per                | Per                     |                | Brinch Hansen                  |     |
+    | {Barnes and Noble, Inc.}          |                         |                | {Barnes and Noble, Inc.}       |     |
+    | {Barnes and} {Noble, Inc.}        | {Barnes and}            |                | {Noble, Inc.}                  |     |
+    | {Barnes} {and} {Noble,} {Inc.}    | {Barnes} {and} {Noble,} |                | {Inc.}                         |     |
+    | Charles Louis Xavier Joseph de la Vallee Poussin | Charles Louis Xavier Joseph | de la | Vallee Poussin       |     |

data/features/preambles.feature

@@ -0,0 +1,27 @@
+Feature: Parse BibTeX preambles
+	As a hacker who works with bibliographies
+	I want to be able to parse BibTeX files with preambles
+	Because they are part of the BibTeX format
+
+	Scenario: A BibTeX file with preambles and strings
+		When I parse the following file:
+		"""
+		%%
+		%% This is a valid BibTeX File
+		%%
+
+		% Testing preamble statements
+
+		@preamble{"This bibliography was created \today"}
+		@preamble {  "Bib\TeX"  }
+
+		@string{ maintainer = "Myself"}
+
+		@preamble { "Maintained by " # maintainer }
+		"""
+		Then my bibliography should contain the following objects:
+			| type     | value                                 |
+			| preamble | This bibliography was created \\today |
+			| preamble | Bib\\TeX                              |
+			| string   | Myself                                |
+			| preamble | "Maintained by " # maintainer         |

data/features/query.feature

@@ -0,0 +1,56 @@
+Feature: Searching in BibTeX bibliographies
+	As a hacker who writes academic papers
+	I want to be able to search my bibliographies
+	In order to find the references I need
+	
+	Scenario: Find entries in a simple bibliography
+		Given the bibliography:
+		"""
+		@book{pickaxe,
+			Address = {Raleigh, North Carolina},
+			Author = {Thomas, Dave, and Fowler, Chad, and Hunt, Andy},
+			Date-Added = {2010-08-05 09:54:07 +0200},
+			Date-Modified = {2010-08-05 10:07:01 +0200},
+			Keywords = {ruby},
+			Publisher = {The Pragmatic Bookshelf},
+			Series = {The Facets of Ruby},
+			Title = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
+			Year = {2009}
+		}
+		@article{a1,
+			Keywords = {@book}
+		}
+		@book{dragon,
+			Address = {Boston},
+			Author = {Aho, Alfred V., and Lam, Monica S., and Ullman, Jeffrey D.},
+			Booktitle = {Compilers: Principles, Techniques, and Tools},
+			Date-Added = {2010-08-05 09:57:15 +0200},
+			Date-Modified = {2010-08-05 10:06:32 +0200},
+			Edition = {second},
+			Keywords = {compiler, lex, yacc},
+			Publisher = {Addison Wesley},
+			Title = {Compilers: Principles, Techniques, and Tools},
+			Year = {2007}
+		}
+		"""
+		When I search for "pickaxe"
+		Then there should be exactly 1 match
+		When I search for :pickaxe
+		Then there should be exactly 1 match
+		When I search for "camel"
+		Then there should be exactly 0 matches
+		When I search for "@book"
+		Then there should be exactly 2 matches
+		When I search for /@book/
+		Then there should be exactly 3 matches
+		When I search for "@book[]"
+		Then there should be exactly 2 matches
+		When I search for "@book[year=2007]"
+		Then there should be exactly 1 match
+		When I search for "@book[year=2009, keywords=ruby]"
+		Then there should be exactly 1 match
+		When I search for "@book[year=2009, keywords=yacc]"
+		Then there should be exactly 0 matches
+		When I search for "@book, @article"
+		Then there should be exactly 3 matches
+