wordmove 2.5.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 941f5c1b78b58426d20bd0f39cf893c63caae8f4
-  data.tar.gz: f2d69577cda70aa963e0e20267302a82d40b1216
+  metadata.gz: 79bfda3783565476f883fc3aa842dee647deeb92
+  data.tar.gz: 0ff3973a23e4c22d8606dffe12a74e13f5eba15c
 SHA512:
-  metadata.gz: 244f9845aa6fb05baaa14197cbcaf6f71ff72505f39cf9a521a3244931ff363264f3995ef1b9fa01b6761c192eeab58f11e17308a60761080550f6b5d2d6620a
-  data.tar.gz: ad2fe3608d0c173adaaea4e314db2a2d80282d1e13a20f7799f0e09ffff50b580770a7721d7ab9b0f12c54a452dacf78bf79b12e847db8c413aab214b822e5ad
+  metadata.gz: 5a78bc56e6282f7b26a352094e4a9c2b490238b186237f645aa95f8991571ee3ca9020782fe09b0182910b629fcbac012d2880a13b353a4b1b3dab8c192f53d6
+  data.tar.gz: 76ebde3511b4116ebde5f560a849e752294a67496c6b42829ce0bff8cd750ca359f3e71271869e0fcad608485e17ce9908318a36b2316fc58c5259e95e8415c5

data/README.mdown

@@ -32,13 +32,14 @@ And to update:
 
 Wordmove just acts as automation glue bewtween tools you already have and love. These are its peer dependencies which you need to have installed and in your $PATH:
 
-| Program | Actions                      | Mandatory?                      |
-| ------- | ---------------------------- | ------------------------------- |
-| rsync   | Push and pull files and dirs | Yes for SSH connections         |
-| mysql   | Import and dump database     | Yes                             |
-| wp-cli  | DB adapt                     | Nope (but soon will be)         |
-| lftp    | all                          | Yes, for FTP connections        |
-| ssh     | all                          | Yes, for SSH connections        |
+| Program   | Actions                      | Mandatory?                      |
+| -------   | ---------------------------- | ------------------------------- |
+| rsync     | Mirror files and dirs        | Yes for SSH connections         |
+| mysql     | Import database              | Yes                             |
+| mysqldump | Dump database                | Yes                             |
+| wp-cli    | Adapt database               | Yes by defalut, but configurable|
+| lftp      | all                          | Yes, for FTP connections        |
+| ssh       | all                          | Yes, for SSH connections        |
 
 ## Usage
 
@@ -69,7 +70,7 @@ You can configure Wordmove creating a `movefile.yml`. That's a YAML file with lo
 
 ```yaml
 global:
-  sql_adapter: default
+  sql_adapter: wpcli
 
 local:
   vhost: http://vhost.local
@@ -99,20 +100,22 @@ production:
     host: host
     # port: 3308 # Use just in case you have exotic server config
     # mysqldump_options: --max_allowed_packet=50MB # Only available if using SSH
+    # mysql_options: --protocol=TCP # Only available if using SSH
 
   exclude:
-    - .git/
-    - .gitignore
-    - .sass-cache/
-    - bin/
-    - tmp/*
-    - Gemfile*
-    - Movefile
-    - movefile
-    - movefile.yml
-    - movefile.yaml
-    - wp-config.php
-    - wp-content/*.sql
+    - '.git/'
+    - '.gitignore'
+    - 'node_modules/'
+    - 'bin/'
+    - 'tmp/*'
+    - 'Gemfile*'
+    - 'Movefile'
+    - 'movefile'
+    - 'movefile.yml'
+    - 'movefile.yaml'
+    - 'wp-config.php'
+    - 'wp-content/*.sql.gz'
+    - '*.orig'
 
   ssh:
     host: host
@@ -171,8 +174,8 @@ See the [Windows (un)support disclaimer](https://github.com/welaika/wordmove/wik
 ### SSH
 
 * You need `rsync` on your machine; as far as we know it's already installed on OS X and Linux.
-* if you want to use your SSH public key for authentication,just delete the `production.ssh.password` field in your `movefile.yml`. Easy peasy.
-* writing the password inside the move file was and is somewhat supported, but **we discourage this practice** in favor of password-less authentication with pub key. Read [here](https://github.com/welaika/wordmove/wiki/%5Bdeprecated%5D-SSH-password-inside-Movefile) for old informations.
+* To use your SSH public key for authentication, just delete the `production.ssh.password` field in your `movefile.yml`. Easy peasy.
+* writing the password inside `movefile.yml` was and is somewhat supported, but **we discourage this practice** in favor of password-less authentication with pub key. Read [here](https://github.com/welaika/wordmove/wiki/%5Bdeprecated%5D-SSH-password-inside-Movefile) for old informations.
 
 ### FTP
 
@@ -181,7 +184,7 @@ See the [Windows (un)support disclaimer](https://github.com/welaika/wordmove/wik
 * Use the absolute FTP path as `production.wordpress_absolute_path` (you may need to recover this from the `__FILE__` [magic constant](http://php.net/manual/en/language.constants.predefined.php)
 * if you want to specify a passive FTP connection add to the YAML config a `production.ftp.passive` flag and set it to `true`.
 
-FTP support is [planned to be discontinued](https://github.com/welaika/wordmove/wiki/FTP-support-disclaimer) at some point of future development.
+FTP support development is [discontinued](https://github.com/welaika/wordmove/wiki/FTP-support-disclaimer), but it's always there.
 
 ## Notes
 

data/lib/wordmove.rb

@@ -14,21 +14,22 @@ require 'kwalify'
 
 require 'photocopier'
 
-require 'wordmove/exceptions'
 require 'wordmove/cli'
 require 'wordmove/doctor'
 require 'wordmove/doctor/movefile'
 require 'wordmove/doctor/mysql'
-require 'wordmove/doctor/wpcli'
 require 'wordmove/doctor/rsync'
 require 'wordmove/doctor/ssh'
+require 'wordmove/doctor/wpcli'
+require 'wordmove/exceptions'
+require 'wordmove/guardian'
 require 'wordmove/hook'
 require 'wordmove/logger'
 require 'wordmove/movefile'
 require 'wordmove/sql_adapter/default'
 require 'wordmove/sql_adapter/wpcli'
-require "wordmove/version"
 require 'wordmove/wordpress_directory'
+require "wordmove/version"
 
 require 'wordmove/generators/movefile_adapter'
 require 'wordmove/generators/movefile'

data/lib/wordmove/assets/wordmove_schema_remote.yml

@@ -129,3 +129,36 @@ mapping:
                 type: seq
                 sequence:
                   - type: str
+  forbid:
+    type: map
+    mapping:
+      pull:
+        type: map
+        mapping:
+          db:
+            type: bool
+          plugins:
+            type: bool
+          themes:
+            type: bool
+          languages:
+            type: bool
+          uploads:
+            type: bool
+          mu-plugins:
+            type: bool
+      push:
+        type: map
+        mapping:
+          db:
+            type: bool
+          plugins:
+            type: bool
+          themes:
+            type: bool
+          languages:
+            type: bool
+          uploads:
+            type: bool
+          mu-plugins:
+            type: bool

data/lib/wordmove/cli.rb

@@ -73,8 +73,10 @@ module Wordmove
 
       Wordmove::Hook.run(:pull, :before, options)
 
+      guardian = Wordmove::Guardian.new(options: options, action: :pull)
+
       handle_options(options) do |task|
-        deployer.send("pull_#{task}")
+        deployer.send("pull_#{task}") if guardian.allows(task.to_sym)
       end
 
       Wordmove::Hook.run(:pull, :after, options)
@@ -95,8 +97,10 @@ module Wordmove
 
       Wordmove::Hook.run(:push, :before, options)
 
+      guardian = Wordmove::Guardian.new(options: options, action: :push)
+
       handle_options(options) do |task|
-        deployer.send("push_#{task}")
+        deployer.send("push_#{task}") if guardian.allows(task.to_sym)
       end
 
       Wordmove::Hook.run(:push, :after, options)

data/lib/wordmove/deployer/base.rb

@@ -145,9 +145,6 @@ module Wordmove
         if options[:password].present?
           command << "--password=#{Shellwords.escape(options[:password])}"
         end
-        if options[:charset].present?
-          command << "--default-character-set=#{Shellwords.escape(options[:charset])}"
-        end
         command << "--result-file=\"#{save_to_path}\""
         if options[:mysqldump_options].present?
           command << Shellwords.split(options[:mysqldump_options])
@@ -164,10 +161,8 @@ module Wordmove
         if options[:password].present?
           command << "--password=#{Shellwords.escape(options[:password])}"
         end
-        if options[:charset].present?
-          command << "--default-character-set=#{Shellwords.escape(options[:charset])}"
-        end
         command << "--database=#{Shellwords.escape(options[:name])}"
+        command << Shellwords.split(options[:mysql_options]) if options[:mysql_options].present?
         command << "--execute=\"SET autocommit=0;SOURCE #{dump_path};COMMIT\""
         command.join(" ")
       end

data/lib/wordmove/deployer/ssh.rb

@@ -52,6 +52,8 @@ module Wordmove
       # @see initialize
       %w[get put get_directory put_directory delete].each do |command|
         define_method "remote_#{command}" do |*args|
+          super
+
           logger.task_step false, "#{command}: #{args.join(' ')}"
           @copier.send(command, *args)
         end

data/lib/wordmove/generators/movefile.yml

@@ -1,5 +1,5 @@
 global:
-  sql_adapter: default
+  sql_adapter: wpcli
 
 local:
   vhost: http://vhost.local
@@ -22,11 +22,11 @@ production:
     host: host
     # port: 3308 # Use just in case you have exotic server config
     # mysqldump_options: --max_allowed_packet=1G # Only available if using SSH
+    # mysql_options: --protocol=TCP # mysql command is used to import db
 
   exclude:
     - '.git/'
     - '.gitignore'
-    - '.sass-cache/'
     - 'node_modules/'
     - 'bin/'
     - 'tmp/*'
@@ -88,6 +88,21 @@ production:
   #         - 'echo "Do something locally after pull"'
   #       remote:
   #         - 'echo "Do something remotely after pull"'
+  # forbid:
+  #   push:
+  #     db: false
+  #     plugins: false
+  #     themes: false
+  #     languages: false
+  #     uploads: false
+  #     mu-plugins: false
+  #   pull:
+  #     db: false
+  #     plugins: false
+  #     themes: false
+  #     languages: false
+  #     uploads: false
+  #     mu-plugins: false
 
 # staging: # multiple environments can be specified
 #   [...]

data/lib/wordmove/guardian.rb

@@ -0,0 +1,35 @@
+module Wordmove
+  class Guardian
+    attr_reader :movefile, :environment, :action, :logger
+
+    def initialize(options: nil, action: nil)
+      @movefile = Wordmove::Movefile.new(options[:config])
+      @environment = @movefile.environment(options).to_sym
+      @action = action
+      @logger = Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
+    end
+
+    def allows(task)
+      if forbidden?(task)
+        logger.warn("You tried to #{action} #{task}, but is forbidden by configuration. Skipping")
+      end
+
+      !forbidden?(task)
+    end
+
+    private
+
+    def forbidden?(task)
+      return false unless forbidden_tasks[task].present?
+      forbidden_tasks[task] == true
+    end
+
+    def forbidden_tasks
+      environment_options = movefile.fetch(false)[environment]
+      return {} unless environment_options.key?(:forbid)
+      return {} unless environment_options[:forbid].key?(action)
+
+      environment_options[:forbid][action]
+    end
+  end
+end

data/lib/wordmove/hook.rb

@@ -29,7 +29,7 @@ module Wordmove
       end
 
       Wordmove::Hook::Remote.run(
-        hooks.remote_hooks, options[environment][:ssh], cli_options[:simulate]
+        hooks.remote_hooks, options[environment], cli_options[:simulate]
       )
     end
 
@@ -90,15 +90,19 @@ module Wordmove
         parent.logger
       end
 
-      def self.run(commands, ssh_options, simulate = false)
+      def self.run(commands, options, simulate = false)
         logger.task "Running remote hooks"
 
+        ssh_options = options[:ssh]
+        wordpress_path = options[:wordpress_path]
+
         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
+          stdout, stderr, exit_code =
+            copier.exec!("bash -l -c 'cd #{wordpress_path} && #{command}'")
 
           if exit_code.zero?
             logger.task_step false, "Output: #{stdout}"

data/lib/wordmove/logger.rb

@@ -30,6 +30,10 @@ module Wordmove
       puts "    ⚠ debug".magenta + " | ".black + message.to_s
     end
 
+    def warn(message)
+      puts "    ⚠ warning".yellow + " | ".black + message.to_s
+    end
+
     private
 
     def padding_length(line)

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "2.5.1".freeze
+  VERSION = "3.0.0".freeze
 end

data/wordmove.gemspec

@@ -46,11 +46,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.9"
 
   spec.post_install_message = <<-RAINBOW
-    Starting from 2.1.0 you'll need to add the global section in your movefile.yml:
-        global:
-            sql_adapter: "default"
-    Or you can spawn a new one with `wordmove init` (backup the old one!)
+    Starting from version 3.0.0 `database.charset` option is no longer accepted.
+    Pass the '--default-charecter-set' flag into `database.mysqldump_options` or to
+    `database.mysql_options` instead, if you need to set the same option.
 
-    Starting from 2.2.0 the default name of the config file is `movefile.yml`.
+    Starting from version 3.0.0 the default `global.sql_adapter` is "wpcli".
+    Therefor `WP-CLI` becomes a required peer dependency, unless you'll
+    change to the "default" adapter.
   RAINBOW
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Stefano Verna
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-24 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -265,6 +265,7 @@ files:
 - 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
 - lib/wordmove/movefile.rb
@@ -281,12 +282,13 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: |2
-      Starting from 2.1.0 you'll need to add the global section in your movefile.yml:
-          global:
-              sql_adapter: "default"
-      Or you can spawn a new one with `wordmove init` (backup the old one!)
+      Starting from version 3.0.0 `database.charset` option is no longer accepted.
+      Pass the '--default-charecter-set' flag into `database.mysqldump_options` or to
+      `database.mysql_options` instead, if you need to set the same option.
 
-      Starting from 2.2.0 the default name of the config file is `movefile.yml`.
+      Starting from version 3.0.0 the default `global.sql_adapter` is "wpcli".
+      Therefor `WP-CLI` becomes a required peer dependency, unless you'll
+      change to the "default" adapter.
 rdoc_options: []
 require_paths:
 - lib