bibtex_munge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0570d1639c6e189aa2bf8a5b8f806ee93a549fb0
+  data.tar.gz: 2125c90d8a6a8cb437f16da9898fb4b464f1fd7c
+SHA512:
+  metadata.gz: 5a1f29d06e2ba3f2f20a5d3c66f9e46a43370c56a84624ce9f2e9e56b78e889afef45eedde00187660ebf984ea9829e4cdc6c0dd7317f412d95bb87b2d19be04
+  data.tar.gz: 14577955753efc43623d95b547c6fade6ec42f8156f9b845d6ca3de6a81ef18f9367c2a2a7e5da7b4ba49c5bc51485ee0e8c3f3d7098f96ec3ecc01c9caac453

data/.gitignore

@@ -0,0 +1,23 @@
+*.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
+*.swp
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bibtex_munge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Leah Velleman
+
+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 @@
+# BibtexMunge
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bibtex_munge'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bibtex_munge
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bibtex_munge/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,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "tests"
+  t.test_files = FileList['tests/test*.rb']
+  t.verbose = true
+end
+

data/bibtex_munge.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bibtex_munge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bibtex_munge"
+  spec.version       = BibtexMunge::VERSION
+  spec.authors       = ["Leah Velleman"]
+  spec.email         = ["leah.velleman@gmail.com"]
+  spec.summary       = %q{Automate several cleanup tasks for BibTeX files}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["bibtex_munge"]
+  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_runtime_dependency "bibtex-ruby"
+  spec.add_runtime_dependency "nokogiri"
+end

data/bin/bibtex_munge

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'bibtex_munge'
+replace = false
+path = nil
+HELP = <<-EOF
+Usage: bibtex_munge [-hR] filename
+
+The filename should be the name of a .bib or .bcf file. If it is a .bib file, the output
+will consist of cleaned and normalized bibliography entries. If it is a .bcf file,
+in addition to cleaning and sanitizing, a subset bibliography will be created: only those
+entries that were actually cited in the document from which the .bcf was created will
+be retained.
+
+Options:
+  --help -h     show this message
+  --replace -R  rather than printing the output to STDOUT, save it as filename.bib, and
+                move the former contents of filename.bib to filename.bib.bak
+
+EOF
+
+def bad_input
+  puts "Invalid input!"
+  puts HELP
+end
+
+define_method :do_output do |bib|
+  if replace
+    if path.end_with? ".bcf"
+      path = path.chomp('.bcf') + ".bib"
+    end
+    bib.save_and_backup(path)
+  else
+    puts bib
+  end 
+end
+
+while ARGV.length > 0 do
+  o = ARGV.shift
+  case o
+  when '-h', '--help' 
+    print HELP
+    exit
+  when '-R', '--replace'
+    replace = true
+  else
+    if File.exists? o 
+      path = o
+    else
+      bad_input
+    end
+  end
+end
+
+if path
+  if path.end_with? ".bcf"
+    bib = BibTeX::Bibliography.from_bcf(path)
+    bib.fix_everything!
+    do_output(bib)
+  elsif path.end_with? ".bib"
+    bib = BibTeX::Bibliography.from_bib(path)
+    bib.fix_everything!
+    do_output(bib)
+  else
+    bad_input
+  end
+else
+  bad_input
+end

data/lib/bibtex_munge.rb

@@ -0,0 +1,6 @@
+require "bibtex_munge/version"
+require "bibtex_munge/bibliography"
+require "bibtex_munge/bcf"
+require "bibtex_munge/save"
+require "bibtex_munge/sort"
+

data/lib/bibtex_munge/bcf.rb

@@ -0,0 +1,52 @@
+require "nokogiri"
+
+module BibTeX
+  class Bibliography
+    attr_accessor :filepath
+
+    class << self
+      def trim_unnecessary_entries!(bib, citekeys)
+        bib.entries.each do |k,v|
+          if !citekeys.include? k 
+            bib.delete(k)
+          end
+        end
+      end
+
+      def from_bcf(path)
+        File.open(path, "r") do |f|
+          @bcf = Nokogiri::XML(f).remove_namespaces!
+        end
+        filepath = File.dirname(path) + "/" + @bcf.at_xpath("//datasource").content
+        citekeys = @bcf.xpath("//citekey", 'bcf'=>'URI').map(&:content)
+        bib = open(filepath, :filter => 'latex')
+        bib.filepath = filepath
+        trim_unnecessary_entries!(bib, citekeys)
+        bib.sort! { |a,b| a.author <=> b.author }
+        bib.extend(BibtexMunge)
+        bib.fix_everything!
+        return bib
+      end  
+    end
+  end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/bibtex_munge/bibliography.rb

@@ -0,0 +1,135 @@
+# TODO: 
+#   - DOI fetching?
+#   - Protect math expressions with braces
+#   - 
+
+
+require "bibtex"
+
+module BibtexMunge
+  @@split_fields = [                          # specifying how to handle {PART 1: PART 2}
+                                              # in fields where it is a frequent issue:
+    [:title, :title, :subtitle],              #  * if the title contains a separator, 
+                                              #    the second part becomes a subtitle
+    [:booktitle, :booktitle, :booksubtitle],  #  * if the booktitle contains a separator,
+                                              #    the second part becomes a booksubtitle
+    [:publisher, :address, :publisher]        #  * if the publisher contains a separator,
+                                              #    the first part becomes an address
+  ]
+  @@name_fields = [:author, :editor]          # specifying which fields shouldn't have
+                                              # trailing periods removed (because
+                                              # they might be initials)
+
+  @@prune_fields = [:isbn, :issn, :abstract]  # common nuisance fields to delete
+ 
+  # Run a block on every field in every entry
+  def each_field(options = {})
+    except   = options[:except]
+    except ||= []
+    if block_given?
+      each_entry do |e|
+        e.fields.each do |k,v|
+          yield v unless except.include? k
+        end
+      end
+    end
+  end
+
+  def normalize_initials!
+    each_entry do |e|
+      @@name_fields.each do |k|
+        if e[k]
+          e[k].each do |name|
+            if name.first
+              name.first = name.normalize_initials
+            end
+          end
+        end
+      end
+    end
+    self
+  end
+
+  def depunctuate!
+    each_field :except => @@name_fields do |f|
+      f.chomp!(".")
+    end
+    self
+  end
+ 
+  def extend_braces!
+    each_field do |f|
+      f.gsub! /\ {([^ ])}([^ ]+)/, ' {\1\2}'  # The initial space is to avoid
+                                              # fucking up braces after an accent.
+                                              # this is *probably* redundant now that we're
+                                              # unicodifying everything, but better safe than
+                                              # sorry
+    end
+    self
+  end
+
+  def remove_double_braces!
+    each_field do |f|
+      f.gsub! /{{(.*)}}/, '{\1}'    # Eliminate overt double braces
+
+      f.gsub! /^{(.*)}$/, '\1'      # Eliminate whole-entry braces (which would have been
+                                    # double braces in the unparsed BibTeX file, since
+                                    #       publisher = {{Blackwell}}
+                                    # parses to 
+                                    #       @bib[:key].publisher = "{Blackwell}"
+    end
+    self
+  end
+
+  def split_field!(e, oldkey, newsuperkey, newsubkey)
+    if e[oldkey]
+      elements = e[oldkey].split(/([.:?]) /,2)    # Split after .:?, retaining the separator
+      if elements.length == 3                       
+        e[newsubkey] = elements[2]                     
+        if elements[1] == "?"                       # Keep the separator as part of the first
+          e[newsuperkey] = elements[0..1].join      # field if it is a ?, to handle titles of
+                                                    # the form {Question? An Answer}
+        else
+          e[newsuperkey] = elements[0]
+        end
+      end
+    end
+  end
+
+  def split_fields!
+    each_entry do |e|
+      @@split_fields.each do |oldkey, newsuperkey, newsubkey|
+        split_field!(e, oldkey, newsuperkey, newsubkey)
+      end
+    end
+    self
+  end
+
+  def prune_fields!
+    each_entry do |e|
+      @@prune_fields.each do |k|
+        e.delete(k)
+      end
+    end
+    self
+  end
+
+  def normalize_page_ranges!
+    each_entry do |e|
+      if e.pages
+        e.pages.gsub! /^(\d+)\s*(–|—|-|--|---)\s*(\d+)$/, '\1 -- \3'
+      end
+    end
+    self
+  end
+
+  def fix_everything!
+    remove_double_braces!
+    depunctuate!
+    extend_braces!
+    split_fields!
+    prune_fields!
+    normalize_initials!
+    normalize_page_ranges!
+  end
+end

data/lib/bibtex_munge/save.rb

@@ -0,0 +1,13 @@
+require "bibtex"
+
+module BibtexMunge
+  def save_and_backup(path)
+    if path == @filepath
+      File.rename(@filepath, @filepath+".bak")
+    end
+    f = File.open(path, "w")
+    f.write(to_s)
+    f.close
+  end
+end  
+

data/lib/bibtex_munge/sort.rb

@@ -0,0 +1,9 @@
+# BibTeX-ruby includes prefixes like "von" as part of the last name when sorting names.
+# This redefinition of Name#sort_order stops it from doing so.
+module BibTeX
+  class Name
+    def sort_order(options = {})
+      [last, suffix, options[:initials] ? initials : first].compact.join(', ')
+    end
+  end
+end

data/lib/bibtex_munge/version.rb

@@ -0,0 +1,3 @@
+module BibtexMunge
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: bibtex_munge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leah Velleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 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: bibtex-ruby
+  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: nokogiri
+  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:
+- leah.velleman@gmail.com
+executables:
+- bibtex_munge
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bibtex_munge.gemspec
+- lib/bibtex_munge.rb
+- lib/bibtex_munge/bcf.rb
+- lib/bibtex_munge/bibliography.rb
+- lib/bibtex_munge/save.rb
+- lib/bibtex_munge/sort.rb
+- lib/bibtex_munge/version.rb
+- bin/bibtex_munge
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Automate several cleanup tasks for BibTeX files
+test_files: []