porter 0.1.4 → 0.1.5

data/README.rdoc

@@ -4,11 +4,11 @@ The Porter gem is comprised of Capistrano and Rake tasks that make cloning your
 
 == Overview
 
-* A mysqldump command is remotely issued (via Capistrano) to the remote production server, saving the result as a compressed (gz) file
+* 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 shared/public are rysnc'd down to your local public directory (exclusions are accepted!)
-* Separate rake tasks are included for restoring the db and re-syncing the assets without re-dumping the production db
+* Separate rake tasks are included for restoring the db and re-syncing the assets without re-dumping the remote db
 
 == Dependencies
 
@@ -26,9 +26,11 @@ The Porter gem is comprised of Capistrano and Rake tasks that make cloning your
 
 == Usage
 
-* cap porter:production (creates the remote database backup then calls the two rake tasks below)
-* rake porter:production:db (if you've already got a db backup pulled down and want to restore from it again)
-* rake porter:production:assets (rsync the assets down from the production server again)
+* 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.
 
 == Copyright
 

data/generators/porter/porter_generator.rb

@@ -9,9 +9,10 @@ class PorterGenerator < Rails::Generator::Base
     @domain = @app + (@app.include?('.') ? '' : '.com')
   
     record do |m|
-      m.template 'porter_config.yml', File.join('config', 'porter_config.yml')
-      m.template 'porter.rake',       File.join('lib', 'tasks', 'porter.rake')
-      m.append_to 'config/deploy.rb', "\n\nrequire 'porter'"
+      m.template  'porter_config.yml', File.join('config', 'porter_config.yml')
+      m.template  'porter.rb',         File.join('lib', 'tasks', 'porter.rb')
+      m.append_to 'config/deploy.rb',  "require 'porter'"
+      m.append_to 'Rakefile',          "require 'tasks/porter'"
     end        
   end
 

data/generators/porter/templates/porter.rb

@@ -0,0 +1,4 @@
+$VERBOSE = nil
+if porter = Gem.searcher.find('porter')
+  Dir["#{porter.full_gem_path}/lib/tasks/*.rake"].each { |ext| load ext }
+end

data/generators/porter/templates/porter_config.yml

@@ -5,6 +5,20 @@ server:
   domain: <%= domain %>
   dir: /opt/apps/<%= app %>
 
+# If you want to be able to pull from different environments, and the domains,
+# usernames or directories differ, you can delete the catch-all server option 
+# above and enable a config for each environment's details like this:
+#
+# production:
+#   user: deploy
+#   domain: <%= domain %>
+#   dir: /opt/apps/<%= app %>
+#
+# staging:
+#   user: deploy
+#   domain: <%= domain %>
+#   dir: /opt/apps/<%= app %>
+
 assets:
   entire_dirs: public/attachments
   excludable_dir: 
@@ -16,9 +30,9 @@ assets:
 # Example:
 # 
 # assets:
-  # entire_dirs: 
+  # entire_dirs: public/campaign public/user
   # excludable_dir: public/attachments
   # excludable_model: Attachment
   # excludable_column: attachable_type
-  # excludable_matches: NULL, Design, Item, Placement
+  # excludable_matches: Document Product
   # rsync_options: --verbose --progress --stats --recursive --times --compress

data/lib/porter/recipes/porter.rb

@@ -1,15 +1,25 @@
 if defined?(Capistrano)
   Capistrano::Configuration.instance.load do
     namespace :porter do
-      task :production do
-        require 'yaml'
-        config = YAML::load_file('config/database.yml')['production']
-        db     = config['database']
-        user   = config['username']
-        pass   = config['password']
-        run "mysqldump --user=#{user} --password=#{pass} #{db} | gzip > ~/#{db}.sql.gz"
-        system "rake porter:production:db"
-        system "rake porter:production:assets"
+      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].nil? ? CONFIG['server']['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

data/lib/porter.rb

@@ -1 +1 @@
-require "#{File.dirname(__FILE__)}/porter/recipes/porter"
+require "#{File.dirname(__FILE__)}/porter/recipes/porter"

data/lib/tasks/porter.rake

@@ -0,0 +1,91 @@
+CONFIG    = YAML::load_file(File.join(RAILS_ROOT, 'config', 'porter_config.yml'))
+DATABASES = YAML::load_file(File.join(RAILS_ROOT, '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
+        # Optional: You can setup specific username and host 
+        # combos for each stage in porter_config.yml or use
+        # the default 'server' key to apply to all stages
+        if CONFIG[stage]
+          src_user     = CONFIG[stage]['user']
+          src_domain   = CONFIG[stage]['domain']
+        else
+          src_user     = CONFIG['server']['user']
+          src_domain   = CONFIG['server']['domain']
+        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'
+        system "#{mysql_version} -u root #{dest_db['database']} < #{root}/#{src_db['database']}.sql"
+
+        puts "Removing database backup file..."
+        system "rm #{root}/#{src_db['database']}.sql"
+
+        puts "Production data reload complete"
+      end
+
+      task :assets => :environment do
+        root           = RAILS_ROOT
+        user           = CONFIG[stage].nil? ? CONFIG['server']['user']   : CONFIG[stage]['user']
+        domain         = CONFIG[stage].nil? ? CONFIG['server']['domain'] : CONFIG[stage]['domain']
+        dir            = CONFIG[stage].nil? ? CONFIG['server']['dir']    : CONFIG[stage]['dir']
+        entire_dirs    = CONFIG['assets']['entire_dirs'].blank? ? '' : CONFIG['assets']['entire_dirs'].gsub(/,/,'').split(' ').map { |i| i.strip }
+        excludable_dir = CONFIG['assets']['excludable_dir']
+        model          = CONFIG['assets']['excludable_model'].constantize unless CONFIG['assets']['excludable_model'].blank?
+        column         = CONFIG['assets']['excludable_column']
+        exclusions     = CONFIG['assets']['excludable_matches'].blank? ? '' : CONFIG['assets']['excludable_matches'].gsub(/,/,'').split(' ').map { |i| i.strip }
+        rsync_options  = CONFIG['assets']['rsync_options']
+      
+        if exclusions.blank?
+          entire_dirs << excludable_dir unless excludable_dir.blank?
+        else
+          puts "Building a list of excludable assets (excluding: #{exclusions.join(', ')}) to rsync down..."
+          rsync_file_list = File.new('rsync_file_list.txt', "w")
+          attachments = model.find(:all, :conditions => ["#{column} NOT IN (?)", exclusions])
+          attachments.each do |a|
+            rsync_file_list.send((a == attachments.last ? :print : :puts), a.partitioned_path.join('/'))
+          end
+          rsync_file_list.close
+          system "rsync --files-from=#{root}/rsync_file_list.txt #{rsync_options} #{user}@#{domain}:#{dir}/shared/#{excludable_dir}/ #{excludable_dir}"
+          system "rm #{root}/rsync_file_list.txt" if File.exists?("#{root}/rsync_file_list.txt")
+        end
+      
+        entire_dirs.each do |d|
+          puts "Synchronizing assets in #{d}..."
+          system "rsync #{rsync_options} #{user}@#{domain}:#{dir}/shared/#{d}/ #{d}"
+        end
+
+        puts "Production asset synchronization complete"
+      end
+    end
+  end
+end

data/porter.gemspec

@@ -5,10 +5,10 @@
 
 Gem::Specification.new do |s|
   s.name = %q{porter}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kenny Johnston"]
+  s.authors = ["Kenny Johnston", "Robert Bousquet"]
   s.date = %q{2010-07-02}
   s.description = %q{Capistrano and Rake tasks for cloning production database and assets to development.}
   s.email = %q{info@appcreations.com}
@@ -24,10 +24,11 @@ Gem::Specification.new do |s|
      "VERSION",
      "generators/porter/lib/insert_commands.rb",
      "generators/porter/porter_generator.rb",
-     "generators/porter/templates/porter.rake",
+     "generators/porter/templates/porter.rb",
      "generators/porter/templates/porter_config.yml",
      "lib/porter.rb",
      "lib/porter/recipes/porter.rb",
+     "lib/tasks/porter.rake",
      "porter.gemspec",
      "test/helper.rb"
   ]

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: porter
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Kenny Johnston
+- Robert Bousquet
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -63,10 +64,11 @@ files:
 - VERSION
 - generators/porter/lib/insert_commands.rb
 - generators/porter/porter_generator.rb
-- generators/porter/templates/porter.rake
+- generators/porter/templates/porter.rb
 - generators/porter/templates/porter_config.yml
 - lib/porter.rb
 - lib/porter/recipes/porter.rb
+- lib/tasks/porter.rake
 - porter.gemspec
 - test/helper.rb
 has_rdoc: true

data/generators/porter/templates/porter.rake

@@ -1,76 +0,0 @@
-namespace :porter do
-  namespace :production do
-    task :db => :environment do
-      root     = RAILS_ROOT
-      config   = YAML.load_file(File.join(RAILS_ROOT, 'config', 'porter_config.yml'))
-      user     = config['server']['user']
-      domain   = config['server']['domain']
-      dbconfig = ActiveRecord::Base.configurations[RAILS_ENV]
-      app      = dbconfig['database'].gsub('_dev', '')
-    
-      puts "Retrieving latest compressed database backup from production server..."
-      system "scp #{user}@#{domain}:~/#{app}.sql.gz #{root}"
-
-      puts "Decompressing database backup..."
-      system "gunzip #{root}/#{app}.sql.gz"
-
-      # Drop the database if it exists
-      begin
-        ActiveRecord::Base.establish_connection(dbconfig)
-        ActiveRecord::Base.connection # Should raise Mysql::Error if db doesn't exist
-        puts "Dropping database: " + dbconfig['database']
-        Rake::Task['db:drop'].execute
-      rescue Mysql::Error => e
-        raise e unless e.message =~ /Unknown database/
-      end
-
-      puts "Creating database: " + dbconfig['database']
-      Rake::Task['db:create'].execute
-
-      puts "Restoring database from backup..."
-      mysql_version = `which mysql`.empty? ? 'mysql5' : 'mysql'
-      system "#{mysql_version} -u root #{dbconfig['database']} < #{root}/#{app}.sql"
-
-      puts "Removing database backup file..."
-      system "rm #{root}/#{app}.sql"
-
-      puts "Production data reload complete"
-    end
-
-    task :assets => :environment do
-      require 'yaml'
-      root           = RAILS_ROOT
-      config         = YAML.load_file(File.join(RAILS_ROOT, 'config', 'porter_config.yml'))
-      user           = config['server']['user']
-      domain         = config['server']['domain']
-      dir            = config['server']['dir']
-      entire_dirs    = config['assets']['entire_dirs'].blank? ? '' : config['assets']['entire_dirs'].split(',').map { |i| i.strip }
-      excludable_dir = config['assets']['excludable_dir']
-      model          = config['assets']['excludable_model'].constantize unless config['assets']['excludable_model'].blank?
-      column         = config['assets']['excludable_column']
-      exclusions     = config['assets']['excludable_matches'].blank? ? '' : config['assets']['excludable_matches'].split(',').map { |i| i.strip }
-      rsync_options  = config['assets']['rsync_options']
-      
-      if exclusions.blank?
-        entire_dirs << excludable_dir unless excludable_dir.blank?
-      else
-        puts "Building a list of excludable assets (excluding: #{exclusions.join(', ')}) to rsync down..."
-        rsync_file_list = File.new('rsync_file_list.txt', "w")
-        attachments = model.find(:all, :conditions => ["#{column} NOT IN (?)", exclusions])
-        attachments.each do |a|
-          rsync_file_list.send((a == attachments.last ? :print : :puts), a.partitioned_path.join('/'))
-        end
-        rsync_file_list.close
-        system "rsync --files-from=#{root}/rsync_file_list.txt #{rsync_options} #{user}@#{domain}:#{dir}/shared/#{excludable_dir}/ #{excludable_dir}"
-        system "rm #{root}/rsync_file_list.txt" if File.exists?("#{root}/rsync_file_list.txt")
-      end
-      
-      entire_dirs.each do |d|
-        puts "Synchronizing assets in #{d}..."
-        system "rsync #{rsync_options} #{user}@#{domain}:#{dir}/shared/#{d}/ #{d}"
-      end
-
-      puts "Production asset synchronization complete"
-    end
-  end
-end