guitr 0.0.5 → 0.0.6

data/History.txt

@@ -26,4 +26,13 @@
 === 0.0.5 2010-06-24
 
 * 1 major enhancements:
-  * --unpushed operation was enhanced to be informative   
+  * --unpushed operation was enhanced to be informative   
+  
+=== 0.0.6 2010-08-11
+
+* 3 major enhancements:
+  * --status, --pull and --unpushed operations were made more silent
+  * OptionParser was integrated to handle arguments
+  * --exec operation to run given command against repository directory was added
+     
+  

data/README.rdoc

@@ -18,11 +18,14 @@ Lets ensure that everything is under git control that should be.
   guitr [options] [path_to_repo if not specified current directory will be used]
   
   Options:
-  --status		# default command to invoke, echos result of the 'git status'
-  --pull		# performs 'git pull' against all found repositories
-  --unpushed    # checks whether there are commits need to be pushed
-  --verbose		# echos INFO level logs
-  --trace		# echos DEBUG level logs
+  -s --status		# default command to invoke, echos result of the 'git status'
+  -p --pull			# performs 'git pull' against all found repositories
+  -u --unpushed    	# checks whether there are commits need to be pushed
+  -e --exec CMD		# operation to run given command (CMD) against repository directory was added  
+  -v --verbose		# echos INFO level logs
+  -t --trace		# echos DEBUG level logs
+  -V --version		# print guitr version  
+  -h --help			# print this help message
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -19,11 +19,14 @@ $hoe = Hoe.spec 'guitr' do
   guitr [options] [path_to_repo if not specified current directory will be used]
   
   Options:
-  --status    # default command to invoke, echos result of the 'git status'
-  --pull      # performs 'git pull' against all found repositories
-  --unpushed  # checks whether there are commits need to be pushed
-  --verbose   # echos INFO level logs
-  --trace     # echos DEBUG level logs
+  -s --status     # default command to invoke, echos result of the 'git status'
+  -p --pull       # performs 'git pull' against all found repositories
+  -u --unpushed   # checks whether there are commits need to be pushed
+  -e --exec CMD   # operation to run given command (CMD) against repository directory was added  
+  -v --verbose    # echos INFO level logs
+  -t --trace      # echos DEBUG level logs
+  -V --version    # print guitr version
+  -h --help       # print this help message  
     
   For details go to http://webdizz.name/posts/guitr
   "

data/bin/guitr

@@ -3,15 +3,8 @@
 require 'rubygems' unless ENV['NO_RUBYGEMS']
 require 'guitr'
 
-if %w(-v --version).include? ARGV.first
-  puts "#{File.basename($0)} #{Guitr::VERSION}"
-  exit(0)
-end
-
-args = ARGV.clone
-
 begin
-  Guitr::GuitrRunner.new.run args
+  Guitr::GuitrRunner.new.run 
 rescue Guitr::SystemExitException => e
   exit e.exit_code
 end

data/lib/guitr.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module Guitr
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end
 
 require 'guitr/guitr'

data/lib/guitr/git.rb

@@ -11,10 +11,13 @@ module Guitr
       def run(repo, options = {})
         @git = Git.open(repo, options)
         res = @git.lib.status
-        puts 
-        puts "Status for #{repo}"
-        puts res = res.gsub('??', ' U')
-        puts
+        if !res.empty?
+          puts 
+          res = "Status for #{repo}\n"+res
+          res = res.gsub('??', ' U')
+          puts res
+          puts
+        end
         
         res
       end
@@ -43,7 +46,6 @@ module Guitr
             puts res
             puts 
           end
-          puts "There is no unpushed commits for #{repo}." if res.empty?
         rescue Git::GitExecuteError => e
           puts "Unable to check unpushed commits '#{repo}' #{e.message}"
         end
@@ -61,8 +63,9 @@ module Guitr
         @git = Git.open(repo, options)
         begin
           puts
-          puts "Going to pull #{repo}"
           res = @git.lib.pull
+          res = "Going to pull #{repo}\n"+res if !res.empty?
+          res = '' if res.include?("up-to-date")
           puts res
           res
         rescue Git::GitExecuteError => e

data/lib/guitr/guitr.rb

@@ -3,6 +3,8 @@ require 'git'
 require 'find'
 require 'logger'
 require 'guitr/git'
+require 'optparse'
+require 'ostruct'
 
 module Guitr
   
@@ -12,81 +14,139 @@ module Guitr
     
     attr_reader :repo_paths, :operation, :log
     
-    def initialize 
-      @operational_args = ['--status', '--pull', '--unpushed']
-      @acceptable_args = [:verbose, :trace] << @operational_args
-      @acceptable_args = @acceptable_args.flatten
+    def initialize
       @repo_paths = []
       @git_dir = '.git'
-      @usage = '$ guitr --status|--pull path_to_git_repo(s) '
-      @options = {}
     end
     
-    def run(args)
-      validate args
-      res = ''
-      @repo_paths.flatten.uniq.each do |repo|
-        case @operation.to_sym
-          when :pull
-          res = GitPull.new.run(repo, @options)
-          when :status
-          res = GitStatus.new.run(repo, @options)
-          when :unpushed          
-          res = GitUnpushed.new.run(repo, @options)
+    def run
+      @options = OpenStruct.new
+      @options.verbose = false
+      @options.trace = false
+      @options.operation = :status
+      @options.isOperationSet = false;
+      @options.log = nil
+      @options.command = nil
+      
+      OptionParser.new do |opts|
+        opts.banner = "Usage: guitr [options] [repository]"
+        opts.separator ""
+        
+        opts.on("-v", "--verbose", "Run verbosely") do |v|
+          @options.verbose = v
+        end
+        
+        opts.on("-t", "--trace", "Run in trace mode") do |t|
+          @options.trace = t
+        end
+        
+        # Run pull
+        opts.on("-p", "--pull", "Run --pull command to update all repositories") do |s|
+          setOperation :pull
+        end
+        
+        # Run unpushed
+        opts.on("-u", "--unpushed", "Run --unpushed command to check commited but not pushed yet changes in repositories") do |s|
+          setOperation :unpushed
+        end
+        
+        # Run status command
+        opts.on("-s", "--status", "Run --status command") do |s|
+          setOperation :status
+        end
+        
+        # Run exec command
+        opts.on("-e", "--exec COMMAND", "Run COMMAND, for example guitr --exec date will output current date") do |c|
+          setOperation :exec
+          @options.command = c 
         end
+        
+        # Print an options summary.
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+        
+        # Print the version.
+        opts.on_tail("-V", "--version", "Show version") do
+          puts Guitr::VERSION
+          exit
+        end
+        
+        end.parse!
+        
+        @operation = @options.operation
+        init_logger
+        validate ARGV
+        do_run
       end
-      res
-    end
-    
-    def validate(args)
-      init_logger(args)
       
-      args.each do |arg|
-        @operation = arg.gsub('--', '') if @operational_args.include?(arg) && @operation.nil?
-      end
-      @operation = :status if @operation.nil?
+      private
       
-      start_directory = './'
-      last = args.last
-      if last.nil? || last.include?('--')
-        @log.info 'Current directory will be used to start looking for git working copies.' if @log
-      else
-        start_directory = args.last	
+      def do_run
+        res = ''
+        @repo_paths.flatten.uniq.each do |repo|
+          case @operation
+            when :pull
+            res = GitPull.new.run(repo)
+            when :status
+            res = GitStatus.new.run(repo)
+            when :unpushed          
+            res = GitUnpushed.new.run(repo)
+            when :exec
+              current_dir = Dir.pwd
+              Dir.chdir repo
+              res = system @options.command
+              Dir.chdir current_dir
+          end
+        end
+        res
       end
       
-      if !File.exist? start_directory
-        puts "Directory '#{start_directory}' does not exist."
-        exit()
+      def setOperation operation
+        if !@options.isOperationSet
+          @options.operation = operation
+          @options.isOperationSet = true
+        end
       end
       
-      Find.find(start_directory) do |path|
-        if path.include?(@git_dir) && !path.include?("#{@git_dir}/") && File.exist?(path) && File.directory?(path)
-          @repo_paths << File.expand_path(path.gsub(@git_dir, ''))
+      def validate(args)
+        start_directory = './'
+        last = @operation==:exec ? args[-2] : args.last
+        if last.nil? || last.include?('--')
+          @log.info 'Current directory will be used to start looking for git working copies.' if @log
+        else
+          start_directory = args.last	
+        end
+        
+        if !File.exist? start_directory
+          puts "Directory '#{start_directory}' does not exist."
+          exit()
         end
+        
+        Find.find(start_directory) do |path|
+          if path.include?(@git_dir) && !path.include?("#{@git_dir}/") && File.exist?(path) && File.directory?(path)
+            @repo_paths << File.expand_path(path.gsub(@git_dir, ''))
+          end
+        end
+        
+        if @repo_paths.empty?
+          puts "There are no repositories within '#{start_directory}' directory."
+          exit()
+        end
+        
       end
       
-      if @repo_paths.empty?
-        puts "There are no repositories within '#{start_directory}' directory."
-        exit()
+      def init_logger
+        create_logger(Logger::INFO) if @options.verbose
+        create_logger(Logger::DEBUG) if @options.trace
       end
       
-    end
-    
-    def init_logger args
-      args.each do |arg|
-        arg = arg.gsub('--', '')
-        create_logger(Logger::INFO) if arg.to_sym == :verbose
-        create_logger(Logger::DEBUG) if arg.to_sym == :trace
+      def create_logger level
+        @log = Logger.new STDOUT
+        @log.level = level
+        @options.log = @log
       end
+      
     end
-    private :init_logger
-    
-    def create_logger level
-      @log = Logger.new STDOUT
-      @log.level = level
-      @options[:log] = @log
-    end
-    private :create_logger
-    
   end
-end

data/spec/git_spec.rb

@@ -5,12 +5,22 @@ include Guitr::GuitrGit
 
 describe Guitr::GuitrGit do
   
-  $RIGHT_REPO = File.expand_path(File.dirname(__FILE__)+'/../')
+  $RIGHT_REPO = File.expand_path(File.dirname(__FILE__)+'/../tmp')
+  
+  before(:all) do
+    FileUtils.rm_rf $RIGHT_REPO
+    Dir.mkdir $RIGHT_REPO
+    Git::init($RIGHT_REPO)
+  end
+  
+  after(:all) do
+    FileUtils.rm_rf $RIGHT_REPO
+  end
   
   describe GitStatus do
     
     before do
-      @test_file_name = 'some_file'
+      @test_file_name = $RIGHT_REPO+'/some_file'
       @action = GitStatus.new
     end
     
@@ -23,7 +33,7 @@ describe Guitr::GuitrGit do
       begin
         file = open(@test_file_name, "w")
         res = @action.run $RIGHT_REPO, {}
-        res.should include @test_file_name
+        res.should include File.basename @test_file_name
       ensure
         clean_test_file(file)
       end
@@ -40,11 +50,10 @@ describe Guitr::GuitrGit do
       end
     end
     
-    def clean_test_file file
-      file.close
-      File.delete @test_file_name
+    it 'should silent for empty status' do
+      res = @action.run $RIGHT_REPO, {}
+      res.should be_empty
     end
-    private :clean_test_file
     
   end
   
@@ -52,7 +61,7 @@ describe Guitr::GuitrGit do
     
     before do
       @action = GitUnpushed.new
-      @test_file_name = 'some_file_2'
+      @test_file_name = $RIGHT_REPO+'/some_file_2'
     end
     
     it "should have a git instance if repo path is correct" do
@@ -63,11 +72,18 @@ describe Guitr::GuitrGit do
     it "should display unpushed items" do
       module Git
         class Lib
-          def unpushed branch, remote_branch
-            'insertions'
+          def branch_current
+            'master'
+          end
+          def remotes
+            'master'
+          end
+          def unpushed current_branch, remote_branch
+            'insertions some additional statistics'
           end
         end
       end
+      
       res = @action.run $RIGHT_REPO, {}
       res.should include('insertions')
     end
@@ -91,7 +107,7 @@ describe Guitr::GuitrGit do
     
     before do
       @action = GitPull.new
-      @test_file_name = 'some_file_2'
+      @test_file_name = $RIGHT_REPO+'/some_file_2'
     end
     
     it "should have a git instance if repo path is correct" do
@@ -99,11 +115,30 @@ describe Guitr::GuitrGit do
       @action.git.should_not be_nil
     end
     
-    it "should display unpushed items or display nothing" do
+    it "should display pulling result" do
+      module Git
+        class Lib
+          def pull
+            'Updating'
+          end
+        end
+      end
       res = @action.run $RIGHT_REPO, {}
       res.should include('Updating')
     end
     
+    it "should be silent if code base is up-to-date" do
+      module Git
+        class Lib
+          def pull
+            'up-to-date'
+          end
+        end
+      end
+      res = @action.run $RIGHT_REPO, {}
+      res.should be_empty
+    end
+    
     it "should report an error without interruption if error was occured on pull action" do
       lambda{
         module Git
@@ -119,15 +154,11 @@ describe Guitr::GuitrGit do
     
   end
   
+  def clean_test_file file
+    file.close
+    File.delete @test_file_name
+  end
+  private :clean_test_file
+  
 end
 
-module Git
-  
-  class Lib
-    
-    def pull
-      'Updating'
-    end
-    
-  end
-end

data/spec/guitr_spec.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'logger'
+require 'optparse'
 
 describe Guitr::GuitrRunner do
   
@@ -7,72 +8,83 @@ describe Guitr::GuitrRunner do
   $RIGHT_REPO_PATH = File.expand_path(File.dirname(__FILE__)+'/../')
   
   before(:each) do
+    ARGV.clear
     @guitr_runner = Guitr::GuitrRunner.new
   end
   
   it "should continue if no args were specified" do
-    args = [];
-    @guitr_runner.validate args
+    @guitr_runner.run
     @guitr_runner.operation.should  eql(:status)
   end
   
   it "should use current directory if no path specified" do
-    args = [];
-    @guitr_runner.validate args
+    @guitr_runner.run
     @guitr_runner.repo_paths.size.should eql(1)
   end
   
   it "should fail if specified directory does not exist" do
-    args = ['some_path'];
-    lambda { @guitr_runner.validate(args)}.should raise_exception SystemExit
+    ARGV << 'some_path'
+    lambda { @guitr_runner.run}.should raise_exception SystemExit
   end
   
   it "should use specified directory if exist" do
-    args = [$RIGHT_REPO_PATH];
-    lambda { @guitr_runner.validate(args)}.should_not raise_exception SystemExit
+    ARGV << $RIGHT_REPO_PATH
+    lambda { @guitr_runner.run}.should_not raise_exception SystemExit
   end
   
   it "should fail if there is are no repositories within specified directory" do
-    args = [$CURRENT_DIR_PATH];
-    lambda { @guitr_runner.validate(args)}.should raise_exception SystemExit
+    ARGV << $CURRENT_DIR_PATH
+    lambda { @guitr_runner.run}.should raise_exception SystemExit
   end
   
   it "should operate verbosely if --verbose was specified" do
-    args = ['--verbose', $RIGHT_REPO_PATH]
-    @guitr_runner.validate args
+    ARGV << '--verbose'
+    ARGV << $RIGHT_REPO_PATH
+    @guitr_runner.run
     @guitr_runner.log.should_not be_nil
   end
   
   it "should use INFO logger if --verbose was specified" do
-    args = ['--verbose', $RIGHT_REPO_PATH]
-    @guitr_runner.validate args
+    ARGV << '--verbose'
+    ARGV << $RIGHT_REPO_PATH
+    @guitr_runner.run
     @guitr_runner.log.level.should eql(Logger::INFO)
   end
   
   it "should operate in debug mode if --trace was specified" do
-    args = ['--trace', $RIGHT_REPO_PATH]
-    @guitr_runner.validate args
+    ARGV << '--trace'
+    ARGV << $RIGHT_REPO_PATH
+    @guitr_runner.run
     @guitr_runner.log.level.should eql(Logger::DEBUG)
   end
   
   it "should use first operation argument to operate with" do
-    args = ['--trace', '--status', '--pull', $RIGHT_REPO_PATH]
-    @guitr_runner.validate args
-    @guitr_runner.operation.should eql(:status.to_s)
+    ARGV << '--trace'
+    ARGV << '--status'
+    ARGV << '--pull'
+    ARGV << $RIGHT_REPO_PATH
+    @guitr_runner.run
+    @guitr_runner.operation.should eql(:status)
   end
   
   it "should have unpushed operation" do
-    args = ['--unpushed'];
-    @guitr_runner.validate args
-    @guitr_runner.operation.should  eql(:unpushed.to_s)
+    ARGV << '--unpushed'
+    @guitr_runner.run
+    @guitr_runner.operation.should  eql(:unpushed)
   end
   
-  it "should have empty or some satistic of unpushed changes" do
-    args = ['--unpushed', $RIGHT_REPO_PATH];
-    res = @guitr_runner.run args
-    res.should be_empty if res.empty?
-    res.should include('insertions') if !res.empty?
-    res.should_not include('nothing to do')
+  it 'should run specified command' do
+    ARGV << '--exec'
+    ARGV << 'date'
+    @guitr_runner.run
+    @guitr_runner.operation.should  eql(:exec)
   end
   
+  it 'should fail to run specified command' do
+    lambda { 
+      ARGV << '--exec'
+      @guitr_runner.run
+    }.should raise_exception OptionParser::ParseError
+  end
+    
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guitr
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - webdizz
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-24 00:00:00 +03:00
+date: 2010-08-11 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,12 +42,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 21
         segments: 
         - 2
         - 6
-        - 0
-        version: 2.6.0
+        - 1
+        version: 2.6.1
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -74,12 +74,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 21
         segments: 
         - 2
         - 6
-        - 0
-        version: 2.6.0
+        - 1
+        version: 2.6.1
   type: :development
   version_requirements: *id004
 description: |-
@@ -117,7 +117,7 @@ has_rdoc: true
 homepage: http://webdizz.name/posts/guitr
 licenses: []
 
-post_install_message: "\n  Usage:  \n  guitr [options] [path_to_repo if not specified current directory will be used]\n  \n  Options:\n  --status    # default command to invoke, echos result of the 'git status'\n  --pull      # performs 'git pull' against all found repositories\n  --unpushed  # checks whether there are commits need to be pushed\n  --verbose   # echos INFO level logs\n  --trace     # echos DEBUG level logs\n    \n  For details go to http://webdizz.name/posts/guitr\n  "
+post_install_message: "\n  Usage:  \n  guitr [options] [path_to_repo if not specified current directory will be used]\n  \n  Options:\n  -s --status     # default command to invoke, echos result of the 'git status'\n  -p --pull       # performs 'git pull' against all found repositories\n  -u --unpushed   # checks whether there are commits need to be pushed\n  -e --exec CMD   # operation to run given command (CMD) against repository directory was added  \n  -v --verbose    # echos INFO level logs\n  -t --trace      # echos DEBUG level logs\n  -V --version    # print guitr version\n  -h --help       # print this help message  \n    \n  For details go to http://webdizz.name/posts/guitr\n  "
 rdoc_options: 
 - --main
 - README.rdoc