warp-dir 1.1.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+env:
+  - CODECLIMATE_REPO_TOKEN=5306e7c3069bd3fef06f717d679f41e969e13bb05efef5bbe1fd781043b0c117
+rvm:
+  - 2.2.3
+  - 2.3.0
+script: "bundle exec rspec"
+notifications:
+  email:
+    recipients:
+      - kigster@gmail.com
+    on_success: never
+    on_failure: always

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in warp-dir.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#^syntax detection
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^warp-dir\.gemspec}) { "spec"}
+  watch(%r{^lib/(.+)\.rb$}) { "spec" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{spec/support/.*}) { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Konstantin Gredeskoul
+
+MIT License
+
+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,114 @@
+# Warp Directory
+
+[![Build Status](https://travis-ci.org/kigster/warp-dir.svg?branch=master)](https://travis-ci.org/kigster/warp-dir)
+[![Code Climate](https://codeclimate.com/github/kigster/warp-dir/badges/gpa.svg)](https://codeclimate.com/github/kigster/warp-dir)
+[![Test Coverage](https://codeclimate.com/github/kigster/warp-dir/badges/coverage.svg)](https://codeclimate.com/github/kigster/warp-dir/coverage)
+[![Issue Count](https://codeclimate.com/github/kigster/warp-dir/badges/issue_count.svg)](https://codeclimate.com/github/kigster/warp-dir)
+
+<hr/>
+[![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)
+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.
+
+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.
+
+The overall concept comes from the realization that when we work on the command line, we
+
+ * 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 :)
+
+Some future extensions could be based on some additional realizations:
+
+ * 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'warp-dir', '~> 1.0 '
+```
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install warp-dir --no-ri --no-rdoc
+    
+After the installation, you will have the `warp-dir` command in the path,
+which actually returns (as it's output) commands for the shell to 
+interprete. This is why you also need to install a tiny shell function
+to wrap this gem's executable.
+
+You can do it using several ways:
+
+    $ warp-dir install [ --file <file> ]
+
+This command will ensure you have the wrapper installed in your ~/.bashrc or ~/.zshrc.
+Without the `--file` option, it will install it in both if it finds them. With the 
+`--file` option, it will only add the shell function to the file specified.
+
+And after that you should be able to get the helpful message below by typing:
+
+    $ wd help
+
+If the above command returns a properly formatted help like the image below, your setup
+is now complete!
+
+## Usage
+
+The usage of the tool is a derived superset of the `ZSH`-based inspiration.
+
+![Image](doc/wd-help-800x710.png)
+
+#### Notable Differences
+
+ * instead of `wd add!` use `wd add -f <point>` (or --force)
+ * for now `wd clean` is not supported.
+ 
+## Future Development
+
+I have so many cool ideas about where this can go, that I created a 
+[dedicated page](ROADMAP.md) for the discussion of future features.  Please head over
+there if you'ld like to participate.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+You can also run `bin/console` for an interactive prompt that will
+allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and
+then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Adding New Commands
+
+Just follow the patter in the `lib/warp/dir/commands/` folder, copy and modify
+one of the existing commands.  Command class name is used as an actual command.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/warp-dir.
+
+## Author
+
+<p>&copy; 2016 Konstantin Gredeskoul, all rights reserved.</p>
+
+## License
+
+This project is distributed under the [MIT License](https://raw.githubusercontent.com/kigster/warp-dir/master/LICENSE).

data/ROADMAP.md

@@ -0,0 +1,96 @@
+# Warp Directory – Future Roadmap
+
+[![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/kigster/warp-dir)
+
+Here I'd like to document various ideas and feature requests from myself and others.
+
+## Simplify Interface
+
+Questionable value, but this sort of interface appear a bit more consistent. 
+
+Still I am not sure I want to type `wd -j proj` or `wd -a proj` instead of `wd proj` and `wd add proj`...
+ 
+```bash
+  wd -j/--jump   point
+  wd -a/--add    point
+  wd -r/--remove point
+  wd -l/--ls     point
+  wd -p/--path   point
+
+  wd -L/--list
+  wd -C/--clean
+  wd -S/--scan           # report whether points exist on the file system
+```  
+
+## Run Commands In A Warp Point
+
+Pass an arbitrary command to execute, and return back to CWD.
+
+```bash
+  wd proj -x/--exec -- "command"      
+```
+
+## Group Commands
+
+Create a group of several warp points:
+
+```bash
+  wd -g/--group group1 -d/--define "point1,point2,...,pointN"
+  wd -g/--group group1 -r/--remove  point1  # remove a point from the group
+  wd -g/--group group1 -a/--add     point1  # add a point to the group
+```
+
+Execute command in all warp points of the group:
+
+```bash
+  wd -x/--exec [ -g/--group group ] [ -r/--return-code ] -- command     
+```
+
+As above, until one returns non-blank output (ie, search).
+If -r is passed, it stops at the first return code of value passed, or 0
+
+```bash
+  wd -f/--find [ -g/--group group ] [ -r/--return-code ] -- command     
+```
+
+As above, until one returns blank output. If -r is passed, it stops at the first 
+return code not equal to the value passed, or 0
+
+```bash
+  wd -a/--all  [ -g/--group group ] [ -r/--return-code ] -- command        
+
+```
+
+The idea here is that you can group several warp points together, and then
+execute a command in all of them. You could use to:
+
+ * search for a specific file in one of the project repos – you expect to exist in
+   only one of them, and so you want the search to stop once found (indicated
+   by return code equal to 1):
+
+```bash
+  wd --find --group project-group --return-code=1 -- \
+       find . -name .aws-credentials.lol
+```
+
+ * you want to run rspec in all projects of the group, and stop at the
+   first non-zero return:
+
+```bash
+  wd --all --group project-group --return-code -- bundle exec rspec
+```
+
+## Networking
+
+Can we go across SSH?
+
+```bash
+  wd add proj kig@remote.server.com:~/workspace/proj
+  wd ls proj 
+  wd proj       
+```
+This then establishes and SSH connection to the server and logs you into the shell. Should be pretty easy, I think :) 
+
+## What Else?
+
+Sky is the limit :)  Well, and the black hole that the warp directory is :)

data/Rakefile

@@ -0,0 +1,24 @@
+task :default => [:rspec ]
+
+task :install do
+  [
+    %q(chmod -R o+r .),
+    %q(rm -f *.gem),
+    %q(rm -rf build),
+    %q(gem uninstall -a --executables warp-dir 2> /dev/null; true),
+    %q(gem build warp-dir.gemspec)
+  ].each do |command|
+    sh command
+  end
+  sh <<-EOF
+export gem_file=$(ls -1 *.gem | tail -1)
+export gem_name=${gem_file//.gem/}
+gem install $gem_file --no-wrappers --force --quiet
+  EOF
+  exit 0
+end
+
+require 'bundler'
+require "bundler/gem_tasks"
+require 'rake/clean'
+require 'rspec/core/rake_task'

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "warp/dir"
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/warp-dir

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+lib_path = File.dirname(__FILE__) + '/../lib'
+if File.exist?(lib_path)
+  $LOAD_PATH << lib_path
+  require 'warp/dir'
+  require 'warp/dir/app/cli'
+end
+
+response = Warp::Dir::App::CLI.new(ARGV.dup).run
+response.print.exit! if response

data/bin/warp-dir.bash

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# warp-dir shell wrapper
+wd() {
+  if [ -z "${warp_dir_exec_installed}" ]; then
+    $(which 'warp-dir') 2>&1 > /dev/null
+    export warp_dir_exec_installed=$?
+  fi
+
+  if [ ${warp_dir_exec_installed} -eq 0 ]; then
+    IFS_BACKUP=$IFS
+    IFS="+"
+    output=$(WARP_DIR_SHELL=yes warp-dir $@ 2>&1)
+    code=$?
+    eval ${output}
+    IFS=$IFS_BACKUP
+  else
+    printf "\nWhoops – I can't find 'warp-dir' executable.\n"
+    printf "Is the gem properly installed?\n"
+    printf "\nTry reinstalling the gem with, for example:\n\n"
+    printf "    $ gem install warp-dir --no-wrappers\n"
+    printf "    $ hash -r\n"
+    printf "    $ warp-dir install [ --dotfile ~/.bashrc ]\n"
+  fi
+}

data/lib/warp.rb

@@ -0,0 +1,4 @@
+require 'warp/dir'
+module Warp
+
+end

data/lib/warp/dir.rb

@@ -0,0 +1,65 @@
+module Warp
+  PROJECT_LIBS = File.dirname(File.absolute_path(__FILE__))
+  PROJECT_HOME = PROJECT_LIBS + '/../..'
+
+  module Dir
+    DOTFILES = %w(~/.bashrc ~/.zshrc ~/.profile)
+    SHELL_WRAPPER = "#{PROJECT_HOME}/bin/warp-dir.bash"
+
+    class << self
+      def require_all_from(folder)
+        ::Dir.glob(Warp::PROJECT_LIBS + folder + '/*.rb') { |file| Kernel.require file }
+      end
+
+      def eval_context?
+        ENV['WARP_DIR_SHELL'] == 'yes'
+      end
+
+      def pwd
+        %x(pwd).chomp.gsub ENV['HOME'], '~'
+      end
+
+      def relative(path)
+        path.gsub ENV['HOME'], '~'
+      end
+
+      def absolute(path)
+        path.gsub '~', ENV['HOME']
+      end
+
+      def default_config
+        relative Warp::Dir::Config::DEFAULTS[:warprc]
+      end
+
+      def sort_by(collection, field)
+        collection.sort { |a, b| a.send(field) <=> b.send(field) }
+      end
+
+    end
+    end
+end
+
+Warp::Dir.require_all_from '/dir'
+Warp::Dir.require_all_from '/dir/command'
+
+module Warp
+  module Dir
+    class << self
+      def on(type, &block)
+        Warp::Dir::App::Response.new.type(type).configure(&block)
+      end
+
+      def commander
+        ::Warp::Dir::Commander.instance
+      end
+    end
+
+  end
+end
+
+class Object
+  def blank?
+    self.eql?('') || self.nil?
+  end
+end
+

data/lib/warp/dir/app/cli.rb

@@ -0,0 +1,162 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'warp/dir'
+require 'slop'
+require 'colored'
+
+module Warp
+  module Dir
+    module App
+      class CLI
+        attr_accessor :argv, :config, :commander, :store, :validated, :opts, :flags
+
+        def initialize(argv)
+          self.argv      = argv
+
+          # flags are everything that follows -- and is typically flags for the command.
+          # for example: 'wd ls project-point -- -alF' would extract flags = [ '-alF' ]
+          self.flags     = extract_suffix_flags(argv.dup)
+          self.flags.flatten!
+          self.commander = ::Warp::Dir::Commander.instance
+          self.config    = ::Warp::Dir::Config.new
+          self.opts      = nil
+        end
+
+        def validate
+          self.validated = false
+          no_arguments   = argv.empty?
+          commands       = shift_non_flag_commands
+          self.opts      = parse_with_slop(self.argv)
+          # merge first few non-flag args which we filtered into `commands` hash
+          # merge onto the hash resulting from options
+          # and pass on to override the default config opts for the final config.
+          config.configure(opts.to_hash.merge(commands))
+
+          self.store     = Warp::Dir::Store.new(config, Warp::Dir::Serializer::Dotfile)
+
+          config.command = :help if (opts.help? || no_arguments)
+          config.command = :warp if !config.command && config.warp
+
+          if config[:command]
+            self.validated = true
+          else
+            raise Warp::Dir::Errors::InvalidCommand.new('Unable to determine what command to run.'.red)
+          end
+          yield self if block_given?
+          validated
+        end
+
+        def run(&block)
+          validate unless validated?
+          response = process_command
+          yield response if block_given?
+          response
+        rescue Exception => e
+          if config.debug
+            STDERR.puts(e.inspect)
+            STDERR.puts(e.backtrace.join("\n"))
+          end
+          on :error do
+            message e.message.red
+          end
+        end
+
+        private
+
+        def on(*args, &block)
+          response = Warp::Dir.on(*args, &block)
+          response.config = self.config
+          response
+        end
+
+        def process_command
+          argv = self.argv
+          if config.command
+            command_class = commander.find(config.command)
+            if command_class
+              command_class.new(store, config.point).run(opts, *flags)
+            else
+              on :error do
+                message "command '#{config.command}' was not found.".red
+              end
+            end
+          else
+            on :error do
+              message "#{$0}: passing #{argv ? argv.join(', ') : 'no arguments'} is invalid.".red
+            end
+          end
+        end
+
+        def parse_with_slop(arguments)
+          opts        = Slop::Options.new
+          opts.banner = nil
+          opts.string  '-m', '--command', '<command>      – command to run, ie. add, ls, list, rm, etc.'
+          opts.string  '-p', '--point',   '<point-name>   – name of the warp point'
+          opts.string  '-w', '--warp',    '<warp-point>   – warp to a given point'
+          opts.bool    '-f', '--force',   '               - force, ie. overwrite existing point when adding'
+          opts.bool    '-h', '--help',    '               – show help'
+          opts.bool    '-v', '--verbose', '               – enable verbose mode'
+          opts.bool    '-q', '--quiet',   '               – suppress output (quiet mode)'
+          opts.bool    '-d', '--debug',   '               – show stacktrace if errors are detected'
+          opts.string  '-s', '--dotfile', '<dotfile>      – shell init file to append the wd wrapper, eg. ~/.bashrc'
+          opts.string  '-c', '--config',  '<config>       – location of the configuration file (default: ' + Warp::Dir.default_config + ')', default: Warp::Dir.default_config
+          opts.on      '-V', '--version', '               – print the version' do
+            puts 'Version ' + Warp::Dir::VERSION
+            exit
+          end
+
+          Slop::Parser.new(opts).parse(arguments)
+        end
+
+        # Given args of the form:
+        # [ 'ls' 'project' --verbose --debug -- -alF ]
+        # this returns:
+        # {
+        #    command: :ls,
+        #      point: :project
+        # }
+        def shift_non_flag_commands
+          result = {}
+          non_flags = []
+          non_flags << argv.shift while not_a_flag(argv.first)
+          case non_flags.size
+            when 1
+              argument = non_flags.first.to_sym
+              if commander.lookup(argument)
+                result[:command] = argument
+              else
+                result[:command] = :warp
+                result[:point] = argument
+              end
+            when 2
+              result[:command], result[:point] = non_flags.map(&:to_sym)
+            when 3
+              #
+              # This is for the hypothetical but awesome future:
+              #
+              #   wd add proj_remote kig@remote.server.com:~/workspace/proj
+              #   wd proj_remote
+              #
+              # >>>>.... ssh kig@remote.server.com -c "cd ~/workspace/proj"
+              #
+              result[:command], result[:point], result[:point_path] = non_flags.map(&:to_sym)
+          end
+          result
+        end
+
+        def extract_suffix_flags(list)
+          element = list.shift until element.eql?('--') || list.empty?
+          list
+        end
+
+        def validated?
+          self.validated
+        end
+
+        def not_a_flag(arg)
+          arg && !arg[0].eql?('-')
+        end
+      end
+    end
+  end
+end