buildmeister 0.8.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-02-24
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/buildmeister
+bin/git_cleanup
+config/buildmeister_config.sample.yml
+lib/buildmeister.rb
+lib/git_cleanup.rb
+test/test_buildmeister.rb

data/README.rdoc

@@ -0,0 +1,70 @@
+= Buildmeister
+
+Managing your build process is fun and easy!
+
+== Description
+
+Buildmeister provides some simple utilities for managing a small team's build process
+using Lighthouse and Github.
+
+== Features
+
+- Growl notification of updated build status
+- Utility scripts to move batch move tickets
+- A very handy utility for pruning local and remote git branches
+
+== Examples
+  # To start periodically updated growl notifications...
+  $ buildmeister notify
+  
+  # To move all tickets in a bin to a particular state...
+  $ buildmeister move_all --from-bin "Staged" --to-state "verified"
+  
+  # Clean up local git branches
+  $ git_cleanup local
+  
+  # Clean up git branches on origin
+  $ git_cleanup remote
+
+== Requirements
+
+Depends on texel-lighthouse-api, activesupport, and growlnotify.
+
+== Install
+
+- Download and install Growl from http://growl.info/
+- sudo gem install texel-buildmeister
+- Use the included config/buildmeister_config.sample.yml file as a guide to creating your own configuration file.
+The file should be called ".buildmeister_config.yml", and be placed in your home directory.
+
+== TODO
+  
+- Generalize remote git cleanup so that it doesn't explicitly refer to origin
+- Break Lighthouse Utilities out into their own gem
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Onehub
+
+http://onehub.com
+
+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,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/buildmeister.rb'
+
+Hoe.new('buildmeister', Buildmeister::VERSION) do |p|
+  p.rubyforge_name = 'buildmeister' # if different than lowercase project name
+  p.developer('Leigh Caplan', 'lcaplan@onehub.com')
+end
+
+task :cultivate do
+  system "touch Manifest.txt; rake check_manifest | grep -v \"(in \" | patch"
+  system "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec"
+end
+
+# vim: syntax=Ruby

data/bin/buildmeister

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/buildmeister")
+
+begin
+  Buildmeister.new.send ARGV.shift
+rescue Interrupt => i
+  Buildmeister.post_notification("Buildmeister Shut Down", "Goodbye!")
+  puts "\rThank you for using Buildmeister!"
+rescue Exception => e
+  Buildmeister.post_notification("Buildmeister Error: #{e.class}", e.message)
+  puts "Quitting Buildmeister due to error: #{e.message}"
+  puts e.backtrace
+end

data/bin/git_cleanup

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

data/config/buildmeister_config.sample.yml

@@ -0,0 +1,16 @@
+token: Your Lighthouse token
+account: Your Lighthouse account name
+project_name: Your Lighthouse project name
+
+bin_groups:
+  - staging:
+    - Ready
+    - Staged
+    - Verified
+    
+  - master:
+    - Ready (Experimental)
+    - Staged (Experimental)
+    - Verified (Experimental)
+
+notification_interval: 5

data/lib/buildmeister.rb

@@ -0,0 +1,276 @@
+require 'rubygems'
+require 'lighthouse'
+require 'activesupport'
+require 'optparse'
+
+class Buildmeister
+  attr_accessor :project, :project_name, :bin_groups, :notification_interval
+  
+  def initialize
+    @options = {}
+    OptionParser.new do |opts|
+      opts.banner = "Usage: buildmeister notify"
+
+      opts.on('-f', '--from-bin BIN_NAME', 'Move From Bin') do |f|
+        @options[:move_from] = f
+      end
+
+      opts.on('-t', '--to-state STATE', 'Move to State') do |t|
+        @options[:to_state] = t
+      end
+      
+      opts.on('-v', '--verbose', 'Verbose') do |t|
+        @options[:verbose] = true
+      end
+    end.parse!
+    
+    @config = Buildmeister.load_config
+    Lighthouse.account  = @config['account']
+    Lighthouse.token    = @config['token']
+    
+    self.project_name   = @config['project_name']
+    self.get_project
+    self.bin_groups     = []
+    
+    self.notification_interval = @config['notification_interval']
+    
+    @config['bin_groups'].each do |bin_group|
+      self.bin_groups << {
+        :name       => bin_group.keys.first,
+        :bin_names  => bin_group.values.first.map
+      }
+    end
+    
+    self.bin_groups.each do |bin_group|
+      bin_group[:bin_names].each do |bin_name|
+        class << bin_name
+          def normalize
+            Buildmeister.normalize_bin_name(self)
+          end
+        end
+        
+        attr_accessor_init = <<-eos
+          class << self
+            attr_accessor :"#{bin_name.normalize}", :"last_#{bin_name.normalize}"
+          end
+        eos
+        
+        eval attr_accessor_init
+      end
+    end
+        
+    load_project
+  end
+  
+  def normalize(bin_name)
+    Buildmeister.normalize_bin_name(bin_name)
+  end
+  
+  def new_hotfix
+    generate_timed_branch('hotfix')
+  end
+  
+  def new_experimental
+    generate_timed_branch('experimental')
+  end
+  
+  def generate_timed_branch(prefix)
+    branches = local_branches
+    now      = Time.now
+    count    = 1
+    
+    loop do
+      new_branch_name = "#{prefix}-#{now.year}-#{now.month.to_s.rjust 2, '0'}-#{now.day.to_s.rjust 2, '0'}-#{count.to_s.rjust 3, '0'}"
+      unless branches.include? new_branch_name
+        `git checkout -b #{new_branch_name}`
+        puts "Created #{new_branch_name}"
+        return true
+      end
+      
+      count += 1
+    end
+  end
+  
+  def pull_bin(bin_name = ARGV.shift)
+    bin_name            = normalize(bin_name)
+    existing_bin_names  = bin_names.map { |b| b.normalize }
+    
+    raise ArgumentError, "#{bin_name} is not a valid bin! Must be in #{bin_names.join(', ')}" unless existing_bin_names.include?(bin_name)
+    
+    `git fetch origin`
+    
+    branches        = remote_branches
+    ticket_numbers  = send(normalize(bin_name)).tickets.map { |tkt| tkt.id.to_s }
+    
+    branches_to_pull = branches.select do |branch_name|
+      ticket_numbers.map { |tkt_number| branch_name =~ /#{tkt_number}/ }.any?
+    end
+    
+    branches_to_pull.each do |branch|
+      result = `git pull origin #{branch.gsub("origin/", "")}`
+      puts result
+    end
+  end
+  
+  def local_branches
+    `git branch`.split.reject { |name| name == "*" }
+  end
+  
+  def remote_branches
+    `git branch -r`.split.reject { |name| name == "*" }
+  end
+  
+  def current_branch
+    branches = `git branch`.split
+    i = branches.index "*"
+    branches[i + 1]
+  end
+  
+  def move_all
+    bin_name = normalize @options[:move_from]
+    self.send(bin_name).tickets.each do |ticket|
+      ticket.state = @options[:to_state]
+      ticket.save
+    end
+    
+    puts "All tickets from bin #{@options[:move_from]} have been moved to #{@options[:to_state]}"
+  end
+  
+  def bin_group_report(bin_group_name = normalize(ARGV.shift))
+    bin_group = bin_groups.find { |group| group[:name] == bin_group_name }
+    bin_names = bin_group[:bin_names].map &:normalize
+    
+    ticket_numbers = bin_names.map do |bin_name|
+      send(normalize(bin_name)).tickets.map &:id
+    end.flatten
+    
+    # Pluck the relevant branch names using git...
+    relevant_branches = 
+      remote_branches.select do |branch_name|
+        ticket_numbers.map { |tkt_number| branch_name =~ /#{tkt_number}/ }.any?
+      end.map { |b| b.gsub('origin/', '') }
+      
+    output = ""
+    output << "#{current_branch}\n"
+    relevant_branches.each do |branch|
+      output << "\n#{branch}"
+    end
+    
+    puts output
+  end
+  
+  def resolve_verified
+    self.verified.tickets.each do |ticket|
+      ticket.state = 'resolved'
+      ticket.save
+    end
+  end
+  
+  def stage_all
+    self.ready.tickets.each do |ticket|
+      ticket.state = 'staged'
+      ticket.save
+    end
+  end
+  
+  def load_project
+    bins  = self.get_project.bins
+    
+    self.bin_groups.each do |bin_group|
+      bin_group[:bin_names].each do |bin_name|
+        self.send("#{bin_name.normalize}=", bins.find { |bin| bin.name == bin_name })
+        
+        class << self.send("#{bin_name.normalize}")
+          attr_accessor :display_value
+        end
+      end
+    end
+  end
+  
+  def reload_info
+    bin_names.each do |bin_name|
+      send("last_#{bin_name.normalize}=", display_value(bin_name))
+    end
+
+    self.load_project
+  end
+  
+  def bin_names
+    bin_groups.map do |bin_group|
+      bin_group[:bin_names].map do |bin_name|
+        bin_name
+      end
+    end.flatten
+  end
+  
+  def changed?
+    bin_names.map { |bin_name| display_value(bin_name) } != bin_names.map { |bin_name| send("last_#{bin_name.normalize}") }
+  end
+  
+  def get_project
+    self.project ||= Lighthouse::Project.find(:all).find {|pr| pr.name == project_name}
+  end
+  
+  def notify
+    puts "Starting BuildMeister Notify..."
+
+    loop do  
+      title = "BuildMeister: #{Time.now.strftime("%m/%d %I:%M %p")}"
+
+      body = ''
+
+      bin_groups.each do |bin_group|
+        body += "#{bin_group[:name].titleize}\n"
+        body += "---------\n"
+
+        bin_group[:bin_names].each do |bin_name|
+          body += "#{bin_name}: #{display_value(bin_name)}\n"
+        end
+
+        body += "\n"
+      end
+
+      puts "Updated notification at #{Time.now.strftime("%m/%d %I:%M %p")}"
+
+      if changed?
+        Buildmeister.post_notification(title, body)   
+      end
+
+      sleep notification_interval.minutes.to_i
+      
+      reload_info
+    end
+  end
+  
+  def display_value(bin_name)
+    # We're memoizing the display value on the bin objects
+    # so that when it comes time to reload, the previous value
+    # is kept.
+    send(bin_name.normalize).display_value ||=
+      if @options[:verbose]
+        send(bin_name.normalize).tickets.map(&:id).join(", ")
+      else
+        send(bin_name.normalize).tickets_count
+      end
+  end
+  
+  def git_cleanup
+    
+  end
+  
+  # -----------------------------------------
+  # Class Methods
+  # -----------------------------------------
+  
+  def self.post_notification(title, body)
+    `growlnotify -H localhost -s -n "Buildmeister" -d "Buildmeister" -t #{title} -m "#{body}"`
+  end
+  
+  def self.normalize_bin_name(bin_name)
+    bin_name.squeeze(' ').gsub(' ', '_').gsub(/\W/, '').downcase
+  end
+  
+  def self.load_config
+    YAML.load_file(File.expand_path('~/.buildmeister_config.yml'))
+  end
+end

data/lib/git_cleanup.rb

@@ -0,0 +1,179 @@
+require 'rubygems'
+require 'lighthouse'
+require 'optparse'
+require 'ostruct'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/buildmeister")
+
+class GitCleanup
+
+  def initialize
+    @config    = Buildmeister.load_config
+    Lighthouse.token    = @config['token']
+    Lighthouse.account  = @config['account']
+    
+    @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|
+        @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(@config['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."
+  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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: buildmeister
+version: !ruby/object:Gem::Version 
+  version: 0.8.1
+platform: ruby
+authors: 
+- Leigh Caplan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-11 00:00:00 -07:00
+default_executable: buildmeister
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: texel-lighthouse-api
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+    version: 
+description: FIX (describe your package)
+email: 
+- lcaplan@onehub.com
+executables: 
+- buildmeister
+- git_cleanup
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/buildmeister
+- bin/git_cleanup
+- config/buildmeister_config.sample.yml
+- lib/buildmeister.rb
+- lib/git_cleanup.rb
+- test/test_buildmeister.rb
+has_rdoc: true
+homepage: http://github.com/texel/buildmeister
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: buildmeister
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: FIX (describe your package)
+test_files: 
+- test/test_buildmeister.rb