vimdb 0.1.0

data/.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless Object.const_defined?(:Gem)
+require File.dirname(__FILE__) + "/lib/vimdb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vimdb"
+  s.version     = Vimdb::VERSION
+  s.authors     = ["Gabriel Horner"]
+  s.email       = "gabriel.horner@gmail.com"
+  s.homepage    = "http://github.com/cldwalker/vimdb"
+  s.summary =  "vim knowledge tabularized - search vim keys, options and more with great precision."
+  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.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc,md} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
+  s.files += Dir.glob(['man/*', '*.gemspec'])
+  s.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  s.license = 'MIT'
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+= 0.1.0
+* Finally a release!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2011 Gabriel Horner
+
+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.

data/README.md

@@ -0,0 +1,93 @@
+Description
+===========
+
+Improve your knowledge of vim by tabularizing vim items: keybindings, options and more. This allows for
+precise searching of items. 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.
+
+Usage
+=====
+
+    # List keys with Ctrl
+    $ vimdb keys C-
+    +---------------+------+---------------------+------------------------------------------
+    | key           | mode | from                | desc                                    |
+    +---------------+------+---------------------+-----------------------------------------|
+    | 0 C-d         | i    | default             | delete all indent in the current line   |
+    | <C-End>       | i    | default             | cursor past end of fil                  |
+    | <C-End>       | n    | default             | 1  same as "G"                          |
+    | <C-Home>      | i    | default             | cursor to start of file                 |
+    | <C-Home>      | n    | default             | 1  same as "gg"                         |
+    | <C-Left>      | n    | default             | 1  same as "b"                          |
+    ...
+
+    # List keys with Ctrl-A combo
+    $ vimdb keys C-A
+
+    # List keys with Esc key
+    $ vimdb keys E-
+
+    # List keys with Leader
+    $ vimdb keys L-
+
+    # List insert mode keys
+    $ vimdb keys -m=i
+
+    # List keys I've defined in vimrc
+    $ vimdb keys user -f=from
+
+    # Plugins are assumed to be in ~/.vim/plugins/ directory
+    # Change with Vimdb::Keys.config[:plugins_dir]
+    # List keys from my plugins
+    $ vimdb keys plugin -f=from
+
+    # List keys from snipmate plugin
+    $ vimdb keys snipmate -f=from
+
+    # List keys that contain completion in description
+    $ vimdb keys completion -f=desc
+
+    # List options that contain window in description
+    $ vimdb opts window -f=desc
+
+    # Info about how vim items were made
+    $ vimdb info keys
+    $ vimdb info options
+
+    # For more
+    $ vimdb help
+
+Key Modes
+=========
+
+Vim's key modes are represented as single letters
+
+* n: normal
+* c: commandline
+* i: insert
+* o: operation
+* v: visual
+* s: select
+
+If you're unfamiliar with all these modes read about them in vim with ':h :map-modes'.
+
+The following modes from :map were altered to fit into the above modes:
+
+* ! -> ci
+* l -> ci
+* x -> v
+* v -> vs
+
+Motivation
+==========
+
+Wanted to learn faster than :help would let me.
+
+Todo
+====
+
+* Tests!
+* Add support for more vim items - commands, variables, functions
+* Fix keys - index.txt edge cases
+* Considering user annotation for vim items

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run tests'
+task :test do |t|
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
+end
+
+task :default => :test

data/bin/vimdb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'vimdb'
+Vimdb::Runner.start

data/deps.rip

@@ -0,0 +1,2 @@
+thor ~>0.14.6
+hirb ~>0.5.0

data/lib/vimdb.rb

@@ -0,0 +1,19 @@
+module Vimdb
+  autoload :Runner, 'vimdb/runner'
+  autoload :User,   'vimdb/user'
+  autoload :DB,     'vimdb/db'
+  autoload :Item,   'vimdb/item'
+  autoload :Keys,    'vimdb/keys'
+
+  class << self; attr_accessor :default_item, :vim; end
+  self.default_item = ENV['VIMDB_ITEM'] || 'keys'
+  self.vim = 'vim'
+
+  def self.user(item_name = nil, db = DB.new)
+    @user ||= User.new(item(item_name), db)
+  end
+
+  def self.item(name = nil)
+    @item ||= Item.instance(name || default_item)
+  end
+end

data/lib/vimdb/db.rb

@@ -0,0 +1,19 @@
+require 'pstore'
+
+module Vimdb
+  class DB
+    attr_accessor :file
+    def initialize(file = Dir.home + '/.vimdb.pstore')
+      @file = file
+      @db = PStore.new(@file)
+    end
+
+    def get(key)
+      @db.transaction(true) { @db[key] }
+    end
+
+    def set(key, value)
+      @db.transaction { @db[key] = value }
+    end
+  end
+end

data/lib/vimdb/item.rb

@@ -0,0 +1,55 @@
+module Vimdb
+  class Item
+    def self.inherited(mod)
+      (@descendants ||= []) << mod
+    end
+
+    def self.load_item(name)
+      require "vimdb/#{name}"
+    rescue LoadError
+    end
+
+    def self.instance(name)
+      load_item(name)
+      item = @descendants.find {|e| e.item_name == name } or
+        abort "Item '#{name}' not found"
+      item.new
+    end
+
+    def self.item_name
+      name[/\w+$/].downcase
+    end
+
+    def search(items, query, options = {})
+      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 }
+      end
+      items
+    end
+
+    # key used to store item in DB
+    def key
+      self.class.item_name
+    end
+
+    def create
+      raise NotImplementedError
+    end
+
+    def info
+      raise NotImplementedError
+    end
+
+    def display_fields
+      raise NotImplementedError
+    end
+
+    private
+
+    def vim(*cmds)
+      system %[#{Vimdb.vim} -c 'colorscheme default | #{cmds.join(' | ')} | qa']
+    end
+  end
+end

data/lib/vimdb/keys.rb

@@ -0,0 +1,133 @@
+require 'tempfile'
+
+class Vimdb::Keys < Vimdb::Item
+  class << self; attr_accessor :config end
+  self.config = {
+    plugins_dir: 'plugins',
+    modifiers: {'<Esc>' => 'E'},
+    mode_map: {'!' => 'ci', 'v' => 'vs', 'x' => 'v', 'l' => 'ci'},
+  }
+
+  def initialize
+    @modifiers, @mode_map = self.class.config.values_at(:modifiers, :mode_map)
+    @plugins_dir = self.class.config[:plugins_dir]
+  end
+
+  def create
+    keys = parse_index_file create_index_file
+    @leader ||= get_leader
+    @modifiers[@leader] ||= 'L'
+    keys + parse_map_file(create_map_file)
+  end
+
+  def search(keys, query, options = {})
+    keys = super
+    if options[:mode]
+      keys.select! do |key|
+        options[:mode].split('').any? {|m| key[:mode].include?(m) }
+      end
+    end
+    keys
+  end
+
+  def info
+    "Created using index.txt and :map"
+  end
+
+  def display_fields
+    [:key, :mode, :from, :desc]
+  end
+
+  private
+
+  def get_leader
+    file = Tempfile.new('vim-leader').path
+    leader_cmd = %[silent! echo exists("mapleader") ? mapleader : ""]
+    vim "redir! > #{file}", leader_cmd, 'redir END'
+    leader = File.readlines(file).last.chomp
+    {' ' => '<Space>', '' => '\\'}[leader] || leader
+  end
+
+  def create_index_file
+    file = Tempfile.new('vim-index').path
+    vim 'silent help index.txt', "silent! w! #{file}"
+    file
+  end
+
+  def parse_index_file(file)
+    lines = File.read(file).split("\n")
+    sections = lines.slice_before(/^={10,}/).to_a
+    header_modes = [
+      ['1. Insert mode', 'i'], ['2.1', 'ovs'], ['2.', 'n'],
+      ['3. Visual mode', 'vs'], ['4. Command-line editing', 'c']
+    ]
+
+    keys = []
+    # skip intro and last Ex section
+    sections[1..-2].each do |section_lines|
+      mode = header_modes.find {|k,v|
+        section_lines[1] =~ Regexp.new('^' + Regexp.quote(k))
+      }.to_a[1] || '?'
+
+      #drop section header
+      section_lines = section_lines.drop_while {|e| e !~ /^\|/ }
+
+      section_lines.each do |e|
+        cols = e.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
+        end
+      end
+    end
+    keys
+  end
+
+  def translate_index_key(key)
+    key.gsub(/CTRL-([A-Z])/) {|s| "C-#{$1.downcase}" }
+  end
+
+  def create_map_file
+    file = Tempfile.new('vim-map').path
+    vim "redir! > #{file}", "silent! verbose map", 'redir END'
+    file
+  end
+
+  def parse_map_file(file)
+    lines = File.read(file).strip.split("\n")
+    lines.slice_before {|e| e !~ /Last set/ }.map do |arr|
+      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'
+
+      key[:key]  = arr[0][/^\S*\s+(\S+)/, 1]
+      next if key[:key][/^(<Plug>|<SNR>)/]
+      key[:key] = translate_map_key(key[:key])
+
+      key[:desc] = arr[0][/^\S*\s+\S+\s+(.*)$/, 1]
+      key[:mode] = (mode = arr[0][/^[nvsxo!ilc]+/]) ?
+        @mode_map[mode] || mode : 'nvso'
+      key
+    end.compact
+  end
+
+  def translate_map_key(key)
+    if match = /^(?<modifier>#{Regexp.union(*@modifiers.keys)})(?<first>\S)(?<rest>.*$)/.match(key)
+      rest = match[:rest].empty? ? '' : ' ' + match[:rest]
+      "#{@modifiers[match[:modifier]]}-#{match[:first]}" + rest
+    elsif match = /^<(?<ctrl>C-[^>])>(?<rest>.*$)/.match(key)
+      rest = match[:rest].empty? ? '' :
+        ' ' + match[:rest].gsub(/<(C-[^>])>/, '\1')
+      (match[:ctrl] + rest).gsub(/C-([A-Z])/) {|s| "C-#{$1.downcase}" }
+    else
+      key
+    end
+  end
+end

data/lib/vimdb/options.rb

@@ -0,0 +1,23 @@
+class Vimdb::Options < Vimdb::Item
+  def display_fields
+    [:name, :alias, :desc]
+  end
+
+  def info
+    "Created using :help option-list"
+  end
+
+  def create
+    file = '.vimdb.temp'
+    # TODO: tempfile not working
+    #file = Tempfile.new('vim-options').path
+    vim 'silent help option-list', 'exe "normal 2_y}"', 'new', 'exe "normal p"',
+      "silent! w! #{file}"
+
+    opts = File.read(file).scan(/^'(\S+)'\s*('\S*')?\s*(.*$)/).map do |line|
+      { name: line[0], alias: line[1] ? line[1][1..-2] : '', desc: line[2] }
+    end
+    File.unlink file
+    opts
+  end
+end

data/lib/vimdb/runner.rb

@@ -0,0 +1,51 @@
+require 'thor'
+require 'hirb'
+
+class Vimdb::Runner < Thor
+  def self.start(*args)
+    rc = ENV['VIMDBRC'] || '~/.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
+
+  def self.common_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'
+  end
+
+  common_options
+  method_option :field, :default => 'key', :desc => 'field to query', :aliases => '-f'
+  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)
+    search_item(query)
+  end
+
+  common_options
+  method_option :field, :default => 'name', :desc => 'field to query', :aliases => '-f'
+  desc 'opts [QUERY]', 'List vim options'
+  def opts(query = nil)
+    Vimdb.item('options')
+    search_item(query)
+  end
+
+  desc 'info', 'Prints info about an item'
+  def info(item = nil)
+    puts Vimdb.item(item).info
+  end
+
+  private
+  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)
+  end
+end

data/lib/vimdb/user.rb

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

data/lib/vimdb/version.rb

@@ -0,0 +1,3 @@
+module Vimdb
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: vimdb
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hirb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id002
+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: 
+- vimdb
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE.txt
+files: 
+- lib/vimdb/db.rb
+- lib/vimdb/item.rb
+- lib/vimdb/keys.rb
+- lib/vimdb/options.rb
+- lib/vimdb/runner.rb
+- lib/vimdb/user.rb
+- lib/vimdb/version.rb
+- lib/vimdb.rb
+- bin/vimdb
+- LICENSE.txt
+- CHANGELOG.rdoc
+- README.md
+- deps.rip
+- Rakefile
+- .gemspec
+has_rdoc: true
+homepage: http://github.com/cldwalker/vimdb
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: vim knowledge tabularized - search vim keys, options and more with great precision.
+test_files: []
+