quickcite 1.0.3 → 1.0.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    quickcite (1.0.2)
+    quickcite (1.0.3)
       bibtex-ruby (>= 2.0)
       json
 

data/lib/quickcite.rb

@@ -11,9 +11,19 @@ require "quickcite/citeulike"
 require "quickcite/dblp"
 
 module QuickCite
-  CITE_REGEX = /\\cite\{([^\}]+)\}/
+  CITE_REGEX = /\\cite[tp]?\{([^\}]+)\}/
   SPLIT_REGEX = /([A-Z]+[a-z]+|[0-9]+|[^\\p]+)/
   
+  class Result < Struct.new(:title, :venue, :authors, :url, :date)    
+    def initialize(hash)
+      super(*hash.values_at(:title, :venue, :authors, :url, :date))
+    end
+  end
+  
+  def self.run(latex_files, bibtex_file)
+    Main.new(latex_files, bibtex_file)
+  end
+  
   # Convert a citation reference (e.g "PowerPiccolo2008") into a
   # list of strings appropriate for submission to a search engine.
   #
@@ -21,13 +31,23 @@ module QuickCite
   def self.cite_to_query(cite)
     cite.scan(SPLIT_REGEX).map { |w| w[0] }
   end
-
+  
+  # Query the user for a result from the result list to 
+  # use for this citation reference.  
+  # 
+  # Returns the selected reference or nil if no match
+  # was selected.
   def self.ask_user(cite, result_list)
+    if result_list.empty? then
+      return nil
+    end
+    
     puts "Result to use for \{#{cite}\}: "
     puts "  (0) Skip this citation"
     result_list.each_with_index do |r, idx|
-      puts "  (#{idx + 1}) #{r.title}"
-      puts "      #{r.authors.join(', ')}"
+      puts "  (#{idx + 1}) #{r.title} (#{r.date})"
+      puts "      Authors: #{r.authors.join(', ')}"
+      puts "      Venue: #{r.venue}"
     end
     
     c = HighLine::SystemExtensions::get_character.chr.to_i
@@ -35,7 +55,7 @@ module QuickCite
       return result_list[c - 1]
     end
   end
-
+  
   class Main
     include QuickCite
     def initialize(latex_files, bibtex_file)
@@ -45,13 +65,13 @@ module QuickCite
         puts "Bibtex file #{bibtex_file} does not exist.  Creating an empty file."
         open(bibtex_file, "w").write("")
       end
-
+      
       @bib = BibTeX.open(bibtex_file, :include => [:meta_content])
-        
-      latex_files.each do|f|
+      
+      latex_files.each { |f|
         puts("Processing... #{f}")
         process_latex(f)
-      end
+      }
       
       puts("Writing bibtex...")
       outfile = open(bibtex_file, "w")
@@ -64,7 +84,7 @@ module QuickCite
       e.key = cite
       @bib << e
     end
-
+    
     def process_cite(cite)
       if @bib.has_key?(cite) then
         puts("Skipping matched reference #{cite}")
@@ -81,19 +101,14 @@ module QuickCite
         end
       end
     end
-
+    
     def process_latex(f)
       latex = File.read(f)
-      latex.scan(CITE_REGEX) do|m|
-        m[0].split(",").map do|c|
+      latex.scan(CITE_REGEX) { |m|
+        m[0].split(",").map  { |c|
           process_cite(c)
-        end
-      end
-      puts(f)
+        }
+      }
     end
   end
-
-  def self.run(latex_files, bibtex_file)
-    Main.new(latex_files, bibtex_file)
-  end
 end

data/lib/quickcite/citeulike.rb

@@ -6,7 +6,7 @@
 
 require "net/http"
 require "uri"
-require "quickcite/json"
+require "json"
 
 module QuickCite
   class CiteULike
@@ -19,7 +19,7 @@ module QuickCite
       request = Net::HTTP::Get.new(SEARCH_BASE)
       request.set_form_data({ "q" => query })
       response = http.request(request)
-      js = JSONUtil.Parse(response.body)
+      js = JSON.parse(response.body)
       return js
     end
     

data/lib/quickcite/dblp.rb

@@ -6,7 +6,7 @@
 
 require "net/http"
 require "nokogiri"
-require "quickcite/json"
+require "json"
 require "uri"
 
 module QuickCite
@@ -15,34 +15,52 @@ module QuickCite
     # the q= argument has to come first.
     SEARCH_BASE = "http://www.dblp.org/search/api/?"
     SEARCH_SUFFIX = "&c=4&f=0&format=json&h=10"
-
-    Result = Struct.new("Result", :title, :authors, :url)
+    
+    def hit_to_result(h)
+      t = h["title"]
+      title = t["dblp:title"]["text"]
+      venue = t["dblp:venue"]["text"]
+      authors = t["dblp:authors"]["dblp:author"]
+      date = t["dblp:year"].to_s
+      Result.new(
+        :title => title, 
+        :authors => authors.to_a, 
+        :url => h["url"], 
+        :venue => venue,
+        :date => date)
+    end
+    
     def search(query)
-      #      json = JSONUtil.parse(File.read("test/power-piccolo.json"))
+      #json = JSON.parse(File.read("test/foobar.json"))
       query_str = "q=" + URI::escape(query.join(" "))
       uri = URI::parse(SEARCH_BASE + query_str + SEARCH_SUFFIX)
       
+      puts("Fetching from #{uri}")
+      
       response = Net::HTTP::get(uri)
-      json = JSONUtil.parse(response)
-
-      json.result.hits.hit.map do |h|
-        Result.new(
-        h.title["dblp:title"].text,
-        h.title["dblp:authors"]["dblp:author"].to_a,
-        h.url)
+      json = JSON.parse(response)
+      
+      hits = json["result"]["hits"]["hit"]
+      
+      # NB.  when there is only a single result DBLP returns a single
+      # hit element instead of an array.
+      case hits
+      when Array 
+        hits.map {  |h| hit_to_result(h) }
+      else
+        [hit_to_result(hits)]
       end
     end
-
+    
     def bibtex(result)
       #      dom = Nokogiri.Slop(open("test/power-piccolo.html"))
-      puts("RESULT #{result.url}")
       dom = Nokogiri.Slop Net::HTTP.get(URI::parse(result.url))
       entries = dom.html.body.pre
       case entries
-        when Nokogiri::XML::NodeSet
-          return entries[0].to_str
-        else
-          return entries.to_str
+      when Nokogiri::XML::NodeSet
+        return entries[0].to_str
+      else
+        return entries.to_str
       end
     end
   end

data/lib/quickcite/version.rb

@@ -1,3 +1,3 @@
 module QuickCite
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/test/foobar.json

@@ -0,0 +1,50 @@
+{
+"result":{
+"query":"Foo Bar",
+"status":
+{
+"@code":12,"text":"OK"
+},
+"time":{
+"@unit":"msecs",
+"text":2.73
+},
+"completions":{
+"@total":1,
+"@computed":1,
+"@sent":1,
+"c":{
+"@sc":2,
+"@dc":1,
+"@oc":1,
+"@id":612166,
+"text":"bar"
+}
+},
+"hits":{
+"@total":1,
+"@computed":1,
+"@sent":1,
+"@first":0,
+"hit":{
+"@score":102,
+"@id":2014945,
+"title":{
+"dblp:authors":{
+"dblp:author":[
+"Chee-Kit Looi",
+"Foo-Keong Ng",
+"Tek-Hong Kho"]},
+"dblp:title":{
+"@ee":"http://www.booksonline.iospress.nl/Content/View.aspx?piid=7515",
+"text":"Technology-Enabled Pedagogy to Bridge Bar Diagrams to Letter-Symbolic Algebra. "},
+"dblp:venue":{
+"@url":"db/conf/icce/icce2007.html#LooiNK07",
+"text":"ICCE 2007:29-36"},
+"dblp:year":2007,
+"dblp:type":"inproceedings"},
+"url":"http://www.dblp.org/rec/bibtex/conf/icce/LooiNK07"
+}
+}
+}
+}

data/test/test_quickcite.rb

@@ -1,17 +1,9 @@
 #!/usr/bin/env ruby
 
 require "quickcite"
-require "quickcite/json"
 
 require "test/unit"
 
-class TestJson < Test::Unit::TestCase
-  def test_simple()
-    v = QuickCite::JSONUtil.parse(File.read('test/power-piccolo.json'))
-    v.result.hits.hit.map { |h| puts(h.url) }
-  end
-end
-
 class TestMain < Test::Unit::TestCase
   def test_simple()
   texfile = open("/tmp/test.tex", "w")
@@ -19,6 +11,7 @@ class TestMain < Test::Unit::TestCase
   This is a test latex file.
 I like to cite \\cite{PowerPiccolo}
 And \\cite{MapreduceDean}
+ANd \\citet{FooBar}
 END
   texfile.close
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: quickcite
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Russell Power
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-18 00:00:00 Z
+date: 2012-07-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bibtex-ruby
@@ -84,10 +84,10 @@ files:
 - lib/quickcite.rb
 - lib/quickcite/citeulike.rb
 - lib/quickcite/dblp.rb
-- lib/quickcite/json.rb
 - lib/quickcite/version.rb
 - quickcite.gemspec
 - test/dean.html
+- test/foobar.json
 - test/power-piccolo.html
 - test/power-piccolo.json
 - test/test_quickcite.rb

data/lib/quickcite/json.rb

@@ -1,46 +0,0 @@
-# JSON utilities.
-require "json"
-
-module QuickCite
-  module JSONUtil
-    class JSONDict
-      extend Forwardable
-      include Enumerable
-      attr_reader :dict
-      
-      def initialize(d)
-        @dict = d
-      end
-      
-      def method_missing name, *args
-        return JSONUtil._wrap(@dict[name.to_s])
-      end
-      
-      def [](key)
-        JSONUtil._wrap(@dict[key])
-      end
-      
-      def each
-        case @dict
-          when Hash
-            @dict.each_key { |k| yield self[k] }
-          when Array
-            @dict.each_index { |k| yield self[k] }
-         end
-      end
-    end
-
-    def self._wrap(value)
-      case value
-        when Hash, Array
-          JSONDict.new(value)
-        else
-          value
-        end
-    end
- 
-    def self.parse(str)
-      d = JSONDict.new(JSON.parse(str))
-    end
-  end
-end