pro 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b15ba0cff13982167359dbb415e2b949e9dc1956
-  data.tar.gz: 5f48d6b702d9b045ca05ffeb77df36d2273a0b6a
+  metadata.gz: 9ac15f737100200ff1b897182f49139736a8e876
+  data.tar.gz: 5ba1a872a3126ea296df0156936b393395920df6
 SHA512:
-  metadata.gz: 9403e2d5237705f2daa8a30c0368e65487d2d9ee9d8765896bcaee2313cf44a5cea22d6b4b6320e277ee922eebc78f80f613415c87a575f9862e78b0e7bd18b4
-  data.tar.gz: 96a90289037146c2125abfd7b07eefe7251e3fab049693c035680b2b439a478f090dae6ffba4a20fa2d8c6a11a20a227eee67ab952748e72d1d215b8df78a817
+  metadata.gz: 5ce52738f6186ed0d640c11761c76eeaf699d1c1993880fa0f1193897409775d32e7e37ff4f9447158c6f0d829623182d910e37bde8aaa8061b0dba5fe039ab3
+  data.tar.gz: 9fc044be29999b50daea1bf481899557c2503fa3f9d60e5b7c9a6ca6d816f33572d2780a6533ef456f1a2ff19757188d10f41b12ddd891f56b17977fb82f5913

data/README.md

@@ -1,28 +1,48 @@
 # Pro
 
 `pro` is a little utility to wrangle your git repositories.
-At the moment all it does is provide the very useful function of letting
-you instantly cd to git repositories based on fuzzy matching.
+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.
 
-## Pro CD
+## CD'ing to a project's repository
 
-Use the `pro install` command and follow the prompts to install the pro cd command.
-As part of the install process you can name it whatever you want but it
-defaults to `pd`.
+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
+problem using frequency and recency.
+Pro solves the problem by fuzzy searching only git repositories.
 
-### Examples
+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`.
+Once you have it you can do some pretty intense cd'ing:
 
-```bash
-    ~/randomFolder/ $ pd pro
-    pro/ $ pwd 
-    /Users/tristan/Box/Dev/Projects/pro
-    pro/ $ pd eye
-    eyeLike/ $ pwd
-    /Users/tristan/Box/Dev/Projects/eyeLike
-    eyeLike/ $ pd web
-    Website/ $ pwd
-    /Users/tristan/Box/Dev/Website/
-```
+![pd demo](http://thume.ca/assets/postassets/pro/pd_screen.png)
+
+## State of the Repos Address
+
+Oftentimes I find myself wondering which git repositories of mine still have
+uncommitted changes or unpushed commits. I could find them all and run git
+status but it would be nice to get a quick overview. `pro status` does this.
+
+![pro status](http://thume.ca/assets/postassets/pro/pro_status.png)
+
+You can also run `pro status <repo>` to show the output of `git status` for a
+certain repo.
+
+## Run all the commands!
+
+Wouldn't it be cool if you could run a command on all your repos and see a
+summary of the output? Now you can!
+
+You can do this with `pro run <command>`. If you don't pass a command it will
+prompt you for one.
+
+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.
 
 ## Installation
 
@@ -32,31 +52,34 @@ Pro is bundled as a Ruby gem. To install run:
 
 ## Usage
 
-    $ pro help
     pro is a command to help you manage your git repositories.
 
-    base directory ==========
-    pro works from a base directory for efficiency.
-    this is the folder that contains all your other git repositories;
+    Base Directory ==========
+    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 
-    a ~/.probase file containing the path.
+    To set the base directory set the PRO_BASE environment variable or make 
+    a ~/.proBase file containing the path.
 
-    commands ===============
+    Commands ===============
     pro search <query> - prints path of git repo that matches query.
-    pro install - install the pro cd command. cd to a directory by fuzzy git repo matching.
+    pro status - prints a list of all repos with uncommitted or unpushed changes.
+    pro status <name> - prints the output of 'git status' on the repo.
+    pro run - prompts for a command to run in all git repos.
+    pro run <command> - runs the given command in all git repos.
+    pro install - Install the pro cd command. cd to a directory by fuzzy git repo matching.
     pro help - display help
 
-    cd command ============
-    you can use the 'pro install' command to install a wrapper function that allows
-    you to cd to git repositories in your pro base wherever you are based on fuzzy matching.
+    CD Command ============
+    You can use the 'pro install' command to install a wrapper function that allows
+    you to cd to git repositories in your Pro Base wherever you are based on fuzzy matching.
 
-    example:
+    Example:
 
-      ~/randomfolder/ $ pd pro
+      ~/randomFolder/ $ pd pro
       pro/ $ pwd 
-      /users/tristan/box/dev/projects/pro
+      /Users/tristan/Box/Dev/Projects/pro
 
 
 ## Contributing

data/bin/pro

@@ -16,6 +16,10 @@ a ~/.proBase file containing the path.
 
 Commands ===============
 pro search <query> - prints path of git repo that matches query.
+pro status - prints a list of all repos with uncommitted or unpushed changes.
+pro status <name> - prints the output of 'git status' on the repo.
+pro run - prompts for a command to run in all git repos.
+pro run <command> - runs the given command in all git repos.
 pro install - Install the pro cd command. cd to a directory by fuzzy git repo matching.
 pro help - display help
 
@@ -38,6 +42,23 @@ when 'search'
   puts Pro.find_repo(ARGV.first)
 when 'install'
   Pro.install_cd
+when 'status'
+  if ARGV.first
+    path = Pro.find_repo(ARGV.first)
+    Dir.chdir(path) do
+      puts `git status`
+    end
+  else
+    Pro.status
+  end
+when 'run'
+  unless ARGV.empty?
+    command = ARGV.join(" ")
+  else
+    print "Command: "
+    command = STDIN.gets.chomp
+  end
+  Pro.run_command(command) 
 when 'help'
   puts HELP 
 end

data/lib/pro.rb

@@ -1,6 +1,7 @@
 require "pro/version"
 require "find"
 require "fuzzy_match"
+require "colored"
 
 SHELL_FUNCTION = <<END
 # pro cd function
@@ -25,6 +26,9 @@ END
 
 
 module Pro
+  DIRTY_MESSAGE = 'uncommitted'.red
+  UNPUSHED_MESSAGE = 'unpushed'.blue
+  JOIN_STRING = ' + '
   # Finds the base directory where repos are kept
   # Checks the environment variable PRO_BASE and the
   # file .proBase
@@ -41,7 +45,10 @@ module Pro
     end
     base
   end
-  def self.find_repo(name)
+
+  # Searches for all the git repositories in the base directory.
+  # returns an array of [repo_name, path] pairs.
+  def self.repo_list
     repos = []
     Find.find(Pro.base_dir) do |path|
       if FileTest.directory?(path)
@@ -53,9 +60,76 @@ module Pro
         end
       end
     end
+    repos
+  end
+
+  # Fuzzy search for a git repository by name
+  # Returns the full path to the repository.
+  def self.find_repo(name)
+    repos = Pro.repo_list
     match = FuzzyMatch.new(repos, :read => :first).find(name)
     match[1] unless match.nil?
   end
+
+  def self.run_command(command, confirm = true)
+    if confirm
+      print "Do you really want to run '#{command.bold}' on all repos [Y/n]? "
+      ans = STDIN.gets
+      return if ans.chomp != "Y"
+    end
+    repos = Pro.repo_list
+    repos.each do |r|
+      Dir.chdir(r[1])
+      result = `#{command}`
+      puts "#{r.first}:".bold.red
+      puts result
+    end
+  end
+
+  # prints a status list showing repos with
+  # unpushed commits or uncommitted changes
+  def self.status
+    repos = Pro.repo_list
+    max_name = repos.map {|pair| pair.first.length}.max + 1
+    repos.each do |pair|
+      path = pair.last
+      status = Pro.repo_status(path)
+      next if status.empty?
+      name = format("%-#{max_name}s",pair.first).bold
+      puts "#{name} > #{status}"
+    end
+  end
+
+  # returns a short status message for the repo
+  def self.repo_status(path)
+    messages = []
+    messages << DIRTY_MESSAGE unless Pro.repo_clean?(path)
+    messages << UNPUSHED_MESSAGE if Pro.repo_unpushed?(path)
+    messages.join(JOIN_STRING)
+  end
+
+  # Checks if there are any uncommitted changes
+  def self.repo_clean?(path)
+    status = ""
+    Dir.chdir(path) do
+      status = `git status 2>/dev/null`
+    end
+    return status.end_with?("(working directory clean)\n")
+  end
+
+  # Finds if there are any commits which have not been pushed to origin
+  def self.repo_unpushed?(path)
+    unpushed = ""
+    Dir.chdir(path) do
+      branch_ref = `/usr/bin/git symbolic-ref HEAD 2>/dev/null`
+      branch = branch_ref.chomp.split('/').last
+      unpushed = `git cherry -v origin/#{branch} 2>/dev/null`
+    end
+    return !(unpushed.empty?)
+  end
+
+  # Adds a shell function to the shell config files that
+  # allows easy directory changing.
   def self.install_cd
     puts CD_INFO
     print "Continue with installation (yN)? "

data/lib/pro/version.rb

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

data/pro.gemspec

@@ -9,12 +9,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tristan Hume"]
   spec.email         = ["tris.hume@gmail.com"]
   spec.description   = %q{Lightweight git project tool.}
-  spec.summary       = %q{Command line tool that allows you to quickly cd to git projects.}
+  spec.summary       = %q{Command line tool that allows you to quickly cd to git projects and other handy things.}
   spec.homepage      = "http://github.com/trishume/pro"
   spec.license       = "MIT"
 
   #spec.add_runtime_dependency 'commander','~> 4.1.2'  
   spec.add_runtime_dependency 'fuzzy_match'
+  spec.add_runtime_dependency 'colored'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tristan Hume
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuzzy_match
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,5 +106,6 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Command line tool that allows you to quickly cd to git projects.
+summary: Command line tool that allows you to quickly cd to git projects and other
+  handy things.
 test_files: []