bibtex-ruby 1.1.2 → 1.2.0

data/lib/bibtex/extensions.rb

@@ -0,0 +1,60 @@
+#--
+# BibTeX-Ruby
+# Copyright (C) 2011  Sylvester Keil <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.
+  # It is intended to be injected in an Array that represents either the
+  # content of a BibTeX @string or an rvalue of a field in a BibTeX entry.
+	module Extensions
+		
+		def self.string_replacement(obj)
+		  raise(ArgumentError, "StringReplacement should only be injected into instances of Array, not #{obj.class}.") unless obj.is_a?(Array)
+		  class << obj; include StringReplacement end
+		  obj
+		end
+		
+		module StringReplacement
+      # Returns a string representation of the literal.
+      def to_s(options={})
+        return '' if self.empty?
+        
+        options[:quotes] ||= [nil,nil]
+        
+        if self.length == 1 && !self[0].is_a?(Symbol)
+          [options[:quotes][0], self[0], options[:quotes][1]].join
+        else
+          self.map { |s| s.is_a?(Symbol) ? s.to_s : %Q("#{ s }") }.join(' # ')
+        end
+      end
+
+      # Replaces all string constants which are defined in +hash+.
+      def replace_strings(hash)
+        Extensions.string_replacement(self.map { |s| s.is_a?(Symbol) && hash.has_key?(s) ? hash[s] : s }.flatten)
+      end
+      
+      # Joins consecutive strings separated by '#'.
+      def join_strings
+        Extensions.string_replacement(self.inject([]) { |a,b|
+          a << (a.last.is_a?(::String) && b.is_a?(::String) ? (a.pop + b) : b )         
+        })
+      end
+    end
+	end
+	
+end

data/lib/bibtex/parser.rb

@@ -398,7 +398,7 @@ module_eval(<<'.,.,', 'bibtex.y', 66)
 
 module_eval(<<'.,.,', 'bibtex.y', 68)
   def _reduce_25(val, _values, result)
-     result = BibTeX::Entry.new(val[0].downcase.to_sym,val[2]) 
+     result = BibTeX::Entry.new(:type => val[0].downcase.to_sym, :key => val[2]) 
     result
   end
 .,.,

data/lib/bibtex/utilities.rb

@@ -0,0 +1,38 @@
+#--
+# BibTeX-Ruby
+# Copyright (C) 2011  Sylvester Keil <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
+
+  class << self
+    # Opens a BibTeX file and returns a corresponding +Bibliography+ object.
+    def open(file, options={})
+      Bibliography.open(file, options)
+    end
+  
+    # Parses the given string and returns a corresponding +Bibliography+ object.
+    def parse(string, options={})
+      BibTeX::Parser.new(options).parse(string)
+    end
+  
+    # Returns true if the given file is a valid BibTeX bibliography.
+    def valid?(file)
+      Bibliography.open(file).valid?
+    end
+  end
+
+end

data/lib/bibtex/version.rb

@@ -18,6 +18,6 @@
 
 module BibTeX
   module Version
-    STRING = '1.1.2'
+    STRING = '1.2.0'
   end
 end

data/test/bib/03_string.bib

@@ -23,4 +23,3 @@ Using some interesting symbols
 @string{foo="'bar'"}
 @string{foo="{"}bar{"}"}
 @string{foo="{bar}"}
-

data/test/bib/11_roundtrip.bib

@@ -0,0 +1,11 @@
+@book{rails,
+  address = {Raleigh, North Carolina},
+  author = {Ruby, Sam, and Thomas, Dave, and Hansson, David Heinemeier},
+  booktitle = {Agile Web Development with Rails},
+  edition = {third},
+  keywords = {ruby, rails},
+  publisher = {The Pragmatic Bookshelf},
+  series = {The Facets of Ruby},
+  title = {Agile Web Development with Rails},
+  year = {2009}
+}

data/test/helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path('../../lib/bibtex.rb', __FILE__)
+require 'rubygems'
+require 'minitest/unit'
+require 'minitest/autorun'

data/test/test_bibtex.rb

@@ -1,7 +1,4 @@
-require File.expand_path('../../lib/bibtex.rb', __FILE__)
-require 'rubygems'
-require 'minitest/unit'
-require 'minitest/autorun'
+require 'helper.rb'
 
 class TestBibtex < MiniTest::Unit::TestCase
   
@@ -33,16 +30,16 @@ class TestBibtex < MiniTest::Unit::TestCase
     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("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])
+    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)
+    bib = BibTeX.open('test/bib/09_errors.bib', :debug => true)
     #refute_nil(bib)
   end
   
@@ -52,7 +49,60 @@ class TestBibtex < MiniTest::Unit::TestCase
     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'])
+    assert_equal('2010-08-05 10:06:32 +0200', bib[:dragon]['date-modified'])
+  end
+  
+  def test_roundtrip
+    file = File.read('test/bib/11_roundtrip.bib')
+    bib = BibTeX.parse(file, :debug => true)
+    refute_nil(bib)
+    assert_equal(BibTeX::Bibliography, bib.class)
+    assert_equal(1, bib.length)
+    assert_equal(file.gsub(/[\s]+/, ''), bib.to_s.gsub(/[\s]+/, ''))
+  end
+  
+  def test_construct
+    file = File.read('test/bib/11_roundtrip.bib')
+    bib = BibTeX::Bibliography.new
+    bib << BibTeX::Entry.new({
+      :type => :book,
+      :key => 'rails',
+      :address => 'Raleigh, North Carolina',
+      :author => 'Ruby, Sam, and Thomas, Dave, and Hansson, David Heinemeier',
+      :booktitle => 'Agile Web Development with Rails',
+      :edition => 'third',
+      :keywords => 'ruby, rails',
+      :publisher => 'The Pragmatic Bookshelf',
+      :series => 'The Facets of Ruby',
+      :title => 'Agile Web Development with Rails',
+      :year => '2009'
+    })
+    assert_equal(file.gsub(/[\s]+/, ''), bib.to_s.gsub(/[\s]+/, ''))    
+  end
+  
+  def test_parse
+    file = File.read('test/bib/11_roundtrip.bib')
+    bib = BibTeX::Bibliography.new
+    bib.add(BibTeX::Element.parse(%q( @string{ pragprog = "The Pragmatic Booksehlf" } )))
+    bib.add(BibTeX::Element.parse(<<-END
+    @book{rails,
+      address = {Raleigh, North Carolina},
+      author = {Ruby, Sam, and Thomas, Dave, and Hansson, David Heinemeier},
+      booktitle = {Agile Web Development with Rails},
+      edition = {third},
+      keywords = {ruby, rails},
+      publisher = {The Pragmatic Bookshelf},
+      series = {The Facets of Ruby},
+      title = {Agile Web Development with Rails},
+      year = {2009}
+    }    
+    END
+    ))
+    
+    assert_equal(2, bib.length)
+    refute_nil(bib[:rails])
+    bib.replace_strings
+    assert_equal(file.gsub(/[\s]+/, ''), bib[:rails].to_s.gsub(/[\s]+/, ''))
   end
 end
 

data/test/test_comment.rb

@@ -1,7 +1,4 @@
-require File.expand_path('../../lib/bibtex.rb', __FILE__)
-require 'rubygems'
-require 'minitest/unit'
-require 'minitest/autorun'
+require 'helper.rb'
 
 class TestComment < MiniTest::Unit::TestCase
   

data/test/test_entry.rb

@@ -1,7 +1,4 @@
-require File.expand_path('../../lib/bibtex.rb', __FILE__)
-require 'rubygems'
-require 'minitest/unit'
-require 'minitest/autorun'
+require 'helper.rb'
 
 class TestEntry < MiniTest::Unit::TestCase
   
@@ -23,23 +20,23 @@ class TestEntry < MiniTest::Unit::TestCase
     assert_equal(:book, bib.data[0].type)
     assert_equal(:article, bib.data[1].type)
     assert_equal(:article, bib.data[2].type)
-    assert_equal(['Poe, Edgar A.'], bib.data[0].fields[:author])
-    assert_equal(['Hawthorne, Nathaniel'], bib.data[1].fields[:author])
-    assert_equal(['2003'], bib.data[0].fields[:year])
-    assert_equal(['2001'], bib.data[1].fields[:year])
-    assert_equal(['American Library'], bib.data[0].fields[:publisher])
-    assert_equal(['American Library'], bib.data[1].fields[:publisher])
-    assert_equal(['Selected \\emph{Poetry} and `Tales\''], bib.data[0].fields[:title])
-    assert_equal(['Tales and Sketches'], bib.data[1].fields[:title])
+    assert_equal('Poe, Edgar A.', bib.data[0][:author])
+    assert_equal('Hawthorne, Nathaniel', bib.data[1][:author])
+    assert_equal('2003', bib.data[0][:year])
+    assert_equal('2001', bib.data[1][:year])
+    assert_equal('American Library', bib.data[0][:publisher])
+    assert_equal('American Library', bib.data[1][:publisher])
+    assert_equal('Selected \\emph{Poetry} and `Tales\'', bib.data[0].title)
+    assert_equal('Tales and Sketches', bib.data[1].title)
   end
   
   def test_ghost_methods
     bib = BibTeX::Bibliography.open('test/bib/07_entry.bib', :debug => true)
     refute_nil(bib)
     assert_equal(BibTeX::Bibliography, bib.class)
-    assert_equal(['Poe, Edgar A.'], bib.data[0].author)
+    assert_equal('Poe, Edgar A.', bib.data[0].author)
     
-    expected = ['Poe, Edgar Allen']
+    expected = 'Poe, Edgar Allen'
     bib.data[0].author = expected
     
     assert_equal(expected, bib.data[0].author)

data/test/test_export.rb

@@ -1,7 +1,5 @@
-require File.expand_path('../../lib/bibtex.rb', __FILE__)
-require 'rubygems'
-require 'minitest/unit'
-require 'minitest/autorun'
+require 'helper.rb'
+
 require 'yaml'
 require 'json'
 

data/test/test_preamble.rb

@@ -1,24 +1,39 @@
-require File.expand_path('../../lib/bibtex.rb', __FILE__)
-require 'rubygems'
-require 'minitest/unit'
-require 'minitest/autorun'
+require 'helper.rb'
 
 class TestPreamble < MiniTest::Unit::TestCase
   
   def setup
+    @bib = BibTeX::Bibliography.open('test/bib/06_preamble.bib', :debug => true, :strict => false)
   end
 
   def teardown
   end
 
   def test_simple
+    refute_nil(@bib)
+    assert_equal(BibTeX::Bibliography, @bib.class)
+    assert_equal(4, @bib.data.length)
+    assert_equal([BibTeX::Preamble,BibTeX::String], @bib.data.map(&:class).uniq)
+    assert_equal('"This bibliography was created \\today"', @bib.data[0].content)
+    assert_equal('"Bib\\TeX"', @bib.data[1].content)
+    assert_equal('"Maintained by " # maintainer', @bib.data[3].content)
+  end
+  
+  def test_roundtrip
+    assert_equal(%q[@preamble{ "This bibliography was created \today" }], @bib.data[0].to_s)
+    assert_equal(%q[@preamble{ "Bib\TeX" }], @bib.data[1].to_s)
+    assert_equal(%q[@string{ maintainer = "Myself" }], @bib.data[2].to_s)
+    assert_equal(%q[@preamble{ "Maintained by " # maintainer }], @bib.data[3].to_s)
+  end
+  
+  def test_replacement
     bib = BibTeX::Bibliography.open('test/bib/06_preamble.bib', :debug => true, :strict => false)
     refute_nil(bib)
-    assert_equal(BibTeX::Bibliography, bib.class)
-    assert_equal(4, bib.data.length)
-    assert_equal([BibTeX::Preamble,BibTeX::String], bib.data.map(&:class).uniq)
-    assert_equal(["This bibliography was created \\today"], bib.data[0].value)
-    assert_equal(["Bib\\TeX"], bib.data[1].value)
-    assert_equal(["Maintained by ",:maintainer], bib.data[3].value)
+    assert_equal(%q[@preamble{ "Maintained by " # maintainer }], bib.data[3].to_s)
+    bib.replace_strings
+    assert_equal('"Maintained by " # "Myself"', bib.data[3].content)
+    assert_equal(%q[@preamble{ "Maintained by " # "Myself" }], bib.data[3].to_s)    
+    bib.join_strings
+    assert_equal(%q[@preamble{ "Maintained by Myself" }], bib.data[3].to_s)    
   end
 end

data/test/test_string.rb

@@ -1,7 +1,4 @@
-require File.expand_path('../../lib/bibtex.rb', __FILE__)
-require 'rubygems'
-require 'minitest/unit'
-require 'minitest/autorun'
+require 'helper.rb'
 
 class TestString < MiniTest::Unit::TestCase
   
@@ -17,9 +14,10 @@ class TestString < MiniTest::Unit::TestCase
     assert(bib.kind_of? BibTeX::Bibliography)
     refute(bib.empty?)
     assert_equal(bib.data.length,1)
-    assert(bib.data.first.kind_of?(BibTeX::String))
-    assert_equal(bib.data.first.key, :foo)
-    assert_equal(bib.data.first.value, ['bar'])
+    assert(bib.data.first.is_a?(BibTeX::String))
+    assert_equal(:foo, bib.data.first.key)
+    assert_equal('"bar"', bib.data.first.value)
+    assert_equal(["bar"], bib.strings[:foo])
   end
 
   def test_assignment
@@ -30,13 +28,13 @@ class TestString < MiniTest::Unit::TestCase
     assert_equal(bib.data.length,17)
     assert_equal(bib.data.map(&:class).uniq, [BibTeX::String]) 
     assert_equal(bib.data.map(&:key).uniq, [:foo]) 
-    (0..10).each { |i| assert_equal(bib.data[i].value, ['bar']) }
-    assert_equal(bib.data[11].value, ['\'bar\''])
-    assert_equal(bib.data[12].value, ['{"}bar{"}'])
-    assert_equal(bib.data[13].value, ['@bar@'])
-    assert_equal(bib.data[14].value, ['\'bar\''])
-    assert_equal(bib.data[15].value, ['{"}bar{"}'])
-    assert_equal(bib.data[16].value, ['{bar}'])
+    (0..10).each { |i| assert_equal( '"bar"', bib.data[i].value) }
+    assert_equal(bib.data[11].value, '"\'bar\'"')
+    assert_equal(bib.data[12].value, '"{"}bar{"}"')
+    assert_equal(bib.data[13].value, '"@bar@"')
+    assert_equal(bib.data[14].value, '"\'bar\'"')
+    assert_equal(bib.data[15].value, '"{"}bar{"}"')
+    assert_equal(bib.data[16].value, '"{bar}"')
   end
 
   def test_replacement
@@ -46,32 +44,54 @@ class TestString < MiniTest::Unit::TestCase
     refute(bib.empty?)
     assert_equal(7,bib.length)
     assert_equal([BibTeX::String,BibTeX::Preamble,BibTeX::Entry], bib.data.map(&:class).uniq) 
-    assert_equal(bib.strings[:foo], ['foo'])
-    assert_equal(bib.strings[:bar], ['bar'])
-    assert_equal(bib.strings[:foobar], [:foo,'bar'])
-    assert_equal(bib.strings[:foobarfoo], [:foobar,:foo])
-    assert_equal(bib.strings[:barfoobar], [:bar,'foo',:bar])
-    assert_equal(['foo',:foo,:foobarfoo,'bar'], bib.preamble[0].value)
-    assert_equal(['foo',:barfoobar], bib.entries['manual:1'][:title])
+    assert_equal(["foo"], bib.strings[:foo])
+    assert_equal(["bar"], bib.strings[:bar])
+    assert_equal([:foo, "bar"], bib.strings[:foobar])
+    assert_equal([:foobar, :foo], bib.strings[:foobarfoo])
+    assert_equal([:bar, "foo", :bar], bib.strings[:barfoobar])
+    assert_equal('"foo" # foo # foobarfoo # "bar"', bib.preamble[0].content)
+    assert_equal('"foo" # barfoobar', bib['manual:1'].title)
 
     bib.replace_strings({ :include => [BibTeX::Preamble]})
-    assert_equal(bib.strings[:foo], ['foo'])
-    assert_equal(bib.strings[:bar], ['bar'])
-    assert_equal(bib.strings[:foobar], [:foo,'bar'])
-    assert_equal(bib.strings[:foobarfoo], [:foobar,:foo])
-    assert_equal(bib.strings[:barfoobar], [:bar,'foo',:bar])
-    assert_equal(['foo','foo',:foobar,:foo,'bar'], bib.preamble[0].value)
-    assert_equal(['foo',:barfoobar], bib.entries['manual:1'][:title])
+    assert_equal(["foo"], bib.strings[:foo])
+    assert_equal(["bar"], bib.strings[:bar])
+    assert_equal([:foo, "bar"], bib.strings[:foobar])
+    assert_equal([:foobar, :foo], bib.strings[:foobarfoo])
+    assert_equal([:bar, "foo", :bar], bib.strings[:barfoobar])
+    assert_equal('"foo" # "foo" # foobar # foo # "bar"', bib.preamble[0].content)
+    assert_equal('"foo" # barfoobar', bib['manual:1'].title)
     
     bib.replace_strings({ :include => [BibTeX::String]})
-    assert_equal(bib.strings[:foobar], ['foo','bar'])
-    assert_equal(bib.strings[:foobarfoo], ['foo', 'bar','foo'])
-    assert_equal(bib.strings[:barfoobar], ['bar','foo','bar'])
-    assert_equal(['foo','foo',:foobar,:foo,'bar'], bib.preamble[0].value)
-    assert_equal(['foo',:barfoobar], bib.entries['manual:1'][:title])
+    assert_equal(['foo','bar'], bib.strings[:foobar])
+    assert_equal(['foo', 'bar','foo'], bib.strings[:foobarfoo])
+    assert_equal(['bar','foo','bar'], bib.strings[:barfoobar])
+    assert_equal('"foo" # "foo" # foobar # foo # "bar"', bib.preamble[0].content)
+    assert_equal('"foo" # barfoobar', bib['manual:1'].title)
 
     bib.replace_strings({ :include => [BibTeX::Preamble,BibTeX::Entry]})
-    assert_equal(['foo','foo','foo','bar','foo','bar'], bib.preamble[0].value)
-    assert_equal(['foo','bar','foo','bar'], bib.entries['manual:1'][:title])
+    assert_equal('"foo" # "foo" # "foo" # "bar" # "foo" # "bar"', bib.preamble[0].content)
+    assert_equal('"foo" # "bar" # "foo" # "bar"', bib['manual:1'].title)
+  end
+  
+  def test_roundtrip
+    bib = BibTeX::Bibliography.open('test/bib/04_string_replacement.bib', :debug => true)
+    refute_nil(bib)
+    assert_equal('@string{ foo = "foo" }', bib.data[0].to_s)
+    assert_equal('@string{ bar = "bar" }', bib.data[1].to_s)
+    assert_equal('@string{ foobar = foo # "bar" }', bib.data[2].to_s)
+    assert_equal('@string{ foobarfoo = foobar # foo }', bib.data[3].to_s)
+    assert_equal('@string{ barfoobar = bar # "foo" # bar }', bib.data[4].to_s)
+    bib.replace_strings
+    assert_equal('@string{ foo = "foo" }', bib.data[0].to_s)
+    assert_equal('@string{ bar = "bar" }', bib.data[1].to_s)
+    assert_equal('@string{ foobar = "foo" # "bar" }', bib.data[2].to_s)
+    assert_equal('@string{ foobarfoo = "foo" # "bar" # "foo" }', bib.data[3].to_s)
+    assert_equal('@string{ barfoobar = "bar" # "foo" # "bar" }', bib.data[4].to_s)
+    bib.join_strings
+    assert_equal('@string{ foo = "foo" }', bib.data[0].to_s)
+    assert_equal('@string{ bar = "bar" }', bib.data[1].to_s)
+    assert_equal('@string{ foobar = "foobar" }', bib.data[2].to_s)
+    assert_equal('@string{ foobarfoo = "foobarfoo" }', bib.data[3].to_s)
+    assert_equal('@string{ barfoobar = "barfoobar" }', bib.data[4].to_s)
   end
 end