help/grab.rdoc help/map.rdoc help/update.rdoc @@ -1,4 +1,7 @@ bin/brigit +help/grab.rdoc +help/map.rdoc +help/update.rdoc lib/brigit/cli.rb lib/brigit/commands/command.rb lib/brigit/commands/grab_command.rb Manifest @@ -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 \ No newline at end of file bin/brigit @@ -5,60 +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#{self.class.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 (v#{Version::STRING}) 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('-v', '--version', "Show version") do - STDERR.puts "Brigit v#{Version::STRING}" - exit - 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 lib/brigit/cli.rb @@ -7,23 +7,43 @@ module Brigit include Listable include Fallible - 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 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')) lib/brigit/commands/command.rb @@ -5,10 +5,8 @@ module Brigit class GrabCommand < Command - self.help = "Grab repos matching optional pattern from a gitosis-admin config" - - def execute! - validate! + def run + super matching_repositories.each do |name, location| if File.exists?(name) STDERR.puts "#{name}: Already exists, skipping..." @@ -17,7 +15,7 @@ module Brigit system "git clone '#{location}' '#{name}'" STDERR.puts "#{name}: Updating submodules ..." Dir.chdir name do - updater.execute! + UpdateCommand.new.run end end end @@ -27,22 +25,12 @@ module Brigit private ####### - def updater - @updater ||= UpdateCommand.new(options) - 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 lib/brigit/commands/grab_command.rb @@ -5,10 +5,13 @@ module Brigit class MapCommand < Command - self.help = "Graphs of submodules in this repository" - - def execute! - super + def run + open = false + super do |parser| + parser.on('-o', '--open', "Open as PNG in Preview.app (OSX only, requires `dot')") do + open = true + end + end text = %|digraph G {\n| # TODO: Allow customization text << %|ranksep=.75; size = "12,12";\n| @@ -21,7 +24,7 @@ module Brigit end end text << %|}\n| - if options.open + if open IO.popen("dot -Tpng | open -f -a /Applications/Preview.app", 'w') do |file| file.write text end @@ -36,18 +39,18 @@ module Brigit def origin_at(path) filename = File.join(path, '.git/config') - result = parser.parse(File.readlines(filename)) + result = config_parser.parse(File.readlines(filename)) result['remote "origin"']['url'] end def submodules_at(path) filename = File.join(path, '.gitmodules') - result = parser.parse(File.readlines(filename)) + result = config_parser.parse(File.readlines(filename)) result.values end - def parser - @parser ||= ConfigParser.new + def config_parser + @config_parser ||= ConfigParser.new end end lib/brigit/commands/map_command.rb @@ -4,10 +4,8 @@ require 'find' module Brigit class UpdateCommand < Command - - self.help = "Update all submodules in the repo, recursively" - - def execute! + + def run super Brigit.at_dot_gitmodules do |path| system "git submodule init" lib/brigit/commands/update_command.rb f776ef88c1bfc2e8e9b77af174373b4ed3cbc56d Bruce Williams bruce@codefluency.com http://github.com/fiveruns/brigit/commit/82c86fd5ee6534ef8b8e04a720174e36fe59b4d7 82c86fd5ee6534ef8b8e04a720174e36fe59b4d7 2008-07-09T07:53:27-07:00 2008-07-09T07:53:27-07:00 Restucture command parsing to use Git-like format, at Adam's suggestion: brigit COMMAND [OPTIONS] For help: brigit COMMAND --help * Expand command documentation 4a7f2095c12b97ca1af4de51c1fac657fc38510e Bruce Williams bruce@codefluency.com