porter 0.1.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 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/README.rdoc

@@ -0,0 +1,35 @@
+= Porter Gem
+
+The Porter gem is comprised of Capistrano and Rake tasks that make cloning your production server data down to your development environment a cinch.
+
+== Overview
+
+* A mysqldump command is remotely issued (via Capistrano) to the remote production server, 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
+
+== Dependencies
+
+* Capistrano (and a config/deploy.rb file)
+* Rake
+* A Rails App
+* rsync (locally and remotely)
+
+== Installation
+
+* sudo gem install porter
+* config.gem 'porter'
+* script/generate porter
+* See the generated config/porter_config.yml - it's pretty straight-forward
+
+== 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)
+
+== Copyright
+
+Copyright (c) 2010 Kenny Johnston. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "porter"
+    gem.summary = "Capistrano and Rake tasks for cloning production database and assets to development."
+    gem.description = "Capistrano and Rake tasks for cloning production database and assets to development."
+    gem.email = "info@appcreations.com"
+    gem.homepage = "http://github.com/kjohnston/porter"
+    gem.authors = ["Kenny Johnston"]
+    gem.add_development_dependency "capistrano", ">= 0"
+    gem.add_development_dependency "rake", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "porter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/generators/porter/lib/insert_commands.rb

@@ -0,0 +1,34 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      File.open(file, "a") do |file|
+        file.puts
+        file.puts line
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def append_to(file, line)
+    logger.remove "#{line} removed from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n#{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+  end
+end

data/generators/porter/porter_generator.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+
+class PorterGenerator < Rails::Generator::Base
+  
+  attr_accessor :app, :domain
+  
+  def manifest
+    @app    = Dir.glob(RAILS_ROOT).to_s.split('/').last
+    @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'"
+    end        
+  end
+
+end

data/generators/porter/templates/porter.rake

@@ -0,0 +1,74 @@
+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']
+      model         = config['assets']['model'].constantize
+      column        = config['assets']['column']
+      exclusions    = config['assets']['exclusions'].blank? ? '' : config['assets']['exclusions'].split(',').map { |i| i.strip }
+      rsync_options = config['assets']['rsync_options']
+
+      excluding = exclusions.blank? ? '' : "(excluding: #{config['assets']['exclusions']} files) "
+      puts "Building a list of assets #{excluding}to rsync down..."
+      
+      unless exclusions.blank?
+        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), ('attachments/' + a.partitioned_path.join('/')))
+        end
+        rsync_file_list.close
+      end
+      
+      rsync_list_command = exclusions.blank? ? '' : "--files-from=#{root}/rsync_file_list.txt "
+    
+      puts "Synchronizing with production assets..."
+      system "rsync #{rsync_list_command}#{rsync_options} #{user}@#{domain}:#{dir}/shared/public/ public"
+
+      system "rm #{root}/rsync_file_list.txt" if File.exists?("#{root}/rsync_file_list.txt")
+
+      puts "Production asset synchronization complete"
+    end
+  end
+end

data/generators/porter/templates/porter_config.yml

@@ -0,0 +1,20 @@
+# Config file for porter gem
+
+server:
+  user: deploy
+  domain: <%= domain %>
+  dir: /opt/apps/<%= app %>
+
+assets:
+  model: Attachment
+  column: attachable_type
+  exclusions: 
+  rsync_options: --verbose --progress --stats --recursive --times --compress
+
+# Example:
+#  
+# assets:
+#   model: Attachment
+#   column: attachable_type
+#   exclusions: NULL, Design, Item, Placement
+#   rsync_options: --verbose --progress --stats --recursive --times --compress

data/lib/porter/recipes/porter.rb

@@ -0,0 +1,16 @@
+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"
+      end
+    end
+  end
+end

data/lib/porter.rb

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

data/porter.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{porter}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kenny Johnston"]
+  s.date = %q{2010-06-17}
+  s.description = %q{Capistrano and Rake tasks for cloning production database and assets to development.}
+  s.email = %q{info@appcreations.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "generators/porter/lib/insert_commands.rb",
+     "generators/porter/porter_generator.rb",
+     "generators/porter/templates/porter.rake",
+     "generators/porter/templates/porter_config.yml",
+     "lib/porter.rb",
+     "lib/porter/recipes/porter.rb",
+     "porter.gemspec",
+     "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kjohnston/porter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Capistrano and Rake tasks for cloning production database and assets to development.}
+  s.test_files = [
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<capistrano>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<capistrano>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<capistrano>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'porter'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: porter
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Kenny Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Capistrano and Rake tasks for cloning production database and assets to development.
+email: info@appcreations.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/porter/lib/insert_commands.rb
+- generators/porter/porter_generator.rb
+- generators/porter/templates/porter.rake
+- generators/porter/templates/porter_config.yml
+- lib/porter.rb
+- lib/porter/recipes/porter.rb
+- porter.gemspec
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/kjohnston/porter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Capistrano and Rake tasks for cloning production database and assets to development.
+test_files: 
+- test/helper.rb