pro 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ac15f737100200ff1b897182f49139736a8e876
-  data.tar.gz: 5ba1a872a3126ea296df0156936b393395920df6
+  metadata.gz: 88c563fe2053d87fa48f4e6cee7c524cb76fae67
+  data.tar.gz: e2870e0364138adfdbffa9a3d459560260485b93
 SHA512:
-  metadata.gz: 5ce52738f6186ed0d640c11761c76eeaf699d1c1993880fa0f1193897409775d32e7e37ff4f9447158c6f0d829623182d910e37bde8aaa8061b0dba5fe039ab3
-  data.tar.gz: 9fc044be29999b50daea1bf481899557c2503fa3f9d60e5b7c9a6ca6d816f33572d2780a6533ef456f1a2ff19757188d10f41b12ddd891f56b17977fb82f5913
+  metadata.gz: a75815fa9f72220d7db560c20af9ec19611a4899c272e71825af478e078fff17e6bc608a8ac8abd88ad57b238938bd3bcab84699b3bc69646f9bb4b11d13f729
+  data.tar.gz: e57aec62751ac749b813bb12cb4b8c047f0bbc04e3d1882e1ab0062430da7be32a0c3f78b1aa136fa007b3f5e90f152a53dbe2be9cf412c1c007e74c588e13af

data/README.md

@@ -1,19 +1,22 @@
 # Pro
 
-`pro` is a little utility to wrangle your git repositories.
+`pro` is a command to wrangle your git repositories.
 It includes features like instantly cd'ing to your git repos and getting a
-status overview. You can also run commands in every git repository.
+status overview, and running an arbitrary command in every git repo.
+
+Note that pro only currently works on Unix systems. If you experience speed issues
+see the section on setting a pro base.
 
 ## CD'ing to a project's repository
 
 Cd'ing to your projects is harder than it should be.
-There are [many tools](https://github.com/rupa/z) that try and solve this
+There are [attempts](https://github.com/rupa/z) to solve this
 problem using frequency and recency.
-Pro solves the problem by fuzzy searching only git repositories.
+`pro` solves the problem by fuzzy searching only git repositories.
 
-The `pd` command allows you to instantly CD to any git repo by fuzzy matching
-its name.
-You can install the `pd` tool (name configurable) by running `pro install`.
+The supplementary `pd` command allows you to instantly CD to any git repo by
+fuzzy matching its name. It is implemented as a shell function.
+You can install `pd` (name configurable) by running `pro install`.
 Once you have it you can do some pretty intense cd'ing:
 
 ![pd demo](http://thume.ca/assets/postassets/pro/pd_screen.png)
@@ -41,25 +44,35 @@ For example, searching all your repos for ruby files:
 
 ![pro run](http://thume.ca/assets/postassets/pro/pro_run.png)
 
-Notice that it double checks before running so you don't accidentally run `rm -rf *` on all
-your projects.
+Notice that it double checks before running so you don't accidentally run
+`rm -rf *` on all your projects.
+
+## The Pro Base
+
+`pro` can use a base directory to speed up its search for git repos. By default it
+uses your home folder.
+
+To set the base directory either create a file at `~/.proBase` containing the
+base path or set the environment variable PRO_BASE.
 
 ## Installation
 
-Pro is bundled as a Ruby gem. To install run:
+`pro` is bundled as a Ruby gem. To install run:
 
     $ gem install pro
 
+You may also want to set your Pro Base. See the above section.
+
 ## Usage
 
     pro is a command to help you manage your git repositories.
 
     Base Directory ==========
-    Pro works from a base directory for efficiency.
+    pro works from a base directory for efficiency.
     This is the folder that contains all your other git repositories;
     they don't have to be at the base level, just somewhere down the tree.
 
-    To set the base directory set the PRO_BASE environment variable or make 
+    To set the base directory set the PRO_BASE environment variable or make
     a ~/.proBase file containing the path.
 
     Commands ===============
@@ -72,13 +85,13 @@ Pro is bundled as a Ruby gem. To install run:
     pro help - display help
 
     CD Command ============
-    You can use the 'pro install' command to install a wrapper function that allows
+    You can use the 'pro install' command to install a wrapper shell function that allows
     you to cd to git repositories in your Pro Base wherever you are based on fuzzy matching.
 
     Example:
 
       ~/randomFolder/ $ pd pro
-      pro/ $ pwd 
+      pro/ $ pwd
       /Users/tristan/Box/Dev/Projects/pro
 
 

data/bin/pro

@@ -7,11 +7,11 @@ HELP = <<END
 pro is a command to help you manage your git repositories.
 
 Base Directory ==========
-Pro works from a base directory for efficiency.
+pro works from a base directory for efficiency.
 This is the folder that contains all your other git repositories;
 they don't have to be at the base level, just somewhere down the tree.
 
-To set the base directory set the PRO_BASE environment variable or make 
+To set the base directory set the PRO_BASE environment variable or make
 a ~/.proBase file containing the path.
 
 Commands ===============
@@ -24,13 +24,13 @@ pro install - Install the pro cd command. cd to a directory by fuzzy git repo ma
 pro help - display help
 
 CD Command ============
-You can use the 'pro install' command to install a wrapper function that allows
+You can use the 'pro install' command to install a wrapper shell function that allows
 you to cd to git repositories in your Pro Base wherever you are based on fuzzy matching.
 
 Example:
 
   ~/randomFolder/ $ pd pro
-  pro/ $ pwd 
+  pro/ $ pwd
   /Users/tristan/Box/Dev/Projects/pro
 
 END
@@ -58,8 +58,8 @@ when 'run'
     print "Command: "
     command = STDIN.gets.chomp
   end
-  Pro.run_command(command) 
+  Pro.run_command(command)
 when 'help'
-  puts HELP 
+  puts HELP
 end
 

data/lib/pro.rb

@@ -4,9 +4,10 @@ require "fuzzy_match"
 require "colored"
 
 SHELL_FUNCTION = <<END
+
 # pro cd function
 {{name}}() {
-  projDir=$(pro search $1)
+  local projDir=$(pro search $1)
   cd ${projDir}
 }
 END
@@ -18,7 +19,7 @@ arbitrarily deep in your PRO_BASE based on fuzzy matching.
 Example:
 
   ~/randomFolder/ $ pd pro
-  pro/ $ pwd 
+  pro/ $ pwd
   /Users/tristan/Box/Dev/Projects/pro
 
 ========
@@ -114,7 +115,7 @@ module Pro
     Dir.chdir(path) do
       status = `git status 2>/dev/null`
     end
-    return status.end_with?("(working directory clean)\n")
+    return status.end_with?("(working directory clean)\n") || status.end_with?("working directory clean\n")
   end
 
   # Finds if there are any commits which have not been pushed to origin
@@ -140,7 +141,7 @@ module Pro
     name = 'pd' if name.empty?
     # sub into function
     func = SHELL_FUNCTION.sub("{{name}}",name)
-    ['~/.bashrc','~/.zshrc'].each do |rel_path|
+    ['~/.profile', '~/.bashrc','~/.zshrc'].each do |rel_path|
       # check if file exists
       path = File.expand_path(rel_path)
       next unless File.exists?(path)

data/lib/pro/version.rb

@@ -1,3 +1,3 @@
 module Pro
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pro
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tristan Hume
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuzzy_match