rb_nav 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+*.swp
+*~.nib
+build/
+*.pbxuser
+*.perspective
+*.perspectivev3
+*.mode1v3
+*.mode2v3
+xcuserdata
+src/
+pkg/
+rdoc-3.6.1/
+other/

data/MIT-LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Daniel Choi, http://danielchoi.com/software/
+
+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/NOTES

@@ -0,0 +1,10 @@
+
+
+
+nav/methods.sh app/models/delivery.rb
+nav/nav.sh 
+
+TODO
+- function to show everywhere a class or method is called in the code
+  - autocomplete
+- look for constants too ^\s*[A-Z]\w+\s*=\s*\S

data/README.markdown

@@ -0,0 +1,91 @@
+# RbNav
+
+RbNav is a lightweight Vim pluging that helps you navigate the classes,
+modules, and methods in your Ruby project 
+
+[screenshots]
+
+Benefits
+
+* navigate the classes and modules in your Ruby projects with less typing
+* jump to methods on current page more quickly
+* symbol-centric approach to navigation might suit you better than the file-centric approach
+
+
+## Prerequisites
+
+* Ruby 1.8.6 (tested on 1.9.2)
+* Vim 7.2 or higher
+
+## Install
+
+    gem install rb_nav
+
+Then
+
+    rb_nav_install
+
+This installs the rb_nav.vim plugin into your ~/.vim/plugin directory. 
+
+To upgrade RbNav to a newer version, just repeat the installation procedure.
+Don't forget to run `rb_nav_install` again after you download the new gem.
+
+
+## Commands
+
+For the all the commands below, the mapleader is assumed to be `,`. If it is
+`\` or something else for your setup, use that instead.
+
+### Invoking the plugin
+
+* `,N` navigate the classes and modules in your project
+* `,n` navigating the methods in the current file
+
+
+Press `TAB` to start autocompletion.
+
+Use the standard Vim autocompletion commands to move up and down the match
+list.
+
+* `CTRL-p` and `CTRL-n` let you navigate the drop-down matches. Press `ENTER` to select
+one.
+* `CTRL-e` closes the match list and lets you continue typing
+* `CTRL-u`: when the match list is active, cycles forward through the match
+  list and what you've typed so far; when the match list is inactive, erases
+  what you've typed.
+* both `TAB` and `CTRL-x CTRL-u` reactivates autocompletion if it's gone away
+* `CTRL-y` selects the highlighted match without triggering ENTER
+
+
+### The search path
+
+By default RbNav looks for `app`, `lib`, and `test` directories in your working
+directory and adds what it finds to the search path.
+
+You can customize the search path by putting something like this in a `.vimrc` 
+files at the root of your project's directory.
+
+    let g:RbNavPaths = "application lib spec"
+
+The directories should be separated by spaces.
+
+
+## Bug reports and feature requests
+
+Please submit them here:
+
+* <https://github.com/danchoi/rb_nav/issues>
+
+
+## About the developer
+
+My name is Daniel Choi. I specialize in Ruby, Rails, MySQL, PostgreSQL, and iOS
+development. I am based in Cambridge, Massachusetts, USA.
+
+* Twitter: [@danchoi][twitter] 
+* Personal Email: dhchoi@gmail.com  
+* My Homepage: <http://danielchoi.com/software>
+
+[twitter]:http://twitter.com/#!/danchoi
+
+

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+
+desc "release and build and push new website"
+task :push => [:release, :web]
+
+desc "Bumps version number up one and git commits"
+task :bump do
+  basefile = "lib/rb_nav/version.rb"
+  file = File.read(basefile)
+  oldver = file[/VERSION = '(\d.\d.\d)'/, 1]
+  newver_i = oldver.gsub(".", '').to_i + 1
+  newver = ("%.3d" % newver_i).split(//).join('.')
+  puts oldver
+  puts newver
+  puts "Bumping version: #{oldver} => #{newver}"
+  newfile = file.gsub("VERSION = '#{oldver}'", "VERSION = '#{newver}'") 
+  File.open(basefile, 'w') {|f| f.write newfile}
+  `git commit -am 'Bump'`
+end
+
+desc "build and push website"
+task :web => :build_webpage do
+  puts "Building and pushing website"
+  Dir.chdir "../project-webpages" do
+    `scp out/rb_nav.html zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+    `rsync -avz out/images-rb_nav zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+    `rsync -avz out/stylesheets zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+    `rsync -avz out/lightbox2 zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
+  end
+  #`open http://danielchoi.com/software/rb_nav.html`
+end
+
+desc "build webpage"
+task :build_webpage do
+  `cp README.markdown ../project-webpages/src/rb_nav.README.markdown`
+  `cp coverage.markdown ../project-webpages/src/rb_nav.coverage.markdown`
+  Dir.chdir "../project-webpages" do
+    puts `ruby gen.rb rb_nav #{RIVim::VERSION}`
+    `open out/rb_nav.html`
+  end
+end
+
+
+desc "git push and rake release bumped version"
+task :bumped do
+  puts `git push && rake release`
+  Rake::Task["web"].execute
+end
+
+desc "Run tests"
+task :test do 
+  $:.unshift File.expand_path("test")
+  require 'test_helper'
+  Dir.chdir("test") do 
+    Dir['*_test.rb'].each do |x|
+      puts "requiring #{x}"
+      require x
+    end
+  end
+
+  MiniTest::Unit.autorun
+end
+
+task :default => :test
+

data/bin/rb_nav_classes

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+# Use this pipe
+# grep -rn  '^\s*\(class\|module\) ' app lib | ruby nav/nav.rb  
+
+begin
+  xs = STDIN.readlines.
+    map {|x| 
+      parts = x.strip.split(/:/,3)
+      path, line, klass = *parts
+      klass = klass ? klass.strip.sub(/^\w+\s/,'') : "no class"
+      if klass =~ /<<\s*self/
+        nil
+      else
+        [klass, [path, line].join(':')] 
+      end
+    }.compact
+
+  max_width = xs.reduce(0) { |max, x| [x[0].length, max].max }
+
+  xs.each do |x|
+    klass, path = *x
+    puts "%-#{max_width}s %s" % [klass, path]
+  end
+rescue
+  puts $!
+end
+

data/bin/rb_nav_install

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+begin
+  require 'install'
+rescue LoadError
+  require 'rubygems'
+  require 'install'
+end
+
+`mkdir -p #{ENV['HOME']}/.vim/plugin`
+vimscript_file = File.join(File.dirname(__FILE__), '..', 'lib/rb_nav.vim')
+
+path = "#{ENV['HOME']}/.vim/plugin/"
+`cp #{vimscript_file} #{path}`
+puts "rb_nav.vim installed at #{path}"

data/bin/rb_nav_methods

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# Use this pipe
+#grep -rn  '^\s*\def ' $1 | ruby nav/methods.rb  
+
+xs = STDIN.readlines.
+  map {|x| 
+    line, method = *x.strip.split(/:/) 
+    method = method.strip
+    [method, line]
+  }
+
+max_width = xs.reduce(0) { |max, x| [x[0].length, max].max }
+
+xs.each do |x|
+  method, line = *x
+  puts "%-#{max_width}s %s" % [method, line]
+end
+

data/lib/rb_nav/version.rb

@@ -0,0 +1,4 @@
+module RbNav
+
+  VERSION = '0.0.1'
+end

data/lib/rb_nav.rb

@@ -0,0 +1,4 @@
+require 'rb_nav/version'
+
+module RbNav
+end

data/lib/rb_nav.vim

@@ -0,0 +1,150 @@
+" Vim script that add ability to search and play iTunes tracks from Vim
+" Maintainer:	Daniel Choi <dhchoi@gmail.com>
+" License: MIT License (c) 2011 Daniel Choi
+
+" This can be set in .vimrc
+if !exists("g:RbNavPaths")
+  let g:RbNavPaths = ""
+  for x in ['app', 'lib', 'test']
+    if isdirectory(x)
+      let g:RbNavPaths .= x.' '
+    endif
+  endfor
+endif
+
+let s:last_class_search = ""
+
+func! RbNavClasses()
+endfunc
+
+func! RbNavMethods()
+endfunc
+
+func! s:trimString(string)
+  let string = substitute(a:string, '\s\+$', '', '')
+  return substitute(string, '^\s\+', '', '')
+endfunc
+
+func! s:prepare_autocomplete()
+  let s:current_file = bufname('')
+  leftabove split rb_nav_prompt
+  setlocal textwidth=0
+  setlocal buftype=nofile
+  setlocal noswapfile
+  setlocal modifiable
+  setlocal nowrap
+  resize 2
+  noremap <buffer> <Esc> :close<cr>
+  inoremap <buffer> <Tab> <C-x><C-u>
+endfunc
+
+" Classes
+
+function! s:autocomplete_classes()
+  call s:prepare_autocomplete()
+  inoremap <buffer> <cr> <Esc>:call <SID>open_class_file()<cr>
+  noremap <buffer> <cr> <Esc>:call <SID>open_class_file()<cr>
+  setlocal completefunc=AutocompleteRbNavClasses
+  call setline(1, "Select a class or module: ")
+  call setline(2, "") " s:last_class_search)
+  normal G$
+  call feedkeys("a\<c-x>\<c-u>\<c-p>", 't')
+endfunction
+
+function! AutocompleteRbNavClasses(findstart, base)
+  if a:findstart
+    let start = 0
+    return start
+  else
+    let res = [] 
+    for m in RbNavClasses()
+      " why doesn't case insensitive flag work?
+      if m =~ substitute(a:base, '\*', '\\*', '')
+        call add(res, m)
+      endif
+    endfor
+    return res
+  endif
+endfun
+
+func! RbNavClasses()
+  let command = "grep -rn ".g:RbNavPaths." --include='*.rb' -e '^\\s*\\(class\\|module\\) \\+[A-Z]'  | rb_nav_classes | sort"
+  let res = system(command)
+  return split(res, "\n")
+endfunc
+
+" Methods
+
+function! s:autocomplete_methods()
+  call s:prepare_autocomplete()
+  inoremap <buffer> <cr> <Esc>:call <SID>jump_to_method()<cr>
+  noremap <buffer> <cr> <Esc>:call <SID>jump_to_method()<cr>
+  setlocal completefunc=AutocompleteRbNavMethods
+  call setline(1, "Select a method: ")
+  call setline(2, "")
+  normal G$
+  call feedkeys("a\<c-x>\<c-u>\<c-p>", 't')
+endfunction
+
+function! AutocompleteRbNavMethods(findstart, base)
+  if a:findstart
+    let start = 0
+    return start
+  else
+    let res = [] 
+    for m in RbNavMethods()
+      " why doesn't case insensitive flag work?
+      if m =~ '^\c.\?' . substitute(a:base, '\*', '\\*', '')
+        call add(res, m)
+      endif
+    endfor
+    return res
+  endif
+endfun
+
+func! RbNavMethods()
+  let command = "grep -rn '^\\s*\\def ' ".s:current_file." | rb_nav_methods "
+  echom command
+  let res = system(command)
+  return split(res, "\n")
+endfunc
+
+func! s:open_class_file()
+  if (getline(2) =~ '^\s*$')
+    close
+    return
+  endif
+  let selection = s:trimString(getline(2))
+  close
+  let query = get(split(selection, '\s\+'), 0)
+  let location = get(split(selection, '\s\+'), -1)
+  let path = get(split(location, ':'), 0)
+  let line = get(split(location, ':'), 1)
+  if filereadable(path)
+    let s:last_class_search = query
+    exec 'edit '.path
+    exec "normal ".line."G"
+    call feedkeys("z\<cr>", "t")
+  else
+    echo "File ".path." not found"
+  endif
+endfunc
+
+func! s:jump_to_method()
+  if (getline(2) =~ '^\s*$')
+    close
+    return
+  endif
+  let selection = s:trimString(getline(2))
+  close
+  let line = get(split(selection, '\s\+'), -1)
+  exec 'normal '.line.'G'
+  call feedkeys("z\<cr>", "t")
+endfunc
+
+
+au BufRead,BufNewFile *.rb nnoremap <Leader>N :call <SID>autocomplete_classes()<cr>
+au BufRead,BufNewFile *.rb nnoremap <Leader>n :call <SID>autocomplete_methods()<cr>
+
+
+

data/rb_nav.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rb_nav/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rb_nav"
+  s.version     = RbNav::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.8.6'
+
+  s.authors     = ["Daniel Choi"]
+  s.email       = ["dhchoi@gmail.com"]
+  s.homepage    = "http://danielchoi.com/software/rb_nav.html"
+  s.summary     = %q{Browse Ruby documentation in Vim}
+  s.description = %q{Browse Ruby documentation in Vim}
+
+  s.rubyforge_project = "rb_nav"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  message = "* Now please run rb_nav_install to install the Vim plugin *"
+  divider = "*" * message.length 
+  s.post_install_message = [divider, message, divider].join("\n")
+
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rb_nav
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-08 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Browse Ruby documentation in Vim
+email: 
+- dhchoi@gmail.com
+executables: 
+- rb_nav_classes
+- rb_nav_install
+- rb_nav_methods
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- MIT-LICENSE.txt
+- NOTES
+- README.markdown
+- Rakefile
+- bin/rb_nav_classes
+- bin/rb_nav_install
+- bin/rb_nav_methods
+- lib/rb_nav.rb
+- lib/rb_nav.vim
+- lib/rb_nav/version.rb
+- rb_nav.gemspec
+has_rdoc: true
+homepage: http://danielchoi.com/software/rb_nav.html
+licenses: []
+
+post_install_message: |-
+  ***********************************************************
+  * Now please run rb_nav_install to install the Vim plugin *
+  ***********************************************************
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: rb_nav
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Browse Ruby documentation in Vim
+test_files: []
+