bibtex-ruby 1.3.0 → 1.3.1

data/README.md

@@ -2,12 +2,13 @@ BibTeX-Ruby
 ===========
 
 BibTeX-Ruby is a fairly complete library and parser for BibTeX bibliography
-files; it offers an interface to manage, search, or convert BibTeX objects in
+files; it offers a rich interface to manage, search, or convert 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 content' which may
-or may not be included in post-processing. BibTeX-Ruby also includes a name
-parser to support comfortable access to the individual tokens of name values.
+and optionally handles all content outside of BibTeX objects as 'meta content'
+which may or may not be included in post-processing. BibTeX-Ruby also includes
+a name parser to support comfortable access to the individual tokens of name
+values.
 
 
 Quickstart
@@ -32,9 +33,29 @@ Quickstart
     => 3
     >> b['@article'].length
     => 0
-    >> bib['@book[year=2009]'].length
+    >> b['@book[year=2009]'].length
     => 1
 
+BibTeX-Ruby helps you convert your bibliography to JSON, XML, or YAML;
+alternatively, you can export to the JSON format used by
+[CSL](http://citationstyles.org) processors and render the bibliography in
+many styles:
+
+    >> require 'citeproc'  # requires the citeproc-ruby gem
+    => true
+		>> CiteProc.process b[:pickaxe].to_citeproc, :style => :apa
+		=> "Thomas, D., Fowler, C., & Hunt, A. (2009). Programming Ruby 1.9:
+		  The Pragmatic Programmer's Guide. The Facets of Ruby.
+		  Raleigh, North Carolina: The Pragmatic Bookshelf."
+		>> CiteProc.process b[:pickaxe].to_citeproc, :style => 'chicago-author-date'
+		=> "Thomas, Dave, Chad Fowler, and Andy Hunt. 2009. Programming Ruby 1.9:
+		  The Pragmatic Programmer's Guide. The Facets of Ruby.
+		  Raleigh, North Carolina: The Pragmatic Bookshelf."
+		>> CiteProc.process b[:pickaxe].to_citeproc, :style => :mla
+		=> "Thomas, Dave, Chad Fowler, and Andy Hunt. Programming Ruby 1.9:
+		  The Pragmatic Programmer's Guide. Raleigh, North Carolina:
+		  The Pragmatic Bookshelf, 2009."
+
 
 Installation
 ------------
@@ -255,7 +276,8 @@ BibTeX to YAML converter:
     >> BibTeX.open('example.bib').to_yaml
 
 Look at the 'examples' directory for more elaborate examples of a BibTeX to YAML
-and a BibTeX to HTML converter.
+and a BibTeX to HTML converter using **#to_citeproc** to format a bibliography
+using [CSL](http://citationstyles.org/).
 
 BibTeX-Ruby offers an API which lets you manipulate BibTeX objects (string
 replacement, name parsing etc.); however, sometimes you just want quick access

data/examples/bib2html.rb

@@ -11,17 +11,16 @@ bib = BibTeX.open File.expand_path('../markdown.bib',__FILE__),
 # converts each BibTeX entries to a string using Chicago style
 # (all other elements are mapped to simple strings)
 
-# TODO 1.3.1
-# begin
-#   require 'citeproc'
-# rescue LoadError
-#   puts 'this example depends on the citeproc-ruby gem'
-#   exit
-# end
+begin
+  require 'citeproc'
+rescue LoadError
+  puts 'this example depends on the citeproc-ruby gem'
+  exit
+end
 
 content = bib.replace.q('@entry, @meta_content').map do |b|
   if b.entry?  
-    [b.author, '. ', b.title, '. ', b.publisher, ': ', b.address, ', ', b.year, '.'].join
+    CiteProc.process b.to_citeproc
   else
     b.to_s
   end

data/lib/bibtex/entry.rb

@@ -45,9 +45,40 @@ module BibTeX
 		}).freeze
 
     NAME_FIELDS = [:author, :editor, :translator].freeze
+    DATE_FIELDS = [:year].freeze
+
+    CSL_FIELDS = Hash.new {|h,k|k}.merge(Hash[*%w{
+      date      issued
+      isbn      ISBN
+      booktitle container-title
+      journal   container-title
+      series    collection-title
+      address   publisher-place
+      pages     page
+      number    issue
+      url       URL
+      doi       DOI
+      year      issued
+    }.map(&:intern)]).freeze
+
+    CSL_TYPES = Hash.new {|h,k|k}.merge(Hash[*%w{
+      booklet        pamphlet
+      conference     paper-conference
+      inbook         chapter
+      incollection   chapter
+      inproceedings  paper-conference
+      manual         book
+      mastersthesis  thesis
+      misc           article
+      phdthesis      thesis
+      proceedings    paper-conference
+      techreport     report
+      unpublished    manuscript
+    }.map(&:intern)]).freeze
+
 	  
 		attr_reader :type, :fields
-    def_delegators :@fields, :empty?, :each
+    def_delegators :@fields, :empty?, :each, :each_pair
 
 		# Creates a new instance. If a hash is given, the entry is populated accordingly.
 		def initialize(attributes = {})
@@ -90,6 +121,10 @@ module BibTeX
       type.to_s.match(/^entry$/i) || @type == type.to_sym || super
     end
     
+    def has_field?(field)
+      @fields.has_key?(field)
+    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.to_s.match(/=$/)		  
@@ -100,19 +135,25 @@ module BibTeX
 		  @fields.has_key?(method.to_sym) || method.to_s.match(/=$/) || super
 		end
 		
+		# Returns a copy of the Entry with all the field names renamed.
+		def rename(*arguments)
+		  dup.rename!(*arguments)
+		end
+		
 		# Renames the given field names unless a field with the new name already
 		# exists.
-		def rename(*arguments)
+		def rename!(*arguments)
 		  Hash[*arguments.flatten].each_pair do |from,to|
-		    if @field.has_key?(from) && !@field.has_key?(to)
-		      @field[to] = @field[from]
-		      @field.delete(from)
+		    if @fields.has_key?(from) && !@fields.has_key?(to)
+		      @fields[to] = @fields[from]
+		      @fields.delete(from)
 	      end
 		  end
 		  self
 		end
 		
 		alias :rename_fields :rename
+		alias :rename_fields! :rename!
 		
 		# Returns the value of the field with the given name.
 		def [](name)
@@ -209,11 +250,18 @@ module BibTeX
 		
 		def to_hash(options = {})
 		  options[:quotes] ||= %w({ })
-		  Hash[*([:key, key, :type, type] + @fields.map { |k,v| [k, v.to_s(options)] }.flatten)]
+		  hash = { :key => key, :type => type }
+		  each_pair { |k,v| hash[k] = v.to_s(options) }
+		  hash
 		end
 
 		def to_citeproc(options = {})
-		  to_hash(options)
+		  options[:quotes] ||= []
+		  hash = { 'id' => key.to_s, 'type' => CSL_TYPES[type].to_s }
+      each_pair do |k,v|
+		    hash[CSL_FIELDS[k].to_s] = k == :year ? v.to_date : v.to_citeproc(options)
+		  end
+		  hash
 		end
 		
 		def to_xml(options = {})

data/lib/bibtex/names.rb

@@ -59,6 +59,14 @@ module BibTeX
     
     def to_name; self; end
     
+    def to_citeproc(options = {})
+      map { |n| n.to_citeproc(options) }
+    end
+    
+    def strip_braces
+      gsub!(/\{|\}/,'')
+    end
+    
     def add(name)
       case
       when name.is_a?(Name)
@@ -141,12 +149,13 @@ module BibTeX
       end
     end
     
-    def to_citeproc
-      {
-        'family' => [prefix, last].compact.join(' '),
-        'given' =>  [first, suffix].compact.join(', '),
-        'parse-names' => true
-      }
+    def to_citeproc(options = {})
+      hash = {}
+      hash['family'] = family unless family.nil?
+      hash['given'] = given unless given.nil?
+      hash['suffix'] = suffix unless suffix.nil?
+      hash['dropping-particle'] = prefix unless prefix.nil?
+      hash
     end
     
     alias :family :last

data/lib/bibtex/value.rb

@@ -73,7 +73,11 @@ module BibTeX
       when Symbol
         @tokens << argument
       else
-        raise(ArgumentError, "Failed to create Value from argument #{ argument.inspect }; expected String, Symbol or Value instance.")
+        if argument.respond_to?(:to_s)
+          @tokens << argument.to_s
+        else
+          raise(ArgumentError, "Failed to create Value from argument #{ argument.inspect }; expected String, Symbol or Value instance.")
+        end
       end
       self
     end
@@ -158,9 +162,8 @@ module BibTeX
       @tokens.length < 2
     end
     
-    # Returns true if the Value looks like a BibTeX name value. 
-    def name?
-    end
+    # Returns true if the value is a BibTeX name value. 
+    def name?; false; end
     
     alias :names? :name?
     alias :is_name? :name?
@@ -170,8 +173,17 @@ module BibTeX
     end
     
     alias :to_names :to_name
+
+    # Returns true if the Value's content looks like a date.    
+    def date?
+    end
+
+    alias :is_date? :date?
     
-    
+    # Returns the string as a citeproc date. TODO use edtf format instead.
+    def to_date
+      numeric? ? { 'date-parts' => [[to_i]] } : { 'literal' => to_s(:quotes => [])}
+    end
     
     # Returns true if the Value's content is numeric.
     def numeric?
@@ -180,6 +192,10 @@ module BibTeX
     
     alias :is_numeric? :numeric?
     
+    def to_citeproc(options = {})
+      to_s(options)
+    end
+    
     # Returns true if the Value contains at least one symbol.
     def symbol?
       @tokens.detect { |v| v.is_a?(Symbol) }

data/lib/bibtex/version.rb

@@ -18,6 +18,6 @@
 
 module BibTeX
   module Version
-    STRING = '1.3.0'.freeze
+    STRING = '1.3.1'.freeze
   end
 end

data/test/bibtex/test_entry.rb

@@ -3,12 +3,43 @@ require 'helper.rb'
 module BibTeX
   class EntryTest < MiniTest::Spec
 
-    context 'a new Entry' do
+    context 'a new entry' do
       should 'not be nil' do
         assert Entry.new
       end
     end
 
+    context 'given an entry' do
+      setup do
+        @entry = Entry.new do |e|
+          e.type = :book
+          e.key = :key
+          e.title = 'Moby Dick'
+          e.author = 'Herman Melville'
+          e.publisher = 'Penguin'
+          e.address = 'New York'
+          e.year = 1993
+          e.parse_names
+        end
+      end
+      
+      should 'support renaming of field attributes' do
+        @entry.rename(:title => :foo)
+        refute @entry.has_field?(:title)
+        assert_equal 'Moby Dick', @entry[:foo]
+      end
+      
+      should 'support citeproc export' do
+        e = @entry.to_citeproc
+        assert_equal 'book', e['type']
+        assert_equal 'New York', e['publisher-place']
+        assert_equal [1993], e['issued']['date-parts'][0]
+        assert_equal 1, e['author'].length
+        assert_equal 'Herman', e['author'][0]['given']
+        assert_equal 'Melville', e['author'][0]['family']
+      end
+    end
+    
     def test_simple
       bib = BibTeX::Bibliography.open(Test.fixtures(:entry), :debug => false)
       refute_nil(bib)
@@ -94,6 +125,5 @@ module BibTeX
 
     end
   
-  
   end
 end

metadata

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