aurels-rbib 1.2 → 2.0

data/test/run_unit_tests.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+#
+# Run all the unit tests in the current directory.
+#
+
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "bibtex"
+
+Dir.glob(File.join(File.dirname(__FILE__), '..', 'test', 'test_*.rb')).each do |file|
+  require file
+end
+

data/test/test_bibliography.rb

@@ -0,0 +1,76 @@
+require 'bibtex/bibliography'
+require 'test/unit'
+
+class TestBibliography < Test::Unit::TestCase
+  include Bibtex
+
+  def setup
+    @b = Bibliography.new
+
+    @foo01 = Entry.new(EntryType::Book, 'foo01')
+    @foo01.add_field :author, 'C. Doof'
+    @foo01.add_field :year, 2007
+    @foo01.add_field Field.new(:url, 'www.doof.me.uk')
+
+    @bar99 = Entry.new(EntryType::Article, 'bar99')
+    @bar99.add_field :author, 'N. Cakesniffer'
+    @bar99.add_field :year, 1999
+    @bar99.add_field Field.new(:url, 'www.cakesniffer.co.uk')
+
+    @b << @foo01
+    @b << @bar99
+  end
+
+  def test_basic
+    assert_equal 2, @b.entries.length
+    assert_equal @foo01, @b['foo01']
+  end
+
+  def test_map
+    expect = <<END
+@article{bar99,
+  author = {N. Cakesniffer},
+  year = {1999}
+}
+
+@book{foo01,
+  author = {C. Doof},
+  year = {2007}
+}
+
+END
+    urlless = @b.map do |e|
+      e.reject_fields [:url]
+    end
+    assert_equal expect, urlless.to_s    
+  end
+
+  def test_to_s
+    expect = <<END
+@article{bar99,
+  author = {N. Cakesniffer},
+  url = {www.cakesniffer.co.uk},
+  year = {1999}
+}
+
+@book{foo01,
+  author = {C. Doof},
+  url = {www.doof.me.uk},
+  year = {2007}
+}
+
+END
+    assert_equal expect, @b.to_s
+  end
+
+  def test_save
+    fname = '/tmp/_test.bib'
+    @b.save fname
+
+    f = File.new(fname)
+    assert_equal @b.to_s, f.read
+    f.close
+    File.delete fname
+  end
+  
+end

data/test/test_entry.rb

@@ -0,0 +1,70 @@
+require 'bibtex/entry'
+require 'test/unit'
+
+class TestEntry < Test::Unit::TestCase
+  include Bibtex
+
+  def setup
+    @e = Entry.new(EntryType::Book, 'foo01')
+  end
+  
+  def test_basic
+    assert_equal EntryType::Book, @e.type
+    assert_equal 'foo01', @e.key
+  end
+
+  def add_default_fields
+    @e.add_field :author, 'C. Doof'
+    @e.add_field :year, 2007
+    @e.add_field Field.new(:url, 'www.doof.me.uk')
+  end
+
+  def test_fields
+    add_default_fields
+    
+    assert_equal 'C. Doof', @e[:author]
+    assert_equal 2007, @e[:year]
+    assert_equal 'www.doof.me.uk', @e[:url]
+  end
+
+  def test_to_s
+    add_default_fields
+
+    expect = <<END
+@book{foo01,
+  author = {C. Doof},
+  url = {www.doof.me.uk},
+  year = {2007}
+}
+
+END
+    assert_equal expect, @e.to_s
+  end
+
+  def test_reject
+    add_default_fields
+
+    expect = <<END
+@book{foo01,
+  author = {C. Doof},
+  year = {2007}
+}
+
+END
+    r = @e.reject_fields [:url]
+    assert_equal expect, r.to_s    
+  end
+
+  def test_select
+    add_default_fields
+
+    expect = <<END
+@book{foo01,
+  url = {www.doof.me.uk}
+}
+
+END
+    r = @e.select_fields [:url]
+    assert_equal expect, r.to_s    
+  end
+end

data/test/test_field.rb

@@ -0,0 +1,17 @@
+require 'bibtex/field'
+require 'test/unit'
+
+class TestField < Test::Unit::TestCase
+  include Bibtex
+
+  def test_basic
+    f = Field.new(:author, 'C. Doof')
+    assert_equal :author, f.key
+    assert_equal 'C. Doof', f.value
+  end
+
+  def test_to_s
+    f = Field.new(:author, 'C. Doof')
+    assert_equal 'author = {C. Doof}', f.to_s
+  end
+end

data/test/test_lexer.rb

@@ -0,0 +1,116 @@
+require 'bibtex/lexer'
+require 'test/unit'
+
+class TestLexer < Test::Unit::TestCase
+  include Bibtex
+  
+  def test_basic
+    l = Lexer.new do |rules|
+      rules.match /a/, :a
+      rules.match /b+/, :bs
+      rules.match /\s+/, :space
+      rules.match /hello/, :hello
+    end
+    l.feed 'aabbb  hello'
+
+    assert_equal :a, l.next_token!
+    assert_equal :a, l.next_token!
+    assert_equal :bs, l.next_token!
+    assert_equal :space, l.next_token!
+    assert_equal :hello, l.peek_token
+    assert_equal 'hello', l.peek_lval
+    assert_equal :hello, l.next_token!
+
+    assert (not l.more_tokens?)
+    assert_raise LexerError do
+      l.next_token!
+    end
+  end
+
+  def test_prec
+    l = Lexer.new do |rules|
+      rules.match /a/, :aye
+      rules.match /a+/, :bad
+      rules.match /.*/, :other
+    end
+    l.feed 'aa'
+    assert_equal :aye, l.next_token!
+    assert_equal :aye, l.next_token!
+    assert (not l.more_tokens?)
+  end
+
+  def test_whitespace
+    l = Lexer.new(false) do |rules|
+      rules.match /\w+/, :word
+    end
+    l.feed " hello\t\n  world   "
+
+    assert (not l.ignore_whitespace)
+    l.ignore_whitespace = true
+
+    assert_equal :word, l.next_token!
+    assert_equal 'hello', l.lval
+    assert_equal :word, l.next_token!
+    assert_equal 'world', l.lval
+    assert (not l.more_tokens?)
+  end
+
+  def test_src_pos
+    l = Lexer.new do |rules|
+      rules.match /a/, :a
+      rules.match /\n/, :newline
+    end
+    l.feed 'aaaab'
+
+    4.times { l.next_token! }
+    begin
+      l.next_token!
+      flunk 'No exception raised'
+    rescue LexerError => e
+      assert_kind_of SourcePos, e.src_pos
+      assert_equal 1, e.src_pos.line
+      assert_equal 4, e.src_pos.column
+    end
+
+    l.ignore_newlines = false
+    l.feed "aa\nab"
+
+    l.file_name = 'My File'
+
+    2.times { l.next_token! }
+    assert_equal :newline, l.next_token!
+    assert_equal :a, l.next_token!
+    begin
+      l.next_token!
+      flunk 'No error raised'
+    rescue LexerError => e
+      assert_equal 2, e.src_pos.line
+      assert_equal 1, e.src_pos.column
+      assert_equal 'My File', e.src_pos.file
+    end
+  end
+
+  def test_literals
+    l = Lexer.new do |rules|
+      rules.literals [:aye, :bee]
+    end
+    l.feed 'ayebeebee'
+
+    assert_equal :aye, l.next_token!
+    assert_equal :bee, l.next_token!
+    assert_equal :bee, l.next_token!
+  end
+
+  def test_refeed
+    l = Lexer.new do |rules|
+      rules.match /a/, :a
+      rules.match /b/, :b
+    end
+    l.feed 'aaa'
+
+    assert_equal :a, l.next_token!
+    l.feed 'bb'
+    assert l.more_tokens?
+    assert_equal :b, l.next_token!
+  end
+end

data/test/test_parser.rb

@@ -0,0 +1,27 @@
+require 'bibtex/parser'
+require 'test/unit'
+
+class TestParser < Test::Unit::TestCase
+  include Bibtex
+  
+  def test_basic
+    b = Parser.parse 'examples/example.bib'
+
+    ryan98 = b['ryan98']
+    assert_kind_of Entry, ryan98
+    assert_equal EntryType::Article, ryan98.type
+    assert_equal 1998, ryan98[:year].to_i
+
+    heys01 = b['heys01']
+    assert_equal "March", heys01[:month]
+    assert_equal 2001, heys01[:year].to_i
+  end
+
+  def test_parse_reparse
+    fname = '/tmp/example.bib.stripped'
+    b = Parser.parse 'examples/example.bib'
+    b.save fname
+    Parser.parse fname
+    File.delete fname    
+  end
+end

metadata

@@ -1,35 +1,62 @@
 --- !ruby/object:Gem::Specification 
 name: aurels-rbib
 version: !ruby/object:Gem::Version 
-  version: "1.2"
+  version: "2.0"
 platform: ruby
 authors: 
-- Nick Gasson
-- "Aur\xC3\xA9lien Malisart"
+- "Nick Gasson, Aur\xC3\xA9lien Malisart"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-05-07 00:00:00 -07:00
+date: 2009-05-10 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: BibTeX parser in Ruby
+description: BibTeX parser written in Ruby
 email: aurelien.malisart@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- lib/bibtex/bibliography.rb
+- lib/bibtex/entry.rb
+- lib/bibtex/field.rb
+- lib/bibtex/lexer.rb
+- lib/bibtex/parser.rb
+- lib/bibtex.rb
+- README.rdoc
 files: 
-- README
+- examples/example.bib
+- examples/glom_citeulike.rb
+- examples/tara_no_url.rb
+- lib/bibtex/bibliography.rb
+- lib/bibtex/entry.rb
+- lib/bibtex/field.rb
+- lib/bibtex/lexer.rb
+- lib/bibtex/parser.rb
 - lib/bibtex.rb
-has_rdoc: false
+- Manifest
+- Rakefile
+- rbib.gemspec
+- README.rdoc
+- test/run_unit_tests.rb
+- test/test_bibliography.rb
+- test/test_entry.rb
+- test/test_field.rb
+- test/test_lexer.rb
+- test/test_parser.rb
+has_rdoc: true
 homepage: http://github.com/aurels/rbib
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rbib
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -42,14 +69,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: rbib
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: BibTeX parser in Ruby
-test_files: []
-
+summary: BibTeX parser written in Ruby
+test_files: 
+- test/test_bibliography.rb
+- test/test_entry.rb
+- test/test_field.rb
+- test/test_lexer.rb
+- test/test_parser.rb

data/README

@@ -1,20 +0,0 @@
-Parser for BibTeX files written in Ruby. No dependencies (except Test::Unit if
-you need to run the tests).
-
-By Nick Gasson (http://www.doof.me.uk)
-
-Example of usage:
-
-require 'rubygems'
-require 'bibtex'
-
-BibTeX::Parser.parse('references.bib').map do |entry|
-  puts entry[:Title]
-  puts entry[:Year]
-  entry
-end
-
-Installation:
-
-gem sources -a http://gems.github.com
-gem install aurels-rbib