git-process 0.9.1.pre3 → 0.9.2

data/Gemfile

@@ -1,10 +1,10 @@
 source "http://rubygems.org"
 
-# gem "git", "~> 1.2.5"
 # gem "rugged"  # "git" bindings for libgit2
 gem "launchy", "~> 2.1.0" # web browser interaction
 gem "octokit", "~> 1.4.0" # GitHub API
 gem "json", "~> 1.7.3"
+gem "trollop", "~> 1.16.2" # CLI options parser
 gem "highline", "~> 1.6.12" # user CLI interaction
 gem "termios", "~> 0.9.4"  # used by highline to make things a little nicer
 gem "system_timer", "~> 1.2.4" # Needed by faraday via octokit
@@ -17,6 +17,6 @@ end
 
 group :development do
   gem "rake", "~> 0.9.2"
-  gem "yard", "~> 0.8.2.1"
+  gem "yard", "~> 0.8.2.1" # documentation generator
   gem "redcarpet", "~> 2.1.1"
 end

data/Gemfile.lock

@@ -33,6 +33,7 @@ GEM
     rspec-mocks (2.10.1)
     system_timer (1.2.4)
     termios (0.9.4)
+    trollop (1.16.2)
     webmock (1.8.7)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
@@ -52,5 +53,6 @@ DEPENDENCIES
   rspec-mocks (~> 2.10.0)
   system_timer (~> 1.2.4)
   termios (~> 0.9.4)
+  trollop (~> 1.16.2)
   webmock (~> 1.8.7)
   yard (~> 0.8.2.1)

data/README.md

@@ -9,6 +9,7 @@ This provides an easy way to work with a sane git workflow process.
 
     $ gem install git-process
 
+
 # Overview #
 
 * `git new-fb` - Create a new feature branch based on the integration branch.
@@ -31,7 +32,7 @@ _The following assumes that the integration branch is "origin/master"._
 3. When you feel your work is ready for others to look at, do another "`git sync`" to post your
    changes to the server, and then "`git pull-request`" to ask someone to review your changes.
 4. If you get the thumbs up from the code-review, use "`git to-master`".
-    * This will merge and push your changes into "`origin/master`"
+    * This will merge and push your changes into "`origin/master`", closing the pull request.
 5. If you still need to make changes, do so and use "`git sync`" to keep your branch on the
    server for that feature updated with your work until all issues have been resolved.
 
@@ -46,25 +47,28 @@ _The following assumes that the integration branch is "origin/master"._
 3. When you are ready to merge your work into the mainline, "`git to-master`".
     * This will merge and push your changes into "`origin/master`"
 
+
 # Notes #
 
-* It's assumed that you **_never_** do any work directly on "master": everything is done on a
+* It's assumed that you **_never_** do any work directly on "`master`": everything is done on a
   feature branch.  This is a much safer and more flexible practice, but may seem odd to
-  people used to old VCSs.
+  people used to old VCSs. In addition to being a much better way of working in general,
+  it is also a requirement to take advantage of Pull Request functionality.
     * After publishing changes to the main integration branch (i.e., "`git to-master`") the
       old feature branch is removed as part of cleanup. Git is then "parked" on a "`_parking_`"
       branch until a new feature branch is created. Work is not expected to be done on this
       branch, but any that is done is brought over to a newly created feature branch (i.e.,
       "`git new-fb`").
+* If there is a problem (such as a merge conflict), this will try to resolve such errors
+  for you as much as it can do safely. When it can't do so in an automated way, it will try
+  to tell you the process for doing so manually.
 * The first time you use a GitHub feature (e.g., "`git pull-request`"), this will ask for your
   username and password. It does not store them, but instead uses them to get an OAuth2 token,
   which is stored in "`git config gitProcess.github.authToken`".
-
-## Misc ##
-
-* http://git-scm.com/2010/03/08/rerere.html
-* http://git.kernel.org/?p=git/git.git;a=blob;f=contrib/rerere-train.sh;hb=HEAD
-* https://github.com/b4mboo/git-review
+* If you want to use a different integration branch other than "`master`", set the
+  "`gitProcess.integrationBranch`" configuration value. (e.g.,
+  "`git config gitProcess.integrationBranch my-integ-branch`")
+* This tries to respond "intelligently" to the use of 'rerere'.
 
 
 # Contributing #
@@ -78,3 +82,17 @@ _The following assumes that the integration branch is "origin/master"._
 5. Create new Pull Request
 
 The tests are written for RSpec 2.
+
+## License ##
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0 "License Link")
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/git-new-fb

@@ -1,21 +1,50 @@
 #!/usr/bin/env ruby
 
-require "rubygems"
-require "bundler/setup"
+require 'git-process/git_process_options'
+require 'git-process/new_fb'
 
-require 'logger'
+class NewFeatureBranchOptions
+  include GitProc::GitProcessOptions
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib/git-process')
-require 'git-new-fb-options'
-require 'git-process'
+  def summary
+    "Create a new feature branch based on the integration branch."
+  end
 
-options = Git::Process::NewFeatureBranchOptions.new(File.basename(__FILE__), ARGV)
 
-gp = Git::Process.new('.', nil, :log_level => options.log_level)
+  def description
+    <<DESC
+DESCRIPTION
+
+This creates the named branch based on the integration branch.
+
+EXAMPLE
+
+Assuming that the the integration branch on the server is "master", \
+typing "git new-fb my_feature" will do roughly the following \
+for you:
+  $ git checkout my_feature origin/master
+
+Also, if you are currently on the "_parking_" branch (see "git to-master"), \
+this will remove that branch.
+
+DESC
+  end
+
+
+  def usage(filename)
+    "#{filename} [options] branch_name"
+  end
+
+
+  def empty_argv_ok?
+    false
+  end
+
+
+  def post_parse(opts, argv)
+    opts[:branch_name] = argv.shift
+  end
 
-begin
-  gp.new_feature_branch(options.branch_name)
-rescue Git::Process::GitProcessError => exp
-  puts exp.message
-  exit(-1)
 end
+
+GitProc::NewFeatureBranch.new('.', NewFeatureBranchOptions.new.parse_cli(File.basename(__FILE__), ARGV)).run

data/bin/git-pull-request

@@ -1,21 +1,87 @@
 #!/usr/bin/env ruby
 
-require "rubygems"
-require "bundler/setup"
+require 'git-process/pull_request'
+require 'git-process/git_process_options'
 
-require 'logger'
+class PullRequestOptions
+  include GitProc::GitProcessOptions
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib/git-process')
-require 'git-pull-request-options'
-require 'git-process'
+  def summary
+    "Creates a Pull Request for the current branch."
+  end
 
-options = Git::Process::PullRequestOptions.new(File.basename(__FILE__), ARGV)
 
-gp = Git::Process.new('.', nil, :log_level => options.log_level)
+  def description
+    <<DESC
+DESCRIPTION
+
+This creates a Pull Request on the GitHub server associated with the current \
+branch. For the reasons why Pull Requests are useful for the development process, \
+see https://help.github.com/articles/using-pull-requests
+
+The "git pull-request" command is a nice, simplified alternative to using the \
+web interface.
+
+EXAMPLE
+
+You've been developing your killer new feature or bug fix, and you want \
+someone else to look at it (to do code-review or otherwise provide input). \
+When you do "git pull-request", it synchronizes the current branch with \
+the server (effectively executing "git sync") and creates the Pull Request \
+against the integration branch. (Usually "master", but this can be changed; \
+see below.)
+
+The counterpart to this command is "git to-master".
+
+NOTES
+
+* It's assumed that you *never* do any work directly on "master":
+  everything is done on a feature branch.  In addition to being a much
+  safer and more flexible way of working in general, it is also a
+  requirement to take advantage of Pull Request functionality.
+* The first time you use a GitHub feature like this, you will be asked
+  for your username and password. This does not store them, but instead
+  uses them to get an OAuth2 token, which is stored in
+  "git config gitProcess.github.authToken".
+* If you want to use a different integration branch other than "master",
+  set the "gitProcess.integrationBranch" configuration value. (e.g.,
+  "git config gitProcess.integrationBranch my-integ-branch")
+
+DESC
+  end
+
+
+  def usage(filename)
+    "Usage: #{filename} [ options ] pull_request_title"
+  end
+
+
+  def empty_argv_ok?
+    false
+  end
+
+
+  def extend_opts(parser)
+    parser.opt :base_branch,  "The branch on the server that you want this \"pulled\" into. "+
+                              "Defaults to the integration branch."
+    parser.opt :head_branch,  "The branch that you want reviewed before being \"pulled\" "+
+                              "into the base branch. Defaults to the current branch."
+    parser.opt :repo_name,    "The name of the repository to \"pull\" into. Defaults to "+
+                              "the current repository."
+    parser.opt :description,  "The description of the Pull Request. Usually includes a "+
+                              "nice description of what was changed to make things easier "+
+                              "for the reviewer.", :short => :d
+    parser.opt :user,         "Your GitHub username. Only needed the first time you connect, "+
+                              "and you will be prompted for it if needed."
+    parser.opt :password,     "Your GitHub password. Only needed the first time you connect, "+
+                              "and you will be prompted for it if needed."
+  end
+
+
+  def post_parse(opts, argv)
+    opts[:title] = argv.shift
+  end
 
-begin
-  gp.create(nil, nil, nil, options.title, options.description, :user => options.user, :password => options.password)
-rescue Git::Process::GitProcessError => exp
-  puts exp.message
-  exit(-1)
 end
+
+GitProc::PullRequest.new('.', PullRequestOptions.new.parse_cli(File.basename(__FILE__), ARGV)).run

data/bin/git-sync

@@ -1,21 +1,55 @@
 #!/usr/bin/env ruby
 
-require "rubygems"
-require "bundler/setup"
+require 'git-process/git_process_options'
+require 'git-process/sync'
 
-require 'logger'
+class SyncOptions
+  include GitProc::GitProcessOptions
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib/git-process')
-require 'git-sync-options'
-require 'git-process'
+  def summary
+    "Gets the latest changes that have happened on the integration branch, then pushes your changes to a \"private\" branch on the server."
+  end
 
-options = Git::Process::SyncOptions.new(File.basename(__FILE__), ARGV)
 
-gp = Git::Process.new('.', nil, :log_level => options.log_level)
+  def description
+    <<DESC
+DESCRIPTION
+
+This fetches the latest repository from the server, rebases/merges the current branch \
+against the changes in the integration branch, then pushes the result up to a branch on \
+the server of the same name.
+
+If there is a problem, such as a merge conflict, this tries to \
+resolve it automatically. If it can not do so in an automated way, \
+if tells you the steps involved for doing so manually.
+
+EXAMPLE
+
+Assuming that the current branch is called "interesting_changes" and the integration \
+branch on the server is "master", typing "git sync" will do roughly the following \
+for you:
+  $ git fetch -p
+  $ git merge origin/master
+  $ git push origin interesting_changes:interesting_changes
+
+DESC
+  end
+
+
+  def extend_opts(parser)
+    parser.opt :rebase, "Rebase instead of merge against the integration branch"
+    parser.opt :merge, "Merge instead of rebase against the integration branch", :short => :none, :default => true
+    parser.opt :force, "Force the push; defaults to true if --rebase is used", :short => :f, :default => false
+
+    parser.conflicts :rebase, :merge
+  end
+
+
+  def post_parse(opts, argv)
+    opts[:force] = true if opts[:rebase]
+    opts[:merge] = !opts[:rebase]
+  end
 
-begin
-  gp.sync_with_server(options.rebase, options.force)
-rescue Git::Process::GitProcessError => exp
-  puts exp.message
-  exit(-1)
 end
+
+GitProc::Sync.new('.', SyncOptions.new.parse_cli(File.basename(__FILE__), ARGV)).run

data/bin/git-to-master

@@ -1,21 +1,64 @@
 #!/usr/bin/env ruby
 
-require "rubygems"
-require "bundler/setup"
+require 'git-process/git_process_options'
+require 'git-process/rebase_to_master'
 
-require 'logger'
+class ToMasterOptions
+  include GitProc::GitProcessOptions
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '../lib/git-process')
-require 'git-to-master-options'
-require 'git-process'
+  def summary
+    "Rebase against the integration branch, then pushes to it."
+  end
 
-options = Git::Process::ToMasterOptions.new(File.basename(__FILE__), ARGV)
 
-gp = Git::Process.new('.', nil, :log_level => options.log_level)
+  def description
+    <<DESC
+DESCRIPTION
+
+This fetches the latest changes from the server, rebases against \
+the integration branch, pushes to the integration branch, then does \
+housecleaning.
+
+If there is a problem, such as a merge conflict, this tries to \
+resolve it automatically. If it can not do so in an automated way, \
+if tells you the steps involved for doing so manually.
+
+"Housecleaning" includes such things as closing any \
+Pull Request that may exist for the branch, removing the (now obsolete) \
+local and remote feature branches, and then "parking" on the \
+special "_parking_" branch.
+
+Work is not expected to be done on the "parking" branch, but any that is \
+done is brought over to a newly created feature branch when you do \
+"git new-fb".
+
+It's assumed that you *never* do any work directly on "master": \
+everything is done on a feature branch.  In addition to being a much \
+safer and more flexible way of working in general, it is also a \
+requirement to take advantage of Pull Request functionality.
+
+EXAMPLE
+
+Assuming that the current branch is called "interesting_changes" and the integration \
+branch on the server is "master", typing "git to-master" will do roughly the following \
+for you:
+  $ git fetch -p
+  $ git rebase origin/master
+  $ git push origin interesting_changes:master
+  # close pull request
+  $ git co -b _parking_ origin/master
+  $ git branch -d interesting_changes
+  $ git push origin :interesting_changes
+
+NOTES
+
+* If you want to use a different integration branch other than "master",
+  set the "gitProcess.integrationBranch" configuration value. (e.g.,
+  "git config gitProcess.integrationBranch my-integ-branch")
+
+DESC
+  end
 
-begin
-  gp.rebase_to_master
-rescue Git::Process::GitProcessError => exp
-  puts exp.message
-  exit(-1)
 end
+
+GitProc::RebaseToMaster.new('.', ToMasterOptions.new.parse_cli(File.basename(__FILE__), ARGV)).run

data/git-process.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "git-process"
   gem.require_paths = ["lib"]
-  gem.version       = Git::Process::Version::STRING
+  gem.version       = GitProc::Version::STRING
   gem.platform      = Gem::Platform::RUBY
   gem.required_ruby_version = '>= 1.8.7'
 end

data/lib/git-process/{abstract-error-builder.rb → abstract_error_builder.rb}

@@ -1,8 +1,18 @@
-require 'git-lib'
-require 'git-process-error'
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.require 'shellwords'
+
 require 'shellwords'
 
-module Git
+module GitProc
 
   #
   # Assumes that there are two attributes defined: error_message, lib

data/lib/git-process/{git-abstract-merge-error-builder.rb → git_abstract_merge_error_builder.rb}

@@ -1,15 +1,25 @@
-require 'git-lib'
-require 'abstract-error-builder'
-require 'git-process-error'
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.require 'shellwords'
+
+require 'git-process/abstract_error_builder'
 require 'shellwords'
 
-module Git
+module GitProc
 
   #
   # Assumes that there are three attributes defined: error_message, lib, continue_command
   #
   module AbstractMergeErrorBuilder
-    include AbstractErrorBuilder
+    include GitProc::AbstractErrorBuilder
 
     def resolved_files
       @resolved_files ||= find_resolved_files

data/lib/git-process/{git-branch.rb → git_branch.rb}

@@ -1,4 +1,16 @@
-module Git
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.require 'shellwords'
+
+module GitProc
 
   class GitBranch
     include Comparable

data/lib/git-process/git_branches.rb

@@ -0,0 +1,72 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.require 'shellwords'
+
+require 'set'
+require 'git-process/git_branch'
+
+module GitProc
+
+  class GitBranches
+    include Enumerable
+
+    def initialize(lib)
+      @lib = lib
+      branch_lines = lib.branch(nil, :all => true, :no_color => true).split("\n")
+      @items = SortedSet.new
+      branch_lines.each do |bl|
+        @items << GitBranch.new(bl[2..-1], bl[0..0] == '*', lib)
+      end
+    end
+
+
+    def <<(item)
+      @items << item
+    end
+
+
+    def each(&block)
+      @items.each {|b| block.call(b)}
+    end
+
+
+    def names
+      @items.map {|b| b.name}
+    end
+
+
+    def current
+      @items.find {|b| b.current? }
+    end
+
+
+    def parking
+      @items.find {|b| b.name == '_parking_' }
+    end
+
+
+    def include?(branch_name)
+      @items.find {|b| b.name == branch_name} != nil
+    end
+
+
+    def [](branch_name)
+      branch_name = current.name if branch_name == 'HEAD'
+      br = @items.find {|b| b.name == branch_name}
+      unless br
+        @lib.logger.warn {"Could not find '#{branch_name}' in #{@items.map{|i|i.name}.join(',')}"}
+      end
+      br
+    end
+
+  end
+
+end