bibkeys 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 397340529138fbead98dff8fda0a4287db17f320
+  data.tar.gz: c6934a5b02ba8f3ca7afea8cb17b1ea1f45d5df0
+SHA512:
+  metadata.gz: 34dcdfe9963c6f770c7cd729628776fbf6c13303ea2ac00fe6a29a4bacc9cc77ae25038f5e7006e2126b9b170217c86e682fcc6bb6124fab41f4d867598b7566
+  data.tar.gz: 42bbaec2d8c15c655f249b2751e99dc003d3c52e2deb9a762cea77f18b3282c1c51be4757e99f31931ea42be2c5b29e6caa8fd2bb22d8078e5e570263eaad53c

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 gem "bundler"
-gem "rake"
-gem "bibtex-ruby", "~> 2.1.2"
+gem "rake", "~> 10.0.4"
+gem "bibtex-ruby", "~> 2.3"

data/Gemfile.lock

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

data/Manifest

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

data/README.md

@@ -6,12 +6,13 @@ Lincoln A. Mullen | lincoln@lincolnmullen.com | http://lincolnmullen.com
 
 ## Installation
 
-You can install bibkeys from [RubyGems](https://rubygems.org/):
+You can install bibkeys from [RubyGems][]:
 
     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.
+If you don't have it installed already, you'll need to install
+[bibtex-ruby][], which does most of the heavy lifting. Using gem 
+to install bibkeys should install that dependency for you.
 
 ## Usage
 
@@ -21,19 +22,38 @@ To list all the keys in a BibTeX file:
 
 To sort the list of keys:
 
-    bibkeys -s bibliograph.bib
+    bibkeys -s bibliography.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 
+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
+    bibkeys bibliography.bib > keys.txt
 
+## Using Bibkeys with Vim
+
+Bibkeys may be useful to you if you use BibTeX citation keys in your
+writing. I generate a file with citation keys automatically whenever I
+edit my [BibTeX database][]. In my `.vimrc`, I've added the following
+lines:
+
+    set dictionary=$HOME/bib/citekeys.txt
+    set complete+=k
+
+When writing a citation in a LaTeX or Pandoc document, typing the
+beginning of a citation and pressing `Ctrl-X Ctrl-K` or `Ctrl-X Ctrl-N`
+autocompletes the citation. (N.B. This only works if your citation keys
+do not contain characters like `:` or `-`. If you keys do have those
+characters, you'll need to user-completion or omni-completion, both of
+which are a pain.)
+
+  [RubyGems]: https://rubygems.org/
   [bibtex-ruby]: https://github.com/inukshuk/bibtex-ruby
+  [BibTeX database]: https://github.com/lmullen/historybib

data/Rakefile

@@ -1,6 +1,8 @@
 # encoding: utf-8
 
 require 'bundler'
+require "bundler/gem_tasks"
+
 begin
   Bundler.setup
 rescue Bundler::BundlerError => e
@@ -12,17 +14,13 @@ end
 require 'rake/clean'
 CLEAN.include('*.gem')
 
-desc 'Builds the gem file'
-task :build => ['manifest'] do
-  system 'gem build bibkeys.gemspec'
-end
-
+task :build => ['manifest']
 
 desc 'Updates the Manifest file'
-task :manifest => ['clean'] do
+task :manifest do
   m = File.open('Manifest', 'w')
   m.print FileList['**/*'].reject{ |f|
-    f.start_with?('coverage') || f.end_with?('.bib')
+    f.start_with?('pkg') || f.end_with?('.bib')
   }.join("\n")
   m.close
 end

data/bibkeys.gemspec

@@ -1,6 +1,10 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bibkeys/version'
+
 Gem::Specification.new do |s|
   s.name          = 'bibkeys'
-  s.version       = '0.0.1'
+  s.version       = Bibkeys::VERSION
   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'
@@ -11,5 +15,5 @@ Gem::Specification.new do |s|
   s.bindir        = 'bin'
   s.executables   << 'bibkeys'
   s.license       = 'MIT'
-  s.add_runtime_dependency('bibtex-ruby', ['~>2.1.2'])
+  s.add_runtime_dependency('bibtex-ruby', ['~>2.3'])
 end

data/bin/bibkeys

@@ -30,6 +30,11 @@ opts = OptionParser.new do|opts|
     options[:sort] = true
   end
 
+  opts.on('--version', 'Show version number') do
+    puts "bibkeys, version " + Bibkeys::VERSION
+    exit
+  end
+
 end
 opts.parse!       # strips all non-filename arguments from ARGV
 

data/lib/bibkeys.rb

@@ -4,6 +4,7 @@
 # License::       MIT License | http://lmullen.mit-license.org/
 
 require 'bibtex'
+require 'bibkeys/version'
 
 # This class parses a stream of BibTeX input passed to it and provides a 
 # method to list its keys, sorted or unsorted.

data/lib/bibkeys/version.rb

@@ -0,0 +1,3 @@
+class Bibkeys
+  VERSION = "0.0.2"
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bibkeys
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Lincoln A. Mullen
@@ -14,19 +13,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '2.3'
 description: A Ruby utility to list all the citation keys in a BibTeX file
 email: lincoln@lincolnmullen.com
 executables:
@@ -34,41 +31,38 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bibkeys.gemspec
-- bin/bibkeys
 - Gemfile
 - Gemfile.lock
-- lib/bibkeys.rb
-- license.txt
 - Manifest
-- Rakefile
 - README.md
+- Rakefile
+- bibkeys.gemspec
+- bin/bibkeys
+- lib/bibkeys.rb
+- lib/bibkeys/version.rb
+- license.txt
 homepage: http://github.com/lmullen/bibkeys
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: List all the keys in BibTeX file
 test_files: []