git-whistles 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdbbcadb6c855b3aa67a6daf8c8b05c1872ca75b
-  data.tar.gz: fb2487cc9827db9edcf36fc6a5fccc739a8ef3ac
+  metadata.gz: 4304a8f417f4f756f4c2522288980894837415ce
+  data.tar.gz: d295f0cbd94e9d4dc09a3ab957928324809c122d
 SHA512:
-  metadata.gz: 78c7d6c34c2f4f8996152002eaa7bb0933d0ec5a0629e22cbc46f898c2c302dbb21039717aeed1740836cf2cd82b6b78444ef7f0f7587a6e5f5634ea53cbb953
-  data.tar.gz: 92bb64c2bdedb443a0378a597b6e35f988c7d77dee073e30bfb60e7d880cfad244dd9164578ba94b5e0bcc73ad169f7d380246755911e216194c891666fcff14
+  metadata.gz: 51ad1985a2f3fe9cf36a5eb55672f2a434d522407b0eed62e0fff7daeb1ccaed6ea0636700705b101f32cabddfac24309ef8ffd8059c4659503abc2e69f15e13
+  data.tar.gz: 754aa0292b9ad21327a127b9e1815854fd767f95e1f51b4b021f49ca4a944308a13880222b2791eceb12d4abe7d12833d07a119d070197a37e41df2db69d9513

data/.gitignore

@@ -7,3 +7,4 @@ pkg
 rdoc
 tmp
 nbproject
+.idea/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git-whistles (1.0.2)
+    git-whistles (1.1.0)
       jira-ruby
       pivotal-tracker (~> 0.5.6)
       term-ansicolor
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.5)
+    activesupport (4.2.5.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -20,7 +20,7 @@ GEM
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    domain_name (0.5.25)
+    domain_name (0.5.20160128)
       unf (>= 0.0.5, < 1.0.0)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
@@ -79,7 +79,7 @@ GEM
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -17,6 +17,8 @@ Install with:
 
 `git jira-branch <issue-id>` - Creates a branch name suggestion from the specified JIRA issue ID. It also writes the branch name as a comment on the issue and allows to transition the issue.
 
+`git jira-pr [--from your-branch] [--to target-branch]` - Open your browser at a Github pull-request page for the specified branch (defaults to the current `head`). If you're using JIRA and your branch has a issue id in its name, populates your pull request with that issue details, else it just creates an empty Pull Request from the current HEAD.
+
 `git latest-pushes [-n NR_RESULTS] [-p PATTERN]` - Show latest pushed branches to origin. Defaults to 20 results. Pattern is appended to refs/remotes/origin/ so include the team or project name to filter results.
 
 `git list-branches [-l] [-r] [-i integration-branch]` - Colourful listing of all local or origin branches, and their distance to an integration branch (`master` by default).

data/bin/git-chop

@@ -0,0 +1 @@
+../libexec/runner.rb

data/bin/git-jira-branch

@@ -14,11 +14,15 @@ require 'jira'
 require 'readline'
 require 'term/ansicolor'
 require 'git-whistles/app'
+require 'git-whistles/jira'
 
 class App < Git::Whistles::App
 
   def initialize
     super
+
+    @jira = Git::Whistles::Jira.new
+    @client = @jira.get_client
   end
 
   def main(args)
@@ -34,7 +38,7 @@ class App < Git::Whistles::App
     # get JIRA Issue info
     issue = get_jira_info(issue_id)
 
-    branch_name_suggested = "#{issue_id.upcase}-#{issue.fields['summary'].downcase}"
+    branch_name_suggested = "#{issue_id.upcase}/#{issue.fields['summary'].downcase}"
     branch_name_suggested.gsub!(/[^\w\d\/]/, '-').gsub!(/-+/, '-')
 
     puts 'The suggested branch name is: ' << Term::ANSIColor.yellow(branch_name_suggested)
@@ -105,50 +109,9 @@ class App < Git::Whistles::App
   end
 
   def get_jira_info(issue_id)
-    if username.empty?
-      puts Term::ANSIColor.yellow %Q{
-        Your branch appears to have a issue ID,
-        but I don't know your JIRA username!
-        Please set it with:
-        $ git config [--global] jira.username <username>
-      }
-      die "Aborting."
-    end
-
-    password = `git config jira.password`.strip
-    if password.empty?
-      puts Term::ANSIColor.yellow %Q{
-        Your branch appears to have a issue ID,
-        but I don't know your JIRA password!
-        Please set it with:
-        $ git config [--global] jira.password <password>
-      }
-      die "Aborting."
-    end
-
-    site = `git config jira.site`.strip
-    if site.empty?
-      puts Term::ANSIColor.yellow %Q{
-        Your branch appears to have a issue ID,
-        but I don't know your JIRA site!
-        Please set it with:
-        $ git config [--global] jira.site <https://mydomain.atlassian.net>
-      }
-      die "Aborting."
-    end
     log.info "Finding your JIRA Issue¬"
 
-    options = {
-      username: username,
-      password: password,
-      site: site,
-      context_path: '',
-      auth_type: :basic,
-      read_timeout: 120
-    }
-
-    client = JIRA::Client.new(options)
-    issue = client.Issue.find(issue_id)
+    issue = @client.Issue.find(issue_id)
 
     log.info '.'
     log.info "Found issue #{issue_id} in '#{issue.fields['project']['name']}'"

data/bin/git-jira-pr

@@ -0,0 +1,164 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+#
+# git-jira-pr --
+#
+#   Open a pull request for the current branch in your default browser
+#
+#   Assumes the branches are named
+#   <team>/<branch-title>-<story-id>
+#
+require 'rubygems'
+require 'jira'
+require 'optparse'
+require 'cgi'
+require 'term/ansicolor'
+require 'git-whistles/app'
+require 'git-whistles/jira'
+
+class App < Git::Whistles::App
+
+  BROWSERS               = %w(xdg-open open firefox iceweasel)
+  SAFE_QUERY_STRING_SIZE = 8000
+
+  def initialize
+    super
+
+    @client = Git::Whistles::Jira.new.get_client
+  end
+
+  def main(args)
+    super
+    parse_args!(args)
+
+    if args.count > 0
+      die "Too many arguments", :usage => true
+    end
+
+    if options.from == options.to
+      die "You cannot issue a pull request to the same branch (#{options.from})."
+    end
+
+    query = { }
+
+    # guess team name
+    if options.from =~ %r{^(\w+-\w+)/.*}
+      team, issue_id = $1.capitalize.split('-')
+    else
+      issue_id = team = nil
+    end
+
+    # guess title.
+    title = options.from.split('/').last.split(/[_-]/).delete_if { |word| word =~ /^\d+$/ }.join(' ').capitalize
+    query[:"pull_request[title]"] = team ? "#{team}: #{title}" : title
+
+    # add Jira infos
+    add_jira_info(query, "#{team}-#{issue_id}".upcase) if issue_id =~ /(\d+)$/
+
+    query_string = query.map { |key,value|
+      "#{CGI.escape key.to_s}=#{CGI.escape value}"
+    }.join('&')
+    url = "https://github.com/#{repo}/compare/#{options.to}...#{options.from}?#{query_string}"
+
+    puts "Preparing a pull request for branch #{options.from}"
+
+    unless launch_browser(url)
+      log.warn "Sorry, I don't know how to launch a web browser on your system. You can open it yourself and paste this URL:\n#{url}"
+    end
+  end
+
+  private
+
+  def defaults
+    {
+      :from   => run!('git symbolic-ref HEAD').strip.gsub(%r(^refs/heads/), ""),
+      :to     => 'master',
+      :remote => 'origin'
+    }
+  end
+
+  def option_parser
+    @option_parser ||= OptionParser.new do |op|
+      op.banner = "Usage: git jira-pr [options]"
+
+      op.on("-f", "--from YOUR_BRANCH", "Branch to issue pull request for [head]") do |v|
+        options.from = v
+      end
+
+      op.on("-to", "--to UPSTREAM_BRANCH", "Branch into which you want your code merged [master]") do |v|
+        options.to = v
+      end
+
+      op.on("-r", "--remote NAME", "The remote you're sending this to [origin]") do |v|
+        options.to = v
+      end
+    end
+  end
+
+  def origin_url
+    @origin_url ||= begin
+      run!("git config --get remote.#{options.remote}.url").strip.tap do |url|
+        url =~ /github\.com/ or die "origin does not have a Github URL !"
+      end
+    end
+  end
+
+  def repo
+    @repo ||= origin_url.sub(/.*github\.com[\/:]/,'').sub(/\.git$/,'')
+  end
+
+  def add_jira_info(query, issue_id)
+    log.info "Finding your Jira Issue¬"
+
+    issue = @client.Issue.find(issue_id)
+    log.info '.'
+
+    if issue.nil?
+      log.warn "Apologies... I could not find issue #{issue_id}."
+      return
+    end
+
+    log.info "Found story #{issue_id} in '#{issue.fields['project']['name']}'"
+
+    title       = "#{issue_id}: #{issue.summary}"
+    headline    = "Jira story [##{issue_id}](#{@client.options[:site]}/browse/#{issue_id}) in project *#{issue.project.name}*:"
+    description = issue.description.split("\n").map do |line|
+      (1..6).each { |i| line.gsub!(/(h#{i}.)/, '#' * i) }
+      line.gsub!(/({{)|(}})/, '`')
+      "> #{line}"
+    end.join("\n")
+
+    query.merge! subject: issue.summary, :"pull_request[title]" => title
+
+    if (headline.length + description.length) > SAFE_QUERY_STRING_SIZE
+      log.warn "Oops looks like your story body exceeds maximum allowed caracters to send a github request"
+      log.warn "Please copy the info below to your pull request body:"
+      puts
+      puts headline
+      puts
+      puts
+      puts description
+      puts
+      puts
+      puts "Press any key to continue..."
+      gets
+      query.merge! :"pull_request[body]" => "Please check your command line for the story body"
+    else
+      body = "TODO: describe your changes\n\n===\n\n#{headline}\n\n#{description}"
+      query.merge! :"pull_request[body]" => body
+    end
+  end
+
+  def launch_browser(url)
+    BROWSERS.each do |command|
+      next if run("which #{command}").strip.empty?
+      system(command, url) and return true
+    end
+    false
+  end
+
+end
+
+############################################################################
+
+App.run!

data/bin/git-list-branches

@@ -0,0 +1 @@
+../libexec/runner.rb

data/bin/git-merge-po

@@ -0,0 +1 @@
+../libexec/runner.rb

data/bin/git-stash-and-checkout

@@ -0,0 +1 @@
+../libexec/runner.rb

data/lib/git-whistles/jira.rb

@@ -0,0 +1,62 @@
+module Git
+  module Whistles
+    class Jira
+      attr_reader :username, :password, :site
+
+      def initialize
+        get_config
+      end
+
+      def get_client(opts = {})
+        options = {
+          username: @username,
+          password: @password,
+          site: @site,
+          context_path: '',
+          auth_type: :basic,
+          read_timeout: 120
+        }
+
+        options.merge!(opts)
+
+        JIRA::Client.new(options)
+      end
+
+      def get_config
+        @username = `git config jira.username`.strip
+        if username.empty?
+          puts Term::ANSIColor.yellow %Q{
+            Your branch appears to have a issue ID,
+            but I don't know your JIRA username!
+            Please set it with:
+            $ git config [--global] jira.username <username>
+          }
+          die "Aborting."
+        end
+
+        @password = `git config jira.password`.strip
+        if password.empty?
+          puts Term::ANSIColor.yellow %Q{
+            Your branch appears to have a issue ID,
+            but I don't know your JIRA password!
+            Please set it with:
+            $ git config [--global] jira.password <password>
+          }
+          die "Aborting."
+        end
+
+        @site = `git config jira.site`.strip
+        if site.empty?
+          puts Term::ANSIColor.yellow %Q{
+            Your branch appears to have a issue ID,
+            but I don't know your JIRA site!
+            Please set it with:
+            $ git config [--global] jira.site <https://mydomain.atlassian.net>
+          }
+          die "Aborting."
+        end
+
+      end
+    end
+  end
+end

data/lib/git-whistles/version.rb

@@ -4,7 +4,7 @@ require 'pathname'
 
 module Git
   module Whistles
-    VERSION = "1.0.2"
+    VERSION = "1.1.0"
     GEMDIR = Pathname.new(__FILE__).parent.parent.parent
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-whistles
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Julien Letessier
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ executables:
 - git-explore
 - git-ff-all-branches
 - git-jira-branch
+- git-jira-pr
 - git-latest-pushes
 - git-list-branches
 - git-merge-po
@@ -155,6 +156,7 @@ files:
 - bin/git-explore
 - bin/git-ff-all-branches
 - bin/git-jira-branch
+- bin/git-jira-pr
 - bin/git-latest-pushes
 - bin/git-list-branches
 - bin/git-merge-po
@@ -168,6 +170,7 @@ files:
 - lib/git-whistles.rb
 - lib/git-whistles/app.rb
 - lib/git-whistles/helpers.rb
+- lib/git-whistles/jira.rb
 - lib/git-whistles/logger.rb
 - lib/git-whistles/version.rb
 - libexec/git-chop.sh
@@ -200,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: 'A few helpers for classic Git workflows: makes branching and merging, PO

data/bin/git-chop

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-#
-# runner.rb --
-#
-#   Run shell scripts from a gem.
-#   Symlink to this script to run a script with the same name living in
-#   libexec/.
-#
-require 'pathname'
-require 'rubygems'
-require 'git-whistles'
-
-target_script = Pathname.new($0).basename
-script_path = Git::Whistles::GEMDIR.join('libexec', "#{target_script}.sh").cleanpath.to_s
-
-Kernel.exec script_path, *ARGV

data/bin/git-list-branches

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-#
-# runner.rb --
-#
-#   Run shell scripts from a gem.
-#   Symlink to this script to run a script with the same name living in
-#   libexec/.
-#
-require 'pathname'
-require 'rubygems'
-require 'git-whistles'
-
-target_script = Pathname.new($0).basename
-script_path = Git::Whistles::GEMDIR.join('libexec', "#{target_script}.sh").cleanpath.to_s
-
-Kernel.exec script_path, *ARGV

data/bin/git-merge-po

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-#
-# runner.rb --
-#
-#   Run shell scripts from a gem.
-#   Symlink to this script to run a script with the same name living in
-#   libexec/.
-#
-require 'pathname'
-require 'rubygems'
-require 'git-whistles'
-
-target_script = Pathname.new($0).basename
-script_path = Git::Whistles::GEMDIR.join('libexec', "#{target_script}.sh").cleanpath.to_s
-
-Kernel.exec script_path, *ARGV

data/bin/git-stash-and-checkout

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-#
-# runner.rb --
-#
-#   Run shell scripts from a gem.
-#   Symlink to this script to run a script with the same name living in
-#   libexec/.
-#
-require 'pathname'
-require 'rubygems'
-require 'git-whistles'
-
-target_script = Pathname.new($0).basename
-script_path = Git::Whistles::GEMDIR.join('libexec', "#{target_script}.sh").cleanpath.to_s
-
-Kernel.exec script_path, *ARGV