bibtex-ruby 1.2.0 → 1.2.1

data/History.txt

@@ -1,3 +1,17 @@
+=== 1.2.1 / 2011-02-26
+
+* Fixed several MacRuby compliancy issues.
+* Fixed compatibility issues and BibTeX parsing of Name tokens (by lyro)
+
+=== 1.2.0 / 2011-02-12
+
+* Switched to using bundler.
+* Improved BibTeX::Entry constructor (supports hashes for intuitive assignments).
+* Added top-level methods BibTeX.parse, BibTeX.open, BibTeX.valid? and
+  BibTeX::Entry.parse.
+* Rewrote StringReplacement extensions to use monkey patching of Arrays.
+* See README.md or unit tests for updated code examples.
+
 === 1.1.2 / 2011-01-27
 
 * Added dynamic ghost methods to BibTeX::Entry for more convenient access

data/README.md

@@ -18,15 +18,15 @@ Quickstart
      => true
     > bib = BibTeX.open('./ruby.bib')
      => 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 Programmers Guide},
-      year  {2009}
+      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 Programmers Guide},
+      year = {2009}
     }
     > bib[:pickaxe].year
      => "2009"
@@ -282,7 +282,9 @@ These represent proper BibTeX objects (e.g., @book, @collection, etc.).
 Credits
 -------
 
-The BibTeX-Ruby package was written by [Sylvester Keil](http://sylvester.keil.or.at/).
+The BibTeX-Ruby package was written by [Sylvester Keil](http://sylvester.keil.or.at/),
+with contributions by [Frank Fischer](https://github.com/lyro).
+
 
 License
 -------

data/bibtex-ruby.gemspec

@@ -6,7 +6,7 @@ require 'bibtex/version'
 
 Gem::Specification.new do |s|
   s.name              = 'bibtex-ruby'
-  s.version           = BibTeX::Version::STRING
+  s.version           = BibTeX::Version::STRING.dup
   s.platform          = Gem::Platform::RUBY
   s.authors           = ['Sylvester Keil']
   s.email             = 'http://sylvester.keil.or.at'

data/lib/bibtex.rb

@@ -20,6 +20,9 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 
+require 'bibtex/version'
+require 'logger'
+
 # = BibTeX
 #
 # This module encompasses a parser for BibTeX files and
@@ -32,8 +35,6 @@ $:.unshift(File.dirname(__FILE__)) unless
 # License:: GNU GPL 3.0
 #
 module BibTeX
-  require 'bibtex/version'
-	require 'logger'
 
 	#
 	# An instance of the Ruby core class +Logger+.
@@ -43,16 +44,17 @@ module BibTeX
 	Log.level = ENV.has_key?('DEBUG') ? Logger::DEBUG : Logger::WARN
 	Log.datetime_format = "%Y-%m-%d %H:%M:%S"
 
-  # Load debugger
-  # require 'ruby-debug'
-  # Debugger.start
+  def self.log; BibTeX::Log end
+end
 
-  require 'bibtex/extensions'
-  require 'bibtex/elements'
-  require 'bibtex/entry'
-  require 'bibtex/error'
-  require 'bibtex/parser'
-  require 'bibtex/bibliography'
-  require 'bibtex/utilities'
+# Load debugger
+# require 'ruby-debug'
+# Debugger.start
 
-end
+require 'bibtex/extensions'
+require 'bibtex/elements'
+require 'bibtex/entry'
+require 'bibtex/error'
+require 'bibtex/parser'
+require 'bibtex/bibliography'
+require 'bibtex/utilities'

data/lib/bibtex/bibliography.rb

@@ -65,7 +65,9 @@ module BibTeX
     
     # Saves the bibliography to a file at the given path.
     def save_to(path)
-      File.write(path,to_s)
+      File.open(path, "w") do |f|
+        f.write to_s
+      end
     end
     
     # Add an object to the bibliography. Returns the bibliography.

data/lib/bibtex/elements.rb

@@ -22,7 +22,8 @@ module BibTeX
 	# The base class for BibTeX objects.
 	#
 	class Element
-
+    include Comparable
+    
 		attr_reader :bibliography
 		
 		# Returns an array of BibTeX elements.
@@ -76,6 +77,11 @@ module BibTeX
 			@bibliography = nil
 			self
 		end
+		
+		def <=>(other)
+		  (type_comparison = self.class.name <=> other.class.name) == 0 ? self.to_s <=> other.to_s : type_comparison
+		end
+		
 	end
 
  

data/lib/bibtex/entry.rb

@@ -51,6 +51,8 @@ module BibTeX
 		  self.key = hash.delete(:key) if hash.has_key?(:key)
 						
 			hash.each { |k, v| add(k.to_sym, v) }
+			
+			yield self if block_given?
 		end
 
 		# Sets the key of the entry
@@ -61,18 +63,18 @@ module BibTeX
 
 		# Sets the type of the entry.
 		def type=(type)
-			raise(ArgumentError, "BibTeX::Entry type must be of type Symbol; was: #{type.class.name}.") unless type.is_a?(Symbol)
-			@type = type
+			raise(ArgumentError, "BibTeX::Entry type must be convertible to Symbol; was: #{type.class.name}.") unless type.respond_to?(:to_sym)
+			@type = type.to_sym
 		end
 		
 		def method_missing(name, *args)
 		  return self[name] if @fields.has_key?(name)
-		  return self.send(:add, name.to_s.chop.to_sym, args[0]) if name.match(/=$/)		  
+		  return self.send(:add, name.to_s.chop.to_sym, args[0]) if name.to_s.match(/=$/)		  
 		  super
 		end
 		
 		def respond_to?(method)
-		  @fields.has_key?(method.to_sym) || method.match(/=$/) || super
+		  @fields.has_key?(method.to_sym) || method.to_s.match(/=$/) || super
 		end
 		
 		# Returns the value of the field with the given name.
@@ -168,5 +170,10 @@ module BibTeX
       end
       xml
 		end
+		
+		def <=>(other)
+		  self.type != other.type ? self.type <=> other.type : self.key != other.key ? self.key <=> other.key : self.to_s <=> other.to_s
+		end
+		
 	end
 end

data/lib/bibtex/extensions.rb

@@ -24,8 +24,8 @@ module BibTeX
 	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
+		  raise(ArgumentError, "StringReplacement should only be injected into instances of Array, not #{obj.class}.") unless obj.is_a?(::Array)
+		  class << obj; include ::BibTeX::Extensions::StringReplacement end
 		  obj
 		end
 		
@@ -36,16 +36,16 @@ module BibTeX
         
         options[:quotes] ||= [nil,nil]
         
-        if self.length == 1 && !self[0].is_a?(Symbol)
+        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(' # ')
+          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)
+        Extensions.string_replacement(self.map { |s| s.is_a?(::Symbol) && hash.has_key?(s) ? hash[s] : s }.flatten)
       end
       
       # Joins consecutive strings separated by '#'.

data/lib/bibtex/lexer.rb

@@ -178,7 +178,7 @@ module BibTeX
 				push [:SHARP,'#']
 			when self.src.scan(/\d+/o)
 				push [:NUMBER,self.src.matched]
-			when self.src.scan(/[a-z\d:_!$\.%&*-]+/io)
+			when self.src.scan(/[a-z\d\/:_!$\.%&*-]+/io)
 				push [:NAME,self.src.matched]
 			when self.src.scan(/"/o)
 				self.mode = :literal

data/lib/bibtex/version.rb

@@ -18,6 +18,6 @@
 
 module BibTeX
   module Version
-    STRING = '1.2.0'
+    STRING = '1.2.1'.freeze
   end
 end

data/test/test_entry.rb

@@ -42,4 +42,57 @@ class TestEntry < MiniTest::Unit::TestCase
     assert_equal(expected, bib.data[0].author)
   end
   
+  def test_creation_simple
+    expected = "@book{raven,\n  author = {Poe, Edgar A.},\n  title = {The Raven}\n}\n"
+    
+    entry = BibTeX::Entry.new
+    entry.type = :book
+    entry.key = 'raven'
+    entry.author = 'Poe, Edgar A.'
+    entry.title = 'The Raven'
+    
+    assert_equal(expected, entry.to_s)
+  end
+
+  def test_creation_from_hash
+    expected = "@book{raven,\n  author = {Poe, Edgar A.},\n  title = {The Raven}\n}\n"
+    
+    entry = BibTeX::Entry.new({
+      :type => 'book',
+      :key => 'raven',
+      :author => 'Poe, Edgar A.',
+      :title => 'The Raven'
+    })
+    
+    assert_equal(expected, entry.to_s)
+  end
+
+  def test_creation_from_block
+    expected = "@book{raven,\n  author = {Poe, Edgar A.},\n  title = {The Raven}\n}\n"
+    
+    entry = BibTeX::Entry.new do |e|
+      e.type = :book
+      e.key = 'raven'
+      e.author = 'Poe, Edgar A.'
+      e.title = 'The Raven'
+    end
+    
+    assert_equal(expected, entry.to_s)
+  end
+  
+  def test_sorting
+    entries = []
+    entries << BibTeX::Entry.new({ :type => 'book', :key => 'raven3', :author => 'Poe, Edgar A.', :title => 'The Raven'})
+    entries << BibTeX::Entry.new({ :type => 'book', :key => 'raven2', :author => 'Poe, Edgar A.', :title => 'The Raven'})
+    entries << BibTeX::Entry.new({ :type => 'book', :key => 'raven1', :author => 'Poe, Edgar A.', :title => 'The Raven'})
+    entries << BibTeX::Entry.new({ :type => 'book', :key => 'raven1', :author => 'Poe, Edgar A.', :title => 'The Aven'})
+    
+    entries.sort!
+    
+    assert_equal(%w{ raven1 raven1 raven2 raven3 }, entries.map(&:key))
+    assert_equal([ 'The Aven', 'The Raven' ], entries.map(&:title)[0,2])
+
+  end
+  
+  
 end

metadata

@@ -2,7 +2,7 @@
 name: bibtex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors: 
 - Sylvester Keil
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-12 00:00:00 +01:00
+date: 2011-04-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency