brigit 0.8.2 → 0.9.1

data/Manifest

@@ -1,7 +1,12 @@
 bin/brigit
+help/grab.rdoc
+help/hop.rdoc
+help/map.rdoc
+help/update.rdoc
 lib/brigit/cli.rb
 lib/brigit/commands/command.rb
 lib/brigit/commands/grab_command.rb
+lib/brigit/commands/hop_command.rb
 lib/brigit/commands/map_command.rb
 lib/brigit/commands/update_command.rb
 lib/brigit/config_parser.rb
@@ -9,12 +14,24 @@ lib/brigit/fallible.rb
 lib/brigit/inventories/gitosis_inventory.rb
 lib/brigit/inventories/inventory.rb
 lib/brigit/listable.rb
+lib/brigit/pretending.rb
 lib/brigit/version.rb
 lib/brigit.rb
 lib/ext/option_parser.rb
 Manifest
 Rakefile
 README.rdoc
+test/brigit_test.rb
+test/cli_test.rb
+test/command_test.rb
 test/config_parser_test.rb
+test/fallible_test.rb
 test/fixtures/example.conf
+test/fixtures/gitosis-admin/gitosis.conf
+test/fixtures/grab_command/existing_directory/stub
+test/fixtures/submodule_methods/parent/submodule/foo.rb
+test/gitosis_test.rb
+test/grab_command_test.rb
+test/inventory_test.rb
+test/option_parser_test.rb
 test/test_helper.rb

data/README.rdoc

@@ -6,6 +6,15 @@ A random collection of utilities for developers working with Git repositories.
 
 Feel free to fork, send patches, etc.  Development is done at http://github.com/fiveruns/brigit
 
+== Usage
+
+Call the +brigit+ executable without any arguments to get the list of commands;
+you can then do:
+
+  brigit <command> --help
+  
+The same information is available under the help/.
+
 == Authors
 
 The FiveRuns development team, http://www.fiveruns.org

data/Rakefile

@@ -11,5 +11,5 @@ Echoe.new 'brigit' do |p|
   p.summary = "Git utilities"
   p.url = "http://github.com/fiveruns/brigit"
   p.include_rakefile = true
-end
-
+  p.rcov_options << '--sort coverage --exclude gems --text-summary'
+end

data/bin/brigit

@@ -2,7 +2,5 @@
 
 require File.dirname(__FILE__) << "/../lib/brigit"
 
-Brigit::CLI.new.parse(*ARGV) do |command|
-  command.execute!
-end
+Brigit::CLI.new.parse(*ARGV).run
   

data/brigit.gemspec

@@ -1,55 +1,131 @@
 
-# Gem::Specification for Brigit-0.8.2
+# Gem::Specification for Brigit-0.9.1
 # Originally generated by Echoe
 
-Gem::Specification.new do |s|
-  s.name = %q{brigit}
-  s.version = "0.8.2"
+--- !ruby/object:Gem::Specification 
+name: brigit
+version: !ruby/object:Gem::Version 
+  version: 0.9.1
+platform: ruby
+authors: 
+- FiveRuns Development Team
+autorequire: 
+bindir: bin
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["FiveRuns Development Team"]
-  s.date = %q{2008-07-08}
-  s.default_executable = %q{brigit}
-  s.description = %q{Git utilities}
-  s.email = %q{dev@fiveruns.com}
-  s.executables = ["brigit"]
-  s.extra_rdoc_files = ["bin/brigit", "lib/brigit/cli.rb", "lib/brigit/commands/command.rb", "lib/brigit/commands/grab_command.rb", "lib/brigit/commands/map_command.rb", "lib/brigit/commands/update_command.rb", "lib/brigit/config_parser.rb", "lib/brigit/fallible.rb", "lib/brigit/inventories/gitosis_inventory.rb", "lib/brigit/inventories/inventory.rb", "lib/brigit/listable.rb", "lib/brigit/version.rb", "lib/brigit.rb", "lib/ext/option_parser.rb", "README.rdoc"]
-  s.files = ["bin/brigit", "lib/brigit/cli.rb", "lib/brigit/commands/command.rb", "lib/brigit/commands/grab_command.rb", "lib/brigit/commands/map_command.rb", "lib/brigit/commands/update_command.rb", "lib/brigit/config_parser.rb", "lib/brigit/fallible.rb", "lib/brigit/inventories/gitosis_inventory.rb", "lib/brigit/inventories/inventory.rb", "lib/brigit/listable.rb", "lib/brigit/version.rb", "lib/brigit.rb", "lib/ext/option_parser.rb", "Manifest", "Rakefile", "README.rdoc", "test/config_parser_test.rb", "test/fixtures/example.conf", "test/test_helper.rb", "brigit.gemspec"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/fiveruns/brigit}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Brigit", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{fiveruns}
-  s.rubygems_version = %q{1.2.0}
-  s.summary = %q{Git utilities}
-  s.test_files = ["test/config_parser_test.rb", "test/test_helper.rb"]
+date: 2008-07-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Git utilities
+email: dev@fiveruns.com
+executables: 
+- brigit
+extensions: []
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+extra_rdoc_files: 
+- bin/brigit
+- lib/brigit/cli.rb
+- lib/brigit/commands/command.rb
+- lib/brigit/commands/grab_command.rb
+- lib/brigit/commands/hop_command.rb
+- lib/brigit/commands/map_command.rb
+- lib/brigit/commands/update_command.rb
+- lib/brigit/config_parser.rb
+- lib/brigit/fallible.rb
+- lib/brigit/inventories/gitosis_inventory.rb
+- lib/brigit/inventories/inventory.rb
+- lib/brigit/listable.rb
+- lib/brigit/pretending.rb
+- lib/brigit/version.rb
+- lib/brigit.rb
+- lib/ext/option_parser.rb
+- README.rdoc
+files: 
+- bin/brigit
+- help/grab.rdoc
+- help/hop.rdoc
+- help/map.rdoc
+- help/update.rdoc
+- lib/brigit/cli.rb
+- lib/brigit/commands/command.rb
+- lib/brigit/commands/grab_command.rb
+- lib/brigit/commands/hop_command.rb
+- lib/brigit/commands/map_command.rb
+- lib/brigit/commands/update_command.rb
+- lib/brigit/config_parser.rb
+- lib/brigit/fallible.rb
+- lib/brigit/inventories/gitosis_inventory.rb
+- lib/brigit/inventories/inventory.rb
+- lib/brigit/listable.rb
+- lib/brigit/pretending.rb
+- lib/brigit/version.rb
+- lib/brigit.rb
+- lib/ext/option_parser.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- test/brigit_test.rb
+- test/cli_test.rb
+- test/command_test.rb
+- test/config_parser_test.rb
+- test/fallible_test.rb
+- test/fixtures/example.conf
+- test/fixtures/gitosis-admin/gitosis.conf
+- test/fixtures/grab_command/existing_directory/stub
+- test/fixtures/submodule_methods/parent/submodule/foo.rb
+- test/gitosis_test.rb
+- test/grab_command_test.rb
+- test/inventory_test.rb
+- test/option_parser_test.rb
+- test/test_helper.rb
+- brigit.gemspec
+has_rdoc: true
+homepage: http://github.com/fiveruns/brigit
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Brigit
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - "="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
 
-    if current_version >= 3 then
-    else
-    end
-  else
-  end
-end
-
-
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# require 'rubygems'
-# require 'echoe'
-# 
-# require File.dirname(__FILE__) << "/lib/brigit/version"
-# 
-# Echoe.new 'brigit' do |p|
-#   p.version = Brigit::Version::STRING
-#   p.author = "FiveRuns Development Team"
-#   p.email  = 'dev@fiveruns.com'
-#   p.project = 'fiveruns'
-#   p.summary = "Git utilities"
-#   p.url = "http://github.com/fiveruns/brigit"
-#   p.include_rakefile = true
-# end
-# 
+rubyforge_project: fiveruns
+rubygems_version: 1.2.0
+specification_version: 2
+summary: Git utilities
+test_files: 
+- test/brigit_test.rb
+- test/cli_test.rb
+- test/command_test.rb
+- test/config_parser_test.rb
+- test/fallible_test.rb
+- test/gitosis_test.rb
+- test/grab_command_test.rb
+- test/inventory_test.rb
+- test/option_parser_test.rb
+- test/test_helper.rb

data/help/grab.rdoc

@@ -0,0 +1,16 @@
+Grab repos matching optional pattern from a gitosis-admin config"
+
+== Syntax
+
+  brigit grab PATH_TO_GITOSIS_ADMIN_REPO [PATTERN, ...]
+  
+== Examples
+
+Using the list of repositories provided by ~/gitosis-admin, clone all that
+include the substring 'my-product' or 'their-product'
+
+  brigit grab ~/gitosis-admin my-product their-product
+  
+The same, but clone all repositories:
+
+  brigit grab ~/gitosis-admin

data/help/hop.rdoc

@@ -0,0 +1,36 @@
+Change submodule references in repositories.
+
+== Syntax
+
+  brigit hop SUBMODULE_URL [OPTIONS] [REPO_PATHS, ...]
+  
+== Notes
+
+* For safety reasons:
+  * It WILL NOT change a submodule that has uncommitted changes; the
+    submodule must be pristine. You need to handle these submodules manually.
+  * It does not currently commit the updated submodule reference in the parent
+    repository; the list of modified repos are output after the command
+    is executed; you still need to commit and push manually.
+* It will do a fresh pull from the submodule's origin before checking out the
+  reference you select with the -r/--ref option (default: 'master')
+  
+== Examples
+
+Update all submodules pointing to remote origin 'git@example.com:mine' in
+repositories under PWD (or just PWD, if it's a repo itself) to a whatever
+the current commit is on the 'master' branch.
+
+  git hop git@example.com:mine
+  
+Do the same, but only in the foo/bar repository
+
+  git hop git@example.com:mine foo/bar
+  
+The same, but this time set the submodule commit to the 'alternate' branch
+
+  git hop git@example.com:mine -r alternate foo/bar
+
+And this time, commit SHA 25b306c73
+
+  git hop git@example.com:mine -r 25b306c73 foo/bar

data/help/map.rdoc

@@ -0,0 +1,19 @@
+Graphs of submodules in this repository
+
+== Syntax
+
+  brigit map [OPTIONS]
+  
+== Notes
+
+You must be in the Git repository when this command is executed.
+
+== Examples
+
+Output DOT-format output for current repository structure:
+
+  brigit map
+  
+Display graph of current repository structure:
+
+  brigit map -o

data/help/update.rdoc

@@ -0,0 +1,9 @@
+Update all submodules in the repo, recursively
+
+== Syntax
+
+  brigit update
+
+== Notes
+
+You must be in the Git repository when this command is executed.

data/lib/brigit/cli.rb

@@ -5,55 +5,24 @@ module Brigit
   class CLI
     
     def parse(*args)
-      self.class.parser.parse!(args)
-      if (args.first && command = Command[args.shift])
-        yield command.new(self.class.options, *args)
+      if (command = Command[args.shift])
+        command.new(*args)
       else
-        abort "No command given.\n#{parser}"
+        abort "No command given.\n\n#{self.class.usage}"
       end
     end
-        
-    def self.usage
-      parser.to_s
-    end
-    
-    #######
-    private
-    #######
     
-    def self.options
-      @options ||= OpenStruct.new
+    def self.banner
+      %{Brigit (v#{Version::STRING}) Submodule utilities for Git}
     end
-    
-    def self.parser
-      
-      command_list = Command.list.map { |command| "  * #{command.name}: #{command.help}" }.join("\n")
-      
-      options.inventory = {}
-      
-      @parser ||= OptionParser.new do |opts|
-        
-        opts.banner = %("Brigit," Submodule utilities for Git\nUSAGE: brigit COMMAND [OPTIONS])
-
-        opts.separator "COMMANDS:\n#{command_list}\n"
         
-        opts.separator "OPTIONS:\n"
-
-        Inventory.list.each do |inventory|
-          opts.on("-#{inventory.name[0,1]}", "--#{inventory.name} PATH", "Location of #{inventory.name} (`grab' only)") do |path|
-            options.inventory[inventory] = path
-          end
-        end
-        
-        opts.on('-o', '--open', "Open with Preview.app  (`map' only, requires OSX & `dot' in PATH)") do
-          options.open = true
-        end
-        
-        opts.on_tail('-h', '--help', 'Show this message') do
-          abort opts.to_s
-        end
-        
-      end
+    def self.usage
+      lines = [
+        banner,
+        %{COMMANDS: (`COMMAND --help' for documentation)},
+        *Command.list.map { |cmd| "  #{cmd.name}" }.sort
+      ]
+      lines.join "\n"
     end
     
   end

data/lib/brigit/commands/command.rb

@@ -1,29 +1,65 @@
 require 'brigit/listable'
 require 'brigit/fallible'
+require 'brigit/pretending'
+
 
 module Brigit
   
   class Command
     include Listable
     include Fallible
+    include Pretending
     
-    class << self
-      attr_accessor :help
+    def self.help
+      @help ||= begin
+        help_file = File.dirname(__FILE__) << "/../../../help/#{name}.rdoc"
+        if File.file?(help_file)
+          File.read(help_file) 
+        else
+          "Sorry, there is no documentation for this command."
+        end
+      end
     end
     
-    attr_reader :options, :args
-    def initialize(options, *args)
-      @options = options
+    attr_reader :args
+    def initialize(*args)
       @args = args
     end
     
-    def execute!
-      raise ArgumentError, "Must be in Git repository" unless repo?
+    def run
+      yield parser if block_given?
+      parser.parse!(args)
     end
     
     #######
     private
     #######
+    
+    def say(message)
+      message = pretending? ? "{PRETENDING} #{message}" : message
+      $stderr.puts message
+    end
+    
+    def sh(command)
+      if pretending?
+        say command
+      else
+        system command
+      end
+    end
+    
+    def check_repo!
+      raise ArgumentError, "Must be in Git repository" unless repo?
+    end
+    
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = CLI.banner + "\n---\n= Help on the `#{self.class.name}' command\n\n" + self.class.help + "\n\n== Options\n"
+        opts.on_tail('-h', '--help', 'Show this message') do
+          abort opts.to_s
+        end
+      end
+    end
 
     def repo?
       File.directory?(File.join(Dir.pwd, '.git'))

data/lib/brigit/commands/grab_command.rb

@@ -5,20 +5,16 @@ module Brigit
   
   class GrabCommand < Command
     
-    self.help = "Grab repos matching optional pattern from a gitosis-admin config"
-    
-    def execute!
-      validate!
+    def run
+      super { |parser| add_pretend_to parser }
       matching_repositories.each do |name, location|
         if File.exists?(name)
-          STDERR.puts "#{name}: Already exists, skipping..."
+          say "#{name}: Already exists, skipping..."
         else
-          STDERR.puts "#{name}: Cloning from #{location} ..."
-          system "git clone '#{location}' '#{name}'"
-          STDERR.puts "#{name}: Updating submodules ..."
-          Dir.chdir name do
-            updater.execute!
-          end
+          say "#{name}: Cloning from #{location} ..."
+          sh "git clone '#{location}' '#{name}'"
+          say "#{name}: Updating submodules ..."
+          update name
         end
       end
     end
@@ -27,22 +23,26 @@ module Brigit
     private
     #######
     
-    def updater
-      @updater ||= UpdateCommand.new(options)
+    def update(name)
+      if pretending?
+        say "(Would update submodules for `#{name}')"
+      else
+        if File.directory?(name)        
+          Dir.chdir name do
+            UpdateCommand.new.run
+          end
+        else
+          say "ERROR: Directory #{name} was not created; skipping..."
+        end
+      end      
     end
-
-    def validate!
-      if options.inventory.empty?
-        list = Inventory.listing { |name| "--#{name}" }
-        fail "Can't find list of repositories; need to set #{list}"
-      end            
+    
+    def inventory
+      @inventory ||= GitosisInventory.new(args.shift)
     end
     
     def all_repositories
-      options.inventory.inject({}) do |all, (klass, path)|
-        source = klass.new(path)
-        all.merge(source.repositories)
-      end
+      inventory.repositories
     end
     
     def matching_repositories

data/lib/brigit/commands/hop_command.rb

@@ -0,0 +1,91 @@
+require 'brigit/commands/command'
+
+module Brigit
+  
+  class HopCommand < Command
+    
+    def run
+      ref = default_ref
+      super do |parser|
+        parser.on('-r TREE-ISH', '--ref', "(default: `#{ref}')") do |treeish|
+          ref = treeish
+        end
+        add_pretend_to parser
+      end
+      check_url!
+      changed = []
+      errors = []
+      submodules.each do |path, parent|
+        Dir.chdir path do
+          say "cd #{path}"
+          if clean?
+            sh 'git pull origin master'
+            sh "git checkout '#{ref}'"
+            changed << parent
+          else
+            say "Working directory isn't clean, skipping"
+            errors << path
+          end
+        end
+      end
+      if changed.any?
+        say "---\nPlease check and commit the following parent repositories:\n#{format_list changed}"
+      end
+      if errors.any?
+        say "---\nCould not update the following locations:\n#{format_list errors}"
+      end
+    end
+    
+    #######
+    private
+    #######
+    
+    def format_list(list)
+      list.map { |item| "  #{item}" }.join("\n")
+    end
+    
+    def clean?
+      `git status` =~ /working directory clean/
+    end
+    
+    def valid?(path)
+      return false unless Brigit.submodule?(path)
+      config_file = File.join(path, '.git/config')
+      url = config_parser.parse(File.readlines(config_file))['remote "origin"']['url'] rescue nil
+      return false unless url
+      normalize(submodule_url) == normalize(url)
+    end
+    
+    def config_parser
+      @config_parser ||= ConfigParser.new
+    end
+    
+    def check_url!
+      fail "Submodule URL required" unless submodule_url
+    end
+    
+    def normalize(url)
+      url =~ /\.git$/ ? url : "#{url}.git"
+    end
+    
+    def submodule_url
+      @submodule_url ||= args.shift
+    end
+    
+    def submodules
+      @submodules ||= begin
+        list = []
+        Brigit.at_repos(true) do |path|
+          list << [path, Brigit.parent_of(path)] if valid?(path)
+        end
+        list
+      end
+    end
+
+    def default_ref
+      'master'
+    end
+    
+  end
+  
+end