heroku_release 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+doc/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in heroku_deploy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    heroku_release (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    mocha (0.9.9)
+      rake
+    rake (0.8.7)
+    rspec (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+      rspec-mocks (= 2.0.0)
+    rspec-core (2.0.0)
+    rspec-expectations (2.0.0)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  heroku_release!
+  mocha (~> 0.9.9)
+  rspec (~> 2.0.0)

data/README.rdoc

@@ -0,0 +1,45 @@
+= Heroku Deploy
+
+Simple RubyGem for tagging and deploying versioned releases of an application to Heroku with the ability to do rollbacks.
+
+== Usage
+
+If you are using Bundler, add a gem dependency like this:
+
+ group :development, :test do
+   gem 'heroku_deploy', '~> version known to work'
+ end
+
+Require the Rake tasks in your Rakefile:
+
+ require 'heroku_deploy/tasks'
+
+You have a few configuration options. If you are using a Git remote other than "heroku" then you must configure that. You can choose to have the release version written to a file on deploy so you can check the version on the live server. Here is an example:
+
+ HerokuDeploy.config.heroku_remote = "production" # git remote for heroku, defaults to "heroku"
+ HerokuDeploy.config.version_file_path = "public/version"
+
+To deploy the master branch to production, use the heroku_deploy rake task:
+
+ rake heroku_deploy COMMENT="This is a comment describing what changed since the last release"
+
+If the deploy went horribly wrong and you need to do a rollback you can do so:
+
+ rake heroku_deploy:rollback
+
+In order to see the changelog:
+
+ rake heroku_deploy:log
+
+To examine git commits since the last release you can do:
+
+ rake heroku_deploy:pending
+
+== TODO
+
+It seems Heroku {is working on}[http://github.com/adamwiggins/heroku-releases] incorporating rollback functionality into the heroku command. Something to look into...
+
+== Credit
+
+This gem was inspired by
+{this gist}[http://gist.github.com/raw/307543/c762d1cb136588fb76edff907d65bbf80a1e254e/deploy.rake].

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.require
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:default)

data/heroku_release.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "heroku_release/version"
+
+Gem::Specification.new do |s|
+  s.name        = "heroku_release"
+  s.version     = HerokuRelease::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Peter Marklund"]
+  s.email       = ["peter@marklunds.com"]
+  s.homepage    = "http://rubygems.org/gems/heroku_release"
+  s.summary     = %q{Simple RubyGem for tagging and deploying versioned releases of an application to Heroku with the ability to do rollbacks.}
+
+  s.rubyforge_project = "heroku_release"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.0.0"
+  s.add_development_dependency "mocha", "~> 0.9.9"
+end

data/lib/heroku_release/tasks.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), "..", "tasks", "*.rake")].each { |rake_file| load rake_file }

data/lib/heroku_release/version.rb

@@ -0,0 +1,3 @@
+module HerokuRelease
+  VERSION = "0.0.1"
+end

data/lib/heroku_release.rb

@@ -0,0 +1,135 @@
+require 'ostruct'
+
+module HerokuRelease
+  @@config = OpenStruct.new(
+    :heroku_remote => "heroku"
+  )
+
+  def self.config
+    @@config
+  end
+
+  def self.config=(config)
+    @@config = config
+  end
+  
+  class Task
+    def self.tasks
+      {
+        :push => nil,
+        :tag => nil,
+        :log => "Produces a changelog from release tags and their comments. Assumes tag comments have no newlines in them.",
+        :current_release => "Show version of current release",
+        :previous_release => "Show version of previous release",
+        :pending => "Show git commits since last released version",
+        :rollback => "Rollback to previous release and remove current release tag"
+      }      
+    end
+    
+    def push
+      output 'Deploying site to Heroku ...'
+      execute "git push #{config.heroku_remote} master"
+    end
+
+    def tag
+      release_name = get_release_name
+      commit_version_file(release_name) if config.version_file_path
+      comment = ENV['COMMENT'] || 'Tagged release'
+      output "Tagging release as '#{release_name}' with comment '#{comment}'"
+      execute "git tag -a #{release_name} -m '#{comment}'"
+      execute "git push --tags origin"
+      execute "git push --tags #{config.heroku_remote}"
+    end
+
+    def log
+      change_log = git_tags_with_comments.scan(/^\s*(release-\d+-\d+)\s*(.+)$/).reverse.map do |release, comment|
+        "- #{release}\n\n#{comment}\n\n"
+      end.join
+      output "\n" + change_log
+    end
+
+    def current_release
+      output current_release_version
+    end
+
+    def previous_release
+      if previous_release_version
+        output previous_release_version
+      else
+        output "no previous release found"
+      end
+    end
+
+    def pending
+      execute "git log #{current_release_version}..HEAD"
+    end
+
+    def rollback
+      # Store releases in local variables so they don't change during tag deletion
+      current = current_release_version
+      previous = previous_release_version
+      if previous
+        output "Rolling back to '#{previous}' ..."
+        execute "git push -f #{config.heroku_remote} #{previous}:master"
+        output "Deleting rollbacked release '#{current}' ..."
+        execute "git tag -d #{current}"
+        execute "git push #{config.heroku_remote} :refs/tags/#{current}"
+        execute "git push origin :refs/tags/#{current}"
+        output 'Rollback completed'
+      else
+        output "No release tags found - cannot do rollback"
+        output releases
+      end
+    end
+
+    private
+
+    def output(message)
+      puts message
+    end
+    
+    def execute(command)
+      output `#{command}`.strip
+    end
+
+    def releases
+      @releases ||= git_tags.split("\n").select { |t| t[0..7] == 'release-' }.sort
+    end
+
+    def current_release_version
+      releases.last
+    end
+
+    def previous_release_version
+      if releases.length >= 2 && previous = releases[-2]
+        previous
+      else
+        nil
+      end    
+    end
+
+    def commit_version_file(release_name)
+      output "Committing version file for release #{release_name}"
+      File.open(config.version_file_path, "w") { |f| f.print release_name }
+      execute "git add #{config.version_file_path}"
+      execute "git commit -m 'Updated version file to #{release_name}'"
+      execute "git push origin master"
+    end
+
+    def get_release_name
+      "release-#{Time.now.utc.strftime("%Y%m%d-%H%M%S")}"
+    end
+
+    def git_tags
+      `git tag`
+    end
+
+    def git_tags_with_comments
+      `git tag -n`
+    end
+    
+    def config
+      HerokuRelease.config
+    end
+  end
+end

data/lib/tasks/heroku_release.rake

@@ -0,0 +1,11 @@
+desc "Tag and push master branch to heroku"
+task :heroku_release => ['heroku_release:tag', 'heroku_release:push']
+
+namespace :heroku_release do
+  HerokuRelease::Task.tasks.each do |task_name, description|
+    desc(description) if description
+    task task_name do
+      HerokuRelease::Task.new.send(task_name)
+    end
+  end
+end

data/spec/heroku_release_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe HerokuRelease do
+  before(:each) do
+    @config_before = HerokuRelease.config.dup
+  end
+  
+  after(:each) do
+    HerokuRelease.config = @config_before
+  end
+  
+  describe "config" do
+    it "defaults heroku_remote to heroku" do
+      config.heroku_remote.should == "heroku"
+    end
+    
+    it "can set heroku_remote" do
+      config.heroku_remote = "production"
+      config.heroku_remote.should == "production"
+    end
+    
+    it "defaults version_file_path to nil" do
+      config.version_file_path.should be_nil
+    end
+    
+    it "can set version_file_path" do
+      config.version_file_path = "public/system/version"
+      config.version_file_path.should == "public/system/version"
+    end
+  end
+  
+  def config
+    HerokuRelease.config
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler.require(:development)
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'heroku_release'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/task_spec.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe HerokuRelease::Task do
+  before(:each) do
+    @task = HerokuRelease::Task.new
+    @config = HerokuRelease.config
+    @config_before = HerokuRelease.config.dup
+  end
+
+  after(:each) do
+    HerokuRelease.config = @config_before
+  end
+  
+  describe "tasks" do
+    it "is a Hash" do
+      HerokuRelease::Task.tasks.is_a?(Hash).should be_true
+    end
+    
+    it "corresponds to public instance methods" do
+      HerokuRelease::Task.tasks.keys.map(&:to_s).sort.should == task_instance_methods      
+    end
+    
+    def task_instance_methods
+      HerokuRelease::Task.public_instance_methods(false).map(&:to_s).sort
+    end
+  end
+  
+  describe "push" do
+    it "should execute a git push to heroku remote" do
+      @task.expects(:execute).with("git push #{@config.heroku_remote} master")
+      @task.push
+    end
+  end
+
+  describe "tag" do
+    it "create git tag with release name and comment and pushes it to origin and to heroku" do
+      ENV['COMMENT'] = "the comment"
+      @task.expects(:get_release_name).returns("release-123")
+      @task.expects(:commit_version_file).never
+      git = sequence('git')
+      @task.expects(:execute).with("git tag -a release-123 -m 'the comment'").in_sequence(git)
+      @task.expects(:execute).with("git push --tags origin").in_sequence(git)
+      @task.expects(:execute).with("git push --tags #{@config.heroku_remote}").in_sequence(git)
+
+      @task.tag
+    end
+    
+    it "commits version file if version_file_path is set" do
+      ENV['COMMENT'] = nil
+      @config.version_file_path = "public/version"
+      @task.expects(:get_release_name).returns("release-123")
+      @task.expects(:commit_version_file).with("release-123")
+      git = sequence('git')
+      @task.expects(:execute).with("git tag -a release-123 -m 'Tagged release'").in_sequence(git)
+      @task.expects(:execute).with("git push --tags origin").in_sequence(git)
+      @task.expects(:execute).with("git push --tags #{@config.heroku_remote}").in_sequence(git)
+
+      @task.tag
+    end
+  end
+
+  describe "log" do
+    it "outputs a changelog from the git tags and their comments" do
+      git_tags = <<-END
+      release-20101026-143729 Initial release
+      release-20101027-225442 Some improvements
+      release-20101029-085937 Major new feature
+      END
+      @task.expects(:git_tags_with_comments).returns(git_tags)
+      @task.expects(:output).with(<<-END
+
+- release-20101029-085937
+
+Major new feature
+
+- release-20101027-225442
+
+Some improvements
+
+- release-20101026-143729
+
+Initial release
+
+      END
+      )
+
+      @task.log
+    end
+  end
+
+  describe "current_release" do
+    it "should output latest release" do
+      @task.expects(:releases).returns(%w(release-20100922-115151 release-20100922-122313))
+      @task.expects(:output).with("release-20100922-122313")
+      @task.current_release
+    end
+  end
+
+  describe "previous_release" do
+    it "outputs previous release if there is one" do
+      @task.stubs(:releases).returns(%w(release-20100922-115151 release-20100922-122313))
+      @task.expects(:output).with("release-20100922-115151")
+      @task.previous_release
+    end
+    
+    it "says there is no previous release if there is none" do
+      @task.stubs(:releases).returns(%w(release-20100922-122313))
+      @task.expects(:output).with("no previous release found")
+      @task.previous_release      
+    end
+  end
+
+  describe "pending" do
+    it "executes a git log between current release and HEAD" do
+      @task.expects(:current_release_version).returns("release-123")
+      @task.expects(:execute).with("git log release-123..HEAD")
+      @task.pending
+    end
+  end
+
+  describe "rollback" do
+    it "pushes previous release tag to heroku and deletes current release tag" do
+      git = sequence('git')
+      @task.expects(:previous_release_version).returns("release-previous")
+      @task.expects(:current_release_version).returns("release-current")
+      @task.expects(:execute).with("git push -f #{@config.heroku_remote} release-previous:master").in_sequence(git)
+      @task.expects(:execute).with("git tag -d release-current").in_sequence(git)
+      @task.expects(:execute).with("git push #{@config.heroku_remote} :refs/tags/release-current").in_sequence(git)
+      @task.expects(:execute).with("git push origin :refs/tags/release-current").in_sequence(git)
+      
+      @task.rollback
+    end
+  end
+
+  describe "output" do
+    it "invokes puts with message" do
+      @task.expects(:puts).with("a message")
+      @task.send(:output, "a message")
+    end
+  end
+  
+  describe "execute" do
+    it "executes a command and outputs the result" do
+      @task.expects(:output).with("foobar")
+      @task.send(:execute, "echo foobar")
+    end
+
+    it "outputs empty line if there is no output" do
+      @task.expects(:output).with("")
+      @task.send(:execute, "echo")
+    end
+  end
+      
+  describe "get_release_name" do
+    it "generates a timestamped tag name" do
+      @task.send(:get_release_name).should =~ /release-\d\d\d\d\d\d\d\d-\d\d\d\d\d\d/
+    end
+  end
+  
+  describe "commit_version_file(release_name)" do
+    before(:each) do
+      @path = "spec/version"      
+    end
+    
+    after(:each) do
+      FileUtils.rm_f(@path)
+    end
+    
+    it "writes release_name to version_file_path and commits that file" do
+      git = sequence('git')
+      @task.expects(:execute).with("git add #{@path}").in_sequence(git)
+      @task.expects(:execute).with("git commit -m 'Updated version file to release-123'").in_sequence(git)
+      @task.expects(:execute).with("git push origin master").in_sequence(git)
+
+      HerokuRelease.config.version_file_path = @path
+      @task.send(:commit_version_file, "release-123")
+
+      File.read(@path).should == "release-123"
+    end
+  end
+
+  describe "git_tags_with_comments" do
+    it "works" do
+      @task.send(:git_tags_with_comments)
+    end
+  end
+
+  describe "releases" do
+    it "parses out list of releases from git tags" do
+      @task.expects(:git_tags).returns(<<-END
+release-20100922-115151
+release-20100922-122313
+foobar
+release-20100926-173016
+      END
+      )
+      
+      @task.send(:releases).should == %w(release-20100922-115151 release-20100922-122313 release-20100926-173016)
+    end
+  end
+
+  describe "git_tags" do
+    it "works" do
+      @task.send(:git_tags)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: heroku_release
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Marklund
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: 
+email: 
+- peter@marklunds.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- heroku_release.gemspec
+- lib/heroku_release.rb
+- lib/heroku_release/tasks.rb
+- lib/heroku_release/version.rb
+- lib/tasks/heroku_release.rake
+- spec/heroku_release_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/heroku_release
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 746099489
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 746099489
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: heroku_release
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple RubyGem for tagging and deploying versioned releases of an application to Heroku with the ability to do rollbacks.
+test_files: 
+- spec/heroku_release_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb