heroku_san 2.2.2 → 3.0.0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log (curated)
 
+## v3.0.0
+
+  * New feature: support for Rack apps (e.g. Sinatra)
+  * Removes dependency on Rails
+  * New feature: deploy strategy class for customizing the :deploy target
+  * `Stage#deploy` calls strategy (breaks v2 API)
+  * `Stage#push` pushes to Heroku
+  * If you have a Rails app, you don't have to do anything; the gem will
+    automatically configure itself to use the Rails deploy strategy. See
+    the README for how to configure you Rack app's `Rakefile`
+  
 ## v2.2.1
 
   * New feature: addons from [Matt Burke](https://github.com/spraints)
@@ -30,17 +41,17 @@
   * Push `REVISION` to Heroku example
   * Bug fixes
 
-### New tasks
+  ### New tasks
 
-  * rake logs:tail
-  * rake shell
-  * All HerokuSan tasks inside heroku: namespace, with aliases in the global namespace
+    * rake logs:tail
+    * rake shell
+    * All HerokuSan tasks inside heroku: namespace, with aliases in the global namespace
 
-### New methods
+  ### New methods
 
-  * `Stage#deploy`
-  * `Stage#maintenance` can now take a block, and ensures that maintenance mode is off afterwards.
-  * `Stage#push_config`
+    * `Stage#deploy`
+    * `Stage#maintenance` can now take a block, and ensures that maintenance mode is off afterwards.
+    * `Stage#push_config`
   
 ## v2.0.0
 

data/README.rdoc

@@ -7,7 +7,7 @@ Helpful rake tasks for Heroku.
 
 === Rails 3
 
-Add this to your Gemfile:
+Add this to your `Gemfile`:
 
   group :development do
     gem 'heroku_san'
@@ -15,11 +15,11 @@ Add this to your Gemfile:
 
 === Rails 2
 
-To install add the following to config/environment.rb:
+To install add the following to `config/environment.rb`:
 
   config.gem 'heroku_san'
 
-Rake tasks are not automatically loaded from gems, so you’ll need to add the following to your Rakefile:
+Rake tasks are not automatically loaded from gems, so you’ll need to add the following to your `Rakefile`:
 
   begin
     require 'heroku_san/tasks'
@@ -27,17 +27,39 @@ Rake tasks are not automatically loaded from gems, so you’ll need to add the f
     STDERR.puts "Run `rake gems:install` to install heroku_san"
   end
 
+=== Sinatra
+
+Update your `Gemfile`:
+
+  group :development do
+    gem 'heroku_san'
+  end
+
+Update your `Rakefile`:
+
+  require "bundler/setup"
+  require "heroku_san"
+  config_file = File.join(File.expand_path(File.dirname(__FILE__)), 'config', 'heroku.yml')
+  HerokuSan.project = HerokuSan::Project.new(config_file, :deploy => HerokuSan::Deploy::Sinatra)
+  load "heroku_san/tasks.rb"
+
 == Configure
 
-In config/heroku.yml you will need to add the Heroku apps that you would like to attach to this project. You can generate this file by running:
+In `config/heroku.yml` you will need to add the Heroku apps that you would like to attach to this project. You can generate this file by running:
+
+=== Rails 3
+
+  rails generate heroku_san
+  
+=== Everything else
 
   rake heroku:create_config
 
-Customize the file for your project. If this is a fresh project, heroku_san can create all the applications for you, and set each one's RACK_ENV.
+Customize the file for your project. If this is a fresh project, `heroku_san` can create all the applications for you, and set each one's RACK_ENV.
 
   rake all heroku:create heroku:rack_env
 
-Configure your Heroku apps according to config/heroku.yml by running:
+Configure your Heroku apps according to `config/heroku.yml` by running:
 
   rake all heroku:config
 
@@ -55,7 +77,7 @@ is additive, you can easily select which servers to run a command on.
   rake demo staging restart
 
 A special rake task 'all' is created that causes any further commands to
-execute on all heroku apps.
+execute on all Heroku apps.
 
 Manipulate collaborators on all this project's apps (prompts for email
 address):
@@ -139,4 +161,4 @@ Issue Tracker:: http://github.com/fastestforward/heroku_san/issues
 
 == License
 
-License:: Copyright (c) 2009-2012 Elijah Miller <mailto:elijah.miller@gmail.com>, released under the MIT license.
+License:: Copyright (c) 2008-2012 Elijah Miller <mailto:elijah.miller@gmail.com>, released under the MIT license.

data/features/config.feature

@@ -1,7 +1,7 @@
 Feature: Command Line
 
   Background:
-    Given I run `rails new heroku_san_test -O`
+    Given I run `rails new heroku_san_test --quiet --force --database=postgresql --skip-bundle --skip-javascript --skip-test-unit --skip-sprockets`
     And I cd to "heroku_san_test"
     And I overwrite "Gemfile" with:
       """
@@ -20,7 +20,8 @@ Feature: Command Line
       demo: 
         app: awesomeapp-demo
       development:
-        app:
+        app: 
+      
       """
 
     When I run `rake --trace heroku:apps:local`
@@ -72,3 +73,11 @@ Feature: Command Line
     When I run `rake EDITOR=echo --trace heroku:create_config`
     And the output should match /Copied example config to ".*.config.heroku.yml"/
     And the output should match /^echo .*.config.heroku.yml$/
+
+  Scenario: rails generate heroku_san
+    When I run `rails generate`
+    Then the output should not contain "Could not find generator heroku_san."
+    And the output should contain "HerokuSan:\n  heroku_san"
+    When I run `rails generate heroku_san`
+    Then a file named "config/heroku.yml" should exist
+    And the output should contain "create  config/heroku.yml"

data/features/extended-config.feature

@@ -14,7 +14,7 @@ Feature: Extended config
     And I run `git add .`
     And I run `git commit -m 'Initial commit'`
     And I cd to ".."
-    Given I run `rails new heroku_san_test -O`
+    Given I run `rails new heroku_san_test --quiet --force --database=postgresql --skip-bundle --skip-javascript --skip-test-unit --skip-sprockets`
     And I cd to "heroku_san_test"
     And I overwrite "Gemfile" with:
       """

data/features/remote.feature

@@ -12,9 +12,31 @@ Feature: heroku_san can control a project on Heroku
     And I run bundle install
     Then rake reports that the heroku: tasks are available 
     
-  Scenario: Manipulates the project on Heroku
+  Scenario: Manipulates a Rails app on Heroku
     Given I have a new Rails project
     When I am in the project directory
+    And I commit any changes with "Initial commit"
+    And I add heroku_san to the Gemfile
+    And I run bundle install
+    And I generate a new config file
+    And I create my project on Heroku
+    And I list the remote configuration
+    And I curl the app home page
+    And I configure my project
+    And I turn maintenance on
+    And I generate a scaffold
+    And I commit any changes with "Added droids"
+    And I deploy my project
+    And I turn maintenance off
+    And I restart my project
+    And I list all apps on Heroku
+    And I install an addon
+    Then heroku_san is green
+    
+  Scenario: Manipulates a Sinatra app on Heroku
+    Given I have a new Sinatra project
+    When I am in the project directory
+    And I commit any changes with "Initial commit"
     And I add heroku_san to the Gemfile
     And I run bundle install
     And I create a new config/heroku.yml file
@@ -23,6 +45,8 @@ Feature: heroku_san can control a project on Heroku
     And I curl the app home page
     And I configure my project
     And I turn maintenance on
+    And I add a new action
+    And I commit any changes with "Added droids"
     And I deploy my project
     And I turn maintenance off
     And I restart my project

data/features/step_definitions/remote_steps.rb

@@ -1,62 +1,102 @@
 World(Aruba::Api)
+require 'active_support/core_ext/string/strip'
 
 Given /^I have a new Rails project$/ do
-  cmd = "rails new heroku_san_test --quiet --force --database=postgresql --skip-bundle --skip-javascript --skip-test-unit --skip-sprockets"
+  cmd = "rails new test_app --quiet --force --database=postgresql --skip-bundle --skip-javascript --skip-test-unit --skip-sprockets"
   run_simple unescape(cmd)
 end
 
+Given /^I have a new Sinatra project$/ do
+  create_dir 'test_app/config'
+  write_file 'test_app/app.rb', <<EOT.strip_heredoc
+    require 'sinatra'
+
+    get '/' do
+      'Hello, world.'
+    end
+EOT
+
+  write_file 'test_app/config.ru', <<EOT.strip_heredoc
+    require './app'
+    run Sinatra::Application
+EOT
+
+  write_file 'test_app/Gemfile', <<EOT.strip_heredoc
+    source 'http://rubygems.org'
+    gem 'sinatra'
+EOT
+
+  write_file 'test_app/Rakefile', <<EOT.strip_heredoc
+    require "bundler/setup"
+    require "heroku_san"
+    config_file = File.join(File.expand_path(File.dirname(__FILE__)), 'config', 'heroku.yml')
+    HerokuSan.project = HerokuSan::Project.new(config_file, :deploy => HerokuSan::Deploy::Sinatra)
+    load "heroku_san/tasks.rb"
+EOT
+
+end
+
 When /^I am in the project directory$/ do
-    cd '/heroku_san_test'
+  cd '/test_app'
+  run_simple 'git init .'
+end
+
+When /^I commit any changes with "(.*)"$/ do |message|
+  run_simple 'git add .'
+  run_simple "git commit -m '#{message}'"
 end
 
 When /^I add heroku_san to the Gemfile$/ do
-  append_to_file 'Gemfile', <<EOT
+  append_to_file 'Gemfile', <<EOT.strip_heredoc
     group :development, :test do
       gem 'heroku_san', :path => '../../../.'
     end
 EOT
+
 end
 
 When /^I run bundle install$/ do
   use_clean_gemset 'heroku_san_test'
   run_simple 'bundle install --quiet'
-  write_file '.rvmrc', "rvm use default@heroku_san_test\n"
 end
 
 Then /^rake reports that the heroku: tasks are available$/ do
-  run_simple 'rake -T heroku:'
-  output = stdout_from 'rake -T heroku:'
+  run_simple 'bundle exec rake -T heroku:'
+  output = stdout_from 'bundle exec rake -T heroku:'
   assert_partial_output 'rake heroku:apps', output
 end
 
+When /^I generate a new config file$/ do
+  run_simple 'bundle exec rails generate heroku_san'
+  output = stdout_from 'bundle exec rails generate heroku_san'
+  assert_partial_output 'create  config/heroku.yml', output
+  overwrite_simple_config_file
+end
+
 When /^I create a new config\/heroku\.yml file$/ do
-  run_simple 'rake heroku:create_config'
-  output = stdout_from 'rake heroku:create_config'
+  run_simple 'bundle exec rake heroku:create_config'
+  output = stdout_from 'bundle exec rake heroku:create_config'
   assert_matching_output %q{Copied example config to ".*.config.heroku.yml"}, output
   assert_matching_output %q{Please edit ".*.config.heroku.yml" with your application's settings.}, output
-  
-  overwrite_file 'config/heroku.yml', <<EOT
----
-test_app:
-EOT
+  overwrite_simple_config_file
 end
 
 When /^I create my project on Heroku$/ do
-  cmd = 'rake test_app heroku:create'
+  cmd = 'bundle exec rake test_app heroku:create'
   run_simple unescape(cmd)
   output = stdout_from cmd
   assert_matching_output %q{test_app: Created ([\w-]+)}, output
   
   @app = output.match(/test_app: Created ([\w-]+)/)[1]
-  overwrite_file 'config/heroku.yml', <<EOT
----
-test_app:
-  app: #{@app}
+  overwrite_file 'config/heroku.yml', <<EOT.strip_heredoc
+    ---
+    test_app:
+      app: #{@app}
 EOT
 end
 
 When /^I list the remote configuration$/ do
-  cmd = 'rake test_app heroku:config:list'
+  cmd = 'bundle exec rake test_app heroku:config:list'
   run_simple unescape(cmd)
   output = stdout_from cmd
   assert_partial_output "APP_NAME: #{@app}", output
@@ -73,22 +113,22 @@ When /^I curl the app home page$/ do
 end
 
 When /^I configure my project$/ do
-  overwrite_file 'config/heroku.yml', <<EOT
----
-test_app:
-  app: #{@app}
-  config:
-    DROIDS: marvin
+  overwrite_file 'config/heroku.yml', <<EOT.strip_heredoc
+    ---
+    test_app:
+      app: #{@app}
+      config:
+        DROIDS: marvin
 EOT
-  cmd = 'rake test_app heroku:config'
+  cmd = 'bundle exec rake test_app heroku:config'
   run_simple cmd
   output = stdout_from cmd
   assert_partial_output 'DROIDS: marvin', output
 end
 
 When /^I turn maintenance on$/ do
-  run_simple 'rake test_app heroku:maintenance_on'
-  output = stdout_from 'rake test_app heroku:maintenance_on'
+  run_simple 'bundle exec rake test_app heroku:maintenance_on'
+  output = stdout_from 'bundle exec rake test_app heroku:maintenance_on'
   assert_partial_output 'test_app: Maintenance mode enabled.', output
   
   run_simple @curl
@@ -97,26 +137,35 @@ When /^I turn maintenance on$/ do
 end
 
 When /^I turn maintenance off$/ do
-  run_simple 'rake test_app heroku:maintenance_off'
-  output = stdout_from 'rake test_app heroku:maintenance_off'
+  run_simple 'bundle exec rake test_app heroku:maintenance_off'
+  output = stdout_from 'bundle exec rake test_app heroku:maintenance_off'
   assert_partial_output 'test_app: Maintenance mode disabled.', output
   assert_app_is_running
 end
 
 When /^I restart my project$/ do
-  run_simple 'rake test_app heroku:restart'
-  output = stdout_from 'rake test_app heroku:restart'
+  run_simple 'bundle exec rake test_app heroku:restart'
+  output = stdout_from 'bundle exec rake test_app heroku:restart'
   assert_partial_output 'test_app: Restarted.', output
   assert_app_is_running
 end
 
-When /^I deploy my project$/ do
-  run_simple 'git init .'
-  run_simple 'rails generate scaffold droid'
+When /^I generate a scaffold$/ do
+  run_simple 'bundle exec rails generate scaffold droid'
   append_to_file 'app/views/droids/index.html.erb', %Q{\n<div><code><%= ENV['DROIDS'] -%></code></div>\n}
-  run_simple 'git add .'
-  run_simple 'git commit -m "Initial commit"'
-  run_simple 'rake test_app deploy'
+end
+
+When /^I add a new action$/ do
+  append_to_file 'app.rb', <<'EOT'.strip_heredoc
+
+    get '/droids' do
+      "<div><code>#{ENV['DROIDS']}</code></div>"
+    end
+EOT
+end
+
+When /^I deploy my project$/ do
+  run_simple 'bundle exec rake test_app deploy'
   assert_partial_output "http://#{@app}.heroku.com deployed to Heroku", all_output
 end
 
@@ -124,8 +173,8 @@ When /^I list all apps on Heroku$/ do
   sha = in_current_dir do
     `git rev-parse HEAD`.chomp
   end
-  run_simple 'rake heroku:apps'
-  output = stdout_from 'rake heroku:apps'
+  run_simple 'bundle exec rake heroku:apps'
+  output = stdout_from 'bundle exec rake heroku:apps'
   assert_partial_output "test_app is shorthand for the Heroku app #{@app} located at:", output
   assert_partial_output "git@heroku.com:#{@app}.git", output
   assert_partial_output "@ #{sha} master", output
@@ -133,14 +182,15 @@ end
 
 When /^I install an addon$/ do
   # Install the campfire addon.
-  overwrite_file 'config/heroku.yml', <<END_CONFIG
-test_app:
-  app: #{@app}
-  addons:
-    - deployhooks:campfire
+  overwrite_file 'config/heroku.yml', <<END_CONFIG.strip_heredoc
+    test_app:
+      app: #{@app}
+      addons:
+        - deployhooks:campfire
 END_CONFIG
-  run_simple 'rake test_app heroku:addons'
-  output = stdout_from 'rake test_app heroku:addons'
+
+  run_simple 'bundle exec rake test_app heroku:addons'
+  output = stdout_from 'bundle exec rake test_app heroku:addons'
   # The output should show the default addons...
   assert_partial_output "shared-database:5mb", output
   # ... and the new one ...
@@ -150,7 +200,7 @@ END_CONFIG
 end
 
 Then /^heroku_san is green$/ do
-  run_simple "heroku apps:destroy #{@app} --confirm #{@app}"
+  run_simple "bundle exec heroku apps:destroy #{@app} --confirm #{@app}"
 end
 
 def assert_app_is_running
@@ -158,3 +208,11 @@ def assert_app_is_running
   output = stdout_from @curl + "/droids"
   assert_partial_output %Q{<code>marvin</code>}, output
 end
+
+def overwrite_simple_config_file
+  overwrite_file 'config/heroku.yml', <<EOT.strip_heredoc
+    ---
+    test_app:
+EOT
+
+end

data/heroku_san.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<heroku>, ['>= 2'])
       s.add_runtime_dependency(%q<heroku-api>, ['>= 0.1.2'])
       s.add_runtime_dependency(%q<rake>)
+      s.add_runtime_dependency('activesupport')
       s.add_development_dependency(%q<aruba>)
       s.add_development_dependency(%q<cucumber>)
       s.add_development_dependency(%q<rake>)

data/lib/generators/heroku_san_generator.rb

@@ -0,0 +1,7 @@
+class HerokuSanGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../templates", __FILE__)
+
+  def copy_initializer_file
+    copy_file "heroku.example.yml", "config/heroku.yml"
+  end
+end

data/lib/heroku_san/deploy/base.rb

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

data/lib/heroku_san/deploy/rails.rb

@@ -0,0 +1,13 @@
+require 'heroku_san/deploy/base'
+
+module HerokuSan
+  module Deploy
+    class Rails < HerokuSan::Deploy::Base
+      def deploy
+        $stderr.puts super
+        $stderr.puts @stage.rake('db:migrate')
+        $stderr.puts @stage.restart
+      end
+    end
+  end
+end

data/lib/heroku_san/deploy/sinatra.rb

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

data/lib/heroku_san/project.rb

@@ -1,16 +1,19 @@
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/hash/slice'
+
 module HerokuSan
   class Project
     attr_reader :config_file
   
     include Git
     
-    def initialize(config_file)
+    def initialize(config_file, options = {})
       @apps = []
       @config_file = config_file
       @app_settings = {}
       config = parse(@config_file)
       config.each do |stage, settings|
-        @app_settings[stage] = HerokuSan::Stage.new(stage, settings)
+        @app_settings[stage] = HerokuSan::Stage.new(stage, settings.merge(options.slice(:deploy)))
       end
     end
 

data/lib/heroku_san/stage.rb

@@ -1,6 +1,8 @@
 require 'heroku'
 require 'heroku/api'
 require 'json'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/keys'
 
 MOCK = false unless defined?(MOCK)
 
@@ -10,8 +12,11 @@ module HerokuSan
     include Git
     
     def initialize(stage, options = {})
+      default_options = {
+        'deploy' => HerokuSan::Deploy::Rails
+      }
       @name = stage
-      @options = options
+      @options = default_options.merge(options.stringify_keys)
     end
     
     def heroku
@@ -50,7 +55,7 @@ module HerokuSan
       end
     end
     
-    def deploy(sha = nil, force = false)
+    def push(sha = nil, force = false)
       sha ||= git_parsed_tag(tag)
       git_push(sha, repo, force ? %w[--force] : [])
     end
@@ -60,6 +65,11 @@ module HerokuSan
       restart
     end
     
+    def deploy(args = {})
+      strategy = @options['deploy'].new(self, args)
+      strategy.deploy
+    end
+    
     def rake(*args)
       run 'rake', args.join(' ')
       # heroku.rake app, args.join(' ')
@@ -79,7 +89,7 @@ module HerokuSan
       end
     end
     
-    def create # DEPREC?
+    def create
       params = Hash[@options.select{|k,v| %w[app stack].include? k}].stringify_keys
       params['name'] = params.delete('app')
       response = heroku.post_app(params)
@@ -134,19 +144,3 @@ module HerokuSan
     end
   end
 end
-
-# from ActiveSupport
-class Hash
-  # Return a new hash with all keys converted to strings.
-  def stringify_keys
-    dup.stringify_keys!
-  end
-
-  # Destructively convert all keys to strings.
-  def stringify_keys!
-    keys.each do |key|
-      self[key.to_s] = delete(key)
-    end
-    self
-  end
-end