wordmove 5.2.2 → 6.0.0.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f06e5ea25d6f6ba6a89a0794f707054bd610332b13577da5f5927abb012e80b
-  data.tar.gz: 606d54185e3da1bc13027223105dd345e3a5af67420eabc5ed44bd4aea1e65ac
+  metadata.gz: ff2399e2a947da60d6acac49fb8dc6beb32f3571d4f79cf5f1ea0c5f8f0fcfe6
+  data.tar.gz: 1aa500f453341eceb9a1d82d03abec6c139de29806b840d0844f578241ae696c
 SHA512:
-  metadata.gz: beaf05a7ce50d11c7477bb7369c727c17ac4d98f541dbcfd383b90486541edba836086fec890df43ff4f9e78041df50be7cb356b3d0eba7de96e71ae122dd37f
-  data.tar.gz: d17d47f4febc8ea941aa4eb038c85c45c749105b92e23a59fb521b13c8bdf518edcd35de6208080e7847008763a7c38913dfe51eba702ba49823de7acc465887
+  metadata.gz: 7e3480a25ffeff1808227e5036dc4c7e0d69d92822019b3ffb3e5d47b54bf60809d1a0951c3ee38574dd9e9f345ddcff7d49e92ab171c5930e8d2d0d9f886fd0
+  data.tar.gz: 5c742c2644d644f9f3d61c0d77dbc15c69957244f98c20dade5e04867b59d55202b88449ea1a9f5ff9ca2952a7e43b1db24fdf8c4e4d387438dd8b0807317096

data/.github/workflows/ruby.yml

@@ -15,16 +15,23 @@ on:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
+    container:
+      image: welaika/wordmove:latest
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+    - name: Cache gems
+      uses: actions/cache@v2
       with:
-        ruby-version: 2.6
+        path: .vendor/bundle
+        key: wordmove-${{ hashFiles('wordmove.gemspec') }}
+    - name: Install bundler
+      run: |
+        echo $(pwd)
+        bundle config set path .vendor/bundle
+        gem install bundler:2.3.3
     - name: Install dependencies
-      run: bundle install
+      run : bundle install
     - name: Run tests
       run: bundle exec rake

data/.rubocop.yml

@@ -1,7 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7.1
   DisplayCopNames: true
   DisplayStyleGuide: true
+  NewCops: enable
 
   Exclude:
     - 'bin/*'
@@ -27,10 +28,6 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 10
 
-Style/StringLiterals:
-  Enabled: false
-  EnforcedStyle: double_quotes
-
 Style/Documentation:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.1

data/.yardopts

@@ -0,0 +1 @@
+--plugin activesupport-concern

data/CONTRIBUTING.md

@@ -77,6 +77,21 @@ or run the executable directly
 bin/wordmove --version
 ```
 
+#### Documenting
+
+A large part of the code is documented using https://yardoc.org/.
+
+Please, stick with this practice when you're implementing new code. If you want to preview yard
+documentation locally
+
+```
+yard server -r
+```
+
+then visit the served HTML at http://localhost:8808.
+
+YARD documentation is automatically published by rubygems site at each release.
+
 ### Maintainer tasks
 
 ToDo:

data/Rakefile

@@ -1,8 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
 RuboCop::RakeTask.new(:rubocop)
+
 task default: :rubocop
+task default: :spec

data/exe/wordmove

@@ -3,4 +3,5 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'wordmove'
-Wordmove::CLI.start
+
+Dry::CLI.new(Wordmove::CLI::Commands).call

data/lib/wordmove/actions/adapt_local_db.rb

@@ -0,0 +1,101 @@
+module Wordmove
+  module Actions
+    #
+    # Adapt the local DB for the remote destination.
+    # "To adapt" in Wordmove jargon means to transform URLs strings into the database. This action
+    # will substitute local URLs with remote ones, in order to make the DB to work correctly once
+    # pushed to the remote wordpress installation.
+    #
+    class AdaptLocalDb
+      extend ::LightService::Action
+      include Wordmove::Actions::Helpers
+      include Wordmove::Wpcli
+
+      expects :local_options,
+              :remote_options,
+              :cli_options,
+              :logger,
+              :photocopier,
+              :db_paths
+
+      # @!method execute
+      # @param local_options [Hash] Local host options fetched from
+      #        movefile (with symbolized keys)
+      # @param remote_options [Hash] Remote host options fetched from
+      #        movefile (with symbolized keys)
+      # @param cli_options [Hash] Command line options
+      # @param logger [Wordmove::Logger]
+      # @param photocopier [Photocopier::SSH|Photocopier::FTP]
+      # @param db_paths [BbPathsConfig] Configuration object for database
+      # @!scope class
+      # @return [LightService::Context] Action's context
+      executed do |context| # rubocop:disable Metrics/BlockLength
+        context.logger.task 'Adapt local DB'
+
+        unless wp_in_path?
+          raise UnmetPeerDependencyError, 'WP-CLI is not installed or not in your $PATH'
+        end
+
+        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?
+
+        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
+
+        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.adapted_path
+          )
+        )
+        context.fail_and_return!(result.message) if result.failure?
+
+        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?
+        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?
+      end
+    end
+  end
+end

data/lib/wordmove/actions/adapt_remote_db.rb

@@ -0,0 +1,88 @@
+module Wordmove
+  module Actions
+    #
+    # Adapt the remote DB for the local destination.
+    # "To adapt" in Wordmove jargon means to transform URLs strings into the database. This action
+    # will substitute remote URLs with local ones, in order to make the DB to work correctly once
+    # pulled to the local wordpress installation.
+    #
+    # @note This action is not responsible to download the remote DB nor to backup any DB at all.
+    #       It expects to find a dump of the remote DB into +context.db_paths.local.gzipped_path+
+    #       (SSH) or +context.db_paths.local.path+ (FTP), otherwise it will fail and stop the
+    #       procedure.
+    #
+    class AdaptRemoteDb
+      extend ::LightService::Action
+      include Wordmove::Actions::Helpers
+      include Wordmove::Wpcli
+
+      expects :local_options,
+              :cli_options,
+              :logger,
+              :db_paths
+
+      # @!method execute
+      # @param local_options [Hash] Local host options fetched from
+      #        movefile (with symbolized keys)
+      # @param cli_options [Hash] Command line options
+      # @param logger [Wordmove::Logger]
+      # @param db_paths [BbPathsConfig] Configuration object for database
+      # @!scope class
+      # @return [LightService::Context] Action's context
+      executed do |context| # rubocop:disable Metrics/BlockLength
+        context.logger.task 'Adapt remote DB'
+
+        unless wp_in_path?
+          raise UnmetPeerDependencyError, 'WP-CLI is not installed or not in your $PATH'
+        end
+
+        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)
+          )
+        end
+
+        unless File.exist?(context.db_paths.local.path)
+          context.fail_and_return!(
+            "Cannot find the dump file to adapt in #{context.db_paths.local.path}"
+          )
+        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?
+
+        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?
+
+        context.logger.success 'Local DB adapted'
+      end
+    end
+  end
+end

data/lib/wordmove/actions/backup_local_db.rb

@@ -0,0 +1,56 @@
+module Wordmove
+  module Actions
+    #
+    # Take a backup of the local database and save it in +wp-content/+ folder.
+    #
+    class BackupLocalDb
+      extend ::LightService::Action
+      include Wordmove::Actions::Helpers
+
+      expects :local_options
+      expects :cli_options
+      expects :db_paths
+      expects :logger
+
+      # @!method execute
+      # @param local_options [Hash] Local host options fetched from
+      #        movefile (with symbolized keys)
+      # @param cli_options [Hash] Command line options
+      # @param db_paths [BbPathsConfig] Configuration object for database
+      # @param logger [Wordmove::Logger]
+      # @!scope class
+      # @return [LightService::Context] Action's context
+      executed do |context|
+        context.logger.task 'Backup local DB'
+
+        if simulate?(cli_options: context.cli_options)
+          context.logger.info 'A backup of the local DB would have been saved into ' \
+                              "#{context.db_paths.backup.local.gzipped_path}, " \
+                              'but you\'re simulating'
+          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?
+
+        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?
+
+        context.logger.success(
+          "Backup saved at #{context.db_paths.backup.local.gzipped_path}"
+        )
+      end
+    end
+  end
+end

data/lib/wordmove/actions/delete_local_file.rb

@@ -0,0 +1,34 @@
+module Wordmove
+  module Actions
+    # Delete a local file situated at the given path.
+    # Command won't be run if +--simulate+ flag is present on CLI.
+    # @note This action is *not* meant to be organized, but as a standalone one.
+    class DeleteLocalFile
+      extend LightService::Action
+      include Wordmove::Actions::Helpers
+
+      expects :file_path,
+              :logger,
+              :cli_options
+
+      # @!method execute
+      # @param file_path [String]
+      # @param logger [Wordmove::Logger]
+      # @param cli_options [Hash] Command line options (with symbolized keys)
+      # @!scope class
+      # @return [LightService::Context] Action's context
+      executed do |context|
+        context.logger.task_step true, "delete: '#{context.file_path}'"
+
+        next context if simulate?(cli_options: context.cli_options)
+
+        unless File.exist?(context.file_path)
+          context.logger.info "File #{context.file_path} does not exist. Nothing done."
+          next context
+        end
+
+        File.delete(context.file_path)
+      end
+    end
+  end
+end

data/lib/wordmove/actions/delete_remote_file.rb

@@ -0,0 +1,43 @@
+module Wordmove
+  module Actions
+    # Delete a remote file
+    # @note This action is *not* meant to be organized, but as a standalone one.
+    class DeleteRemoteFile
+      extend LightService::Action
+      include Wordmove::Actions::Helpers
+
+      expects :photocopier,
+              :logger,
+              :cli_options,
+              :remote_file
+
+      # @!method execute
+      # @param photocopier [Photocopier]
+      # @param logger [Wordmove::Logger]
+      # @param cli_options [Hash] Command line options (with symbolized keys)
+      # @param remote_file ((String) remote file path)
+      # @!scope class
+      # @return [LightService::Context] Action's context
+      executed do |context|
+        command = 'delete'
+
+        context.logger.task_step false, "#{command}: #{context.remote_file}"
+
+        next context if simulate?(cli_options: context.cli_options)
+
+        _stdout, stderr, exit_code = context.photocopier.send(command, context.remote_file)
+
+        next context if exit_code&.zero?
+
+        # When +context.photocopier+ is a +Photocopier::FTP+ instance, +delte+ will always
+        # return +nil+; so it's impossible to correctly fail the context when using
+        # FTP protocol. The problem is how +Net::FTP+ ruby class behaves.
+        # IMO this is an acceptable tradeoff.
+        unless exit_code.nil?
+          context.fail! "Error code #{exit_code} returned while deleting file "\
+                        "#{context.remote_file}: #{stderr}"
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/actions/filter_and_setup_tasks_to_run.rb

@@ -0,0 +1,42 @@
+module Wordmove
+  module Actions
+    # Given the command line options and given the denied-by-config actions,
+    # selects the actions to be run altering the context.
+    class FilterAndSetupTasksToRun
+      extend ::LightService::Action
+      include Wordmove::Actions::Helpers
+      include Wordmove::Actions::Ssh::Helpers
+      include WordpressDirectory::RemoteHelperMethods
+
+      expects :guardian,
+              :cli_options
+      promises :folder_tasks,
+               :database_task,
+               :wordpress_task
+
+      # @!method execute
+      # @param guardian [Wordmove::Guardian]
+      # @param cli_options [Hash]
+      # @!scope class
+      # @return [LightService::Context] Action's context
+      executed do |context|
+        all_tasks = Wordmove::CLI::PullPushShared::WORDPRESS_OPTIONS
+
+        requested_tasks = all_tasks.select do |task|
+          context.cli_options[task] ||
+            (context.cli_options[:all] && context.cli_options[task] != false)
+        end
+
+        allowed_tasks = requested_tasks.select { |task| context.guardian.allows task }
+
+        # Since we `promises` the following variables, we cannot set them as `nil`
+        context.database_task = allowed_tasks.delete(:db) || false
+        context.wordpress_task = allowed_tasks.delete(:wordpress) || false
+        # :db and :wordpress were just removed, so we consider
+        # the reminders as folder tasks. It's a weak assumption
+        # though.
+        context.folder_tasks = allowed_tasks
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Wordmove
+  module Actions
+    module Ftp
+      # Bakups an already downloaded remote DB dump
+      class BackupRemoteDb
+        extend ::LightService::Action
+        include Wordmove::Actions::Helpers
+
+        expects :remote_options,
+                :cli_options,
+                :logger,
+                :photocopier,
+                :db_paths
+
+        # @!method execute
+        # @param remote_options [Hash] Options for the remote host fetched from the movefile
+        # @param cli_options [Hash] Command line options (with symbolized keys)
+        # @param logger [Wordmove::Logger]
+        # @param photocopier [Photocopier::FTP]
+        # @param db_paths [BbPathsConfig] Configuration object for database
+        # @!scope class
+        # @return [LightService::Context] Action's context
+        executed do |context|
+          context.logger.task 'Backup remote DB'
+
+          if simulate?(cli_options: context.cli_options)
+            context.logger.info 'A backup of the remote DB would have been saved into ' \
+                                "#{context.db_paths.backup.remote.gzipped_path}, " \
+                                'but you\'re simulating'
+            next context
+          end
+
+          begin
+            result = Wordmove::Actions::RunLocalCommand.execute(
+              logger: context.logger,
+              cli_options: context.cli_options,
+              command: compress_command(file_path: context.db_paths.local.path)
+            )
+            raise(result.message) if result.failure?
+
+            FileUtils.mv(
+              context.db_paths.local.gzipped_path,
+              context.db_paths.backup.remote.gzipped_path
+            )
+
+            context.logger.success("Backup saved at #{context.db_paths.backup.remote.gzipped_path}")
+          rescue Errno::ENOENT, RuntimeError => e
+            context.fail_and_return!("Remote DB backup failed with: <#{e.message}>. Aborting.")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module Wordmove
+  module Actions
+    module Ftp
+      # Cleanup file created during DB push/pull operations
+      class CleanupAfterAdapt
+        extend ::LightService::Action
+        include Wordmove::Actions::Helpers
+
+        expects :db_paths,
+                :cli_options,
+                :logger,
+                :photocopier
+
+        # @!method execute
+        # @param logger [Wordmove::Logger]
+        # @param cli_options [Hash] Command line options (with symbolized keys)
+        # @param db_paths [BbPathsConfig] Configuration object for database
+        # @param photocopier [Photocopier::FTP]
+        # @!scope class
+        # @return [LightService::Context] Action's context
+        executed do |context| # rubocop:disable Metrics/BlockLength
+          context.logger.task 'Cleanup'
+
+          if simulate?(cli_options: context.cli_options)
+            context.logger.info 'No cleanup during simulation'
+            next context
+          end
+
+          result = Wordmove::Actions::DeleteLocalFile.execute(
+            logger: context.logger,
+            cli_options: context.cli_options,
+            file_path: context.db_paths.local.path
+          )
+
+          if result.failure?
+            context.logger.warning 'Failed to delete local file ' \
+                                   "#{context.db_paths.local.path} because: " \
+                                   "#{result.message}" \
+                                   '. Manual intervention required'
+          end
+
+          [
+            context.db_paths.ftp.remote.dump_script_path,
+            context.db_paths.ftp.remote.import_script_path,
+            context.db_paths.remote.path,
+            context.db_paths.ftp.remote.dumped_path
+          ].each do |file|
+            begin
+              result = Wordmove::Actions::DeleteRemoteFile.execute(
+                photocopier: context.photocopier,
+                logger: context.logger,
+                cli_options: context.cli_options,
+                remote_file: file
+              )
+            rescue Net::FTPPermError => _e
+              context.logger.info "#{file} doesn't exist remotely. Nothing to cleanup"
+            end
+
+            if result.failure? # rubocop:disable Style/Next
+              context.logger.warning 'Failed to delete remote file ' \
+                                     "#{file} because: " \
+                                     "#{result.message}" \
+                                     '. Manual intervention required'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Wordmove
+  module Actions
+    module Ftp
+      # Downloads the remote DB over FTP protocol
+      class DownloadRemoteDb
+        extend ::LightService::Action
+        include Wordmove::Actions::Helpers
+        include Wordmove::Actions::Ftp::Helpers
+        include WordpressDirectory::LocalHelperMethods
+        include WordpressDirectory::RemoteHelperMethods
+
+        expects :remote_options,
+                :cli_options,
+                :logger,
+                :photocopier,
+                :db_paths
+
+        # @!method execute
+        # @param remote_options [Hash] Remote host options fetched from
+        #        movefile (with symbolized keys)
+        # @param cli_options [Hash] Command line options (with symbolized keys)
+        # @param logger [Wordmove::Logger]
+        # @param photocopier [Photocopier::FTP]
+        # @param db_paths [BbPathsConfig] Configuration object for database
+        # @!scope class
+        # @return [LightService::Context] Action's context
+        executed do |context| # rubocop:disable Metrics/BlockLength
+          context.logger.task 'Download remote DB'
+
+          if simulate?(cli_options: context.cli_options)
+            context.logger.info 'A dump of the remote DB would have been saved into ' \
+                                "#{context.db_paths.local.path}, " \
+                                'but you\'re simulating'
+            next context
+          end
+
+          result = Wordmove::Actions::PutFile.execute(
+            photocopier: context.photocopier,
+            logger: context.logger,
+            cli_options: context.cli_options,
+            command_args: [
+              context.db_paths.ftp.local.generated_dump_script_path,
+              context.db_paths.ftp.remote.dump_script_path
+            ]
+          )
+          context.fail_and_return!(result.message) if result.failure?
+
+          dump_url = [
+            context.db_paths.ftp.remote.dump_script_url,
+            '?shared_key=',
+            context.db_paths.ftp.token
+          ].join
+
+          begin
+            download(url: dump_url, local_path: context.db_paths.local.path)
+          rescue => _e # rubocop:disable Style/RescueStandardError
+            context.fail_and_return!(e.message)
+          end
+
+          unless File.exist? context.db_paths.local.path
+            context.fail_and_return!('Download of remote DB failed')
+          end
+
+          context.logger.success "Remote DB dump downloaded in #{context.db_paths.local.path}"
+        end
+      end
+    end
+  end
+end