wordmove 2.0.2 → 2.1.0

data/lib/wordmove/cli.rb

@@ -1,6 +1,6 @@
 module Wordmove
   class CLI < Thor
-    map %w(--version -v) => :__print_version
+    map %w[--version -v] => :__print_version
 
     desc "--version, -v", "Print the version"
     def __print_version
@@ -39,7 +39,7 @@ module Wordmove
       end
 
       def wordpress_options
-        %w(wordpress uploads themes plugins mu_plugins languages db)
+        %w[wordpress uploads themes plugins mu_plugins languages db]
       end
 
       def ensure_wordpress_options_presence!(options)

data/lib/wordmove/deployer/base.rb

@@ -20,12 +20,20 @@ module Wordmove
           environment = (options[:environment] || available_enviroments.first).to_sym
 
           return FTP.new(environment, options) if options[environment][:ftp]
-          return SSH.new(environment, options) if options[environment][:ssh]
+
+          if options[environment][:ssh] && options[:global][:sql_adapter] == 'wpcli'
+            return Ssh::WpcliSqlAdapter.new(environment, options)
+          end
+
+          if options[environment][:ssh] && options[:global][:sql_adapter] == 'default'
+            return Ssh::DefaultSqlAdapter.new(environment, options)
+          end
+
           raise NoAdapterFound, "No valid adapter found."
         end
 
         def extract_available_envs(options)
-          options.keys.map(&:to_sym) - [:local]
+          options.keys.map(&:to_sym) - %i[local global]
         end
 
         def fetch_movefile(name = nil, start_dir = current_dir)
@@ -39,7 +47,7 @@ module Wordmove
 
           found = entries.first
           logger.task("Using Movefile: #{found}")
-          YAML.load(ERB.new(File.read(found)).result)
+          YAML.safe_load(ERB.new(File.read(found)).result)
         end
 
         def current_dir
@@ -77,7 +85,7 @@ module Wordmove
 
       def remote_put_directory(directory); end
 
-      %w(uploads themes plugins mu_plugins languages).each do |task|
+      %w[uploads themes plugins mu_plugins languages].each do |task|
         define_method "push_#{task}" do
           logger.task "Pushing #{task.titleize}"
           local_path = send("local_#{task}_dir").path
@@ -127,18 +135,19 @@ module Wordmove
 
       def run(command)
         logger.task_step true, command
-        unless simulate?
-          system(command)
-          raise ShellCommandError, "Return code reports an error" unless $CHILD_STATUS.success?
-        end
+        return true if simulate?
+
+        system(command)
+        raise ShellCommandError, "Return code reports an error" unless $CHILD_STATUS.success?
       end
 
       def download(url, local_path)
         logger.task_step true, "download #{url} > #{local_path}"
-        unless simulate?
-          open(local_path, 'w') do |file|
-            file << open(url).read
-          end
+
+        return true if simulate?
+
+        open(local_path, 'w') do |file|
+          file << open(url).read
         end
       end
 
@@ -154,7 +163,7 @@ module Wordmove
         WordpressDirectory::Path::UPLOADS,
         WordpressDirectory::Path::LANGUAGES
       ].each do |type|
-        [:remote, :local].each do |location|
+        %i[remote local].each do |location|
           define_method "#{location}_#{type}_dir" do
             options = send("#{location}_options")
             WordpressDirectory.new(type, options)
@@ -162,13 +171,6 @@ module Wordmove
         end
       end
 
-      def adapt_sql(save_to_path, local, remote)
-        unless options[:no_adapt]
-          logger.task_step true, "adapt dump"
-          SqlAdapter.new(save_to_path, local, remote).adapt! unless simulate?
-        end
-      end
-
       def mysql_dump_command(options, save_to_path)
         command = ["mysqldump"]
         command << "--host=#{Shellwords.escape(options[:host])}" if options[:host].present?

data/lib/wordmove/deployer/ftp.rb

@@ -53,7 +53,7 @@ module Wordmove
 
       private
 
-      %w(get get_directory put_directory delete).each do |command|
+      %w[get get_directory put_directory delete].each do |command|
         define_method "remote_#{command}" do |*args|
           logger.task_step false, "#{command}: #{args.join(' ')}"
           @copier.send(command, *args) unless simulate?

data/lib/wordmove/deployer/ssh/default_sql_adapter.rb

@@ -0,0 +1,47 @@
+module Wordmove
+  module Deployer
+    module Ssh
+      class DefaultSqlAdapter < SSH
+        private
+
+        def backup_remote_db!
+          download_remote_db(local_gzipped_backup_path)
+        end
+
+        def adapt_local_db!
+          save_local_db(local_dump_path)
+          adapt_sql(local_dump_path, local_options, remote_options)
+          run compress_command(local_dump_path)
+          import_remote_dump(local_gzipped_dump_path)
+        end
+
+        def after_push_cleanup!
+          local_delete(local_gzipped_dump_path)
+        end
+
+        def backup_local_db!
+          save_local_db(local_backup_path)
+          run compress_command(local_backup_path)
+        end
+
+        def adapt_remote_db!
+          download_remote_db(local_gzipped_dump_path)
+          run uncompress_command(local_gzipped_dump_path)
+          adapt_sql(local_dump_path, remote_options, local_options)
+          run mysql_import_command(local_dump_path, local_options[:database])
+        end
+
+        def after_pull_cleanup!
+          local_delete(local_dump_path)
+        end
+
+        def adapt_sql(save_to_path, local, remote)
+          return if options[:no_adapt]
+
+          logger.task_step true, "Adapt dump"
+          SqlAdapter::Default.new(save_to_path, local, remote).adapt! unless simulate?
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/deployer/ssh/wpcli_sql_adapter.rb

@@ -0,0 +1,54 @@
+module Wordmove
+  module Deployer
+    module Ssh
+      class WpcliSqlAdapter < SSH
+        def backup_remote_db!
+          download_remote_db(local_gzipped_backup_path)
+        end
+
+        def adapt_local_db!
+          save_local_db(local_dump_path)
+          run wpcli_search_replace(local_options, remote_options, :vhost)
+          run wpcli_search_replace(local_options, remote_options, :wordpress_path)
+
+          local_search_replace_dump_path = local_wp_content_dir.path("search_replace_dump.sql")
+          local_gzipped_search_replace_dump_path = local_search_replace_dump_path + '.gz'
+
+          save_local_db(local_search_replace_dump_path)
+          run compress_command(local_search_replace_dump_path)
+          import_remote_dump(local_gzipped_search_replace_dump_path)
+          local_delete(local_gzipped_search_replace_dump_path)
+          run mysql_import_command(local_dump_path, local_options[:database])
+        end
+
+        def after_push_cleanup!
+          local_delete(local_dump_path)
+        end
+
+        def backup_local_db!
+          save_local_db(local_backup_path)
+          run compress_command(local_backup_path)
+        end
+
+        def adapt_remote_db!
+          download_remote_db(local_gzipped_dump_path)
+          run uncompress_command(local_gzipped_dump_path)
+          run mysql_import_command(local_dump_path, local_options[:database])
+          run wpcli_search_replace(remote_options, local_options, :vhost)
+          run wpcli_search_replace(remote_options, local_options, :wordpress_path)
+        end
+
+        def after_pull_cleanup!
+          local_delete(local_dump_path)
+        end
+
+        def wpcli_search_replace(local, remote, config_key)
+          return if options[:no_adapt]
+
+          logger.task_step true, "adapt dump for #{config_key}"
+          SqlAdapter::Wpcli.new(local, remote, config_key).command unless simulate?
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/deployer/ssh.rb

@@ -1,49 +1,42 @@
 module Wordmove
   module Deployer
     class SSH < Base
+      attr_reader :local_dump_path,
+                  :local_backup_path,
+                  :local_gzipped_dump_path,
+                  :local_gzipped_backup_path
+
       def initialize(environment, options)
         super
         ssh_options = remote_options[:ssh]
         @copier = Photocopier::SSH.new(ssh_options).tap { |c| c.logger = logger }
+
+        @local_dump_path = local_wp_content_dir.path("dump.sql")
+        @local_backup_path = local_wp_content_dir.path("local-backup-#{Time.now.to_i}.sql")
+        @local_gzipped_dump_path = local_dump_path + '.gz'
+        @local_gzipped_backup_path = local_wp_content_dir
+                                     .path("#{environment}-backup-#{Time.now.to_i}.sql.gz")
       end
 
+      protected
+
       def push_db
         super
 
-        local_dump_path = local_wp_content_dir.path("dump.sql")
-        local_gzipped_dump_path = local_dump_path + '.gz'
-        local_gzipped_backup_path = local_wp_content_dir
-                                    .path("#{environment}-backup-#{Time.now.to_i}.sql.gz")
-
-        download_remote_db(local_gzipped_backup_path)
-
-        save_local_db(local_dump_path)
-        adapt_sql(local_dump_path, local_options, remote_options)
-        run compress_command(local_dump_path)
-        import_remote_dump(local_gzipped_dump_path)
-        local_delete(local_gzipped_dump_path)
+        backup_remote_db!
+        adapt_local_db!
+        after_push_cleanup!
       end
 
       def pull_db
         super
 
-        local_dump_path = local_wp_content_dir.path("dump.sql")
-        local_gzipped_dump_path = local_dump_path + '.gz'
-        local_backup_path = local_wp_content_dir.path("local-backup-#{Time.now.to_i}.sql")
-
-        save_local_db(local_backup_path)
-        run compress_command(local_backup_path)
-
-        download_remote_db(local_gzipped_dump_path)
-        run uncompress_command(local_gzipped_dump_path)
-        adapt_sql(local_dump_path, remote_options, local_options)
-        run mysql_import_command(local_dump_path, local_options[:database])
-        local_delete(local_dump_path)
+        backup_local_db!
+        adapt_remote_db!
+        after_pull_cleanup!
       end
 
-      private
-
-      %w(get put get_directory put_directory delete).each do |command|
+      %w[get put get_directory put_directory delete].each do |command|
         define_method "remote_#{command}" do |*args|
           logger.task_step false, "#{command}: #{args.join(' ')}"
           @copier.send(command, *args) unless simulate?
@@ -52,13 +45,16 @@ module Wordmove
 
       def remote_run(command)
         logger.task_step false, command
-        unless simulate?
-          _stdout, stderr, exit_code = @copier.exec! command
-          raise(
-            ShellCommandError,
-            "Error code #{exit_code} returned by command \"#{command}\": #{stderr}"
-          ) unless exit_code.zero?
-        end
+        return true if simulate?
+
+        _stdout, stderr, exit_code = @copier.exec! command
+
+        return true if exit_code.zero?
+
+        raise(
+          ShellCommandError,
+          "Error code #{exit_code} returned by command \"#{command}\": #{stderr}"
+        )
       end
 
       def download_remote_db(local_gizipped_dump_path)

data/lib/wordmove/exceptions.rb

@@ -3,4 +3,6 @@ module Wordmove
   class NoAdapterFound < StandardError; end
   class MovefileNotFound < StandardError; end
   class ShellCommandError < StandardError; end
+  class ImplementInSubclassError < StandardError; end
+  class UnmetPeerDependencyError < StandardError; end
 end

data/lib/wordmove/generators/Movefile

@@ -1,3 +1,6 @@
+global:
+  sql_adapter: "default"
+
 local:
   vhost: "http://vhost.local"
   wordpress_path: "<%= wordpress_path %>" # use an absolute path here
@@ -30,7 +33,7 @@ production:
     - "Gemfile*"
     - "Movefile"
     - "wp-config.php"
-    - "wp-content/*.sql"
+    - "wp-content/*.sql.gz"
 
   # paths: # you can customize wordpress internal paths
   #   wp_content: "wp-content"

data/lib/wordmove/sql_adapter/default.rb

@@ -0,0 +1,68 @@
+module Wordmove
+  module SqlAdapter
+    class Default
+      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 adapt!
+        replace_vhost!
+        replace_wordpress_path!
+        write_sql!
+      end
+
+      def replace_vhost!
+        source_vhost = source_config[:vhost]
+        dest_vhost = dest_config[:vhost]
+        replace_field!(source_vhost, dest_vhost)
+      end
+
+      def replace_wordpress_path!
+        source_path = source_config[:wordpress_absolute_path] || source_config[:wordpress_path]
+        dest_path = dest_config[:wordpress_absolute_path] || dest_config[:wordpress_path]
+        replace_field!(source_path, dest_path)
+      end
+
+      def replace_field!(source_field, dest_field)
+        return false unless source_field && dest_field
+
+        serialized_replace!(source_field, dest_field)
+        simple_replace!(source_field, dest_field)
+      end
+
+      def serialized_replace!(source_field, dest_field)
+        length_delta = source_field.length - dest_field.length
+
+        sql_content.gsub!(/s:(\d+):([\\]*['"])(.*?)\2;/) do |_|
+          length = Regexp.last_match(1).to_i
+          delimiter = Regexp.last_match(2)
+          string = Regexp.last_match(3)
+
+          string.gsub!(/#{Regexp.escape(source_field)}/) do |_|
+            length -= length_delta
+            dest_field
+          end
+
+          %(s:#{length}:#{delimiter}#{string}#{delimiter};)
+        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
+end

data/lib/wordmove/sql_adapter/wpcli.rb

@@ -0,0 +1,21 @@
+module Wordmove
+  module SqlAdapter
+    class Wpcli
+      attr_accessor :sql_content
+      attr_reader :from, :to
+
+      def initialize(source_config, dest_config, config_key)
+        @from = source_config[config_key]
+        @to = dest_config[config_key]
+      end
+
+      def command
+        unless system('which wp > /dev/null 2>&1')
+          raise UnmetPeerDependencyError, "WP-CLI is not installed or not in your $PATH"
+        end
+
+        "wp search-replace #{from} #{to} --quiet --skip-columns=guid --all-tables"
+      end
+    end
+  end
+end

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "2.0.2".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/wordmove.rb

@@ -16,7 +16,8 @@ require 'photocopier'
 require 'wordmove/exceptions'
 require 'wordmove/cli'
 require 'wordmove/logger'
-require 'wordmove/sql_adapter'
+require 'wordmove/sql_adapter/default'
+require 'wordmove/sql_adapter/wpcli'
 require "wordmove/version"
 require 'wordmove/wordpress_directory'
 
@@ -26,6 +27,8 @@ require 'wordmove/generators/movefile'
 require 'wordmove/deployer/base'
 require 'wordmove/deployer/ftp'
 require 'wordmove/deployer/ssh'
+require 'wordmove/deployer/ssh/default_sql_adapter'
+require 'wordmove/deployer/ssh/wpcli_sql_adapter'
 
 module Wordmove
 end

data/wordmove.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wordmove/version'
@@ -37,18 +36,22 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = "~> 2.4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14.6", ">= 1.14.6"
+  spec.add_development_dependency "bundler", ">= 1.14.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "simplecov", "~> 0.9"
   spec.add_development_dependency "pry-byebug", "~> 3.1"
   spec.add_development_dependency "priscilla", "~> 1.0"
-  spec.add_development_dependency "rubocop", "~> 0.37.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.0"
 
   spec.post_install_message = <<-RAINBOW
     Starting from 2.0.0 Wordmove will compress SQL dumps both in remote and locale environments.
     If something will broke, please check if gzip executable is present locally and
     remotely. We are considering obvious it's installed in any web environment.
-    Open an issue on github at your needs.
+
+    Starting from 2.1.0 you'll need to add the global section in your Movefile:
+        global:
+            sql_adapter: "default"
+    Or you can spawn a new one with `wordmove init` (backup the old one!)
   RAINBOW
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Stefano Verna
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -86,9 +86,6 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.14.6
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.14.6
@@ -96,9 +93,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.14.6
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.14.6
@@ -178,14 +172,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.49.0
 description: Wordmove deploys your WordPress websites at the speed of light.
 email:
 - stefano.verna@welaika.com
@@ -204,6 +198,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- ".vscode/launch.json"
 - CHANGELOG.md
 - Gemfile
 - README.mdown
@@ -221,12 +216,15 @@ files:
 - lib/wordmove/deployer/base.rb
 - lib/wordmove/deployer/ftp.rb
 - lib/wordmove/deployer/ssh.rb
+- lib/wordmove/deployer/ssh/default_sql_adapter.rb
+- lib/wordmove/deployer/ssh/wpcli_sql_adapter.rb
 - lib/wordmove/exceptions.rb
 - lib/wordmove/generators/Movefile
 - lib/wordmove/generators/movefile.rb
 - lib/wordmove/generators/movefile_adapter.rb
 - lib/wordmove/logger.rb
-- lib/wordmove/sql_adapter.rb
+- lib/wordmove/sql_adapter/default.rb
+- lib/wordmove/sql_adapter/wpcli.rb
 - lib/wordmove/version.rb
 - lib/wordmove/wordpress_directory.rb
 - lib/wordmove/wordpress_directory/path.rb
@@ -241,7 +239,11 @@ post_install_message: |2
       Starting from 2.0.0 Wordmove will compress SQL dumps both in remote and locale environments.
       If something will broke, please check if gzip executable is present locally and
       remotely. We are considering obvious it's installed in any web environment.
-      Open an issue on github at your needs.
+
+      Starting from 2.1.0 you'll need to add the global section in your Movefile:
+          global:
+              sql_adapter: "default"
+      Or you can spawn a new one with `wordmove init` (backup the old one!)
 rdoc_options: []
 require_paths:
 - lib

data/lib/wordmove/sql_adapter.rb

@@ -1,66 +0,0 @@
-module Wordmove
-  class SqlAdapter
-    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 adapt!
-      replace_vhost!
-      replace_wordpress_path!
-      write_sql!
-    end
-
-    def replace_vhost!
-      source_vhost = source_config[:vhost]
-      dest_vhost = dest_config[:vhost]
-      replace_field!(source_vhost, dest_vhost)
-    end
-
-    def replace_wordpress_path!
-      source_path = source_config[:wordpress_absolute_path] || source_config[:wordpress_path]
-      dest_path = dest_config[:wordpress_absolute_path] || dest_config[:wordpress_path]
-      replace_field!(source_path, dest_path)
-    end
-
-    def replace_field!(source_field, dest_field)
-      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+):([\\]*['"])(.*?)\2;/) do |_|
-        length = Regexp.last_match(1).to_i
-        delimiter = Regexp.last_match(2)
-        string = Regexp.last_match(3)
-
-        string.gsub!(/#{Regexp.escape(source_field)}/) do |_|
-          length -= length_delta
-          dest_field
-        end
-
-        %(s:#{length}:#{delimiter}#{string}#{delimiter};)
-      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