vimdb 0.3.0 → 0.4.0

data/.gemspec

@@ -12,10 +12,12 @@ Gem::Specification.new do |s|
   s.description = "Search your vim keybindings precisely by keystroke, mode, description or where they came from. Search vim options by name, alias and description."
   s.required_rubygems_version = ">= 1.3.6"
   s.executables        = %w(vimdb)
-  s.add_dependency 'thor', '~> 0.14.6'
-  s.add_dependency 'hirb', '~> 0.5.0'
+  s.add_dependency 'boson', '~> 1.0.0'
+  s.add_dependency 'hirb', '~> 0.6.0'
   s.add_development_dependency 'minitest', '~> 2.5.1'
-  s.files = Dir.glob(%w[{lib,spec}/**/*.rb bin/* [A-Z]*.{txt,rdoc,md} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
+  s.add_development_dependency 'bahia', '~> 0.3.0'
+  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.files = Dir.glob(%w[{lib,spec}/**/*.rb bin/* [A-Z]*.{txt,rdoc,md} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec .travis.yml}
   s.files += Dir.glob(['spec/fixtures/*', 'spec/.vimdbrc'])
   s.extra_rdoc_files = ["README.md", "LICENSE.txt"]
   s.license = 'MIT'

data/.travis.yml

@@ -0,0 +1,4 @@
+before_install: bundle init --gemspec=.gemspec
+rvm:
+- 1.9.2
+- 1.9.3

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+= 0.4.0
+* Switch to boson
+
 = 0.3.0
 * Several fixes to key parsing
 * Add all + not search options

data/Rakefile

@@ -29,7 +29,7 @@ end
 
 desc 'Run tests'
 task :test do |t|
-  ENV['RUBYLIB'] = 'lib:' + ENV['RUBYLIB']
+  ENV['RUBYLIB'] = ['lib', ENV['RUBYLIB']].compact.join(':')
   sh 'testrb spec/*_spec.rb'
 end
 

data/deps.rip

@@ -1,2 +1,2 @@
-thor ~>0.14.6
-hirb ~>0.5.0
+boson ~>1.0.0
+hirb ~>0.6.0

data/lib/vimdb/keys.rb

@@ -80,10 +80,13 @@ class Vimdb::Keys < Vimdb::Item
           # add desc from following lines
           if cols[0] == ''
             if cols[1] !~ /^(Meta characters|not used)/
-              keys[-1][:desc] += ' ' + cols[1].strip
+              keys[-1][:desc] << ' ' if !keys[-1][:desc].empty?
+              keys[-1][:desc] << cols[1].gsub(/^\s*\d?|\s*$/, '')
             end
           else
-            keys << create_index_key(mode, cols[1])
+            key, desc = cols[1].include?('use register') ?
+              cols[1].split(/\s+/, 2) : [cols[1], nil]
+            keys << create_index_key(mode, key, desc)
           end
         elsif cols.size == 1
           tag, key = line.split(/\s+/, 2)
@@ -103,7 +106,7 @@ class Vimdb::Keys < Vimdb::Item
   end
 
   def create_index_key(mode, key, desc = nil)
-    desc = desc ? desc.strip : ''
+    desc = desc ? desc.gsub(/^\s*\d?\s*|\s*$/, '') : ''
     { mode: mode, key: translate_index_key(key), desc: desc, from: 'default' }
   end
 
@@ -131,7 +134,7 @@ class Vimdb::Keys < Vimdb::Item
       next if key[:key][/^(<Plug>|<SNR>)/]
       key[:key] = translate_map_key(key[:key])
 
-      key[:desc] = arr[0][/^\S*\s+\S+\s+(.*)$/, 1]
+      key[:desc] = arr[0][/^\S*\s+\S+\s+\*?\s*(.*)$/, 1]
       key[:mode] = (mode = arr[0][/^[nvsxo!ilc]+/]) ?
         @mode_map[mode] || mode : 'nvso'
       key

data/lib/vimdb/runner.rb

@@ -1,60 +1,53 @@
-require 'thor'
+require 'boson/runner'
 require 'hirb'
+ENV['BOSONRC'] = ENV['VIMDB_RC'] || '~/.vimdbrc'
 
-class Vimdb::Runner < Thor
-  def self.start(*args)
-    rc = ENV['VIMDB_RC'] || '~/.vimdbrc'
-    begin
-      load(rc) if File.exists?(File.expand_path(rc))
-    rescue StandardError, SyntaxError, LoadError => err
-      warn "Error while loading #{rc}:\n"+
-        "#{err.class}: #{err.message}\n    #{err.backtrace.join("\n    ")}"
-    end
-    super
-  end
+class Vimdb::Runner < Boson::Runner
 
   def self.common_search_options
-    method_option :reload, :type => :boolean, :desc => 'reloads items'
-    method_option :sort, :type => :string, :desc => 'sort by field', :aliases => '-s'
-    method_option :reverse_sort, :type => :boolean, :aliases => '-R'
-    method_option :ignore_case, :type => :boolean, :aliases => '-i'
-    method_option :regexp, :type => :boolean, :aliases => '-r', :desc => 'query is a regexp'
-    method_option :not, :type => :boolean, :aliases => '-n', :desc => 'return non-matching results'
-    method_option :all, :type => :boolean, :aliases => '-a', :desc => 'search all fields'
-    method_option :field, :type => :string, :desc => 'field to query', :aliases => '-f'
+    option :reload, :type => :boolean, :desc => 'reloads items'
+    option :sort, :type => :string, :desc => 'sort by field'
+    option :reverse_sort, :type => :boolean
+    option :ignore_case, :type => :boolean
+    option :regexp, :type => :boolean, :desc => 'query is a regexp'
+    option :not, :type => :boolean, :desc => 'return non-matching results'
+    option :all, :type => :boolean, :desc => 'search all fields'
+    option :field, :type => :string, :desc => 'field to query'
+    option :tab, :type => :boolean, :desc => 'print tab-delimited table'
   end
 
   common_search_options
-  method_option :mode, :type => :string, :desc => 'search by mode, multiple modes are ORed', :aliases => '-m'
-  desc 'keys [QUERY]', 'List vim keys'
-  def keys(query = nil)
+  option :mode, :type => :string, :desc => 'search by mode, multiple modes are ORed'
+  desc 'List vim keys'
+  def keys(query = nil, options={})
     Vimdb.item('keys')
-    search_item(query)
+    search_item(query, options)
   end
 
   common_search_options
-  desc 'opts [QUERY]', 'List vim options'
-  def opts(query = nil)
+  desc 'List vim options'
+  def opts(query = nil, options={})
     Vimdb.item('options')
-    search_item(query)
+    search_item(query, options)
   end
 
   common_search_options
-  desc 'commands [QUERY]', 'List vim commands'
-  def commands(query = nil)
+  desc 'List vim commands'
+  def commands(query = nil, options={})
     Vimdb.item('commands')
-    search_item(query)
+    search_item(query, options)
   end
 
-  desc 'info [ITEM]', 'Prints info about an item'
+  desc 'Prints info about an item'
   def info(item = nil)
     puts Vimdb.item(item).info
   end
 
   private
-  def search_item(query = nil)
+  def search_item(query = nil, options)
     Vimdb.user.reload if options[:reload]
     keys = Vimdb.user.search(query, options)
-    puts Hirb::Helpers::Table.render(keys, fields: Vimdb.item.fields)
+    puts Hirb::Helpers::Table.render(keys, fields: Vimdb.item.fields, tab: options[:tab])
   end
+
 end

data/lib/vimdb/version.rb

@@ -1,3 +1,3 @@
 module Vimdb
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/commands_spec.rb

@@ -7,47 +7,47 @@ describe "vimdb commands" do
   end
 
   it "searches :name field by default" do
-    vimdb 'commands', 'bufd'
+    vimdb "commands bufd"
     stdout.must_match /1 row/
   end
 
   it 'lists command names without symbol' do
-    vimdb 'commands', 'bad'
+    vimdb 'commands bad'
     stdout.must_include <<-STR
 | badd | bad   | default | add buffer to the buffer list |
 STR
   end
 
   it "lists command name without alias" do
-    vimdb 'commands', 'bufd'
+    vimdb 'commands bufd'
     stdout.must_include <<-STR
 | bufdo |       | default | execute command in each listed buffer |
 STR
   end
 
   it 'lists multi-line index commands correctly' do
-    vimdb 'commands', 'wp'
+    vimdb 'commands wp'
     stdout.must_include <<-STR
 | wprevious | wp    | default | write to a file and go to previous file in argument list |
 STR
   end
 
   it "lists user-defined commands correctly" do
-    vimdb 'commands', 'GitGrep'
+    vimdb 'commands GitGrep'
     stdout.must_include <<-STR
 | GitGrep |       | user | call GitGrep(<q-args>) |
 STR
   end
 
   it "lists plugin commands correctly" do
-    vimdb 'commands', 'Gist'
+    vimdb 'commands Gist'
     stdout.must_include <<-STR
 | Gist |       | gist-vim plugin | :call Gist(<line1>, <line2>, <f-args>) |
 STR
   end
 
   it "lists plugin commands using plugin_dir regexp correctly" do
-    vimdb 'commands', 'Vopen'
+    vimdb 'commands Vopen'
     stdout.must_include <<-STR
 | Vopen |       | pathogen.vim plugin | :execute s:find(<count>,'edit<bang>',<q-args>,1) |
 STR

data/spec/common_search_options_spec.rb

@@ -2,33 +2,33 @@ require File.expand_path(File.dirname(__FILE__) + '/helper')
 
 describe "common search options" do
   it "with --field option searches another field" do
-    vimdb 'keys', 'L-z' ,'-f=desc'
+    vimdb 'keys L-z -f=desc'
     stdout.must_match /^0 rows/
   end
 
   it "with --reverse_sort option reverse sorts field" do
-    vimdb 'keys', '-R'
+    vimdb 'keys -R'
     stdout.must_match /gq.*'\]/m
   end
 
   it "with --regexp option converts search to regexp" do
-    vimdb 'keys', '^C-', '-r'
+    vimdb 'keys ^C- -r'
     stdout.wont_match /^0 rows/
     stdout.must_match /C-a.*C-z/m
   end
 
   it "with --ignore-case option ignores case" do
-    vimdb 'keys', 'Q:', '-i'
+    vimdb "keys Q: -i"
     stdout.must_match /q:.*1 row/m
   end
 
   it "with --not option returns all non-matching results" do
-    vimdb 'keys', 'blarg', '-n'
+    vimdb "keys blarg -n"
     stdout.must_match /928 rows/
   end
 
   it "with --all option searches all fields" do
-    vimdb 'keys', 'C', '-a'
+    vimdb "keys C -a"
     stdout.must_match /365 rows/
     # from desc field
     stdout.must_include ' :TComment<CR>'

data/spec/deps.rip

@@ -1 +1,3 @@
-minitest ~>2.5.1
+minitest ~>2.5.1
+bahia ~>0.3.0
+rake ~>0.9.2

data/spec/helper.rb

@@ -1,26 +1,15 @@
 gem 'minitest' unless ENV['NO_RUBYGEMS']
 require 'minitest/autorun'
 require 'vimdb'
-require 'open3'
 require 'fileutils'
+require 'bahia'
 
 ENV['VIMDB_RC'] = File.dirname(__FILE__) + '/.vimdbrc'
 ENV['VIMDB_DB'] = File.dirname(__FILE__) + '/vimdb.pstore'
 ENV['VIMDB_FIXTURE_DIR'] = File.dirname(__FILE__) + '/fixtures'
 
-module TestHelpers
-  attr_reader :stdout, :stderr, :process
-
-  def vimdb(*args)
-    args.unshift File.dirname(__FILE__) + '/../bin/vimdb'
-    args.unshift({'RUBYLIB' => "#{File.dirname(__FILE__)}/../lib:" +
-                 ENV['RUBYLIB']})
-    @stdout, @stderr, @process = Open3.capture3(*args)
-  end
-end
-
 class MiniTest::Unit::TestCase
-  include TestHelpers
+  include Bahia
 end
 
 MiniTest::Unit.after_tests { FileUtils.rm_f(ENV['VIMDB_DB']) }

data/spec/keys_spec.rb

@@ -7,35 +7,35 @@ describe "vimdb keys" do
   end
 
   it 'searches :key field by default' do
-    vimdb 'keys', 'g#'
+    vimdb "keys g#"
     stdout.must_match /1 row/
   end
 
   it 'with --mode option ANDs mode to search' do
-    vimdb 'keys', 'gm', '-m=n'
+    vimdb "keys gm -m=n"
     stdout.must_match /1 row/
   end
 
   describe "edge cases" do
     it "converts control key to C-" do
-      vimdb 'keys', 'C-z'
+      vimdb "keys C-z"
       stdout.wont_match /^0 rows/
       stdout.must_match /C-z/
     end
 
     it "converts escape key to E-" do
-      vimdb 'keys', 'E-x'
+      vimdb "keys E-x"
       stdout.wont_match /^0 rows/
       stdout.must_match /E-x/
     end
 
     it 'converts leader key to L-' do
-      vimdb 'keys', 'L-z'
+      vimdb "keys L-z"
       stdout.must_match /1 row/
     end
 
     it 'searches non-alphabetic characters' do
-      vimdb 'keys', '!'
+      vimdb "keys !"
       stdout.must_match /!\{filter\}/
     end
 
@@ -45,59 +45,83 @@ describe "vimdb keys" do
     end
 
     it 'lists user-generated keys' do
-      vimdb 'keys', 'L-w'
+      vimdb "keys L-w"
       stdout.must_include <<-STR.sub(/^\s+/, '')
       | L-w | nvso | user | :call OpenURL()<CR> |
       STR
     end
 
+    it "lists user keys with starred descriptions" do
+      vimdb "keys L-l"
+      stdout.must_include <<-STR
+| L-l | n    | user | <C-W>l |
+STR
+    end
+
     it "doesn't list Plug keys" do
-      vimdb 'keys', 'Plug'
+      vimdb "keys Plug"
       stdout.must_match /^0 rows/
     end
 
     it "doesn't list not used keys" do
-      vimdb 'keys', '^not used$', '-f=desc', '-r'
+      skip 'fix multi-word'
+      vimdb "keys '^not used$' -f=desc -r"
       stdout.must_match /^0 rows/
     end
 
     it "lists keys with description on following line" do
-      vimdb 'keys', 'digraph', '-a'
+      vimdb "keys digraph -a"
       stdout.must_include <<-STR
-| {char1}<BS>{char2}   | i    | default |  enter digraph (only when 'digraph' option set) |
+| {char1}<BS>{char2}   | i    | default | enter digraph (only when 'digraph' option set) |
 STR
     end
 
     it "lists keys with no tabs and no description" do
-      vimdb 'keys', 'C-r C-r'
+      skip 'fix multi-word'
+      vimdb "keys 'C-r C-r'"
       stdout.must_include <<-STR
-| C-r C-r {0-9a-z"%#*:=}                 | i    | default |  insert the contents of a register literally               |
+| C-r C-r {0-9a-z"%#*:=}                 | i    | default | insert the contents of a register literally                |
 STR
     end
 
     it "lists keys with no tabs but a description" do
-      vimdb 'keys', 'C-v {number}'
+      skip 'fix multi-word'
+      vimdb "keys 'C-v {number}'"
       stdout.must_include <<-STR
 | C-v {number} | i    | default | insert three digit decimal number as a single byte. |
 STR
 
-      vimdb 'keys', 'C-w g C-]'
+      vimdb "keys 'C-w g C-]'"
       stdout.must_include <<-STR
 | C-w g C-] | n    | default | split window and do |:tjump| to tag under cursor |
       STR
     end
 
     it "lists key without unrelated sentences after it" do
-      vimdb 'keys', 'delete character under', '-a'
+      vimdb "keys 'delete character under' -a"
       stdout.must_include <<-STR
 | <Del> | i    | default | delete character under the cursor |
 STR
     end
 
     it "lists keys correctly that have desc from previous key" do
-      vimdb 'keys', '2$', '-r'
+      vimdb "keys 2$ -r"
       stdout.must_include <<-STR
 | 2   | n    | default | prepend to command to give a count |
+STR
+    end
+
+    it "lists keys with numbered descriptions correctly" do
+      vimdb "keys C-b"
+      stdout.must_include <<-STR
+| C-b     | n    | default | scroll N screens Backwards      |
+STR
+    end
+
+    it "lists key with incorrect separator between key and description" do
+      vimdb "keys 'use register' -a"
+      stdout.must_include <<-STR
+| "{a-zA-Z0-9.%#:-"} | n    | default | use register {a-zA-Z0-9.%#:-"} for next delete, yank or put (uppercase to a... |
 STR
     end
   end

data/spec/options_spec.rb

@@ -7,7 +7,7 @@ describe "vimdb opts" do
   end
 
   it 'searches :name field by default' do
-    vimdb 'opts' ,'wildignorec'
+    vimdb "opts wildignorec"
     stdout.must_match /1 row/
   end
 end

data/spec/runner_spec.rb

@@ -3,19 +3,19 @@ require 'tempfile'
 
 describe Vimdb::Runner do
   describe "commands" do
-    it "help prints help" do
-      vimdb 'help'
-      stdout.must_match /vimdb commands.*vimdb keys.*vimdb opts/m
+    it "--help prints help" do
+      vimdb '--help'
+      stdout.must_match /^Usage: vimdb COMMAND.*commands.*keys.*opts/m
     end
 
     it "no arguments prints help" do
       vimdb
-      stdout.must_match /vimdb commands.*vimdb keys.*vimdb opts/m
+      stdout.must_match /^Usage: vimdb COMMAND.*commands.*keys.*opts/m
     end
 
     Vimdb::Item.all.each do |item|
       it "info for #{item} prints info" do
-        vimdb 'info', item
+        vimdb "info #{item}"
         stdout.must_match /^Created/
       end
     end
@@ -34,14 +34,14 @@ describe Vimdb::Runner do
 
     it "loads user-defined commands" do
       rc_contains <<-RC
-      class Vimdb::Runner < Thor
-        desc 'new_task', ''
-        def new_task; end
+      class Vimdb::Runner
+        desc 'some task'
+        def new_task(arg); end
       end
       RC
 
-      vimdb 'help', 'new_task'
-      stdout.must_match /vimdb new_task/
+      vimdb "new_task -h"
+      stdout.must_match /^Usage: vimdb new_task ARG/
     end
 
     it "can be nonexistent" do

metadata

@@ -1,61 +1,81 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vimdb
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Gabriel Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-07 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: boson
+  requirement: &70144496636600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.14.6
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hirb
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70144496636600
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: &70144496635640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.5.0
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70144496635640
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70144496634600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.5.1
   type: :development
-  version_requirements: *id003
-description: Search your vim keybindings precisely by keystroke, mode, description or where they came from. Search vim options by name, alias and description.
+  prerelease: false
+  version_requirements: *70144496634600
+- !ruby/object:Gem::Dependency
+  name: bahia
+  requirement: &70144496633600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70144496633600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70144496632560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70144496632560
+description: Search your vim keybindings precisely by keystroke, mode, description
+  or where they came from. Search vim options by name, alias and description.
 email: gabriel.horner@gmail.com
-executables: 
+executables:
 - vimdb
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE.txt
-files: 
+files:
 - lib/vimdb/commands.rb
 - lib/vimdb/db.rb
 - lib/vimdb/item.rb
@@ -79,6 +99,7 @@ files:
 - spec/deps.rip
 - Rakefile
 - .gemspec
+- .travis.yml
 - spec/fixtures/commands_command
 - spec/fixtures/commands_index
 - spec/fixtures/keys_index
@@ -86,33 +107,30 @@ files:
 - spec/fixtures/keys_map
 - spec/fixtures/options_help
 - spec/.vimdbrc
-has_rdoc: true
 homepage: http://github.com/cldwalker/vimdb
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: vim knowledge tabularized - search vim keys, options and more with great precision.
+summary: vim knowledge tabularized - search vim keys, options and more with great
+  precision.
 test_files: []
-