wordmove 0.1.0.alpha → 0.1.0.beta

data/README.mdown

@@ -1,6 +1,8 @@
 # Wordmove
 
-Wordmove is a nice little gem that lets you automatically mirror local Wordpress installations and DB data back and forth from your local development machine to the remote staging server.
+Wordmove is a nice little gem that lets you automatically mirror local Wordpress
+installations and DB data back and forth from your local development machine to
+the remote staging server. SSH and FTP connections are both supported.
 
 Think of it like Capistrano for Wordpress, complete with push/pull capabilities.
 
@@ -9,7 +11,7 @@ Think of it like Capistrano for Wordpress, complete with push/pull capabilities.
 That's easy:
 
 ```
-gem install wordmove
+gem install wordmove --pre
 ```
 
 ## Usage
@@ -33,7 +35,7 @@ local:
   wordpress_path: "~/dev/sites/your_site"
   database:
     name: "database_name"
-    username: "username"
+    user: "user"
     password: "password"
     host: "host"
 remote:
@@ -46,34 +48,30 @@ remote:
     - Movefile
   database:
     name: "database_name"
-    username: "username"
+    user: "user"
     password: "password"
     host: "host"
   ssh:
-    username: "username"
+    user: "user"
     password: "password" # optional, will use SSH public key if available
     host: "host"
     port: 2202 # optional
 ```
-## About SSH authentication
-
 ### If you have your local SSH public key already installed on the remote machine.. (recommended)
-Just drop the `remote.ssh.password` file on your `Movefile`.
-
-### Else..
-You need to have [`sshpass`](http://sourceforge.net/projects/sshpass/) on your machine. On Linux, install it with your standard package manager. On Mac, you can have it via [`brew`](https://github.com/mxcl/homebrew):
+Just not use the `remote.ssh.password` field on your `Movefile`. Easy peasy.
 
-```
-sudo brew install https://raw.github.com/gist/1513663/3e98bf9e03feb7e31eeddcd08f89ca86163a376d/sshpass.rb
-```
+### If you want to specify SSH password on the Movefile
+Please take a look at the various gotchas of the underlying [`photocopier` gem](https://github.com/stefanoverna/photocopier#password-gotchas).
 
-**Please note that on Ubuntu 11.10 `sshpass` is at version 1.04, which has a [bug](https://bugs.launchpad.net/ubuntu/+source/sshpass/+bug/774882) that prevents it from working. Install version 1.03 or 1.05.**
+### How the heck you are able to sync the DB via FTP?
+Thanks for asking. We basically upload via FTP a PHP script that performs the various
+import/export operations. This script then gets executed via HTTP. Don't worry
+too much about security though: the script is deleted just after the usage,
+and can only be executed by `wordmove`, as each time it requires a pre-shared
+one-time-password to be run.
 
-## Requirements
-* Wordmove requires an SSH connection to the remote host;
-* Wordmove requires `mysqldump` and `mysql` to be present in the remote host and executable by the SSH user;
-* Wordmove requires `rsync` to be present and executable in your machine;
-* As said above, you may also need `sshpass` on your machine;
+* The dump script is the [`MYSQL-dump` PHP package](https://github.com/dg/MySQL-dump) by David Grudl;
+* The import script used is the [BigDump](http://www.ozerov.de/bigdump/) library;
 
 ## License
 

data/lib/wordmove/assets/import.php.erb

@@ -10,7 +10,7 @@ if ($_GET['shared_key'] != $shared_key) {
 // Database configuration
 
 $db_server = '<%= escape_php db[:host] %>';
-$db_username = '<%= escape_php db[:user] %>';
+$db_username = '<%= escape_php db[:username] %>';
 $db_password = '<%= escape_php db[:password] %>';
 $db_name = '<%= escape_php db[:name] %>';
 
@@ -48,7 +48,7 @@ $comment[]='/*!';                     // Or add your own string to leave out oth
 // See http://dev.mysql.com/doc/refman/5.0/en/charset-charsets.html for the full list
 // Change this if you have problems with non-latin letters
 
-$db_connection_charset = '<%= db[:charset] || utf8';
+$db_connection_charset = '<%= db[:charset] || 'utf8' %>';
 
 // Default query delimiter: this character at the line end tells Bigdump where a SQL statement ends
 // Can be changed by DELIMITER statement in the dump file (normally used when defining procedures/functions)

data/lib/wordmove/deployer/base.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext'
 require 'wordmove/logger'
+require 'wordmove/sql_mover'
 require 'escape'
 
 module Wordmove
@@ -51,17 +52,21 @@ module Wordmove
       %w(uploads themes plugins).each do |task|
         define_method "push_#{task}" do
           logger.task "Pushing #{task.titleize}"
-          remote_put_directory(local_wpcontent_path(task), remote_wpcontent_path(task))
+          remote_put_directory(local_wpcontent_path(task), remote_wpcontent_path(task), paths_to_exclude)
         end
 
         define_method "pull_#{task}" do
           logger.task "Pulling #{task.titleize}"
-          remote_get_directory(remote_wpcontent_path(task), local_wpcontent_path(task))
+          remote_get_directory(remote_wpcontent_path(task), local_wpcontent_path(task), paths_to_exclude)
         end
       end
 
       protected
 
+      def paths_to_exclude
+        options[:remote][:exclude] || Array.new
+      end
+
       def run(command)
         logger.task_step true, command
         unless simulate?
@@ -97,16 +102,14 @@ module Wordmove
       def adapt_sql(save_to_path, local, remote)
         logger.task_step true, "adapt dump"
         unless simulate?
-          File.open(save_to_path, 'a') do |file|
-            file.write "UPDATE wp_options SET option_value=\"#{remote[:vhost]}\" WHERE option_name=\"siteurl\" OR option_name=\"home\";\n"
-          end
+          SqlMover.new(save_to_path, local, remote).move!
         end
       end
 
       def mysql_dump_command(options, save_to_path)
         arguments = [ "mysqldump" ]
         arguments << "--host=#{options[:host]}" if options[:host].present?
-        arguments << "--user=#{options[:user]}" if options[:user].present?
+        arguments << "--user=#{options[:username]}" if options[:username].present?
         arguments << "--password=#{options[:password]}" if options[:password].present?
         arguments << "--default-character-set=#{options[:charset]}" if options[:charset].present?
         arguments << options[:name]
@@ -116,7 +119,7 @@ module Wordmove
       def mysql_import_command(dump_path, options)
         arguments = [ "mysql" ]
         arguments << "--host=#{options[:host]}" if options[:host].present?
-        arguments << "--user=#{options[:user]}" if options[:user].present?
+        arguments << "--user=#{options[:username]}" if options[:username].present?
         arguments << "--password=#{options[:password]}" if options[:password].present?
         arguments << "--database=#{options[:name]}"
         Escape.shell_command(arguments) + " < #{dump_path}"

data/lib/wordmove/deployer/ftp.rb

@@ -10,7 +10,8 @@ module Wordmove
       def initialize(options)
         super
         ftp_options = options[:remote][:ftp]
-        @copier = Photocopier::FTP.new(ftp_options.merge(logger: logger))
+        @copier = Photocopier::FTP.new(ftp_options)
+        @copier.logger = logger
       end
 
       def push_db

data/lib/wordmove/deployer/ssh.rb

@@ -7,7 +7,8 @@ module Wordmove
       def initialize(options)
         super
         ssh_options = options[:remote][:ssh]
-        @copier = Photocopier::SSH.new(ssh_options.merge(logger: logger))
+        @copier = Photocopier::SSH.new(ssh_options)
+        @copier.logger = logger
       end
 
       def push_db

data/lib/wordmove/generators/Movefile

@@ -3,30 +3,25 @@ local:
   wordpress_path: "~/dev/sites/your_site"
   database:
     name: "database_name"
-    username: "username"
+    username: "user"
     password: "password"
-    host: "host"
+    host: "127.0.0.1"
 remote:
   vhost: "http://remote.com"
   wordpress_path: "/var/www/your_site"
-  exclude:
-    - .git
-    - .DS_Store
-    - .sass-cache
-    - Movefile
   database:
     name: "database_name"
-    username: "username"
+    username: "user"
     password: "password"
     host: "host"
-  ssh:
+  ssh: # also ftp is allowed
     host: "host"
-    username: "username"
+    user: "user"
     password: "password" # password is optional, will use public keys if available.
     # port: 22 # Port is optional
     #
     # gateway:
     #   host: "host"
-    #   username: "username"
+    #   user: "user"
     #   password: "password" # password is optional, will use public keys if available.
 

data/lib/wordmove/sql_mover.rb

@@ -0,0 +1,59 @@
+module Wordmove
+
+  class SqlMover
+
+    attr_accessor :sql_content
+    attr_reader :sql_path, :source_config, :dest_config
+
+    def initialize(sql_path, source_config, dest_config)
+      @sql_path = sql_path
+      @source_config = source_config
+      @dest_config = dest_config
+    end
+
+    def sql_content
+      @sql_content ||= File.open(sql_path).read
+    end
+
+    def move!
+      replace_vhost!
+      replace_wordpress_path!
+      write_sql!
+    end
+
+    def replace_vhost!
+      replace_field!(:vhost)
+    end
+
+    def replace_wordpress_path!
+      replace_field!(:wordpress_path)
+    end
+
+    def replace_field!(field_sym)
+      source_field = source_config[field_sym]
+      dest_field = dest_config[field_sym]
+      if source_field && dest_field
+        serialized_replace!(source_field, dest_field)
+        simple_replace!(source_field, dest_field)
+      end
+    end
+
+    def serialized_replace!(source_field, dest_field)
+      length_delta = source_field.length - dest_field.length
+
+      sql_content.gsub!(/s:(\d+):"#{Regexp.escape(source_field)}/) do |match|
+        source_length = $1.to_i
+        dest_length = source_length - length_delta
+        "s:#{dest_length}:\"#{dest_field}"
+      end
+    end
+
+    def simple_replace!(source_field, dest_field)
+      sql_content.gsub!(source_field, dest_field)
+    end
+
+    def write_sql!
+      File.open(sql_path, 'w') {|f| f.write(sql_content) }
+    end
+  end
+end

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "0.1.0.alpha"
+  VERSION = "0.1.0.beta"
 end

data/spec/fixtures/Movefile

@@ -3,24 +3,19 @@ local:
   wordpress_path: "~/dev/sites/your_site"
   database:
     name: "database_name"
-    username: "username"
+    user: "user"
     password: "password"
     host: "host"
 remote:
   vhost: "http://remote.com"
   wordpress_path: "/var/www/your_site"
-  exclude:
-    - .git
-    - .DS_Store
-    - .sass-cache
-    - Movefile
   database:
     name: "database_name"
-    username: "username"
+    user: "user"
     password: "password"
     host: "host"
   ssh:
-    username: "username"
+    user: "user"
     password: "password"
     host: "host"
     port: 30000

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha
+  version: 0.1.0.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -183,9 +183,8 @@ files:
 - lib/wordmove/deployer/ssh.rb
 - lib/wordmove/generators/Movefile
 - lib/wordmove/generators/movefile.rb
-- lib/wordmove/hosts/local_host.rb
-- lib/wordmove/hosts/remote_host.rb
 - lib/wordmove/logger.rb
+- lib/wordmove/sql_mover.rb
 - lib/wordmove/version.rb
 - pkg/wordmove-0.0.1.gem
 - pkg/wordmove-0.0.2.gem

data/lib/wordmove/hosts/local_host.rb

@@ -1,41 +0,0 @@
-require 'escape'
-
-module Wordmove
-  class LocalHost
-
-    attr_reader :options
-    attr_reader :logger
-    attr_reader :ssh_extras
-
-    def initialize(options = {})
-      @options = Hashie::Mash.new(options)
-      @logger = @options[:logger]
-    end
-
-    def run(*args)
-      command = shell_command(*args)
-      logger.verbose "Executing locally #{command}"
-      unless system(command)
-        raise Thor::Error, "Error executing \"#{command}\""
-      end
-    end
-
-    def close
-    end
-
-    protected
-
-    def shell_command(*args)
-      options = args.extract_options!
-      command = Escape.shell_command(args)
-      if options[:stdin]
-        command += " < #{options[:stdin]}"
-      end
-      if options[:stdout]
-        command += " > #{options[:stdout]}"
-      end
-      command
-    end
-
-  end
-end

data/lib/wordmove/hosts/remote_host.rb

@@ -1,135 +0,0 @@
-require 'net/ssh'
-require 'net/scp'
-require 'net/ssh/gateway'
-
-module Wordmove
-  class RemoteHost < LocalHost
-
-    alias :locally_run :run
-
-    attr_reader :session
-
-    def initialize(options = {})
-      super
-    end
-
-    def session
-      if options.ssh.nil?
-        raise Thor::Error, "No SSH credentials provided on Movefile!"
-      end
-
-      ssh_extras = {}
-      [ :port, :password ].each do |p|
-        ssh_extras.merge!( { p => options.ssh[p] } ) if options.ssh[p]
-      end
-
-      if options.ssh.gateway.nil?
-        logger.verbose "Connecting to #{options.ssh.host}..." unless @session.present?
-        @session ||= Net::SSH.start(options.ssh.host, options.ssh.username, ssh_extras)
-      else
-        logger.verbose "Connecting to #{options.ssh.host} through the gateway..." unless @session.present?
-        @session ||= gateway.ssh(options.ssh.host, options.ssh.username, ssh_extras)
-      end
-
-      @session
-    end
-
-    def gateway
-      if options.ssh.gateway.nil?
-        raise Thor::Error, "No SSH credentials provided on Movefile!"
-      end
-
-      ssh_extras = {}
-      [ :port, :password ].each do |p|
-        ssh_extras.merge!( { p => options.ssh.gateway[p] } ) if options.ssh.gateway[p]
-      end
-
-      logger.verbose "Connecting to #{options.ssh.gateway.host}..." unless @gateway.present?
-      @gateway ||= Net::SSH::Gateway.new(options.ssh.gateway.host, options.ssh.gateway.username, ssh_extras )
-
-      @gateway
-    end
-
-    def close
-      session.close
-      if options.ssh.gateway.present?
-        gateway.close(session.transport.port)
-      end
-    end
-
-    def upload_file(source_file, destination_file)
-      logger.verbose "Copying remote #{source_file} to #{destination_file}..."
-      session.scp.download! source_file, destination_file
-    end
-
-    def download_file(source_file, destination_file)
-      logger.verbose "Copying local #{source_file} to #{destination_file}..."
-      session.scp.upload! source_file, destination_file
-    end
-
-    def download_dir(source_dir, destination_dir)
-      destination_dir = ":#{destination_dir}"
-      destination_dir = "#{options.ssh.username}@#{destination_dir}" if options.ssh.username
-      rsync "#{source_dir}/", destination_dir
-    end
-
-    def upload_dir(source_dir, destination_dir)
-      source_dir = ":#{source_dir}/"
-      rsync source_dir, destination_dir
-    end
-
-    def run(*args)
-      command = shell_command(*args)
-      logger.verbose "Executing remotely #{command}"
-      session.exec!(command)
-    end
-
-    private
-
-    def rsync(source_dir, destination_dir)
-
-      exclude_file = Tempfile.new('exclude')
-      exclude_file.write(options.exclude.join("\n"))
-      exclude_file.close
-
-      arguments = [ "-azLKO" ]
-
-      if options.ssh && (options.ssh.port || options.ssh.password || options.ssh.gateway)
-
-        remote_shell_arguments = []
-
-        if options.ssh.gateway
-          host = options.ssh.gateway.host
-          host = "#{options.ssh.gateway.username}@#{host}" if options.ssh.gateway.username
-          remote_shell_arguments << [ "ssh", host ]
-          if options.ssh.gateway.port
-            remote_shell_arguments << [ "-p", options.ssh.gateway.port ]
-          end
-        end
-
-        remote_shell_arguments << [ "ssh" ]
-
-        if options.ssh.port
-          remote_shell_arguments << [ "-p", options.ssh.port ]
-        end
-
-        if options.ssh.password
-          remote_shell_arguments = [ "sshpass", "-p", options.ssh.password ] + remote_shell_arguments
-        end
-
-        host = options.ssh.host
-        host = "#{options.ssh.username}@#{host}" if options.ssh.username
-        remote_shell_arguments << host
-
-        arguments << [ "-e", remote_shell_arguments.join(" ") ]
-      end
-
-      arguments <<  [ "--exclude-from=#{exclude_file.path}", "--delete", source_dir, destination_dir ]
-      arguments.flatten!
-      locally_run "rsync", *arguments
-
-      exclude_file.unlink
-    end
-
-  end
-end