jump 0.1.0

data/test/bookmarks_test.rb

@@ -0,0 +1,139 @@
+# 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 "test_helper"
+require 'bookmarks'
+require 'fileutils'
+
+class BookmarksTest < Test::Unit::TestCase
+  def setup
+    @test_bookmarks = { "foo" => "/tmp/foo",
+                        "bar" => "/tmp/bar",
+                        "complex" => "/tmp/foo/bar/complex"}
+    FakeFS do
+      File.open(Bookmarks::BOOKMARKS_PATH, 'w') do |file|
+        file << YAML::dump(@test_bookmarks)
+      end
+
+      @bookmarks = Bookmarks.new
+    end
+
+  end
+
+  def test_expand_path
+    @test_bookmarks.each do |bookmark, expected_path|
+      current_path = @bookmarks.expand_path bookmark
+      assert_equal expected_path, current_path
+    end
+
+    # check absolute path
+    assert_equal "/foo", @bookmarks.expand_path("/foo")
+
+    # check multiple / handling
+    assert_equal "/tmp/foo/1/2", @bookmarks.expand_path("foo/1/2")
+  end
+
+  def test_add
+    # should add a new bookmark
+    bookmark = "flavio_home"
+    path = "/home/flavio"
+    @bookmarks.add(path, bookmark)
+    assert_equal path, @bookmarks.expand_path(bookmark)
+
+    #should update a bookmark
+    new_path = "/tmp"
+    @bookmarks.add(new_path, bookmark)
+    assert_equal new_path, @bookmarks.expand_path(bookmark)
+  end
+
+  def test_to_s
+    output = <<EOF
++----------+----------------------+
+| Bookmark | Path                 |
++----------+----------------------+
+| bar      | /tmp/bar             |
+| complex  | /tmp/foo/bar/complex |
+| foo      | /tmp/foo             |
++----------+----------------------+
+EOF
+    assert_equal output, @bookmarks.to_s
+  end
+
+  def test_save
+    bookmark = "flavio_home"
+    path = "/home/flavio"
+    @bookmarks.add(path, bookmark)
+
+    expected_bookmarks = @test_bookmarks.dup
+    expected_bookmarks[bookmark] = path
+
+    FakeFS do
+      @bookmarks.save
+
+      assert File.exists?(Bookmarks::BOOKMARKS_PATH)
+      contents = YAML::load_file Bookmarks::BOOKMARKS_PATH
+      assert_equal expected_bookmarks, contents
+    end
+  end
+
+  def test_bash_completion
+    FakeFS do
+      FileUtils.rm "~/.jumprc"
+      bookmarks = Bookmarks.new
+      bookmarks.add("/home/flavio/templates", "templates")
+      bookmarks.add("/home/flavio/templates", "test")
+      bookmarks.add("/home/flavio/test/rails_app", "rails")
+
+      FileUtils.mkdir_p "/home/flavio/templates/foo/bar"
+      FileUtils.mkdir_p "/home/flavio/test/rails_app/log"
+      FileUtils.mkdir_p "/home/flavio/test/rails_app/locale"
+      FileUtils.mkdir_p "/home/flavio/test/rails_app/app/model"
+      FileUtils.touch "/home/flavio/test/rails_app/local_file"
+
+      # should handle absolute paths
+      assert_equal "/rails", bookmarks.bash_completion('/rails')
+
+      # should return all the bookmarks
+      assert_equal "rails templates test", bookmarks.bash_completion(nil)
+      assert_equal "rails templates test", bookmarks.bash_completion('')
+
+      # no matches => should return the same text
+      assert_equal "foo", bookmarks.bash_completion("foo")
+
+      # should complete the text
+      assert_equal "templates test", bookmarks.bash_completion("te")
+      assert_equal "rails", bookmarks.bash_completion("ra")
+
+      # /home/flavio/templates/bar doesn't exist => should return the same text
+      assert_equal "templates/bar", bookmarks.bash_completion("templates/bar")
+      assert_equal( "templates/bar/1/2",
+                    bookmarks.bash_completion("templates/bar/1/2"))
+
+      # should expand the path
+      assert_equal  "rails/ rails/locale rails/log",
+                    bookmarks.bash_completion("rails/lo")
+
+      # should expand the path
+      assert_equal  "rails/ rails/app rails/locale rails/log",
+                    bookmarks.bash_completion("rails/")
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+# 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 'test/unit'
+require 'fakefs/safe'
+require 'yaml'

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: jump
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Flavio Castelli
+- Giuseppe Capizzi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-09 00:00:00 +02:00
+default_executable: jump-bin
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: terminal-table
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: |-
+  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/).
+email: 
+- flavio@castelli.name
+- gcapizzi@gmail.com
+executables: 
+- jump-bin
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- COPYING.txt
+- POST_INSTALL.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bash_integration/bash_completion/jump
+- bash_integration/shell_driver
+- lib/bookmarks.rb
+- test/bookmarks_test.rb
+- test/test_helper.rb
+- bin/jump-bin
+has_rdoc: true
+homepage: http://github.com/flavio/jump
+licenses: []
+
+post_install_message: |-
+  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.
+rdoc_options: 
+- --line-numbers
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A bookmarking system for the bash shell
+test_files: 
+- test/bookmarks_test.rb