git_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0e458481a11751c30773053821dc103dcb20066
+  data.tar.gz: ad109373d0c651babb912fa2a97ff8f247ad9ad8
+SHA512:
+  metadata.gz: b2c2ef68608acf414c38b9acf868c87afa209743c34fc98b87aec3c35a948a398233948132f7957ac2bd272c3362e98f872a85a7b6cab8e2841062c101a89a7b
+  data.tar.gz: 0e4c13416a9498544dcd3e10f8711cc00b8953743ed8da487df4c4a05ffba1bb797d0d8730b6882c86d8263a091a8df03b6821cead0bce96dcfdaed99cbc31db

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+*.gem
+pkg/
+*.swp

data/README.md

@@ -0,0 +1,4 @@
+git_tools
+=========
+
+Additional git commands and rake tasks for various git related goodness.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+
+namespace :gem do
+  desc 'Build the gem'
+  task :build do
+    `mkdir -p pkg`
+    `gem build *.gemspec`
+    `mv *.gem pkg/`
+  end 
+
+  desc 'Publish the gem'
+  task :publish do
+    gem = `ls pkg | sort | tail -n 1`
+    exec("gem push pkg/#{gem}")
+  end 
+
+  desc 'Install the gem locally'
+  task :install do
+    gem = `ls pkg`.split.sort
+    `gem install pkg/#{gem.last}`
+  end 
+end
+
+desc 'Remove generated files'
+task :clean do
+  `rm -rf pkg`
+end

data/git_tools.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "git_tools"
+  s.version     = '0.1.0'
+  s.authors     = ["Birkir A. Barkarson"]
+  s.email       = ["birkirb@stoicviking.net"]
+  s.licenses    = ['MIT']
+  s.homepage    = "https://github.com/birkirb/git_tools"
+  s.summary     = %q{Collection of various handy git commands and tasks.}
+  s.description = %q{Git tools for installing hooks, cleaning up branches and more.}
+
+  s.rubyforge_project = "git_tools"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/git_tools/branches/cleaner.rb

@@ -0,0 +1,237 @@
+require 'git_tools/extensions/time'
+
+module GitTools
+  module Branches
+
+    KEEP_LIST = %w(master develop development testing stable release production)
+    KEEP_BRANCH_FILENAME = File.join(CUSTOM_DIR, 'keep_branches')
+
+    def self.git_keep_branches_from_file
+      if File.exists?(KEEP_BRANCH_FILENAME)
+        File.readlines(KEEP_BRANCH_FILENAME).each { |line| line.strip! }
+      else
+        []
+      end
+    end
+
+    def self.default_keep_list
+      KEEP_LIST + git_keep_branches_from_file
+    end
+
+    class Cleaner
+      MASTER_BRANCH = 'master'
+      DEFAULT_REMOTE = 'origin'
+      AGE_THRESHOLD_IN_MONTHS_FOR_DELETING_REMOTE_BRANCHES_IN_MASTER = 1 * Time::SECONDS_IN_MONTH
+      AGE_THRESHOLD_IN_MONTHS_FOR_DELETING_ANY_UNMERGED_BRANCHES = 6 * Time::SECONDS_IN_MONTH
+
+      attr_reader :master_branch, :remote, :protected_branches
+
+      def self.with_local(master_branch, protected_branches = nil)
+        self.new(nil, master_branch, protected_branches)
+      end
+
+      def self.with_origin(protected_branches = nil)
+        self.new(DEFAULT_REMOTE, nil, protected_branches)
+      end
+
+      public
+
+      def initialize(remote = nil, master_branch = nil, protected_branches = nil)
+        @remote = remote
+        @protected_branches = protected_branches || Branches.default_keep_list
+        @master_branch = master_branch || get_remote_head || MASTER_BRANCH
+        @branches = branches
+
+        if @master_branch.nil?
+          raise "Master branch was not set or determined."
+        else
+          puts "Master branch is #{@master_branch}" if $VERBOSE
+        end
+      end
+
+      def local?
+        @remote.nil?
+      end
+
+      def run!
+        (@branches - protected_branches - [master_branch] ).each do |branch|
+          branch = Branch.new(branch, remote)
+          containing_branches = contained_branches(branch.normalized_name) - [branch.name]
+
+          if protected_branch?(branch.name)
+            puts "#{label_for_remote} branch [#{branch}] is on keep list ( #{kbs.join(" , ")} )" if $VERBOSE
+          elsif in_master_branch?(containing_branches)
+            if delete_branch_merged_to_master_without_confirmation?(branch.age)
+              message = "Removing #{label_for_remote.downcase} branch [#{branch}] since it is in #{master_branch}. [#{branch.age.relative}]"
+              branch.remove!(message)
+            else
+              message = "#{label_for_remote} branch [#{branch}] is in #{master_branch} and could be deleted [#{branch.age.relative}]"
+              branch.confirm_remove(message, "Delete #{branch}?")
+            end
+          elsif delete_unmerged_branch?(branch.age)
+            branch_list = containing_branches.empty? ? '' : "Branch has been merged into:\n  #{containing_branches.join("\n  ")}"
+            message = "#{label_for_remote} branch [#{branch}] is not on #{master_branch}, but old [#{branch.age.relative}]. #{branch_list}"
+            branch.confirm_remove(message, "Delete old unmerged branch: #{branch} ?")
+          else
+            puts "Ignoring unmerged #{label_for_remote.downcase} branch [#{branch}]" if $VERBOSE
+          end
+
+          if defined?($signal_handler)
+            break if $signal_handler.interrupted?
+          end
+        end
+
+        git_remote_prune
+      end
+
+      private
+
+      def git_remote_prune
+        `git remote prune #{remote}` unless local?
+      end
+
+      def label_for_remote
+        local? ? "Local" : "Remote"
+      end
+
+      def branches
+        clean_branches_result(`git branch #{git_argument_for_remote}`)
+      end
+
+      def git_argument_for_remote
+        local? ? '' : ' -r'
+      end
+
+      def get_remote_head
+        (`git branch -r | grep #{remote}/HEAD`).sub(/#{remote}\/HEAD -> #{remote}\//, '').strip
+      end
+
+      def clean_branches_result(branches)
+        bs = branches.to_s.split(/\n/).map { |b| b.strip.sub(/^\s*\*\s*/, '') }
+
+        if local?
+          bs
+        else
+          # technically split out remote branch name (may not be origin) and return as list
+          bs.delete_if { |b| b =~ /HEAD/ }
+          bs.find_all { |b| /^#{remote}\// =~ b }.map { |b| b.sub(/^#{remote}\//, '') }
+        end
+      end
+
+      def contained_branches(branch)
+        # git's --contains param seems to cause this stderr out:
+        #   error: branch 'origin/HEAD' does not point at a commit
+        # piping that to stderr and cleaning out.
+        clean_branches_result(`git branch #{git_argument_for_remote} --contains #{branch} 2>&1`)
+      end
+
+      def in_master_branch?(branch)
+        branch.include?(master_branch)
+      end
+
+      def protected_branch?(branch)
+        protected_branches.include?(branch)
+      end
+
+      def delete_branch_merged_to_master_without_confirmation?(time)
+        if local?
+          true
+        else
+          (Time.now - time) > AGE_THRESHOLD_IN_MONTHS_FOR_DELETING_REMOTE_BRANCHES_IN_MASTER
+        end
+      end
+
+      def delete_unmerged_branch?(time)
+        (Time.now - time) > AGE_THRESHOLD_IN_MONTHS_FOR_DELETING_ANY_UNMERGED_BRANCHES
+      end
+
+    end
+
+    class Branch
+
+      DATE_REGEXP = /^Date:\s+(.*)$/
+
+      def self.age(branch)
+        time = DATE_REGEXP.match(`git log --shortstat --date=iso -n 1 #{branch}`)
+        Time.parse(time[1])
+      end
+
+      def self.executor
+        ActionExecutor.new
+      end
+
+      public
+
+      attr_reader :name, :remote, :age
+
+      def initialize(name, remote)
+        @name = name
+        @remote = remote
+        @age = self.class.age(normalized_name)
+      end
+
+      def normalized_name
+        local? ? name : "#{remote}/#{name}"
+      end
+
+      def remove!(message)
+        self.class.executor.execute(remove_branch_action, message)
+      end
+
+      def confirm_remove(message, prompt)
+        self.class.executor.execute(remove_branch_action, message, prompt)
+      end
+
+      def to_s
+        name
+      end
+
+      private
+
+      def local?
+        remote.nil?
+      end
+
+      def remove_branch_action
+        local? ? "git branch -d #{name}" : "git push #{remote} :#{name}"
+      end
+    end
+
+    class ActionExecutor
+
+      @@test_mode = true
+      @@skip_prompted = false
+
+      def self.test_mode=(value)
+        @@test_mode = (value == true)
+      end
+
+      def self.skip_prompted=(value)
+        @@skip_prompted = (value == true)
+      end
+
+      def execute(command, action_message, confirmation_prompt = nil)
+        if @@test_mode
+          $stderr.puts("#{action_message} -> #{command}")
+        else
+          if confirmation_prompt
+            if @@skip_prompted
+              puts "#{action_message} -> skipping prompts" if $VERBOSE
+            else
+              puts action_message
+              puts "#{confirmation_prompt} [y/N]"
+              case $stdin.gets.chomp
+              when 'y'
+                `#{command}`
+              end
+            end
+          else
+              puts action_message
+            `#{command}`
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/git_tools/extensions/string.rb

@@ -0,0 +1,8 @@
+class String
+  def multi_gsub!(options = {})
+    options.each do |key, value|
+      self.gsub!("{#{key}}", value.to_s)
+    end
+    self
+  end
+end

data/lib/git_tools/extensions/time.rb

@@ -0,0 +1,50 @@
+require 'time'
+require 'git_tools/extensions/string'
+
+class Time
+
+  DAYS_IN_YEAR = 365.2424
+  SECONDS_IN_MINUTE =         60
+  SECONDS_IN_HOUR   =      3_600
+  SECONDS_IN_DAY    =     86_400
+  SECONDS_IN_WEEK   =    604_800
+  SECONDS_IN_YEAR   = 31_556_736 # AVERAGE
+  SECONDS_IN_MONTH  = SECONDS_IN_YEAR/12 # AVERAGE
+
+  HUMAN_TIMES  = [
+    [SECONDS_IN_MINUTE, 120, "minutes"],
+    [SECONDS_IN_HOUR  ,  72, "hours"],
+    [SECONDS_IN_DAY   ,  21, "days"],
+    [SECONDS_IN_WEEK  ,  12, "weeks"],
+    [SECONDS_IN_MONTH ,  12, "months"]
+    #[SECONDS_IN_YEAR  ,  10, "years"]
+  ]
+
+  def relative(t0 = Time.now)
+    dt = self - t0
+
+    if dt < 0
+      tense = 'ago'
+      dt = dt.abs - 1
+    else
+      tense = 'from now'
+    end
+
+    if dt < SECONDS_IN_MINUTE
+      return 'now'.t
+    else
+      HUMAN_TIMES.each do |time|
+        seconds    = time[0]
+        limit      = time[1]
+        time_unit  = time[2]
+
+        if dt < seconds * limit
+          return "{time} #{time_unit} #{tense}".multi_gsub!(:time => (dt/seconds).ceil.to_i)
+        end
+      end
+      # Above the higest limit
+      "over a year #{tense}".t
+    end
+  end
+
+end

data/lib/git_tools/hooks/pre-commit/01_check_keywords_and_conflicts.rb

@@ -0,0 +1,33 @@
+#!/env/ruby
+
+FAILURE = false
+
+diff_lines = `git diff`.split("\n")
+added_lines = diff_lines.select { |line| line =~ /^\+/ }
+
+conflict_markers = ['<<<<<<<', '=======', '>>>>>>>']
+debug_keywords = ['puts', 'debugger']
+
+conflict_lines = added_lines.select do |line|
+  conflict_markers.any? { |marker| line =~ /#{marker}/ }
+end
+debug_lines = added_lines.select do |line|
+  debug_keywords.any? { |keyword| line =~ /\b#{keyword}\b/ }
+end
+
+$stdin.readlines.each { |l| puts l }
+
+if conflict_lines.any?
+  puts "You might be committing changes containing conflict markers, this indicates an unfinished merge"
+  puts "The lines are the following:"
+  conflict_lines.each { |line| puts line }
+end
+if debug_lines.any?
+  puts "You might be committing changes containing debug keywords"
+  puts "The lines are the following:"
+  debug_lines.each { |line| puts line }
+end
+if conflict_lines.any? || debug_lines.any?
+  puts "If you are sure you want to make this commit, commit again with the --no-verify flag"
+  exit(FAILURE)
+end

data/lib/git_tools/hooks/prepare-commit-msg/01_capture_issue_tracker_number_from_branch_name.rb

@@ -0,0 +1,51 @@
+#!/env/ruby
+require 'erb'
+
+message_file = ARGV[0]
+commit_source = ARGV[1]
+# sha1 = ARGV[2]
+
+exit if ['merge', 'commit', 'message'].include? commit_source
+
+working_dir = File.expand_path(File.join(File.dirname(message_file), '..'))
+template_file = File.join(working_dir, '.git_tools', 'templates', 'prepare_commit_msg')
+contents = File.read(message_file)
+
+has_merge_message = contents.match(/^Merge branch/m) # Commit with resolved merge conflicts don't have a commit source.
+exit if has_merge_message
+ticket_no_from_branch_name = contents.scan(/On branch .+#(\d{1,5})/)
+
+if ticket_no_from_branch_name.empty?
+  references = nil
+  default_line = <<-MESSAGE
+#
+# PLEASE ADD THE ISSUE TRACKER NUMBER TO THE BRANCH NAME.
+# Replace these lines with any applicable issue tracker references.
+MESSAGE
+else
+  references = ticket_no_from_branch_name.join(', #')
+  default_line = "Issue tracker: ##{references}"
+end
+
+if File.exists?(template_file)
+  message_template = ERB.new(File.read(template_file), 0, '>').result
+else
+  message_template = <<-MESSAGE
+
+# [Tell us *why* are you committing on the line above.]
+
+# [Details below this line.]
+#{default_line}
+#
+# Check out the following links on how to write proper git messges:
+#
+# http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+# http://robots.thoughtbot.com/post/48933156625/5-useful-tips-for-a-better-commit-message
+#
+MESSAGE
+end
+
+File.open(message_file, 'w') do |file|
+  file.write(message_template.chomp)
+  file.write(contents)
+end

data/lib/git_tools/hooks.rb

@@ -0,0 +1,79 @@
+module GitTools
+  module Hooks
+    GIT_HOOK_INSTALL_LINE_BEGIN = "# BEGIN Ruby git-hooks\n"
+    GIT_HOOK_INSTALL_LINE_END = "# END Ruby git-hooks\n"
+    GIT_HOOK_DIR = File.join('.git', 'hooks')
+    GIT_TOOLS_CUSTOM_HOOKS_DIR = File.join(CUSTOM_DIR, 'hooks')
+    GIT_TOOLS_INCLUDED_HOOKS_DIR = File.join(File.dirname(__FILE__), 'hooks')
+
+    def self.with_git_hook_files
+      if File.exist?(GIT_HOOK_DIR)
+        default_ruby_hooks.merge(custom_ruby_hooks).each do |dir, files|
+          files.each do |file|
+            git_hook = File.join(GIT_HOOK_DIR, file)
+            yield(dir, file, git_hook)
+          end
+        end
+      else
+        puts "Git hook directory not found."
+      end
+    end
+
+    def self.default_ruby_hooks
+      {GIT_TOOLS_INCLUDED_HOOKS_DIR => (Dir.entries(GIT_TOOLS_INCLUDED_HOOKS_DIR) - ['.', '..'])}
+    end
+
+    def self.custom_ruby_hooks
+      if Dir.exists?(GIT_TOOLS_CUSTOM_HOOKS_DIR)
+        {GIT_TOOLS_CUSTOM_HOOKS_DIR => (Dir.entries(GIT_TOOLS_CUSTOM_HOOKS_DIR) - ['.', '..'])}
+      else
+        {}
+      end
+    end
+
+    def self.clear_git_hooks
+      with_git_hook_files do |dir, ruby_hook, git_hook|
+        if File.exists?(git_hook)
+          hook_content = File.read(git_hook)
+          if hook_content.match(/#{GIT_HOOK_INSTALL_LINE_BEGIN}/)
+            puts "Clearing Ruby #{ruby_hook} git-hooks."
+            hook_content.gsub!(/#{GIT_HOOK_INSTALL_LINE_BEGIN}.*#{GIT_HOOK_INSTALL_LINE_END}/m, '')
+            File.open(git_hook, 'w+') do |file|
+              file.write(hook_content)
+            end
+          end
+        end
+      end
+    end
+
+    def self.install_git_hooks
+      with_git_hook_files do |ruby_hook_dir, ruby_hook_file, git_hook|
+        if File.exists?(git_hook)
+          hook_content = File.read(git_hook)
+        else
+          hook_content = "#!/bin/sh\n\n"
+        end
+
+        if hook_content.match(/#{GIT_HOOK_INSTALL_LINE_BEGIN}/)
+          next
+        else
+          puts "Installing Ruby #{ruby_hook_file} git-hooks."
+          hook_commands = ''
+          hook_files = File.join(ruby_hook_dir, ruby_hook_file)
+          puts "Hook file: #{hook_files}" if $VERBOSE
+          Dir.foreach(hook_files) do |file_path|
+            if file_path.match(/\.rb$/)
+              hook_commands += "if [ $? -eq 0 ]; then ruby #{File.join(ruby_hook_dir, ruby_hook_file, file_path)} \"$@\"; else exit 1; fi\n"
+            end
+          end
+          hook_content += "#{GIT_HOOK_INSTALL_LINE_BEGIN}\n#{hook_commands}\n#{GIT_HOOK_INSTALL_LINE_END}"
+          File.open(git_hook, 'w+') do |file|
+            file.write(hook_content)
+          end
+          FileUtils.chmod(0744, git_hook)
+        end
+      end
+    end
+
+  end
+end

data/lib/git_tools.rb

@@ -0,0 +1,8 @@
+module GitTools
+  CUSTOM_DIR = '.git_tools'
+end
+
+if defined?(Rake)
+  load 'tasks/git_tools/hooks.rake'
+  load 'tasks/git_tools/branches.rake'
+end

data/lib/tasks/git_tools/branches.rake

@@ -0,0 +1,30 @@
+require 'git_tools/branches/cleaner'
+
+namespace :git do
+  namespace :branches do
+    # puts $VERBOSE, $-V, $DEBUG, $-W
+    # VERBOSE and DEBUG mode don't seem to be triggered in rake tasks even with RUBYOPTS.
+    # Something turning it off?
+
+    GitTools::Branches::ActionExecutor.test_mode = $DEBUG
+    GitTools::Branches::ActionExecutor.skip_prompted = true
+
+    desc 'Clean up all branches'
+    task(:clean => ['clean:local', 'clean:remote']) do
+    end
+
+    namespace :clean do
+      desc 'Clean up local branches'
+      task :local do
+        GitTools::Branches::Cleaner.with_local('stable').run!
+      end
+
+      desc 'Clean up remote branches'
+      task :remote do
+        # TODO: Handle non origin
+        GitTools::Branches::Cleaner.with_origin.run!
+      end
+
+    end
+  end
+end

data/lib/tasks/git_tools/hooks.rake

@@ -0,0 +1,21 @@
+require 'git_tools/hooks'
+
+namespace :git do
+  namespace :hooks do
+    desc "Clear any installed git-hooks"
+    task :clear do
+      GitTools::Hooks.clear_git_hooks
+    end
+
+    desc "Install all git-hooks"
+    task :install do
+      GitTools::Hooks.install_git_hooks
+    end
+
+    desc "Re-install all git-hooks"
+    task :reinstall do
+      GitTools::Hooks.clear_git_hooks
+      GitTools::Hooks.install_git_hooks
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: git_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Birkir A. Barkarson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies: []
+description: Git tools for installing hooks, cleaning up branches and more.
+email:
+- birkirb@stoicviking.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- Rakefile
+- git_tools.gemspec
+- lib/git_tools.rb
+- lib/git_tools/branches/cleaner.rb
+- lib/git_tools/extensions/string.rb
+- lib/git_tools/extensions/time.rb
+- lib/git_tools/hooks.rb
+- lib/git_tools/hooks/pre-commit/01_check_keywords_and_conflicts.rb
+- lib/git_tools/hooks/prepare-commit-msg/01_capture_issue_tracker_number_from_branch_name.rb
+- lib/tasks/git_tools/branches.rake
+- lib/tasks/git_tools/hooks.rake
+homepage: https://github.com/birkirb/git_tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: git_tools
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Collection of various handy git commands and tasks.
+test_files: []