bibtex-cleaner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f45e5cbb472cb8b143af18667b38ba94917e8bac
+  data.tar.gz: de896821da019dc7b3008a835b58d127b22cc1fd
+SHA512:
+  metadata.gz: de3edb96472a17fd7d04cf1cb1c422ab2f6c78492dbb9a4d1bd437194ad3d508f9ccfcca0e06052d67ca77b82b1b45668a13ce209f9264dcb9cd8df8b3c98717
+  data.tar.gz: b62855b6ab7bc5954ea4fe464242f555ce747dce07bba96482b831455dbf16b71136aeb05f76b3d444c96b3ec03c45054b40d1bc486be6f148e19a187dc8ce33

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem "cites", git: "https://github.com/sckott/cites.git"
+gem "google-scholar", git: "https://github.com/tpendragon/ruby-google-scholar.git"
+gem "gscholar", git: "https://github.com/5kg/gscholar.git"
+gem "dblp", git: "https://github.com/grundprinzip/dblp.git"
+gem "levenshtein"
+
+group :dev do
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Tim Felgentreff
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Bibtex::Cleaner
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bibtex-cleaner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bibtex-cleaner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bibtex-cleaner/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bibtex-cleaner.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bibtex_cleaner'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bibtex-cleaner"
+  spec.version       = BibtexCleaner::VERSION
+  spec.authors       = ["Tim Felgentreff"]
+  spec.email         = ["timfelgentreff@gmail.com"]
+  spec.summary       = %q{Cleanup your bib file interactively}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "cites"
+  spec.add_dependency "google-scholar"
+  spec.add_dependency "gscholar"
+  spec.add_dependency "dblp"
+  spec.add_dependency "levenshtein"
+end

data/bin/bibtex-cleaner

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+require "bibtex_cleaner"
+require "bibtex_cleaner/acm"
+require "bibtex_cleaner/dblp"
+require "bibtex_cleaner/doi"
+require "bibtex_cleaner/google"
+require "bibtex_cleaner/ieee"
+require "bibtex_cleaner/springer"
+
+if ARGV.size < 3 || ARGV.include?("-h") || ARGV.include?("--help")
+  puts "Usage:\n\t#{File.basename(__FILE__)} -unify -clean input.bib output.bib"
+  exit
+end
+
+unify = ARGV.delete("-unify")
+clean = ARGV.delete("-clean")
+
+b = BibTeX.open(ARGV[0])
+
+if unify
+  b.unify :publisher, /springer/i, "Springer"
+  b.unify :publisher, /acm/i, "{ACM}"
+  b.unify :publisher, /ieee/i, "{IEEE}"
+  b.unify :publisher, /easychair/i, "{EasyChair}"
+  b.unify :publisher, /mit/i, "{MIT} Press"
+  b.unify :institution, /vpri|viewpoints/i, "Viewpoints Research Institute"
+  b.unify :institution, /hpi|hasso.plattner.institut/i, "Hasso Plattner Institute"
+  b.unify(:doi, /./) { |e| e.doi = e.doi.downcase }
+  b.unify(:issn, /./) { |e| e.issn = e.issn.downcase }
+  b.unify(:isbn, /./) { |e| e.isbn = e.isbn.downcase }
+  b.unify(:pages, /\-/) { |e| e.pages = e.pages.gsub(/\-+/, "--") }
+
+  b.unify(:journal, /\(?[A-Z][A-Z]+\)?/) do |e|
+    unless e.journal =~ /{/
+      e.journal = e.journal.gsub(/(\(?[A-Z][A-Z]+\)?)/, "{\\1}")
+    end
+  end
+  b.unify(:booktitle, /\(?[A-Za-z]+\)/) do |e|
+    unless e.booktitle =~ /{/
+      e.booktitle = e.booktitle.gsub(/(\(?[A-Z][A-Z]+\)?)/, "{\\1}")
+    end
+  end
+
+  b.unify_interactively(:journal) { b.save_to(ARGV[0]) }
+  b.unify_interactively(:booktitle) { b.save_to(ARGV[0]) }
+  b.unify_interactively(:publisher) { b.save_to(ARGV[0]) }
+  b.unify_interactively(:organization) { b.save_to(ARGV[0]) }
+  b.unify_interactively(:institution) { b.save_to(ARGV[0]) }
+
+  b.save_to(ARGV[1])
+end
+
+if clean
+  out = BibTeX::Bibliography.new
+  inputthread = Thread.new {}
+
+  b.entries.values.each do |e|
+    querystr = "#{e.title} #{e.author} #{e.year} #{e.journal} #{e.booktitle}"
+    nbibtexen = BibtexCleaner.constants.map { |c| BibtexCleaner.const_get(c) }.map do |m|
+      begin
+        m.bibtex_for(querystr) if m.respond_to? :bibtex_for
+      rescue Exception; end
+    end.flatten.compact
+
+    inputthread.join
+    bibtexen = nbibtexen
+    inputthread = Thread.new do
+      puts "\nCleaning #{e} ..."
+      out << e.merge_interactively(
+        bibtexen,
+        inproceedings: [:author, :booktitle, :year, :month, :pages, :publisher, :doi],
+        incollection: [:author, :booktitle, :year, :month, :pages, :publisher, :doi],
+        phdthesis: [:author, :year, :month, :school],
+        article: [:author, :journal, :number, :volume, :year, :month, :pages, :publisher, :doi],
+        book: [:author, :year, :month, :isbn, :issn, :publisher, :doi, :edition],
+        techreport: [:author, :year, :month, :number, :institution, :issn, :doi, :isbn],
+        manual: [:author, :organization, :edition, :year, :month, :note],
+        online: [:author, :day, :month, :year, :url, :note],
+        misc: [:author, :month, :year, :howpublished, :note]
+      )
+      out.save_to(ARGV[1])
+    end
+  end
+
+  out.save_to(ARGV[1])
+end

data/lib/bibtex_cleaner.rb

@@ -0,0 +1,119 @@
+require "bundler/setup"
+require "levenshtein"
+require "bibtex"
+require "readline"
+
+module BibtexCleaner
+  VERSION = "0.1.0"
+end
+
+class BibTeX::Entry
+  def multiple_choice(f, bibtexen)
+    choices = bibtexen.map { |b| [(b.send(f) if b.respond_to?(f)), b.title, b.author] }
+    choices = choices.reject { |c| "#{c.first}".empty? }.uniq { |c| "#{c.first}" }
+
+    return choices.first.first if choices.size == 1
+    return "" if choices.size == 0
+
+    puts "Choose #{f}! (or enter your own, 0 is the original or suggested entry)"
+    choices.each_with_index do |choice, idx|
+      puts "[#{idx}] \"#{choice.first}\"\n\t\t\t\t(#{choice[1]}, #{choice[2]})"
+    end
+    answer = Readline.readline.strip
+    result = if answer =~ /\d+/
+               choices[answer.to_i].first
+             elsif answer.empty?
+               choices[0].first
+             else
+               answer
+             end
+    puts result
+    result
+  end
+
+  def merge_interactively(other_entries, required_fields)
+    new_entry = {
+      bibtex_type: multiple_choice(:type, [self] + other_entries),
+      key: self.key
+    }
+    fields = required_fields[new_entry[:bibtex_type]]
+    if fields.nil?
+      self.key = "XXX_NOT_CLEANED_#{self.key}"
+      fields = []
+    end
+
+    unless fields.empty?
+      other_entries = other_entries.select do |b|
+        b.type == new_entry[:bibtex_type]
+      end
+      new_entry[:title] = multiple_choice(:title, [self] + other_entries)
+      other_entries = other_entries.select do |b|
+        Levenshtein.normalized_distance(b.title.to_s, new_entry[:title].to_s) < 0.5
+      end
+      fields.each do |f|
+        new_entry[f] = multiple_choice(f, [self] + other_entries)
+      end
+      BibTeX::Entry.new(new_entry)
+    else
+      self
+    end
+  end
+end
+
+class BibTeX::Bibliography
+  def unify_interactively(field)
+    elements = entries.values
+    todo = elements.clone
+
+    elements.each do |prime|
+      next unless todo.include?(prime)
+      if prime.respond_to?(field) && prime.send(field)
+        primevalue = prime.send(field).to_s
+        todo.delete(prime)
+
+        es = todo.select do |e|
+          e.respond_to?(field) && Levenshtein.normalized_distance(
+            e.send(field).to_s.downcase.gsub(/[^A-Za-z]/, "").split.sort.join(" "),
+            primevalue.downcase.gsub(/[^A-Za-z]/, "").split.sort.join(" ")) < 0.4
+        end
+
+        if (es + [prime]).uniq { |e| e.send(field).to_s }.size > 1
+          puts "#{field}: #{primevalue}"
+          puts "These seem similar -- write (comma separated) which entries do belong in this list (or press return to skip all)"
+          es.each_with_index do |e, i|
+            puts "[#{i}] #{e.send(field)}"
+          end
+          answer = Readline.readline.strip
+          unless answer.empty?
+            rejects = answer.strip.split(",").map(&:strip).map(&:to_i)
+            es = es.each_with_index.select do |(e, idx)|
+              rejects.include? idx
+            end.map(&:first)
+          else
+            es = []
+          end
+        end
+
+        puts "Now, enter the desired common writing for this, press return to keep all values as they are, enter '.' to apply the prime writing"
+        puts "#{primevalue}"
+        es.each_with_index do |e, i|
+          puts "#{e.send(field)}"
+        end
+        answer = Readline.readline("", true).strip
+        unless answer.empty?
+          if answer == "."
+            answer = primevalue
+          else
+            prime.send("#{field}=", answer)
+          end
+          es.each do |e|
+            e.send("#{field}=", answer)
+            todo.delete(e)
+          end
+        end
+        puts "\n\n"
+        yield if block_given?
+      end
+    end
+  end
+end

data/lib/bibtex_cleaner/acm.rb

@@ -0,0 +1,19 @@
+require "mechanize"
+
+module BibtexCleaner
+  module ACM
+    def self.bibtex_for(querystr, limit = 4)
+      agent = Mechanize.new
+      page = agent.get("http://dl.acm.org/results.cfm", query: querystr, srt: "_score")
+
+      page.links.
+        select { |l| l.href =~ /citation.cfm\?id/ }[0...limit].
+        map do |l|
+        BibTeX.parse(
+          agent.get(l.href.sub("citation.cfm", "exportformats.cfm") + "&expformat=bibtex").
+          links.detect { |l| l.to_s =~ /download/i }.click.content
+        ).entries.values
+      end.flatten
+    end
+  end
+end

data/lib/bibtex_cleaner/dblp.rb

@@ -0,0 +1,19 @@
+require "mechanize"
+require "dblp"
+
+module BibtexCleaner
+  module DBLP
+    def self.bibtex_for(querystr, limit = 4)
+      agent = Mechanize.new
+      page = agent.get("http://dblp.uni-trier.de/search", q: querystr)
+
+      page.links.
+        select { |l| l.href =~ /rec\/bibtex\/(.+)/; $1 }.compact[0...limit].
+        map do |dblpkey|
+        BibTeX.parse(
+          agent.get("http://dblp.uni-trier.de/rec/bib2/#{dblpkey}.bib").content
+        ).entries.values
+      end.flatten
+    end
+  end
+end

data/lib/bibtex_cleaner/doi.rb

@@ -0,0 +1,14 @@
+require "cites"
+
+module BibtexCleaner
+  module DOI
+    def self.bibtex_for(querystr, limit = 4)
+      results = ::Cites.search(querystr)
+      results["items"].select { |i| i["normalizedScore"] > 90 }.map do |i|
+        BibTeX.
+          parse(::Cites.doi2cit(i["doi"].sub(/^.+dx.doi.org\//, ""), "bibtex").first).
+          entries.values
+      end.flatten[0...limit]
+    end
+  end
+end

data/lib/bibtex_cleaner/google.rb

@@ -0,0 +1,19 @@
+require "gscholar"
+require "mechanize"
+
+module BibtexCleaner
+  module Google
+    def self.bibtex_for(querystr, limit = 4)
+      agent = Mechanize.new
+      page = agent.get("https://scholar.google.de/scholar", q: querystr)
+
+      page.links.
+        map { |l| l.href =~ /\?cites=(\d+)/; $1 }.compact[0..limit].
+        map do |id|
+        bibtex = GScholar::Paper.new(id).bibtex
+        bibtex = bibtex.encode('ASCII', :invalid => :replace, :undef => :replace)
+        BibTeX.parse(bibtex).entries.values
+      end.flatten
+    end
+  end
+end

data/lib/bibtex_cleaner/ieee.rb

@@ -0,0 +1,22 @@
+require "mechanize"
+
+module BibtexCleaner
+  module IEEE
+    def self.bibtex_for(querystr, limit = 4)
+      agent = Mechanize.new
+      page = agent.get("http://ieeexplore.ieee.org/search/searchresult.jsp", queryText: querystr)
+
+      page.links.
+        map { |l| l.href =~ /arnumber=(\d+)/; $1 }.compact[0...limit].
+        map do |id|
+        bibtex = agent.post("http://ieeexplore.ieee.org/xpl/downloadCitations",
+                            :recordIds => id,
+                            "citations-format" => "citation-only",
+                            "download-format" => "download-bibtex",
+                            "x" => "74",
+                            "y" => "7").content
+        BibTeX.parse(bibtex).entries.values
+      end.flatten
+    end
+  end
+end

data/lib/bibtex_cleaner/springer.rb

@@ -0,0 +1,18 @@
+require "mechanize"
+
+module BibtexCleaner
+  module Springer
+    def self.bibtex_for(querystr, limit = 4)
+      agent = Mechanize.new
+      page = agent.get("http://link.springer.com/search", query: querystr)
+
+      page.links.
+        select { |l| l.href =~ /link.springer.com\/(chapter|article)\/.+\/.+/ }[0...limit].
+        map do |l|
+        BibTeX.parse(
+          agent.get(l.href.sub("link.springer.com/", "link.springer.com/export-citation") + ".bib").content
+        ).entries.values
+      end.flatten
+    end
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: bibtex-cleaner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Felgentreff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cites
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-scholar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gscholar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dblp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: levenshtein
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- timfelgentreff@gmail.com
+executables:
+- bibtex-cleaner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bibtex-cleaner.gemspec
+- bin/bibtex-cleaner
+- lib/bibtex_cleaner.rb
+- lib/bibtex_cleaner/acm.rb
+- lib/bibtex_cleaner/dblp.rb
+- lib/bibtex_cleaner/doi.rb
+- lib/bibtex_cleaner/google.rb
+- lib/bibtex_cleaner/ieee.rb
+- lib/bibtex_cleaner/springer.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Cleanup your bib file interactively
+test_files: []