bibtex_parser 1.0.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+*1.0.0 (March 02, 2010)*
+
+* <x@y, x=jshantz4, y=csd.uwo.ca>: Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010, Jeffrey Shantz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,107 @@
+= BibTeXParser - Simple BibTeX parsing
+
+BibTeXParser is a simple parser for the BibTeX format, allowing a file
+containing BibTeX citations to be parsed into individual entries consisting of
+key-value pairs.
+
+This is a new library, and so there are likely to be bugs and strange citation
+formats that I have not yet encountered.  If you happen to find a citation
+which is not parsed properly by this library, please see the Bug Reporting
+section below.
+
+== Author
+
+Jeff Shantz <x@y, where x is equal to jshantz4, y = csd.uwo.ca>
+
+== License
+
+BibTeXParser is Copyright (C) 2010, Jeff Shantz, and is licensed under the MIT
+license.  Please see LICENSE for more details
+
+== Parsing a BibTeX File
+
+A BibTeX file can be parsed using the BibTeXParser class:
+
+    require 'rubygems'
+    require 'bibtex_parser'
+
+    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+
+    entries.each do |entry|
+        puts entry.title
+        puts entry.year
+    end
+
+== Accessing entry data
+
+To access entry data, you can either index into the entry, specifying the key
+name to get or set, or simply use "dot" notation, as shown below:
+
+    require 'rubygems'
+    require 'bibtex_parser'
+
+    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+    entry = entries[0]
+
+    entry.year = 2010
+    entry[:year] = 2010  # Equivalent
+
+    puts entry.title
+    puts entry[:title]  # Equivalent
+
+== Getting author data
+
+Authors (or editors) are stored under the 'author' key as an array of
+BibTeXAuthor objects.  A BibTeXAuthor contains an author's name parsed into
+First, Middle, and Last parts.  Unlike other BibTeX parsers currently in
+existence, this parser does not extract "von" and "jr" parts of names.  This
+may be implemented in the future, should demand arise.
+
+    require 'rubygems'
+    require 'bibtex_parser'
+
+    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+    entry = entries[0]
+    first_author = entry.authors[0]
+
+    puts first_author.first_name
+    puts first_author.middle_name
+    puts first_author.last_name
+
+== Checking whether or not a citation is valid
+
+The 'valid?' method and the 'errors' array will be of assistance in determining
+whether or not a citation is valid and, if not, why it is failing.
+
+    require 'rubygems'
+    require 'bibtex_parser'
+
+    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+    entry = entries[0]
+
+    unless (entry.valid?)
+        entry.errors.each do |error|
+            puts error
+        end
+    end
+
+== Special entry attributes
+
+The following attributes of the BibTexEntry class may be of interest to you:
+
+    * raw_bibtex    - Returns the raw BibTeX citation from which the entry was
+                      created
+    * valid         - Whether or not the citation was properly parsed
+    * type          - The citation type (e.g. "inproceedings" or "techreport")
+    * key           - The entry's citation key
+    * errors        - Array of parsing errors, if the citation is invalid
+
+== Reporting Bugs
+
+Should you find a bug with the parser, please send an email to the address below
+with the following:
+
+    * The version of the parser you are using
+    * The failing BibTeX citation attached
+
+Send bug reports to: x@y, where x is equal to jshantz4, and y = csd.uwo.ca

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'bibtex_parser'
+  s.version = '1.0.0'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README', 'LICENSE','CHANGELOG']
+  s.summary = 'A parser for the BibTeX citation format'
+  s.description = s.summary
+  s.author = 'Jeff Shantz'
+  s.email = 'x@y, where x = jshantz4, y = csd.uwo.ca'
+  # s.executables = ['your_executable_here']
+  s.files = %w(LICENSE README CHANGELOG Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.require_path = "lib"
+  s.bindir = "bin"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['README', 'LICENSE', 'CHANGELOG', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README" # page to start on
+  rdoc.title = "BibTeXParser Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.libs << Dir["lib"]
+end

data/lib/bibtex_author.rb

@@ -0,0 +1,50 @@
+# = BibTeXParser - Simple BibTeX parsing
+#
+# Author: Jeff Shantz <x@y, where x is equal to jshantz4, y = csd.uwo.ca>
+#
+# Licensed under the MIT license -- see LICENSE for more details
+
+class BibTeXAuthor
+
+  attr_accessor :first_name, :last_name, :middle_name, :raw_name
+  
+  def initialize(name)
+    @raw_name = name.strip
+    parse
+  end
+  
+  def parse
+  
+    if @raw_name =~ /^([\w.-]+)\s*(?:(\w\.))?\s*([\w.-]+)$/ # First M. Last
+      @first_name = $1
+      @last_name = $3
+      @middle_name = $2 unless $2.nil?      
+    elsif @raw_name =~ /^([\w.-]+)\s*,\s*([\w.-]+)\s*(?:([\w]\.)?)$/ # Last, First M.
+      @first_name = $2
+      @last_name = $1
+      @middle_name = $3 unless $3.nil?
+    elsif @raw_name.index(",") # De Last, First
+      parts = @raw_name.split(/\s*,\s*/) 
+      @last_name = parts[0]
+      @first_name = parts[1]
+      @middle_name = nil
+    else # First De Last
+      parts = @raw_name.split(/\s+/) 
+      @first_name = parts.shift
+      @last_name = parts.join(" ")
+      @middle_name = nil
+    end
+      
+  end
+  
+#  def inspect
+#
+#    s = ""
+#    s += "\t\tFIRST  : #{@first_name}\n"
+#    s += "\t\tMIDDLE : #{@middle_name}\n"
+#    s += "\t\tLAST   : #{@last_name}\n"
+#
+#    return s
+#
+#  end
+end

data/lib/bibtex_entry.rb

@@ -0,0 +1,184 @@
+require 'bibtex_author'
+
+# = BibTeXParser - Simple BibTeX parsing
+#
+# Author: Jeff Shantz <x@y, where x is equal to jshantz4, y = csd.uwo.ca>
+#
+# Licensed under the MIT license -- see LICENSE for more details
+
+class BibTeXEntry
+
+  attr_accessor :raw_bibtex, :valid, :type, :key, :errors, :authors
+  
+  def initialize(block)
+    
+    @raw_bibtex = block
+    @valid = true
+    @fields = {}
+    @authors = []
+    @errors = []
+    self.parse
+    
+  end
+
+  def valid?
+    @valid
+  end
+
+  def [](key)
+    key = key.strip.downcase.to_sym if (key.is_a?(String))
+    @fields[key]
+  end
+
+  def []=(key, value)    
+    key = key.strip.downcase.to_sym if (key.is_a?(String))
+    @fields[key] = value
+  end
+
+  def has_key?(key)
+    key = key.strip.downcase.to_sym if (key.is_a?(String))
+    @fields.has_key?(key)
+  end
+
+  def parse  
+    @valid = true
+    @errors = []
+    @raw_bibtex.strip!  
+    @parsed = @raw_bibtex 
+     
+    return unless parse_type
+    return unless parse_key
+    parse_fields    
+    parse_authors
+    
+    if ((! self.has_key?(:year)) || (self[:year].eql?("")))
+      @errors << "Missing year field"
+      @valid = false
+    end
+    
+    if ((! self.has_key?(:title)) || (self[:title].eql?("")))
+      @errors << "Missing title field"
+      @valid = false
+    end
+    
+  end       
+  
+#  def inspect
+#
+#    s =  "TYPE: #{@type}\n"
+#    s += "KEY: #{@key}\n"
+#    s += "FIELDS [#{@fields.size}]: \n"
+#    s += "VALID: #{@valid}\n"
+#
+#    @fields.each do |k,v|
+#      s += "\t#{k}\t=> #{v}\n"
+#    end
+#
+#    s += "AUTHORS [#{@authors.size}]: \n"
+#    @authors.each do |author|
+#      s+= author.inspect
+#    end
+#    s += "\n\n#{@parsed}"
+#
+#    s += "ERRORS [#{@errors.size}]: \n"
+#    @errors.each do |error|
+#      s+= "\t\t#{error}\n"
+#    end
+#
+#    return s
+#
+#  end
+
+  def method_missing(sym, *arguments)
+    
+    if (sym.to_s =~ /=$/)      
+      self.send(:[]=, sym.to_s.chop, *arguments)
+    else
+      self.send(:[], sym)
+    end
+    
+  end
+
+
+  private
+
+  def parse_type
+
+    if (@parsed =~ /^(\s*@([[:alpha:]]+)\s*\{)/)
+      @type = $2
+      @parsed = @parsed[$1.length..-1]
+      @valid = true
+    else
+      @errors << "Missing citation type"
+      @valid = false
+    end
+
+  end
+
+  def parse_key
+
+    idx = @parsed.index(",")
+
+    if (idx)
+
+      key = @parsed[0...idx].strip
+
+      # Quick sanity check to ensure the user specified a key -- don't
+      # want to treat a "KEY = VALUE," pair as the key simply because
+      # there's a comma after the pair
+      if (key =~ /=/)
+        @errors << "Missing citation key"
+        @valid = false
+
+      else
+        @key = key
+        @parsed = @parsed[idx+1..-1]
+      end
+    else
+      @errors << "Missing citation key"
+      @valid = false
+    end
+  end
+
+  def parse_fields
+
+    pairs = @parsed.scan(/(\s*[[:alpha:]]+\s*=\s*(?:\{.*\}|".*"))/)
+
+    pairs.each do |pair|
+      parts = pair[0].split("=")
+      key = parts[0].strip.downcase
+      value = parts[1].strip
+      value.sub!(/^\{(.*)\}$/,"\\1") if value
+      value.sub!(/^"(.*)"$/,"\\1") if value
+      self[key] = value.strip
+    end
+
+  end
+
+  def parse_authors
+
+    unless ((self.has_key?(:author)) || (self.has_key?(:editor)))
+      @errors << "Missing author or editor field"
+      @valid = false
+      return
+    end
+
+    if ((self.has_key?(:author)) && (self[:author].length > 0))
+      authors = self[:author]
+    elsif ((self.has_key?(:editor)) && (self[:editor].length > 0))
+      authors = self[:editor]
+    else
+      @errors << "Missing author or editor field"
+      @valid = false
+      return
+    end
+
+    author_list = authors.split(/\s+and\s+/)
+    
+    author_list.each do |author_name|
+      @authors << BibTeXAuthor.new(author_name)
+    end
+
+  end
+
+end

data/lib/bibtex_parser.rb

@@ -0,0 +1,189 @@
+require 'bibtex_entry'
+
+# = BibTeXParser - Simple BibTeX parsing
+#
+# BibTeXParser is a simple parser for the BibTeX format, allowing a file
+# containing BibTeX citations to be parsed into individual entries consisting of
+# key-value pairs.
+#
+# This is a new library, and so there are likely to be bugs and strange citation
+# formats that I have not yet encountered.  If you happen to find a citation
+# which is not parsed properly by this library, please see the Bug Reporting
+# section below.
+#
+# == Author
+#
+# Jeff Shantz <x@y, where x is equal to jshantz4, y = csd.uwo.ca>
+#
+# == License
+#
+# BibTeXParser is Copyright (C) 2010, Jeff Shantz, and is licensed under the MIT
+# license.  Please see LICENSE for more details
+#
+# == Parsing a BibTeX File
+#
+# A BibTeX file can be parsed using the BibTeXParser class:
+#
+#    require 'rubygems'
+#    require 'bibtex_parser'
+#
+#    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+#
+#    entries.each do |entry|
+#        puts entry.title
+#        puts entry.year
+#    end
+#
+# == Accessing entry data
+#
+# To access entry data, you can either index into the entry, specifying the key
+# name to get or set, or simply use "dot" notation, as shown below:
+#
+#    require 'rubygems'
+#    require 'bibtex_parser'
+#
+#    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+#    entry = entries[0]
+#
+#    entry.year = 2010
+#    entry[:year] = 2010  # Equivalent
+#
+#    puts entry.title
+#    puts entry[:title]  # Equivalent
+#
+# == Getting author data
+#
+# Authors (or editors) are stored under the 'author' key as an array of
+# BibTeXAuthor objects.  A BibTeXAuthor contains an author's name parsed into
+# First, Middle, and Last parts.  Unlike other BibTeX parsers currently in
+# existence, this parser does not extract "von" and "jr" parts of names.  This
+# may be implemented in the future, should demand arise.
+#
+#    require 'rubygems'
+#    require 'bibtex_parser'
+#
+#    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+#    entry = entries[0]
+#    first_author = entry.authors[0]
+#
+#    puts first_author.first_name
+#    puts first_author.middle_name
+#    puts first_author.last_name
+#
+# == Checking whether or not a citation is valid
+#
+# The 'valid?' method and the 'errors' array will be of assistance in
+# determining whether or not a citation is valid and, if not, why it is failing.
+#
+#    require 'rubygems'
+#    require 'bibtex_parser'
+#
+#    entries = BibTeXParser.parse_bibtex_file('thesis.bib')
+#    entry = entries[0]
+#
+#    unless (entry.valid?)
+#        entry.errors.each do |error|
+#            puts error
+#        end
+#    end
+#
+# == Special entry attributes
+#
+# The following attributes of the BibTexEntry class may be of interest to you:
+#
+#    * raw_bibtex    - Returns the raw BibTeX citation from which the entry was
+#                      created
+#    * valid         - Whether or not the citation was properly parsed
+#    * type          - The citation type (e.g. "inproceedings" or "techreport")
+#    * key           - The entry's citation key
+#    * errors        - Array of parsing errors, if the citation is invalid
+#
+# == Reporting Bugs
+#
+# Should you find a bug with the parser, please send an email to the address
+# below with the following:
+#
+#    * The version of the parser you are using
+#    * The failing BibTeX citation attached
+#
+# Send bug reports to: x@y, where x is equal to jshantz4, and y = csd.uwo.ca
+
+class BibTeXParser
+
+  def BibTeXParser.parse_bibtex_file(filename)
+
+    f = File.open(filename)
+    blocks = []
+    entries = []
+    
+    while (!f.eof?)
+      line = f.gets
+          
+      if ((line =~ /^\s*@[[:alpha:]]+/) && (line !~ /@(string|preamble)/i))
+        blocks << extract_block(f,line)
+      end
+      
+    end
+    
+    blocks.each do |block|
+      entries << BibTeXEntry.new(block)
+    end
+
+    return entries    
+  
+  end
+
+  private
+  
+  def BibTeXParser.extract_block(f, start_line)
+    
+    stack = []
+    first_brace_seen = false
+    block = ""
+      
+    start_line.each_char do |c|
+    
+      block += c
+
+      if (c.eql?("{"))
+        stack.push("{")
+        first_brace_seen = true
+      elsif (c.eql?("}"))
+        stack.pop()
+      end    
+      
+      return block if ((first_brace_seen) && (stack.length == 0))
+      
+    end  
+
+    while (((first_brace_seen) ^ (stack.length == 0)) && (!f.eof?))
+    
+      line = f.gets
+      
+      line.each_char do |c|
+      
+        block += c
+
+        if (c.eql?("{"))
+          stack.push("{")
+          first_brace_seen = true
+        elsif (c.eql?("}"))
+          stack.pop()
+        end    
+      
+        break if ((first_brace_seen) && (stack.length == 0))
+      end
+      
+    end
+          
+    return block
+  
+  end
+  
+end
+
+#entries = BibTeXParser.parse_bibtex_file('cs9544a_project.bib')
+#entries = BibTeXParser.parse_bibtex_file('test.bib')
+#entries.each do |entry|
+#  puts "NEW ENTRY:\n==================================================\n#{entry.inspect}"
+#end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: bibtex_parser
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeff Shantz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-02 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A parser for the BibTeX citation format
+email: x@y, where x = jshantz4, y = csd.uwo.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- CHANGELOG
+files: 
+- LICENSE
+- README
+- CHANGELOG
+- Rakefile
+- lib/bibtex_author.rb
+- lib/bibtex_entry.rb
+- lib/bibtex_parser.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A parser for the BibTeX citation format
+test_files: []
+