vimdb 0.2.0 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+= 0.3.0
+* Several fixes to key parsing
+* Add all + not search options
+* Fix reloading
+
 = 0.2.0
 * Several bug fixes
 * Add support for commands

data/README.md

@@ -31,6 +31,9 @@ Usage
     # List keys with Leader
     $ vimdb keys L-
 
+    # List keys with no Leader - not of last search
+    $ vimdb keys L- -n
+
     # List insert mode keys
     $ vimdb keys -m=i
 
@@ -51,8 +54,8 @@ Usage
     # List options that contain window in description
     $ vimdb opts window -f=desc
 
-    # List commands about buffers
-    $ vimdb commands buffer -f=desc
+    # List commands mentioning 'buffer' in any field
+    $ vimdb commands buffer -a
 
     # Info about how vim items were made
     $ vimdb info keys
@@ -61,6 +64,13 @@ Usage
     # For more
     $ vimdb help
 
+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).
+
 Key Modes
 =========
 
@@ -94,8 +104,5 @@ Contributing
 Todo
 ====
 
-* Fix test coupling
-* More tests!
-* Fix keys - index.txt edge cases
 * Add support for more vim items - variables, functions
 * Considering user annotation for vim items

data/Rakefile

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

data/lib/vimdb/commands.rb

@@ -48,8 +48,8 @@ class Vimdb::Commands < Vimdb::Item
       cmd = {}
 
       cmd[:file] = arr[1].to_s[%r{Last set from (\S+)}, 1] or next
-      cmd[:from] = cmd[:file].to_s[%r{/#{@plugins_dir}/([^/]+)\S+}, 1] || 'user'
-      cmd[:from] << ' plugin' if cmd[:from] != 'user'
+      match = cmd[:file].to_s.match(%r{/#{@plugins_dir}/(?<plugin>[^/]+)})
+      cmd[:from] = match ? match[:plugin] + ' plugin' : 'user'
       cmd[:name]  = arr[0][/^(?:[!b" ]+)(\S+)/, 1]
       cmd[:desc]  = arr[0][/^(?:[!b" ]+)\S+\s*(.*)$/, 1]
       if cmd[:desc][/^(\*|\+|\?|\d)\s+(\dc?|%|\.)?\s*(#{completions})?\s*(.*)/]
@@ -60,7 +60,7 @@ class Vimdb::Commands < Vimdb::Item
     end.compact
   end
 
-  def display_fields
+  def fields
     [:name, :alias, :from, :desc]
   end
 

data/lib/vimdb/item.rb

@@ -24,7 +24,15 @@ module Vimdb
       if query
         query = Regexp.escape(query) unless options[:regexp]
         regex = Regexp.new(query, options[:ignore_case])
-        items.select! {|e| e[options[:field].to_sym] =~ regex }
+
+        if options[:all]
+          items.select! {|item|
+            fields.any? {|field| item[field] =~ regex }
+          }
+        else
+          search_field = options[:field] ? options[:field].to_sym : default_field
+          items.select! {|item| item[search_field] =~ regex }
+        end
       end
       items
     end
@@ -42,10 +50,14 @@ module Vimdb
       raise NotImplementedError
     end
 
-    def display_fields
+    def fields
       raise NotImplementedError
     end
 
+    def default_field
+      fields[0]
+    end
+
     private
 
     def vim(*cmds)

data/lib/vimdb/keys.rb

@@ -31,7 +31,7 @@ class Vimdb::Keys < Vimdb::Item
     "Created using index.txt and :map"
   end
 
-  def display_fields
+  def fields
     [:key, :mode, :from, :desc]
   end
 
@@ -70,22 +70,43 @@ class Vimdb::Keys < Vimdb::Item
       #drop section header
       section_lines = section_lines.drop_while {|e| e !~ /^\|/ }
 
-      section_lines.each do |e|
-        cols = e.split(/\t+/)
+      section_lines.each do |line|
+        cols = line.split(/\t+/)
         if cols.size >= 3
-          key = translate_index_key cols[-2]
-          keys << {mode: mode, key: key, desc: cols[-1].strip, :from => 'default'}
-        # add desc from following lines
-        elsif cols.size == 2 && cols[0] == ''
-          keys[-1][:desc] += ' ' + cols[1].strip
-        # else
-        # TODO: parse few edge cases
+          desc = cols[-1] == '"' ? keys[-1][:desc] : cols[-1]
+          keys << create_index_key(mode, cols[-2], desc)
+          keys.pop if keys[-1][:desc] == 'not used'
+        elsif cols.size == 2
+          # add desc from following lines
+          if cols[0] == ''
+            if cols[1] !~ /^(Meta characters|not used)/
+              keys[-1][:desc] += ' ' + cols[1].strip
+            end
+          else
+            keys << create_index_key(mode, cols[1])
+          end
+        elsif cols.size == 1
+          tag, key = line.split(/\s+/, 2)
+          if tag == '|i_CTRL-V_digit|'
+            key, desc = key.split(/(?<=})/)
+            keys << create_index_key(mode, key, desc)
+          elsif tag == '|CTRL-W_g_CTRL-]|'
+            key, desc = key.split(/(?<=\])/)
+            keys << create_index_key(mode, key, desc)
+          else
+            keys << create_index_key(mode, key)
+          end
         end
       end
     end
     keys
   end
 
+  def create_index_key(mode, key, desc = nil)
+    desc = desc ? desc.strip : ''
+    { mode: mode, key: translate_index_key(key), desc: desc, from: 'default' }
+  end
+
   def translate_index_key(key)
     key.gsub(/CTRL-(\S)/) {|s| "C-#{$1.downcase}" }
   end
@@ -103,8 +124,8 @@ class Vimdb::Keys < Vimdb::Item
       key = {}
 
       key[:file] = arr[1].to_s[%r{Last set from (\S+)}, 1] or next
-      key[:from] = key[:file].to_s[%r{/#{@plugins_dir}/([^/]+)\S+}, 1] || 'user'
-      key[:from] += ' plugin' if key[:from] != 'user'
+      match = key[:file].to_s.match(%r{/#{@plugins_dir}/(?<plugin>[^/]+)})
+      key[:from] = match ? match[:plugin] + ' plugin' : 'user'
 
       key[:key]  = arr[0][/^\S*\s+(\S+)/, 1]
       next if key[:key][/^(<Plug>|<SNR>)/]

data/lib/vimdb/options.rb

@@ -1,5 +1,5 @@
 class Vimdb::Options < Vimdb::Item
-  def display_fields
+  def fields
     [:name, :alias, :desc]
   end
 

data/lib/vimdb/runner.rb

@@ -13,16 +13,18 @@ class Vimdb::Runner < Thor
     super
   end
 
-  def self.common_options
+  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'
   end
 
-  common_options
-  method_option :field, :default => 'key', :desc => 'field to query', :aliases => '-f'
+  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)
@@ -30,23 +32,21 @@ class Vimdb::Runner < Thor
     search_item(query)
   end
 
-  common_options
-  method_option :field, :default => 'name', :desc => 'field to query', :aliases => '-f'
+  common_search_options
   desc 'opts [QUERY]', 'List vim options'
   def opts(query = nil)
     Vimdb.item('options')
     search_item(query)
   end
 
-  common_options
-  method_option :field, :default => 'name', :desc => 'field to query', :aliases => '-f'
+  common_search_options
   desc 'commands [QUERY]', 'List vim commands'
   def commands(query = nil)
     Vimdb.item('commands')
     search_item(query)
   end
 
-  desc 'info', 'Prints info about an item'
+  desc 'info [ITEM]', 'Prints info about an item'
   def info(item = nil)
     puts Vimdb.item(item).info
   end
@@ -55,6 +55,6 @@ class Vimdb::Runner < Thor
   def search_item(query = nil)
     Vimdb.user.reload if options[:reload]
     keys = Vimdb.user.search(query, options)
-    puts Hirb::Helpers::Table.render(keys, fields: Vimdb.item.display_fields)
+    puts Hirb::Helpers::Table.render(keys, fields: Vimdb.item.fields)
   end
 end

data/lib/vimdb/user.rb

@@ -2,24 +2,25 @@ module Vimdb
   class User
     def initialize(item, db)
       @item, @db = item, db
-      @db_exists = File.exists?(@db.file)
+      @reload = !File.exists?(@db.file)
     end
 
     def items
-      @db_exists ? @db.get(@item.key) :
-        @db.set(@item.key, @item.create).tap { @db_exists = true }
+      !@reload && @db.get(@item.key) ||
+        @db.set(@item.key, @item.create).tap { @reload = false }
     end
 
     def search(query, options = {})
-      results = @item.search(items, query, options)
-      sort = options[:sort] || options[:field]
+      results = @item.search(items.dup, query, options)
+      results = items - results if options[:not]
+      sort = options[:sort] || options[:field] || @item.default_field
       results.sort_by! {|e| e[sort.to_sym] || '' }
       results.reverse! if options[:reverse_sort]
       results
     end
 
     def reload
-      @db_exists = false
+      @reload = true
     end
   end
 end

data/lib/vimdb/version.rb

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

data/spec/.vimdbrc

@@ -1 +1 @@
-Vimdb.plugins_dir = 'plugins'
+Vimdb.plugins_dir = '(plugins|autoload)'

data/spec/commands_spec.rb

@@ -43,6 +43,13 @@ STR
     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'
+    stdout.must_include <<-STR
+| Vopen |       | pathogen.vim plugin | :execute s:find(<count>,'edit<bang>',<q-args>,1) |
 STR
   end
 end

data/spec/common_search_options_spec.rb

@@ -0,0 +1,36 @@
+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'
+    stdout.must_match /^0 rows/
+  end
+
+  it "with --reverse_sort option reverse sorts field" do
+    vimdb 'keys', '-R'
+    stdout.must_match /gq.*'\]/m
+  end
+
+  it "with --regexp option converts search to regexp" do
+    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'
+    stdout.must_match /q:.*1 row/m
+  end
+
+  it "with --not option returns all non-matching results" do
+    vimdb 'keys', 'blarg', '-n'
+    stdout.must_match /928 rows/
+  end
+
+  it "with --all option searches all fields" do
+    vimdb 'keys', 'C', '-a'
+    stdout.must_match /365 rows/
+    # from desc field
+    stdout.must_include ' :TComment<CR>'
+  end
+end

data/spec/keys_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/helper')
 describe "vimdb keys" do
   it "lists all keys by default" do
     vimdb 'keys'
-    stdout.must_match /903 rows/
+    stdout.must_match /928 rows/
   end
 
   it 'searches :key field by default' do
@@ -11,27 +11,6 @@ describe "vimdb keys" do
     stdout.must_match /1 row/
   end
 
-  it "with --field option searches another field" do
-    vimdb 'keys', 'L-z' ,'-f=desc'
-    stdout.must_match /0 rows/
-  end
-
-  it "with --reverse_sort option reverse sorts field" do
-    vimdb 'keys', '-R'
-    stdout.must_match /gq.*'\]/m
-  end
-
-  it "with --regexp option converts search to regexp" do
-    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'
-    stdout.must_match /q:.*1 row/m
-  end
-
   it 'with --mode option ANDs mode to search' do
     vimdb 'keys', 'gm', '-m=n'
     stdout.must_match /1 row/
@@ -40,13 +19,13 @@ describe "vimdb keys" do
   describe "edge cases" do
     it "converts control key to C-" do
       vimdb 'keys', 'C-z'
-      stdout.wont_match /0 rows/
+      stdout.wont_match /^0 rows/
       stdout.must_match /C-z/
     end
 
     it "converts escape key to E-" do
       vimdb 'keys', 'E-x'
-      stdout.wont_match /0 rows/
+      stdout.wont_match /^0 rows/
       stdout.must_match /E-x/
     end
 
@@ -74,7 +53,52 @@ describe "vimdb keys" do
 
     it "doesn't list Plug keys" do
       vimdb 'keys', 'Plug'
-      stdout.must_match /0 rows/
+      stdout.must_match /^0 rows/
+    end
+
+    it "doesn't list not used keys" do
+      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'
+      stdout.must_include <<-STR
+| {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'
+      stdout.must_include <<-STR
+| 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}'
+      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-]'
+      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'
+      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'
+      stdout.must_include <<-STR
+| 2   | n    | default | prepend to command to give a count |
+STR
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: vimdb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-24 00:00:00 -04:00
+date: 2011-11-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,7 @@ files:
 - lib/vimdb/version.rb
 - lib/vimdb.rb
 - spec/commands_spec.rb
+- spec/common_search_options_spec.rb
 - spec/helper.rb
 - spec/keys_spec.rb
 - spec/options_spec.rb