rbibtex 0.0.2 → 0.1.0

data/CHANGELOG

@@ -1,3 +1,21 @@
+0.1.0
+  * ! Incompatible API change. Removed entry.properties property. The data can
+    now be accessed as described below. !
+  * ! More incompatible changes. Renamed File to BibTeXFile, though I'm not yet
+    satisfied with the name. More changes can be expected. !
+  * Now parsing and interpreting strings. See BibTeXFile#interpolate.
+  * Moved common transformation logic into the library
+  * Made entry directly accessible like a hash. That allows to sort also by key
+    and type
+  * Made entry access case / type insensitive. 
+    (I.e. entry["Title"] = entry["title"] = entry[:TITLE])
+  * Made entry accessible by method also. (I.e. entry[:Title] = entry.title
+  * Made entry use Enumerable for all the goodness of it. Each iterates about
+    all properties except key and type.
+  * Allow second line to be indented
+  * Added some documentation
+  * Added some unit tests (fixing a few layout bugs on the way. Should have done TDD).
+
 0.0.2
   * Simplified Grammar a bit
   * Now parsing @comment correctly

data/README

@@ -53,12 +53,14 @@ Brian
 * The binaries are only quick hacks for my specific applications right now,
   they should be rewritten and extended.
 * I should transfer functionality from rbib2bib into a library usable by all
-  programs.
+  programs. (Partially done)
 * The full bibtex format is not parsed, I only allow for a specific subset
-  right now.  
-* Escaping is not implemented.
+  right now. (May be done, I'm not quite sure what is the exact standard)
+* Add automatic abbreviation creation as a fun quiz.
 * Create the documentation after having racc'ed the .y files, then cleanup
   again before packaging.
+* Move string handling code into module, such that we no longer trample around
+  in the standard library.
   
 ## Authors
 This was implemented by Brian Schroeder.

data/bin/rbib2bib

@@ -1,147 +1,117 @@
 #! /home/bschroed//bin/ruby
-
-# Some string handling routines for wordwrapping and tabifying.
-class String
-  def wrap(width = 78, tabwidth = 8)
-    raise "Invalid width" if width < 0
-    self.untabify(tabwidth).
-      gsub(/.{1,#{width}}(?:\s|\Z)/) { ($& + 5.chr).gsub(/\n\005/,"\n").gsub(/\005/,"\n") }.
-    gsub(/\s*\Z/m, "")
-  end
-
-  def indent_hanging(indent = 2)
-    self.gsub(/\n/, "\n#{" " * indent}")
-  end
-
-  def indent(indent = 2)
-    self.gsub(/^/, " " * indent)
-  end
-
-
-  def untabify(tab_width = 8)
-    self.gsub(/\t/, " "*tab_width)
+# 
+# Pretty print a bibtex file.
+#
+# (c) 2005 Brian Schroeder
+#
+# http://ruby.brian-schroeder.de/rbibtex/
+#
+
+require "rbibtex"
+require "rbibtex/transform"
+require 'optparse'
+
+include BibTeX
+# Define Interface
+class B2BOptions < OptionParser
+  VERSION = "0.0.3"
+  
+  attr_reader :wrap, :wrap_width, :comment, :interpolate
+
+  def initialize
+    super()
+
+    # Defaults
+    @comment = true
+    @wrap = true
+    @wrap_width = 78
+
+    # Parser Actions
+    self.banner = "Usage: #{ __FILE__ } [-o OUTPUT] [OPTIONS] INPUT [INPUT_1 ...]"
+    self.separator ""
+    self.separator "Formatting"
+    self.on("-C", "--no-comment",
+	    "Suppress generation of 'Created by' comment.")       {       @comment   = false }
+    self.on("-w", "--wrap [WIDTH]", Integer,
+	    "Reformat and wrap text (the default).")              { | w | @wrap_width = w || @wrap_width; @wrap   = true }
+    self.on("-W", "--no-wrap",
+	    "Do not reformat and wrap text.")                     {       @wrap   = false }
+    self.on("-S", "--interpolate-strings",
+	    "Replace abbreviations by their full string.")        {       @interpolate   = true }
   end
 
-  def deindent_hanging(indent = [self[/^\s*/].untabify.length, self[/\n(\s*)/, 1].to_s.untabify.length].max)
-    self.untabify.gsub(/^\s{0,#{indent}}/, "")
+  def parse!(*args)      
+    super
   end
 
-  def deindent(indent = self[/^\s*/].untabify.length)
-    self.untabify.gsub(/^\s{0,#{indent}}/, "")
-  end
-
-  def unwrap
-    self.split(/\n\n+/).map { | paragraph |
-      paragraph.gsub(/((?:\n|^)\S[^\n]*)\n(?=\S)/, "\\1 ")
-    }.join("\n\n")
-  end
+  include Options::ApplicationOptions
+  include Options::SortOptions
+  include Options::SortFieldsOptions
 end
 
-module Bib2Bib
-  VERSION = "0.0.2"
-
-  require 'optparse'
-
-  class Options < OptionParser
-    attr_reader :wrap, :sort_by, :top_fields, :bottom_fields, :output, :help, :show_version, :comment
-
-    def initialize
-      super()
-
-      # Defaults
-      @top_fields    = [:author, :title, :year]
-      @bottom_fields = [:note, :pdf, :ps, :www]    
-      @comment = true
-      @output = STDOUT
-
-      # Parser Actions
-      self.banner = "Usage: #{ __FILE__ } [-o OUTPUT] [OPTIONS] INPUT [INPUT_1 ...]"
-      self.on("-o FILENAME", "--output FILENAME", String,
-	      "Set the output filename. Writes to stdout if nothing is given")   { | v | @output   = File.open(v, 'w') }
-      self.on("-s", "--sort-by", "--sort_by Field_1,Field2,...", Array,
-	      "Specify fields that shall be used for sorting of the file")       { | v | @sort_by  = v.map { | e | e.downcase.to_sym  } }
-      self.on("-t", "--top_fields Field_1,Field2,...", Array,
-	      "Specify a list of fields that are written first in the output")   { | v | @top_fields     = v.map { | e | e.downcase.to_sym }
-											 @bottom_fields -= @top_fields }
-      self.on("-b", "--bottom_fields Field_1,Field2,...", Array,
-	      "Specify a list of fields that are written last in the output")    { | v | @bottom_fields  = v.map { | e | e.downcase.to_sym }
-		                                                                         @top_fields -= @bottom_fields }
-      self.on("-C", "--no-comment",
-	      "Suppress generation of 'Created by' comment")                     {       @comment   = false }
-      self.on("-?", "--help",
-	      "Show this help")                                                  {       @help     = true }
-      self.on("-v", "--version", 
-	      "Output version number and exit")                                  {       @show_version = true }
-    end
-
-    def parse!(*args)      
-      super
-      raise "You can't specify an empty list of fields for sorting" if @sort_by and @sort_by.empty?
-    end
-  end
-
-  options = Options.new
-  begin
-    options.parse!(ARGV)
-  rescue => e
-    puts "Invalid Commandline Arguments"
-    puts e
-    puts options
-    exit
-  end
-
-  if options.show_version
-    puts VERSION 
-    exit
-  end
-
-  if options.help
-    puts options
-    exit
-  end
+# Parse the options
+options = B2BOptions.new
+begin
+  options.parse!(ARGV)
+rescue => e
+  puts "Invalid Commandline Arguments"
+  puts e
+  puts options
+  exit
+end
 
-  require "rbibtex"
+file = BibTeXFile.parse( ARGF.read )
+file.normalize!
+file.interpolate! if options.interpolate 
+O = options.output
 
+if @comment
+  O.puts "@comment { Pretty Printed using rbib2bib }"
+end
 
-  entries = BibTeX::Parser.new.parse( ARGF.read )
-  O = options.output
+# Calculate maximum key length
+max_key_length = file.entries.inject(0) { | r, entry |
+  entry.inject(r) { | r, (k, _) |
+    [r, k.to_s.length].max
+  }
+}
 
-  if @comment
-    O.puts "@comment { Pretty Printed using rbib2bib }"
-  end
+def extract_properties(properties, fields)
+  fields.map    { | k | [k, properties.delete(k)] }.select { | (_, v) | v }
+end
 
-  # Calculate maximum key length
-  max_key_length = entries.entries.inject(0) { | r, entry |
-    entry.properties.inject(r) { | r, (k, _) |
-      [r, k.to_s.length].max
-    }
-  }
+def rewrap(text, indent, width)    
+  text.to_str.deindent_hanging.unwrap.wrap(width - indent).indent_hanging(indent)
+end
 
-  def self.extract_properties(properties, fields)
-    fields.map    { | k | [k, properties.delete(k)] }.select { | (_, v) | v }
-  end
+if options.sort_by
+  file.sort_by(*options.sort_by)
+end
 
-  elements = entries.elements.select { | e | e.is_a?(BibTeX::Entry) or e.is_a?(BibTeX::Comment) }
-  if options.sort_by
-    elements = elements.sort_by { | e | e.is_a?(BibTeX::Comment) ? [] : options.sort_by.map { | k | e.properties[k] || "" } }
-  end
-  puts elements.map { | entry |
+reformat = if options.wrap	     
+	     lambda do | text, indent | rewrap(text, indent, options.wrap_width).remove_trailing_whitespace end
+	   else
+	     lambda do | text, indent | text.remove_trailing_whitespace end
+	   end
+
+puts file.elements.map { | element |
+  
+  if element.is_a?Comment
+    "@comment { #{reformat[element, 11]} }"
+  elsif element.is_a?Abbreviation
+    %(@string{#{element.key} = #{reformat[element.string.to_bib, max_key_length + 6]}})
+  else
+    properties = element.inject({}) { | r, (k, v) | r[k] = v; r }
+    top    = extract_properties(properties, options.top_fields)
+    bottom = extract_properties(properties, options.bottom_fields)
+    middle = properties.to_a.map { | (k, v) | [k.to_s, v] }.sort
     
-    if entry.is_a?BibTeX::Comment
-      "@comment { #{entry.to_s.deindent_hanging.unwrap.wrap(78 - 11).indent_hanging(11)} }"
-    else
-      properties = entry.properties.dup
-      top    = extract_properties(properties, options.top_fields)
-      bottom = extract_properties(properties, options.bottom_fields)
-      middle = properties.to_a.map { | (k, v) | [k.to_s, v] }.sort
-      
-      "@#{entry.type}{#{entry.key},\n" +
-      (
-	(top + middle + bottom).map { | (k, v) |
-	 %(  #{k}).ljust(max_key_length+2) + " = {#{v.deindent_hanging.unwrap.wrap(78-(max_key_length+6)).indent_hanging(max_key_length+6)}}"
-	}.join(",\n")
-      ) + "\n}"
-    end
-  }.join("\n\n\n")
+    "@#{element.type}{#{element.key},\n" +
+    (
+      (top + middle + bottom).map { | (k, v) |
+        %(  #{Entry::CAPITALIZATION[k]}).ljust(max_key_length+2) + " = " + reformat[v.to_bib, max_key_length + 6]
+      }.join(",\n")
+    ) + "\n}"
+  end
+}.join("\n\n\n")
 
-end

data/bin/rbib2html

@@ -1,13 +1,61 @@
 #! /home/bschroed//bin/ruby
 
-$:.unshift("~/lib/ruby")
-
 require "rbibtex"
+require "rbibtex/transform"
+require 'optparse'
+
+include BibTeX
+# Define Interface
+class B2HTMLOptions < OptionParser
+  VERSION = "0.0.3"
+  
+  attr_reader :wrap, :wrap_width, :comment, :interpolate
 
-parser = BibTeX::Parser.new
-file = parser.parse( ARGF.read )
+  def initialize
+    super()
 
-puts <<HTML_HEADER
+    # Defaults
+    @comment = true
+    @wrap = true
+    @wrap_width = 78
+
+    # Parser Actions
+    self.banner = "Usage: #{ __FILE__ } [-o OUTPUT] [OPTIONS] INPUT [INPUT_1 ...]"
+    self.separator ""
+    self.separator "Formatting"
+    self.on("-C", "--no-comment",
+	    "Suppress generation of 'Created by' comment.")       {       @comment   = false }
+  end
+
+  def parse!(*args)      
+    super
+  end
+
+  include Options::ApplicationOptions
+  include Options::SortOptions
+end
+
+# Parse the options
+options = B2HTMLOptions.new
+begin
+  options.parse!(ARGV)
+rescue => e
+  puts "Invalid Commandline Arguments"
+  puts e
+  puts options
+  exit
+end
+
+file = BibTeXFile.parse( ARGF.read )
+file.normalize!
+file.interpolate!
+O = options.output
+
+if options.sort_by
+  file.sort_by(*options.sort_by)
+end
+
+O.puts <<HTML_HEADER
 <html>
   <head>
     <style type="text/css">
@@ -19,33 +67,38 @@ puts <<HTML_HEADER
     </style>
   </head>
   <body>
+  <h1>Bibliography created from #{ARGV.inspect}</h1>
 HTML_HEADER
 
+
 first = [:author, :title, :year]
 last  = [:note]
 links = [:pdf, :ps]
 
-file.each do | entry |
+file.entries.each do | entry |
   
-  p = entry.properties.dup
+  p = entry.inject({}) { | r, (k, v) | r[k] = v; r }
   f = first.map { | k | [k, p.delete(k)] }
   l = last.map { | k | [k, p.delete(k)] }
   a = links.map { | k | [k, p.delete(k)] }
   p = p.to_a.map{ | (k, v) | [k.to_s, v] }.sort
   
-  puts %(<div class="entry">)
+  O.puts %(<div class="entry">)
   (f + p).each do | (k, v) |
-    puts %(<span class="#{k}">#{v}</span>)
+    O.puts %(<span class="#{k}">#{v}</span>)
   end
-  puts %(<span class="links")
+  O.puts %(<span class="links")
   a.each do | k, v |
-    puts %(<a href="#{v}">#{k}</a>)
+    O.puts %(<a href="#{v}">#{k}</a>)
   end
-  puts %(</span)
+  O.puts %(</span)
   (l).each do | (k, v) |
-    puts %(<span class="#{k}">#{v}</span>)
+    O.puts %(<span class="#{k}">#{v}</span>)
   end
-  puts %(</div>)
+  O.puts %(</div>)
 end
 
-puts "</body></html>"
+if @comment
+  O.puts %(<div class="comment">Pretty Printed using rbib2bib</div>)
+end
+O.puts "</body></html>"

data/bin/rbib2txt

@@ -1,41 +1,111 @@
 #! /home/bschroed//bin/ruby
-
-$:.unshift("~/lib/ruby")
+# 
+# Convert a bibtex file to plain text
+#
+# (c) 2005 Brian Schroeder
+#
+# http://ruby.brian-schroeder.de/rbibtex/
+#
 
 require "rbibtex"
+require "rbibtex/transform"
+require 'optparse'
 
-parser = BibTeX::Parser.new
-file = parser.parse( ARGF.read )
+include BibTeX
+# Define Interface
+class B2TXTOptions < OptionParser
+  VERSION = "0.0.3"
+  
+  attr_reader :wrap, :wrap_width, :comment, :interpolate
 
-first = [:author, :title, :year]
-last  = [:note]
-links = [:pdf, :ps]
+  def initialize
+    super()
 
-file.each do | entry |
-  
-  p = entry.properties.dup
-  f = first.map { | k | [k, p.delete(k)] }
-  l = last.map { | k | [k, p.delete(k)] }
-  a = links.map { | k | [k, p.delete(k)] }
-  p = p.to_a.map{ | (k, v) | [k.to_s, v] }.sort
-  
-  puts
-  (f + p).each do | (k, v) |
-    next unless v
-    print %(  #{k}: ).ljust(20)
-    puts v.gsub(/\n\s*/, "\n" + (" " * 20))
-  end
-  (l).each do | (k, v) |
-    next unless v
-    print %(  #{k}: ).ljust(20)
-    puts v.gsub(/\n\s*/, "\n" + (" " * 20))
+    # Defaults
+    @comment = true
+    @wrap = true
+    @wrap_width = 78
+
+    # Parser Actions
+    self.banner = "Usage: #{ __FILE__ } [-o OUTPUT] [OPTIONS] INPUT [INPUT_1 ...]"
+    self.separator ""
+    self.separator "Formatting"
+    self.on("-C", "--no-comment",
+	    "Suppress generation of 'Created by' comment.")       {       @comment   = false }
+    self.on("-w", "--wrap [WIDTH]", Integer,
+	    "Reformat and wrap text (the default).")              { | w | @wrap_width = w || @wrap_width; @wrap   = true }
+    self.on("-W", "--no-wrap",
+	    "Do not reformat and wrap text.")                     {       @wrap   = false }
   end
-  a.each do | k, v |
-    next unless v
-    print %(  #{k}: ).ljust(20)
-    puts v.gsub(/\n\s*/, "\n" + (" " * 20))
+
+  def parse!(*args)      
+    super
   end
-  puts
-  puts "-" * 80
+
+  include Options::ApplicationOptions
+  include Options::SortOptions
+  include Options::SortFieldsOptions
+end
+
+# Parse the options
+options = B2TXTOptions.new
+begin
+  options.parse!(ARGV)
+rescue => e
+  puts "Invalid Commandline Arguments"
+  puts e
+  puts options
+  exit
 end
 
+file = BibTeXFile.parse( ARGF.read )
+file.normalize!
+file.interpolate!
+O = options.output
+
+if @comment
+  O.puts "# Pretty Printed using rbib2bib"
+end
+
+# Calculate maximum key length
+max_key_length = file.entries.inject(0) { | r, entry |
+  entry.inject(r) { | r, (k, _) |
+    [r, k.to_s.length].max
+  }
+}
+
+def extract_properties(properties, fields)
+  fields.map    { | k | [k, properties.delete(k)] }.select { | (_, v) | v }
+end
+
+def rewrap(text, indent, width)    
+  text.to_str.deindent_hanging.unwrap.wrap(width - indent).indent_hanging(indent)
+end
+
+if options.sort_by
+  file.sort_by(*options.sort_by)
+end
+
+reformat = if options.wrap	     
+	     lambda do | text, indent | rewrap(text, indent, options.wrap_width).remove_trailing_whitespace end
+	   else
+	     lambda do | text, indent | text.remove_trailing_whitespace end
+	   end
+
+puts file.elements.map { | element |
+  
+  if element.is_a?Comment
+    reformat[element, 11].gsub(/^/, "#  ")
+  elsif element.is_a?Abbreviation
+  else
+    properties = element.inject({}) { | r, (k, v) | r[k] = v; r }
+    top    = extract_properties(properties, options.top_fields)
+    bottom = extract_properties(properties, options.bottom_fields)
+    middle = properties.to_a.map { | (k, v) | [k.to_s, v] }.sort
+    
+    (top + middle + bottom).map { | (k, v) |
+      %(#{Entry::CAPITALIZATION[k]}:).ljust(max_key_length) + "  " + reformat[v.to_s, max_key_length + 2]
+    }.join("\n") + "\n" + \
+    (%(Type:).ljust(max_key_length) + "  " + reformat[element.type, max_key_length + 2])
+  end
+}.join("\n\n" + ("-" * options.wrap_width) + "\n\n")

data/lib/rbibtex/pre-setup.rb

@@ -1,5 +1,5 @@
 # pre-setup.rb
 
 # process grammer file
-system "racc rbibtex.y"
+system "racc -g rbibtex.y"