bibtex-ruby 1.1.0 → 1.1.1

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.1.1 / 2011-01-25
+
+* Improved JSON and XML export.
+* Added more examples to README.
+
 === 1.1.0 / 2011-01-24
 
 * Improved YAML export.
@@ -8,4 +13,4 @@
 
 === 1.0.0 / 2011-01-17
 
-* Initial Release. See README.rdoc for further details.
+* Initial Release. See README.md for further details.

data/Manifest

@@ -1,13 +1,16 @@
 History.txt
 LICENSE
 Manifest
-README.rdoc
+README.md
 Rakefile
+examples
 examples/bib2html.rb
 examples/bib2yaml.rb
 examples/markdown.bib
-lib/bibtex.rb
+lib
+lib/bibtex
 lib/bibtex/bibliography.rb
+lib/bibtex/bibtex.y
 lib/bibtex/elements.rb
 lib/bibtex/entry.rb
 lib/bibtex/error.rb
@@ -15,6 +18,10 @@ lib/bibtex/lexer.rb
 lib/bibtex/parser.output
 lib/bibtex/parser.rb
 lib/bibtex/string_replacement.rb
+lib/bibtex/version.rb
+lib/bibtex.rb
+test
+test/bib
 test/bib/00_empty.bib
 test/bib/01_no_bibtex.bib
 test/bib/02_string.bib
@@ -31,4 +38,4 @@ test/test_comment.rb
 test/test_entry.rb
 test/test_export.rb
 test/test_preamble.rb
-test/test_string.rb
+test/test_string.rb

data/README.md

@@ -0,0 +1,223 @@
+BibTeX-Ruby
+===========
+
+The BibTeX-Ruby package contains a parser for BibTeX
+bibliography files and a class structure to manage BibTeX objects in
+Ruby. It is designed to support all BibTeX objects (including @comment,
+string-replacements via @string, as well as string concatenation using '#')
+and handles all content outside of BibTeX objects as 'meta comments' which may
+be included in post-processing.
+
+
+Quickstart
+----------
+
+		$ irb
+		> require 'bibtex'
+		 => true
+		> bib = BibTeX::Bibliography.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}
+		}
+		> bib[:pickaxe][:author]
+		 => ["Thomas, Dave, and Fowler, Chad, and Hunt, Andy"]
+
+
+Installation
+------------
+
+If you just want to use it:
+
+		$ [sudo] gem install bibtex-ruby
+
+If you want to work with the sources:
+
+		$ [sudo] gem install racc
+		$ git clone http://github.com/inukshuk/bibtex-ruby.git
+		$ cd bibtex-ruby
+		$ rake racc
+		$ rake rdoc
+		$ rake test
+
+Or, alternatively, fork the [project on github](http://github.com/inukshuk/bibtex-ruby.git).
+
+
+Requirements
+------------
+
+* 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
+-----
+
+It is very easy to use BibTeX-Ruby. You can use the class method `BibTeX::Bibliography.open`
+to open a '.bib' file. Normally, BibTeX-Ruby will discard all content outside of
+regular BibTeX elements; however, if you wish to include everything, simply add
+`:include => [:meta_comments]` to your invocation of `BibTeX::Bibliography.open`.
+
+Once BibTeX-Ruby has parsed your '.bib' file, you can easily access individual entries.
+For example, if your bibliography object `bib` contained the following entry:
+
+		@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}
+		}
+		
+You could easily access it, using the entry's key, 'pickaxe', like so: `bib[:pickaxe]`;
+you also have easy access to individual fields, for example: `bib[:pickaxe](:author)`.
+
+If your bibliography contains BibTeX @string objects, you can let BibTeX-Ruby
+replace the strings for you. You have access to a bibliography's strings via
+`BibTeX::Bibliography#strings` and you can replace the strings of an entry using
+the `BibTeX::Entry#replace!` method. Thus, to replace all strings defined in your
+bibliography object `bib` your could use this code:
+
+		bib.entries.each do |entry|
+			entry.replace!(bib.strings)
+		end
+
+Furthermore, BibTeX-Ruby allows you to export your bibliography for processing
+by other tools. Currently supported formats include YAML, JSON, and XML.
+Of course, you can also export your bibliography back to BibTeX; if you include
+`:meta_comments', your export should be identical to the original '.bib' file,
+except for whitespace, blank lines and letter case (BibTeX-Ruby will downcase
+all keys).
+
+In order to export your bibliography use `#to_s`, `#to_yaml`, `#to_json`, or
+`#to_xml`, respectively.
+
+Look at the 'examples' directory for a simple BibTeX to YAML and BibTeX to HTML converter.
+
+
+The Parser
+----------
+
+The BibTeX-Ruby parser is generated using the wonderful
+[racc](http://i.loveruby.net/en/projects/racc/) parser generator.
+
+
+The BibTeX Format
+_________________
+
+At first glance, the BibTeX file format seems very clear and simple;
+however, there are a number of peculiarities which warrant some
+explanation. The best place to start reading is probably at [your closest
+ctan server](http://www.ctan.org/get/biblio/bibtex/) where
+the original `bibtex` from 1988 still lives. Additionally, Xavier Decoret
+has written
+[a great summary](http://artis.imag.fr/~Xavier.Decoret/resources/xdkbibtex/bibtex_summary.html)
+of the format; another invaluable source of information is [Nicolas Markey's
+website](http://www.lsv.ens-cachan.fr/~markey/bibla.php). Unfortunately,
+even after consulting these documents, a number of issues remain.
+Therefore, it is the purpose of this section to deliver the rationale
+that went into some of the design decision in BibTeX-Ruby.
+
+A BibTeX bibliography is typically stored in a file with the file
+extension '.bib'. This file may contain any number of BibTeX objects;
+everything that is not a BibTeX object is assumed to be a comment and
+ignored.
+
+The individual objects are discussed in further detail below. First, however, a
+number of general remarks:
+
+* BibTeX-Ruby begins in comment-mode, treating all text it encounters as comments.
+  Normally these comments are ignored; however, if you wish the parser to include
+  them, you can do so by adding the symbol `:meta_comments`` to the `:include`` array
+  in the parser's options.
+* Note that string literals in BibTeX are either contained in quotes or braces;
+  nested quotes in a quoted literal are not escaped with a usual backslash but
+  must be placed inside braces. Nested braces must be balanced in literals, regardless
+  of whether they are surrounded by quotes or braces.
+* Quoted strings and string constants (which are defined by @string objects) can be
+  concatted by the '#' symbol. String literals in braces can not be concatted in
+  this way.
+* The '@' symbol may only occur in quoted string literals (not in braced out literals)
+  in the original BibTeX; note, however, that this is not true for BibTeX-Ruby (i.e.,
+  it will parse any string containing an '@').
+
+### @comment
+
+
+The purpose of the @comment object is not entirely clear, because everything
+outside of an object is treated as a comment anyway. Nicolas Markay argues that
+a @comment makes it possible to quickly comment out a number of consecutive
+objects; however, as Xavier Decoret points out that this does not work with the
+original `bibtex' program (following a @comment, it simply ignores everything
+until the end of the line). Indeed, on page 13 of [the original
+documentation](http://www.ctan.org/get/biblio/bibtex/contrib/doc/btxdoc.pdf),
+Oren Patashnik explains that @comment objects are not really necessary; they
+exist only for _Scribe_ system compatibility.
+
+Because they would be useless otherwise, BibTeX-Ruby treats @comment objects
+as Nicolas Markay describes them: thus, everything inside a @comment is treated
+as a comment and is ignored -- everything,
+that is, until the object is closed. For this reason, BibTeX-Ruby assumes that
+braces inside a @comment are balanced! Obviously, BibTeX-Ruby differs from
+`bibtex` in that respect; though, the gain is, that it is now possible to
+comment out a sequence of entries, without removing their respective '@' symbols.
+
+### @string
+
+The @string object defines a single string constant (for multiple constant
+assignments, it is necessary to define separate @string objects). These
+constants can be used within string assignments in other @string or @preamble
+objects, as well as in regular BibTeX entries. For example, this is a valid constant
+definition and usage:
+
+		@string{ generator = "BibTeX-Ruby"}
+		@preamble{ "This bibliography was generated by " # generator }
+
+
+### @preamble
+
+Typically, the purpose of @preamble objects is to define LaTeX statements, which
+will be put into the '.bbl' file by `bibtex`. A @preamble object may contain
+a single string literal, a single string constant (defined by a @string object), or
+a concatenation of literals and constants.
+
+### Entries
+
+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/).
+
+License
+-------
+
+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/>.

data/Rakefile

@@ -3,26 +3,65 @@
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
-require 'rake/rdoctask'
 require 'rake/testtask'
-require 'echoe'
-
-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'], ['minitest']]
-  p.need_tgz       = true
-  p.rdoc_options   = ["--line-numbers", "--inline-source", "--title", "BibTeX-Ruby Documentation", "--main", "README.rdoc"]
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+require './lib/bibtex/version.rb'
+
+
+spec = Gem::Specification.new do |s|
+  s.platform          = Gem::Platform::RUBY
+  s.name              = 'bibtex-ruby'
+  s.rubyforge_project = s.name
+  s.version           = BibTeX::Version::STRING
+  s.summary           = "A BibTeX parser written in Ruby"
+  s.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)."
+  s.homepage          = 'http://github.com/inukshuk/bibtex-ruby'
+  s.authors           = ["Sylvester Keil"]
+  s.email             = 'http://sylvester.keil.or.at'
+  s.cert_chain        = ["/Users/sylvester/.gem/keys/gem-public_cert.pem"]
+  s.signing_key       = '/Users/sylvester/.gem/keys/gem-private_key.pem'
+  s.has_rdoc          = true
+  s.rdoc_options      = ["--line-numbers", "--inline-source", "--title", "BibTeX-Ruby Documentation", "--main", "README.rdoc"]
+  s.extra_rdoc_files  = ["README.md"]
+  s.files             = File.open('Manifest').readlines.map(&:chomp)
+  s.test_files        = FileList['test/test*.rb']
+  s.require_paths     = ["lib"]
+  s.date              = Time.now
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency('racc', [">= 1.4.6"])
+      s.add_development_dependency('minitest', [">= 2.0.2"])
+      s.add_development_dependency('json', [">= 1.5.0"])
+    else
+      s.add_dependency('racc', [">= 1.4.6"])
+      s.add_dependency('minitest', [">= 2.0.2"])
+      s.add_dependency('json', [">= 1.5.0"])
+    end
+  else
+    s.add_dependency('racc', [">= 1.4.6"])
+    s.add_dependency('minitest', [">= 2.0.2"])
+    s.add_dependency('json', [">= 1.5.0"])
+  end
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+  pkg.package_dir = 'build'
 end
 
 Rake::RDocTask.new(:rdoc_task) do |rd|
-  rd.main = 'README.rdoc'
+  rd.main = 'README.md'
   rd.title = "BibTeX-Ruby Documentation"
-  rd.rdoc_files.include('README.rdoc',"lib/**/*.rb")
+  rd.rdoc_files.include('README.md',"lib/**/*.rb")
   rd.rdoc_dir = "doc/html"
   rd.options << '--webcvs=http://github.com/inukshuk/bibtex-ruby/tree/master/'
 end
@@ -43,13 +82,23 @@ task :rdoc => ['clean','racc','rdoc_task']
 
 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'
 end
 
+desc 'Updates the Manifest file'
+task :manifest => ['clean', 'racc'] do
+  m = File.open('Manifest', 'w')
+  m.print FileList['**/*'].join("\n")
+  m.close
+end
+
+
 CLEAN.include('lib/bibtex/parser.rb')
 CLEAN.include('lib/bibtex/parser.output')
 CLEAN.include('doc/html')
+CLEAN.include('build')
 
 
 # vim: syntax=ruby

data/lib/bibtex.rb

@@ -32,11 +32,9 @@ $:.unshift(File.dirname(__FILE__)) unless
 # License:: GNU GPL 3.0
 #
 module BibTeX
+  require 'bibtex/version'
 	require 'logger'
 
-	# The current library version.
-	VERSION = '1.1.0'
-
 	#
 	# An instance of the Ruby core class +Logger+.
 	# Used for logging by BibTeX-Ruby.

data/lib/bibtex/bibliography.rb

@@ -153,12 +153,18 @@ module BibTeX
     def to_yaml
       @entries.values.map(&:to_hash).to_yaml
     end
-        
+    
+    # Returns a JSON representation of the bibliography. Only BibTeX entries are exported.
+    def to_json
+      @entries.values.map(&:to_hash).to_json
+    end
+    
+    # Returns an XML representation of the bibliography. Only BibTeX entries are exported.
     def to_xml
       xml = REXML::Document.new
       xml << REXML::XMLDecl.new('1.0','UTF-8')
       root = REXML::Element.new('bibliography')
-      @data.each { |e| root.add_element(e.to_xml) }
+      @entries.values.each { |e| root.add_element(e.to_xml) }
       xml << root
       xml
     end

data/lib/bibtex/bibtex.y

@@ -0,0 +1,129 @@
+#--
+# 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 -*-

data/lib/{extensions/core.rb → bibtex/version.rb}

@@ -1,5 +1,6 @@
+#--
 # BibTeX-Ruby
-# Copyright (C) 2010-2011	Sylvester Keil <http://sylvester.keil.or.at>
+# Copyright (C) 2010-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
@@ -15,21 +16,8 @@
 # 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)
-    
+module BibTeX
+  module Version
+    STRING = '1.1.1'
   end
 end

data/test/bib/10_bibdesk.bib

@@ -21,7 +21,8 @@
 	Publisher = {The Pragmatic Bookshelf},
 	Series = {The Facets of Ruby},
 	Title = {Agile Web Development with Rails},
-	Year = {2009}}
+	Year = {2009}
+}
 
 @book{dragon,
 	Address = {Boston},
@@ -33,7 +34,8 @@
 	Keywords = {compiler, lex, yacc},
 	Publisher = {Addison Wesley},
 	Title = {Compilers: Principles, Techniques, and Tools},
-	Year = {2007}}
+	Year = {2007}
+}
 
 @book{pickaxe,
 	Address = {Raleigh, North Carolina},
@@ -44,4 +46,5 @@
 	Publisher = {The Pragmatic Bookshelf},
 	Series = {The Facets of Ruby},
 	Title = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
-	Year = {2009}}
+	Year = {2009}
+}

data/test/test_export.rb

@@ -3,6 +3,7 @@ require 'rubygems'
 require 'minitest/unit'
 require 'minitest/autorun'
 require 'yaml'
+require 'json'
 
 class TestString < MiniTest::Unit::TestCase
   
@@ -20,4 +21,13 @@ class TestString < MiniTest::Unit::TestCase
     assert_equal(['dragon', 'pickaxe', 'rails'], yaml.map { |y| y['key'] }.sort)
     assert_equal('{The Facets of Ruby}', yaml[0]['series'])
   end
+  
+  def test_json
+    bib = BibTeX::Bibliography.open('test/bib/10_bibdesk.bib', :debug => true)
+    json = JSON.parse(bib.to_json)
+    refute_nil(json)
+    assert_equal(3, json.length)
+    assert_equal(['dragon', 'pickaxe', 'rails'], json.map { |y| y['key'] }.sort)
+    assert_equal('{The Facets of Ruby}', json[0]['series'])
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Sylvester Keil
@@ -35,7 +35,7 @@ cert_chain:
   J/FeJ8pSGMcNlQbhGpGIX+ARJK5ArG0Aq4214ttgefkdQJvw5r9hG3J4AgM=
   -----END CERTIFICATE-----
 
-date: 2011-01-24 00:00:00 +01:00
+date: 2011-01-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,10 +62,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
         - 0
-        version: "0"
+        - 2
+        version: 2.0.2
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :development
+  version_requirements: *id003
 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: []
@@ -73,30 +90,18 @@ executables: []
 extensions: []
 
 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
+- README.md
 files: 
 - History.txt
 - LICENSE
 - Manifest
-- README.rdoc
+- README.md
 - 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
@@ -104,7 +109,8 @@ files:
 - lib/bibtex/parser.output
 - lib/bibtex/parser.rb
 - lib/bibtex/string_replacement.rb
-- lib/extensions/core.rb
+- lib/bibtex/version.rb
+- lib/bibtex.rb
 - test/bib/00_empty.bib
 - test/bib/01_no_bibtex.bib
 - test/bib/02_string.bib

data/README.rdoc

@@ -1,154 +0,0 @@
-= BibTeX-Ruby
-
-The BibTeX-Ruby package contains a parser for BibTeX
-bibliography files and a class structure to manage BibTeX objects in
-Ruby. It is designed to support all BibTeX objects (including @comment and
-string-replacements via @string) and handles all content outside of BibTeX
-objects as `meta comments' which may be included in post-processing.
-
-
-== Quickstart
-
-* require 'bibtex'
-* bib = BibTeX::Bibliography.open('file.bib')
-* bib.to_yaml
-
-
-== Installation
-
-If you just want to use it:
-
-* gem install bibtex-ruby
-
-If you want to work with the sources:
-
-* gem install racc
-* git clone http://github.com/inukshuk/bibtex-ruby.git
-* cd bibtex-ruby
-* rake racc
-* rake rdoc
-* rake test
-
-Or, alternatively, fork the (project on github)[http://github.com/inukshuk/bibtex-ruby.git].
-
-
-== Requirements
-
-* 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 YAML and BibTeX to HTML converter.
-
-
-== The Parser
-
-The BibTeX-Ruby parser is generated using the wonderful
-{+racc+}[http://i.loveruby.net/en/projects/racc/] parser generator.
-
-== The BibTeX Format
-
-At first glance, the BibTeX file format seems very clear and simple;
-however, there are a number of peculiarities which warrant some
-explanation. The best place to start reading is probably at {your closest
-ctan server}[http://www.ctan.org/get/biblio/bibtex/] where
-the original +bibtex+ from 1988 still lives. Additionally, Xavier Decoret
-has written
-{a great summary}[http://artis.imag.fr/~Xavier.Decoret/resources/xdkbibtex/bibtex_summary.html]
-of the format; another invaluable source of information is Nicolas Markey's
-website[http://www.lsv.ens-cachan.fr/~markey/bibla.php]. Unfortunately,
-even after consulting these documents, a number of issues remain.
-Therefore, it is the purpose of this section to deliver the rationale
-that went into some of the design decision in BibTeX-Ruby.
-
-A BibTeX bibliography is typically stored in a file with the file
-extension `.bib'. This file may contain any number of BibTeX objects;
-everything that is not a BibTeX object is assumed to be a comment and
-ignored.
-
-The individual objects are discussed in further detail below. First, however, a
-number of general remarks:
-
-* BibTeX-Ruby begins in comment-mode, treating all text it encounters as comments.
-  Normally these comments are ignored; however, if you wish the parser to include
-  them, you can do so by adding the symbol +:meta_comments+ to the +:include+ array
-  in the parser's options.
-* Note that string literals in BibTeX are either contained in quotes or braces;
-  nested quotes in a quoted literal are not escaped with a usual backslash but
-  must be placed inside braces. Nested braces must be balanced in literals, regardless
-  of whether they are surrounded by quotes or braces.
-* Quoted strings and string constants (which are defined by @string objects) can be
-  concatted by the `#' symbol. String literals in braces can not be concatted in
-  this way.
-* The `@' symbol may only occur in quoted string literals (not in braced out literals)
-  in the original BibTeX; note, however, that this is not true for BibTeX-Ruby (i.e.,
-  it will parse any string containing an `@').
-
-=== @comment
-
-The purpose of the @comment object is not entirely clear, because everything
-outside of an object is treated as a comment anyway. Nicolas Markay argues that
-a @comment makes it possible to quickly comment out a number of consecutive
-objects; however, as Xavier Decoret points out that this does not work with the
-original +bibtex+ program (following a @comment, it simply ignores everything
-until the end of the line). Indeed, on page 13 of {the original
-documentation}[http://www.ctan.org/get/biblio/bibtex/contrib/doc/btxdoc.pdf],
-Oren Patashnik explains that @comment objects are not really necessary; they
-exist only for _Scribe_ system compatibility.
-
-Because they would be useless otherwise, BibTeX-Ruby treats @comment objects
-as Nicolas Markay describes them: thus, everything inside a @comment is treated
-as a comment and is ignored—everything,
-that is, until the object is closed. For this reason, BibTeX-Ruby assumes that
-braces inside a @comment are balanced! Obviously, BibTeX-Ruby differs from
-+bibtex+ in that respect; though, the gain is, that it is now possible to
-comment out a sequence of entries, without removing their respective `@' symbols.
-
-=== @string
-
-The @string object defines a single string constant (for multiple constant
-assignments, it is necessary to define separate @string objects). These
-constants can be used within string assignments in other @string or @preamble
-objects, as well as in regular BibTeX entries. For example, this is a valid constant
-definition and usage:
-
-* @string{ generator = "BibTeX-Ruby"}
-* @preamble{ "This bibliography was generated by " # generator }
-
-
-=== @preamble
-
-Typically, the purpose of @preamble objects is to define LaTeX statements, which
-will be put into the `.bbl' file by +bibtex+. A @preamble object may contain
-a single string literal, a single string constant (defined by a @string object), or
-a concatenation of literals and constants.
-
-=== Entries
-
-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/].
-
-== License
-
-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/>.

data/bibtex-ruby.gemspec

@@ -1,39 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{bibtex-ruby}
-  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-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/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"]
-  s.rubyforge_project = %q{bibtex-ruby}
-  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_export.rb", "test/test_preamble.rb", "test/test_string.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    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