bibkeys 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+gem "bundler"
+gem "rake"
+gem "bibtex-ruby", "~> 2.1.2"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bibtex-ruby (2.1.2)
+      latex-decode (>= 0.0.6)
+      multi_json (~> 1.3)
+    latex-decode (0.0.12)
+      unicode (~> 0.4)
+    multi_json (1.3.7)
+    rake (0.9.2.2)
+    unicode (0.4.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bibtex-ruby (~> 2.1.2)
+  bundler
+  rake

data/Manifest

@@ -0,0 +1,11 @@
+bibkeys.gemspec
+bin
+bin/bibkeys
+Gemfile
+Gemfile.lock
+lib
+lib/bibkeys.rb
+license.txt
+Manifest
+Rakefile
+README.md

data/README.md

@@ -0,0 +1,39 @@
+# Bibkeys
+
+A Ruby utility to list all the citation keys in a BibTeX file
+
+Lincoln A. Mullen | lincoln@lincolnmullen.com | http://lincolnmullen.com
+
+## Installation
+
+You can install bibkeys from [RubyGems](https://rubygems.org/):
+
+    gem install bibkeys
+
+If you don't have it installed already, you'll need to install 
+[bibtex-ruby], which does most of the heavy lifting.
+
+## Usage
+
+To list all the keys in a BibTeX file:
+
+    bibkeys bibliography.bib
+
+To sort the list of keys:
+
+    bibkeys -s bibliograph.bib
+
+To list all the keys in multiple files:
+
+    bibkeys bib1.bib bib2.bib etc.bib
+
+This program functions as *nix-style utility. Accordingly, it can read 
+from stdin:
+
+    cat bibliography.bib | bibkeys -
+
+To save the keys to a file:
+
+    bibkeys bibliograph.bib > keys.txt
+
+  [bibtex-ruby]: https://github.com/inukshuk/bibtex-ruby

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'bundler'
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake/clean'
+CLEAN.include('*.gem')
+
+desc 'Builds the gem file'
+task :build => ['manifest'] do
+  system 'gem build bibkeys.gemspec'
+end
+
+
+desc 'Updates the Manifest file'
+task :manifest => ['clean'] do
+  m = File.open('Manifest', 'w')
+  m.print FileList['**/*'].reject{ |f|
+    f.start_with?('coverage') || f.end_with?('.bib')
+  }.join("\n")
+  m.close
+end
+

data/bibkeys.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name          = 'bibkeys'
+  s.version       = '0.0.1'
+  s.date          = '2012-11-02'
+  s.summary       = 'List all the keys in BibTeX file'
+  s.description   = 'A Ruby utility to list all the citation keys in a BibTeX file'
+  s.author        = 'Lincoln A. Mullen'
+  s.email         = 'lincoln@lincolnmullen.com'
+  s.homepage      = 'http://github.com/lmullen/bibkeys'
+  s.files         = File.open('Manifest').readlines.map(&:chomp)
+  s.bindir        = 'bin'
+  s.executables   << 'bibkeys'
+  s.license       = 'MIT'
+  s.add_runtime_dependency('bibtex-ruby', ['~>2.1.2'])
+end

data/bin/bibkeys

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+# Name::          Bibkeys
+# Author::        Lincoln Mullen | lincoln@lincolnmullen.com
+# Copyright::     Copyright (c) 2012 Lincoln Mullen 
+# License::       MIT License | http://lmullen.mit-license.org/
+
+
+# for use/testing when no gem is installed
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib]) 
+
+require 'optparse'
+require 'bibkeys'
+
+# set default options
+options = {}
+options[:sort] = false
+
+opts = OptionParser.new do|opts|
+
+  # help options
+  opts.banner = "Usage: bibkeys [-s] bibliography.bib [bibliography2.bib]\n       bibkeys [-s] -\nOptions:"
+  opts.on( '-h', '--help', 'Display help screen' ) do
+    puts opts
+    exit
+  end
+
+  # should we sort?
+  opts.on('-s', '--sort', 'Sort the list of keys' ) do
+    options[:sort] = true
+  end
+
+end
+opts.parse!       # strips all non-filename arguments from ARGV
+
+# If values have been passed as filenames or stdin, then pass those 
+# values as an input stream to a Bibkeys class to be parsed.
+if ARGV.any?
+  Bibkeys.new( ARGF.read , options[:sort] ).list 
+else
+  puts "Please pass a BibTeX filename or BibTeX input to stdin."
+end

data/lib/bibkeys.rb

@@ -0,0 +1,36 @@
+# Name::          Bibkeys
+# Author::        Lincoln Mullen | lincoln@lincolnmullen.com
+# Copyright::     Copyright (c) 2012 Lincoln Mullen 
+# License::       MIT License | http://lmullen.mit-license.org/
+
+require 'bibtex'
+
+# This class parses a stream of BibTeX input passed to it and provides a 
+# method to list its keys, sorted or unsorted.
+class Bibkeys
+
+  # Parses an input stream as if it were a BibTeX file
+  def initialize ( stream , sort=false )
+    @bib = BibTeX.parse( stream )
+    @sort = sort
+  end
+
+
+  # List all the keys in the BibTeX file
+  def list
+
+    keys = Array.new
+
+    @bib.each do |entry|
+      keys.push entry.key
+    end
+
+    if @sort
+      puts keys.sort
+    else 
+      puts keys
+    end
+
+  end
+
+end

data/license.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2012 Lincoln A. Mullen <lincoln@lincolnmullen.com>
+
+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.

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: bibkeys
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lincoln A. Mullen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+description: A Ruby utility to list all the citation keys in a BibTeX file
+email: lincoln@lincolnmullen.com
+executables:
+- bibkeys
+extensions: []
+extra_rdoc_files: []
+files:
+- bibkeys.gemspec
+- bin/bibkeys
+- Gemfile
+- Gemfile.lock
+- lib/bibkeys.rb
+- license.txt
+- Manifest
+- Rakefile
+- README.md
+homepage: http://github.com/lmullen/bibkeys
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4548692308244964840
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: List all the keys in BibTeX file
+test_files: []