wordmove 5.2.0 → 6.0.0.alpha.2

data/lib/wordmove/organizers/ftp/pull.rb

@@ -0,0 +1,52 @@
+module Wordmove
+  module Organizers
+    module Ftp
+      class Pull
+        extend ::LightService::Organizer
+        include Wordmove::Actions::Helpers
+        include Wordmove::Actions::Ftp::Helpers
+
+        def self.call(cli_options:, movefile:)
+          logger = Logger.new($stdout, movefile.secrets).tap { |l| l.level = Logger::DEBUG }
+          remote_options = movefile.options[movefile.environment]
+          ftp_opts = ftp_options(remote_options: remote_options)
+
+          LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
+
+          with(
+            cli_options: cli_options,
+            global_options: movefile.options[:global],
+            local_options: movefile.options[:local],
+            remote_options: remote_options,
+            movefile: movefile,
+            guardian: Wordmove::Guardian.new(cli_options: cli_options, action: :pull),
+            logger: logger,
+            photocopier: Photocopier::FTP
+                          .new(ftp_opts)
+                          .tap { |c| c.logger = logger }
+          ).reduce(actions)
+        end
+
+        def self.actions
+          [
+            Wordmove::Actions::RunBeforePullHook, # Will fail and warn the user
+            Wordmove::Actions::FilterAndSetupTasksToRun,
+            reduce_if(
+              ->(ctx) { ctx.wordpress_task },
+              [Wordmove::Actions::Ftp::PullWordpress]
+            ),
+            iterate(:folder_tasks, [Wordmove::Actions::Ftp::GetDirectory])
+          ].concat [
+            Wordmove::Actions::SetupContextForDb,
+            Wordmove::Actions::BackupLocalDb,
+            Wordmove::Actions::Ftp::DownloadRemoteDb,
+            Wordmove::Actions::AdaptRemoteDb,
+            Wordmove::Actions::Ftp::CleanupAfterAdapt
+          ].concat [
+            Wordmove::Actions::RunAfterPullHook # Will fail and warn the user
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/organizers/ftp/push.rb

@@ -0,0 +1,53 @@
+module Wordmove
+  module Organizers
+    module Ftp
+      class Push
+        extend ::LightService::Organizer
+        include Wordmove::Actions::Helpers
+        include Wordmove::Actions::Ftp::Helpers
+
+        def self.call(cli_options:, movefile:)
+          logger = Logger.new($stdout, movefile.secrets).tap { |l| l.level = Logger::DEBUG }
+          remote_options = movefile.options[movefile.environment]
+          ftp_opts = ftp_options(remote_options: remote_options)
+
+          LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
+
+          with(
+            cli_options: cli_options,
+            global_options: movefile.options[:global],
+            local_options: movefile.options[:local],
+            remote_options: remote_options,
+            movefile: movefile,
+            guardian: Wordmove::Guardian.new(cli_options: cli_options, action: :push),
+            logger: logger,
+            photocopier: Photocopier::FTP
+                          .new(ftp_opts)
+                          .tap { |c| c.logger = logger }
+          ).reduce(actions)
+        end
+
+        def self.actions
+          [
+            Wordmove::Actions::RunBeforePushHook, # Will fail and warn the user
+            Wordmove::Actions::FilterAndSetupTasksToRun,
+            reduce_if(
+              ->(ctx) { ctx.wordpress_task },
+              [Wordmove::Actions::Ftp::PushWordpress]
+            ),
+            iterate(:folder_tasks, [Wordmove::Actions::Ftp::PutDirectory])
+          ].concat [
+            Wordmove::Actions::SetupContextForDb,
+            Wordmove::Actions::Ftp::DownloadRemoteDb,
+            Wordmove::Actions::Ftp::BackupRemoteDb,
+            Wordmove::Actions::AdaptLocalDb,
+            Wordmove::Actions::Ftp::PutAndImportDumpRemotely,
+            Wordmove::Actions::Ftp::CleanupAfterAdapt
+          ].concat [
+            Wordmove::Actions::RunAfterPushHook # Will fail and warn the user
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/organizers/ssh/pull.rb

@@ -0,0 +1,52 @@
+module Wordmove
+  module Organizers
+    module Ssh
+      class Pull
+        extend ::LightService::Organizer
+        include Wordmove::Actions::Helpers
+        include Wordmove::Actions::Ssh::Helpers
+
+        def self.call(cli_options:, movefile:)
+          logger = Logger.new($stdout, movefile.secrets).tap { |l| l.level = Logger::DEBUG }
+          remote_options = movefile.options[movefile.environment]
+          ssh_opts = ssh_options(remote_options: remote_options, simulate: cli_options[:simulate])
+
+          LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
+
+          with(
+            cli_options: cli_options,
+            global_options: movefile.options[:global],
+            local_options: movefile.options[:local],
+            remote_options: remote_options,
+            movefile: movefile,
+            guardian: Wordmove::Guardian.new(cli_options: cli_options, action: :pull),
+            logger: logger,
+            photocopier: Photocopier::SSH
+                          .new(ssh_opts)
+                          .tap { |c| c.logger = logger }
+          ).reduce(actions)
+        end
+
+        def self.actions
+          [
+            Wordmove::Actions::RunBeforePullHook,
+            Wordmove::Actions::FilterAndSetupTasksToRun,
+            reduce_if(
+              ->(ctx) { ctx.wordpress_task },
+              [Wordmove::Actions::Ssh::PullWordpress]
+            ),
+            iterate(:folder_tasks, [Wordmove::Actions::Ssh::GetDirectory])
+          ].concat [
+            Wordmove::Actions::SetupContextForDb,
+            Wordmove::Actions::BackupLocalDb,
+            Wordmove::Actions::Ssh::DownloadRemoteDb,
+            Wordmove::Actions::AdaptRemoteDb,
+            Wordmove::Actions::Ssh::CleanupAfterAdapt
+          ].concat [
+            Wordmove::Actions::RunAfterPullHook
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/organizers/ssh/push.rb

@@ -0,0 +1,53 @@
+module Wordmove
+  module Organizers
+    module Ssh
+      class Push
+        extend ::LightService::Organizer
+        include Wordmove::Actions::Helpers
+        include Wordmove::Actions::Ssh::Helpers
+
+        def self.call(cli_options:, movefile:)
+          logger = Logger.new($stdout, movefile.secrets).tap { |l| l.level = Logger::DEBUG }
+          remote_options = movefile.options[movefile.environment]
+          ssh_opts = ssh_options(remote_options: remote_options, simulate: cli_options[:simulate])
+
+          LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
+
+          with(
+            cli_options: cli_options,
+            global_options: movefile.options[:global],
+            local_options: movefile.options[:local],
+            remote_options: remote_options,
+            movefile: movefile,
+            guardian: Wordmove::Guardian.new(cli_options: cli_options, action: :push),
+            logger: logger,
+            photocopier: Photocopier::SSH
+                          .new(ssh_opts)
+                          .tap { |c| c.logger = logger }
+          ).reduce(actions)
+        end
+
+        def self.actions
+          [
+            Wordmove::Actions::RunBeforePushHook,
+            Wordmove::Actions::FilterAndSetupTasksToRun,
+            reduce_if(
+              ->(ctx) { ctx.wordpress_task },
+              [Wordmove::Actions::Ssh::PushWordpress]
+            ),
+            iterate(:folder_tasks, [Wordmove::Actions::Ssh::PutDirectory])
+          ].concat [
+            Wordmove::Actions::SetupContextForDb,
+            Wordmove::Actions::Ssh::DownloadRemoteDb,
+            Wordmove::Actions::Ssh::BackupRemoteDb,
+            Wordmove::Actions::AdaptLocalDb,
+            Wordmove::Actions::Ssh::PutAndImportDumpRemotely,
+            Wordmove::Actions::Ssh::CleanupAfterAdapt
+          ].concat [
+            Wordmove::Actions::RunAfterPushHook
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "5.2.0".freeze
+  VERSION = '6.0.0.alpha.2'.freeze
 end

data/lib/wordmove/wordpress_directory.rb

@@ -1,13 +1,21 @@
-require 'wordmove/wordpress_directory/path'
-
 class WordpressDirectory
-  attr_accessor :type, :options
+  attr_reader :folder, :options
 
-  def initialize(type, options)
-    @type = type
+  def initialize(folder, options)
+    @folder = folder
     @options = options
   end
 
+  module Path
+    WP_CONTENT = :wp_content
+    WP_CONFIG  = :wp_config
+    PLUGINS    = :plugins
+    MU_PLUGINS = :mu_plugins
+    THEMES     = :themes
+    UPLOADS    = :uploads
+    LANGUAGES  = :languages
+  end
+
   DEFAULT_PATHS = {
     Path::WP_CONTENT => 'wp-content',
     Path::WP_CONFIG => 'wp-config.php',
@@ -31,11 +39,71 @@ class WordpressDirectory
   end
 
   def relative_path(*args)
-    path = if options[:paths] && options[:paths][type]
-             options[:paths][type]
+    path = if options[:paths] && options[:paths][folder]
+             options[:paths][folder]
            else
-             DEFAULT_PATHS[type]
+             DEFAULT_PATHS[folder]
            end
     File.join(path, *args)
   end
+
+  module RemoteHelperMethods
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def remote_wp_content_dir(remote_options:)
+        WordpressDirectory.new(:wp_content, remote_options)
+      end
+
+      def remote_plugins_dir(remote_options:)
+        WordpressDirectory.new(:plugins, remote_options)
+      end
+
+      def remote_mu_plugins_dir(remote_options:)
+        WordpressDirectory.new(:mu_plugins, remote_options)
+      end
+
+      def remote_themes_dir(remote_options:)
+        WordpressDirectory.new(:themes, remote_options)
+      end
+
+      def remote_uploads_dir(remote_options:)
+        WordpressDirectory.new(:uploads, remote_options)
+      end
+
+      def remote_languages_dir(remote_options:)
+        WordpressDirectory.new(:languages, remote_options)
+      end
+    end
+  end
+
+  module LocalHelperMethods
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def local_wp_content_dir(local_options:)
+        WordpressDirectory.new(:wp_content, local_options)
+      end
+
+      def local_plugins_dir(local_options:)
+        WordpressDirectory.new(:plugins, local_options)
+      end
+
+      def local_mu_plugins_dir(local_options:)
+        WordpressDirectory.new(:mu_plugins, local_options)
+      end
+
+      def local_themes_dir(local_options:)
+        WordpressDirectory.new(:themes, local_options)
+      end
+
+      def local_uploads_dir(local_options:)
+        WordpressDirectory.new(:uploads, local_options)
+      end
+
+      def local_languages_dir(local_options:)
+        WordpressDirectory.new(:languages, local_options)
+      end
+    end
+  end
 end

data/lib/wordmove/wpcli.rb

@@ -0,0 +1,85 @@
+module Wordmove
+  # This class is a sort of mini-wrapper around the wp-cli executable.
+  # It's responsible to run or produce wp-cli commands.
+  module Wpcli
+    extend ActiveSupport::Concern
+
+    included do
+      private_class_method :load_from_wpcli, :load_from_yml
+    end
+
+    class_methods do # rubocop:disable Metrics/BlockLength
+      # Checks if `wp` command is in your shell `$PATH`
+      #
+      # @return [Boolean]
+      # @!scope class
+      def wp_in_path?
+        system('which wp > /dev/null 2>&1')
+      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 wpcli_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)}",
+          context.remote_options[config_key],
+          context.local_options[config_key],
+          '--quiet',
+          '--skip-columns=guid',
+          '--all-tables',
+          '--allow-root'
+        ].join(' ')
+      end
+
+      # Returns the wordpress path from wp-cli (with precedence) or from movefile
+      #
+      # It's intended to be used from a +LightService::Action+
+      #
+      # @param context [LightService::Context] The context of an action
+      # @return [String]
+      # @!scope class
+      def wpcli_config_path(context)
+        load_from_yml(context) || load_from_wpcli || context.local_options[:wordpress_path]
+      end
+
+      # If wordpress installation brings a `wp-cli.yml` file in its root folder,
+      # reads it and returns the `path` yaml key configured there
+      #
+      # @return [String, nil] The `path` configuration or `nil`
+      # @!scope class
+      # @!visibility private
+      def load_from_yml(context)
+        yml_path = File.join(context.local_options[:wordpress_path], 'wp-cli.yml')
+
+        return unless File.exist?(yml_path)
+
+        YAML.load_file(yml_path).with_indifferent_access['path']
+      end
+
+      # Returns the wordpress path as per wp-cli configuration.
+      # A possible scenario is that the used wpcli command could return an empty
+      # string: we thus rescue parse errors in order to ignore this config source
+      #
+      # @return [String, nil] The wordpress path as per wp-cli configuration or nil
+      # @!scope class
+      # @!visibility private
+      def load_from_wpcli
+        wpcli_config = JSON.parse(`wp cli param-dump --with-values`, symbolize_names: true)
+        wpcli_config.dig(:path, :current)
+      rescue JSON::ParserError => _e
+        nil
+      end
+    end
+  end
+end

data/lib/wordmove.rb

@@ -4,13 +4,15 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'colorize'
 require 'dotenv'
+require 'dry/cli'
+require 'dry-configurable'
+require 'dry/files'
 require 'erb'
 require 'kwalify'
+require 'light-service'
 require 'logger'
 require 'open-uri'
 require 'ostruct'
-require 'thor'
-require 'thor/group'
 require 'yaml'
 
 require 'photocopier'
@@ -27,20 +29,40 @@ require 'wordmove/guardian'
 require 'wordmove/hook'
 require 'wordmove/logger'
 require 'wordmove/movefile'
-require 'wordmove/sql_adapter/default'
-require 'wordmove/sql_adapter/wpcli'
 require 'wordmove/wordpress_directory'
-require "wordmove/version"
-require "wordmove/environments_list"
+require 'wordmove/version'
+require 'wordmove/environments_list'
+require 'wordmove/wpcli'
 
 require 'wordmove/generators/movefile_adapter'
 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'
+require 'wordmove/db_paths_config'
+
+require 'wordmove/actions/helpers'
+require 'wordmove/actions/ssh/helpers'
+require 'wordmove/actions/ftp/helpers'
+Dir[File.join(__dir__, 'wordmove/actions/**/*.rb')].sort.each { |file| require file }
+Dir[File.join(__dir__, 'wordmove/organizers/**/*.rb')].sort.each { |file| require file }
 
 module Wordmove
+  # Interactors' namespce. Interactors are called "Actions", following the LightService convention.
+  # In this namespace there are two kinds of "Actions":
+  # * local environment actions
+  # * protocol agnostic remote environment actions
+  # @see https://github.com/adomokos/light-service/blob/master/README.md LightService README
+  module Actions
+    # Ssh actions' namespace. Here are SSH protocol specific actions and organizers
+    # for remote environments
+    module Ssh
+    end
+  end
+
+  # Organizers are responsible of running organizer procedures putting together Actions
+  # following business logic requirements.
+  module Organizers
+    # Organizers for the Ssh protocol
+    module Ssh
+    end
+  end
 end

data/wordmove.gemspec

@@ -3,48 +3,55 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wordmove/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "wordmove"
+  spec.name          = 'wordmove'
   spec.version       = Wordmove::VERSION
+  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
   spec.authors       = [
-    "Stefano Verna", "Ju Liu", "Fabrizio Monti", "Alessandro Fazzi", "Filippo Gangi Dino"
+    'Stefano Verna', 'Ju Liu', 'Fabrizio Monti', 'Alessandro Fazzi', 'Filippo Gangi Dino'
   ]
   spec.email = [
-    "stefano.verna@welaika.com",
-    "ju.liu@welaika.com",
-    "fabrizio.monti@welaika.com",
-    "alessandro.fazzi@welaika.com",
-    "filippo.gangidino@welaika.com"
+    'stefano.verna@welaika.com',
+    'ju.liu@welaika.com',
+    'fabrizio.monti@welaika.com',
+    'alessandro.fazzi@welaika.com',
+    'filippo.gangidino@welaika.com'
   ]
 
-  spec.summary       = "Wordmove, Capistrano for Wordpress"
-  spec.description   = "Wordmove deploys your WordPress websites at the speed of light."
-  spec.homepage      = "https://github.com/welaika/wordmove"
-  spec.license       = "MIT"
+  spec.summary       = 'Wordmove, Capistrano for Wordpress'
+  spec.description   = 'Wordmove deploys your WordPress websites at the speed of light.'
+  spec.homepage      = 'https://github.com/welaika/wordmove'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`
                        .split("\x0")
                        .reject { |f| f.match(%r{^(test|spec|features)/}) }
 
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "activesupport", '~> 5.1', '>= 5.1.1'
-  spec.add_runtime_dependency "colorize", "~> 0.8.1"
-  spec.add_runtime_dependency "dotenv", "~> 2.7.5"
-  spec.add_runtime_dependency "kwalify", "~> 0"
-  spec.add_runtime_dependency "photocopier", "~> 1.4", ">= 1.4.0"
-  spec.add_runtime_dependency "thor", "~> 0.20.3"
-
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "priscilla", "~> 1.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.1"
-  spec.add_development_dependency "rake", "~> 13.0.1"
-  spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "rubocop", "~> 0.76.0"
-  spec.add_development_dependency "simplecov", "~> 0.17.1"
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~> 6.1'
+  spec.add_runtime_dependency 'colorize', '~> 0.8.1'
+  spec.add_runtime_dependency 'dotenv', '~> 2.7.5'
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.13.0'
+  spec.add_runtime_dependency 'kwalify', '~> 0.7.2'
+  spec.add_runtime_dependency 'light-service', '~> 0.17.0'
+  spec.add_runtime_dependency 'photocopier', '~> 1.4', '>= 1.4.0'
+  # spec.add_runtime_dependency 'thor', '~> 0.20.3'
+  spec.add_runtime_dependency 'dry-cli', '~> 0.7.0'
+  spec.add_runtime_dependency 'dry-files', '~> 0.1.0'
+
+  spec.required_ruby_version = '>= 2.6.0' # rubocop:disable Gemspec/RequiredRubyVersion
+
+  spec.add_development_dependency 'bundler', '~> 2.3.3'
+  spec.add_development_dependency 'pry-byebug', '~> 3.1'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 1.24.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.6.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'yard-activesupport-concern'
 
   spec.post_install_message = <<-RAINBOW
     Starting from version 3.0.0 `database.charset` option is no longer accepted.