gitcycle 0.2.7 → 0.2.8

data/README.md

@@ -3,73 +3,98 @@ Gitcycle
 
 Tame your development cycle.
 
-Gitcycle is a drop-in replacement for git that makes pull request dev cycles super easy.
+About
+-----
+
+Gitcycle is a `git` wrapper that makes working on a team easy.
+
+It assumes you are using pull requests along side [GitHub Issues](https://github.com/features/projects/issues).
+
+It connects to email, Lighthouse, and Campfire if you want it to.
 
 Get Started
 -----------
 
-Visit [gitcycle.com](http://gitcycle.com) to set up your environment.
+Visit [gitcycle.com](http://gitcycle.com) to set up your repository.
+
+gitc
+----
+
+The `gitc` command does everything `git` does, but with some extra features.
+
+Try using `gitc` for everything. It should just work.
 
-Create Branch
--------------
+Branch From Ticket
+------------------
 
-Checkout the branch that you will eventually merge your feature into:
+First, checkout the branch that you will eventually merge your code into:
 
-	gitc checkout master
+	gitc checkout <branch>
 
-Type `gitc` + your ticket URL to create a new branch:
+Type `gitc branch` + your ticket URL to create a new branch:
 
-	gitc https://xxx.lighthouseapp.com/projects/0000/tickets/0000-my-ticket
+	gitc branch https://xxx.lighthouseapp.com/projects/0000/tickets/0000-my-ticket
 
-Pull Changes from Upstream
---------------------------
+Pull
+----
 
-When you're developing, you may need to pull new changes from an upstream branch:
+Use `gitc pull` without parameters. It knows what you're trying to do.
 
 	gitc pull
 
-Push Changes
-------------
+If you're working on a ticket branch, it will automatically pull the latest code from upstream.
+
+Commit
+------
+
+Commit all changes and open commit message in EDITOR:
+
+	gitc commit
+
+Ticket number and name are prefilled if present.
+
+Push
+----
+
+Use `gitc push` without parameters. It knows what you're trying to do.
 
 	gitc push
 
-Discuss Code
-------------
+Discuss
+-------
 
-After pushing one or two commits, put the code up for discussion:
+After pushing some commits, put the code up for discussion:
 
 	gitc discuss
 
-Mark as Ready
--------------
+Ready
+-----
 
-When the branch is ready for merging, mark it as ready:
+When the branch is ready for code review:
 
 	gitc ready
 
-This will mark the pull request as "Pending Review".
+This will label the pull request as "Pending Review".
 
 Code Review
 -----------
 
-Managers will periodically check for "Pending Review" issues on GitHub.
+Periodically check for "Pending Review" issues on GitHub.
 
-Once reviewed, they will mark the issue as reviewed:
+Once reviewed, label the issue as reviewed:
 
 	gitc reviewed [GITHUB ISSUE #] [...]
 
 Quality Assurance
 -----------------
 
-QA engineers will periodically check for "Pending QA" issues on Github.
+Periodically check for "Pending QA" issues on Github.
 
 To create a new QA branch:
 
 	gitc qa [GITHUB ISSUE #] [...]
 
-This will create a new QA branch containing the commits from the related Github issue numbers.
-
-This branch can be deployed to a staging environment for QA.
+Now you have a QA branch containing all commits from the specified Github issue numbers.
 
 QA Fail
 -------
@@ -82,7 +107,7 @@ To fail all issues:
 
 	gitc qa fail
 
-This will add a "fail" label to the issue.
+This adds a "fail" label to the issue.
 
 QA Pass
 ------- 
@@ -95,7 +120,7 @@ To pass all issues:
 
 	gitc qa pass
 
-This will add a "pass" label to the issue and will complete the pull request by merging the feature branch into the target branch.
+This adds a "pass" label to the issue and completes the pull request by merging the feature branch into the target branch.
 
 More
 ----
@@ -108,7 +133,7 @@ If you are working in a fork, it is easy to checkout upstream branches:
 
 ### Collaborate
 
-Its easy to checkout branches from other forks:
+Checkout branches from other forks:
 
 	gitc checkout [USER] [BRANCH]
 
@@ -122,12 +147,6 @@ See who is QA'ing what:
 
 If you associate the wrong branch with a ticket, use `gitc redo` to fix it.
 
-Checkout the branch that you will eventually merge your feature into:
-
-	gitc checkout master
-
-Type `gitc redo` + your ticket URL to reset the branch:
-
 	gitc redo https://xxx.lighthouseapp.com/projects/0000/tickets/0000-my-ticket
 
 Todo

data/features/gitcycle.feature

@@ -20,7 +20,7 @@ Scenario: Feature branch w/ custom branch name
   Given a fresh set of repositories
     And a new Lighthouse ticket
   When I cd to the user repo
-    And I execute gitcycle with the Lighthouse ticket URL
+    And I execute gitcycle branch with the Lighthouse ticket URL
     And I enter "y"
     And I enter "n"
     And I enter "ticket.id-rename"
@@ -44,7 +44,7 @@ Scenario: Feature branch
   Given a fresh set of repositories
     And a new Lighthouse ticket
   When I cd to the user repo
-    And I execute gitcycle with the Lighthouse ticket URL
+    And I execute gitcycle branch with the Lighthouse ticket URL
     And I enter "y"
     And I enter "y"
   Then gitcycle runs
@@ -86,7 +86,7 @@ Scenario: Redo feature branch
 
 Scenario: Checkout via ticket w/ existing branch
   When I cd to the user repo
-    And I execute gitcycle with the Lighthouse ticket URL
+    And I execute gitcycle branch with the Lighthouse ticket URL
   Then gitcycle runs
     And output includes
       """
@@ -98,7 +98,7 @@ Scenario: Checkout via ticket w/ existing branch
 Scenario: Checkout via ticket w/ fresh repo
   Given a fresh set of repositories
   When I cd to the user repo
-    And I execute gitcycle with the Lighthouse ticket URL
+    And I execute gitcycle branch with the Lighthouse ticket URL
   Then gitcycle runs
     And output includes
       """
@@ -175,7 +175,9 @@ Scenario: Ready issue w/ no parameters
       Adding remote repo 'config.owner/config.repo'.
       Fetching remote 'config.owner'.
       Merging remote branch 'master' from 'config.owner/config.repo'.
-      Retrieving branch information from gitcycle.
+      Adding remote repo 'config.user/config.repo'.
+      Fetching remote 'config.user'.
+      Merging remote branch 'ticket.id' from 'config.user/config.repo'.
       Labeling issue as 'Pending Review'.
       """
 

data/features/steps/gitcycle_steps.rb

@@ -113,6 +113,7 @@ Given /^a new Lighthouse ticket$/ do
     :title => "Test ticket"
   )
   $ticket.save
+  $ticket.attributes['id'] = "master-#{$ticket.attributes['id']}"
 end
 
 When /^I execute gitcycle with nothing$/ do
@@ -139,8 +140,8 @@ When /^I execute gitcycle setup$/ do
   ].join(' ')
 end
 
-When /^I execute gitcycle with the Lighthouse ticket URL$/ do
-  $execute << $ticket.url
+When /^I execute gitcycle branch with the Lighthouse ticket URL$/ do
+  $execute << "branch #{$ticket.url}"
 end
 
 When /^I execute gitcycle redo with the Lighthouse ticket URL$/ do

data/gitcycle.gemspec

@@ -6,7 +6,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "gitcycle"
-  s.version     = '0.2.7'
+  s.version     = '0.2.8'
   s.platform    = Gem::Platform::RUBY
   s.authors     = [ 'Winton Welsh' ]
   s.email       = [ 'mail@wintoni.us' ]

data/lib/gitcycle.rb

@@ -37,10 +37,95 @@ class Gitcycle
     start(args) if args
   end
 
-  def checkout(remote, branch=nil)
+  def branch(*args)
+    url = args.detect { |arg| arg =~ /^https?:\/\// }
+    title = args.detect { |arg| arg =~ /\s/ }
+
+    exec_git(:branch, args) unless url || title
+
+    require_git && require_configs
+
+    params = {
+      'branch[source]' => branches(:current => true)
+    }
+
+    if url && url.include?('lighthouseapp.com/')
+      params.merge!('branch[lighthouse_url]' => url)
+    elsif url && url.include?('github.com/')
+      params.merge!('branch[issue_url]' => url)
+    elsif url
+      puts "Gitcycle only supports Lighthouse or Github Issue URLs.".red
+      exit
+    elsif title
+      params.merge!(
+        'branch[name]' => title,
+        'branch[title]' => title
+      )
+    else
+      exec_git(:branch, args)
+    end
+
+    params['reset'] = '1' if args.include?('--redo')
+
+    puts "\nRetrieving branch information from gitcycle.\n".green
+    branch = get('branch', params)
+    name = branch['name']
+
+    begin
+      owner, repo = branch['repo'].split(':')
+
+      unless branch['exists']
+        branch['home'] = @git_login
+
+        unless yes?("\nYour work will eventually merge into '#{branch['source']}'. Is this correct?")
+          branch['source'] = q("What branch would you like to eventually merge into?")
+        end
+
+        unless yes?("Would you like to name your branch '#{name}'?")
+          name = q("\nWhat would you like to name your branch?")
+          name = name.gsub(/[\s\W]/, '-')
+        end
+
+        checkout_remote_branch(
+          :owner => owner,
+          :repo => repo,
+          :branch => branch['source'],
+          :target => name
+        )
+      end
+    rescue SystemExit, Interrupt
+      puts "\nDeleting branch from gitcycle.\n".green
+      branch = get('branch',
+        'branch[name]' => branch['name'],
+        'create' => 0,
+        'reset' => 1
+      )
+    end
+
+    if branch['exists']
+      checkout_or_track(:name => name, :remote => 'origin')
+    else
+      puts "Sending branch information to gitcycle.".green
+      get('branch',
+        'branch[home]' => branch['home'],
+        'branch[name]' => branch['name'],
+        'branch[rename]' => name != branch['name'] ? name : nil,
+        'branch[source]' => branch['source']
+      )
+    end
+
+    puts "\n"
+  end
+
+  def checkout(*args)
+    if args.length > 2 || options?(args)
+      exec_git(:checkout, args)
+    end
+
     require_git && require_config
 
-    branch, remote = remote, nil if branch.nil?
+    remote, branch = args
+    remote, branch = nil, remote if branch.nil?
 
     unless branches(:match => branch)
       collab = branch && remote
@@ -79,6 +164,8 @@ class Gitcycle
     msg = nil
 
     if args.empty?
+      require_git && require_config
+
       puts "\nRetrieving branch information from gitcycle.\n".green
       branch = get('branch',
         'branch[name]' => branches(:current => true),
@@ -86,94 +173,26 @@ class Gitcycle
       )
 
       id = branch["lighthouse_url"].match(/tickets\/(\d+)/)[1] rescue nil
-      title = branch["title"]
 
       if branch && id
         msg = "[#{id}]"
-        msg += " #{title}" if title
+        msg += " #{branch["title"]}" if branch["title"]
       end
     end
 
+    cmd = "git add . && git add . -u && git commit -a"
+
     if msg
-      run("git add . -u && git commit -am #{msg.dump}")
+      run(cmd + "m #{msg.dump}")
       Kernel.exec("git commit --amend")
+    elsif args.empty?
+      run(cmd)
     else
       exec_git(:commit, args)
     end
   end
   alias :ci :commit
 
-  def create_branch(url_or_title, reset=false)
-    require_git && require_config
-
-    params = {}
-
-    if url_or_title.strip[0..3] == 'http'
-      if url_or_title.include?('lighthouseapp.com/')
-        params = { 'branch[lighthouse_url]' => url_or_title }
-      elsif url_or_title.include?('github.com/')
-        params = { 'branch[issue_url]' => url_or_title }
-      end
-    else
-      params = {
-        'branch[name]' => url_or_title,
-        'branch[title]' => url_or_title
-      }
-    end
-
-    params['reset'] = '1' if reset
-
-    puts "\nRetrieving branch information from gitcycle.\n".green
-    branch = get('branch', params)
-    name = branch['name']
-
-    begin
-      owner, repo = branch['repo'].split(':')
-
-      unless branch['exists']
-        branch['home'] = @git_login
-        branch['source'] = branches(:current => true)
-
-        unless yes?("\nYour work will eventually merge into '#{branch['source']}'. Is this correct?")
-          branch['source'] = q("What branch would you like to eventually merge into?")
-        end
-
-        unless yes?("Would you like to name your branch '#{name}'?")
-          name = q("\nWhat would you like to name your branch?")
-          name = name.gsub(/[\s\W]/, '-')
-        end
-
-        checkout_remote_branch(
-          :owner => owner,
-          :repo => repo,
-          :branch => branch['source'],
-          :target => name
-        )
-      end
-    rescue SystemExit, Interrupt
-      puts "\nDeleting branch from gitcycle.\n".green
-      branch = get('branch',
-        'branch[name]' => branch['name'],
-        'create' => 0,
-        'reset' => 1
-      )
-    end
-
-    if branch['exists']
-      checkout_or_track(:name => name, :remote => 'origin')
-    else
-      puts "Sending branch information to gitcycle.".green
-      get('branch',
-        'branch[home]' => branch['home'],
-        'branch[name]' => branch['name'],
-        'branch[rename]' => name != branch['name'] ? name : nil,
-        'branch[source]' => branch['source']
-      )
-    end
-
-    puts "\n"
-  end
-
   def discuss(*issues)
     require_git && require_config
 
@@ -200,7 +219,9 @@ class Gitcycle
     end
   end
 
-  def pull
+  def pull(*args)
+    exec_git(:pull, args) if args.length > 0
+
     require_git && require_config
 
     current_branch = branches(:current => true)
@@ -212,34 +233,41 @@ class Gitcycle
       'create' => 0
     )
 
-    if branch
-      if branch['collab'] == '1'
-        merge_remote_branch(
-          :owner => branch['home'],
-          :repo => branch['repo']['name'],
-          :branch => branch['name']
-        )
-      else
-        merge_remote_branch(
-          :owner => branch['repo']['owner'],
-          :repo => branch['repo']['name'],
-          :branch => branch['source']
-        )
-      end
-    else
-      puts "\nRetrieving repo information from gitcycle.".green
-      repo = get('repo')
+    collab = branch && branch['collab'] == '1'
 
-      add_remote_and_fetch(:owner => repo['owner'], :repo => repo['name'])
+    if collab
+      # Merge from collab
+      merge_remote_branch(
+        :owner => branch['home'],
+        :repo => branch['repo']['name'],
+        :branch => branch['name']
+      )
+    else
+      # Merge from upstream owner
+      merge_remote_branch(
+        :owner => branch['repo']['owner'],
+        :repo => branch['repo']['name'],
+        :branch => branch['source']
+      )
+    end
 
-      puts "\nPulling '#{repo['owner']}/#{current_branch}'.\n".green
-      run("git pull #{repo['owner']} #{current_branch}")
+    unless collab
+      # Merge from origin
+      merge_remote_branch(
+        :owner => @git_login,
+        :repo => @git_repo,
+        :branch => current_branch
+      )
     end
 
     branch
   end
 
-  def push
+  def push(*args)
+    exec_git(:push, args) if args.length > 0
+
+    require_git && require_config
+
     branch = pull
     remote = branch && branch['collab'] == '1' ? branch['home'] : 'origin'
 
@@ -356,8 +384,8 @@ class Gitcycle
     require_git && require_config
 
     if issues.empty?
-      pull
-      branch = create_pull_request
+      branch = pull
+      create_pull_request(branch)
 
       if branch == false
         puts "Branch not found.\n".red
@@ -383,8 +411,9 @@ class Gitcycle
     end
   end
 
-  def redo(ticket_or_url)
-    create_branch(ticket_or_url, true)
+  def redo(*args)
+    args << "--redo"
+    branch(*args)
   end
 
   def reviewed(*issues)
@@ -432,12 +461,10 @@ class Gitcycle
 
     if command.nil?
       puts "\nNo command specified\n".red
-    elsif command[0..0] == '-'
+    elsif command =~ /^-/
       command_not_recognized
     elsif self.respond_to?(command)
       send(command, *args)
-    elsif args.empty?
-      create_branch(command)
     else
       command_not_recognized
     end
@@ -453,13 +480,14 @@ class Gitcycle
 
     unless $remotes[owner]
       $remotes[owner] = true
+      
       puts "Adding remote repo '#{owner}/#{repo}'.\n".green
       run("git remote rm #{owner}") if remotes(:match => owner)
       run("git remote add #{owner} git@github.com:#{owner}/#{repo}.git")
-    end
 
-    puts "Fetching remote '#{owner}'.\n".green
-    run("git fetch -q #{owner}")
+      puts "Fetching remote '#{owner}'.\n".green
+      run("git fetch -q #{owner}")
+    end
   end
 
   def branches(options={})
@@ -531,13 +559,14 @@ class Gitcycle
     Launchy.open(readme)
   end
 
-  def create_pull_request
-    puts "\nRetrieving branch information from gitcycle.\n".green
-      
-    branch = get('branch',
-      'branch[name]' => branches(:current => true),
-      'create' => 0
-    )
+  def create_pull_request(branch=nil)
+    unless branch
+      puts "\nRetrieving branch information from gitcycle.\n".green  
+      branch = get('branch',
+        'branch[name]' => branches(:current => true),
+        'create' => 0
+      )
+    end
 
     if branch && !branch['issue_url']
       puts "Creating GitHub pull request.\n".green
@@ -611,7 +640,7 @@ class Gitcycle
 
   def exec_git(command, args)  
     args.unshift("git", command)
-    Kernel.exec(*args)
+    Kernel.exec(*args.collect(&:to_s))
   end
 
   def fix_conflict(options)
@@ -710,6 +739,10 @@ class Gitcycle
     fix_conflict(options)
   end
 
+  def options?(args)
+    args.any? { |arg| arg =~ /^-/ }
+  end
+
   def remotes(options={})
     b = `git remote`
     if options[:match]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitcycle
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - Winton Welsh
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-04 00:00:00 -08:00
+date: 2012-02-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency