git-helpers 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4981c208c8a78f9d127ae0eadb4d094aa5d22527
-  data.tar.gz: d68a8861b6012bb68104ed6f51b68ff32c0ac876
+  metadata.gz: 3c3aae4c9f77059eeb841e6a6342a9292616c3c5
+  data.tar.gz: 41804526c500c86e32371b84ec35754300abc2a6
 SHA512:
-  metadata.gz: 003a486979b01520f36627e2441d4f0c5e2a75ddd016776265bdc3c2e85ac4f886817130f5fe83b9edbd477dc0fc22abb8fc07b17d595c5854c50d76452edcbd
-  data.tar.gz: 3f9100bb1444f1cfbdb0477edc42b3a7833ec88cf5401cc42f8ecba58a7ff57cc53d25efa449bb35e4ebc87d8f6c5898baf150cbdf81df8dc0663679700ec620
+  metadata.gz: c89be32c4173474ed8c978f2212be9b4b1e55c1c7803fc2612790831e8ca1270c108c13ff46b3cfcd9348532fab8a541db948ad48786235609e5305f03281e42
+  data.tar.gz: bd3fc87c14083b2322c2c7c57c53218d7c25ee656681983a0f751c2eeda9e2f121b8720330a375f1d9abc7c0180ee4a413d62c443c7b00253f0c2e9b2a1b902f

data/README.md

@@ -28,7 +28,18 @@ page at the current working branch. You can specify the remote if you wish to
 browse a different one in the format `git browse [remote]`. If you wish to view a
 specific branch/tag/commit then you can specify the tree after `remote` in the
 format `git browse [remote] [tree]`.
-*Note: To use a commit as a tree you must use the full commit hash* 
+*Note: To use a commit as a tree you must use the full commit hash*
+
+### PR (Pull Request)
+Running `git pr` or one of its other forms will open a new pull request window
+in your default web browser.
+*Note: only works on GitHub remotes currently*
+
+Forms:
+* `git pr` - Opens the comparison between upstream and origin for the current branch
+* `git pr target_remote` - Opens the comparison between `target_remote` and origin for the current branch
+* `git pr target_remote target_branch` - Opens the comparison between `target_remote` at the `target_branch` and origin at the current branch
+* `git pr target_remote/target_branch source_remote/source_branch` - Opens the comparison between `target_remote` at the `target_branch` and `source_remote` at the `source_branch`
 
 ## Development
 

data/exe/git-pr

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require 'git/helpers'
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Git-Helpers git pr\n"\
+                "Opens the default browser to a pull request creation window (only works for Github currently)\n"\
+                "Usages: git pr\n"\
+                "        git pr target_remote\n"\
+                "        git pr target_remote target_branch\n"\
+                '        git pr target_remote/target_branch source_remote/source_branch'
+  opts.on_tail '-h', '--help', 'Shows this help message' do
+    puts opts
+    exit 0
+  end
+  opts.on_tail '-v', '--version', 'Shows the version of git-helpers' do
+    puts "Git-Helpers version #{Git::Helpers::VERSION}"
+    exit 0
+  end
+end.parse!
+
+target = ARGV.shift unless ARGV.empty?
+source = ARGV.shift unless ARGV.empty?
+
+if target.nil?
+  Git::Helpers.pull_request
+else
+  target_remote, target_branch = Git::Helpers::Utils.split_remote_string(target)
+  if source.nil?
+    Git::Helpers.pull_request Dir.pwd, target_remote, target_branch
+  else
+    source_remote, source_branch = Git::Helpers::Utils.split_remote_string(source)
+    if target_branch.nil?
+      Git::Helpers.pull_request Dir.pwd, target_remote, source_remote
+    else
+      Git::Helpers.pull_request Dir.pwd, target_remote, target_branch, source_remote, source_branch
+
+    end
+  end
+end

data/lib/git/helpers/pull_request.rb

@@ -0,0 +1,28 @@
+require 'git/helpers/utils'
+module Git
+  # Provides a set of helper functions to make Git life easier
+  module Helpers
+    require 'git'
+    require 'launchy'
+
+    # Opens the default web browser to an comparison page to open a pull request
+    # @param repo_dir [String] Directory of the git repo to browse, defaults to current working dir
+    # @param target_remote [String] Name of the target remote, default upstream
+    # @param target_branch [String] Name of the branch on the target remote to compare, defaults to current branch
+    # @param source_remote [String] Name of the source remote, default origin
+    # @param source_branch [String] Name of the branch on the source remote to compare, defaults to current branch
+    def self.pull_request(repo_dir = Dir.pwd, target = 'upstream', target_branch = nil, source = 'origin', source_branch = nil)
+      repo = Git.open(repo_dir)
+      raise "#{target} is not a known remote" unless Utils.remote? repo, target
+      raise "#{source} is not a known remote" unless Utils.remote? repo, source
+      target_remote = Utils.remotes_hash(repo)[target]
+      source_remote = Utils.remotes_hash(repo)[source]
+      target_branch ||= repo.current_branch
+      source_branch ||= repo.current_branch
+      url = target_remote.url.chomp('.git')
+      url = Utils.transform_url(url)
+      url << "/compare/#{target_branch}...#{Utils.true_name(source_remote)}:#{source_branch}?expand=1"
+      Launchy.open url
+    end
+  end
+end

data/lib/git/helpers/utils.rb

@@ -33,6 +33,26 @@ module Git
           url
         end
       end
+
+      # Splits a remote/branch string into its component parts
+      # @param str [String] String to split
+      # @return [Array<String>] remote, branch
+      def self.split_remote_string(str)
+        first_slash = str.index('/')
+        if first_slash.nil?
+          return str, nil
+        else
+          return str[0..first_slash-1], str[first_slash+1..-1]
+        end
+      end
+
+      # Gets the true name for a remote
+      # @param remote [Git::Remote] The remote to get the true name for
+      # @return [String] The true name of the remote, pulled from the url
+      def self.true_name(remote)
+        transform_url(remote.url) =~ %r{^https://.*?/(.*?)/.*$}
+        Regexp.last_match 1
+      end
     end
   end
 end

data/lib/git/helpers/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Helpers
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/git/helpers.rb

@@ -1,3 +1,5 @@
 require 'git/helpers/version'
+require 'git/helpers/utils'
 require 'git/helpers/update'
 require 'git/helpers/browse'
+require 'git/helpers/pull_request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-helpers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kierran McPherson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
@@ -157,6 +157,7 @@ email:
 - kierranm@gmail.com
 executables:
 - git-browse
+- git-pr
 - git-update
 extensions: []
 extra_rdoc_files: []
@@ -170,10 +171,12 @@ files:
 - README.md
 - Rakefile
 - exe/git-browse
+- exe/git-pr
 - exe/git-update
 - git-helpers.gemspec
 - lib/git/helpers.rb
 - lib/git/helpers/browse.rb
+- lib/git/helpers/pull_request.rb
 - lib/git/helpers/update.rb
 - lib/git/helpers/utils.rb
 - lib/git/helpers/version.rb