capita_git 0.0.2 → 0.1.0

data/.gitignore

@@ -2,4 +2,5 @@ pkg/*
 *.gem
 .bundle
 .idea
-lib/capita_git/man
+lib/capita_git/man
+tmp/*

data/Gemfile

@@ -2,4 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in capita_git.gemspec
 gemspec
-gem 'ronn'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capita_git (0.0.1)
+    capita_git (0.1.0)
       git (>= 1.2.5)
       thor (>= 0.14.6)
 
@@ -11,11 +11,13 @@ GEM
     git (1.2.5)
     hpricot (0.8.3)
     mustache (0.12.0)
+    open4 (1.0.1)
     rdiscount (1.6.5)
     ronn (0.7.3)
       hpricot (>= 0.8.2)
       mustache (>= 0.7.0)
       rdiscount (>= 1.5.8)
+    shoulda (2.11.3)
     thor (0.14.6)
 
 PLATFORMS
@@ -23,6 +25,6 @@ PLATFORMS
 
 DEPENDENCIES
   capita_git!
-  git (>= 1.2.5)
-  ronn
-  thor (>= 0.14.6)
+  open4
+  ronn (>= 0.7.3)
+  shoulda (>= 2.11.0)

data/README.rdoc

@@ -8,23 +8,23 @@
 
   $ gitc check
 
-  $ gitc create [name] [source_branch]
+  $ gitc create [name] ([source_branch])
 
-  $ gitc update [branch]
+  $ gitc update ([source_branch])
 
-  $ gitc close [branch]
+  $ gitc close ([source_branch])
 
 === DESCRIPTION 
 
-*gitc* is a git automation tool used by CAPITA Unternehmensberatung GmbH with comes
-along the gem *capita_git*.
+*gitc* is a git automation tool used by CAPITA Unternehmensberatung GmbH which comes
+packaged as the Rubygem *capita_git*.
 
-It's main purpose is to automate repetivite tasks as spawing new feature branches,
+It's main purpose is to automate repetivite tasks like spawing new feature branches,
 updating and rebasing from the source branch of a given feature branch, as well as
-closing/merging feature branchs back into their originating timeline.
+closing/merging feature branches back into their original tree.
 
-*gict* uses a strict naming convention for creating, idenfitying and maintaining
-local and remote branches and depends on the users's name being set in the git
+*gitc* uses a strict naming convention for creating, identifying and maintaining
+local and remote branches and depends on the user's name being set in the git
 configuration of your local cloned copy or in the global settings.
 
 Please make sure that both
@@ -33,7 +33,7 @@ and
   $ git config user.email
 return your correct name and email address.
 
-=== Installation
+=== INSTALLATION
 
   $ gem install capita_git
 
@@ -44,14 +44,23 @@ For detailed explanation of the various commands, please use *gitc help <command
 Available commands currently are:
 
   * <check>:
-    performs a basic check of your repository, as well as maintains fixbranches for
-    major release tags both locally and remotely
+    Performs a basic check of your repository, as well as maintains fixbranches for
+    major release tags both locally and remotely.
+    i.e., assuming your current release tag is 1.0, this will automatically create
+    the remote branch 1.0-fix that is based upon 1.0
 
-  * <create>:
-    creates a feature branch
+  * <create> branch_name:
+    Creates a feature branch based upon the current branch with the naming scheme
+    <USER_INITIALS>_sourcebranch_branch_name>.
+    Assuming you are 'CO' and on 1.0-fix, gitc create js_bugfix will create
+    the local branch co_1.0-fix_js_bugfix and check it out
 
   * <update>:
-    updates the feature branch's source branch and does a rebase
+    Updates the active feature branch's source branch and does a rebase, thus pulling
+    in the latest changes into your local tree
 
   * <close>:
-    closes a feature branch by updating and merging into the source branch
+    Closes a feature branch by updating the source branch, rebasing it onto your feature
+    branch and then merging into the source branch.
+    
+

data/Rakefile

@@ -2,6 +2,22 @@ $:.unshift File.expand_path("../lib", __FILE__)
 require 'bundler/gem_helper'
 Bundler::GemHelper.install_tasks
 
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
 task :install => ["man:clean", "man:build"]
 task :build => ["man:clean", "man:build"]
 task :release => ["man:clean", "man:build"]

data/capita_git.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |s|
   s.name = "capita_git"
   s.version = CapitaGit::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors = ["Sebastian Georgi"]
-  s.email = ["sgeorgi@capita.de"]
+  s.authors = ["Sebastian Georgi", "Christoph Olszowka"]
+  s.email = ["sgeorgi@capita.de", "colszowka at capita de"]
   s.homepage = "https://github.com/capita/capita_git"
-  s.summary = %q{Git-automation tool for managing features branches and more}
-  s.description = %q{see RDoc or command help for further information}
+  s.summary = %q{Git-automation tool for quick handling of common patterns for feature and fix branches}
+  s.description = %q{Git-automation tool for quick handling of common patterns for feature and fix branches}
 
   s.rubyforge_project = "capita_git"
 
@@ -21,4 +21,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_dependency('git', '>= 1.2.5')
   s.add_dependency('thor', '>= 0.14.6')
+  s.add_development_dependency('ronn', ">= 0.7.3")
+  s.add_development_dependency('shoulda', ">= 2.11.0")
+  s.add_development_dependency('open4')
 end

data/lib/capita_git/cli.rb

@@ -126,7 +126,6 @@ module CapitaGit
       raise "Source branch '#{name}' is not a feature branch, can't close!" unless repo.is_local_feature_branch?(name)
 
       CapitaGit.ui.confirm "--> Closing feature branch '#{name}' onto '#{repo.source_branch(name)}'"
-      repo.rebase_local_branch(name)
       repo.close_local_branch(name)
     end
 
@@ -142,4 +141,4 @@ module CapitaGit
       !(`which groff` rescue '').empty?
     end
   end
-end
+end

data/lib/capita_git/man/gitc

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GITC" "5" "January 2011" "GITC 0.0.2" "GITC Manual"
+.TH "GITC" "5" "January 2011" "GITC 0.1.0" "GITC Manual"
 .
 .SH "NAME"
 \fBgitc\fR \- git helper for CAPITA Unternehmensberatung GmbH

data/lib/capita_git/man/gitc-check

@@ -1,5 +1,5 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GITC\-CHECK" "" "January 2011" "GITC 0.0.2" "GITC Manual"
+.TH "GITC\-CHECK" "" "January 2011" "GITC 0.1.0" "GITC Manual"
 

data/lib/capita_git/man/gitc-check.txt

@@ -2,4 +2,4 @@ GITC-CHECK()			  GITC Manual			  GITC-CHECK()
 
 
 
-GITC 0.0.2			 January 2011			  GITC-CHECK()
+GITC 0.1.0			 January 2011			  GITC-CHECK()

data/lib/capita_git/man/gitc.txt

@@ -50,4 +50,4 @@ COMMANDS
 
 
 
-GITC 0.0.2			 January 2011			       GITC(5)
+GITC 0.1.0			 January 2011			       GITC(5)

data/lib/capita_git/version.rb

@@ -1,3 +1,3 @@
 module CapitaGit
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/cli_test.rb

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+class CliTest < Test::Unit::TestCase
+  with_a_repo_setup do
+    in_dir 'local_checkout_1' do
+      after('git pull') { should_have_tag '1.0' }
+
+      gitc 'check' do
+        should_have_branch '1.0-fix'
+
+        in_dir 'local_checkout_2' do
+          should_not_have_branch '1.0-fix'
+          
+          gitc 'check' do
+            should_have_branch '1.0-fix'
+            
+            context "after creating a fix" do
+              setup do
+                assert_command 'git checkout 1.0-fix'
+                assert_command 'echo "foo" > fixfile'
+                assert_command 'git add . && git commit -m "fixfile" && git push'
+              end
+              
+              should_not_have_file 'fixfile', :in => 'local_checkout_1'
+              
+              context "after pull and checkout of 1.0-fix in checkout 1" do
+                setup do
+                  in_dir 'local_checkout_1' do
+                    assert_command 'git checkout 1.0-fix'
+                    assert_command 'git pull'
+                  end
+                end
+                should_have_file 'fixfile', :in => 'local_checkout_1'
+              end
+            end
+            
+          end
+        end
+      end
+      
+      gitc 'create my_feature' do
+        should "be on branch USER_master_my_feature" do
+          user = CapitaGit::Repository.new('.').user_shortcut
+          assert_equal "#{user}_master_my_feature", repo.current_branch
+        end
+        
+        should_not_have_file 'awesome_feature', :in => 'local_checkout_1'
+        
+        # Propagating changes on source branch with gitc update
+        context "after checkout 2 pushes file master_2_update on master" do
+          setup do
+            in_dir 'local_checkout_2' do
+              assert_command 'echo "foo" > master_2_update'
+              assert_command 'git add . && git commit -m "master 2 update" && git push'
+            end
+          end
+          
+          after 'git pull origin master' do
+            should_not_have_file 'awesome_feature', :in => 'local_checkout_1'
+          end
+          
+          context "after invoking 'gitc update'" do
+            setup { assert_command("#{ShouldaMacros::BIN_PATH} update") }
+            should_have_file 'master_2_update', :in => 'local_checkout_1'
+          end
+        end
+        
+        # Committing a fix and closing branch
+        context "after committing a file and gitc close" do
+          setup do
+            assert_command 'echo "foo" > awesome_feature'
+            assert_command 'git add . && git commit -m "my feature"'
+            assert_command("#{ShouldaMacros::BIN_PATH} close")
+            assert_command 'git push'
+          end
+          
+          should "be on branch master" do
+            assert_equal 'master', repo.current_branch
+          end
+          
+          should "have removed the feature branch" do
+            assert !repo.branches.map(&:name).any? {|n| n =~ /feature/}
+          end
+          
+          should_have_file 'awesome_feature', :in => 'local_checkout_1'
+          
+          context "after git pull on local_checkout_2" do
+            setup do
+              in_dir 'local_checkout_2' do
+                assert_command 'git pull'
+              end
+            end
+            
+            should_have_file 'awesome_feature', :in => 'local_checkout_2'
+          end
+        end
+        
+      end
+    end
+  end
+end

data/test/shoulda_macros.rb

@@ -0,0 +1,160 @@
+module ShouldaMacros
+  TEMP_DIR = File.expand_path('/tmp/capita_git_tmp')
+  BIN_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..', 'bin/gitc'))
+  
+  # Test method level helpers
+  module InstanceMethods
+    # Returns the path to the temporary directory, with the optional subdirectory
+    # Creates the directory if it's missing
+    def temp_dir(subdirectory = nil)
+      path = ShouldaMacros::TEMP_DIR
+      path = File.join(path, subdirectory) if subdirectory
+      FileUtils.mkdir_p(path)
+      path
+    end
+
+    # Switches current working directory to the temp_dir subdirectory of given
+    # name for the given block, switching back after execution    
+    def in_dir(name)
+      Dir.chdir(temp_dir(name)) do
+        yield
+      end
+    end
+    
+    # Runs the specified command and asserts it's exit status should be 0
+    def assert_command(cmd)
+      Open4.popen4(cmd) { |pid, stdin, stdout, stderr|  }
+      #puts `#{cmd}`
+      assert_equal 0, $?.exitstatus, "Expected exit status of 0 for command '#{cmd}'"
+    end
+    
+    # Opens a Git ruby lib instance for current working dir and returns it
+    def repo
+      Git.open(Dir.getwd)
+    end
+  end
+
+  # Context and should block helpers  
+  module ClassMethods
+    
+    #
+    # Creates a repository with a remote in temp_dir
+    #
+    def with_a_repo_setup
+      context "With a basic repo setup" do
+        setup do
+          ENV["GIT_WORK_TREE"] = nil
+          ENV['GIT_DIR'] = nil
+          ENV['GIT_INDEX_FILE'] = nil
+          
+          in_dir 'origin' do
+            assert_command 'git init --bare'
+          end
+          
+          in_dir "initial_commit" do
+            assert_command 'git init'
+            assert_command "echo 'foo bar commit' > README"
+            assert_command "git add . && git commit -m 'Initial commit'"
+            assert_command "git remote add origin #{temp_dir('origin')}"
+            assert_command 'git push origin master'
+          end
+          
+          in_dir "local_checkout_1" do
+            assert_command "git clone #{temp_dir('origin')} ."
+            assert_command 'git push origin master'
+            assert_command 'git pull origin master'
+          end
+          
+          in_dir "local_checkout_2" do
+            assert_command "git clone #{temp_dir('origin')} ."
+            assert_command 'git tag -a 1.0 -m "First release"'
+            assert_command 'git push --tags origin master'
+            assert_command 'git pull origin master'
+          end
+        end
+        
+        yield
+        
+        # Make sure the temporary directory is purged after every run
+        teardown do
+          FileUtils.rm_rf(temp_dir)
+        end
+      end
+    end
+    
+    def in_dir(name)
+      context "in dir '#{name}'" do
+        setup do
+          @original_wd ||= {}
+          @original_wd[name] = Dir.getwd
+          Dir.chdir(temp_dir(name))
+        end
+        
+        yield
+        
+        teardown do
+          Dir.chdir(@original_wd[name]) if @original_wd
+        end
+      end
+    end
+    
+    # Invokes the gitc binary with given arguments and yields after the setup
+    def gitc(args)
+      context "after invoking 'gitc #{args}'" do
+        setup { assert_command("#{BIN_PATH} #{args}") }
+        yield
+      end
+    end
+    
+    def after(command)
+      context "after '#{command}'" do
+        setup do
+          assert_command command
+        end
+        yield
+      end
+    end
+    
+    def should_have_branch(name)
+      should "have branch '#{name}'" do
+        assert repo.branches.map(&:name).include?(name), "Found in #{Dir.getwd}: " + repo.branches.map(&:name).inspect
+      end
+    end
+    
+    def should_not_have_branch(name)
+      should "NOT have branch '#{name}'" do
+        assert !repo.branches.map(&:name).include?(name), "Found in #{Dir.getwd}: " + repo.branches.map(&:name).inspect
+      end
+    end
+    
+    def should_have_tag(name)
+      should "have tag '#{name}'" do
+        assert repo.tags.map(&:name).include?(name), repo.tags.map(&:name).inspect
+      end
+    end
+    
+    def should_not_have_tag(name)
+      should "NOT have tag '#{name}'" do
+        assert !repo.tags.map(&:name).include?(name), repo.tags.map(&:name).inspect
+      end
+    end
+    
+    def should_have_file(name, options)
+      raise "Usage: should_have_file 'filename', :in => 'tempdirname' (or %w(dir1 dir2))" unless options[:in]
+      [options[:in]].flatten.each do |dir|
+        should "have file '#{name}' in #{dir}" do
+          assert_equal 1, Dir[File.join(temp_dir(dir), name)].length
+        end
+      end
+    end
+    
+    def should_not_have_file(name, options)
+      raise "Usage: should_not_have_file 'filename', :in => 'tempdirname' (or %w(dir1 dir2))" unless options[:in]
+      [options[:in]].flatten.each do |dir|
+        should "not have file '#{name}' in #{dir}" do
+          assert_equal 0, Dir[File.join(temp_dir(dir), name)].length
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'capita_git'
+require 'git'
+
+require 'test/unit'
+require 'shoulda'
+
+require 'fileutils'
+require "open4" # See http://tech.natemurray.com/2007/03/ruby-shell-commands.html
+require 'shoulda_macros'
+
+class Test::Unit::TestCase
+  include ShouldaMacros::InstanceMethods
+  extend  ShouldaMacros::ClassMethods
+end

metadata

@@ -2,20 +2,21 @@
 name: capita_git
 version: !ruby/object:Gem::Version 
   hash: 27
-  prerelease: false
+  prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Sebastian Georgi
+- Christoph Olszowka
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 +01:00
+date: 2011-01-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,9 +51,56 @@ dependencies:
         version: 0.14.6
   type: :runtime
   version_requirements: *id002
-description: see RDoc or command help for further information
+- !ruby/object:Gem::Dependency 
+  name: ronn
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        - 3
+        version: 0.7.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 11
+        - 0
+        version: 2.11.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Git-automation tool for quick handling of common patterns for feature and fix branches
 email: 
 - sgeorgi@capita.de
+- colszowka at capita de
 executables: 
 - gitc
 extensions: []
@@ -74,10 +122,13 @@ files:
 - lib/capita_git/version.rb
 - man/gitc-check.ronn
 - man/gitc.ronn
+- test/cli_test.rb
+- test/shoulda_macros.rb
+- test/test_helper.rb
 - lib/capita_git/man/gitc
+- lib/capita_git/man/gitc.txt
 - lib/capita_git/man/gitc-check.txt
 - lib/capita_git/man/gitc-check
-- lib/capita_git/man/gitc.txt
 has_rdoc: true
 homepage: https://github.com/capita/capita_git
 licenses: []
@@ -108,9 +159,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: capita_git
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
-summary: Git-automation tool for managing features branches and more
+summary: Git-automation tool for quick handling of common patterns for feature and fix branches
 test_files: []