bibout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5ace274726271cc7dad80e58d5f017244081497
+  data.tar.gz: 473d2b2666ad65b7ac322e94890cb77cb19661e9
+SHA512:
+  metadata.gz: a286408043f4143eea87aafc3cddb435ea6a84679e571fc141e88517a126d8e756aa91c88c5474bad6cb42ba30ad71b33a855191a498dd25364a4229d45a9586
+  data.tar.gz: 7cea2697ceefa319cb502941893e75117d2a53454e35445037b212bd50e71ad7a0f4fedc8dd890fd3a423625ddf3284d6af3008df20024f345ba6e31025ffa4b

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/bibout.rb", "lib/bibout/bibtex.rb", "lib/bibout/erb_binding.rb")
+  rdoc.generator = 'bootstrap'
+  rdoc.rdoc_dir = 'gh-pages/rdoc'
+end
+

data/bin/bibout

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+#
+#  Author: Charles Sutton <csutton@inf.ed.ac.uk>
+#  Created: 2008-03-03.
+#  Copyright (c) 2008. All rights reserved.
+
+$CURRENT_DIR = "FOOBAR"
+
+require 'bibout'
+require 'optparse'
+
+options = { :template => nil, :output_file => nil }
+
+opts = OptionParser.new
+
+opts.banner = "Usage: bibout [options] <bibfile>"
+opts.on("-tMANDATORY", "--template MANDATORY", "Name of template file") do |tmpl|
+  options[:template] = tmpl
+end
+opts.on("-oFILENAME", "--output FILE_NAME", "Name of output file (if unspecified, uses stdout)") do |ofile|
+  options[:output_file] = ofile
+end
+opts.on("-dDIRECTORY", "--directory DIR", "Base directory for embed() calls in template (default: directory of template)") do |dir|
+  options[:dir] = dir
+end
+opts.on("-r", "--require module1,...,moduleN", Array, "Ruby modules to require before running templates") do |r|
+  options[:require_list] = r
+end
+opts.on_tail("-h", "--help", "Show this message") do
+  puts opts
+  exit
+end
+opts.parse!
+
+bibfile = ARGV[0]
+
+if options[:template].nil? 
+  puts "Error: Missing template file"
+  puts opts
+  abort
+end
+if bibfile.nil? 
+  puts "Error: Missing BibTeX file"
+  puts opts
+  abort
+end
+if not options[:require_list].nil?
+  options[:require_list].each { |x| require x }
+end
+
+#########################################################################
+
+bib = BibTeX.open(bibfile, :filter => :latex)
+bib.replace # substitute all @string mentions
+
+result = BibOut.new(options[:dir]).process_file(bib, options[:template])
+
+if options[:output_file].nil?
+  print (result)
+else
+  File.open(options[:output_file], "w") { |outf| outf << result }
+end
+

data/lib/bibout/bibtex.rb

@@ -0,0 +1,109 @@
+# -*- coding: iso-8859-1 -*-
+# -*- ruby-mode -*-
+# Extensions to 'bibtex-ruby' library that adds some convenience methods.
+
+# Author:: Charles Sutton (mailto:csutton@inf.ed.ac.uk)
+# Copyright:: Copyright (c) 2013 Charles Sutton
+# License:: MIT
+
+
+require 'bibtex'
+
+module BibTeX
+
+  # A list of Symbols naming fields that are commonly used in BibTeX entries.
+  $STANDARD_FIELDS = [
+    :address,
+    :annote,
+    :author,
+    :booktitle,
+    :chapter,
+    :crossref,
+    :edition,
+    :editor,
+    :howpublished,
+    :institution,
+    :journal,
+    :month,
+    :number,
+    :organization,
+    :pages,
+    :publisher,
+    :school,
+    :series,
+    :title,
+    :type,
+    :volume,
+    :year
+  ].freeze
+
+  
+  # This class represents a bibliography, usually a single BibTeX file.
+  #
+  # This is the same class as {BibTeX::Bibliography}[http://rubydoc.info/gems/bibtex-ruby/BibTeX/Bibliography] from bibtex-ruby.
+  # See those class docs for more information.
+  class Bibliography
+
+    #  Returns a list of all values of the specified field type, across all entries in the bibliography
+    #
+    #  This generalizes the names method to arbitrary field types
+    #
+    #  Ex: all_values(:year)
+    #   --> list of all years that appear in the bibliography
+    def all_values(field)
+      return map { |e| e[field] }.flatten.compact.map { |v| v.to_s }.sort.uniq
+    end
+
+    #  Returns a list of all of the Entries in this bibliography,
+    #  sorted by calling the given block. Fixes a problem with the 
+    #  sort_by method in the bibtex-ruby version
+    #  of this class.
+    def sort_by(*arguments, &block)
+      data.sort_by(*arguments, &block)
+    end
+
+    #  Returns a list of all of the Entries in this bibliography,
+    #  sorted by in the specified order. Fixes a problem with bibtex-ruby.
+    def sort(*arguments, &block)
+      data.sort(*arguments, &block)
+    end
+
+  end
+
+  # This class represents a single entry in a bibliography.
+  # This is the same class as {BibTeX::Entry}[http://rubydoc.info/gems/bibtex-ruby/BibTeX/Entry] from bibtex-ruby.
+  # See those class docs for more information.
+  class Entry
+
+    # Returns a copy of this entry that has all non-standard BibTeX fields removed.
+    def minimize
+      result = clone
+      fields.each do |k,v|
+              if not $STANDARD_FIELDS.include? k
+                result.delete k
+              end
+            end
+      result
+    end
+
+  end
+
+
+  # This class represents a list of names.
+  # This is the same class as {BibTeX::Names}[http://rubydoc.info/gems/bibtex-ruby/BibTeX/Names] from bibtex-ruby.
+  # See those class docs for more information.
+  class Names
+
+    # Returns a string containing the list of names in first-last order,
+    # correctly delimited by commas and and
+    def pretty(options={})
+      names = map { |n| n.display_order(options) }
+      return to_s if names.nil? or names.length < 1
+      return names[0].to_s if names.length == 1
+      names[0..-2].join(", ") + " and " + names[-1]
+    end
+
+  end
+
+
+end

data/lib/bibout/erb_binding.rb

@@ -0,0 +1,63 @@
+# Contains variables and methods that are useful for bibout templates.
+# 
+# When a template is formatted using #BibOut.result or ErbBinding#embed,
+# it is evaluated within the context of an ErbBinding object, 
+# so all instance varaibles and methods are available within
+# code blocks of the template.
+class ErbBinding < OpenStruct
+
+  # Name of the base directory for finding any sub-templates using #embed
+  attr_accessor :root_dir
+
+  # The current bibliography being processed. Of type #BibTeX::Bibliography
+  attr_accessor :bib
+
+  # Creates an Erb binding that can be used to process a template.
+  # Params:
+  # +bib+:: Bibliography object to run the template on
+  # +root_dir+:: Name of the directory to run the template in. This is used 
+  # as the "current directory" if sub-templates are called using #embed
+  # +hash+:: Contains any keyword arguments that should be passed to the template
+  def initialize(bib, root_dir, hash=nil)
+    super(hash)
+    @bib = bib
+    @root_dir = root_dir
+  end
+
+  # Processes a given string as a bibout template
+  # Params:
+  # +tmpl+:: String containing text of template to process
+  # +fname+:: Name that should be used to identify template in error messages
+  # +hash+:: Contains any keyword arguments that should be passed to the template
+  def process_string(tmpl, fname='(bibout)', hash=nil)
+    bind = ErbBinding.new(@bib, @root_dir, hash).get_binding()
+    erb = ERB.new(tmpl)
+    erb.filename = fname
+    erb.result(bind)
+  end
+
+  # Processes a file as a bibout template, and returns the result.
+  #
+  # The file is assumed to reside in the directory #@root_dir
+  # Keyword options can be passed to the template.
+  # The sub-template will be passed in the same bibliography as this template.
+  #
+  # Params:
+  # +fname+:: Name of file containing template to process
+  # +hash+:: Contains any keyword arguments that should be passed to the template
+  def embed(fname, hash=nil)
+    if not @root_dir.nil?
+      fname = File.join(@root_dir, fname)
+    end
+    File.open(fname) do |f|
+      tmpl = f.read()
+      process_string(tmpl, fname, hash)
+    end
+  end
+
+  # Should not be called by external users
+  def get_binding
+    return binding()
+  end
+
+end

data/lib/bibout.rb

@@ -0,0 +1,40 @@
+#  Author: Charles Sutton <csutton@inf.ed.ac.uk>
+#  Created: 2008-03-03.
+#  Copyright (c) 2008. All rights reserved.
+
+require 'erb'
+require 'ostruct'
+require 'bibout/bibtex'
+require 'bibout/erb_binding'
+
+# Toplevel class for processing templates.
+# Delegates everything to ErbBinding
+class BibOut
+
+  # Name of a directory containing template files. 
+  # This is used as the base directory when one template is embedded within another.
+  attr_accessor :root_dir
+
+  def initialize(root_dir=nil)
+    @root_dir = root_dir
+  end
+
+  # Processes a file containing a bibout template.
+  # Params:
+  # +bib+:: Name of BibTeX file
+  # +filename+:: Name of BibOut template file
+  def process_file(bib, filename)
+    ErbBinding.new(bib, @root_dir).embed(filename)
+  end
+
+  # Processes a string containing a bibout template.
+  # Params:
+  # +bib+:: Name of BibTeX file
+  # +filename+:: String containing text of BibOut template
+  def process_string(bib, string)
+    ErbBinding.new(bib, @root_dir).process_string(string)
+  end
+
+end
+
+

data/test/test_bib.rb

@@ -0,0 +1,77 @@
+require 'test/unit'
+require 'bibout'
+
+# Tests the extensions that this project makes to
+# BibTeX::Bibliography and friends.
+class BibliographyTest < Test::Unit::TestCase
+
+  def setup
+    current_dir = File.expand_path File.dirname(__FILE__) 
+    @data_dir = File.join(current_dir, "data")
+    @bib = BibTeX.open(File.join(@data_dir, "test.bib"))
+    @bib_sutton = BibTeX.open(File.join(@data_dir, "sutton.bib"), :format => :latex)
+  end
+
+  def test_years
+    years = @bib.all_values(:year).sort
+    assert_equal ["1951", "1953", "1979"], years
+  end
+
+  def test_all_values2
+    vols = @bib.all_values(:volume).sort
+    assert_equal ["21", "22"], vols
+  end
+
+  def test_names_pretty
+    e = @bib["robbins-monro"]
+    name_str = e.author.pretty
+    assert_equal "H. Robbins and S. Monro", name_str
+
+    e = @bib["metropolis"]
+    name_str = e.author.pretty
+    assert_equal "N. Metropolis, A. Rosenbluth, M. Rosenbluth, A. Teller and E. Teller", name_str
+  end
+
+  def test_names_single_pretty
+    e = @bib_sutton["sutton:thesis"]
+    assert_equal "Charles Sutton", e.author.pretty
+  end
+
+  $FUNNY_BIB = <<END
+@book{garey:johnson,
+	Address = {New York, NY, USA},
+	Author = {Garey, Michael R. and Johnson, David S.},
+	Publisher = {W. H. Freeman \& Co.},
+	Title = {Computers and Intractability: A Guide to the Theory of NP-Completeness},
+        Tags = {Classic},
+        InternalCruft = xyzzy,
+	Year = {1979}}
+END
+
+$CLEAN_BIB = <<END
+@book{garey:johnson,
+  address = {New York, NY, USA},
+  author = {Garey, Michael R. and Johnson, David S.},
+  publisher = {W. H. Freeman & Co.},
+  title = {Computers and Intractability: A Guide to the Theory of NP-Completeness},
+  year = {1979}
+}
+END
+
+  def test_minimize
+    entry = BibTeX.parse($FUNNY_BIB)[0]
+    entry2 = entry.minimize
+    assert_equal $CLEAN_BIB, entry2.to_s
+  end
+
+  def test_bib_sort_by
+    entries = @bib.sort_by { |e| e.year }
+    assert_equal ["robbins-monro", "metropolis", "garey:johnson"], entries.map { |e| e.key }
+  end
+
+  def test_bib_sort
+    entries = @bib.sort { |e1,e2| e1.year <=> e2.year }
+    assert_equal ["robbins-monro", "metropolis", "garey:johnson"], entries.map { |e| e.key }
+  end
+
+end

data/test/test_bibout.rb

@@ -0,0 +1,109 @@
+require 'test/unit'
+require 'bibout'
+
+class BiboutTest < Test::Unit::TestCase
+
+  def setup
+    current_dir = File.expand_path File.dirname(__FILE__) 
+    @data_dir = File.join(current_dir, "data")
+    @bib = BibTeX.open(File.join(@data_dir, "test.bib"))
+    @tmpl1 = <<ENDTMPL
+<% bib.each do |entry| %>
+<%= entry.key %>
+<%end%>
+ENDTMPL
+  end
+
+  $RESULT1 = <<END 
+
+garey:johnson
+
+robbins-monro
+
+metropolis
+
+END
+
+  def test_tmpl1
+    result = BibOut.new.process_string(@bib, @tmpl1)
+    assert_equal $RESULT1, result
+  end
+
+  def test_embed
+    result = BibOut.new(@data_dir).process_file(@bib, "root.tmpl")
+    assert_equal $RESULT1, result
+  end
+
+  $BY_YEAR_RESULT = <<END
+
+
+1951
+
+Robbins, H. and Monro, S.. A stochastic approximation method. 1951.
+
+
+1953
+
+Metropolis, N. and Rosenbluth, A. and Rosenbluth, M. and Teller, A. and Teller, E.. Equations of state calculations by fast computing machines. 1953.
+
+
+1979
+
+Garey, Michael R. and Johnson, David S.. Computers and Intractability: A Guide to the Theory of NP-Completeness. 1979.
+
+
+END
+
+  def test_by_year
+    result = BibOut.new(@data_dir).process_file(@bib, "by_year.tmpl")
+    assert_equal $BY_YEAR_RESULT, result
+  end
+
+  $RESULT2 = <<END 
+
+garey:johnson
+
+robbins-monro
+
+metropolis
+
+
+garey:johnson
+
+robbins-monro
+
+metropolis
+
+END
+
+  def test_double_embed
+    result = BibOut.new(@data_dir).process_file(@bib, "double_embed.tmpl")
+    assert_equal $RESULT2, result
+  end
+
+$EMBED2_RESULT = <<END
+<html>
+   <body>
+     <div id="text">
+
+
+<h2>Dissertation</h2>
+<ol>
+
+   <li>Computers and Intractability: A Guide to the Theory of NP-Completeness
+</li>
+
+</ol>
+
+
+      </div>
+   </body>
+</html>
+END
+
+  def test_embed2
+    result = BibOut.new(@data_dir).process_file(@bib, "embed2_root.tmpl")
+    assert_equal $EMBED2_RESULT, result
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: bibout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Sutton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Converts BibTeX files into pretty output using arbitrary user-specified
+  templates, which can contain arbitrary Ruby code using ERB.
+email: csutton@inf.ed.ac.uk
+executables:
+- bibout
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/bibout.rb
+- lib/bibout/bibtex.rb
+- lib/bibout/erb_binding.rb
+- test/test_bibout.rb
+- test/test_bib.rb
+- bin/bibout
+homepage: http://rubygems.org/gems/bibout
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: BibTeX formatter
+test_files:
+- test/test_bibout.rb
+- test/test_bib.rb