heroku-rails 0.0.1 → 0.2.0

data/CHANGELOG

@@ -1,4 +1,14 @@
 Heroku Rails
+
+v0.2.0
+============================================
+Added Heroku Settings tasks, and rails generators
+
+Cleaned out lots of tasks that are now handled by editing config/heroku.yml and running `rake heroku:setup`
+
+Namespaced tasks such as heroku:deploy, heroku:console, etc. The only top level task now is `rake all ...` which sets all the environments. Individual environment tasks (e.g. `rake production ...`) are still generated without a namespace.
+
+
 v0.0.1
 ============================================
 Initial fork and reorganization

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heroku-rails (0.0.1)
+    heroku-rails (0.2.0)
       heroku
 
 GEM

data/README.md

@@ -35,76 +35,119 @@ Rake tasks are not automatically loaded from gems, so you’ll need to add the f
 
 In config/heroku.yml you will need add the Heroku apps that you would like to attach to this project. You can generate this file and edit it by running:
 
-    rake heroku:create_config
+    rails generate heroku:config
 
-If this is a fresh project, heroku_san can create all the applications for
-you, and set the RACK_ENV.
+Then edit config/heroku.yml with your project's heroku configurations. To persist the changes onto Heroku, just run:
 
-    rake all heroku:create heroku:rack_env
+    rake all heroku:setup
+
+This will create the heroku apps you have defined, and create the settings for each.
 
 ## Usage
 
 After configuring your Heroku apps you can use rake tasks to control the
 apps.
 
-    rake production deploy
+    rake production heroku:deploy
 
 A rake task with the shorthand name of each app is now available and adds that
 server to the list that subsequent commands will execute on. Because this list
 is additive, you can easily select which servers to run a command on.
 
-    rake demo staging restart
+    rake demo staging heroku:restart
 
 A special rake task 'all' is created that causes any further commands to
 execute on all heroku apps.
 
-Manipulate collaborators on all this project's apps (prompts for email
-address):
-
-    rake all heroku:share
-    rake all heroku:unshare
-
 Need to add remotes for each app?
 
     rake all heroku:remotes
 
 A full list of tasks provided:
 
-    rake all                   # Select all Heroku apps for later command
-    rake console               # Opens a remote console
-    rake deploy                # Deploys, migrates and restarts latest code.
-    rake after_deploy          # Callback run after the overall deploy
-    rake after_each_deploy     # Callback run after each environment's deploy
-    rake before_deploy         # Callback run before the overall deploy
-    rake before_each_deploy    # Callback run before each environment's deploy
-    rake capture               # Captures a bundle on Heroku
-    rake heroku:apps           # Lists configured apps
-    rake heroku:create         # Creates the Heroku app
-    rake heroku:create_config  # Creates an example configuration file
-    rake heroku:gems           # Generate the Heroku gems manifest from gem dependencies
-    rake heroku:remotes        # Add git remotes for all apps in this project
-    rake heroku:rack_env       # Add proper RACK_ENV to each application
-    rake heroku:share          # Adds a collaborator
-    rake heroku:unshare        # Removes a collaborator
-    rake migrate               # Migrates and restarts remote servers
-    rake restart               # Restarts remote servers
-
-Frequently used tasks are not namespaced, everything else lives under heroku.
+    rake all                        # Select all Heroku apps for later command
+    rake heroku:deploy              # Deploys, migrates and restarts latest code.
+    rake heroku:apps                # Lists configured apps
+    rake heroku:info                # Queries the heroku status info on each app
+    rake heroku:console             # Opens a remote console
+    rake heroku:capture             # Captures a bundle on Heroku
+    rake heroku:remotes             # Add git remotes for all apps in this project
+    rake heroku:migrate             # Migrates and restarts remote servers
+    rake heroku:restart             # Restarts remote servers
+
+    rake heroku:setup               # runs all heroku setup scripts
+    rake heroku:setup:addons        # sets up the heroku addons
+    rake heroku:setup:collaborators # sets up the heroku collaborators
+    rake heroku:setup:config        # sets up the heroku config env variables
+    rake heroku:setup:domains       # sets up the heroku domains
+    rake heroku:setup:stacks        # sets the correct stack for each heroku app
+
+    rake heroku:db:setup            # Migrates and restarts remote servers
+
+You can easily alias frequently used tasks within your application's Rakefile:
+
+    task :deploy =>  ["heroku:deploy"]
+    task :console => ["heroku:console"]
+    task :capture => ["heroku:capture"]
+
+With this in place, you can be a bit more terse:
+
+    rake staging console
+    rake all deploy
+
+### Deploy Hooks
+
+You can easily hook into the deploy process by defining any of the following rake tasks:
+
+You can generate these automatically within lib/tasks/heroku.rake by running:
+
+    rails generate heroku:callbacks
+
+
+Then edit the rake tasks to provide custom logic for each of these steps
+
+    namespace :heroku do
+
+      # runs before all the deploys complete
+      task :before_deploy do
+
+      end
+
+      # runs before each push to a particular heroku deploy environment
+      task :before_each_deploy do
+
+      end
+
+      # runs after each push to a particular heroku deploy environment
+      task :after_each_deploy do
+
+      end
+
+      # runs after all the deploys complete
+      task :after_deploy do
+
+      end
+
+    end
+
+
+
 
 ## About Heroku Rails
 
 ### Links
 
-Homepage:: http://github.com/railsjedi/heroku-rails
-Issue Tracker:: http://github.com/railsjedi/heroku-rails/issues
+Homepage:: <http://github.com/railsjedi/heroku-rails>
+
+Issue Tracker:: <http://github.com/railsjedi/heroku-rails/issues>
 
 ### License
 
-License:: Copyright (c) 2010 [Jacques Crocker](mailto:railsjedi@gmail.com), released under the MIT license.
+License:: Copyright (c) 2010 Jacques Crocker <railsjedi@gmail.com> released under the MIT license.
 
 ## Forked from Heroku Sans
 
-Heroku Rails is a fork and rewrite/reorganiziation of Heroku Sans, and a nice simple set of Rake tasks for managing Heroku environments. Check out that project here: http://github.com/fastestforward/heroku_san
+Heroku Rails is a fork and rewrite/reorganiziation of Heroku Sans, and a nice simple set of Rake tasks for managing Heroku environments. Check out that project here: <http://github.com/fastestforward/heroku_san>
 
 ### Heroku Sans Contributors
 
@@ -114,4 +157,4 @@ Heroku Rails is a fork and rewrite/reorganiziation of Heroku Sans, and a nice si
 
 ### Heroku Sans License
 
-License:: Copyright (c) 2009 Elijah Miller <mailto:elijah.miller@gmail.com>, released under the MIT license.
+License:: Copyright (c) 2009 Elijah Miller <elijah.miller@gmail.com>, released under the MIT license.

data/TODO

@@ -1,2 +1,5 @@
-  - refactor config/helpers out of tasks.rb into own file(s)
-  - 
+√ refactor config/helpers out of tasks.rb into own file(s)
+√ add config setup tasks (DONE)
+√ add proper rails3 generator support
+√ add hooks to allow other precompilations before deploy
+- add sass/coffeescript precompile + jammit-s3 support

data/heroku-rails.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name = "heroku-rails"
-  s.version = "0.0.1"
+  s.version = "0.2.0"
 
   s.authors = ["Elijah Miller", "Glenn Roberts", "Jacques Crocker"]
-  s.summary = "A bunch of useful Rake tasks for managing your Heroku apps"
-  s.description = "Manage multiple Heroku instances/apps for a single Rails app using Rake"
+  s.summary = "Deployment and configuration tools for Heroku/Rails"
+  s.description = "Manage multiple Heroku instances/apps for a single Rails app using Rake. It's the Capistrano for Heroku, without the suck."
 
   s.email = "railsjedi@gmail.com"
   s.homepage = "http://github.com/railsjedi/heroku-rails"

data/lib/generators/heroku/callbacks_generator.rb

@@ -0,0 +1,15 @@
+module Heroku
+  module Generators
+    class CallbacksGenerator < ::Rails::Generators::Base
+      desc "Generates the rake tasks (lib/tasks/heroku.rake) that let you override heroku deploy callbacks"
+
+      def self.source_root
+        @_heroku_gen_source_root ||= File.expand_path("../../templates", __FILE__)
+      end
+
+      def create_callbacks_rake_file
+        template 'heroku.rake', File.join('lib', 'tasks', "heroku.rake")
+      end
+    end
+  end
+end

data/lib/generators/heroku/config_generator.rb

@@ -0,0 +1,15 @@
+module Heroku
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      desc "Generates a Heroku Config file at config/heroku.yml"
+
+      def self.source_root
+        @_heroku_gen_source_root ||= File.expand_path("../../templates", __FILE__)
+      end
+
+      def create_config_file
+        template 'heroku.yml', File.join('config', "heroku.yml")
+      end
+    end
+  end
+end

data/lib/generators/templates/heroku.rake

@@ -0,0 +1,24 @@
+# Heroku Deploy Callbacks
+namespace :heroku do
+
+  # runs before all the deploys complete
+  task :before_deploy do
+
+  end
+
+  # runs before each push to a particular heroku deploy environment
+  task :before_each_deploy do
+
+  end
+
+  # runs after each push to a particular heroku deploy environment
+  task :after_each_deploy do
+
+  end
+
+  # runs after all the deploys complete
+  task :after_deploy do
+
+  end
+
+end

data/lib/generators/templates/heroku.yml

@@ -0,0 +1,51 @@
+apps:
+  # map the environments to your desired heroku app names
+  # for example,
+  #   production: awesomeapp
+  # would create the RACK_ENV=production
+  # and deploy to http://awesomeapp.heroku.com
+  production: awesomeapp
+  staging: awesomeapp-staging
+  legacy: awesomeapp-legacy
+
+stacks:
+  # choose the stacks you want to use for each app.
+  # the all: setting sets the default
+  all: bamboo-mri-1.9.2
+
+  # override on a per environment basis
+  legacy: bamboo-ree-1.8.7
+
+config:
+  # choose the configuration settings for all environments
+  all:
+    BUNDLE_WITHOUT: "test development"
+    CONFIG_VAR1: "config1"
+    CONFIG_VAR2: "config2"
+
+  # you can also override configuration settings for each environment
+  production:
+    CONFIG_VAR1: "config1-production"
+  staging:
+    CONFIG_VAR1: "config1-staging"
+
+collaborators:
+  all:
+    - "my-heroku-email@somedomain.com"
+    - "another-heroku-email@somedomain.com"
+
+domains:
+  production:
+    - "awesomeapp.com"
+    - "www.awesomeapp.com"
+
+addons:
+  all:
+    # add any other addons here
+    - custom_domains:basic
+    - newrelic:bronze
+
+  production:
+    # list production env specific addons here
+    - ssl:piggyback
+    - cron:hourly

data/lib/heroku-rails.rb

@@ -1,9 +1,3 @@
-module Heroku
-  module Rails
-    class Railtie < ::Rails::Railtie
-      rake_tasks do
-        load 'heroku/rails/tasks.rb'
-      end
-    end
-  end
-end
+require 'heroku/rails/heroku_config'
+require 'heroku/rails/heroku_runner'
+require 'heroku/rails/railtie' if defined?(::Rails::Railtie)

data/lib/heroku/rails/heroku_config.rb

@@ -0,0 +1,69 @@
+module Heroku
+  module Rails
+    class HerokuConfig
+
+      attr_accessor :settings
+
+      def initialize(config_filepath)
+        if File.exists?(config_filepath)
+          self.settings = YAML.load_file(config_filepath) || {}
+        else
+          self.settings = {}
+        end
+      end
+
+      def apps
+        self.settings['apps']
+      end
+
+      def app_names
+        self.settings['apps'].values
+      end
+
+      def app_environments
+        self.settings['apps'].keys
+      end
+
+      # return the stack setting for a particular app environment
+      def stack(app_env)
+        stacks = self.settings['stacks'] || {}
+        stacks[app_env] || stacks['all']
+      end
+
+      # pull out the config setting hash for a particular app environment
+      def config(app_env)
+        config = self.settings['config'] || {}
+        all = config['all'] || {}
+
+        # overwrite all configs with the environment specific ones
+        all.merge(config[app_env] || {})
+      end
+
+      # return a list of domains for a particular app environment
+      def domains(app_env)
+        domains = self.settings['domains'] || {}
+        domains[app_env] || []
+      end
+
+      # return a list of collaborators for a particular app environment
+      def collaborators(app_env)
+        app_setting_list('collaborators', app_env)
+      end
+
+      # return a list of addons for a particular app environment
+      def addons(app_env)
+        app_setting_list('addons', app_env)
+      end
+
+      protected
+
+      def app_setting_list(setting_key, app)
+        setting = self.settings[setting_key] || {}
+        all = setting['all'] || []
+
+        # add in collaborators from app environment to the ones defined in all
+        (all + (setting[app] || [])).uniq
+      end
+    end
+  end
+end

data/lib/heroku/rails/heroku_runner.rb

@@ -0,0 +1,242 @@
+require 'heroku/client'
+
+module Heroku
+  module Rails
+    class HerokuRunner
+      def initialize(config)
+        @config = config
+        @environments = []
+      end
+
+      def authorize
+        return if @heroku
+
+        # setup heroku username and password so we can start up a heroku client
+        credentials_path = File.expand_path("~/.heroku/credentials")
+
+        # read in the username,password so we can build the client
+        if File.exists?(credentials_path)
+          auth = File.read(credentials_path)
+          username, password = auth.split("\n")
+          @heroku = Heroku::Client.new(username, password)
+        else
+          puts "Heroku not set up. Run `heroku list` in order to input your credentials and try again"
+          exit(1)
+        end
+      end
+
+      # add a specific environment to the run list
+      def add_environment(env)
+        @environments << env
+      end
+
+      # use all environments
+      def all_environments
+        @environments = @config.app_environments
+      end
+
+      # setup apps (create if necessary)
+      def setup_apps
+        authorize unless @heroku
+
+        # get a list of all my current apps on Heroku (so we don't create dupes)
+        @my_apps = @heroku.list.map{|a| a.first}
+
+        each_heroku_app do |heroku_env, app_name, repo|
+          next if @my_apps.include?(app_name)
+
+          stack = @config.stack(heroku_env)
+          stack_option = " --stack #{stack}" if stack.to_s.size > 0
+          system_with_echo "heroku create #{app_name}#{stack_option} --remote #{app_name}"
+        end
+      end
+
+      # setup the stacks for each app (migrating if necessary)
+      def setup_stacks
+        authorize unless @heroku
+        each_heroku_app do |heroku_env, app_name, repo|
+          # get the intended stack setting
+          stack = @config.stack(heroku_env)
+
+          # get the remote info about the app from heroku
+          heroku_app_info = @heroku.info(app_name) || {}
+
+          # if the stacks don't match, then perform a migration
+          if stack != heroku_app_info[:stack]
+            puts "Migrating the app: #{app_name} to the stack: #{stack}"
+            system_with_echo "heroku stack:migrate #{stack} --app #{app_name}"
+          end
+        end
+      end
+
+      # setup the list of collaborators
+      def setup_collaborators
+        authorize unless @heroku
+        each_heroku_app do |heroku_env, app_name, repo|
+          # get the remote info about the app from heroku
+          heroku_app_info = @heroku.info(app_name) || {}
+
+          # get the intended list of collaborators to add
+          collaborator_emails = @config.collaborators(heroku_env)
+
+          # get existing collaborators
+          existing_emails = heroku_app_info[:collaborators].to_a.map{|c| c[:email]}
+
+          # get the list of collaborators to delete
+          existing_emails.each do |existing_email|
+            # check to see if we need to delete this person
+            unless collaborator_emails.include?(existing_email)
+              # delete that collaborator if they arent on the approved list
+              system_with_echo "heroku sharing:remove #{existing_email} --app #{app_name}"
+            end
+          end
+
+          # get the list of collaborators to add
+          collaborator_emails.each do |collaborator_email|
+            # check to see if we need to add this person
+            unless existing_emails.include?(collaborator_email)
+              # add the collaborator if they are not already on the server
+              system_with_echo "heroku sharing:add #{collaborator_email} --app #{app_name}"
+            end
+          end
+        end
+      end
+
+      # setup configuration
+      def setup_config
+        authorize unless @heroku
+        each_heroku_app do |heroku_env, app_name, repo|
+          # get the configuration that we are aiming towards
+          new_config = @config.config(heroku_env)
+
+          # default RACK_ENV to the heroku_env (unless its manually set to something else)
+          unless new_config["RACK_ENV"].to_s.length > 0
+            new_config["RACK_ENV"] = heroku_env
+          end
+
+          # get the existing config from heroku's servers
+          existing_config = @heroku.config_vars(app_name) || {}
+
+          # find the config variables to add
+          add_config = {}
+          new_config.each do |new_key, new_val|
+            add_config[new_key] = new_val unless existing_config[new_key] == new_val
+          end
+
+          # persist the changes onto heroku
+          unless add_config.empty?
+            # add the config
+            set_config = ""
+            add_config.each do |key, val|
+              set_config << "#{key}='#{val}' "
+            end
+
+            system_with_echo "heroku config:add #{set_config} --app #{app_name}"
+          end
+        end
+      end
+
+      # setup the addons for heroku
+      def setup_addons
+        authorize unless @heroku
+        each_heroku_app do |heroku_env, app_name, repo|
+          # get the addons that we are aiming towards
+          addons = @config.addons(heroku_env)
+
+          # get the addons that are already on the servers
+          existing_addons = (@heroku.installed_addons(app_name) || []).map{|a| a["name"]}
+
+          # add "custom_domains" if that addon doesnt already exist
+          # and we have domains configured for this app
+          addons << "custom_domains:basic" unless @config.domains(heroku_env).empty? or
+                                                  addons.any?{|a| a =~ /custom_domains/} or
+                                                  existing_addons.any?{|a| a =~ /custom_domains/}
+
+          # remove the addons that need to be removed
+          existing_addons.each do |existing_addon|
+            # check to see if we need to delete this addon
+            unless addons.include?(existing_addon)
+              # delete this addon if they arent on the approved list
+              system_with_echo "heroku addons:remove #{existing_addon} --app #{app_name}"
+            end
+          end
+
+          # add the addons that dont exist already
+          addons.each do |addon|
+            # check to see if we need to add this addon
+            unless existing_addons.include?(addon)
+              # add this addon if they are not already added
+              system_with_echo "heroku addons:add #{addon} --app #{app_name}"
+            end
+          end
+        end
+      end
+
+      # setup the domains for heroku
+      def setup_domains
+        authorize unless @heroku
+        each_heroku_app do |heroku_env, app_name, repo|
+          # get the domains that we are aiming towards
+          domains = @config.domains(heroku_env)
+
+          # get the domains that are already on the servers
+          existing_domains = (@heroku.list_domains(app_name) || []).map{|a| a[:domain]}
+
+          # remove the domains that need to be removed
+          existing_domains.each do |existing_domain|
+            # check to see if we need to delete this domain
+            unless domains.include?(existing_domain)
+              # delete this domain if they arent on the approved list
+              system_with_echo "heroku domains:remove #{existing_domain} --app #{app_name}"
+            end
+          end
+
+          # add the domains that dont exist already
+          domains.each do |domain|
+            # check to see if we need to add this domain
+            unless existing_domains.include?(domain)
+              # add this domain if they are not already added
+              system_with_echo "heroku domains:add #{domain} --app #{app_name}"
+            end
+          end
+        end
+      end
+
+      # cycles through each configured heroku app
+      # yields the environment name, the app name, and the repo url
+      def each_heroku_app
+        if @environments.blank? && @config.apps.size == 1
+          puts "Defaulting to #{env} app since only one app is defined"
+          @environments = [@config.app_environments.first]
+        end
+
+        if @environments.present?
+          @environments.each do |heroku_env|
+            app_name = @config.apps[heroku_env]
+            yield(heroku_env, app_name, "git@heroku.com:#{app_name}.git")
+          end
+        else
+          puts "You must first specify at least one Heroku app:
+            rake <app> [<app>] <command>
+            rake production restart
+            rake demo staging deploy"
+
+          puts "\nYou can use also command all Heroku apps for this project:
+            rake all heroku:share"
+
+          exit(1)
+        end
+      end
+
+      def system_with_echo(*args)
+        puts args.join(' ')
+        command(*args)
+      end
+
+      def command(*args)
+        system(*args)
+      end
+
+    end
+  end
+end