jump 0.1.0

data/POST_INSTALL.txt

@@ -0,0 +1,60 @@
+It's strongly recommended to install bash_completion. In this way you will have
+the best user experience.
+Linux users can install it using their package manager (apt, zypper, yum, emerge...),
+while OSX users can install it via ports, fink or brew.
+
+Now that jump is installed you have to create a file called 'jump' containing the
+following text:
+
+    _jump()
+    {
+      local cur prev opts
+      COMPREPLY=()
+      cur="${COMP_WORDS[COMP_CWORD]}"
+      prev="${COMP_WORDS[COMP_CWORD-1]}"
+      opts="--help -h --add -a --del -d --list -l"
+
+      if [[ ${prev} == -d || ${prev} == --d* ]] ; then
+        # complete the del command with a list of the available bookmarks
+        local bookmarks=$(jump --bc)
+        COMPREPLY=( $(compgen -W "${bookmarks}" -- ${cur}) )
+        return 0
+      fi
+
+      if [[ ${cur:0:1} == "-" ]]; then
+        COMPREPLY="$(compgen -W "${opts}" -- ${cur}) "
+        return 0
+      else
+        local bookmarks=$(jump --bc ${cur})
+        COMPREPLY=( $(compgen -W "${bookmarks}" -- ${cur}) )
+        return 0
+      fi
+    }
+
+    function jump {
+      #echo "jump called with $*"
+      if [ ${1:0:1} == "-" ]; then
+        jump-bin $*
+      else
+        cd $(jump-bin $*)
+      fi
+    }
+
+    complete -o nospace -F _jump jump
+
+
+The file must be located inside of the 'bash_completion.d' directory, which is
+usually located under /etc/.
+
+If you do not want to install 'bash_completion' then add the following code
+to your bash configuration file (e.g. '~/.bash_profile' or '~/.bashrc'):
+
+    function jump {
+      if [ ${1:0:1} == "-" ]; then
+        jump-bin $*
+      else
+        cd $(jump-bin $*)
+      fi
+    }
+
+Beware: without bash_completion you won't be able use jump's advanced completion features.

data/README.rdoc

@@ -0,0 +1,108 @@
+= Jump, a bookmarking system for the bash shell.
+
+== Introduction
+
+Jump is a tool that allows you to quickly change directories in the bash
+shell using bookmarks. Thanks to Jump, you won't have to type those long
+paths anymore. 
+Jump was inspired by {go-tool}[http://code.google.com/p/go-tool/] by ActiveState.
+
+== Usage
+
+Say you often work in a directory with a path like
+`/Users/giuseppe/Work/Projects/MyProject`. With Jump you can add a bookmark
+to it:
+
+    $ jump --add myproject
+
+From now on you can jump to your project just by typing:
+
+    $ jump myproject
+
+You can even append subfolders to the bookmark name!
+
+    $ jump myproject/src/
+    
+You can take a look at all your bookmarks with the `list` command:
+
+    $ jump --list
+
+To delete a bookmark you don't need anymore, use the `del` command:
+
+    $ jump --del myproject
+
+Don't remember a command? Just type:
+
+    $ jump --help
+
+== Installation
+
+Jump is packaged as a gem:
+
+    $ gem install jump
+
+== Bash integration
+
+It's strongly recommended to install <i>bash_completion</i>. In this way you will have
+the best user experience.
+
+Linux users can install it using their package manager (apt, zypper, yum, emerge...)
+while OSX users can install it via ports, fink or brew.
+
+When jump is installed you have to create a file called <i>jump</i> containing the
+following text:
+
+    _jump()
+    {
+      local cur prev opts
+      COMPREPLY=()
+      cur="${COMP_WORDS[COMP_CWORD]}"
+      prev="${COMP_WORDS[COMP_CWORD-1]}"
+      opts="--help -h --add -a --del -d --list -l"
+
+      if [[ ${prev} == -d || ${prev} == --d* ]] ; then
+        # complete the del command with a list of the available bookmarks
+        local bookmarks=$(jump --bc)
+        COMPREPLY=( $(compgen -W "${bookmarks}" -- ${cur}) )
+        return 0
+      fi
+
+      if [[ ${cur:0:1} == "-" ]]; then
+        COMPREPLY="$(compgen -W "${opts}" -- ${cur}) "
+        return 0
+      else
+        local bookmarks=$(jump --bc ${cur})
+        COMPREPLY=( $(compgen -W "${bookmarks}" -- ${cur}) )
+        return 0
+      fi
+    }
+
+    function jump {
+      #echo "jump called with $*"
+      if [ ${1:0:1} == "-" ]; then
+        jump-bin $*
+      else
+        cd $(jump-bin $*)
+      fi
+    }
+
+    complete -o nospace -F _jump jump
+
+
+The file must be located inside of the <i>bash_completion.d</i> directory, which
+is usually located under <i>/etc/</i>.
+
+If you do not want to install <i>bash_completion</i> then add the following code
+to your bash configuration file (e.g. <i>~/.bash_profile</i> or <i>~/.bashrc</i>):
+
+    function jump {
+      if [ ${1:0:1} == "-" ]; then
+        jump-bin $*
+      else
+        cd $(jump-bin $*)
+      fi
+    }
+
+<b>Beware:</b> without bash_completion you won't be able use jump's advanced completion features.
+
+(c) 2010 Flavio Castelli and Giuseppe Capizzi

data/Rakefile

@@ -0,0 +1,88 @@
+# This file is part of the jump project
+#
+# Copyright (C) 2010 Flavio Castelli <flavio@castelli.name>
+# Copyright (C) 2010 Giuseppe Capizzi <gcapizzi@gmail.com>
+#
+# kaveau is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# kaveau is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Keep; if not, write to the
+# Free Software Foundation, Inc.,
+# 51 Franklin Steet, Fifth Floor, Boston, MA 02110-1301, USA.
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+task :default => "test"
+
+namespace :test do
+  desc "Test all classes"
+  Rake::TestTask.new(:all) do |t|
+    t.libs << "test"
+    t.pattern = 'test/*_test.rb'
+    t.verbose = true
+  end 
+end
+
+desc "Run all the unit tests"
+task :test do
+  Rake::Task["test:all"].invoke
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'jump'
+  rdoc.options << '--line-numbers' << "--main" << "README.rdoc"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = %q{jump}
+    gem.summary     = %q{A bookmarking system for the bash shell}
+    gem.description = %q{Jump is a tool that allows you to quickly change
+                       directories in the bash shell using bookmarks.
+                       Thanks to Jump, you won't have to type those long paths anymore.
+
+                       Jump was inspired by go-tool by ActiveState
+                       (http://code.google.com/p/go-tool/).}
+
+    gem.files        = FileList['[A-Z]*', 'bash_integration/**/*', 'lib/**/*.rb', 'test/**/*.rb']
+    gem.require_path = 'lib'
+    gem.bindir = 'bin'
+    gem.executables = ['jump-bin']
+    gem.test_files   = Dir[*['test/**/*_test.rb']]
+
+    gem.has_rdoc         = true
+    gem.extra_rdoc_files = ["README.rdoc"]
+    gem.rdoc_options = ['--line-numbers', "--main", "README.rdoc"]
+
+    gem.authors = ["Flavio Castelli", "Giuseppe Capizzi"]
+    gem.email   = %w(flavio@castelli.name gcapizzi@gmail.com)
+    gem.homepage = "http://github.com/flavio/jump"
+
+    gem.add_dependency "terminal-table"
+    gem.add_development_dependency "fakefs"
+
+    gem.platform = Gem::Platform::RUBY
+    gem.post_install_message = File.read('POST_INSTALL.txt')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc]

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bash_integration/bash_completion/jump

@@ -0,0 +1,55 @@
+# This file is part of the jump project
+#
+# Copyright (C) 2010 Flavio Castelli <flavio@castelli.name>
+# Copyright (C) 2010 Giuseppe Capizzi <gcapizzi@gmail.com>
+#
+# kaveau is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# kaveau is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Keep; if not, write to the
+# Free Software Foundation, Inc.,
+# 51 Franklin Steet, Fifth Floor, Boston, MA 02110-1301, USA.
+
+_jump()
+{
+  local cur prev opts
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+  opts="--help -h --add -a --del -d --list -l"
+
+  if [[ ${prev} == -d || ${prev} == --d* ]] ; then
+    # complete the del command with a list of the available bookmarks
+    local bookmarks=$(jump --bc)
+    COMPREPLY=( $(compgen -W "${bookmarks}" -- ${cur}) )
+    return 0
+  fi
+
+  if [[ ${cur:0:1} == "-" ]]; then
+    COMPREPLY="$(compgen -W "${opts}" -- ${cur}) "
+    return 0
+  else
+    local bookmarks=$(jump --bc ${cur})
+    COMPREPLY=( $(compgen -W "${bookmarks}" -- ${cur}) )
+    return 0
+  fi 
+}
+
+function jump {
+  #echo "jump called with $*"
+  if [ ${1:0:1} == "-" ]; then
+    jump-bin $*
+  else
+    cd $(jump-bin $*)
+  fi
+}
+
+complete -o nospace -F _jump jump

data/bash_integration/shell_driver

@@ -0,0 +1,28 @@
+# This file is part of the jump project
+#
+# Copyright (C) 2010 Flavio Castelli <flavio@castelli.name>
+# Copyright (C) 2010 Giuseppe Capizzi <gcapizzi@gmail.com>
+#
+# kaveau is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# kaveau is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Keep; if not, write to the
+# Free Software Foundation, Inc.,
+# 51 Franklin Steet, Fifth Floor, Boston, MA 02110-1301, USA.
+
+function jump {
+  #echo "jump called with $*"
+  if [ ${1:0:1} == "-" ]; then
+    jump-bin $*
+  else
+    cd $(jump-bin $*)
+  fi
+}

data/bin/jump-bin

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+# This file is part of the jump project
+# 
+# Copyright (C) 2010 Flavio Castelli <flavio@castelli.name>
+# Copyright (C) 2010 Giuseppe Capizzi <gcapizzi@gmail.com>
+# 
+# kaveau is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+# 
+# kaveau is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with Keep; if not, write to the
+# Free Software Foundation, Inc.,
+# 51 Franklin Steet, Fifth Floor, Boston, MA 02110-1301, USA.
+
+THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
+
+require "#{File.dirname(THIS_FILE)}/../lib/bookmarks"
+
+options = {}
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: example.rb [options]"
+
+    opts.on("-a", "--add BOOKMARK", "Saves the current directory in BOOKMARK") do |v|
+      options[:add] = v
+    end
+
+    opts.on("-d", "--del BOOKMARK", "Deletes BOOKMARK") do |v|
+      options[:del] = v
+    end
+
+    opts.on("-l", "--list", "Prints the list of all saved bookmarks") do |v|
+      options[:list] = true
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+      puts opts
+      exit
+    end
+  end.parse!
+rescue OptionParser::InvalidOption
+  if $!.args.first == "--bc"
+    # This is an hidden method used by bash_completion
+    bookmarks = Bookmarks.new
+    puts bookmarks.bash_completion(ARGV[0])
+    exit 0
+  else
+    STDERR.puts $!
+    exit 1
+  end
+end
+
+bookmarks = Bookmarks.new
+
+if options.has_key?(:add)
+  bookmarks.add(Dir.pwd, options[:add])
+  bookmarks.save
+  puts "Bookmark added."
+end
+
+if options.has_key?(:del)
+  if bookmarks.del(options[:del])
+    bookmarks.save
+    puts "Bookmark deleted."
+  else
+    STDERR.puts "Bookmark '#{options[:del]}' has not been deleted, it's unknown."
+  end
+end
+
+puts bookmarks if options.has_key?(:list)
+if ARGV.size == 1
+  expanded_path = bookmarks.expand_path(ARGV[0])
+  if expanded_path.nil?
+    STDERR.puts "Unknown bookmark: '#{ARGV[0]}'."
+    puts Dir.pwd
+  else
+    puts expanded_path
+  end
+elsif ARGV.size > 1
+  STDERR.puts "Wrong arguments."
+  puts Dir.pwd
+end

data/lib/bookmarks.rb

@@ -0,0 +1,146 @@
+# This file is part of the jump project
+#
+# Copyright (C) 2010 Flavio Castelli <flavio@castelli.name>
+# Copyright (C) 2010 Giuseppe Capizzi <gcapizzi@gmail.com>
+#
+# kaveau is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# kaveau is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Keep; if not, write to the
+# Free Software Foundation, Inc.,
+# 51 Franklin Steet, Fifth Floor, Boston, MA 02110-1301, USA.
+
+require 'rubygems'
+require 'yaml'
+require 'terminal-table/import'
+
+class Bookmarks
+  BOOKMARKS_PATH = File.expand_path "~/.jumprc"
+
+  def initialize
+    # Loads the bookmarks list from the bookmarks file.
+    begin
+      @bookmarks = YAML::load_file(BOOKMARKS_PATH)
+    rescue Errno::ENOENT
+      @bookmarks = {}
+    rescue
+      raise "Can't save configuration file"
+    end
+  end
+
+  # Checks if +bookmark+ name is valid
+  def self.is_valid_name? bookmark
+    return (bookmark =~/\A\W/).nil?
+  end
+
+  # Saves the bookmarks list in the bookmarks file.
+  def save
+    begin
+      File.open(BOOKMARKS_PATH, 'w') do |file|
+        file << YAML::dump(@bookmarks)
+      end
+    rescue
+      raise "Can't save configuration file"
+    end
+  end
+
+  # Adds +bookmark+ pointing to +path+
+  def add path, bookmark
+    @bookmarks[bookmark] = path
+  end
+
+  # Deletes +bookmark+
+  def del bookmark
+    if @bookmarks.has_key? bookmark
+      @bookmarks.delete bookmark
+      true
+    else
+      false
+    end
+  end
+
+  # Prints the bookmarks list.
+  def to_s
+    if @bookmarks.empty?
+      "No bookmarks saved"
+    else
+      bookmarks_table = table do |t|
+        t.headings = "Bookmark", "Path"
+        @bookmarks.keys.sort.each do |bookmark|
+          t << [bookmark, @bookmarks[bookmark]]
+        end
+      end
+      bookmarks_table.to_s
+    end
+  end
+
+  def bash_completion text
+    if text.nil? || text.empty?
+      # nothing is provided -> return all the bookmarks
+      @bookmarks.keys.sort.join(' ')
+    elsif text.include? '/'
+      if text.index('/') == 0
+        # this is an absolute path (eg: /foo)
+        return text
+      end
+
+      # [bookmark]/path
+      bookmark = text[0, text.index('/')]
+      path = text[text.index('/')+1, text.size]
+      if @bookmarks.has_key?(bookmark)
+        # this is a known bookmark
+        entries = []
+        Dir.foreach(@bookmarks[bookmark]) do |filename|
+          next if !path.empty? && (filename =~ /\A#{path}.*/).nil?
+          if File.directory?(File.join(@bookmarks[bookmark], filename))
+            next if filename == "." || filename == ".."
+            entries << File.join(bookmark, filename)
+          end
+        end
+
+        if entries.empty?
+          text
+        else
+          entries << "#{bookmark}/"
+          entries.sort.join(' ')
+        end
+      else
+        # this is an unknown bookmark
+        text
+      end
+    else
+      # text could match one of the bookmarks
+      matches = @bookmarks.keys.find_all { |b| b =~ /\A#{text}/ }
+      if matches.empty?
+        text
+      else
+        matches.sort.join(' ')
+      end
+    end
+  end
+
+  # Expands paths that could start with a bookmark (e.g. [bookmark]/sub/path)
+  def expand_path(path_with_bookmark)
+    if path_with_bookmark.index("/").nil?
+      # the path is just a bookmark
+      return @bookmarks[path_with_bookmark]
+    elsif path_with_bookmark.index("/") == 0
+      # the path is an absolute path (no bookmark, e.g. /absolute/path)
+      return path_with_bookmark
+    else
+      # the path is composed of a bookmark and a subpath
+      name = path_with_bookmark[0, path_with_bookmark.index('/')]
+      path = path_with_bookmark[path_with_bookmark.index('/')+1,
+                                path_with_bookmark.size]
+      return @bookmarks[name] + "/" + path;
+    end
+  end
+end