wordmove 6.0.0.alpha.3 → 6.0.0.alpha.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 940d75a3bdf8e78dfff726d64c99c2a303ed0d0323c596df8617a1dc7d3e23ee
-  data.tar.gz: 5b1c355dc1bfd4111f9f1f3cabdfae9f248dd1c4437b3111d4555b70bf6ec02f
+  metadata.gz: eb4272b210238aa9a149f8d2bc890a2c038abad4774fabcf32d76c11c000a1cb
+  data.tar.gz: a99d350edebe61c428d129c2bd6b121f0ca24dc5bc2e7cbbaed524cdd74af573
 SHA512:
-  metadata.gz: 6627537b7592ba9453612c3eea7cce646ab54e8c8383c0b76fa19f6f68dd6f66a5ddb6e82739606e5a8cf5972bff566f7d5a454e9f61b46289f6a43bf543f5c0
-  data.tar.gz: d12311a3fdd3d48e1fe041a7c58f90337364b281e9c63bda4299fcf23e50712489949860a690c803927b77d721325f962ce9fd2de8e7934ad8217ee33559272e
+  metadata.gz: 4b4c36435fe95a960202bba159f30fe94c42273b5dc70d8542a4f97082aa2dc01b919e1178a1015417b9db1faf94d9c202c7b340026b1e0e4876e84f46154bdd
+  data.tar.gz: 267622c86ffc5491040540941c75ce445b27d07583e24d2e9ca01b46086a9b989c09ec03cd8a66233ccdfb64b0a64f52b55f0e59dbf0311d7060e249383a37ca

data/.github/workflows/ruby.yml

@@ -17,7 +17,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     container:
-      image: welaika/wordmove:latest
+      image: welaika/wordmove:php7-wordmove6
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7.1
+  TargetRubyVersion: 3.1.0
   DisplayCopNames: true
   DisplayStyleGuide: true
   NewCops: enable

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.1.0

data/lib/wordmove/actions/adapt_local_db.rb

@@ -9,7 +9,7 @@ module Wordmove
     class AdaptLocalDb
       extend ::LightService::Action
       include Wordmove::Actions::Helpers
-      include Wordmove::Wpcli
+      include Wordmove::WpcliHelpers
 
       expects :local_options,
               :remote_options,
@@ -30,8 +30,6 @@ module Wordmove
       # @!scope class
       # @return [LightService::Context] Action's context
       executed do |context| # rubocop:disable Metrics/BlockLength
-        next context if context.database_task == false
-
         context.logger.task 'Adapt local DB'
 
         unless wp_in_path?
@@ -40,63 +38,104 @@ module Wordmove
 
         next context if simulate?(cli_options: context.cli_options)
 
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
-          logger: context.logger,
-          command: mysql_dump_command(
-            env_db_options: context.local_options[:database],
-            save_to_path: context.db_paths.local.path
-          )
-        )
-        context.fail_and_return!(result.message) if result.failure?
+        context.logger.task_step true, dump_command(context)
+        begin
+          system(dump_command(context), exception: true)
+        rescue RuntimeError, SystemExit => e
+          context.fail_and_return!("Local command status reports an error: #{e.message}")
+        end
 
         if context.cli_options[:no_adapt]
           context.logger.warn 'Skipping DB adapt'
         else
-          result = Wordmove::Actions::RunLocalCommand.execute(
-            cli_options: context.cli_options,
-            logger: context.logger,
-            command: wpcli_search_replace_command(context, :vhost)
-          )
-          context.fail_and_return!(result.message) if result.failure?
-
-          result = Wordmove::Actions::RunLocalCommand.execute(
-            cli_options: context.cli_options,
-            logger: context.logger,
-            command: wpcli_search_replace_command(context, :wordpress_path)
-          )
-          context.fail_and_return!(result.message) if result.failure?
-        end
+          %i[vhost wordpress_path].each do |key|
+            command = search_replace_command(context, key)
+            context.logger.task_step true, command
 
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
+            begin
+              system(command, exception: true)
+            rescue RuntimeError, SystemExit => e
+              context.fail_and_return!("Local command status reports an error: #{e.message}")
+            end
+          end
+        end
 
-          logger: context.logger,
-          command: mysql_dump_command(
-            env_db_options: context.local_options[:database],
-            save_to_path: context.db_paths.local.adapted_path
-          )
-        )
-        context.fail_and_return!(result.message) if result.failure?
+        context.logger.task_step true, dump_adapted_command(context)
+        begin
+          system(dump_adapted_command(context), exception: true)
+        rescue RuntimeError, SystemExit => e
+          context.fail_and_return!("Local command status reports an error: #{e.message}")
+        end
 
         if context.photocopier.is_a? Photocopier::SSH
-          result = Wordmove::Actions::RunLocalCommand.execute(
-            cli_options: context.cli_options,
-            logger: context.logger,
-            command: compress_command(file_path: context.db_paths.local.adapted_path)
-          )
-          context.fail_and_return!(result.message) if result.failure?
+          context.logger.task_step true, compress_command(context)
+          begin
+            system(compress_command(context), exception: true)
+          rescue RuntimeError, SystemExit => e
+            context.fail_and_return!("Local command status reports an error: #{e.message}")
+          end
+        end
+
+        context.logger.task_step true, import_original_db_command(context)
+        begin
+          system(import_original_db_command(context), exception: true)
+        rescue RuntimeError, SystemExit => e
+          context.fail_and_return!("Local command status reports an error: #{e.message}")
+        end
+      end
+
+      def self.dump_command(context)
+        "wp db export #{context.db_paths.local.path} --allow-root --quiet " \
+          "--path=#{wpcli_config_path(context)}"
+      end
+
+      def self.dump_adapted_command(context)
+        "wp db export #{context.db_paths.local.adapted_path} --allow-root --quiet " \
+          "--path=#{wpcli_config_path(context)}"
+      end
+
+      def self.import_original_db_command(context)
+        "wp db import #{context.db_paths.local.path} --allow-root --quiet " \
+          "--path=#{wpcli_config_path(context)}"
+      end
+
+      def self.compress_command(context)
+        command = ['nice']
+        command << '-n'
+        command << '0'
+        command << 'gzip'
+        command << '-9'
+        command << '-f'
+        command << "\"#{context.db_paths.local.adapted_path}\""
+        command.join(' ')
+      end
+
+      # Compose and returns the search-replace command. It's intended to be
+      # used from a +LightService::Action+
+      #
+      # @param context [LightService::Context] The context of an action
+      # @param config_key [:vhost, :wordpress_path] Determines what will be replaced in DB
+      # @return [String]
+      # @!scope class
+      def self.search_replace_command(context, config_key)
+        unless %i[vhost wordpress_path].include?(config_key)
+          raise ArgumentError, "Unexpected `config_key` #{config_key}.:vhost" \
+                               'or :wordpress_path expected'
         end
 
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
-          logger: context.logger,
-          command: mysql_import_command(
-            dump_path: context.db_paths.local.path,
-            env_db_options: context.local_options[:database]
-          )
-        )
-        context.fail_and_return!(result.message) if result.failure?
+        [
+          'wp search-replace',
+          "--path=#{wpcli_config_path(context)}",
+          '"\A' + context.dig(:local_options, config_key) + '\Z"', # rubocop:disable Style/StringConcatenation
+          '"' + context.dig(:remote_options, config_key) + '"', # rubocop:disable Style/StringConcatenation
+          '--regex-delimiter="|"',
+          '--regex',
+          '--precise',
+          '--quiet',
+          '--skip-columns=guid',
+          '--all-tables',
+          '--allow-root'
+        ].join(' ')
       end
     end
   end

data/lib/wordmove/actions/adapt_remote_db.rb

@@ -14,7 +14,7 @@ module Wordmove
     class AdaptRemoteDb
       extend ::LightService::Action
       include Wordmove::Actions::Helpers
-      include Wordmove::Wpcli
+      include Wordmove::WpcliHelpers
 
       expects :local_options,
               :cli_options,
@@ -30,8 +30,6 @@ module Wordmove
       # @!scope class
       # @return [LightService::Context] Action's context
       executed do |context| # rubocop:disable Metrics/BlockLength
-        next context if context.database_task == false
-
         context.logger.task 'Adapt remote DB'
 
         unless wp_in_path?
@@ -41,11 +39,12 @@ module Wordmove
         next context if simulate?(cli_options: context.cli_options)
 
         if File.exist?(context.db_paths.local.gzipped_path)
-          Wordmove::Actions::RunLocalCommand.execute(
-            cli_options: context.cli_options,
-            logger: context.logger,
-            command: uncompress_command(file_path: context.db_paths.local.gzipped_path)
-          )
+          context.logger.task_step true, uncompress_command(context)
+          begin
+            system(uncompress_command(context), exception: true)
+          rescue RuntimeError, SystemExit => e
+            context.fail_and_return!("Local command status reports an error: #{e.message}")
+          end
         end
 
         unless File.exist?(context.db_paths.local.path)
@@ -54,37 +53,76 @@ module Wordmove
           )
         end
 
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
-          logger: context.logger,
-          command: mysql_import_command(
-            dump_path: context.db_paths.local.path,
-            env_db_options: context.local_options[:database]
-          )
-        )
-        context.fail_and_return!(result.message) if result.failure?
+        context.logger.task_step true, import_db_command(context)
+        begin
+          system(import_db_command(context), exception: true)
+        rescue RuntimeError, SystemExit => e
+          context.fail_and_return!("Local command status reports an error: #{e.message}")
+        end
 
         if context.cli_options[:no_adapt]
           context.logger.warn 'Skipping DB adapt'
           next context
         end
 
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
-          logger: context.logger,
-          command: wpcli_search_replace_command(context, :vhost)
-        )
-        context.fail_and_return!(result.message) if result.failure?
-
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
-          logger: context.logger,
-          command: wpcli_search_replace_command(context, :wordpress_path)
-        )
-        context.fail_and_return!(result.message) if result.failure?
+        %i[vhost wordpress_path].each do |key|
+          command = search_replace_command(context, key)
+          context.logger.task_step true, command
+          begin
+            system(command, exception: true)
+          rescue RuntimeError, SystemExit => e
+            context.fail_and_return!("Local command status reports an error: #{e.message}")
+          end
+        end
 
         context.logger.success 'Local DB adapted'
       end
+
+      # Construct the command to deflate a compressed file as a string.
+      #
+      # @param file_path [String] The path where the file to be deflated is located
+      # @return [String] the command
+      # @!scope class
+      def self.uncompress_command(context)
+        command = ['gzip']
+        command << '-d'
+        command << '-f'
+        command << "\"#{context.db_paths.local.gzipped_path}\""
+        command.join(' ')
+      end
+
+      def self.import_db_command(context)
+        "wp db import #{context.db_paths.local.path} --allow-root --quiet " \
+          "--path=#{wpcli_config_path(context)}"
+      end
+
+      # Compose and returns the search-replace command. It's intended to be
+      # used from a +LightService::Action+
+      #
+      # @param context [LightService::Context] The context of an action
+      # @param config_key [:vhost, :wordpress_path] Determines what will be replaced in DB
+      # @return [String]
+      # @!scope class
+      def self.search_replace_command(context, config_key)
+        unless %i[vhost wordpress_path].include?(config_key)
+          raise ArgumentError, "Unexpected `config_key` #{config_key}.:vhost" \
+                               'or :wordpress_path expected'
+        end
+
+        [
+          'wp search-replace',
+          "--path=#{wpcli_config_path(context)}",
+          '"\A' + context.dig(:remote_options, config_key) + '\Z"', # rubocop:disable Style/StringConcatenation
+          '"' + context.dig(:local_options, config_key) + '"', # rubocop:disable Style/StringConcatenation
+          '--regex-delimiter="|"',
+          '--regex',
+          '--precise',
+          '--quiet',
+          '--skip-columns=guid',
+          '--all-tables',
+          '--allow-root'
+        ].join(' ')
+      end
     end
   end
 end

data/lib/wordmove/actions/backup_local_db.rb

@@ -20,9 +20,7 @@ module Wordmove
       # @param logger [Wordmove::Logger]
       # @!scope class
       # @return [LightService::Context] Action's context
-      executed do |context| # rubocop:disable Metrics/BlockLength
-        next context if context.database_task == false
-
+      executed do |context|
         context.logger.task 'Backup local DB'
 
         if simulate?(cli_options: context.cli_options)
@@ -32,27 +30,41 @@ module Wordmove
           next context
         end
 
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
-          logger: context.logger,
-          command: mysql_dump_command(
-            env_db_options: context.local_options[:database],
-            save_to_path: context.db_paths.backup.local.path
-          )
-        )
-        context.fail_and_return!(result.message) if result.failure?
+        context.logger.task_step true, dump_command(context)
 
-        result = Wordmove::Actions::RunLocalCommand.execute(
-          cli_options: context.cli_options,
-          logger: context.logger,
-          command: compress_command(file_path: context.db_paths.backup.local.path)
-        )
-        context.fail_and_return!(result.message) if result.failure?
+        begin
+          system(dump_command(context), exception: true)
+        rescue RuntimeError, SystemExit => e
+          context.fail_and_return!("Local command status reports an error: #{e.message}")
+        end
+
+        context.logger.task_step true, compress_command(context)
+
+        begin
+          system(compress_command(context), exception: true)
+        rescue RuntimeError, SystemExit => e
+          context.fail_and_return!("Local command status reports an error: #{e.message}")
+        end
 
         context.logger.success(
           "Backup saved at #{context.db_paths.backup.local.gzipped_path}"
         )
       end
+
+      def self.dump_command(context)
+        "wp db export #{context.db_paths.backup.local.path} --allow-root --quiet"
+      end
+
+      def self.compress_command(context)
+        command = ['nice']
+        command << '-n'
+        command << '0'
+        command << 'gzip'
+        command << '-9'
+        command << '-f'
+        command << "\"#{context.db_paths.backup.local.path}\""
+        command.join(' ')
+      end
     end
   end
 end

data/lib/wordmove/actions/ftp/backup_remote_db.rb

@@ -21,8 +21,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context|
-          next context if context.database_task == false
-
           context.logger.task 'Backup remote DB'
 
           if simulate?(cli_options: context.cli_options)

data/lib/wordmove/actions/ftp/cleanup_after_adapt.rb

@@ -19,8 +19,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context| # rubocop:disable Metrics/BlockLength
-          next context if context.database_task == false
-
           context.logger.task 'Cleanup'
 
           if simulate?(cli_options: context.cli_options)

data/lib/wordmove/actions/ftp/download_remote_db.rb

@@ -25,8 +25,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context| # rubocop:disable Metrics/BlockLength
-          next context if context.database_task == false
-
           context.logger.task 'Download remote DB'
 
           if simulate?(cli_options: context.cli_options)

data/lib/wordmove/actions/ftp/put_and_import_dump_remotely.rb

@@ -25,8 +25,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context| # rubocop:disable Metrics/BlockLength
-          next context if context.database_task == false
-
           context.logger.task 'Upload and import adapted DB'
 
           result = Wordmove::Actions::PutFile.execute(

data/lib/wordmove/actions/setup_context_for_db.rb

@@ -16,13 +16,6 @@ module Wordmove
       promises :db_paths
 
       executed do |context| # rubocop:disable Metrics/BlockLength
-        if context.database_task == false
-          context.db_paths = false
-          next context
-        end
-
-        next context if simulate?(cli_options: context.cli_options)
-
         content_dir = local_wp_content_dir(local_options: context.local_options)
 
         token = remote_php_scripts_token
@@ -57,12 +50,10 @@ module Wordmove
           remote_options: context.remote_options
         ).url('import.php')
         DbPathsConfig.ftp.local.generated_dump_script_path = generate_dump_script(
-          remote_db_options: context.remote_options[:database],
-          token: token
+          remote_db_options: context.remote_options[:database], token:
         )
         DbPathsConfig.ftp.local.generated_import_script_path = generate_import_script(
-          remote_db_options: context.remote_options[:database],
-          token: token
+          remote_db_options: context.remote_options[:database], token:
         )
         DbPathsConfig.ftp.local.temp_path = local_wp_content_dir(
           local_options: context.local_options

data/lib/wordmove/actions/ssh/backup_remote_db.rb

@@ -17,8 +17,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context|
-          next context if context.database_task == false
-
           context.logger.task 'Backup remote DB'
 
           if simulate?(cli_options: context.cli_options)

data/lib/wordmove/actions/ssh/cleanup_after_adapt.rb

@@ -17,8 +17,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context| # rubocop:disable Metrics/BlockLength
-          next context if context.database_task == false
-
           context.logger.task 'Cleanup'
 
           if simulate?(cli_options: context.cli_options)

data/lib/wordmove/actions/ssh/download_remote_db.rb

@@ -24,8 +24,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context| # rubocop:disable Metrics/BlockLength
-          next context if context.database_task == false
-
           context.logger.task 'Download remote DB'
 
           next context if simulate?(cli_options: context.cli_options)

data/lib/wordmove/actions/ssh/put_and_import_dump_remotely.rb

@@ -24,8 +24,6 @@ module Wordmove
         # @!scope class
         # @return [LightService::Context] Action's context
         executed do |context| # rubocop:disable Metrics/BlockLength
-          next context if context.database_task == false
-
           context.logger.task 'Upload and import adapted DB'
 
           result = Wordmove::Actions::PutFile.execute(

data/lib/wordmove/assets/wordmove_schema_local.yml

@@ -3,6 +3,7 @@ mapping:
   vhost:
     pattern: /^https?:\/\//
   wordpress_path:
+    required: true
   database:
     type: map
     required: true
@@ -15,9 +16,6 @@ mapping:
         required: true
       host:
         required: true
-      mysqldump_options:
-      port:
-      charset:
   paths:
     type: map
     mapping:

data/lib/wordmove/cli.rb

@@ -32,23 +32,16 @@ module Wordmove
           exit 1
         end
 
-        def initial_context(cli_options)
-          cli_options.deep_symbolize_keys!
-          movefile = Wordmove::Movefile.new(cli_options)
-
-          [cli_options, movefile]
-        end
-
-        def movefile_from(**cli_options)
+        def movefile_from(cli_options)
           ensure_wordpress_options_presence!(cli_options)
-          Wordmove::Movefile.new(cli_options)
+          Wordmove::Movefile.new(cli_options, nil, true)
         rescue MovefileNotFound => e
           Logger.new($stdout).error(e.message)
           exit 1
         end
 
-        def call_organizer_with(klass:, movefile:, **cli_options)
-          result = klass.call(cli_options: cli_options, movefile: movefile)
+        def call_organizer_with(klass:, movefile:, cli_options:)
+          result = klass.call(cli_options, movefile)
 
           exit 0 if result.success?
 
@@ -114,22 +107,22 @@ module Wordmove
         private
 
         def call_pull_organizer_with(**cli_options)
-          movefile = movefile_from(**cli_options)
+          movefile = movefile_from(cli_options)
 
           if movefile.options.dig(movefile.environment, :ssh)
             call_organizer_with(
               klass: Wordmove::Organizers::Ssh::Pull,
-              movefile: movefile,
-              **cli_options
+              movefile:, cli_options:
             )
           elsif movefile.options.dig(movefile.environment, :ftp)
             call_organizer_with(
               klass: Wordmove::Organizers::Ftp::Pull,
-              movefile: movefile,
-              **cli_options
+              movefile:, cli_options:
             )
           else
-            raise NoAdapterFound, 'No valid adapter found.'
+            raise NoAdapterFound, 'No valid adapter found. It seems like your movefile.yml lacks ' \
+                                  'an ssh or ftp section for the current environment. ' \
+                                  'Run `wordmove doctor` for more info'
           end
         rescue NoAdapterFound => e
           Logger.new($stdout).error(e.message)
@@ -149,22 +142,22 @@ module Wordmove
         private
 
         def call_push_organizer_with(**cli_options)
-          movefile = movefile_from(**cli_options)
+          movefile = movefile_from(cli_options)
 
           if movefile.options.dig(movefile.environment, :ssh)
             call_organizer_with(
               klass: Wordmove::Organizers::Ssh::Push,
-              movefile: movefile,
-              **cli_options
+              movefile:, cli_options:
             )
           elsif movefile.options.dig(movefile.environment, :ftp)
             call_organizer_with(
               klass: Wordmove::Organizers::Ftp::Push,
-              movefile: movefile,
-              **cli_options
+              movefile:, cli_options:
             )
           else
-            raise NoAdapterFound, 'No valid adapter found.'
+            raise NoAdapterFound, 'No valid adapter found. It seems like your movefile.yml lacks ' \
+                                  'an ssh or ftp section for the current environment. ' \
+                                  'Run `wordmove doctor` for more info'
           end
         rescue NoAdapterFound => e
           Logger.new($stdout).error(e.message)

data/lib/wordmove/doctor/movefile.rb

@@ -5,7 +5,7 @@ module Wordmove
       attr_reader :movefile, :contents, :root_keys
 
       def initialize(cli_options = {}, dir = '.')
-        @movefile = Wordmove::Movefile.new(cli_options, dir)
+        @movefile = Wordmove::Movefile.new(cli_options, dir, false)
 
         begin
           @contents = movefile.options

data/lib/wordmove/doctor/mysql.rb

@@ -7,7 +7,7 @@ module Wordmove
         @logger = Logger.new($stdout).tap { |l| l.level = Logger::INFO }
         begin
           @config = Wordmove::Movefile
-                    .new({ config: movefile_name }, movefile_dir)
+                    .new({ config: movefile_name }, movefile_dir, false)
                     .options[:local][:database]
         rescue Psych::SyntaxError => e
           logger.error e.message

data/lib/wordmove/environments_list.rb

@@ -16,8 +16,8 @@ module Wordmove
     end
 
     def print
-      contents = parse_movefile(movefile: movefile)
-      generate_vhost_list(contents: contents)
+      contents = parse_movefile(movefile:)
+      generate_vhost_list(contents:)
       output
     end
 
@@ -55,7 +55,7 @@ module Wordmove
     #
     def generate_vhost_list(contents:)
       # select object which has 'vhost' only
-      vhosts = select_vhost(contents: contents)
+      vhosts = select_vhost(contents:)
       vhosts.each do |list|
         if list[:env] == :local
           @local_vhost << list