heroku_san 3.0.0 → 3.0.1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log (curated)
 
+## v3.0.1
+
+  * Fix deploy:force bugs (#84 & #85)
+
 ## v3.0.0
 
   * New feature: support for Rack apps (e.g. Sinatra)

data/examples/deploy_strategies.md

@@ -0,0 +1,56 @@
+# Deploy Strategies
+
+If you look at the network graphs of `heroku_san` on github, you'll see a number of branches where the only change is the deletion of the following line from the `deploy` task:
+
+  - stage.migrate
+  
+If more than a few people are will to take the effort to fork a gem just so they can delete 1 line, something smells. The reason is that these forkers were using something other than Rails+ActiveRecord+SQL in their project. Some were using Sinatra, others were using Rails, but with CouchDB. 
+
+The _raison d'être_ for the `heroku_san` gem is to make Heroku deploys dirt simple. So, if people are making whole forks to customize the deploy task, we should make it less painful.
+
+## Enter strategies
+
+[Strategies](need_ref) are an object oriented programming pattern for creating pluggable execution control. There's is now a new class of objects that inherit from `HerokuSan::Deploy::Base`. These objects now control how deploys are executed for you. The Rails strategy, `HerokuSan::Deploy::Base` does exactly what HerokuSan has always done:
+
+  * push to git@heroku.com
+  * call rake db:migrate
+  * restart
+  
+On the other hand, the Sinatra strategy, `HerokuSan::Deploy::Sinatra` does nothing more than the base strategy:
+
+  * push to git@heroku.com
+  
+You can create your own strategies and then configure HerokuSan to use it instead of its default:
+
+## Rails 3 projects
+
+Amend your `Rakefile`:
+
+  require 'heroku_san'
+  
+  class MyStrategy < HerokuSan::Deploy::Base
+    def deploy
+      super
+      # call my own code to do something unique
+    end
+  end
+  
+  HerokuSan.project = HerokuSan::Project.new(Rails.root.join("config","heroku.yml"), :deploy => MyStrategy)
+
+## Sinatra (and other Rack based apps)
+
+Amend your `Rakefile`
+
+  require 'heroku_san'
+  
+  class MyStrategy < HerokuSan::Deploy::Base
+    def deploy
+      super
+      # call my own code to do something unique
+    end
+  end
+  
+  config_file = File.join(File.expand_path(File.dirname(__FILE__)), 'config', 'heroku.yml')
+  HerokuSan.project = HerokuSan::Project.new(config_file, :deploy => MyStrategy)
+  
+  load "heroku_san/tasks.rb"

data/features/step_definitions/remote_steps.rb

@@ -52,7 +52,6 @@ When /^I add heroku_san to the Gemfile$/ do
       gem 'heroku_san', :path => '../../../.'
     end
 EOT
-
 end
 
 When /^I run bundle install$/ do
@@ -92,6 +91,7 @@ When /^I create my project on Heroku$/ do
     ---
     test_app:
       app: #{@app}
+
 EOT
 end
 
@@ -119,6 +119,7 @@ When /^I configure my project$/ do
       app: #{@app}
       config:
         DROIDS: marvin
+
 EOT
   cmd = 'bundle exec rake test_app heroku:config'
   run_simple cmd
@@ -187,6 +188,7 @@ When /^I install an addon$/ do
       app: #{@app}
       addons:
         - deployhooks:campfire
+
 END_CONFIG
 
   run_simple 'bundle exec rake test_app heroku:addons'
@@ -212,7 +214,7 @@ end
 def overwrite_simple_config_file
   overwrite_file 'config/heroku.yml', <<EOT.strip_heredoc
     ---
-    test_app:
+    test_app: 
+    
 EOT
-
 end

data/lib/heroku_san/deploy/base.rb

@@ -1,13 +1,14 @@
 module HerokuSan
   module Deploy
     class Base
-      def initialize(stage, args = {})
+      def initialize(stage, commit = nil, force = nil)
         @stage = stage
-        @args = args
+        @commit = commit
+        @force = force
       end
       
       def deploy
-        @stage.push(@args[:commit], @args[:force])
+        @stage.push(@commit, @force)
       end        
     end
   end

data/lib/heroku_san/deploy/noop.rb

@@ -0,0 +1,11 @@
+require 'heroku_san/deploy/base'
+
+module HerokuSan
+  module Deploy
+    class Noop < Base
+      def deploy
+        # do nothing
+      end        
+    end
+  end
+end

data/lib/heroku_san/deploy/rails.rb

@@ -2,11 +2,12 @@ require 'heroku_san/deploy/base'
 
 module HerokuSan
   module Deploy
-    class Rails < HerokuSan::Deploy::Base
+    class Rails < Base
       def deploy
-        $stderr.puts super
-        $stderr.puts @stage.rake('db:migrate')
-        $stderr.puts @stage.restart
+        # TODO: Add announce/logger
+        super
+        @stage.rake('db:migrate')
+        @stage.restart
       end
     end
   end

data/lib/heroku_san/deploy/sinatra.rb

@@ -2,9 +2,9 @@ require 'heroku_san/deploy/base'
 
 module HerokuSan
   module Deploy
-    class Sinatra < HerokuSan::Deploy::Base
+    class Sinatra < Base
       def deploy
-        $stderr.puts super
+        super
       end
     end
   end

data/lib/heroku_san/project.rb

@@ -13,11 +13,13 @@ module HerokuSan
       @app_settings = {}
       config = parse(@config_file)
       config.each do |stage, settings|
+        # TODO: Push this eval later (j.i.t.)
         @app_settings[stage] = HerokuSan::Stage.new(stage, settings.merge(options.slice(:deploy)))
       end
     end
 
     def create_config
+      # TODO: Convert true/false returns to success/exception
       template = File.expand_path(File.join(File.dirname(__FILE__), '../templates', 'heroku.example.yml'))
       if File.exists?(@config_file)
         false
@@ -43,11 +45,10 @@ module HerokuSan
     end
   
     def apps
-      if !@apps.empty?
+      if @apps.present?
         @apps
       else
-        @apps = case all.size
-        when 1
+        @apps = if all.size == 1
           $stdout.puts "Defaulting to #{all.first.inspect} since only one app is defined"
           all
         else

data/lib/heroku_san/stage.rb

@@ -65,8 +65,8 @@ module HerokuSan
       restart
     end
     
-    def deploy(args = {})
-      strategy = @options['deploy'].new(self, args)
+    def deploy(commit = nil, force = nil)
+      strategy = @options['deploy'].new(self, commit, force)
       strategy.deploy
     end
     

data/lib/heroku_san/tasks.rb

@@ -170,7 +170,7 @@ namespace :heroku do
   desc "Pushes the given commit (default: HEAD)"
   task :push, :commit do |t, args|
     each_heroku_app do |stage|
-      stage.push(args[:commit])
+      stage.push(args.commit)
     end
   end
 
@@ -178,7 +178,7 @@ namespace :heroku do
     desc "Force-pushes the given commit (default: HEAD)"
     task :force, :commit do |t, args|
       each_heroku_app do |stage|
-        stage.push(args[:commit], :force)
+        stage.push(args.commit, :force)
       end
     end
   end
@@ -207,19 +207,19 @@ namespace :heroku do
     end
   end
 
-  desc "Pushes the given commit, migrates and restarts (default: HEAD)"
+  desc "Deploys the app (default: HEAD)"
   task :deploy, [:commit] => [:before_deploy] do |t, args|
     each_heroku_app do |stage|
-      stage.deploy(args)
+      stage.deploy(args.commit)
     end
     Rake::Task[:after_deploy].execute
   end
 
   namespace :deploy do
-    desc "Force-pushes the given commit, migrates and restarts (default: HEAD)"
+    desc "Deploys the app with push --force (default: HEAD)"
     task :force, [:commit] => [:before_deploy] do |t, args|
       each_heroku_app do |stage|
-        stage.deploy(args.merge(:force => true))
+        stage.deploy(args.commit, :force)
       end
       Rake::Task[:after_deploy].execute
     end

data/lib/heroku_san/version.rb

@@ -1,3 +1,3 @@
 module HerokuSan
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/spec/heroku_san/deploy/base_spec.rb

@@ -6,26 +6,26 @@ module HerokuSan
       let(:stage) { HerokuSan::Stage.new('test', {"app" => "awesomeapp", "deploy" => 'HerokuSan::Deploy::Base'}) }
       
       it "calls push" do
-        subject = described_class.new(stage, {})
+        subject = described_class.new(stage)
         stage.should_receive(:push).with(nil, nil)
         subject.deploy
       end
       
       it "calls push(sha)" do
-        subject = described_class.new(stage, {:commit => 'sha'})
+        subject = described_class.new(stage, 'sha')
         stage.should_receive(:push).with('sha', nil)
         subject.deploy
       end
       
       it "calls push(nil, :force)" do
-        subject = described_class.new(stage, {:force => true})
-        stage.should_receive(:push).with(nil, true)
+        subject = described_class.new(stage, nil, :force)
+        stage.should_receive(:push).with(nil, :force)
         subject.deploy
       end
 
       it "calls push(sha, :force)" do
-        subject = described_class.new(stage, {:commit => 'sha', :force => true})
-        stage.should_receive(:push).with('sha', true)
+        subject = described_class.new(stage, 'sha', :force)
+        stage.should_receive(:push).with('sha', :force)
         subject.deploy
       end
     end

data/spec/heroku_san/deploy/rails_spec.rb

@@ -5,11 +5,11 @@ module HerokuSan
     describe Rails do
       let(:stage) { HerokuSan::Stage.new('test', {"app" => "awesomeapp", "deploy" => 'HerokuSan::Deploy::Rails'}) }
 
-      it "calls migrate" do
+      it "calls push, rake db:migrate & restart" do
         subject = described_class.new(stage, {})
-        stage.should_receive(:push) # "mock" super
-        stage.should_receive(:rake).with('db:migrate')
-        stage.should_receive(:restart)
+        stage.should_receive(:push) { "pushed" } # "mock" super
+        stage.should_receive(:rake).with('db:migrate') { "migrated" }
+        stage.should_receive(:restart) { "restarted" }
         subject.deploy
       end
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 0
-  - 0
-  version: 3.0.0
+  - 1
+  version: 3.0.1
 platform: ruby
 authors: 
 - Elijah Miller
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-12 00:00:00 -07:00
+date: 2012-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -159,6 +159,7 @@ files:
 - autotest/discover.rb
 - cucumber.yml
 - examples/auto_tagger.rake
+- examples/deploy_strategies.md
 - examples/push_revision.rake
 - features/config.feature
 - features/extended-config.feature
@@ -170,6 +171,7 @@ files:
 - lib/git.rb
 - lib/heroku_san.rb
 - lib/heroku_san/deploy/base.rb
+- lib/heroku_san/deploy/noop.rb
 - lib/heroku_san/deploy/rails.rb
 - lib/heroku_san/deploy/sinatra.rb
 - lib/heroku_san/project.rb