git_cleaner 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Leigh Caplan
+
+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.rdoc

@@ -0,0 +1,17 @@
+= git_cleaner
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Leigh Caplan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "git_cleaner"
+    gem.summary = %Q{Automatic cleanup of Git branches– with Lighthouse integration!}
+    gem.description = %Q{Git Cleaner allows you to easily remove stale branches based on a number of factors, such as date modified, branch name, and even Lighthouse ticket state.}
+    gem.email = "lcaplan@onehub.com"
+    gem.homepage = "http://github.com/onehub/git_cleaner"
+    gem.authors = ["Leigh Caplan"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency 'lighthouse-api', '>= 1.1.0'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "git_cleaner #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/git_cleaner

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/git_cleaner")
+
+begin
+  GitCleaner.new.cleanup
+rescue Interrupt => i
+  puts "\rThank you for using Git Cleaner!"
+rescue Exception => e
+  puts "Quitting Git Cleaner due to error: #{e.message}"
+  puts e.backtrace
+end

data/lib/git_cleaner.rb

@@ -0,0 +1,192 @@
+require 'rubygems'
+require 'lighthouse'
+require 'optparse'
+require 'ostruct'
+
+class GitCleaner
+  CONFIG_FILE = '.git_cleaner'
+  
+  attr_accessor :project_name
+
+  def initialize
+    if File.exist?("./#{CONFIG_FILE}")
+      @config = YAML.load_file("./#{CONFIG_FILE}")
+      
+      if @config['lighthouse']
+        Lighthouse.token    = @config['lighthouse']['token']
+        Lighthouse.account  = @config['lighthouse']['account']
+        self.project_name   = @config['lighthouse']['project']
+      end
+    else
+      # We might want to warn here if there's no config file at all. Right now it's not a big deal.
+    end
+    
+    @options = {:rules => {}}
+    
+    OptionParser.new do |opts|
+      opts.banner = "Usage: git_cleanup --remote"
+
+      opts.on('-r', '--remote', 'Clean up remote branches') do |f|
+        @options[:mode] = 'remote'
+      end
+
+      opts.on('-l', '--local', 'Clean up local branches') do
+        @options[:mode] = 'local'
+      end
+      
+      opts.on('-t', '--test', 'Test mode - no changes will be made') do
+        @options[:test_mode] = true
+      end
+      
+      opts.on('-b', '--before date', 'Automatically delete branches last updated before') do |date|
+        @options[:rules].merge!(:before => eval(date))
+      end
+      
+      opts.on('-s', '--state ticket_state', 'Automatically delete branches corresponding to a Lighthouse ticket state') do |state|
+        puts "#{CONFIG_FILE} with Lighthouse token, account, and project are required to match on ticket state" and exit unless Lighthouse.token && Lighthouse.account && project_name
+        @options[:rules].merge!(:state => state)
+      end
+      
+      opts.on('-m', '--matching string', 'Automatically delete branches with names matching the string') do |string|
+        @options[:rules].merge!(:matching => string)
+      end
+    end.parse!
+  end
+
+  def get_project(name)
+    projects = Lighthouse::Project.find(:all)
+    project  = projects.find {|pr| pr.name == name}
+  end
+
+  def prune_these(local_or_remote, branches)
+    project = get_project(project_name)
+
+    branches.each do |branch|
+      branch_info = OpenStruct.new(:string => branch, :local_or_remote => local_or_remote)
+      
+      puts "#{branch_info.string} (updated #{branch_modified(branch_info, :time_ago_in_words)})"
+
+      if project
+        get_lighthouse_status(branch_info, project)
+        puts branch_info.lighthouse_message
+      end
+      
+      if @options[:rules].empty?
+        print "keep [return], delete [d]: "
+        user_input = gets
+        user_input.strip!
+
+        case user_input
+        when 'd'
+          send "delete_#{local_or_remote}", branch_info
+        end
+
+        puts "\n"
+      else
+        rules_matched = @options[:rules].map do |rule_name, rule_body|
+          send "match_#{rule_name}", branch_info, rule_body
+        end
+
+        send "delete_#{local_or_remote}", branch_info if rules_matched.all?
+        puts "\n"
+      end
+    end
+  end
+  
+  def branch_modified(branch_info, format = :time_ago_in_words)      
+    format_string =
+      case format
+      when :time_ago_in_words
+        "%ar"
+      when :absolute
+        "%aD"
+      end
+      
+    `git show --pretty=format:#{format_string} #{branch_info.string}`.split("\n")[0]
+  end
+  
+  # git_cleanup --before 1.month.ago
+  def match_before(branch_info, date)
+    last_updated = Time.parse(branch_modified(branch_info, :absolute))
+    last_updated < date
+  rescue
+    false
+  end
+  
+  # git_cleanup --state resolved
+  def match_state(branch_info, state)
+    branch_info.lighthouse_state == state
+  end
+  
+  # git_cleanup --matching hotfix
+  def match_matching(branch_info, string)
+    branch_info.string =~ /#{string}/
+  end
+
+  def delete_local(branch_info)
+    execute "git branch -D #{branch_info.string}"
+  end
+
+  def delete_remote(branch_info)
+    branch_info.string.gsub!(/(remotes\/)|(origin\/)/, '')
+    execute "git push origin :#{branch_info.string}", "git remote prune origin"
+  end
+  
+  def execute(*instructions)
+    if test_mode?
+      puts "Test mode - The following instructions would be executed"
+      
+      instructions.each do |instruction|
+        puts instruction
+      end
+    else
+      instructions.each do |instruction|
+        system instruction
+      end
+    end
+  end
+
+  def get_lighthouse_status(branch_info, project)
+    lighthouse_id = 
+      (matches = branch_info.string.match(/(^|\/)(\d+)-/)) ? matches[2] : nil
+
+    if lighthouse_id
+      tickets = project.tickets :q => lighthouse_id
+      ticket  = tickets.first
+      
+      if ticket
+        branch_info.lighthouse_state = ticket.state
+        branch_info.lighthouse_message = "Lighthouse Info:\nTicket ##{lighthouse_id} state - #{ticket.state}"
+        return
+      end
+    end
+    
+    branch_info.lighthouse_message = "No Lighthouse Info."
+  rescue StandardError => e
+    puts "Unable to connect to Lighthouse"
+  end
+
+  def cleanup
+    branches = `git branch -a`.split.reject { |name| name == "*" }
+
+    local_branches = branches.select do |branch|
+      !(branch =~ /^remotes\/origin/)
+    end
+
+    remote_branches = branches.select do |branch|
+      !local_branches.include?(branch)
+    end
+
+    local_or_remote = @options[:mode]
+
+    if local_or_remote == 'local'
+      prune_these(local_or_remote, local_branches)
+    else
+      prune_these(local_or_remote, remote_branches)
+    end
+  end
+  
+  def test_mode?
+    @options[:test_mode]
+  end
+end

data/spec/git_cleaner_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "GitCleaner" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'git_cleaner'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: git_cleaner
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Leigh Caplan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-02 00:00:00 -07:00
+default_executable: git_cleaner
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: lighthouse-api
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+description: Git Cleaner allows you to easily remove stale branches based on a number of factors, such as date modified, branch name, and even Lighthouse ticket state.
+email: lcaplan@onehub.com
+executables: 
+- git_cleaner
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/git_cleaner
+- lib/git_cleaner.rb
+- spec/git_cleaner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/onehub/git_cleaner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: "Automatic cleanup of Git branches\xE2\x80\x93 with Lighthouse integration!"
+test_files: 
+- spec/git_cleaner_spec.rb
+- spec/spec_helper.rb