primedia-qa_release_tasks 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 PRIMEDIA
+
+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,7 @@
+==Summary
+
+QA Release Management Workflow for Git
+
+==Authors
+
+  Jason Noble, Rein Henrichs

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+require 'lib/qa_release_tasks'
+
+GEM = "qa_release_tasks"
+GEM_VERSION = "0.1.1"
+AUTHORS = "Jason Noble", "Rein Henrichs"
+SUMMARY = "A gem that provides workflow driven rake tasks for git QA branch management"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.authors = AUTHORS
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/cli.rb

@@ -0,0 +1,43 @@
+module CLI
+  def warn(message)
+    STDERR.puts "*" * 50
+    STDERR.puts "Warning: #{message}"
+    STDERR.puts "*" * 50
+  end
+
+  def error(message)
+    STDERR.puts "*" * 50
+    STDERR.puts "Error: #{message}"
+    STDERR.puts "*" * 50
+    exit 1
+  end
+
+  def ask(question, default=nil, valid_response=nil, invalid_message=nil)
+    loop do
+      print "#{question}"
+      print " [#{default}]" if default
+      print ": "
+      answer = STDIN.gets.chomp
+      answer = default if default && answer.empty?
+      valid = false
+      valid = true if valid_response.nil?
+      valid = true if valid_response.respond_to?(:include?) && valid_response.include?(answer)
+      valid = true if valid_response.respond_to?(:match) && valid_response.match(answer)
+      if valid
+        return answer
+      else
+        if valid_response.is_a?(Array)
+          puts invalid_message || begin
+            print "Invalid answer, please try again."
+            print " Valid answers include:\n"
+            puts valid_response
+          end
+        elsif valid_response.is_a?(Regexp)
+          puts invalid_message || "Invalid format for answer, please try again."
+        else
+          puts invalid_message || "Invalid answer, please try again."
+        end
+      end
+    end  
+  end
+end

data/lib/git/commands.rb

@@ -0,0 +1,74 @@
+module Git
+  module Commands
+
+    def assert_is_git_repo
+      error "Not a git repository" unless is_git_repo?
+    end
+
+    def is_git_repo?
+      File.directory?('.git')
+    end
+
+    #  figure out what branch the pwd's repo is on
+    def get_branch
+      match = Regexp.new("^# On branch (.*)").match(`git status`)
+      match && match[1]
+    end
+    
+     # e.g. v1.4.3
+    def valid_version_regexp
+      /^v\d+\.\d+\.\d+/
+    end
+
+    # Find all version tags
+    def get_tags
+      version_regexp = valid_version_regexp
+      %x{git tag}.split.grep(version_regexp).sort_by{|v| v.split('.').map{|nbr| nbr[/\d+/].to_i}}.map{|tag| tag.strip}
+    end
+
+    def next_version(options={})
+      latest_tag = get_tags.last
+      return 'v0.0.1' unless latest_tag
+
+      unless latest_tag.match valid_version_regexp
+        warn "invalid version number"
+        return latest_tag
+      end
+
+      major, minor, point = latest_tag.split('.')
+      major = major[1..-1]
+      if options[:major]
+        major.succ!
+        minor, point = '0', '0'
+      elsif options[:minor]
+        minor.succ!
+        point = '0'
+      elsif options[:point]
+        point.succ!
+      else
+        warn "unable to increment version number."
+      end
+
+      'v' + [major, minor, point].join('.')
+    end
+
+    #  based on 'git status' output, does this repo contain changes that need to be committed?
+    #  optional second argument is a specific file (or directory) in the repo.
+    def needs_commit?(dir = Dir.pwd, file = nil)
+      rval = false
+      Dir.chdir(dir) do
+        status = %x{git status}
+        if file.nil?
+          rval = true unless status =~ /nothing to commit \(working directory clean\)|nothing added to commit but untracked files present/
+          if status =~ /nothing added to commit but untracked files present/
+            warn "untracked files present in #{dir}"
+            show_changed_files(status)
+          end
+        else
+          rval = true if status =~ /^#\t.*modified:   #{file}/
+        end
+      end
+      rval
+    end
+  end
+end

data/lib/git/release_notes.rb

@@ -0,0 +1,33 @@
+module Git
+  class ReleaseNotes
+    require 'enumerator'
+    include CLI
+    include Commands
+
+    def annotate!
+      assert_is_git_repo
+      tags = get_tags.reverse
+      error "No version tags available." if tags.empty?
+      
+      start_tag = ask "Start at which tag?", tags[0], tags
+      start_index = tags.index(start_tag)      
+      end_tag = ask "End at which tag?", tags[start_index + 1] || tags[start_index], tags
+      puts
+      end_index = tags.index(end_tag) + 1 # include end tag
+      
+      start_index.upto(end_index-1) do |i|
+        start = tags[i]
+        finish = tags[i+1]
+        range = ''
+        range << "refs/tags/#{finish}.." if finish # log until end tag if there is an end tag
+        range << "refs/tags/#{start}"
+        log = `git log --no-merges --pretty=format:"%h  %s" #{range}`.strip
+        next if log.empty?
+        puts "#{start}"
+        puts "=" * start.length
+        puts log
+        puts
+      end
+    end
+  end
+end

data/lib/git/tagger.rb

@@ -0,0 +1,63 @@
+module Git
+  class Tagger
+    include CLI
+    include Commands
+
+    attr_reader :options
+    def initialize(options)
+      @options = options
+    end
+
+    def tag!
+      assert_is_git_repo
+      begin
+        assert_on_qa_branch
+        assert_no_local_modifications
+        update_qa if options[:update]
+        tag_next_version(options)
+        git_push_tags
+      ensure
+        system 'git checkout qa_branch' unless get_branch == 'qa_branch'
+      end
+    end
+
+    private
+
+    def assert_no_local_modifications
+      if needs_commit?
+        error "You have local modifications.  Use git commit or git stash to fix that."
+      end
+    end
+
+    def assert_on_qa_branch
+      unless get_branch == 'qa_branch'
+        error "You have to be in the qa_branch to do a release."
+      end
+    end
+
+    def update_qa
+      system("git checkout master")    &&
+      system("git pull")               &&
+      system("git checkout qa_branch") &&
+      system("git pull")               &&
+      response = %x(git merge master)
+
+      unless response.include?("Fast forward") || response.include?('Already up-to-date.')
+        warn "There are outstanding changes in qa_branch that may need to be merged into master"
+      end
+    end
+
+    def tag_next_version(options={})
+      tag = next_version(options)
+      if options[:update]
+        invalid_message = "Invalid version. Version must be in the format: \"v1.2.3\""
+        tag = ask "Name of new version tag ", tag, valid_version_regexp, invalid_message
+      end
+      system "git tag #{tag}"
+    end
+
+    def git_push_tags
+      system "git push --tags"
+    end
+  end
+end

data/lib/qa_release_tasks.rb

@@ -0,0 +1,6 @@
+$:.unshift File.join(File.dirname(__FILE__))
+require 'cli'
+require 'git/commands'
+require 'git/release_notes'
+require 'git/tagger'
+require 'tasks/qa_release'

data/lib/tasks/qa_release.rake

@@ -0,0 +1,18 @@
+namespace :qa do
+  namespace :release do
+    desc "Create a new minor version release from master."
+    task :new do
+      Git::Tagger.new(:minor => true, :update => true).tag!
+    end
+
+    desc "Create a new point version release from qa branch."
+    task :update do
+      Git::Tagger.new(:point => true).tag!
+    end
+
+    desc "Add release notes for a given tag based on commit summaries"
+    task :notes do
+      Git::ReleaseNotes.new.annotate!
+    end
+  end
+end

data/lib/tasks/qa_release.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'rake'
+ 
+# Load rake file
+import "#{File.dirname(__FILE__)}/qa_release.rake"

data/spec/qa_release_tasks_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "qa_release_tasks" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: primedia-qa_release_tasks
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jason Noble
+- Rein Henrichs
+autorequire: qa_release_tasks
+bindir: bin
+cert_chain: []
+
+date: 2009-04-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A gem that provides workflow driven rake tasks for git QA branch management
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/cli.rb
+- lib/git
+- lib/git/commands.rb
+- lib/git/release_notes.rb
+- lib/git/tagger.rb
+- lib/qa_release_tasks.rb
+- lib/tasks
+- lib/tasks/qa_release.rake
+- lib/tasks/qa_release.rb
+- spec/qa_release_tasks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A gem that provides workflow driven rake tasks for git QA branch management
+test_files: []
+