bibtex-ruby 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,11 @@
+=== 1.1.0 / 2011-01-24
+
+* Improved YAML export.
+
+=== 1.0.1 / 2011-01-17
+
+* Removed StringScanner extension.
+
 === 1.0.0 / 2011-01-17
 
 * Initial Release. See README.rdoc for further details.

data/Manifest

@@ -4,10 +4,10 @@ Manifest
 README.rdoc
 Rakefile
 examples/bib2html.rb
+examples/bib2yaml.rb
 examples/markdown.bib
 lib/bibtex.rb
 lib/bibtex/bibliography.rb
-lib/bibtex/bibtex.y
 lib/bibtex/elements.rb
 lib/bibtex/entry.rb
 lib/bibtex/error.rb
@@ -15,7 +15,6 @@ lib/bibtex/lexer.rb
 lib/bibtex/parser.output
 lib/bibtex/parser.rb
 lib/bibtex/string_replacement.rb
-lib/extensions/core.rb
 test/bib/00_empty.bib
 test/bib/01_no_bibtex.bib
 test/bib/02_string.bib
@@ -30,5 +29,6 @@ test/bib/10_bibdesk.bib
 test/test_bibtex.rb
 test/test_comment.rb
 test/test_entry.rb
+test/test_export.rb
 test/test_preamble.rb
 test/test_string.rb

data/README.rdoc

@@ -11,6 +11,7 @@ objects as `meta comments' which may be included in post-processing.
 
 * require 'bibtex'
 * bib = BibTeX::Bibliography.open('file.bib')
+* bib.to_yaml
 
 
 == Installation
@@ -35,11 +36,12 @@ Or, alternatively, fork the (project on github)[http://github.com/inukshuk/bibte
 
 * The parser generator {+racc+}[http://i.loveruby.net/en/projects/racc/] is required to generate parser.
 * The +minitest+ gem is required to run the tests in older Ruby versions (prior to 1.9).
+* The +json+ gem is required on older ruby versions for JSON export.
 
 
 == Usage
 
-Look at the `examples' directory for a simple BibTeX to HTML converter.
+Look at the `examples' directory for a simple BibTeX to YAML and BibTeX to HTML converter.
 
 
 == The Parser

data/Rakefile

@@ -7,13 +7,14 @@ require 'rake/rdoctask'
 require 'rake/testtask'
 require 'echoe'
 
-Echoe.new('bibtex-ruby', '1.0.0') do |p|
-  p.description    = "A BibTeX parser written in Ruby"
+Echoe.new('bibtex-ruby', '1.1.0') do |p|
+  p.summary        = "A BibTeX parser written in Ruby"
+  p.description    = "A (fairly complete) BibTeX parser written in Ruby. Supports regular BibTeX entries, @comments, string replacement via @string, and simple export formats (e.g. YAML)."
   p.url            = "http://github.com/inukshuk/bibtex-ruby"
   p.author         = "Sylvester Keil"
   p.email          = "http://sylvester.keil.or.at"
   p.ignore_pattern = []
-  p.development_dependencies = [['racc', '>=1.4.6']]
+  p.development_dependencies = [['racc', '>=1.4.6'], ['minitest']]
   p.need_tgz       = true
   p.rdoc_options   = ["--line-numbers", "--inline-source", "--title", "BibTeX-Ruby Documentation", "--main", "README.rdoc"]
 end

data/bibtex-ruby.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bibtex-ruby}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sylvester Keil"]
   s.cert_chain = ["/Users/sylvester/.gem/keys/gem-public_cert.pem"]
-  s.date = %q{2011-01-18}
-  s.description = %q{A (fairly complete) BibTeX parser written in Ruby}
+  s.date = %q{2011-01-24}
+  s.description = %q{A (fairly complete) BibTeX parser written in Ruby. Supports regular BibTeX entries, @comments, string replacement via @string, and simple export formats (e.g. YAML).}
   s.email = %q{http://sylvester.keil.or.at}
-  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/bibtex.rb", "lib/bibtex/bibliography.rb", "lib/bibtex/bibtex.y", "lib/bibtex/elements.rb", "lib/bibtex/entry.rb", "lib/bibtex/error.rb", "lib/bibtex/lexer.rb", "lib/bibtex/parser.output", "lib/bibtex/parser.rb", "lib/bibtex/string_replacement.rb", "lib/extensions/core.rb"]
-  s.files = ["History.txt", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "examples/bib2html.rb", "examples/markdown.bib", "lib/bibtex.rb", "lib/bibtex/bibliography.rb", "lib/bibtex/bibtex.y", "lib/bibtex/elements.rb", "lib/bibtex/entry.rb", "lib/bibtex/error.rb", "lib/bibtex/lexer.rb", "lib/bibtex/parser.output", "lib/bibtex/parser.rb", "lib/bibtex/string_replacement.rb", "lib/extensions/core.rb", "test/bib/00_empty.bib", "test/bib/01_no_bibtex.bib", "test/bib/02_string.bib", "test/bib/03_string.bib", "test/bib/04_string_replacement.bib", "test/bib/05_comment.bib", "test/bib/06_preamble.bib", "test/bib/07_entry.bib", "test/bib/08_decoret.bib", "test/bib/09_errors.bib", "test/bib/10_bibdesk.bib", "test/test_bibtex.rb", "test/test_comment.rb", "test/test_entry.rb", "test/test_preamble.rb", "test/test_string.rb", "bibtex-ruby.gemspec"]
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/bibtex.rb", "lib/bibtex/bibliography.rb", "lib/bibtex/elements.rb", "lib/bibtex/entry.rb", "lib/bibtex/error.rb", "lib/bibtex/lexer.rb", "lib/bibtex/parser.output", "lib/bibtex/parser.rb", "lib/bibtex/string_replacement.rb", "lib/extensions/core.rb"]
+  s.files = ["History.txt", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "bibtex-ruby.gemspec", "examples/bib2html.rb", "examples/bib2yaml.rb", "examples/markdown.bib", "lib/bibtex.rb", "lib/bibtex/bibliography.rb", "lib/bibtex/elements.rb", "lib/bibtex/entry.rb", "lib/bibtex/error.rb", "lib/bibtex/lexer.rb", "lib/bibtex/parser.output", "lib/bibtex/parser.rb", "lib/bibtex/string_replacement.rb", "lib/extensions/core.rb", "test/bib/00_empty.bib", "test/bib/01_no_bibtex.bib", "test/bib/02_string.bib", "test/bib/03_string.bib", "test/bib/04_string_replacement.bib", "test/bib/05_comment.bib", "test/bib/06_preamble.bib", "test/bib/07_entry.bib", "test/bib/08_decoret.bib", "test/bib/09_errors.bib", "test/bib/10_bibdesk.bib", "test/test_bibtex.rb", "test/test_comment.rb", "test/test_entry.rb", "test/test_export.rb", "test/test_preamble.rb", "test/test_string.rb"]
   s.homepage = %q{http://github.com/inukshuk/bibtex-ruby}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "BibTeX-Ruby Documentation", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.signing_key = %q{/Users/sylvester/.gem/keys/gem-private_key.pem}
   s.summary = %q{A BibTeX parser written in Ruby}
-  s.test_files = ["test/test_bibtex.rb", "test/test_comment.rb", "test/test_entry.rb", "test/test_preamble.rb", "test/test_string.rb"]
+  s.test_files = ["test/test_bibtex.rb", "test/test_comment.rb", "test/test_entry.rb", "test/test_export.rb", "test/test_preamble.rb", "test/test_string.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -27,10 +27,13 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<racc>, [">= 1.4.6"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
     else
       s.add_dependency(%q<racc>, [">= 1.4.6"])
+      s.add_dependency(%q<minitest>, [">= 0"])
     end
   else
     s.add_dependency(%q<racc>, [">= 1.4.6"])
+    s.add_dependency(%q<minitest>, [">= 0"])
   end
 end

data/examples/bib2yaml.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bibtex'
+require 'yaml'
+
+if ARGV.length < 1
+  puts "Usage: #{$0} <bib> [<yml>]" 
+else
+  out = ARGV.length == 2 ? File.open(ARGV[1], 'w') : STDOUT
+  out.puts BibTeX::Bibliography.open(ARGV[0]).to_yaml
+end

data/lib/bibtex.rb

@@ -15,7 +15,11 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.	If not, see <http://www.gnu.org/licenses/>.
 #++
-#
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
 # = BibTeX
 #
 # This module encompasses a parser for BibTeX files and
@@ -31,7 +35,7 @@ module BibTeX
 	require 'logger'
 
 	# The current library version.
-	VERSION = '1.0.0'
+	VERSION = '1.1.0'
 
 	#
 	# An instance of the Ruby core class +Logger+.

data/lib/bibtex/bibliography.rb

@@ -149,10 +149,11 @@ module BibTeX
       @data.map(&:to_s).join
     end
     
+    # Returns a YAML representation of the bibliography. Only BibTeX entries are exported.
     def to_yaml
-      @data.map(&:to_yaml).join
+      @entries.values.map(&:to_hash).to_yaml
     end
-    
+        
     def to_xml
       xml = REXML::Document.new
       xml << REXML::XMLDecl.new('1.0','UTF-8')

data/lib/bibtex/elements.rb

@@ -16,7 +16,6 @@
 # along with this program.	If not, see <http://www.gnu.org/licenses/>.
 #++
 
-require 'json'
 require 'rexml/document'
 require 'yaml'
 
@@ -52,6 +51,7 @@ module BibTeX
 	  end
 	  
 	  def to_json
+	    require 'json'
 	    self.to_hash.to_json
 	  end
 	  

data/lib/bibtex/entry.rb

@@ -137,7 +137,7 @@ module BibTeX
 		end
 		
 		def to_hash
-		  { @type.to_s => @fields.keys.map { |k| { k.to_s => StringReplacement.to_s(@fields[k], :delimiter => ['{','}']) } }.inject({ 'key' => @key }) { |sum,n| sum.merge(n) } }.to_yaml
+		  @fields.keys.map { |k| { k.to_s => StringReplacement.to_s(@fields[k], :delimiter => ['{','}']) } }.inject({ 'key' => @key, 'type' => @type.to_s }) { |sum,n| sum.merge(n) }
 		end
 		
 		def to_xml

data/test/test_bibtex.rb

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

data/test/test_comment.rb

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

data/test/test_entry.rb

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

data/test/test_export.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../../lib/bibtex.rb', __FILE__)
+require 'rubygems'
+require 'minitest/unit'
+require 'minitest/autorun'
+require 'yaml'
+
+class TestString < MiniTest::Unit::TestCase
+  
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_yaml
+    bib = BibTeX::Bibliography.open('test/bib/10_bibdesk.bib', :debug => true)
+    yaml = YAML.load(bib.to_yaml)
+    refute_nil(yaml)
+    assert_equal(3, yaml.length)
+    assert_equal(['dragon', 'pickaxe', 'rails'], yaml.map { |y| y['key'] }.sort)
+    assert_equal('{The Facets of Ruby}', yaml[0]['series'])
+  end
+end

data/test/test_preamble.rb

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

data/test/test_string.rb

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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sylvester Keil
@@ -35,7 +35,7 @@ cert_chain:
   J/FeJ8pSGMcNlQbhGpGIX+ARJK5ArG0Aq4214ttgefkdQJvw5r9hG3J4AgM=
   -----END CERTIFICATE-----
 
-date: 2011-01-18 00:00:00 +01:00
+date: 2011-01-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,7 +53,20 @@ dependencies:
         version: 1.4.6
   type: :development
   version_requirements: *id001
-description: A (fairly complete) BibTeX parser written in Ruby
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A (fairly complete) BibTeX parser written in Ruby. Supports regular BibTeX entries, @comments, string replacement via @string, and simple export formats (e.g. YAML).
 email: http://sylvester.keil.or.at
 executables: []
 
@@ -64,7 +77,6 @@ extra_rdoc_files:
 - README.rdoc
 - lib/bibtex.rb
 - lib/bibtex/bibliography.rb
-- lib/bibtex/bibtex.y
 - lib/bibtex/elements.rb
 - lib/bibtex/entry.rb
 - lib/bibtex/error.rb
@@ -79,11 +91,12 @@ files:
 - Manifest
 - README.rdoc
 - Rakefile
+- bibtex-ruby.gemspec
 - examples/bib2html.rb
+- examples/bib2yaml.rb
 - examples/markdown.bib
 - lib/bibtex.rb
 - lib/bibtex/bibliography.rb
-- lib/bibtex/bibtex.y
 - lib/bibtex/elements.rb
 - lib/bibtex/entry.rb
 - lib/bibtex/error.rb
@@ -106,9 +119,9 @@ files:
 - test/test_bibtex.rb
 - test/test_comment.rb
 - test/test_entry.rb
+- test/test_export.rb
 - test/test_preamble.rb
 - test/test_string.rb
-- bibtex-ruby.gemspec
 has_rdoc: true
 homepage: http://github.com/inukshuk/bibtex-ruby
 licenses: []
@@ -151,5 +164,6 @@ test_files:
 - test/test_bibtex.rb
 - test/test_comment.rb
 - test/test_entry.rb
+- test/test_export.rb
 - test/test_preamble.rb
 - test/test_string.rb

data/lib/bibtex/bibtex.y

@@ -1,129 +0,0 @@
-#--
-# 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/>.
-#++
-#
-# A BibTeX grammar for the parser generator +racc+
-#
-
-# -*- racc -*-
-
-class BibTeX::Parser
-
-token AT COMMA COMMENT CONTENT ERROR EQ LBRACE META_COMMENT
-      NAME NUMBER PREAMBLE RBRACE SHARP STRING STRING_LITERAL
-
-expect 0
-
-rule
-
-  bibliography : /* empty */                       { result = Bibliography.new }
-               | objects                           { result = val[0] }
-
-  objects : object                                 { result = Bibliography.new << val[0] }
-          | objects object                         { result << val[1] }
-
-  object : AT at_object                            { result = val[1] }
-         | META_COMMENT                            { result = BibTeX::MetaComment.new(val[0]) }
-         | ERROR                                   { result = BibTeX::Error.new(val[0]) }
-
-  at_object : comment                              { result = val[0] }
-            | string                               { result = val[0] }
-            | preamble                             { result = val[0] }
-            | entry                                { result = val[0] }
-
-  comment : COMMENT LBRACE content RBRACE          { result = BibTeX::Comment.new(val[2]) }
-  
-  content : /* empty */                            { result = '' }
-          | CONTENT                                { result = val[0] }
-  
-  preamble : PREAMBLE LBRACE string_value RBRACE   { result = BibTeX::Preamble.new(val[2]) }
-
-  string : STRING LBRACE string_assignment RBRACE  { result = BibTeX::String.new(val[2][0],val[2][1]); }
-
-  string_assignment : NAME EQ string_value         { result = [val[0].downcase.to_sym, val[2]] }
-
-  string_value : string_literal                    { result = [val[0]] }
-               | string_value SHARP string_literal { result << val[2] }
-
-  string_literal : NAME                            { result = val[0].downcase.to_sym }
-                 | STRING_LITERAL                  { result = val[0] }
-
-  entry : entry_head assignments RBRACE            { result = val[0] << val[1] }
-        | entry_head assignments COMMA RBRACE      { result = val[0] << val[1] }
-        | entry_head RBRACE                        { result = val[0] }
-
-  entry_head : NAME LBRACE key COMMA               { result = BibTeX::Entry.new(val[0].downcase.to_sym,val[2]) }
-
-  key : NAME                                       { result = val[0] }
-      | NUMBER                                     { result = val[0] }
-
-  assignments : assignment                         { result = val[0] }
-              | assignments COMMA assignment       { result.merge!(val[2]) }
-
-  assignment : NAME EQ value                       { result = { val[0].downcase.to_sym => val[2] } }
-
-  value : string_value                             { result = val[0] }
-        | NUMBER                                   { result = val[0] }
-        | LBRACE content RBRACE                    { result = val[1] }
-
-end
-
----- header
-require 'bibtex/lexer'
-
----- inner
-
-  attr_reader :lexer
-  
-  def initialize(options={})
-    @options = options
-    @options[:include] ||= [:errors]
-    @lexer = Lexer.new(options)
-  end
-
-  def parse(input)
-    @yydebug = self.debug?
-    
-    self.lexer.src = input
-    self.lexer.analyse
-    
-    do_parse
-  end
-  
-  def next_token
-    token = self.lexer.next_token
-    if token[0] == :ERROR
-      self.include_errors? ? token : next_token
-    else
-      [token[0],token[1][0]]
-    end
-  end
-  
-  def debug?
-    @options[:debug] == true || ENV['DEBUG'] == true
-  end
-  
-  def include_errors?
-    @options[:include].include?(:errors)
-  end
-  
-  def on_error(tid, val, vstack)
-    #raise(ParseError, "Failed to parse BibTeX on value %s (%s) %s" % [val.inspect, token_to_str(tid) || '?', vstack.inspect])
-    Log.error("Failed to parse BibTeX on value %s (%s) %s" % [val.inspect, token_to_str(tid) || '?', vstack.inspect])
-  end
-
-# -*- racc -*-