pro 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ce1007c92dc6bd6f0db3974744f220c0a2feb18
-  data.tar.gz: 0eaa44825c4d8e106bbc2b92c481af03da126de0
+  metadata.gz: 218f37b379ff1daf81b8fe9d35b07b8966aedcbb
+  data.tar.gz: 1a00825b3e77f87452f237b30c11e3827c9a6e6c
 SHA512:
-  metadata.gz: 54262864147d3607af7b4f531b811244de89f2f4993489ec58bbf9ee389cde3eb2e3efec4fa5da6a3cc6f7d976fbc6ff7084cab63f35a391851908185d48651b
-  data.tar.gz: e372b86ce017c084bcfc7f7c7a20ea43014c0ee17c45391787056bed31b16895f41180add6448a0aae7e28241b9bf5e4af5c7d9d480186ccc2b4e21d22eec0c0
+  metadata.gz: 237b2f95989c62e6807f5c17ee318ec2b12f23c7f5bf3db54cb192bb5a75d679e78dc6e4b991bf51b8ab1c37a9c2039131069d1f5a2a2f6ad76130b6a8dba599
+  data.tar.gz: 507ac61607b98f9c38138bf0ef82680efb5a766663265666cc8407ca432d7e667edbe93888d881018e037afed6428af037ab54fe562d82eb1014dffa5f64b03d

data/.gitignore

@@ -1,5 +1,7 @@
 *.gem
 *.rbc
+*.sublime-workspace
+*.sublime-project
 .bundle
 .config
 .yardoc

data/bin/pro

@@ -2,6 +2,15 @@
 # vi: set filetype=ruby fileencoding=UTF-8 shiftwidth=2 tabstop=2 expandtab
 
 require "pro"
+require "yaml"
+
+$pryAvailable = true
+begin
+  require "pry"
+rescue LoadError
+  $pryAvailable = false
+end
+
 
 HELP = <<END
 pro is a command to help you manage your git repositories.
@@ -23,6 +32,8 @@ 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 list - prints the paths to all repos. Intended for scripting.
+pro bases - prints the paths to all bases. Intended for scripting.
 pro install - Install the pro cd command. cd to a directory by fuzzy git repo matching.
 pro help - display help
 
@@ -43,21 +54,32 @@ Example:
 
 END
 
+# spins of indexer even if index
+# unnecessary such as version command
+index = Pro::Indexer.new.index
+pro = Pro::Commands.new(index)
+
 command = ARGV.shift || 'help'
 
 case command
+when 'debug'
+  binding.pry if $pryAvailable
 when 'search'
-  puts Pro.find_repo(ARGV.first)
+  puts pro.find_repo(ARGV.first)
 when 'install'
-  Pro.install_cd
+  pro.install_cd
+when 'list'
+  pro.list_repos
+when 'bases'
+  pro.list_bases
 when 'status'
   if ARGV.first
-    path = Pro.find_repo(ARGV.first)
+    path = pro.find_repo(ARGV.first)
     Dir.chdir(path) do
       puts `git status`
     end
   else
-    Pro.status
+    pro.status
   end
 when 'run'
   unless ARGV.empty?
@@ -66,10 +88,12 @@ when 'run'
     print "Command: "
     command = STDIN.gets.chomp
   end
-  Pro.run_command(command)
+  pro.run_command(command)
 when 'help'
   puts HELP
 when '-v'
-  puts "Pro version #{Pro::VERSION} by Tristan Hume and contributors.\nhttp://github.com/trishume/pro"
+  puts "Pro version #{Pro::VERSION} by Tristan Hume and contributors."
+  puts "Running on Ruby version #{RUBY_VERSION} on platform #{RUBY_PLATFORM}."
+  puts "http://github.com/trishume/pro"
 end
 

data/lib/pro/commands.rb

@@ -0,0 +1,144 @@
+require "pro/index"
+require "find"
+require "fuzzy_match"
+require "colored"
+
+SHELL_FUNCTION = <<END
+
+# pro cd function
+{{name}}() {
+  local projDir=$(pro search $1)
+  cd ${projDir}
+}
+END
+
+CD_INFO = <<END
+This installs a command to allow you to cd to a git repo
+arbitrarily deep in your PRO_BASE based on fuzzy matching.
+
+Example:
+
+  ~/randomFolder/ $ pd pro
+  pro/ $ pwd
+  /Users/tristan/Box/Dev/Projects/pro
+
+========
+END
+
+
+module Pro
+  class Commands
+    DIRTY_MESSAGE = 'uncommitted'.red
+    UNPUSHED_MESSAGE = 'unpushed'.blue
+    JOIN_STRING = ' + '
+
+    def initialize(index)
+      @index = index
+    end
+
+    # Fuzzy search for a git repository by name
+    # Returns the full path to the repository.
+    # 
+    # If name is nil return the pro base.
+    def find_repo(name)
+      return @index.base_dirs.first unless name
+      match = FuzzyMatch.new(@index.to_a, :read => :name).find(name)
+      match[1] unless match.nil?
+    end
+
+    def 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
+      @index.each do |r|
+        Dir.chdir(r.path)
+        result = `#{command}`
+        puts "#{r.name}:".bold.red
+        puts result
+      end
+    end
+
+    # Prints out the paths to all repositories in all bases
+    def list_repos()
+      @index.each do |r|
+        puts r.path
+      end
+    end
+
+    # prints out all the base directories
+    def list_bases
+      @index.base_dirs.each do |b|
+        puts b
+      end
+    end
+
+    # prints a status list showing repos with
+    # unpushed commits or uncommitted changes
+    def status()
+      max_name = @index.map {|repo| repo.name.length}.max + 1
+      @index.each do |r|
+        status = repo_status(r.path)
+        next if status.empty?
+        name = format("%-#{max_name}s",r.name).bold
+        puts "#{name} > #{status}"
+      end
+    end
+
+    # returns a short status message for the repo
+    def repo_status(path)
+      messages = []
+      messages << DIRTY_MESSAGE unless repo_clean?(path)
+      messages << UNPUSHED_MESSAGE if repo_unpushed?(path)
+      messages.join(JOIN_STRING)
+    end
+
+    # Checks if there are any uncommitted changes
+    def repo_clean?(path)
+      status = ""
+      Dir.chdir(path) do
+        status = `git status 2>/dev/null`
+      end
+      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
+    def 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 install_cd
+      puts CD_INFO
+      print "Continue with installation (yN)? "
+      return unless gets.chomp == "y"
+      # get name
+      print "Name of pro cd command (default 'pd'): "
+      name = gets.strip
+      name = 'pd' if name.empty?
+      # sub into function
+      func = SHELL_FUNCTION.sub("{{name}}",name)
+      ['~/.profile', '~/.bashrc','~/.zshrc'].each do |rel_path|
+        # check if file exists
+        path = File.expand_path(rel_path)
+        next unless File.exists?(path)
+        # ask the user if they want to add it
+        print "Install #{name} function to #{rel_path} (yN): "
+        next unless gets.chomp == "y"
+        # add it on to the end of the file
+        File.open(path,'a') do |file|
+          file.puts func
+        end
+      end
+      puts "Done! #{name} will be available in new shells."
+    end
+  end
+end

data/lib/pro/index.rb

@@ -0,0 +1,17 @@
+module Pro
+  Repo = Struct.new(:name,:path)
+  class Index
+    include Enumerable
+    attr_reader :bases,:base_dirs,:created_version
+    def initialize(bases,base_dirs)
+      @bases, @base_dirs = bases, base_dirs
+      @created_version = Pro::VERSION
+    end
+    # yields all repo objects in all bases
+    def each
+      bases.each do |key,val|
+        val.each {|r| yield r}
+      end
+    end
+  end
+end

data/lib/pro/indexer.rb

@@ -0,0 +1,151 @@
+require "pro/index"
+require "colored"
+module Pro
+  # creates an index object from cache
+  # or by searching the file system
+  class Indexer
+    CACHE_PATH = File.expand_path("~/.proCache")
+    INDEXER_LOCK_PATH = File.expand_path("~/.proCacheLock")
+    def initialize
+      @base_dirs = find_base_dirs
+      @low_cpu = false
+    end
+
+    def index
+      # most of the time the cache should exist
+      if res = read_cache
+        # index in the background for next time.
+        run_index_process
+      else
+        STDERR.puts "Indexing... This should only happen after updating.".red
+        res = build_index
+      end
+      res
+    end
+    # unserializes the cache file and returns
+    # the index object
+    def read_cache
+      return nil unless File.readable_real?(CACHE_PATH)
+      index = YAML::load_file(CACHE_PATH)
+      return nil unless index.created_version == Pro::VERSION
+      return nil unless index.base_dirs == @base_dirs
+      index
+    end
+
+    # spins off a background process to update the cache file
+    def run_index_process
+      fork {
+        index_process unless File.exists?(INDEXER_LOCK_PATH)
+      }
+    end
+
+    def index_process
+      @low_cpu = true
+      # create lock so no work duplicated
+      begin
+        File.open(INDEXER_LOCK_PATH, "w") {}
+        build_index
+      ensure
+        File.delete(INDEXER_LOCK_PATH)
+      end
+    end
+
+    # scan the base directories for git repos
+    # and build an index then cache it
+    # returns an index
+    def build_index
+      index = scan_into_index
+      cache_index(index)
+      index
+    end
+
+    # serialize the index to a cache file
+    def cache_index(index)
+      # TODO: atomic rename. Right now we just hope.
+      File.open(CACHE_PATH, 'w' ) do |out|
+        YAML::dump( index, out )
+      end
+    end
+
+    # compile base directories and scan them
+    # use this info to create an index object
+    # and return it
+    def scan_into_index
+      repos = scan_bases
+      Index.new(repos,@base_dirs)
+    end
+
+    # add all git repos in all bases to the index
+    def scan_bases
+      bases = {}
+      @base_dirs.each do |base|
+        bases[base] = index_repos(base)
+      end
+      bases
+    end
+
+
+    # find all repos in a certain base directory
+    # returns an array of Repo objects
+    def index_repos(base)
+      if system("which find > /dev/null")
+        index_repos_fast(base)
+      else
+        index_repos_slow(base)
+      end
+    end
+
+    def index_repos_fast(base)
+      res = `find #{base} -name .git`
+      # turn the output into a list of repos
+      repos = []
+      res.each_line do |line|
+        next if line.empty?
+        git_path = File.expand_path(line.chomp)
+        path = File.dirname(git_path)
+        repo_name = File.basename(path)
+        repos << Repo.new(repo_name,path)
+      end
+      repos
+    end
+
+    # recursive walk in ruby
+    def index_repos_slow(base)
+      STDERR.puts "WARNING: pro is indexing slowly, please install the 'find' command."
+      repos = []
+      Find.find(base) do |path|
+        # dir must exist and be a git repo
+        if FileTest.directory?(path) && File.exists?(path+"/.git")
+          base_name = File.basename(path)
+          repos << Repo.new(base_name,path)
+          Find.prune
+        end
+        # slow down
+        sleep(1.0/10000.0) if @low_cpu
+      end
+      repos
+    end
+
+    # Finds the base directory where repos are kept
+    # Checks the environment variable PRO_BASE and the
+    # file .proBase
+    def find_base_dirs()
+      bases = []
+      # check environment first
+      base = ENV['PRO_BASE']
+      bases << base if base
+      # next check proBase file
+      path = ENV['HOME'] + "/.proBase"
+      if File.exists?(path)
+        # read lines of the pro base file
+        bases += IO.read(path).split("\n").map {|p| File.expand_path(p.strip)}
+      end
+      # strip bases that do not exist
+      # I know about select! but it doesn't exist in 1.8
+      bases = bases.select {|b| File.exists?(b)}
+      # if no bases then return home
+      bases << ENV['HOME'] if bases.empty?
+      bases
+    end
+  end
+end

data/lib/pro/version.rb

@@ -1,3 +1,3 @@
 module Pro
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/pro.rb

@@ -1,168 +1,4 @@
 require "pro/version"
-require "find"
-require "fuzzy_match"
-require "colored"
-
-SHELL_FUNCTION = <<END
-
-# pro cd function
-{{name}}() {
-  local projDir=$(pro search $1)
-  cd ${projDir}
-}
-END
-
-CD_INFO = <<END
-This installs a command to allow you to cd to a git repo
-arbitrarily deep in your PRO_BASE based on fuzzy matching.
-
-Example:
-
-  ~/randomFolder/ $ pd pro
-  pro/ $ pwd
-  /Users/tristan/Box/Dev/Projects/pro
-
-========
-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
-  def self.base_dirs()
-    bases = []
-    # check environment first
-    base = ENV['PRO_BASE']
-    bases << base if base
-    # next check proBase file
-    path = ENV['HOME'] + "/.proBase"
-    if File.exists?(path)
-      # read lines of the pro base file
-      bases += IO.read(path).split("\n").map {|p| File.expand_path(p.strip)}
-    end
-    # strip bases that do not exist
-    # I know about select! but it doesn't exist in 1.8
-    bases = bases.select {|b| File.exists?(b)}
-    # if no bases then return home
-    bases << ENV['HOME'] if bases.empty?
-    bases
-  end
-
-  # Searches for all the git repositories in the base directory.
-  # returns an array of [repo_name, path] pairs.
-  def self.repo_list
-    repos = []
-    Pro.base_dirs.each do |base|
-      Find.find(base) do |path|
-        if FileTest.directory?(path)
-          # is this folder a git repo
-          if File.exists?(path+"/.git")
-            base_name = File.basename(path)
-            repos << [base_name,path]
-            Find.prune
-          end
-        end
-      end
-    end
-    repos
-  end
-
-  # Fuzzy search for a git repository by name
-  # Returns the full path to the repository.
-  # 
-  # If name is nil return the pro base.
-  def self.find_repo(name)
-    return Pro.base_dirs.first unless 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") || 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)? "
-    return unless gets.chomp == "y"
-    # get name
-    print "Name of pro cd command (default 'pd'): "
-    name = gets.strip
-    name = 'pd' if name.empty?
-    # sub into function
-    func = SHELL_FUNCTION.sub("{{name}}",name)
-    ['~/.profile', '~/.bashrc','~/.zshrc'].each do |rel_path|
-      # check if file exists
-      path = File.expand_path(rel_path)
-      next unless File.exists?(path)
-      # ask the user if they want to add it
-      print "Install #{name} function to #{rel_path} (yN): "
-      next unless gets.chomp == "y"
-      # add it on to the end of the file
-      File.open(path,'a') do |file|
-        file.puts func
-      end
-    end
-    puts "Done! #{name} will be available in new shells."
-  end
-end
+require "pro/indexer"
+require "pro/index"
+require "pro/commands"

data/pro.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pro
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Tristan Hume
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuzzy_match
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Lightweight git project tool.
 email:
 - tris.hume@gmail.com
@@ -81,6 +95,9 @@ files:
 - Rakefile
 - bin/pro
 - lib/pro.rb
+- lib/pro/commands.rb
+- lib/pro/index.rb
+- lib/pro/indexer.rb
 - lib/pro/version.rb
 - pro.gemspec
 homepage: http://github.com/trishume/pro