warp-dir 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce99a9d0405623c7ea50b88e363f95309c9b1773
-  data.tar.gz: 149746d9e2645ffaff1cb7abc422a7e3b508aafc
+  metadata.gz: 61b42bdc5b12481249402bc4d6dacdf721c9fc5e
+  data.tar.gz: 83d013305b5d9ce4aded23b90484ea09f90c15d3
 SHA512:
-  metadata.gz: 47407f8fe071a1d127137f358aadb7a19c626522cf3bc21bf96592fe2bb378023de3a224080f5165a28f59c209d49f0fdde3575604fe12adcd0738f9eafee2f1
-  data.tar.gz: a67e48b9e831686f47853d14ce8b4bacf158fa8091cfafb9c7ebd574772054ef4c42c494ad4da7ae5c0b2e019b6ed69f89b074d72edf932a4d5a9e07e6f4e75c
+  metadata.gz: 101ddf5bada2103da584e85553ed6c60971a1771a322f722f22c8db71a8f38ac1264a6c0ef5380e064144a713d9335304b49b3283011850fc776d8e3d278d100
+  data.tar.gz: cd1d0d4d60306349b06e16407b30a5477dbaa45a2e66ddcfdc6685d30d49ee10394f860a6c1625a7808e5373392eba1981c3419c99a97ebd34f106785ded7100

data/.gitignore

@@ -1,3 +1,4 @@
+.idea/
 *.gem
 *.rbc
 .bundle
@@ -17,25 +18,3 @@ test/version_tmp
 tmp
 vendor/
 **/.DS_Store
-
-.idea/.rakeTasks
-.idea/*.iml
-# User-specific stuff:
-.idea/workspace.xml
-.idea/tasks.xml
-.idea/dictionaries
-
-# Sensitive or high-churn files:
-.idea/dataSources.ids
-.idea/dataSources.xml
-.idea/sqlDataSources.xml
-.idea/dynamic.xml
-.idea/uiDesigner.xml
-
-# Gradle:
-.idea/gradle.xml
-.idea/libraries
-
-# Mongo Explorer plugin:
-.idea/mongoSettings.xml
-

data/.rspec

@@ -1,4 +1,2 @@
 --color
 --format progress
---backtrace
--p 1

data/.travis.yml

@@ -3,11 +3,11 @@ env:
   - CODECLIMATE_REPO_TOKEN=5306e7c3069bd3fef06f717d679f41e969e13bb05efef5bbe1fd781043b0c117
 rvm:
   - 2.2.3
-  - 2.3.0
+  - 2.3.1
 script: "gem install bundler rake --no-ri --no-rdoc; rake"
 notifications:
   email:
     recipients:
       - kigster@gmail.com
-    on_success: never
+    on_success: change
     on_failure: always

data/README.md

@@ -10,81 +10,102 @@
 [![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/kigster/warp-dir)
 <hr/>
 
-This is a ruby implementation of the tool 'wd' (warp directory),
-[originally written as a zsh module](https://github.com/mfaerevaag/wd)
+This is a ruby implementation of the tool `wd` (warp directory),
+[originally written as a `ZSH` module](https://github.com/mfaerevaag/wd)
 by [Markus Færevaag](https://github.com/mfaerevaag).
 
-After finding it very useful, but having to switch to `bash` on occasion, I wanted to have a completely
-compatible tool that is well tested, and can be extended to do some more interesting things.
+I personaly went back to `bash` after trying out `ZSH`, but it was the `wd` plugin that I really missed.
 
-Markus kindly offered a ruby version in a [separate branch of this module](https://github.com/mfaerevaag/wd/tree/ruby),
-which served as an inspiration for this gem.
+While Markus kindly offered a ruby version in a [separate branch of this module](https://github.com/mfaerevaag/wd/tree/ruby),
+it wasn't quite as extensible as I wanted to (or well tested), so it ended up being an inspiration for this gem.
 
-The overall concept comes from the realization that when we work on the command line, we
+## Warp This
 
- * often have to deal with a limited number of folders at any given time
- * it would be nice to quickly switch between these folders (which we call __warp points__).
- * it should be easy to add, remove, list, and validate warp points
- * everything should require as few characters as possible :)
+WarpDir is a UNIX command line tool that works somewhat similar to the standard built-in command `cd` — "change directory". 
 
-Some future extensions could be based on some additional realizations:
+The main difference is that `wd` is able to add/remove/list folder "shortcuts", and allows you to jump to these shortcuts from anywhere on the filesystem. 
 
- * each folder often represents a project, some of which are managed by `git`
- * eventually we might want to do things across all projects, such as perform group `git pull`,
-   or even `git push` etc.
+This of this as a folder-navigation super-charge tool that you'd use on a most frequently-used set of folders. This becomes __really useful__ if you are often finding youself going into a small number of deeply nested folders with a long path prefix. 
 
-## Installation
+## Usage
+
+__NOTE:__ in the below examples, the characters `~ ❯ ` denote the current shell prompt, showing the current folder you are in. The command to type is on the right hand side of the "❯".
+
+Let's first bookmark a long directory:
 
-Add this line to your application's Gemfile:
+```bash
+~ ❯ cd ~/workspace/arduino/robots/command-bridge/src
+~/workspace/arduino/robots/command-bridge/src ❯ wd add cbsrc
+Warp point saved!
+
+~/workspace/arduino/robots/command-bridge/src ❯ cd ~/workspace/c++/foo/src
+~/workspace/c++/foo/src ❯ wd add foosrc
+Warp point saved!
 
-```ruby
-gem 'warp-dir'
+~/workspace/c++/foo/src ❯ cd /usr/local/Cellar
+/usr/local/Cellar ❯ wd add brew
+Warp point saved!
 ```
-And then execute:
 
-    $ bundle
+Now we can list/inspect current set of warp points:
+
+```bash
+/usr/local/Cellar ❯ wd l
+   cbsrc -> ~/workspace/arduino/robots/command-bridge/src
+  foosrc -> ~/workspace/c++/foo/src
+    brew -> /usr/local/Cellar
+```
 
-Or install it yourself as:
+Now we can jump around these warp points, as well as run 'ls' inside (even passing arbitrary arguments to the `ls` itself):
 
-    $ gem install warp-dir --no-ri --no-rdoc
+```bash
+/usr/local/Cellar ❯ wd cbsrc
+~/workspace/arduino/robots/command-bridge/src ❯ wd foosrc
+~/workspace/c++/foo/src ❯  1 wd ls brew -- -alF | head -4        # run ls -alF inside /usr/local/Cellar
+total 0
+drwxrwx---  73 kig  staff  2482 May  7 15:29 ./
+drwxrwx---  21 kig  staff   714 Apr 28 11:40 ../
+drwxrwx---   3 kig  staff   102 Dec 24 03:14 ack/
+```
 
-The last step is to install the `wd` bash function, which enables the `cd`-like behavior.
-Choose 
-    $ warp-dir install [ --dotfile <file> ]
+### Command Completion
 
-And after that you need to restart your shell, and then you should get the command's
-"help" message by typing:
+If you installed `wd` properly, it should register it's own command completion for BASH and be ready for your tabs :)
 
-    $ wd help
+Note that you can use `wd` to change directory by giving an absolute or relative directory name, just like `cd` (so not just using warp-points), so when you type `wd [TAB]` you will see all saved warp points as well as the local directories you can `cd` into.
 
-If the above command returns a properly formatted help like the image below, your setup
-is now complete!
+That's basically it!  
 
-## Usage
+### Config File (aka. Warp Points Database)
 
-The usage of the tool is derived from `ZSH`-based inspiration. If it ain't broke, don't fix it!
-I like how `wd` can be used with very short warp points, so it's so much less typing. I often name
-my points `pu` so that I can jump there with `wd pu`.
+All of the mappings are stored in the `~/.warprc` file, where the warp point name is followed by a colon, and the path it maps to. So it's trivial to do a global search/replace on that file in your favorite editor, if, for example, a commond top level folder had changed. 
 
-Unlike ZSH counterpart, this tool includes full command line parsing, so
-you can (if you want to) use flags to achieve the same effect with more
-characters to type, for example all below commands do the same thing.
+The format of the file was left identical to that of the `ZSH` version of `wd` so that one could switch back and force between the two versions of `wd` and still be able to use their collection of warp points. 
 
-```bash
-  wd pu
-  wd --warp --point pu
-  wd -m warp -p pu
-```
+See? I think we thought of everything :) 
 
-You can run a comman in the target directory without leaving the current via
-`wd ls pu`, but in this implementation you can also pass arguments to `ls` after
-the `--` in argument list, for example, to run `ls -1` I would do `wd ls pu -- -1`.
+Happy warping!
 
-Here is a full command / help summary.
+### Detailed Usage
 
 ![Image](doc/wd-help.png)
 
-#### Notable Differences
+## `wd` Concept 
+
+The overall concept comes from the realization that when we work on the command line, we often do things that `wd` tool provides straight out of the box, such as:
+
+ * we often have to deal with a limited number of folders at any given time
+ * on occastion have to jump between these folders (which we call __warp points__), which may require mult-level `cd` command, for example: `cd ~/workspace/foo/src/include/; ....; cd ~/Documents/Microsoft\ Word/; ...` 
+ * seems like it should be easy to add, remove and list warp points
+ * everything should require typing few characters as possible :)
+ * it would be great to have full BASH completion support
+
+Some future extensions could be based on some additional realizations:
+
+ * perhaps you might want to inspect a bookmarked folder without leaving your current place. 
+ * maybe by inspecting we mean — running a `find`, or `ls` or any other command for that matter
+
+### Notable Differences with original `wd`
 
  * instead of `wd add!` use `wd add -f <point>` (or --force)
 
@@ -94,6 +115,31 @@ These features will be added shortly:
  * for now history is not supported
  * for now '-' is not supported
 
+## Installation
+
+Three steps:
+
+ 1. This `wd` requires version 2+ of ruby interpreter. Check your default ruby with `ruby --version`. You should see something like "ruby 2.3.0p0....". If you see version 1.9 or earlier, upgrade your ruby with `brew update; brew install ruby`.
+ 2. Install warp-dir gem:
+```bash
+~ ❯ gem install warp-dir --no-ri --no-rdoc
+```
+ 3. The last step is to install the `wd` BASH function and auto-completion:
+```bash
+~ ❯ warp-dir install --dotfile ~/.bash_profile
+```
+
+This last step appends the required shell function to the shell initialization file specified with the `--dotfile` flag. If you are unsure what that means, please run the command above as is.
+
+And step 3 you will need to restart your shell, so reopen your Terminal or [iTerm2](https://www.iterm2.com/) (please use iTerm over Terminal — it's soooo much better!), and then type:
+
+```bash
+~ ❯ wd help
+```
+
+If the above command returns a properly formatted help like the image below, your setup
+is now complete!
+
 ## Future Development
 
 I have so many cool ideas about where this can go, that I created a

data/Rakefile

@@ -27,8 +27,8 @@ namespace :development do
   task :setup do
     sh %q{
       echo "source 'https://rubygems.org'; gemspec" > Gemfile
-      [[ -n $(which bundle) ]] || gem install bundler --no-ri --no-rdoc
-      bundle install
+      [[ -n $(which bundle) ]] || gem install bundler --no-ri --no-rdoc --quiet
+      bundle install --quiet
     }.gsub(%r{^\s+}m, '')
   end
 

data/bin/warp-dir.bash

@@ -1,6 +1,11 @@
 #!/usr/bin/env bash
-
-# warp-dir shell wrapper
+#
+# %WARP-DIR% shell wrapper, installed by a gem 'warp-dir'
+#
+# © 2015-2016, Konstantin Gredeskoul
+# https://github.com/kigster/warp-dir
+#
+#
 wd() {
   if [ -z "${warp_dir_exec_installed}" -o "${warp_dir_exec_installed}" == "1" ]; then
     $(which 'warp-dir') 2>&1 > /dev/null

data/lib/warp/dir.rb

@@ -1,13 +1,20 @@
+require_relative 'dir/version'
 module Warp
   PROJECT_LIBS = File.dirname(File.absolute_path(__FILE__))
   PROJECT_HOME = PROJECT_LIBS + '/../..'
 
   module Dir
     # tried in order.
+    INSTALL_TIME = Time.now
     DOTFILES = %w(.bash_profile .bashrc .profile .bash_login).map{|f| "~/#{f}" }
-    DOTFILE_CREATED='.bash_profile'
-    SHELL_WRAPPER = "#{PROJECT_HOME}/bin/warp-dir.bash"
-
+    SHELL_WRAPPER_FILE = "#{PROJECT_HOME}/bin/warp-dir.bash"
+    SHELL_WRAPPER_DEST  = ENV['HOME'] + '/.bash_wd'
+    SHELL_WRAPPER_REGX  = %r[WarpDir \(v(\d+\.\d+\.\d+)]
+    SHELL_WRAPPER_SRCE  = <<-eof
+# WarpDir (v#{Warp::Dir::VERSION}, appended on #{INSTALL_TIME}) BEGIN
+[[ -f ~/.bash_wd ]] && source ~/.bash_wd
+# WarpDir (v#{Warp::Dir::VERSION}, appended on #{INSTALL_TIME}) END
+eof
     class << self
       def require_all_from(folder)
         ::Dir.glob(Warp::PROJECT_LIBS + folder + '/*.rb') { |file| Kernel.require file }

data/lib/warp/dir/command/install.rb

@@ -1,11 +1,17 @@
-require 'warp/dir/command'
 require 'warp/dir'
+require 'warp/dir/command'
+require 'fileutils'
 class Warp::Dir::Command::Install < Warp::Dir::Command
   description %q(Installs warp-dir shell wrapper in your ~/.bashrc)
   needs_a_point? false
 
   attr_accessor :installed, :existing, :wrapper, :shell_init_files
 
+# SHELL_WRAPPER_FILE
+# SHELL_WRAPPER_DEST
+# SHELL_WRAPPER_REGX
+# SHELL_WRAPPER_SRCE
+
   class << self
     def wrapper_installed?
       ::Warp::Dir::DOTFILES.any?{ |file| already_installed?(file) }
@@ -15,7 +21,7 @@ class Warp::Dir::Command::Install < Warp::Dir::Command
       path = ::Warp::Dir.absolute(file_path)
       matches = if File.exists?(path)
                   File.open path do |file|
-                    file.find { |line| line =~ /warp-dir/ }
+                    file.find { |line| line =~ ::Warp::Dir::SHELL_WRAPPER_REGX }
                   end
                 end
       matches
@@ -25,7 +31,7 @@ class Warp::Dir::Command::Install < Warp::Dir::Command
   def initialize(*args)
     self.installed        = []
     self.existing         = []
-    self.wrapper          = File.read(::Warp::Dir::SHELL_WRAPPER)
+    self.wrapper          = ::Warp::Dir::SHELL_WRAPPER_SRCE
     self.shell_init_files = ::Warp::Dir::DOTFILES
     super(*args)
   end
@@ -33,9 +39,14 @@ class Warp::Dir::Command::Install < Warp::Dir::Command
   def run(*args)
     self.shell_init_files = config[:dotfile].split(',') if config[:dotfile]
     self.shell_init_files.any? { |dotfile| append_wrapper_to(dotfile) }
+
+    # Overwrites if already there
+    install_bash_wd
+
     local_existing    = self.existing
     local_installed   = self.installed
     local_shell_files = self.shell_init_files
+
     if installed.empty?
       if existing.empty?
         on :error do
@@ -61,14 +72,25 @@ class Warp::Dir::Command::Install < Warp::Dir::Command
 
   private
 
+  def install_bash_wd
+    source = File.read(::Warp::Dir::SHELL_WRAPPER_FILE)
+    source.gsub!(/%WARP-DIR%/, "WarpDir (v#{::Warp::Dir::VERSION})")
+    File.open(::Warp::Dir::SHELL_WRAPPER_DEST, 'w') do |file|
+      file.puts source
+    end
+  end
+
   def append_wrapper_to(shell_init_file)
     file          = ::Warp::Dir.absolute(shell_init_file)
     pre_installed = self.class.already_installed?(file)
     self.existing << file if pre_installed
     if File.exists?(file)
       if !pre_installed || config[:force]
-        File.open(file, 'a') do |f|
-          f.write(wrapper)
+        source = File.read(file)
+        source.gsub!(/# WarpDir.*BEGIN\n.*\n# WarpDir.*END/, '')
+        File.open(file, 'w') do |f|
+          f.write source
+          f.write wrapper
         end
         self.installed << shell_init_file
       end

data/lib/warp/dir/point.rb

@@ -2,7 +2,45 @@ require 'forwardable'
 require 'digest'
 module Warp
   module Dir
+    # This class encapsulates the tuple: name + path.
+    # It provides convenience accessors to retrieve absolute or
+    # realtive path of a point, optionally via a set of predefined
+    # filters.
+    #
+    # In addition, this class is responsible for serializing and
+    # deserializing itself properly.
     class Point
+
+      # This method creates/defines methods used to
+      # access the #full_path component of the Point instance, but
+      # enclosing it in a chain of provided filters.
+      def self.filtered_paths(path_hash)
+        path_hash.each_pair do |method, filters|
+          define_method method.to_sym do |*args|
+            filters.inject(self.full_path) do |memo, filter|
+              self.send(filter, memo)
+            end
+          end
+        end
+      end
+
+      def self.deserialize(line)
+        name, path = line.split(/:/)
+        if name.nil? || path.nil?
+          raise Warp::Dir::Errors::StoreFormatError.new(
+            'warprc file may be corrupt, offending line is: ' +
+              line, line)
+        end
+        self.new(name, path)
+      end
+
+      filtered_paths absolute_path: %i(quote_spaces),
+                     path:          %i(quote_spaces),
+                     relative_path: %i(make_relative quote_spaces)
+
+      #
+      # Instance Methods
+      #
       attr_accessor :full_path, :name
 
       def initialize(name, full_path)
@@ -12,18 +50,6 @@ module Warp
         @name      = name.to_sym
       end
 
-      def absolute_path
-        full_path
-      end
-
-      def relative_path
-        Warp::Dir.relative full_path
-      end
-
-      def path
-        absolute_path
-      end
-
       def inspect
         sprintf("(#{object_id})[name: '%s', path: '%s']", name, relative_path)
       end
@@ -48,6 +74,20 @@ module Warp
         true
       end
 
+      def serialize
+        "#{name}:#{full_path}"
+      end
+
+      private
+
+      # Filters that receive a path, and return a possibly decorated path back
+      def make_relative(path)
+        Warp::Dir.relative(path)
+      end
+
+      def quote_spaces(path)
+        path =~ /\s+/ ? %Q("#{path}") : path
+      end
     end
   end
 end

data/lib/warp/dir/serializer/dotfile.rb

@@ -4,6 +4,8 @@ require_relative 'base'
 module Warp
   module Dir
     module Serializer
+      # Serializer only assumes that Points can serialize themselves
+      # or deserialize themselves to/from a one-line text format.
       class Dotfile < Base
 
         def warprc_file_path
@@ -19,11 +21,8 @@ module Warp
             f.each_line do |line|
               line = line.chomp
               next if line.blank?
-              name, path = line.split(/:/)
-              if name.nil? || path.nil?
-                raise Warp::Dir::Errors::StoreFormatError.new("File may be corrupt - #{config.warprc}:#{line}", line)
-              end
-              store.add point_name: name, point_path: path
+              line.gsub!(/["']/,'') # remove any quotes that may have been inserted
+              store.add(point: Warp::Dir::Point.deserialize(line))
             end
           end
         end
@@ -32,7 +31,7 @@ module Warp
           File.open(warprc_file_path, 'wt') do |file|
             buffer = ''
             store.points.each do |point|
-              buffer << "#{point.name}:#{point.relative_path}\n"
+              buffer << "#{point.serialize}\n"
             end
             file.write(buffer)
           end
@@ -41,5 +40,3 @@ module Warp
     end
   end
 end
-
-

data/lib/warp/dir/version.rb

@@ -1,7 +1,7 @@
 require_relative '../../colored'
 module Warp
   module Dir
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
 
     @install_notice = <<-EOF
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warp-dir
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -94,7 +94,6 @@ files:
 - ".codeclimate.yml"
 - ".gitignore"
 - ".idea/encodings.xml"
-- ".idea/misc.xml"
 - ".idea/modules.xml"
 - ".idea/runConfigurations/All_Specs.xml"
 - ".idea/vcs.xml"

data/.idea/misc.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectLevelVcsManager" settingsEditedManually="false">
-    <OptionsSetting value="true" id="Add" />
-    <OptionsSetting value="true" id="Remove" />
-    <OptionsSetting value="true" id="Checkout" />
-    <OptionsSetting value="true" id="Update" />
-    <OptionsSetting value="true" id="Status" />
-    <OptionsSetting value="true" id="Edit" />
-    <ConfirmationsSetting value="0" id="Add" />
-    <ConfirmationsSetting value="0" id="Remove" />
-  </component>
-  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.2.3-p173" project-jdk-type="RUBY_SDK" />
-</project>