wordmove 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b44325c0d09d56d3a59080721d52ef65d301116
-  data.tar.gz: 5fbb645e7df0d2ec0b66773c0c52c5523ec25131
+  metadata.gz: 2b51293554be6d33b634aa494f0db0e88ea2326a
+  data.tar.gz: 2fcf92909bd0a02c28f2a2f641be9f0e03c585be
 SHA512:
-  metadata.gz: 8112d61e266fb7b83227463dcd70e6160a006bbfa19cbf1405502783a7a0ddcb4ee8b4d8a28df9ee2d88cd9f93c7bdc962926e2da1296444fb7dff83b770f464
-  data.tar.gz: 0f07783014805087b720a9b11b48fc7fda2a79e3b6ab0f8eca31ad75ac3d82f7b6d07c9434f393ab94b4b8924c16bfc38e324e3e550625afa09f24981a4bcec6
+  metadata.gz: 9a9d599400d09b8b0424eb1b88c01e1f68c80a4f280c304d6522d9e275aaf2ad6716eef0dd0c679a490f05490bd6e2b2daf6b09089ee02fab88445b2de4cb6a9
+  data.tar.gz: 450caed451d3c875f977a6aad2407e88d5cd895a8b7c3916a8e8d744f4a9cd0da2ddd775a606e96f0e49f705bdd57d5d76a5a4942bd0e82576781bf57e2bd394

data/README.mdown

@@ -6,11 +6,14 @@ Wordmove is a gem that lets you automatically mirror local Wordpress
 installations and DB data back and forth from your local development machine to
 the remote server.
 
-**SSH** connections are fully supported, while [FTP support is planned to be discontinued](https://github.com/welaika/wordmove/wiki/FTP-support-disclaimer) when new features will be introduced.
+Wordmove has also a neat hook system which enables you to run arbitrary commands
+before and after push/pull actions. Local and remote commands are both supported, but remote
+ones will be run only if using SSH protocol. Read the [dedicated wiki page](https://github.com/welaika/wordmove/wiki/Hooks) for more info.
 
-Think of it like Capistrano for Wordpress, complete with push/pull capabilities.
+[FTP support has been discontinued](https://github.com/welaika/wordmove/wiki/FTP-support-disclaimer), thus most recent features won't work,
+while base functionalities are granted.
 
-[![Build Status](https://travis-ci.org/welaika/wordmove.png?branch=master)](https://travis-ci.org/welaika/wordmove)
+[![Build Status](https://travis-ci.org/welaika/wordmove.svg?branch=master)](https://travis-ci.org/welaika/wordmove)
 [![Slack channel](https://img.shields.io/badge/Slack-WP--Hub-blue.svg)](https://wphub-auto-invitation.herokuapp.com/)
 [![Gem Version](https://badge.fury.io/rb/wordmove.svg)](https://rubygems.org/gems/wordmove)
 
@@ -18,11 +21,11 @@ Think of it like Capistrano for Wordpress, complete with push/pull capabilities.
 
 That's easy:
 
-```
-gem install wordmove
-```
+    gem install wordmove
 
+And to update:
 
+    gem update wordmove
 
 ## Peer dependencies
 
@@ -32,7 +35,7 @@ Wordmove just acts as automation glue bewtween tools you already have and love.
 | ------- | ---------------------------- | ------------------------------- |
 | rsync   | Push and pull files and dirs | Yes for SSH connections         |
 | mysql   | Import and dump database     | Yes                             |
-| wp-cli  | DB adapt                     | Nope: experimental and optional |
+| wp-cli  | DB adapt                     | Nope (but soon will be)         |
 | lftp    | all                          | Yes, for FTP connections        |
 | ssh     | all                          | Yes, for SSH connections        |
 
@@ -61,7 +64,7 @@ Move inside the Wordpress folder and use `wordmove init` to generate a new `move
 
 ## movefile.yml
 
-You can configure Wordmove creating a `movefile.yml`. That's just a YAML file with local and remote host infos:
+You can configure Wordmove creating a `movefile.yml`. That's a YAML file with local and remote host(s) infos:
 
 ```yaml
 global:
@@ -113,11 +116,49 @@ production:
   ssh:
     host: host
     user: user
+
+  # hooks: # Remote hooks won't work with FTP
+  #   push:
+  #     before:
+  #       local:
+  #         - 'echo "Do something locally before push"'
+  #       remote:
+  #         - 'echo "Do something remotely before push"'
+  #     after:
+  #       local:
+  #         - 'echo "Do something locally after push"'
+  #       remote:
+  #         - 'echo "Do something remotely after push"'
+  #   pull:
+  #     before:
+  #       local:
+  #         - 'echo "Do something locally before pull"'
+  #       remote:
+  #         - 'echo "Do something remotely before pull"'
+  #     after:
+  #       local:
+  #         - 'echo "Do something locally after pull"'
+  #       remote:
+  #         - 'echo "Do something remotely after pull"'
 ```
 
 **We warmly recommend to read the wiki article [Multiple environments explained
 ](https://github.com/welaika/wordmove/wiki/Multiple-environments-explained) if you need multi-stage support, and the wiki article [Movefile configurations explained](https://github.com/welaika/wordmove/wiki/movefile.yml-configurations-explained) to understand about the supported configurations.**
 
+## Multistage
+
+You can define multiple environments in your `movefile.yml`, such as production, staging, etc.
+Use `-e` with `pull` or `push` to run the command on the specified environment.
+
+For example:
+
+    wordmove push -e staging -d
+
+will push your local database to the staging environment only.
+
+We warmly **recommend** to read the wiki article: [Multiple environments explained
+](https://github.com/welaika/wordmove/wiki/Multiple-environments-explained)
+
 ## Supports
 
 ### OS
@@ -141,21 +182,17 @@ See the [Windows (un)support disclaimer](https://github.com/welaika/wordmove/wik
 
 FTP support is [planned to be discontinued](https://github.com/welaika/wordmove/wiki/FTP-support-disclaimer) at some point of future development.
 
-### Multistage
+## Notes
 
-You can define multiple environments in your `movefile.yml`, such as production, staging, etc.
-Use `-e` with `pull` or `push` to run the command on the specified environment.
+### Mirroring
 
-For example:
-```
-wordmove push -e staging -d
-```
-will push your local database to the staging environment only.
-
-We warmly **recommend** to read the wiki article: [Multiple environments explained
-](https://github.com/welaika/wordmove/wiki/Multiple-environments-explained)
+Push and pull actions on files will perform a **mirror** operation. Please, keep
+in mind that to mirror means to transfer new/updated files **and remove files**
+from destination if not present in source.
 
-## Notes
+This means that if you have files/directories on your remotes which you must
+preserve, you **must exclude those in your movefile.yml**, or they will be
+deleted.
 
 ### How the heck you are able to sync the DB via FTP?
 

data/lib/wordmove.rb

@@ -22,6 +22,7 @@ require 'wordmove/doctor/mysql'
 require 'wordmove/doctor/wpcli'
 require 'wordmove/doctor/rsync'
 require 'wordmove/doctor/ssh'
+require 'wordmove/hook'
 require 'wordmove/logger'
 require 'wordmove/movefile'
 require 'wordmove/sql_adapter/default'

data/lib/wordmove/assets/wordmove_schema_remote.yml

@@ -76,3 +76,56 @@ mapping:
       passive:
         type: bool
       scheme:
+  hooks:
+    type: map
+    mapping:
+      push:
+        type: map
+        mapping:
+          before:
+            type: map
+            mapping:
+              local:
+                type: seq
+                sequence:
+                  - type: str
+              remote:
+                type: seq
+                sequence:
+                  - type: str
+          after:
+            type: map
+            mapping:
+              local:
+                type: seq
+                sequence:
+                  - type: str
+              remote:
+                type: seq
+                sequence:
+                  - type: str
+      pull:
+        type: map
+        mapping:
+          before:
+            type: map
+            mapping:
+              local:
+                type: seq
+                sequence:
+                  - type: str
+              remote:
+                type: seq
+                sequence:
+                  - type: str
+          after:
+            type: map
+            mapping:
+              local:
+                type: seq
+                sequence:
+                  - type: str
+              remote:
+                type: seq
+                sequence:
+                  - type: str

data/lib/wordmove/cli.rb

@@ -65,14 +65,19 @@ module Wordmove
     def pull
       ensure_wordpress_options_presence!(options)
       begin
-        deployer = Wordmove::Deployer::Base.deployer_for(options)
+        deployer = Wordmove::Deployer::Base.deployer_for(options.deep_symbolize_keys)
       rescue MovefileNotFound => e
         logger.error(e.message)
         exit 1
       end
+
+      Wordmove::Hook.run(:pull, :before, options)
+
       handle_options(options) do |task|
         deployer.send("pull_#{task}")
       end
+
+      Wordmove::Hook.run(:pull, :after, options)
     end
 
     desc "push", "Pushes WP data from local machine to remote host"
@@ -87,9 +92,14 @@ module Wordmove
         logger.error(e.message)
         exit 1
       end
+
+      Wordmove::Hook.run(:push, :before, options)
+
       handle_options(options) do |task|
         deployer.send("push_#{task}")
       end
+
+      Wordmove::Hook.run(:push, :after, options)
     end
   end
 end

data/lib/wordmove/deployer/base.rb

@@ -7,17 +7,9 @@ module Wordmove
 
       class << self
         def deployer_for(cli_options)
-          options = fetch_movefile(cli_options[:config])
-          available_enviroments = extract_available_envs(options)
-          options.merge!(cli_options).deep_symbolize_keys!
-
-          if available_enviroments.size > 1 && options[:environment].nil?
-            raise(
-              UndefinedEnvironment,
-              "You need to specify an environment with --environment parameter"
-            )
-          end
-          environment = (options[:environment] || available_enviroments.first).to_sym
+          movefile = Wordmove::Movefile.new(cli_options[:config])
+          options = movefile.fetch.merge! cli_options
+          environment = movefile.environment(cli_options)
 
           return FTP.new(environment, options) if options[environment][:ftp]
 
@@ -32,15 +24,6 @@ module Wordmove
           raise NoAdapterFound, "No valid adapter found."
         end
 
-        def extract_available_envs(options)
-          options.keys.map(&:to_sym) - %i[local global]
-        end
-
-        def fetch_movefile(name = nil, start_dir = current_dir)
-          movefile = Wordmove::Movefile.new
-          movefile.fetch name, start_dir
-        end
-
         def current_dir
           '.'
         end

data/lib/wordmove/deployer/ftp.rb

@@ -10,6 +10,8 @@ module Wordmove
       def push_db
         super
 
+        return true if simulate?
+
         local_dump_path = local_wp_content_dir.path("dump.sql")
         remote_dump_path = remote_wp_content_dir.path("dump.sql")
         local_backup_path = local_wp_content_dir.path("remote-backup-#{Time.now.to_i}.sql")
@@ -32,6 +34,9 @@ module Wordmove
 
       def pull_db
         super
+
+        return true if simulate?
+
         local_dump_path = local_wp_content_dir.path("dump.sql")
         local_backup_path = local_wp_content_dir.path("local-backup-#{Time.now.to_i}.sql")
 

data/lib/wordmove/deployer/ssh.rb

@@ -9,6 +9,13 @@ module Wordmove
       def initialize(environment, options)
         super
         ssh_options = remote_options[:ssh]
+
+        if simulate? && ssh_options[:rsync_options]
+          ssh_options[:rsync_options].concat(" --dry-run")
+        elsif simulate?
+          ssh_options[:rsync_options] = "--dry-run"
+        end
+
         @copier = Photocopier::SSH.new(ssh_options).tap { |c| c.logger = logger }
 
         @local_dump_path = local_wp_content_dir.path("dump.sql")
@@ -23,6 +30,8 @@ module Wordmove
       def push_db
         super
 
+        return true if simulate?
+
         backup_remote_db!
         adapt_local_db!
         after_push_cleanup!
@@ -31,15 +40,20 @@ module Wordmove
       def pull_db
         super
 
+        return true if simulate?
+
         backup_local_db!
         adapt_remote_db!
         after_pull_cleanup!
       end
 
+      # In following commands, we do not guard for simulate?
+      # because it is handled through --dry-run rsync option.
+      # @see initialize
       %w[get put get_directory put_directory delete].each do |command|
         define_method "remote_#{command}" do |*args|
           logger.task_step false, "#{command}: #{args.join(' ')}"
-          @copier.send(command, *args) unless simulate?
+          @copier.send(command, *args)
         end
       end
 

data/lib/wordmove/doctor/movefile.rb

@@ -1,14 +1,14 @@
 module Wordmove
   class Doctor
     class Movefile
-      MANDATORY_SECTIONS = %w[global local].freeze
+      MANDATORY_SECTIONS = %i[global local].freeze
       attr_reader :movefile, :contents, :root_keys
 
       def initialize(name = nil, dir = '.')
-        @movefile = Wordmove::Movefile.new
+        @movefile = Wordmove::Movefile.new(name, dir)
 
         begin
-          @contents = movefile.fetch(name, dir)
+          @contents = movefile.fetch
           @root_keys = contents.keys
         rescue Psych::SyntaxError
           movefile.logger.error "Your movefile is not parsable due to a syntax error"\
@@ -37,7 +37,7 @@ module Wordmove
       def validate_section(key)
         validator = validator_for(key)
 
-        errors = validator.validate(contents[key])
+        errors = validator.validate(contents[key].deep_stringify_keys)
 
         if errors&.empty?
           movefile.logger.success "Formal validation passed"
@@ -67,7 +67,7 @@ module Wordmove
       end
 
       def validate_protocol_presence(keys)
-        return true if keys.include?('ssh') || keys.include?('ftp')
+        return true if keys.include?(:ssh) || keys.include?(:ftp)
 
         movefile.logger.error "This remote has not ssh nor ftp protocol defined"
 

data/lib/wordmove/doctor/mysql.rb

@@ -6,7 +6,7 @@ module Wordmove
       def initialize(movefile_name = nil, movefile_dir = '.')
         @logger = Logger.new(STDOUT).tap { |l| l.level = Logger::INFO }
         begin
-          @config = Wordmove::Movefile.new.fetch(movefile_name, movefile_dir)["local"]["database"]
+          @config = Wordmove::Movefile.new(movefile_name, movefile_dir).fetch[:local][:database]
         rescue Psych::SyntaxError
           return
         end

data/lib/wordmove/generators/movefile.yml

@@ -24,19 +24,20 @@ production:
     # mysqldump_options: --max_allowed_packet=1G # Only available if using SSH
 
   exclude:
-    - .git/
-    - .gitignore
-    - .sass-cache/
-    - node_modules/
-    - bin/
-    - tmp/*
-    - Gemfile*
-    - Movefile
-    - movefile
-    - movefile.yml
-    - movefile.yaml
-    - wp-config.php
-    - wp-content/*.sql.gz
+    - '.git/'
+    - '.gitignore'
+    - '.sass-cache/'
+    - 'node_modules/'
+    - 'bin/'
+    - 'tmp/*'
+    - 'Gemfile*'
+    - 'Movefile'
+    - 'movefile'
+    - 'movefile.yml'
+    - 'movefile.yaml'
+    - 'wp-config.php'
+    - 'wp-content/*.sql.gz'
+    - '*.orig'
 
   # paths: # you can customize wordpress internal paths
   #   wp_content: wp-content
@@ -51,7 +52,7 @@ production:
   #   user: user
   #   password: password # password is optional, will use public keys if available.
   #   port: 22 # Port is optional
-  #   rsync_options: --verbose # Additional rsync options, optional
+  #   rsync_options: --verbose --itemize-changes# Additional rsync options, optional
   #   gateway: # Gateway is optional
   #     host: host
   #     user: user
@@ -64,5 +65,29 @@ production:
   #   passive: true
   #   scheme: ftps # default ftp
 
+  # hooks: # Remote hooks won't work with FTP
+  #   push:
+  #     before:
+  #       local:
+  #         - 'echo "Do something locally before push"'
+  #       remote:
+  #         - 'echo "Do something remotely before push"'
+  #     after:
+  #       local:
+  #         - 'echo "Do something locally after push"'
+  #       remote:
+  #         - 'echo "Do something remotely after push"'
+  #   pull:
+  #     before:
+  #       local:
+  #         - 'echo "Do something locally before pull"'
+  #       remote:
+  #         - 'echo "Do something remotely before pull"'
+  #     after:
+  #       local:
+  #         - 'echo "Do something locally after pull"'
+  #       remote:
+  #         - 'echo "Do something remotely after pull"'
+
 # staging: # multiple environments can be specified
 #   [...]

data/lib/wordmove/hook.rb

@@ -0,0 +1,114 @@
+module Wordmove
+  class Hook
+    def self.logger
+      Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
+    end
+
+    def self.run(action, step, cli_options)
+      movefile = Wordmove::Movefile.new(cli_options[:config])
+      options = movefile.fetch(false)
+      environment = movefile.environment(cli_options)
+
+      hooks = Wordmove::Hook::Config.new(
+        options[environment][:hooks],
+        action,
+        step
+      )
+
+      unless hooks.local_hooks.empty?
+        Wordmove::Hook::Local.run(hooks.local_hooks, cli_options[:simulate])
+      end
+
+      return if hooks.remote_hooks.empty?
+
+      if options[environment][:ftp]
+        logger.debug "You have configured remote hooks to run over "\
+                     "an FTP connections, but this is not possible. Skipping."
+
+        return
+      end
+
+      Wordmove::Hook::Remote.run(
+        hooks.remote_hooks, options[environment][:ssh], cli_options[:simulate]
+      )
+    end
+
+    Config = Struct.new(:options, :action, :step) do
+      def empty?
+        (local_hooks + remote_hooks).empty?
+      end
+
+      def local_hooks
+        return [] if empty_step?
+
+        options[action][step][:local] || []
+      end
+
+      def remote_hooks
+        return [] if empty_step?
+
+        options[action][step][:remote] || []
+      end
+
+      private
+
+      def empty_step?
+        return true unless options
+        return true if options[action].nil?
+        return true if options[action][step].nil?
+
+        false
+      end
+    end
+
+    class Local
+      def self.logger
+        parent.logger
+      end
+
+      def self.run(commands, simulate = false)
+        logger.task "Running local hooks"
+
+        commands.each do |command|
+          logger.task_step true, "Exec command: #{command}"
+          return true if simulate
+
+          stdout_return = `#{command} 2>&1`
+          logger.task_step true, "Output: #{stdout_return}"
+
+          if $CHILD_STATUS.exitstatus.zero?
+            logger.success ""
+          else
+            logger.error "Error code: #{$CHILD_STATUS.exitstatus}"
+          end
+        end
+      end
+    end
+
+    class Remote
+      def self.logger
+        parent.logger
+      end
+
+      def self.run(commands, ssh_options, simulate = false)
+        logger.task "Running remote hooks"
+
+        copier = Photocopier::SSH.new(ssh_options).tap { |c| c.logger = logger }
+        commands.each do |command|
+          logger.task_step false, "Exec command: #{command}"
+          return true if simulate
+
+          stdout, stderr, exit_code = copier.exec! command
+
+          if exit_code.zero?
+            logger.task_step false, "Output: #{stdout}"
+            logger.success ""
+          else
+            logger.task_step false, "Output: #{stderr}"
+            logger.error "Error code #{exit_code}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wordmove/movefile.rb

@@ -1,12 +1,14 @@
 module Wordmove
   class Movefile
-    attr_reader :logger
+    attr_reader :logger, :name, :start_dir
 
-    def initialize
+    def initialize(name = nil, start_dir = current_dir)
       @logger = Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
+      @name = name
+      @start_dir = start_dir
     end
 
-    def fetch(name = nil, start_dir = current_dir)
+    def fetch(verbose = true)
       entries = if name.nil?
                   Dir["#{File.join(start_dir, '{M,m}ovefile')}{,.yml,.yaml}"]
                 else
@@ -15,16 +17,36 @@ module Wordmove
 
       if entries.empty?
         raise MovefileNotFound, "Could not find a valid Movefile" if last_dir?(start_dir)
-        return fetch(name, upper_dir(start_dir))
+        @start_dir = upper_dir(start_dir)
+        return fetch
       end
 
       found = entries.first
-      logger.task("Using Movefile: #{found}")
-      YAML.safe_load(ERB.new(File.read(found)).result, [], [], true)
+      logger.task("Using Movefile: #{found}") if verbose == true
+      YAML.safe_load(ERB.new(File.read(found)).result, [], [], true).deep_symbolize_keys!
+    end
+
+    def environment(cli_options = {})
+      options = fetch(false)
+      available_enviroments = extract_available_envs(options)
+      options.merge!(cli_options).deep_symbolize_keys!
+
+      if available_enviroments.size > 1 && options[:environment].nil?
+        raise(
+          UndefinedEnvironment,
+          "You need to specify an environment with --environment parameter"
+        )
+      end
+
+      (options[:environment] || available_enviroments.first).to_sym
     end
 
     private
 
+    def extract_available_envs(options)
+      options.keys.map(&:to_sym) - %i[local global]
+    end
+
     def last_dir?(directory)
       directory == "/" || File.exist?(File.join(directory, 'wp-config.php'))
     end

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "2.3.1".freeze
+  VERSION = "2.4.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Stefano Verna
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-23 00:00:00.000000000 Z
+date: 2017-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -264,6 +264,7 @@ files:
 - lib/wordmove/generators/movefile.rb
 - lib/wordmove/generators/movefile.yml
 - lib/wordmove/generators/movefile_adapter.rb
+- lib/wordmove/hook.rb
 - lib/wordmove/logger.rb
 - lib/wordmove/movefile.rb
 - lib/wordmove/sql_adapter/default.rb