git-process-lib 2.0.4 → 3.0.0

data/lib/git-process/github_pull_request.rb

@@ -18,7 +18,7 @@ require 'octokit/repository'
 module GitHub
 
   class PullRequest
-    attr_reader :gitlib, :repo, :remote_name, :client, :configuration
+    attr_reader :gitlib, :repo, :remote_name, :configuration
 
     MAX_RESEND = 5
 
@@ -26,24 +26,43 @@ module GitHub
       @gitlib = lib
       @repo = repo
       @remote_name = remote_name
-      @configuration = GitHubService::Configuration.new(gitlib.config, :user => opts[:user], :password => opts[:password])
+      @configuration = GitHubService::Configuration.new(
+          gitlib.config,
+          :user => opts[:user],
+          :password => opts[:password],
+          :remote_name => remote_name
+      )
     end
 
 
     def client
-      @client ||= @configuration.create_client
+      @configuration.client
     end
 
 
-    def pull_requests(state = 'open', opts = {})
-      @pull_requests ||= client.pull_requests(repo, state, opts)
+    def pull_requests(opts = {})
+      @pull_requests ||= sym_hash_JSON(client.pull_requests(repo, opts))
     end
 
 
+    # Create a pull request
+    #
+    # @see https://developer.github.com/v3/pulls/#create-a-pull-request
+    # @param base [String] The branch (or git ref) you want your changes
+    #                      pulled into. This should be an existing branch on the current
+    #                      repository. You cannot submit a pull request to one repo that requests
+    #                      a merge to a base of another repo.
+    # @param head [String] The branch (or git ref) where your changes are implemented.
+    # @param title [String] Title for the pull request
+    # @param body [String] The body for the pull request (optional). Supports GFM.
+    # @return [Hash] The newly created pull request
+    # @example
+    #   @client.create_pull_request("master", "feature-branch",
+    #     "Pull Request title", "Pull Request body")
     def create(base, head, title, body)
       logger.info { "Creating a pull request asking for '#{head}' to be merged into '#{base}' on #{repo}." }
       begin
-        client.create_pull_request(repo, base, head, title, body)
+        return sym_hash_JSON(client.create_pull_request(repo, base, head, title, body))
       rescue Octokit::UnprocessableEntity => exp
         pull = pull_requests.find { |p| p[:head][:ref] == head and p[:base][:ref] == base }
         if pull
@@ -51,7 +70,7 @@ module GitHub
         else
           logger.warn { "UnprocessableEntity: #{exp}" }
         end
-        pull
+        return pull
       end
     end
 
@@ -62,7 +81,7 @@ module GitHub
 
 
     def pull_request(pr_number)
-      client.pull_request(repo, pr_number)
+      sym_hash_JSON(client.pull_request(repo, pr_number))
     end
 
 
@@ -94,7 +113,9 @@ module GitHub
       logger.info { "Looking for a pull request asking for '#{head}' to be merged into '#{base}' on #{repo}." }
 
       json = pull_requests
-      pr = json.find { |p| p[:head][:ref] == head and p[:base][:ref] == base }
+      pr = json.find do |p|
+        p[:head][:ref] == head and p[:base][:ref] == base
+      end
 
       raise NotFoundError.new(base, head, repo, json) if error_if_missing && pr.nil?
 
@@ -147,10 +168,43 @@ module GitHub
 
     private
 
+    #
+    # @param [String, Sawyer::Resource] str the String to parse as JSON, or a simple pass through
+    #
+    # @return [Array, Hash, Sawyer::Resource, nil] an Array/Hash where all the hash keys are Symbols
+    #
+    def sym_hash_JSON(str)
+      return nil if str.nil?
+      case str
+        when String
+          raise ArgumentError.new('Can not parse an empty JSON string') if str.empty?
+          to_sym_hash(JSON.parse(str))
+        when Array, Hash
+          to_sym_hash(str)
+        else
+          str
+      end
+    end
+
+
+    def to_sym_hash(source)
+      if source.is_a? Hash
+        Hash[source.map { |k, v|
+               [k.to_sym, to_sym_hash(v)]
+             }]
+      elsif source.is_a? Array
+        source.map { |e| to_sym_hash(e) }
+      else
+        source
+        # raise "Don't know what to do with #{source.class} - #{source}"
+      end
+    end
+
 
+    # @return [Sawyer::Resource]
     def send_close_req(pull_number, count)
       begin
-        client.patch("repos/#{Octokit::Repository.new(repo)}/pulls/#{pull_number}", {:state => 'closed'})
+        sym_hash_JSON(client.patch("repos/#{Octokit::Repository.new(repo)}/pulls/#{pull_number}", {:state => 'closed'}))
       rescue Octokit::UnprocessableEntity => exp
         if count > MAX_RESEND
           raise exp

data/lib/git-process/pull_request.rb

@@ -85,17 +85,17 @@ module GitProc
 
 
       def checkout_pull_request(lib, pr_number, remote_name, repo_name, username, password, logger)
-        logger.info { 'Getting #pr_number' }
+        logger.info { "Getting #{pr_number}" }
 
         lib.fetch(remote_name)
 
         pr = create_pull_request_client(lib, remote_name, repo_name, username, password)
         json = pr.pull_request(pr_number)
-        head_branch_name = json.head.ref
-        base_branch_name = json.base.ref
+        head_branch_name = json[:head][:ref]
+        base_branch_name = json[:base][:ref]
 
-        remote_head_server_name = match_remote_to_pr_remote(lib, json.head.repo.ssh_url)
-        remote_base_server_name = match_remote_to_pr_remote(lib, json.base.repo.ssh_url)
+        remote_head_server_name = match_remote_to_pr_remote(lib, json[:head][:repo][:ssh_url])
+        remote_base_server_name = match_remote_to_pr_remote(lib, json[:base][:repo][:ssh_url])
         lib.checkout(head_branch_name, :new_branch => "#{remote_head_server_name}/#{head_branch_name}")
         lib.branch(head_branch_name, :upstream => "#{remote_base_server_name}/#{base_branch_name}")
         #logger.info(json.to_hash)

data/lib/git-process/version.rb

@@ -12,9 +12,9 @@
 
 module GitProc
   module Version
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 0
-    PATCH = 4
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/local-build.rb

@@ -3,22 +3,26 @@ require File.expand_path('../lib/git-process/version', __FILE__)
 
 gems = %w(git-process-lib git-sync git-to-master git-new-fb git-pull-req git-process)
 
+puts "rake manpage"
 %x[rake manpage 2>&1]
 
+puts "uninstall"
 for gem in gems.reverse
   %x[gem uninstall #{gem} -x -v #{GitProc::Version::STRING} 2>&1]
 end
 
 for gem in gems
-  puts %x(a2x -f manpage -D man docs/#{gem}.1.adoc)
-  SystemExit.new($?) if $?.exitstatus
+  # puts %x(a2x -f manpage -D man docs/#{gem}.1.adoc)
+  # SystemExit.new($?) if $?.exitstatus
 
+  puts "gem build #{gem}"
   %x[gem build #{gem}.gemspec]
   SystemExit.new($?) if $?.exitstatus
 
   # puts %x(gem install ./#{gem}-#{GitProc::Version::STRING}.gem -l -u)
   # SystemExit.new($?) if $?.exitstatus
 
+  puts "gem push #{gem}"
   puts %x(gem push ./#{gem}-#{GitProc::Version::STRING}.gem)
   SystemExit.new($?) if $?.exitstatus
 end

data/spec/changed_file_helper_spec.rb

@@ -110,7 +110,7 @@ describe ChangeFileHelper, :git_repo_helper do
 
         change_file_helper.offer_to_help_uncommitted_changes
 
-        gitlib.status.clean?.should be_true
+        gitlib.status.clean?.should be true
 
         gitlib.stash_pop
 

data/spec/git_branch_spec.rb

@@ -21,6 +21,41 @@ describe GitProc::GitBranch do
   end
 
 
+  describe 'comparison' do
+
+    it 'should handle another branch' do
+      base_branch = gitlib.branches.current
+      current = gitlib.branches.current
+      gitlib.checkout('fb', :new_branch => base_branch.name)
+      fb = gitlib.branches['fb']
+      expect( current <=> fb ).to eq(1)
+      expect( fb <=> current ).to eq(-1)
+    end
+
+
+    it 'should handle a String' do
+      current = gitlib.branches.current
+      expect( current <=> 'fb' ).to eq(1)
+      expect( 'fb' <=> current ).to eq(-1)
+    end
+
+
+    it 'should handle a nil' do
+      current = gitlib.branches.current
+      expect( current <=> nil ).to be_nil
+      expect( nil <=> current ).to be_nil
+    end
+
+
+    it 'should handle an unknown' do
+      current = gitlib.branches.current
+      expect( current <=> {} ).to be_nil
+      expect( {} <=> current ).to be_nil
+    end
+
+  end
+
+
   describe 'contains_all_of' do
 
     it 'should handle the trivial case' do

data/spec/git_lib_spec.rb

@@ -46,18 +46,41 @@ describe GitLib, :git_repo_helper do
   end
 
 
+  describe 'rev_parse' do
+
+    it 'parses a known branch name' do
+      expect(gitlib.rev_parse('master')).not_to be_empty
+    end
+
+
+    it 'does not try to parse a file name as a revision name' do
+      file = gitlib.workdir + '/fooble.txt'
+      FileUtils.touch(file, :verbose => false)
+      gitlib.add file
+      gitlib.commit 'test'
+      expect(gitlib.rev_parse('fooble.txt')).to be_nil
+    end
+
+
+    it 'empty for an unknown branch name' do
+      expect(gitlib.rev_parse('skdfklsjhdfklerouwh')).to be_nil
+    end
+
+  end
+
+
   describe 'set_upstream_branch' do
     include GitRepoHelper
 
     it 'updates for remote branch' do
-        gitlib.branch('ba/bb', :base_branch => 'master')
-        clone_repo do |gl|
-           gl.checkout('new_branch', :new_branch => 'origin/master')
-           gl.set_upstream_branch('new_branch', 'origin/ba/bb')
+      gitlib.branch('ba/bb', :base_branch => 'master')
+      clone_repo do |gl|
+        gl.checkout('new_branch', :new_branch => 'origin/master')
+        gl.set_upstream_branch('new_branch', 'origin/ba/bb')
 
-           gl.config['branch.new_branch.remote'].should == 'origin'
-           gl.config['branch.new_branch.merge'].should == 'refs/heads/ba/bb'
-        end
+        gl.config['branch.new_branch.remote'].should == 'origin'
+        gl.config['branch.new_branch.merge'].should == 'refs/heads/ba/bb'
+      end
     end
 
 
@@ -86,7 +109,7 @@ describe GitLib, :git_repo_helper do
   describe 'fetch' do
 
     it 'parse the list of changes' do
-      output = '''
+      output = '' '
 remote: Counting objects: 1028, done.
 remote: Compressing objects: 100% (301/301), done.
 remote: Total 699 (delta 306), reused 654 (delta 273)
@@ -111,7 +134,7 @@ From remote.system.com:tuser/test-proj
    b9797f8..dd24a9f  webcms-2135 -> origin/webcms-2135
  * [new branch]      webcms-831-faq-web-service -> origin/webcms-831-faq-web-service
  x [deleted]         (none)     -> origin/webcms-1315-masthead
-'''
+' ''
       changes = gitlib.fetch_changes(output)
 
       changes[:new_branch].size().should == 6

data/spec/git_process_spec.rb

@@ -1,5 +1,6 @@
-require 'git-process/git_process'
+require File.dirname(__FILE__) + '/../lib/git-process/git_process'
 require 'GitRepoHelper'
+require 'climate_control'
 require 'fileutils'
 
 describe GitProc::Process do
@@ -21,6 +22,13 @@ describe GitProc::Process do
     rm_rf(gitlib.workdir)
   end
 
+  around do |example|
+    # make sure there aren't side-effects testing from the testing user's .gitconfig
+    ClimateControl.modify HOME: '/path_that_does_not_exist' do
+      example.run
+    end
+  end
+
 
   describe 'run lifecycle' do
 
@@ -35,13 +43,13 @@ describe GitProc::Process do
     end
 
 
-    it "should call 'cleanup' even if there's an error" do
+    it 'should call "cleanup" even if there is an error' do
       proc = GitProc::Process.new(gitlib)
       proc.should_receive(:verify_preconditions)
-      proc.should_receive(:runner).and_raise(GitProc::GitProcessError.new("Error!"))
+      proc.should_receive(:runner).and_raise(GitProc::GitProcessError.new('Error!'))
       proc.should_receive(:cleanup)
       proc.should_receive(:exit)
-      proc.should_receive(:puts).with("Error!")
+      proc.should_receive(:puts).with('Error!')
 
       proc.run
     end
@@ -49,9 +57,9 @@ describe GitProc::Process do
   end
 
 
-  describe "validate local integration branch" do
+  describe 'validate local integration branch' do
 
-    it "should use remove the int-branch if not on it and not blocked" do
+    it 'should use remove the int-branch if not on it and not blocked' do
       clone_repo('master') do |gl|
         gl.checkout('fb', :new_branch => 'master')
 
@@ -60,12 +68,12 @@ describe GitProc::Process do
 
         gp.verify_preconditions
 
-        gl.branches.include?('master').should be_false
+        gl.branches.include?('master').should be false
       end
     end
 
 
-    it "should ask use remove the int-branch if not on it and not blocked" do
+    it 'should ask to remove the int-branch if not on it and not blocked' do
       clone_repo('master') do |gl|
         gl.checkout('fb', :new_branch => 'master')
 
@@ -74,12 +82,12 @@ describe GitProc::Process do
 
         gp.verify_preconditions
 
-        gl.branches.include?('master').should be_false
+        gl.branches.include?('master').should be false
       end
     end
 
 
-    it "should ask use remove the int-branch if not on it and not blocked and not remove if answered no" do
+    it 'should ask to remove the int-branch if not on it and not blocked and not remove if answered no' do
       clone_repo('master') do |gl|
         gl.checkout('fb', :new_branch => 'master')
 
@@ -88,22 +96,22 @@ describe GitProc::Process do
 
         gp.verify_preconditions
 
-        gl.branches.include?('master').should be_true
+        gl.branches.include?('master').should be true
       end
     end
 
 
-    it "should not remove the int-branch if on it" do
+    it 'should not remove the int-branch if on it' do
       clone_repo('master') do |gl|
         gp = GitProc::Process.new(gl)
         gp.verify_preconditions
 
-        gl.branches.include?('master').should be_true
+        gl.branches.include?('master').should be true
       end
     end
 
 
-    it "should not remove the int-branch if blocked" do
+    it 'should not remove the int-branch if blocked' do
       clone_repo('master') do |gl|
         gl.config['gitProcess.keepLocalIntegrationBranch'] = 'true'
         gl.checkout('fb', :new_branch => 'master')
@@ -111,12 +119,12 @@ describe GitProc::Process do
         gp = GitProc::Process.new(gl)
         gp.verify_preconditions
 
-        gl.branches.include?('master').should be_true
+        gl.branches.include?('master').should be true
       end
     end
 
 
-    describe "local vs remote branch status" do
+    describe 'local vs remote branch status' do
 
       before(:each) do
         change_file_and_commit('a.txt', 'a content', gitlib)
@@ -124,7 +132,7 @@ describe GitProc::Process do
       end
 
 
-      it "should not remove if both have changes" do
+      it 'should not remove if both have changes' do
         clone_repo('master') do |gl|
           change_file_and_commit('c.txt', 'c on origin/master', gitlib)
           change_file_and_commit('d.txt', 'd on master', gl)
@@ -136,12 +144,12 @@ describe GitProc::Process do
           gp = GitProc::Process.new(gl)
           gp.verify_preconditions
 
-          gl.branches.include?('master').should be_true
+          gl.branches.include?('master').should be true
         end
       end
 
 
-      it "should remove if server changed but not local" do
+      it 'should remove if server changed but not local' do
         clone_repo('master') do |gl|
           gp = GitProc::Process.new(gl)
           gp.stub(:ask_about_removing_master).and_return(true)
@@ -154,12 +162,12 @@ describe GitProc::Process do
 
           gp.verify_preconditions
 
-          gl.branches.include?('master').should be_false
+          gl.branches.include?('master').should be false
         end
       end
 
 
-      it "should not remove if server did not change but local did" do
+      it 'should not remove if server did not change but local did' do
         clone_repo('master') do |gl|
           change_file_and_commit('c.txt', 'c on master', gl)
 
@@ -170,12 +178,12 @@ describe GitProc::Process do
           gp = GitProc::Process.new(gl)
           gp.verify_preconditions
 
-          gl.branches.include?('master').should be_true
+          gl.branches.include?('master').should be true
         end
       end
 
 
-      it "should remove if server and local are the same" do
+      it 'should remove if server and local are the same' do
         change_file_and_commit('c.txt', 'c on origin/master', gitlib)
 
         clone_repo('master') do |gl|
@@ -186,21 +194,21 @@ describe GitProc::Process do
           gl.fetch
           gp.verify_preconditions
 
-          gl.branches.include?('master').should be_false
+          gl.branches.include?('master').should be false
         end
       end
 
     end
 
 
-    it "should not remove the int-branch if not a clone" do
+    it 'should not remove the int-branch if not a clone' do
       gitlib.config['gitProcess.keepLocalIntegrationBranch'] = 'false'
       gitlib.checkout('fb', :new_branch => 'master')
 
       gitprocess = GitProc::Process.new(gitlib)
       gitprocess.verify_preconditions
 
-      gitlib.branches.include?('master').should be_true
+      gitlib.branches.include?('master').should be true
     end
 
   end