jiragit 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c227df23b5b4a750360a0e4c071e33350fb9cce3
+  data.tar.gz: 5dbc5bebb53abb4fc137e2f6239528b2659a5e31
+SHA512:
+  metadata.gz: 89dee5bc0243afa9887a7d5583c71325f101e078f2dda969d9c36a82cea3653db2acbd554e3044490e7f5c40cc07c877d0a35326b53f8ba2dd245ee7bcce61a0
+  data.tar.gz: 714bd81531c4661ea27d916feed9af42f053fb2b6fad1db955fd6d6a2a2724c59ce13f63cd1d320be5a513fe3209db530393b6a9062fbb28f2506954941bc582

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Derrick Parkhurst
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# Jiragit
+
+  A gem to smooth the integration of JIRA and Git in a common software development workflow. Jiragit automates the insertion of JIRA numbers and hyperlinks into Git commits, and provides a tool useful for accessing JIRA and Github while working on the command line. Pronounced 'drag it'.
+
+## Context
+
+  JIRA is an online service used by software development teams to track software issues as well as plan and track software development work. Each issue is assigned a number, for example PA-12345. Issues include a title, a description, user comments as well as a number of other customizable data fields. JIRA can integrate with Github. Github is an online service that provides Git repository hosting as well as a suite of software management tools, including code reviews and issue tracking. When integrated, JIRA can track pull requests and commits pushed to Github and relate them to JIRA issue numbers when the pull request description or the commit messages contain a JIRA issue number. This integration is useful in many ways, including for historical code analysis.
+
+  A frequently used workflow for automatically including JIRA issue numbers into commit messages is to take advantage of [Git repository hooks](http://git-scm.com/book/en/Customizing-Git-Git-Hooks). With the [appropriate hook installed](https://bitbucket.org/tpettersen/prepare-commit-msg-jira) into a repository, and a Git branch name that begins with a JIRA issue number, the JIRA number will be prepended to all commit messages made on that branch. JIRA will thus recognize the relation between the commit and the JIRA when the commit is pushed to Github, and the JIRA issue will be updated with a reference to the commit automatically.
+
+  While this workflow automates the insertion of JIRA numbers into commit messages, it has three negative side affects on Git usage. First, JIRA numbers, being serially determined, can be hard for a developer to remember, especially when multitasking on multiple issues or working in a repository shared by many developers. Beginning a branch name with a JIRA issue number requires developers to recall an arbitrary JIRA issue number while working and thus places an unnecessary cognitive burden on the developer. Second, JIRA numbers without links to the JIRA content, force the developer to take the extra steps of accessing the JIRA issue through an online search. Third, the JIRA issue numbers use up precious space in the title of the commit message and dilute the usefulness of many Git tools that only or preferentially report the first line of each commit message.
+
+## Solution
+
+Install the jiragit gem (globally)
+```
+$ gem install jiragit
+```
+Configure your JIRA URL
+```
+$ jiragit configure jira_url https://yourcompany.atlassian.net
+```
+Use jiragit to install the custom Git hooks into your repository
+```
+$ cd repository
+$ jiragit install
+```
+When creating a feature branch, choose a name that you will be able to easily remember, such as a short word phrase. It is always easier to remember branch names that you create yourself and that are meaningful:
+```
+$ git checkout -b improve-one-click-purchase-form
+Switched to a new branch 'improve-one-click-purchase-form'
+What is the JIRA Number? []>
+```
+Then enter the JIRA number that describes this work, for example PA-12345.
+```
+$ git checkout -b improve-one-click-purchase-form
+Switched to a new branch 'improve-one-click-purchase-form'
+What is the JIRA Number? []> PA-12345
+```
+Jiragit will remember the relationship between the Git branch name and the JIRA number. When you go to create a new commit Jiragit will automiatically insert
+the JIRA issue number and a hyperlink to the end of the body of the commit message.
+```
+$ git commit -m 'revised the form layout by updating the css'
+[improve-one-click-purchase-form 3fde944] revised the form layout by updating the css
+ 1 file changed, 0 insertions(+), 0 deletions(-)
+ create mode 100644 form.css
+
+$ git log -1
+commit 3fde94467d55bff68e78d05324ead6687b4127ce
+Author: Derrick Parkhurst <derrick.parkhurst@gmail.com>
+Date:   Mon Sep 8 17:49:14 2014 -0500
+
+    revised the form layout by updating the css
+
+    PA-12345: https://yourcompany.atlassian.net/browse/PA-12345
+
+```
+Once you push this commit to Github, JIRA will recognize this commit as belonging to the JIRA issue because the JIRA/Github integration searches the entire body of the commit message for JIRA issue numbers.
+
+Jiragit also provides a convenient way to navigate to JIRA issues via the command line. You can view the JIRA for the current branch in your browser:
+```
+$ jiragit browse jira
+```
+or view a specified JIRA in your browser
+```
+$ jiragit PA-54321
+```
+
+Jiragit also provides a convenient way to navigate to branches on Github via the command line. You can view the Github page for the current branch in your browser:
+```
+$ jiragit browse
+```
+or view the specified branch in your browser
+```
+$ jiragit browse improve-one-click-purchase-form
+```
+
+## Requirements
+
+* JIRA - http://www.atlassian.com/software/jira
+* Github - http://github.com
+* Git - http://git-scm.com/
+* Ruby - https://www.ruby-lang.org/en/
+
+## Tested on
+
+* Mac OS X 10.8 - Ruby MRI 2.1.0
+
+## License
+
+Copyright (c) 2014 Derrick Parkhurst derrick.parkhurst@gmail.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :gem do
+
+  task :build do
+    `gem build jiragit.gemspec`
+  end
+
+  task :install => [:build] do
+    `gem install pkg/jiragit-1.0.0.gem`
+  end
+
+end

data/bin/jiragit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'jiragit'
+
+Jiragit::Cli.new(ARGV)

data/hooks/commit-msg

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+require 'jiragit'
+
+@log = Jiragit::Logger.new(".git/jiragit/hooks.log")
+@log.hook = File.basename $0
+@log.level = Logger::DEBUG
+
+@log.debug "launched"
+
+STDIN.reopen('/dev/tty')
+
+def commit_message_filename
+  ARGV[0]
+end
+
+def commit_message
+  message = File.read(commit_message_filename)
+  @log.debug "#{__method__}\n#{message}"
+  message
+end
+
+def query(message, default=nil)
+  if default
+    print "#{message} [#{default}]> "
+  else
+    print "#{message} > "
+  end
+  response = STDIN.gets.chomp
+  if response.empty? && default
+    default
+  else
+    response
+  end
+end
+
+def message(message)
+  puts message
+  @log.debug message
+end
+
+def fail(message)
+  error_message = "Commit rejected: #{message}"
+  @log.debug error_message
+  $stderr.puts error_message
+
+  response = query("Edit commit message?", "yes")
+  if response[0].downcase == 'y'
+    root_dir = Jiragit::Git.repository_root
+    hook_dir = ".git/hooks"
+    exec("cd #{root_dir}; $GIT_EDITOR '#{commit_message_filename}'; #{hook_dir}/commit-msg '#{commit_message_filename}'")
+  else
+    $stderr.puts "Commit aborted"
+    exit 1
+  end
+
+end
+
+def enforce_a_title(line = "")
+  return unless line.length == 0
+  fail "The title of the commit message must be present"
+end
+
+def enforce_title_length(line)
+  return unless line.length > 50
+  fail "The title of the commit message must be no longer than 50 characters"
+end
+
+def enforce_body_length(line)
+  return unless line.length > 72
+  fail "Lines in the body of the commit message must be no longer than 72 characters"
+end
+
+def enforce_blank_line(line)
+  return unless line.length > 0
+  fail "The commit title and body must be separated by a single blank line"
+end
+
+def enforce_commit_message_length
+  lines = commit_message.split(/\n/)
+  title = lines.shift
+  enforce_a_title(title)
+  enforce_title_length(title)
+  puts lines
+  enforce_blank_line(lines.shift) if lines.any?
+  lines.each { |line| enforce_body_length(line) } if lines.any?
+end
+
+enforce_commit_message_length
+

data/hooks/post-checkout

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+require 'jiragit'
+
+@log = Jiragit::Logger.new(".git/jiragit/hooks.log")
+@log.hook = File.basename $0
+@log.level = Logger::DEBUG
+
+@log.debug "launched"
+
+STDIN.reopen('/dev/tty')
+
+def previous_head
+  ARGV[0]
+end
+
+def new_head
+  ARGV[1]
+end
+
+def branch_switch?
+  ARGV[2] == '1'
+end
+
+def current_branch
+  Jiragit::Git.current_branch
+end
+
+def previous_branch
+  Jiragit::Git.previous_branch
+end
+
+def new_branch?
+  current_branch != previous_branch
+end
+
+def detached_head
+  current_branch==''
+end
+
+def master_branch
+  current_branch=='master'
+end
+
+def query(message, default=nil)
+  if default
+    print "#{message} [#{default}]> "
+  else
+    print "#{message} > "
+  end
+  response = STDIN.gets.chomp
+  if response.empty? && default
+    default
+  else
+    response
+  end
+end
+
+def message(message)
+  puts message
+  @log.debug message
+end
+
+def jira_store
+  @jira_store ||= Jiragit::JiraStore.new(".git/jiragit/jira_store")
+end
+
+def related_jiras(params)
+  jira_store
+    .relations(params)
+    .to_a
+    .select { |r| r.type == :jira }
+    .map(&:label)
+end
+
+def relate_jiras_to_current_branch(jiras)
+  return if jiras.empty?
+  jiras.gsub(/\s/,'').split(',').each do |jira|
+    jira_store.relate(jira: jira, branch: current_branch) unless jira.empty?
+  end
+end
+
+def message_jiras_related_to_current_branch
+  message("JIRA(s): #{related_jiras(branch: current_branch).join(', ')}")
+end
+
+def query_for_related_jiras
+  default = related_jiras(branch: previous_branch).join(', ') if new_branch?
+  query("What is the JIRA Number?", default)
+end
+
+exit(1) if detached_head || master_branch
+
+if related_jiras(branch: current_branch).any?
+
+  message_jiras_related_to_current_branch
+
+else
+
+  jiras = query_for_related_jiras
+  relate_jiras_to_current_branch(jiras)
+
+end
+
+
+
+

data/hooks/post-commit

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'jiragit'
+
+@log = Jiragit::Logger.new(".git/jiragit/hooks.log")
+@log.hook = File.basename $0
+@log.level = Logger::DEBUG
+
+@log.debug "launched"
+
+def current_branch
+  @current_branch ||= begin
+    branch = Jiragit::Git.current_branch
+    @log.debug "#{__method__} #{branch}"
+    branch
+  end
+end
+
+def current_commit
+  @current_commit ||= begin
+    commit = Jiragit::Git.current_commit
+    @log.debug "#{__method__} #{commit}"
+    commit
+  end
+end
+
+def jira_store
+  @jira_store ||= Jiragit::JiraStore.new(".git/jiragit/jira_store")
+end
+
+def related_jiras(params)
+  jira_store
+    .relations(params)
+    .to_a
+    .select { |r| r.type == :jira }
+    .map(&:label)
+end
+
+def relate_commit_to_current_branch
+  jira_store.relate(commit: current_commit, branch: current_branch)
+end
+
+def relate_commit_to_jiras_for_current_branch
+  related_jiras(branch: current_branch).each do |jira|
+    jira_store.relate(jira: jira, commit: current_commit)
+  end
+end
+
+relate_commit_to_current_branch
+relate_commit_to_jiras_for_current_branch
+

data/hooks/prepare-commit-msg

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+
+require 'jiragit'
+
+@log = Jiragit::Logger.new(".git/jiragit/hooks.log")
+@log.hook = File.basename $0
+@log.level = Logger::DEBUG
+
+@log.debug "launched"
+
+@config = Jiragit::Configuration.new("#{`echo ~`.chomp}/.jiragit")
+
+STDIN.reopen('/dev/tty')
+
+def commit_source
+  ARGV[1]
+end
+
+def commit_message
+  message = File.read(ARGV[0])
+  @log.debug "#{__method__}\n#{message}"
+  message
+end
+
+def write_commit_message(message)
+  @log.debug "#{__method__}\n#{message}"
+  File.write(ARGV[0], message)
+end
+
+def specified_commit_message_on_command_line?
+  @log.debug "#{__method__} #{commit_source == 'message'}"
+  commit_source == 'message'
+end
+
+def has_existing_commit_message?
+  @log.debug "#{__method__} #{commit_source == 'commit'}"
+  commit_source == 'commit'
+end
+
+def is_a_merge_commit?
+  @log.debug "#{__method__} #{commit_source == 'merge'}"
+  commit_source == 'merge'
+end
+
+def is_a_squash_commit?
+  @log.debug "#{__method__} #{commit_source == 'squash'}"
+  commit_source == 'squash'
+end
+
+def should_modify_commit_message?
+  modify = !(has_existing_commit_message? || is_a_squash_commit?)
+  @log.debug "#{__method__} #{modify}"
+  modify
+end
+
+def current_branch
+  branch = Jiragit::Git.current_branch
+  @log.debug "#{__method__} #{branch}"
+  branch
+end
+
+def merge_branch
+  commit_message.match(/Merge branch '(.*?)'/)
+  @log.debug "#{__method__} #{$1}"
+  $1
+end
+
+def jira_store
+  @jira_store ||= Jiragit::JiraStore.new(".git/jiragit/jira_store")
+end
+
+def related_jiras(params)
+  jira_store
+    .relations(params)
+    .to_a
+    .select { |r| r.type == :jira }
+    .map(&:label)
+end
+
+def add_to_commit_message(line="")
+  message = commit_message
+  message.insert(message.index('#') || -1,line+"\n")
+  write_commit_message(message)
+end
+
+def add_jiras_to_commit_message
+  jiras = related_jiras(branch: current_branch)
+  return if jiras.empty?
+
+  add_to_commit_message
+  jiras.each do |jira|
+    add_to_commit_message formatted_jira(jira)
+  end
+  add_to_commit_message
+end
+
+def add_merge_jiras_to_commit_message
+  jiras = related_jiras(branch: merge_branch)
+  return if jiras.empty?
+
+  add_to_commit_message "Merged JIRA(s)"
+  jiras.each do |jira|
+    add_to_commit_message formatted_jira(jira)
+  end
+  add_to_commit_message
+end
+
+def add_jiras_to_commit_message
+  jiras = related_jiras(branch: current_branch)
+  return if jiras.empty?
+
+  jiras.each do |jira|
+    add_to_commit_message formatted_jira(jira)
+  end
+  add_to_commit_message
+end
+
+def add_line_length_guide
+  add_to_commit_message "\n#------------------------------------------------#---------------------#"
+end
+
+def formatted_jira(jira)
+  if @config.include?(:jira_url) && !@config[:jira_url].empty?
+    "#{jira}: #{@config[:jira_url]}/browse/#{jira}"
+  else
+    jira
+  end
+end
+
+exit(0) unless should_modify_commit_message?
+
+case
+when specified_commit_message_on_command_line?
+  add_to_commit_message
+  add_jiras_to_commit_message
+
+when is_a_merge_commit?
+  add_jiras_to_commit_message
+  add_merge_jiras_to_commit_message
+
+else
+  add_line_length_guide
+  add_jiras_to_commit_message
+end