vimdb 0.5.0 → 0.5.1

data/.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'boson', '>= 1.1.1'
   s.add_dependency 'hirb', '~> 0.6.0'
   s.add_development_dependency 'minitest', '~> 2.5.1'
-  s.add_development_dependency 'bahia', '~> 0.3.0'
+  s.add_development_dependency 'bahia', '~> 0.5'
   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'])

data/.travis.yml

@@ -2,3 +2,5 @@ before_install: bundle init --gemspec=.gemspec
 rvm:
 - 1.9.2
 - 1.9.3
+# disabled until bahia + rbx issues worked out
+# - rbx-19mode

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.5.1
+* Add windows support
+* Explicit abort for < 1.9.2 ruby
+
 = 0.5.0
 * rename opts command to options
 * Upgrade boson to fix multi-word arg bug

data/README.md

@@ -1,14 +1,23 @@
 Description
 ===========
 
-Improve your knowledge of vim by precise searching of vim items: keybindings, options and commands.
-For example, keys can be searched by keystroke, mode, description or where they came from.  This gem
-creates a vimdb database, ~/.vimdb.pstore, from your vim documentation. Tested with vim >= 7.2 on a
-mac. Works only on ruby 1.9.x.
+Increase the speed and amount of vim knowledge at your fingertips with precise
+searching of vim's items: keys (keybindings), options and commands. vimdb is
+aware of vim's default items, ones in your vimrc and ones in plugins. vimdb's
+plugin detection works only if you're using a pathogen-like setup i.e. each
+plugin has its own directory under ~/.vim/bundle/ (see Configuration below to
+change the directory). Tested with vim >= 7.2 on a mac. Works only on ruby 1.9.x.
+
+Install
+=======
+
+    $ gem install vimdb
 
 Usage
 =====
 
+Basic examples searching different vim items:
+
     # List keys with Ctrl
     $ vimdb keys C-
     +---------------+------+---------------------+------------------------------------------
@@ -21,6 +30,78 @@ Usage
     | <C-Home>      | n    | default             | 1  same as "gg"                         |
     | <C-Left>      | n    | default             | 1  same as "b"                          |
     ...
+    262 rows in set
+
+
+    # List options that contain word 'window' in any field
+    $ vimdb options window -a
+    +----------------+--------+----------------------------------------------------+
+    | name           | alias  | desc                                               |
+    +----------------+--------+----------------------------------------------------+
+    | autochdir      | acd    | change directory to the file in the current window |
+    | bufhidden      | bh     | what to do when buffer is no longer in window      |
+    | cedit          |        | key used to open the command-line window           |
+    | cmdwinheight   | cwh    | height of the command-line window                  |
+    | cscopequickfix | csqf   | use quickfix window for cscope results             |
+    | cursorbind     | crb    | move cursor in window as it moves in other windows |
+    | diff           |        | use diff mode for the current window               |
+    | equalalways    | ea     | windows are automatically made the same size       |
+    | guiheadroom    | ghr    | GUI: pixels room for window decorations            |
+    | helpheight     | hh     | minimum height of a new help window                |
+    | icon           |        | let Vim set the text of the window icon            |
+    ...
+    30 rows in set
+
+    # Search for commands from pathogen plugin
+    $ vimdb commands pathogen -f=from
+    +----------+-------+---------------------+-----------------------------------------------------+
+    | name     | alias | from                | desc                                                |
+    +----------+-------+---------------------+-----------------------------------------------------+
+    | Helptags |       | pathogen.vim plugin | :call pathogen#helptags()                           |
+    | Ve       |       | pathogen.vim plugin | :execute s:find(<count>,'edit<bang>',<q-args>,0)    |
+    | Vedit    |       | pathogen.vim plugin | :execute s:find(<count>,'edit<bang>',<q-args>,0)    |
+    | Vopen    |       | pathogen.vim plugin | :execute s:find(<count>,'edit<bang>',<q-args>,1)    |
+    | Vpedit   |       | pathogen.vim plugin | :execute s:find(<count>,'pedit',<q-args>,<bang>1)   |
+    | Vread    |       | pathogen.vim plugin | :execute s:find(<count>,'read',<q-args>,<bang>1)    |
+    | Vsplit   |       | pathogen.vim plugin | :execute s:find(<count>,'split',<q-args>,<bang>1)   |
+    | Vtabedit |       | pathogen.vim plugin | :execute s:find(<count>,'tabedit',<q-args>,<bang>1) |
+    | Vvsplit  |       | pathogen.vim plugin | :execute s:find(<count>,'vsplit',<q-args>,<bang>1)  |
+    +----------+-------+---------------------+-----------------------------------------------------+
+    9 rows in set
+
+    # Info about how a vim item is made
+    $ vimdb info keys
+    Created using index.txt and :map
+
+    # For a list of all commands
+    $ vimdb
+
+## More Usage
+
+As you can see from the last example, vimdb supports options for each command.
+For a command's listing of options use --help or -h:
+
+    $ vimdb keys --help
+    Usage: vimdb keys [QUERY]
+
+    Options:
+      -a, --all          search all fields
+      -f, --field        field to query
+      -i, --ignore_case
+      -m, --mode         search by mode, multiple modes are ORed
+      -n, --not          return non-matching results
+      -r, --regexp       query is a regexp
+      -R, --reload       reloads items
+      --reverse_sort
+      -s, --sort         sort by field
+      -t, --tab          print tab-delimited table
+
+    Description:
+      List vim keys
+
+
+As you can see, keys can be searched by keystroke, mode, description or from
+(default, user or plugin name). Some examples:
 
     # List keys with Ctrl-A combo
     $ vimdb keys C-A
@@ -40,8 +121,6 @@ Usage
     # List keys I've defined in vimrc
     $ vimdb keys user -f=from
 
-    # Plugins are assumed to be in ~/.vim/bundle/ i.e. for pathogen
-    # Change with Vimdb.plugins_dir
     # List keys from my plugins
     $ vimdb keys plugin -f=from
 
@@ -51,25 +130,78 @@ Usage
     # List keys that contain completion in description
     $ vimdb keys completion -f=desc
 
-    # List options that contain window in description
-    $ vimdb options window -f=desc
-
-    # List commands mentioning 'buffer' in any field
-    $ vimdb commands buffer -a
-
-    # Info about how vim items were made
-    $ vimdb info keys
-    $ vimdb info options
+Advanced Usage
+==============
+
+vimdb can be customized with your own commands thanks to its rc file and command
+engine, [boson](http://github.com/cldwalker/boson). For example,
+[my rc file](https://github.com/cldwalker/dotfiles/blob/master/.vimdbrc)
+defines a command that detects conflicts between default keys and plugin keys:
+
+    $ vimdb conflict
+    +-------+------+---------------------+---------------------------------------------------------------------------------+
+    | key   | mode | from                | desc/action                                                                     |
+    +-------+------+---------------------+---------------------------------------------------------------------------------+
+    | C-w o | n    | default             | close all but current window (like |:only|)                                     |
+    | C-w o | n    | zoomwin plugin      | <Plug>ZoomWin                                                                   |
+    | *     | n    | default             | search forward for the Nth occurrence of the ident under the cursor             |
+    | *     | nos  | tcomment_vim plugin | :TCommentRight<CR>                                                              |
+    | *     | n    | default             | search forward for the Nth occurrence of the ident under the cursor             |
+    | *     | nos  | tcomment_vim plugin | :TComment<CR>                                                                   |
+    ...
 
-    # For more
-    $ vimdb help
+If you look at conflict's implementation, you see it's only about a dozen lines.
+Since vimdb stores vim items as array of hashes, you can use these within
+commands for whatever purpose.
+
+To illustrate creating a command, let's create one that lists the first
+given number of vim commands. In your ~/.vimdbrc:
+
+```ruby
+class Vimdb::Runner
+  desc "Prints first X options"
+  def first(num)
+    # Set item type we're retrieving
+    Vimdb.item('options')
+    puts Vimdb.user.items.first(num.to_i).map {|e| e[:name] }
+  end
+end
+```
+
+To test drive it:
+
+    $ vimdb first 5
+    aleph
+    allowrevins
+    altkeymap
+    ambiwidth
+    antialias
 
 Configuration
 =============
 
-Configure vimdb with a ~/.vimdbrc, which is loaded before every command request. Use it to define
-additional commands. For an example, [see my rc
-file](https://github.com/cldwalker/dotfiles/blob/master/.vimdbrc).
+Configure vimdb with a ~/.vimdbrc (in ruby), which is loaded before every
+command request. For example, to configure where plugins are stored:
+
+    # plugins stored in ~/.vim/plugins
+    Vimdb.plugins_dir = 'plugins'
+
+For a more thorough example,
+[see my rc file](https://github.com/cldwalker/dotfiles/blob/master/.vimdbrc).
+
+Vim Mappings
+============
+
+Since vimdb runs on ruby 1.9.x, there's a good chance you don't have vim
+compiled against ruby 1.9.x.  No worries, use rvm or rbenv to install a 1.9.x
+version. Then to invoke vimdb within vim, set up a key to pipe out to vimdb
+using rvm or rbenv:
+
+```vim
+map <Leader>v :!rbenv exec vimdb
+" or for rvm
+map <Leader>v :!rvm 1.9.3 vimdb
+```
 
 Key Modes
 =========
@@ -92,11 +224,24 @@ The following modes from :map were altered to fit into the above modes:
 * x -> v
 * v -> vs
 
+How It Works
+============
+
+This gem creates a vimdb database, ~/.vimdb.pstore, by parsing your vim
+documentation and outputs of vim commands. When an item is first searched it is
+parsed. Subsequent searches are cached. To reload (and reparse) you database,
+pass a --reload option to most commands.
+
 Motivation
 ==========
 
 Wanted to learn faster than :help would let me.
 
+Credits
+=======
+
+* mattn for windows support
+
 Contributing
 ============
 [See here](http://tagaholic.me/contributing.html)

data/bin/vimdb

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
 
+if RUBY_VERSION < '1.9.2'
+  abort "vimdb only runs on ruby >= 1.9.2. " +
+    "Use rbenv or rvm to install the latest 1.9 ruby."
+end
+
 require 'vimdb'
 Vimdb::Runner.start

data/lib/vimdb/item.rb

@@ -61,7 +61,12 @@ module Vimdb
     private
 
     def vim(*cmds)
-      system %[#{Vimdb.vim} -c 'colorscheme default | #{cmds.join(' | ')} | qa']
+      quote = "'"
+      if RUBY_PLATFORM =~ /mswin(?!ce)|mingw|cygwin|bccwin/i
+        cmds = cmds.map{|x| x.gsub(/"/,'"""') }
+        quote = '"'
+      end
+      system %[#{Vimdb.vim} -N -u NONE --cmd #{quote}colorscheme default | #{cmds.join(' | ')} | qa#{quote}]
     end
 
     if ENV['VIMDB_FIXTURE_DIR']

data/lib/vimdb/version.rb

@@ -1,3 +1,3 @@
 module Vimdb
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/deps.rip

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vimdb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-09 00:00:00.000000000 Z
+date: 2012-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boson
-  requirement: &70144353831720 !ruby/object:Gem::Requirement
+  requirement: &70096513129620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70144353831720
+  version_requirements: *70096513129620
 - !ruby/object:Gem::Dependency
   name: hirb
-  requirement: &70144353831140 !ruby/object:Gem::Requirement
+  requirement: &70096513129060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70144353831140
+  version_requirements: *70096513129060
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70144353830620 !ruby/object:Gem::Requirement
+  requirement: &70096513128420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,21 +43,21 @@ dependencies:
         version: 2.5.1
   type: :development
   prerelease: false
-  version_requirements: *70144353830620
+  version_requirements: *70096513128420
 - !ruby/object:Gem::Dependency
   name: bahia
-  requirement: &70144353830100 !ruby/object:Gem::Requirement
+  requirement: &70096513127180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *70144353830100
+  version_requirements: *70096513127180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70144353829640 !ruby/object:Gem::Requirement
+  requirement: &70096513126640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70144353829640
+  version_requirements: *70096513126640
 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