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

data/lib/wordmove/generators/movefile.rb

@@ -1,16 +1,15 @@
 module Wordmove
   module Generators
     class Movefile
-      include MovefileAdapter
-
       def self.generate
-        new.copy_movefile
+        copy_movefile
       end
 
-      def copy_movefile
+      def self.copy_movefile
+        wordpress_path = File.expand_path(Dir.pwd)
         content = ERB.new(File.read(File.join(__dir__, 'movefile.yml'))).result(binding)
-        files = Dry::Files.new
 
+        files = Dry::Files.new
         files.write('movefile.yml', content)
       end
     end

data/lib/wordmove/generators/movefile.yml

@@ -2,14 +2,15 @@ global:
   sql_adapter: wpcli
 
 local:
-  vhost: http://vhost.local
   wordpress_path: <%= wordpress_path %> # use an absolute path here
 
-  database:
-    name: <%= database.name %>
-    user: <%= database.user %>
-    password: "<%= database.password %>" # could be blank, so always use quotes around
-    host: <%= database.host %>
+  # paths: # you can customize wordpress internal paths
+  #   wp_content: wp-content
+  #   uploads: wp-content/uploads
+  #   plugins: wp-content/plugins
+  #   mu_plugins: wp-content/mu-plugins
+  #   themes: wp-content/themes
+  #   languages: wp-content/languages
 
 production:
   vhost: http://example.com
@@ -40,6 +41,7 @@ production:
     - 'wp-config.php'
     - 'wp-content/*.sql.gz'
     - '*.orig'
+    - 'wp-cli.yml'
 
   # paths: # you can customize wordpress internal paths
   #   wp_content: wp-content

data/lib/wordmove/movefile.rb

@@ -56,8 +56,6 @@ module Wordmove
     private
 
     def fetch(verbose = true) # rubocop:disable Style/OptionalBooleanParameter
-      load_dotenv
-
       entries = if config_file_name.nil?
                   Dir["#{File.join(start_dir, '{M,m}ovefile')}{,.yml,.yaml}"]
                 else
@@ -75,18 +73,40 @@ module Wordmove
       end
 
       found = entries.first
+
       logger.task("Using Movefile: #{found}") if verbose == true
-      YAML.safe_load(ERB.new(File.read(found)).result, [], [], true).deep_symbolize_keys!
+      load_dotenv(verbose)
+
+      options = YAML.safe_load(ERB.new(File.read(found)).result, symbolize_names: true)
+
+      merge_local_options_from_wpcli(options)
+    end
+
+    def merge_local_options_from_wpcli(options)
+      config_path = options.dig(:local, :wordpress_path)
+
+      options.merge(
+        local: {
+          database: {
+            password: Wordmove::WpcliHelpers.get_config('DB_PASSWORD', config_path:),
+            host: Wordmove::WpcliHelpers.get_config('DB_HOST', config_path:),
+            name: Wordmove::WpcliHelpers.get_config('DB_NAME', config_path:),
+            user: Wordmove::WpcliHelpers.get_config('DB_USER', config_path:)
+          },
+          vhost: Wordmove::WpcliHelpers.get_option('siteurl', config_path:),
+          wordpress_path: config_path
+        }
+      )
     end
 
-    def load_dotenv
+    def load_dotenv(verbose)
       env_files = Dir[File.join(start_dir, '.env')]
 
       found_env = env_files.first
 
       return false unless found_env.present?
 
-      logger.info("Using .env file: #{found_env}")
+      logger.info("Using .env file: #{found_env}") if verbose
       Dotenv.load(found_env)
     end
 

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

@@ -6,21 +6,23 @@ module Wordmove
         include Wordmove::Actions::Helpers
         include Wordmove::Actions::Ftp::Helpers
 
-        def self.call(cli_options:, movefile:)
+        # Can't use keyword arguments since LightService still has some problems with modern
+        # ruby syntax: https://github.com/adomokos/light-service/pull/224
+        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)
+          ftp_opts = ftp_options(remote_options:)
 
           LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
 
           with(
-            cli_options: 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,
+            remote_options:,
+            movefile:,
+            guardian: Wordmove::Guardian.new(cli_options:, action: :pull),
+            logger:,
             photocopier: Photocopier::FTP
                           .new(ftp_opts)
                           .tap { |c| c.logger = logger }
@@ -35,14 +37,15 @@ module Wordmove
               ->(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 [
+            iterate(:folder_tasks, [Wordmove::Actions::Ftp::GetDirectory]),
+            reduce_if(->(ctx) { ctx.database_task },
+                      [
+                        Wordmove::Actions::SetupContextForDb,
+                        Wordmove::Actions::BackupLocalDb,
+                        Wordmove::Actions::Ftp::DownloadRemoteDb,
+                        Wordmove::Actions::AdaptRemoteDb,
+                        Wordmove::Actions::Ftp::CleanupAfterAdapt
+                      ]),
             Wordmove::Actions::RunAfterPullHook # Will fail and warn the user
           ]
         end

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

@@ -6,21 +6,23 @@ module Wordmove
         include Wordmove::Actions::Helpers
         include Wordmove::Actions::Ftp::Helpers
 
-        def self.call(cli_options:, movefile:)
+        # Can't use keyword arguments since LightService still has some problems with modern
+        # ruby syntax: https://github.com/adomokos/light-service/pull/224
+        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)
+          ftp_opts = ftp_options(remote_options:)
 
           LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
 
           with(
-            cli_options: 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,
+            remote_options:,
+            movefile:,
+            guardian: Wordmove::Guardian.new(cli_options:, action: :push),
+            logger:,
             photocopier: Photocopier::FTP
                           .new(ftp_opts)
                           .tap { |c| c.logger = logger }
@@ -35,15 +37,16 @@ module Wordmove
               ->(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 [
+            iterate(:folder_tasks, [Wordmove::Actions::Ftp::PutDirectory]),
+            reduce_if(->(ctx) { ctx.database_task },
+                      [
+                        Wordmove::Actions::SetupContextForDb,
+                        Wordmove::Actions::Ftp::DownloadRemoteDb,
+                        Wordmove::Actions::Ftp::BackupRemoteDb,
+                        Wordmove::Actions::AdaptLocalDb,
+                        Wordmove::Actions::Ftp::PutAndImportDumpRemotely,
+                        Wordmove::Actions::Ftp::CleanupAfterAdapt
+                      ]),
             Wordmove::Actions::RunAfterPushHook # Will fail and warn the user
           ]
         end

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

@@ -6,21 +6,23 @@ module Wordmove
         include Wordmove::Actions::Helpers
         include Wordmove::Actions::Ssh::Helpers
 
-        def self.call(cli_options:, movefile:)
+        # Can't use keyword arguments since LightService still has some problems with modern
+        # ruby syntax: https://github.com/adomokos/light-service/pull/224
+        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])
+          ssh_opts = ssh_options(remote_options:, simulate: cli_options[:simulate])
 
           LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
 
           with(
-            cli_options: 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,
+            remote_options:,
+            movefile:,
+            guardian: Wordmove::Guardian.new(cli_options:, action: :pull),
+            logger:,
             photocopier: Photocopier::SSH
                           .new(ssh_opts)
                           .tap { |c| c.logger = logger }
@@ -35,14 +37,15 @@ module Wordmove
               ->(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 [
+            iterate(:folder_tasks, [Wordmove::Actions::Ssh::GetDirectory]),
+            reduce_if(->(ctx) { ctx.database_task },
+                      [
+                        Wordmove::Actions::SetupContextForDb,
+                        Wordmove::Actions::BackupLocalDb,
+                        Wordmove::Actions::Ssh::DownloadRemoteDb,
+                        Wordmove::Actions::AdaptRemoteDb,
+                        Wordmove::Actions::Ssh::CleanupAfterAdapt
+                      ]),
             Wordmove::Actions::RunAfterPullHook
           ]
         end

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

@@ -6,21 +6,23 @@ module Wordmove
         include Wordmove::Actions::Helpers
         include Wordmove::Actions::Ssh::Helpers
 
-        def self.call(cli_options:, movefile:)
+        # Can't use keyword arguments since LightService still has some problems with modern
+        # ruby syntax: https://github.com/adomokos/light-service/pull/224
+        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])
+          ssh_opts = ssh_options(remote_options:, simulate: cli_options[:simulate])
 
           LightService::Configuration.logger = ::Logger.new($stdout) if cli_options[:debug]
 
           with(
-            cli_options: 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,
+            remote_options:,
+            movefile:,
+            guardian: Wordmove::Guardian.new(cli_options:, action: :push),
+            logger:,
             photocopier: Photocopier::SSH
                           .new(ssh_opts)
                           .tap { |c| c.logger = logger }
@@ -35,15 +37,16 @@ module Wordmove
               ->(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 [
+            iterate(:folder_tasks, [Wordmove::Actions::Ssh::PutDirectory]),
+            reduce_if(->(ctx) { ctx.database_task },
+                      [
+                        Wordmove::Actions::SetupContextForDb,
+                        Wordmove::Actions::Ssh::DownloadRemoteDb,
+                        Wordmove::Actions::Ssh::BackupRemoteDb,
+                        Wordmove::Actions::AdaptLocalDb,
+                        Wordmove::Actions::Ssh::PutAndImportDumpRemotely,
+                        Wordmove::Actions::Ssh::CleanupAfterAdapt
+                      ]),
             Wordmove::Actions::RunAfterPushHook
           ]
         end

data/lib/wordmove/version.rb

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

data/lib/wordmove/wpcli.rb

@@ -1,7 +1,7 @@
 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
+  module WpcliHelpers
     extend ActiveSupport::Concern
 
     included do
@@ -17,40 +17,28 @@ module Wordmove
         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+
+      # It's intended to be used from a +LightService::Action+, but it also supports
+      # to receive a path as argument. If the argument is not a LightService::Context
+      # then it will be treated as a path.
+      # The path passed as argument should be the wordpress installation path, but it's
+      # not strictly mandatory: the method will try to load a wpcli's YAML config
+      # from that path, so you can potentially use it with any path
       #
-      # @param context [LightService::Context] The context of an action
+      # @param context [LightService::Context|String] The context of an action or a path as string
       # @return [String]
       # @!scope class
-      def wpcli_config_path(context)
-        load_from_yml(context) || load_from_wpcli || context.local_options[:wordpress_path]
+      def wpcli_config_path(context_or_path)
+        context = if context_or_path.is_a? LightService::Context
+                    context_or_path
+                  else
+                    # We need to make it quack like a duck in order to be
+                    # backward compatible with previous code
+                    { local_options: { wordpress_path: context_or_path } }
+                  end
+
+        load_from_yml(context) || load_from_wpcli || context.dig(:local_options, :wordpress_path)
       end
 
       # If wordpress installation brings a `wp-cli.yml` file in its root folder,
@@ -60,7 +48,8 @@ module Wordmove
       # @!scope class
       # @!visibility private
       def load_from_yml(context)
-        yml_path = File.join(context.local_options[:wordpress_path], 'wp-cli.yml')
+        config_path = context.dig(:local_options, :wordpress_path) || '.'
+        yml_path = File.join(config_path, 'wp-cli.yml')
 
         return unless File.exist?(yml_path)
 
@@ -84,5 +73,13 @@ module Wordmove
         nil
       end
     end
+
+    def self.get_option(option, config_path:)
+      `wp option get #{option} --allow-root --path=#{config_path}`.chomp
+    end
+
+    def self.get_config(config, config_path:)
+      `wp config get #{config} --allow-root --path=#{config_path}`.chomp
+    end
   end
 end

data/lib/wordmove.rb

@@ -17,6 +17,8 @@ require 'yaml'
 
 require 'photocopier'
 
+require 'wordmove/wpcli'
+
 require 'wordmove/cli'
 require 'wordmove/doctor'
 require 'wordmove/doctor/movefile'
@@ -32,9 +34,7 @@ require 'wordmove/movefile'
 require 'wordmove/wordpress_directory'
 require 'wordmove/version'
 require 'wordmove/environments_list'
-require 'wordmove/wpcli'
 
-require 'wordmove/generators/movefile_adapter'
 require 'wordmove/generators/movefile'
 
 require 'wordmove/db_paths_config'
@@ -42,8 +42,8 @@ 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 }
+Dir[File.join(__dir__, 'wordmove/actions/**/*.rb')].each { |file| require file }
+Dir[File.join(__dir__, 'wordmove/organizers/**/*.rb')].each { |file| require file }
 
 module Wordmove
   # Interactors' namespce. Interactors are called "Actions", following the LightService convention.

data/wordmove.gemspec

@@ -36,12 +36,12 @@ Gem::Specification.new do |spec|
   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 'photocopier', '~> 1.4', '>= 1.4.1'
   # 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.required_ruby_version = '>= 3.1.0'
 
   spec.add_development_dependency 'bundler', '~> 2.3.3'
   spec.add_development_dependency 'pry-byebug', '~> 3.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove
 version: !ruby/object:Gem::Version
-  version: 6.0.0.alpha.3
+  version: 6.0.0.alpha.7
 platform: ruby
 authors:
 - Stefano Verna
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,7 +107,7 @@ dependencies:
         version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -117,7 +117,7 @@ dependencies:
         version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -375,7 +375,6 @@ files:
 - lib/wordmove/exceptions.rb
 - lib/wordmove/generators/movefile.rb
 - lib/wordmove/generators/movefile.yml
-- lib/wordmove/generators/movefile_adapter.rb
 - lib/wordmove/guardian.rb
 - lib/wordmove/hook.rb
 - lib/wordmove/logger.rb
@@ -410,14 +409,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Wordmove, Capistrano for Wordpress

data/lib/wordmove/generators/movefile_adapter.rb

@@ -1,89 +0,0 @@
-module Wordmove
-  module Generators
-    module MovefileAdapter
-      def wordpress_path
-        File.expand_path(Dir.pwd)
-      end
-
-      def database
-        DBConfigReader.config
-      end
-    end
-
-    class DBConfigReader
-      def self.config
-        new.config
-      end
-
-      def config
-        Struct.new(
-          :name,
-          :user,
-          :password,
-          :host,
-          keyword_init: true
-        ).new(database_config)
-      end
-
-      def database_config
-        if wp_config_exists?
-          WordpressDBConfig.config
-        else
-          DefaultDBConfig.config
-        end
-      end
-
-      def wp_config_exists?
-        File.exist?(WordpressDirectory.default_path_for(:wp_config))
-      end
-    end
-
-    class DefaultDBConfig
-      def self.config
-        {
-          name: 'database_name',
-          user: 'user',
-          password: 'password',
-          host: '127.0.0.1'
-        }
-      end
-    end
-
-    class WordpressDBConfig
-      def self.config
-        new.config
-      end
-
-      def wp_config
-        @wp_config ||= File.read(
-          WordpressDirectory.default_path_for(:wp_config)
-        ).encode('utf-8', invalid: :replace)
-      end
-
-      def wp_definitions
-        {
-          name: 'DB_NAME',
-          user: 'DB_USER',
-          password: 'DB_PASSWORD',
-          host: 'DB_HOST'
-        }
-      end
-
-      def wp_definition_regex(definition)
-        /['"]#{definition}['"],\s*["'](?<value>.*)['"]/
-      end
-
-      def defaults
-        DefaultDBConfig.config.clone
-      end
-
-      def config
-        wp_definitions.each_with_object(defaults) do |(key, definition), result|
-          wp_config.match(wp_definition_regex(definition)) do |match|
-            result[key] = match[:value]
-          end
-        end
-      end
-    end
-  end
-end