dblp 0.0.1 → 0.2.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.0.1 2008-05-29
+
+* added documentation and more command line options
+
+
 == 0.0.1 2008-05-28
 
 * 1 major enhancement:

data/README.txt

@@ -1,26 +1,25 @@
 = dblp
 
-* FIX (url)
-
 == DESCRIPTION:
 
-FIX (describe your package)
+DBLP is a command line tool to fetch required bibtex entries directly from the DBLP servers. The idea is, that you don't have to maintain all entries in your own file, but youse well known bibtex identifiers instead and then fetch them from DBLP.
+
 
-== FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+The first step is to build your latex document, so that dblp can parse the aux file for your document. Now call
 
-== REQUIREMENTS:
+	dblp my_tex_file[|.tex|.aux]
+	
+and this will scan for the citation commands in the aux file. The defined keys will be used to query DBLP. If an entry is available it is saved and as a result stored in the dblp.bib file. To use it in your Latex document just use \bibliography{my_own_file,..., dblp}
 
-* FIX (list of requirements)
+For more command line options see
 
-== INSTALL:
+	dblp --help
+	
 
-* FIX (sudo gem install, anything else)
 
 == LICENSE:
 

data/bin/dblp

@@ -10,7 +10,48 @@ rescue LoadError
 end
 
 require 'dblp'
+require 'optparse'
+require 'ostruct'
 
-Dblp::run(ARGV.first)
+opt = OpenStruct.new
+opt.output = "dblp.bib"
+opt.bibtex = true
+
+if ARGV.size == 0
+  ARGV << "-h"
+end
+
+unless ARGV[0] == "-h"
+  file_to_parse = ARGV.shift
+end
+
+OptionParser.new do |opts|
+  
+  opts.banner = <<BANNER
+DBLP is a command line tool to fetch required bibtex entries 
+directly from the DBLP servers. The idea is, that you don't 
+have to maintain all entries in your own file, but youse well 
+known bibtex identifiers instead and then fetch them from DBLP.
+BANNER
+  
+  opts.separator("")
+  opts.separator("Specific Options:")
+  
+  opts.on("-o", "--output [FILENAME]", "Specify FILENAME for output instead of dblp.bib") do |fn|
+    opt.output = fn
+  end
+  
+  opts.on("-b", "--[no-]bibtex", "Run Bibtex after fetching bib entries") do |b|
+    opt.bibtex = b
+  end
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+
+Dblp::run(file_to_parse, opt)
 
 # do stuff

data/lib/dblp/version.rb

@@ -1,8 +1,8 @@
 module Dblp #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 1
+    MINOR = 2
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/dblp.rb

@@ -8,16 +8,30 @@ module Dblp
   
   class << self
 
-    def run(file, out = "dblp.bib")
+    def run(file, options)
+      
+      # Clean file to parse
+      file = File.basename(file, File.extname(file)) + ".aux"
+      overall_size = 0
       
       parser = Dblp::Parser.new(file)
       grabber = Dblp::Grabber.new
-      File.open(out, "w+") do |f|
+      File.open(options.output, "w+") do |f|
         f.puts parser.parse.inject({}) {|m, l| 
             m.merge!(grabber.grab(l))
+            overall_size = m.size
             m
           }.values.join("\n")
       end
+      
+      if options.bibtex
+        res = system("bibtex #{File.basename(file, File.extname(file))}")
+        puts res
+      end
+      
+      # Output
+      puts "Stored #{overall_size} entries in #{options.output}"
+      
     end
   
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dblp
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Martin Grund