release_party 0.0.1

data/lib/release_party.rb

@@ -0,0 +1 @@
+require 'release_party/release_party'

data/lib/release_party/environment.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), 'release_file')
+
+class Environment
+
+  def initialize
+    @attributes = {}
+    load_defaults
+  end
+
+  def method_missing(method_id, *args, &block)
+    case method_id.to_s
+    when /\A(.*)=\Z/
+      @attributes[$1.to_sym] = args.first
+
+    when /\A(.*)\?\Z/
+      @attributes.key?($1.to_sym)
+
+    else
+      unless @attributes.key?(method_id)
+        raise ArgumentError, "No value for #{method_id} defined"
+      end
+      value = @attributes[method_id.to_sym]
+      return value.call if value.is_a?(Proc)
+      value
+
+    end
+  end
+
+  def load_release_file
+    # Process the Releasefile and merge the attributes loaded
+    release_file = ReleaseFile.new
+    @attributes = @attributes.merge release_file.attributes
+  end
+
+  def load_capistrano_defaults(cap_config)
+    # General cap info
+    self.user = cap_config.fetch(:user, `git config user.name`.chomp)
+    self.branch = cap_config.fetch(:branch, 'master')
+    self.stage = cap_config.fetch(:stage, 'staging')
+    self.repository = cap_config.fetch(:repository, nil)
+    self.domain = cap_config.fetch(:domain, nil)
+    self.display_name = cap_config.fetch(:display_name, 'Release Party')
+  end
+
+  def load_defaults
+    self.from_address = 'Release Party <releaseparty@noreply.org>'
+    self.smtp_address = 'localhost'
+    self.smtp_port = 25
+    self.subject = Proc.new {"A release of #{display_name} was released to #{domain}"}
+    self.finished_stories = []
+    self.known_bugs = []
+    self.send_email = true
+    self.template_engine = :haml
+    self.deliver_stories = false
+  end
+
+end

data/lib/release_party/release_file.rb

@@ -0,0 +1,22 @@
+class ReleaseFile
+
+  RELEASE_FILE = 'Releasefile'
+
+  attr_reader :attributes
+
+  def initialize
+    @attributes = {}
+
+    capfile_path = File.join(Dir.pwd, RELEASE_FILE)
+    if File.exists?(capfile_path)
+      eval File.read(capfile_path)
+    else
+      puts "Warning: No #{RELEASE_FILE} found, you should put one in your project root."
+    end
+  end
+
+  def method_missing(method_id, *args, &block)
+    @attributes[method_id.to_sym] = args.first || block
+  end
+
+end

data/lib/release_party/release_party.rb

@@ -0,0 +1,202 @@
+require 'capistrano'
+require 'pivotal-tracker'
+require 'mail'
+require 'grit'
+
+require File.join(File.dirname(__FILE__), 'environment')
+
+module Capistrano::ReleaseParty
+
+  def self.extended(configuration)
+    configuration.load do
+
+      after 'deploy', 'release_party:finished'
+
+      namespace 'release_party' do
+        task 'started' do
+          @env = Environment.new
+
+          # Record when the release began
+          @env.release_started = Time.now
+
+          @env.load_capistrano_defaults(self)
+          @env.load_release_file
+
+          announce "beginning deployment, project details obtained."
+
+          load_git_progress @env
+          load_tracker_progress @env
+        end
+
+        task 'finished' do
+          raise ArgumentError, "Release finished without being started" if @env.nil?
+
+          begin
+            announce "celebrating release, deployment finished successfully!"
+
+            # Record when the release finished
+            @env.release_finished = Time.now
+
+
+            # Do pivotal story delivery
+            if @env.deliver_stories
+              commit_tracker_progress @env
+            end
+
+            # Send an email notification
+            if @env.send_email
+              body = load_email_content @env
+              deliver_notification(@env, body)
+            end
+
+          #rescue ArgumentError => error
+          #  puts "ERROR: #{error.message}"
+          end
+        end
+      end
+    end
+  end
+
+  def commit_tracker_progress(env)
+    # Go through each finished story id we've seen in the git repo
+    # and deliver each story that is marked as finished
+    env.finished_store_ids.each do |story_id|
+
+    end
+  end
+
+  def load_git_progress(env)
+    #repo = Grit::Repo.new(Dir.pwd)
+    repo = Grit::Repo.new("/Users/john/Projects/breeze")
+    config = Grit::Config.new(repo)
+
+    feature_branch = config.fetch('gitflow.prefix.feature', 'feature/')
+    release_branch = config.fetch('gitflow.prefix.release', 'release/')
+    puts "Feature branch: #{feature_branch}"
+    puts "Release branch: #{release_branch}"
+
+    # Find the last release
+    latest_release = \
+      repo.commits('master').find do |commit|
+        commit.message =~ /\AMerge branch '#{release_branch}(\d+)/
+      end
+    latest_release_tag = $1
+
+    puts "Commit: #{latest_release} #{latest_release.message}"
+    previous_release = \
+      repo.commits('master', 100).find do |commit|
+        if commit.message =~ /\AMerge branch '#{release_branch}(\d+)/ 
+          latest_release_tag != $1
+        end
+      end
+    previous_release_tag = $1
+    puts "Commit: #{previous_release} #{previous_release.message}"
+
+    env.finished_story_ids = 
+      repo.commits('develop').collect do |commit|
+        $1 if commit.message =~ /\AMerge branch '#{feature_branch}(\d+)/
+      end.compact
+    puts env.finished_story_ids
+  end
+
+  def load_email_content(env)
+    arguments_required env, :template_engine, :template
+
+    template = env.template
+    raise ArgumentError, "Missing template file #{template}" unless File.exists?(template)
+
+    engine = \
+      case env.template_engine
+      when :haml
+        load_haml
+        Haml::Engine.new(File.read(template))
+
+      when :erb
+        load_erb
+        ERB.new(File.read(template))
+
+      else
+        raise ArgumentError, "Unsupported template engine #{env.template_engine}"
+      end
+
+    engine.render env
+  end
+
+  def load_tracker_progress(env)
+    arguments_required env, :project_id, :project_api_key
+
+    PivotalTracker::Client.token = env.project_api_key
+
+    begin
+      env.project = PivotalTracker::Project.find(env.project_id)
+    rescue RestClient::Request::Unauthorized => e
+      puts 'Unable to authenticate with pivotal, perhaps your API key is wrong.' +
+        "Message: #{e.message}"
+    end
+
+    env.instance_eval do
+      self.finished_stories = \
+        project.stories.all(:state => 'finished')
+      self.known_bugs = \
+        project.stories.all(:state => ['unstarted', 'started'], :story_type => 'bug')
+    end
+  end
+
+  def deliver_notification(env, body)
+    arguments_required env,
+      :smtp_address, :smtp_port, :smtp_domain, :from_address,
+      :email_notification_to, :subject
+
+    Mail.defaults do
+      delivery_method :smtp,
+        :address => env.smtp_address,
+        :port => env.smtp_port,
+        :domain => env.smtp_domain
+    end
+    announce "delivering deployment notice to #{env.email_notification_to.inspect}"
+    Mail.deliver do
+      from      env.from_address
+      to        env.email_notification_to
+      subject   env.subject
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body body
+      end
+    end
+    announce "deployment notice sent!"
+  end
+
+  def announce(message)
+    puts "ReleaseParty: #{message}"
+  end
+
+  def arguments_required(env, *arguments)
+    missing = arguments.reject do |argument|
+      env.send("#{argument}?".to_sym)
+    end
+    unless missing.empty?
+      raise ArgumentError, "Parameters #{missing.join(', ')} must be defined"
+    end
+  end
+
+  def load_haml
+    require 'haml'
+  rescue LoadError => error
+    raise ArgumentError,
+      'Unable to load HAML, you need to make sure the haml gem is installed ' 
+      'if it is specified as the template engine'
+  end
+
+  def load_erb
+    require 'erb'
+  rescue LoadError => error
+    raise ArgumentError,
+      'Unable to load ERB, you need to make sure the erb gem is installed ' 
+      'if it is specified as the template engine'
+  end
+
+end
+
+if Capistrano::Configuration.instance
+  Capistrano::Configuration.instance.extend(Capistrano::Configuration.instance)
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: release_party
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Barker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pivotal-tracker
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 4
+        - 1
+        version: 2.4.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: capistrano_colors
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: colored
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+description: Perform a number of common post deployment tasks such as delivering pivotal stories, sending out a release email, notifying campfire.
+email: jebarker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/release_party/environment.rb
+- lib/release_party/release_file.rb
+- lib/release_party/release_party.rb
+- lib/release_party.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Celebrate releases
+test_files: []
+