chrismetcalf-cap-ext-webistrano 0.1.2

data/README.markdown

@@ -0,0 +1,63 @@
+A drop-n replacement for Capistrano so you can run tasks in Webistrano from
+your command line just using the cap command.
+
+Installation
+============
+
+    gem install mattmatt-cap-ext-webistrano
+
+Usage
+=====
+
+You can still use the capify command to generate the initial files required by
+Capistrano.
+
+In your Capfile, insert the following lines at the end.
+
+    gem 'mattmatt-cap-ext-webistrano'
+    require 'cap_ext_webistrano'
+
+The Webistrano extensions require a couple of configuration options that you
+can specify in your deploy.rb. They're pretty much the standard options you'd
+configure for your application with Capistrano.
+
+    set :application,     "My project" # The project as named in Webistrano
+    set :user,            "admin"
+    set :password,        "admin"
+    set :stage,           "test" # specify the stage you want to deploy
+    set :webistrano_home, "http://webistrano.mydomain.com"
+
+If you only have one stage in your project this should do, however with
+several stages it'd be better to ask for the stage to be deployed:
+
+    set :stage do
+      Capistrano::CLI.ui.ask "Specify the stage to deploy: "
+    end
+
+You can ask for the password too:
+
+    set :password do
+        Capistrano::CLI.password_prompt "Enter the deploy password: "
+    end
+
+Optionally, you can specify configuration that you had setup webistrano to
+prompt it:
+
+    set :prompt_config, { :password => 'mysecretpassword' }
+
+Changes
+=======
+
+- Added support for prompt configuration (Lucas Mundim)
+- Restore prefix_options hash as Active Resource lost it when reload method is called (Lucas Mundim)
+- Solved "regular expression too big" exception error on large string 
+output (Michael Lim)
+- Workaround to solve bug in @deployment.reload() not loading the site url 
+correctly (Michael Lim)
+
+License
+=======
+
+(c) 2009 Mathias Meyer
+
+Released under the MIT license.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = 'cap-ext-webistrano'
+    s.summary = 'A drop-in replacement for Capistrano to fire off Webistrano deployments transparently without losing the joy of using the cap command. You need a fully configured Webistrano installation.'
+    s.email = 'meyer@paperplanes.de'
+    s.homepage = 'http://github.com/mattmatt/cap-ext-webistrano'
+    s.authors = ["Mathias Meyer"]
+    s.files = FileList["[A-Z]*", "{lib,test}/**/*"]
+    s.add_dependency 'capistrano'
+    s.add_dependency 'activeresource'
+  end
+rescue LoadError 
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com" 
+end
+
+desc "Default Task"
+task :default => ["test"]
+
+desc "Runs the unit tests"
+task :test => "test:unit"
+
+namespace :test do
+  desc "Unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << 'test/unit'
+    t.pattern = "test/*_shoulda.rb"
+    t.verbose = true
+  end
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 2
+:major: 0

data/lib/cap_ext_webistrano.rb

@@ -0,0 +1,47 @@
+$:.unshift(File.dirname(File.expand_path(__FILE__)))
+require 'cap_ext_webistrano/task'
+require 'active_resource'
+require 'cap_ext_webistrano/project'
+
+module CapExtWebistrano
+  def task(*args, &blk)
+    original_task(*args, &hijack_runner)
+  end
+
+  def after(*args)
+  end
+
+  def on(*args)
+  end
+
+  def before(*args)
+  end
+end
+
+Capistrano::Configuration::Namespaces.class_eval do
+  alias :original_task :task
+  include CapExtWebistrano
+end
+
+Capistrano::Configuration::Execution.class_eval do
+  alias :original_find_and_execute_task :find_and_execute_task
+  
+  def hijack_runner
+    @hijack_runner ||= lambda { CapExtWebistrano::Task.new(current_task.fully_qualified_name, self).run }
+  end
+  
+  def hijack_capistrano
+    tasks.each {|tsk| tsk.last.instance_variable_set(:@body, hijack_runner)}
+    namespaces.each {|nmspace| nmspace.last.tasks.each {|tsk| tsk.last.instance_variable_set(:@body, hijack_runner)}}
+  end
+  
+  def find_and_execute_task(task, hooks = {})
+    hijack_capistrano
+    @callbacks = {}
+    begin
+      original_find_and_execute_task(task, {})
+    rescue Capistrano::NoSuchTaskError
+      CapExtWebistrano::Task.new(task, self).run
+    end
+  end
+end

data/lib/cap_ext_webistrano/deployment.rb

@@ -0,0 +1,7 @@
+class Deployment < ActiveResource::Base
+  def self.configure(config)
+    Deployment.site = "#{config[:webistrano_home]}/projects/:project_id/stages/:stage_id"
+    Deployment.user = config[:user]
+    Deployment.password = config[:password]
+  end
+end

data/lib/cap_ext_webistrano/project.rb

@@ -0,0 +1,17 @@
+require 'active_resource'
+
+class Project < ActiveResource::Base
+  def self.configure(config)
+    Project.site = config[:webistrano_home]
+    Project.user = config[:user]
+    Project.password = config[:password]
+  end
+  
+  def self.find_by_name(name)
+    project = find(:all).find {|project| project.name == name}
+  end
+  
+  def find_stage(name)
+    Stage.find(:all, :params => {:project_id => id}).find {|stage| stage.name == name}
+  end
+end

data/lib/cap_ext_webistrano/stage.rb

@@ -0,0 +1,7 @@
+class Stage < ActiveResource::Base
+  def self.configure(config)
+    Stage.site = "#{config[:webistrano_home]}/projects/:project_id"
+    Stage.user = config[:user]
+    Stage.password = config[:password]
+  end
+end

data/lib/cap_ext_webistrano/task.rb

@@ -0,0 +1,52 @@
+require 'cap_ext_webistrano/project'
+require 'cap_ext_webistrano/stage'
+require 'cap_ext_webistrano/deployment'
+
+module CapExtWebistrano
+  class Task
+    attr_accessor :task, :log
+
+    def initialize(task, config)
+      @task = task
+      @config = config
+      @log = ""
+    end
+
+    def set_access_data
+      [Project, Stage, Deployment].each do |klazz|
+        klazz.configure(@config)
+      end
+    end
+
+    def loop_latest_deployment
+      still_running = true
+      prefix_options = @deployment.prefix_options
+      while still_running
+        sleep 5
+        @deployment.prefix_options.merge!(prefix_options)
+        @deployment.reload
+        print_diff(@deployment)
+        still_running = false unless @deployment.completed_at.nil?
+      end
+    end
+
+    def print_diff(deployment)
+      if deployment.log
+        diff = deployment.log
+        diff.slice!(log) 
+        print diff
+        log << diff
+      end
+    end
+
+    def run
+      set_access_data
+      @project = Project.find_by_name(@config[:application])
+      @stage = @project.find_stage(@config[:stage])
+      params = { :task => task, :stage_id => @stage.id, :project_id => @project.id, :description => @config[:description] }
+      params.merge!(:prompt_config => @config[:prompt_config]) if @config.exists?(:prompt_config)
+      @deployment = Deployment.create(params)
+      loop_latest_deployment
+    end
+  end
+end

data/test/cap_ext_webistrano_shoulda.rb

@@ -0,0 +1,31 @@
+$:.unshift(File.dirname(File.expand_path(__FILE__)))
+
+require 'test_helper'
+require 'cap_ext_webistrano'
+require 'capistrano_stub'
+require 'cap_ext_webistrano/task'
+
+class CapExtWebistranoTest < Test::Unit::TestCase
+  context "when executing tasks" do
+    setup do
+      @cap = CapistranoStub.new
+      CapExtWebistrano::Task.stubs(:new).returns @cap
+    end
+    
+    should "convert all tasks to use the hijacking task" do
+      @cap.find_and_execute_task("deploy")
+      assert_nothing_raised {@cap.task.body.call}
+    end
+    
+    should "call run on the task runner" do
+      @cap.find_and_execute_task("deploy")
+      assert @cap.ran
+    end
+    
+    should "just call tasks that don't exist locally" do
+      @cap.stubs(:original_find_and_execute_task).raises(Capistrano::NoSuchTaskError.new, "the task activate:web does not exist")
+      @cap.find_and_execute_task("acticate:web")
+      assert @cap.ran
+    end
+  end
+end

data/test/capistrano_stub.rb

@@ -0,0 +1,39 @@
+require 'capistrano'
+
+class CapistranoStub
+  include Capistrano::Configuration::Namespaces
+  include Capistrano::Configuration::Execution
+  attr_accessor :task, :ran
+  
+  def logger
+    Logger.new(STDOUT)
+  end
+  
+  def find_task(*args)
+    @task ||= Capistrano::TaskDefinition.new("deploy", top, {}) { raise "This shouldn't be raised" }
+  end
+  
+  def original_find_and_execute_task(*args)
+    find_task.body.call
+  end
+  
+  def namespaces
+    {:default => top}
+  end
+  
+  def tasks
+    @tasks = {"deploy" => find_task}
+  end
+  
+  def current_task
+    find_task
+  end
+  
+  def [](key)
+    "admin"
+  end
+  
+  def run
+    @ran = true
+  end
+end

data/test/project_shoulda.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(File.expand_path(__FILE__)))
+require 'test_helper.rb'
+require 'cap_ext_webistrano/project'
+
+class ProjectTestCase < Test::Unit::TestCase
+  should "set the base url for project" do
+    Project.site = "http://localhots:3000"
+  end
+end

data/test/task_shoulda.rb

@@ -0,0 +1,92 @@
+$:.unshift(File.dirname(File.expand_path(__FILE__)))
+require 'test_helper.rb'
+require 'cap_ext_webistrano/project'
+require 'cap_ext_webistrano/task'
+require 'cap_ext_webistrano/stage'
+require 'cap_ext_webistrano/deployment'
+
+
+class TaskTest < Test::Unit::TestCase
+  context "with a new task" do
+    setup do
+      @config = Capistrano::Configuration.new
+      @config[:webistrano_home] = "http://localhost:3000"
+      @config[:password] = "bacon"
+      @config[:user] = "chunky"
+      @task = CapExtWebistrano::Task.new("deploy", @config)
+      @task.set_access_data
+      @task.stubs(:sleep)
+    end
+    
+    context "when setting up the configuration data" do
+      should "set the access data for project" do
+        assert_equal "http://localhost:3000", Project.site.to_s
+        assert_equal "chunky", Project.user
+        assert_equal "bacon", Project.password
+      end
+    
+      should "set the access data for the stage" do
+        assert_equal "http://localhost:3000/projects/:project_id", Stage.site.to_s
+        assert_equal "chunky", Stage.user
+        assert_equal "bacon", Stage.password
+      end
+    
+      should "set the access data for the deployment" do
+        assert_equal "http://localhost:3000/projects/:project_id/stages/:stage_id", Deployment.site.to_s
+        assert_equal "chunky", Deployment.user
+        assert_equal "bacon", Deployment.password
+      end
+    end
+    
+    context "when running the task" do
+      setup do
+        @project1 = Project.new(:name => "Bacon", :id => 2)
+        @project2 = Project.new(:name => "Chunky", :id => 1)
+        Project.stubs(:find).returns([@project1, @project2])
+        @stage1 = Stage.new(:name => "test", :id => 3)
+        Stage.stubs(:find).returns([@stage1])
+        @deployment = Deployment.new(:completed_at => Time.now, :log => "Chunky bacon!")
+        Deployment.stubs(:create).returns @deployment
+        Deployment.stubs(:find).returns(@deployment)
+        @config[:application] = "Bacon"
+        @config[:stage] = "test"
+      end
+      
+      should "find the project" do
+        Project.expects(:find).returns([@project1, @project2])
+        @task.run
+      end
+      
+      should "find the stage" do
+        Stage.expects(:find).with(:all, :params => {:project_id => 2}).returns([@stage1])
+        @task.run
+      end
+      
+      should "create a deployment" do
+        Deployment.expects(:create).with(:task => "deploy", :project_id => 2, :stage_id => 3).returns(@deployment)
+        @task.run
+      end
+      
+      should "find the latest deployment" do
+        Deployment.expects(:find).returns @deployment
+        @task.run
+      end
+      
+      context "when requesting the deployment multiple times" do
+        setup do
+          @seq = sequence("latest")
+          @deployment1 = Deployment.new(:completed_at => nil, :log => "Chunky bacon", :id => 2)
+          @deployment2 = Deployment.new(:completed_at => Time.now, :log => "Chunky bacon is my bitch", :id => 2)
+          Deployment.stubs(:create).returns(@deployment1)
+        end
+        
+        should "concat the deployment log" do
+          Deployment.expects(:find).returns(@deployment1).in_sequence(@seq)
+          Deployment.expects(:find).returns(@deployment2).in_sequence(@seq)
+          @task.run
+          assert_equal "Chunky bacon is my bitch", @task.log
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require 'rubygems'
+
+gem 'thoughtbot-shoulda', '>= 2.0.0'
+require 'shoulda'
+gem 'capistrano'
+require 'capistrano'
+gem 'mocha'
+require 'mocha'
+
+$:.unshift(File.join(File.dirname(File.expand_path(__FILE__)), "..", "lib"))

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: chrismetcalf-cap-ext-webistrano
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Mathias Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: meyer@paperplanes.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.markdown
+- VERSION.yml
+- lib/cap_ext_webistrano
+- lib/cap_ext_webistrano/deployment.rb
+- lib/cap_ext_webistrano/project.rb
+- lib/cap_ext_webistrano/stage.rb
+- lib/cap_ext_webistrano/task.rb
+- lib/cap_ext_webistrano.rb
+- test/cap_ext_webistrano_shoulda.rb
+- test/capistrano_stub.rb
+- test/project_shoulda.rb
+- test/task_shoulda.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mattmatt/cap-ext-webistrano
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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 drop-in replacement for Capistrano to fire off Webistrano deployments transparently without losing the joy of using the cap command. You need a fully configured Webistrano installation.
+test_files: []
+