bibtex-ruby 1.0.0

data/lib/bibtex/string_replacement.rb

@@ -0,0 +1,43 @@
+#--
+# BibTeX-Ruby
+# Copyright (C) 2010	Sylvester Keil <http://sylvester.keil.or.at>
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.	If not, see <http://www.gnu.org/licenses/>.
+#++
+
+module BibTeX
+	# This module contains functions to manipulate BibTeX
+	# string literals.
+	module StringReplacement
+		
+		# Returns a string representation of the literal.
+		def self.to_s(value,options={})
+			return if value.nil?
+			options[:delimiter] ||= ['"','"']
+			#options[:delimiter] ||= ['{','}']
+
+			if value.empty? || (value.length == 1 && !value[0].kind_of?(Symbol))
+				[options[:delimiter][0],value,options[:delimiter][1]].join
+			else
+				value.map { |s| s.kind_of?(Symbol) ? s.to_s : s.inspect}.join(' # ')
+			end
+		end
+
+		# Replaces all string constants in +value+ which are defined in +hsh+.
+		def self.replace(value,hsh)
+			return if value.nil?
+			value.map { |s| s.kind_of?(Symbol) && hsh.has_key?(s) ? hsh[s] : s }.flatten
+		end
+	end
+end

data/lib/extensions/core.rb

@@ -0,0 +1,35 @@
+# BibTeX-Ruby
+# Copyright (C) 2010-2011	Sylvester Keil <http://sylvester.keil.or.at>
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.	If not, see <http://www.gnu.org/licenses/>.
+#++
+
+#
+# This file contains extensions to the Ruby core
+#
+
+class StringScanner
+  
+  alias orig_scan_until scan_until
+  
+  def pre_match_offset(offset)
+    self.pre_match[offset..-1]
+  end
+  
+  # Like the original +scan_until+ but sets the start of `pre_match' to the
+  # current position not to zero
+  def scan_until(pattern)
+    
+  end
+end

data/test/bib/01_no_bibtex.bib

@@ -0,0 +1,9 @@
+%%
+%% A valid BibTeX file that contains no BibTeX objects
+%%
+
+Therefore, all content is treated as a comment
+
+
+string{ foo = "bar" }
+

data/test/bib/02_string.bib

@@ -0,0 +1 @@
+@string{ foo = "bar" }

data/test/bib/03_string.bib

@@ -0,0 +1,26 @@
+%%
+%% This is a valid BibTeX file
+%% String assignments Test
+%%
+
+@string{foo="bar"}
+@ string{foo="bar"}
+@string {foo="bar"}
+@string{ foo="bar"}
+@string{foo ="bar"}
+@string{foo= "bar"}
+@string{foo="bar" }
+@ string { foo = "bar" }
+@string   { foo=   "bar"}
+@string{ foo = "bar" }
+
+@string{foo="bar"}
+@string{foo="'bar'"}
+@string{foo="{"}bar{"}"}
+
+Using some interesting symbols
+@string{foo="@bar@"}
+@string{foo="'bar'"}
+@string{foo="{"}bar{"}"}
+@string{foo="{bar}"}
+

data/test/bib/04_string_replacement.bib

@@ -0,0 +1,16 @@
+%%
+%% A valid BibTeX file
+%% String assignment and replacement
+%%
+
+@string{ foo = "foo" }
+@string{ bar = "bar" }
+@string{ foobar = foo # "bar" }
+@string{ foobarfoo = foobar # foo }
+@string{ barfoobar = bar # "foo" # bar }
+
+@preamble { "foo" # foo # foobarfoo # "bar" }
+
+@manual {manual:1,
+	title = "foo" # barfoobar
+}

data/test/bib/05_comment.bib

@@ -0,0 +1,15 @@
+%
+% A valid BibTeX file
+%
+
+% Simple comments
+
+@comment{ A comment can contain pretty much anything }
+
+Here a comment is used to comment out otherwise valid
+entries:
+@comment{
+@string{ foo = "bar" }
+
+@string{ bar = "foo" }
+}

data/test/bib/06_preamble.bib

@@ -0,0 +1,12 @@
+%%
+%% 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 }

data/test/bib/07_entry.bib

@@ -0,0 +1,20 @@
+%%
+%% A valid BibTeX file
+%%
+
+%% This file contains a few entries
+
+@book{key:0,
+  author = "Poe, Edgar A.",
+  title = {Selected \emph{Poetry} and `Tales'},
+  publisher = "American Library",
+  year = 2003
+}
+
+@article { key:1 ,
+  author={Hawthorne, Nathaniel},
+  title={Tales and Sketches},
+  publisher={American Library},
+  year={2001},}
+
+@article{foo,}

data/test/bib/08_decoret.bib

@@ -0,0 +1,83 @@
+%%
+%% 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{steward03,
+  author =   {Martha Steward},
+  title =  {Cooking behind bars},
+  publisher =  {Culinary Expert Series},
+  year =   2003
+}
+[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{steward03,
+    author =   {Martha Steward},
+    title =  {Cooking behind bars},
+    publisher =  {Culinary Expert Series},
+    year =   2003
+  }
+}
+
+@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 }
+

data/test/bib/09_errors.bib

@@ -0,0 +1,67 @@
+%%
+%% A BibTeX file with various errors.
+%%
+
+In strict mode we cannot have the AT symbol anywhere except inside literals
+or comment objects.
+
+Unbalanced braces in string literal:
+@string{ foo = "foo }
+
+Another unbalanced braces in string literal:
+@string{ foo = "foo{"} }
+
+Another unterminated string literal:
+@string{ foo = "foo{" }
+
+A valid objects after two invalid ones:
+@string { foo="foo"}
+
+Unterminated literal:
+@preamble    {  "{" # foo # "bar" }
+
+Valid object:
+@preamble {
+	"preamble"
+	
+}
+
+Bad Syntax:
+@book{
+	author = "An Author"
+}
+
+@book{key
+	author = "An Author"
+}
+
+@book{key,
+	author = "An Author"
+	title = "The Title"
+}
+
+Unterminated string:
+@book{key,
+	author = "An Author,
+	title = "The Title"
+}
+
+Better syntax:
+@book{ key, author ="An Author", title = "The Title"}
+
+Unterminated object:
+@preamble{ "hello"
+
+@string
+{ bar =
+"bar"
+
+Better:
+@string
+
+{
+  bar
+  =
+  "bar"
+
+}

data/test/bib/10_bibdesk.bib

@@ -0,0 +1,47 @@
+%% 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, David Heinemeier},
+	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}}

data/test/test_bibtex.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'bibtex'
+require 'minitest/unit'
+require 'minitest/autorun'
+
+class TestBibtex < MiniTest::Unit::TestCase
+  
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_empty
+    bib = BibTeX::Bibliography.open('test/bib/00_empty.bib', :debug => true)
+    refute_nil(bib)
+    assert_equal(BibTeX::Bibliography, bib.class)
+    assert(bib.empty?)
+  end
+
+  def test_no_bibtex
+    bib = BibTeX::Bibliography.open('test/bib/01_no_bibtex.bib', :debug => true)
+    refute_nil(bib)
+    assert_equal(BibTeX::Bibliography, bib.class)
+    assert(bib.empty?)
+  end
+
+  def test_decoret
+    bib = BibTeX::Bibliography.open('test/bib/08_decoret.bib', :debug => true)
+    refute_nil(bib)
+    assert_equal(BibTeX::Bibliography, bib.class)
+    assert_equal(15, bib.length)
+    assert_equal([BibTeX::Entry,BibTeX::Comment,BibTeX::String,BibTeX::Preamble], bib.data.map(&:class).uniq)
+    assert_equal('py03', bib.data[0].key)
+    assert_equal(:article, bib['py03'].type)
+    assert_equal(['Xavier D\\\'ecoret'], bib['py03'][:author])
+    assert_equal(['PyBiTex'], bib['py03'][:title])
+    assert_equal(['2003'], bib['py03'][:year])
+    assert_equal(:article, bib['key03'].type)
+    assert_equal(['A {bunch {of} braces {in}} title'], bib['key03'][:title])
+    #TODO missing assertions
+  end
+  
+  def test_errors
+    bib = BibTeX::Bibliography.open('test/bib/09_errors.bib', :debug => true)
+    #refute_nil(bib)
+  end
+  
+  def test_bibdesk
+    bib = BibTeX::Bibliography.open('test/bib/10_bibdesk.bib', :debug => true)
+    refute_nil(bib)
+    assert_equal(BibTeX::Bibliography, bib.class)
+    assert_equal(3, bib.length)
+    assert_equal('rails', bib.data[0].key)
+    assert_equal(['2010-08-05 10:06:32 +0200'], bib[:dragon]['date-modified'])
+  end
+end
+