porter 1.0.2 → 1.1.0

data/Gemfile

@@ -1,4 +1,3 @@
-source "http://rubygems.org"
+source :rubygems
 
-# Specify your gem's dependencies in porter.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    porter (1.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  porter!

data/README.md

@@ -0,0 +1,69 @@
+# Porter Gem
+
+The Porter gem is comprised of Capistrano and Rake tasks that make cloning remote server data down to your local Rails application environment a cinch.
+
+## Dependencies
+
+* Capistrano and a proper Capistrano Multistage configuration
+* Rake
+* A Rails app
+* rsync (locally and remotely, if you want to sync assets)
+
+## Capistrano Multistage (capistrano-ext)
+
+As of v1.1.0, Porter expects that your Capistrano setup utilizes the Capistrano Multistage Extension (capistrano-ext).  This is a really great way to manage the various "stages" you deploy to and Porter is opinionated in that it requires you to organize your stage-specific settings into the Capistrano Multistage pattern.
+
+More on the Capistrano Multistage Extension:
+[https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension)
+
+## Installation
+
+* Add gem "porter", "~> 1.1.0" to your Gemfile
+* Run: bundle install
+* Run: rails g porter
+* Add require "porter/capistrano" to your config/deploy.rb
+* Review the generated config/porter_config.yml (just so you're familiar, it's pretty straight-forward)
+
+## Usage
+
+### Purge your local database and reload data from a remote server's MySQL dump
+
+    $  bundle exec cap production porter:db
+
+This will do the following:
+
+* A mysqldump command will be remotely issued (via Capistrano) to the remote server, saving the result as a compressed (gz) file
+* The database backup file from the server will be retrieved (via scp) and decompressed
+* The database for the environment you are running the task in will be dropped, recreated, and restored from the backup
+
+### Synchronize a remote server's filesystem-stored assets to your local filesystem
+
+    $  bundle exec cap production porter:assets
+
+This will do the following:
+
+* Assets stored in directories you define will be rysnc'd down to your local application directory
+
+## License
+
+The MIT License
+
+Copyright (c) 2010-2011 Kenny Johnston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -1,2 +1,2 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks

data/lib/generators/porter/porter_generator.rb

@@ -1,19 +1,14 @@
-require 'rails/generators'
+require "rails/generators"
 
 class PorterGenerator < Rails::Generators::Base
 
-  attr_accessor :app, :domain
-
   def self.source_root
-    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    @source_root ||= File.join(File.dirname(__FILE__), "templates")
   end
 
   def create_config_file
-    @app    = Rails.root.to_s.split('/').last
-    @domain = @app + (@app.include?('.') ? '' : '.com')
-
-    template 'porter_config.yml', 'config/porter_config.yml'
-    readme 'INSTALL'
+    template "porter_config.yml", "config/porter_config.yml"
+    readme "INSTALL"
   end
 
 end

data/lib/generators/porter/templates/INSTALL

@@ -2,6 +2,6 @@
 
 Add the following to the top of your config/deploy.rb:
 
-require 'porter'
+require "porter/capistrano"
 
-*******************************************************
+*******************************************************

data/lib/generators/porter/templates/porter_config.yml

@@ -1,16 +1,9 @@
 # Config file for porter gem
 
 production:
-  user: deploy
-  domain: <%= domain %>
-  app_dir: /opt/apps/<%= app %>/current
   asset_dirs: public/system
   rsync_options: --verbose --progress --stats --recursive --times --compress --delete
 
 # staging:
-#   user: deploy
-#   domain: <%= domain %>
-#   dir: /opt/apps/<%= app %>/current
 #   asset_dirs: public/system
 #   rsync_options: --verbose --progress --stats --recursive --times --compress --delete
-

data/lib/porter.rb

@@ -1,5 +1,5 @@
-require "#{File.dirname(__FILE__)}/porter/recipes/porter"
+require File.join(File.dirname(__FILE__), "porter", "capistrano")
 
 module Porter
-  require 'porter/railtie'
-end
+  require "porter/railtie"
+end

data/lib/porter/capistrano.rb

@@ -0,0 +1,36 @@
+require "capistrano"
+
+if instance = Capistrano::Configuration.instance
+  instance.load do
+
+    namespace :porter do
+
+      task :db do
+        set :user, ENV["AS"] || ENV["USER"]
+        puts "Connecting to #{domain} as #{user}..."
+
+        puts "Reading database.yml on #{domain}..."
+        database_yml = ""
+        run "cat #{deploy_to}/current/config/database.yml" do |channel, stream, data|
+          database_yml << data
+        end
+
+        config   = YAML::load(database_yml)[stage.to_s]
+        database = config["database"]
+        username = config["username"]
+        password = config["password"]
+
+        puts "Creating compressed backup of #{database} database on #{domain}..."
+        run "mysqldump --user=#{username} --password=#{password} #{database} | gzip > ~/#{database}.sql.gz"
+
+        system "rake porter:db DOMAIN=#{domain} DATABASE=#{database} --trace"
+      end
+
+      task :assets do
+        system "rake porter:assets STAGE=#{stage.to_s} DOMAIN=#{domain} APP_DIR=#{deploy_to}"
+      end
+
+    end
+
+  end
+end

data/lib/porter/railtie.rb

@@ -1,5 +1,6 @@
-require 'porter'
-require 'rails'
+require "porter"
+require "rails"
+
 module Porter
   class Railtie < Rails::Railtie
     railtie_name :porter
@@ -8,4 +9,4 @@ module Porter
       load "tasks/porter.rake"
     end
   end
-end
+end

data/lib/porter/version.rb

@@ -1,3 +1,3 @@
 module Porter
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/tasks/porter.rake

@@ -1,75 +1,73 @@
-CONFIG    = YAML::load_file(Rails.root.join('config', 'porter_config.yml'))
-DATABASES = YAML::load_file(Rails.root.join('config', 'database.yml'))
-STAGES    = DATABASES.keys - %w(development test) # you don't need data out of these
-
 namespace :porter do
-  STAGES.each do |stage|
-    namespace stage do
-      task :db => :environment do
-        if CONFIG[stage]
-          src_user     = CONFIG[stage]['user']
-          src_domain   = CONFIG[stage]['domain']
-        else
-          puts "Please tell config/porter_config.yml about the '#{stage}' server."
-          return
-        end
-          
-        src_db    = ActiveRecord::Base.configurations[stage]
-        dest_db   = ActiveRecord::Base.configurations[Rails.env]
-        dest_root = Rails.root
-        
-        app       = src_db['database'].split('_').first
-        root      = Rails.root
-    
-        puts "Retrieving latest compressed database backup from #{stage} server..."
-        system "scp #{src_user}@#{src_domain}:~/#{src_db['database']}.sql.gz #{root}"
-
-        puts "Decompressing database backup..."
-        system "gunzip #{root}/#{src_db['database']}.sql.gz"
-
-        # Drop the database if it exists
-        begin
-          ActiveRecord::Base.establish_connection(dest_db)
-          ActiveRecord::Base.connection # Should raise Mysql::Error if db doesn't exist
-          puts "Dropping database: " + dest_db['database']
-          Rake::Task['db:drop'].execute
-        rescue Mysql::Error => e
-          raise e unless e.message =~ /Unknown database/
-        end
-
-        puts "Creating database: " + dest_db['database']
-        Rake::Task['db:create'].execute
-
-        puts "Restoring database from backup..."
-        mysql_version = `which mysql`.empty? ? 'mysql5' : 'mysql'
-        cmd = [mysql_version]
-        cmd << "-u #{dest_db['username']}"
-        cmd << "--password=#{dest_db['password']}" unless dest_db['password'].blank?
-        cmd << dest_db['database']
-        cmd << "< #{root}/#{src_db['database']}.sql"
-        system cmd.join(' ') # Run the mysql import
-
-        puts "Removing database backup file..."
-        system "rm #{root}/#{src_db['database']}.sql"
-
-        puts "Database reload complete"
-      end
 
-      task :assets => :environment do
-        root           = Rails.root
-        user           = CONFIG[stage]['user']
-        domain         = CONFIG[stage]['domain']
-        app_dir        = CONFIG[stage]['app_dir']
-        asset_dirs     = CONFIG[stage]['asset_dirs'].blank? ? '' : CONFIG[stage]['asset_dirs'].gsub(/,/,'').split(' ').map { |i| i.strip }
-        rsync_options  = CONFIG[stage]['rsync_options']
-      
-        asset_dirs.each do |d|
-          puts "Synchronizing assets in #{d}..."
-          system "rsync #{rsync_options} #{user}@#{domain}:#{app_dir}/#{d}/ #{d}"
-        end
-
-        puts "Asset synchronization complete"
+  task :db => :environment do
+    domain          = ENV["DOMAIN"]
+    user            = ENV["AS"] || ENV["USER"]
+    source_database = ENV["DATABASE"]
+
+    destintation_database_config   = ActiveRecord::Base.configurations[Rails.env]
+    destintation_database          = destintation_database_config["database"]
+    destintation_database_username = destintation_database_config["username"]
+    destintation_database_password = destintation_database_config["password"]
+
+    root = Rails.root
+
+    puts "Connecting to #{domain} as #{user}..."
+
+    puts "Retrieving database backup from #{domain}..."
+    system "scp #{user}@#{domain}:~/#{source_database}.sql.gz #{root}"
+
+    puts "Decompressing database backup..."
+    system "gunzip #{root}/#{source_database}.sql.gz"
+
+    # Drop the database if it exists
+    begin
+      ActiveRecord::Base.establish_connection(destintation_database_config)
+      ActiveRecord::Base.connection # Should raise Mysql::Error if db doesn't exist
+      puts "Dropping database: " + destintation_database
+      Rake::Task["db:drop"].execute
+    rescue Mysql2::Error => e
+      raise e unless e.message =~ /Unknown database/
+    end
+
+    puts "Creating database: " + destintation_database
+    Rake::Task["db:create"].execute
+
+    puts "Restoring database from backup..."
+    mysql_version = `which mysql`.empty? ? "mysql5" : "mysql"
+    cmd = [mysql_version]
+    cmd << "-u #{destintation_database_username}"
+    cmd << "--password=#{destintation_database_password}" unless destintation_database_password.blank?
+    cmd << destintation_database
+    cmd << "< #{root}/#{source_database}.sql"
+    system cmd.join(' ') # Run the mysql import
+
+    puts "Removing database backup file..."
+    system "rm #{root}/#{source_database}.sql"
+
+    puts "Database reload complete"
+  end
+
+  task :assets => :environment do
+    stage         = ENV["STAGE"]
+    domain        = ENV["DOMAIN"]
+    user          = ENV["AS"] || ENV["USER"]
+    app_dir       = ENV["APP_DIR"]+"/current"
+    config        = YAML::load_file(Rails.root.join("config", "porter_config.yml"))
+    rsync_options = config[stage]["rsync_options"]
+
+    unless config[stage]["asset_dirs"].blank?
+      asset_dirs = config[stage]["asset_dirs"].gsub(/,/,' ').split(' ').map { |i| i.strip }
+
+      puts "Connecting to #{domain} as #{user}..."
+
+      asset_dirs.each do |d|
+        puts "Synchronizing assets in #{d}..."
+        system "rsync #{rsync_options} #{user}@#{domain}:#{app_dir}/#{d}/ #{d}"
       end
     end
+
+    puts "Asset synchronization complete"
   end
-end
+
+end

data/porter.gemspec

@@ -12,7 +12,9 @@ Gem::Specification.new do |s|
   s.summary     = %q{Capistrano and Rake tasks for cloning production and/or staging databases and assets to development.}
   s.description = %q{Capistrano and Rake tasks for cloning production and/or staging databases and assets to development.}
 
-  s.rubyforge_project = "porter"
+  s.add_runtime_dependency "capistrano",     ">= 2.5.0"
+  s.add_runtime_dependency "capistrano-ext", ">= 1.2.0"
+  s.add_runtime_dependency "rake",           ">= 0.8.7"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,79 +1,95 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: porter
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
 platform: ruby
-authors: 
+authors:
 - Kenny Johnston
 - Robert Bousquet
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-18 00:00:00 Z
-dependencies: []
-
-description: Capistrano and Rake tasks for cloning production and/or staging databases and assets to development.
-email: 
+date: 2011-12-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &2223799140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2223799140
+- !ruby/object:Gem::Dependency
+  name: capistrano-ext
+  requirement: &2223798140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2223798140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2223797360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *2223797360
+description: Capistrano and Rake tasks for cloning production and/or staging databases
+  and assets to development.
+email:
 - kjohnston.ca@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
+- Gemfile.lock
+- README.md
 - Rakefile
-- Readme.textile
 - lib/generators/porter/porter_generator.rb
 - lib/generators/porter/templates/INSTALL
 - lib/generators/porter/templates/porter_config.yml
 - lib/porter.rb
+- lib/porter/capistrano.rb
 - lib/porter/railtie.rb
-- lib/porter/recipes/porter.rb
 - lib/porter/version.rb
 - lib/tasks/porter.rake
 - porter.gemspec
 homepage: http://github.com/kjohnston/porter
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: porter
-rubygems_version: 1.8.6
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Capistrano and Rake tasks for cloning production and/or staging databases and assets to development.
+summary: Capistrano and Rake tasks for cloning production and/or staging databases
+  and assets to development.
 test_files: []
-

data/Readme.textile

@@ -1,58 +0,0 @@
-h1. Porter Gem
-
-The Porter gem is comprised of Capistrano and Rake tasks that make cloning your production and/or staging server data down to your development environment a cinch.
-
-h2. Overview
-
-* A mysqldump command is remotely issued (via Capistrano) to the remote server (production or staging environment), saving the result as a compressed (gz) file
-* The database backup file from the server is retrieved (via scp) and decompressed
-* The development database is dropped, recreated, and restored from the backup
-* Assets stored in directories you define are rysnc'd down to your local application directory
-* Separate rake tasks are included for restoring the db and re-syncing the assets without re-dumping the remote db
-
-h2. Dependencies
-
-* Capistrano (and a config/deploy.rb file)
-* Rake
-* A Rails app
-* rsync (locally and remotely)
-
-h2. Installation
-
-* Add gem 'porter' to your Gemfile
-* Run: bundle install
-* Run: rails g porter
-* Add require 'porter' to your config/deploy.rb
-* See the generated config/porter_config.yml - it's pretty straight-forward
-
-h2. Usage
-
-* cap porter:[stage] (creates the remote db backup file then calls the two rake tasks below)
-* rake porter:[stage]:db (if you've already got a db backup on the remote server and want to restore from it again)
-* rake porter:[stage]:assets (rsync the assets down from the remote server again)
-
-Note: [stage] is most likely going to be 'production' unless your app has a staging or demo environment and you want to pull from there instead.
-
-h2. License
-
-The MIT License
-
-Copyright (c) 2010-2011 Kenny Johnston
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/lib/porter/recipes/porter.rb

@@ -1,26 +0,0 @@
-if defined?(Capistrano)
-  Capistrano::Configuration.instance.load do
-    namespace :porter do
-      CONFIG    = YAML::load_file('config/porter_config.yml')
-      DATABASES = YAML::load_file('config/database.yml')
-      STAGES    = DATABASES.keys - %w(development test) # you don't need data out of these
-      STAGES.each do |stage|
-        # task names for each of your other stages: production, staging, etc.
-        # cap porter:production, cap porter:staging, etc.
-        task stage do
-          src_db = DATABASES[stage]
-          db     = src_db['database']
-          user   = src_db['username']
-          pass   = src_db['password']
-        
-          domain = CONFIG[stage]['domain']
-          server domain, :porter
-        
-          run "mysqldump --user=#{user} --password=#{pass} #{db} | gzip > ~/#{db}.sql.gz", :roles => :porter
-          system "rake porter:#{stage}:db"
-          system "rake porter:#{stage}:assets"
-        end
-      end
-    end
-  end
-end