warp-dir 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 038c1bf836f10b44823ae7fdc6acbafb1ed9d356
-  data.tar.gz: dd8a492fc4f52bf96f38aa385f5d9a67a37a44ed
+  metadata.gz: a03aa1db919b1fdb774efb8365b27f4fe08b2d2f
+  data.tar.gz: 1af544ccadb6429c650769e117c84deb6569b01c
 SHA512:
-  metadata.gz: bbf7666d599530708775ae4cada2604c8244ca8e175af66f64c89f0bced139ec40a5c7394630599be08c0ed65e73832ce5160a165644d20a6e2c9017c63cd220
-  data.tar.gz: 9ae73bb486069adcae90e411e48266f97dfa2c6b5b99e34f085c4cbdfb2758c891d0714c0ffe150dbd15a9a567194802d592dfbe30511d7f027c3c9d453ca707
+  metadata.gz: 23d52072aac9a4b8cc9bbb53d0f62f76fcfc24c011ca46c97b7d830ae13fbef0d8ccd636d0e28c8947572f063eccd8c135fd0b8aaf6ec1fdc72efd7f1ec75d37
+  data.tar.gz: a32e4f31ec0610d42933c23d8159c53d3da24c50afa012698f01f25d5eea5340a64e85a9aa507d6888cb6561101787e75eb73c41e3a487d5b5c5b340490e5739

data/.idea/warp-dir.iml

@@ -41,7 +41,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="true" />
       <method />
     </configuration>
-    <configuration default="false" name="Run spec 'store_spec': warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
+    <configuration default="false" name="Warp::Dir::Store with no existin warprc file creates the file when adding points: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
       <predefined_log_file id="RUBY_RSPEC" enabled="true" />
       <module name="warp-dir" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
@@ -63,7 +63,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/spec/warp/dir/store_spec.rb" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="**/*_spec.rb" />
-      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::Store with no existin warprc file creates the file when adding points" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="TEST_SCRIPT" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
@@ -74,7 +74,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
       <method />
     </configuration>
-    <configuration default="false" name="Warp::Dir::Store with no existin warprc file creates the file when adding points: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
+    <configuration default="false" name="Warp::Dir::Store: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
       <predefined_log_file id="RUBY_RSPEC" enabled="true" />
       <module name="warp-dir" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
@@ -96,7 +96,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/spec/warp/dir/store_spec.rb" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="**/*_spec.rb" />
-      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::Store with no existin warprc file creates the file when adding points" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::Store" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="TEST_SCRIPT" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
@@ -107,7 +107,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
       <method />
     </configuration>
-    <configuration default="false" name="Warp::Dir::Store: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
+    <configuration default="false" name="Warp::Dir::App::CLI: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
       <predefined_log_file id="RUBY_RSPEC" enabled="true" />
       <module name="warp-dir" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
@@ -126,10 +126,10 @@
         </COVERAGE_PATTERN>
       </EXTENSION>
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TESTS_FOLDER_PATH" VALUE="" />
-      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/spec/warp/dir/store_spec.rb" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/spec/warp/dir/app/cli_spec.rb" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="**/*_spec.rb" />
-      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::Store" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::App::CLI" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="TEST_SCRIPT" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
@@ -140,7 +140,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
       <method />
     </configuration>
-    <configuration default="false" name="Warp::Dir::App::CLI: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
+    <configuration default="false" name="Warp::Dir::App::CLI when running command with a point arg, such as  warp &lt;point&gt;: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
       <predefined_log_file id="RUBY_RSPEC" enabled="true" />
       <module name="warp-dir" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
@@ -162,7 +162,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/spec/warp/dir/app/cli_spec.rb" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="**/*_spec.rb" />
-      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::App::CLI" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::App::CLI when running command with a point arg, such as  warp &lt;point&gt;" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="TEST_SCRIPT" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
@@ -173,7 +173,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
       <method />
     </configuration>
-    <configuration default="false" name="Warp::Dir::App::CLI when running command with a point arg, such as  add &lt;point&gt; when point exists with --force should overwrite existing point: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
+    <configuration default="false" name="Warp::Dir::App::CLI when running command with a point arg, such as  warp &lt;point&gt; when using --command: warp-dir" type="RSpecRunConfigurationType" factoryName="RSpec" temporary="true">
       <predefined_log_file id="RUBY_RSPEC" enabled="true" />
       <module name="warp-dir" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)" />
@@ -195,7 +195,7 @@
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/spec/warp/dir/app/cli_spec.rb" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="**/*_spec.rb" />
-      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::App::CLI when running command with a point arg, such as  add &lt;point&gt; when point exists with --force should overwrite existing point" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="Warp::Dir::App::CLI when running command with a point arg, such as  warp &lt;point&gt; when using --command" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="TEST_SCRIPT" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
       <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
@@ -216,6 +216,7 @@
     <orderEntry type="jdk" jdkName="ruby-2.3.0-p0" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
     <orderEntry type="library" scope="PROVIDED" name="bundler (v1.11.2, ruby-2.3.0-p0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="chef (v12.6.0, ruby-2.3.0-p0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="codeclimate-test-reporter (v0.5.0, ruby-2.3.0-p0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="colored (v1.2, ruby-2.3.0-p0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, ruby-2.3.0-p0) [gem]" level="application" />

data/README.md

@@ -1,5 +1,6 @@
 # Warp Directory
 
+[![Gem Version](https://badge.fury.io/rb/warp-dir.svg)](https://badge.fury.io/rb/warp-dir)
 [![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)
@@ -37,7 +38,7 @@ Some future extensions could be based on some additional realizations:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'warp-dir', '~> 1.0 '
+gem 'warp-dir'
 ```
 And then execute:
 
@@ -47,20 +48,18 @@ 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.
+After the installation, you will have the `warp-dir` command in the path. You can use
+this command almost like `wd` except it can not warp you to another folder due to 
+UNIX parent/child process restrictions. To do that you need to also install the shell
+function wrapper in your `~/.bashrc` or similar file:
 
-You can do it using several ways:
+You can do like so (if you don't provide file, it will install in `~/.bashrc`, `~/.bash_profile`
+or `~/.profile` whichever works first, – so use `--file` to override it if you need to).
 
-    $ warp-dir install [ --file <file> ]
+    $ warp-dir install [ --dotfile <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:
+And after that you need to restart your sheel, and then you should be able to get the 
+helpful message below by typing:
 
     $ wd help
 
@@ -69,14 +68,37 @@ is now complete!
 
 ## Usage
 
-The usage of the tool is a derived superset of the `ZSH`-based inspiration.
+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`.
+
+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. 
+
+```bash
+  wd pu
+  wd --warp --point pu
+  wd -m warp -p pu
+```
+
+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`.
+ 
+Here is a full command / help summary.
 
-![Image](doc/wd-help-800x710.png)
+![Image](doc/wd-help.png)
 
 #### Notable Differences
 
  * instead of `wd add!` use `wd add -f <point>` (or --force)
- * for now `wd clean` is not supported.
+
+These features will be added shortly:
+
+ * for now `wd clean` is not supported 
+ * for now history is not supported
+ * for now '-' is not supported
  
 ## Future Development
 

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

@@ -35,7 +35,7 @@ module Warp
           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
+          config.command = :warp if config.warp || config.command == 'warp'
 
           if config[:command]
             self.validated = true

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

@@ -7,26 +7,35 @@ class Warp::Dir::Command::Help < Warp::Dir::Command
 
   def run(opts, flags = [])
     commander = ::Warp::Dir.commander
+    cmd = self
     on :success do
       message USAGE
       message ' '
       message 'Warp Point Commands:'.bold.green
       message ' '
-      commander.commands.select{|cmd| cmd.needs_a_point?}.map(&:command_name).each do |installed_commands|
-        message sprintf("  %s\n", commander.find(installed_commands).help)
-      end
+      message cmd.commands_needing_points(commander, needing_point: true)
       message ' '
       message 'Global Commands:'.bold.green
       message ' '
-      commander.commands.reject{|cmd| cmd.needs_a_point?}.map(&:command_name).each do |installed_commands|
-        message sprintf("  %s\n", commander.find(installed_commands).help)
-      end
+      message cmd.commands_needing_points(commander, needing_point: false)
       message EXAMPLES
       message INSTALLATION
       message opts.to_s
     end
   end
 
+  def commands_needing_points(commander,
+                              needing_point: true)
+    help = ''
+    commander.
+      commands.
+      select{|cmd| needing_point ? cmd.needs_a_point? : !cmd.needs_a_point? }.
+      map(&:command_name).each do |installed_commands|
+      help << sprintf("  %s\n", commander.find(installed_commands).help)
+    end
+    help
+  end
+
   USAGE = <<EOF
 #{"Usage:".bold.green}  wd [ --command ] [ list | help ] [ wd-flags ]
         wd [ --command ] [ [ warp ] | add  [-f] | rm | ls ] [ wd flags ] <point> -- [ cmd-flags ]
@@ -47,8 +56,8 @@ EOF
     INSTALLATION = <<EOF
 
 #{'Installation'.bold.green}
-    It appears that you already have a wrapper installed in one of your
-    shell init files (#{::Warp::Dir::DOTFILES.join(', ')}
+    It appears that you already have a wrapper installed in one of the default
+    shell init files (#{::Warp::Dir::DOTFILES.join(', ')}).
 
     Which means that 'wd' should be working on your system.  If not, edit your
     shell init file, remove any lines related to warp-dir gem, and then reinstall:

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

@@ -32,7 +32,7 @@ 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.each { |dotfile| append_wrapper_to(dotfile) }
+    self.shell_init_files.any? { |dotfile| append_wrapper_to(dotfile) }
     local_existing    = self.existing
     local_installed   = self.installed
     local_shell_files = self.shell_init_files

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

@@ -10,12 +10,19 @@ module Warp
 
         def run(*args)
           if point.nil? && point_name
-            self.point = store[point_name]
+            begin
+              self.point = store[point_name]
+            rescue ::Warp::Dir::Errors::PointNotFound
+            end
           end
-          raise ::Warp::Dir::Errors::PointNotFound.new(point) unless point
-          p = point
+          warp_to_path = if point
+            point.absolute_path
+          else
+            point_name if ::Dir.exist?(point_name.to_s)
+          end
+          raise ::Warp::Dir::Errors::PointNotFound.new(point_name) unless warp_to_path
           on :shell do
-            message "cd #{p.absolute_path}"
+            message "cd #{warp_to_path}"
           end
         end
       end

data/lib/warp/dir/version.rb

@@ -1,6 +1,6 @@
 module Warp
   module Dir
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
   end
 end
 

data/lib/warp/dir.rb

@@ -3,7 +3,9 @@ module Warp
   PROJECT_HOME = PROJECT_LIBS + '/../..'
 
   module Dir
-    DOTFILES = %w(~/.bashrc ~/.zshrc ~/.profile)
+    # tried in order.
+    DOTFILES = %w(~/.bashrc ~/.bash_profile ~/.profile)
+
     SHELL_WRAPPER = "#{PROJECT_HOME}/bin/warp-dir.bash"
 
     class << self

data/spec/warp/dir/app/cli_spec.rb

@@ -129,6 +129,20 @@ RSpec.describe Warp::Dir::App::CLI do
           }
           expect(warp_args).to output("cd #{wp_path}")
         end
+
+        describe 'when using --command' do
+          let(:warp_args) { "--command warp -p #{wp_name} #{warprc}"}
+          it "should return response with a 'cd' to a warp point" do
+            warp_point = wp_name
+            expect(warp_args).to validate { |cli|
+              expect(cli.config.point).to eql(warp_point.to_s)
+              expect(cli.config.command).to eql(:warp)
+              expect(cli.store[warp_point]).to eql(Warp::Dir::Point.new(wp_name, wp_path))
+            }
+            expect(warp_args).to output("cd #{wp_path}")
+          end
+
+        end
       end
 
       describe 'remove <point>' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warp-dir
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Warp-Dir (aka 'wd') is a command line tool that lets you bookmark any folders,
@@ -226,3 +226,4 @@ test_files:
 - spec/warp/dir/formatter_spec.rb
 - spec/warp/dir/point_spec.rb
 - spec/warp/dir/store_spec.rb
+has_rdoc: