wordmove 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 340a4d6b588c3aa99922d41aa684b0e2bc6b3a5f
-  data.tar.gz: dee8d76ea56e73fca649e5b41848e9cad8241f48
+  metadata.gz: 415b8493170b6b7c1a104594977944feea297510
+  data.tar.gz: 959b2d34d6021d1065674809b07334ea606466fa
 SHA512:
-  metadata.gz: 120795ed6849c97d92cac8a8b9df8d3fc9166384853554bdc9308c369254e43808510ce1ff5ea7ad2fc366925df3894a8b6bb7069f5923204344a542d29ca91f
-  data.tar.gz: da33fddca0c38541cb49ce77b948acfe8511f1c5b1b8e046ca1b013c112f39246836c45b0b2ffd96765d4fb22958853a60c5e5a63af7ed5ff54b9b788a51aea3
+  metadata.gz: 1f9a738b923f299eaa5902ef82d217d40fbb8aa8a8a54840cf32e94da1891706a3bc9b2708f8828b8049f5467ea04b5945773b3d1f2a02489bba13a3921d6b0d
+  data.tar.gz: 9b79a7a4d9bd137f24202de1742e5bb061de33928f74fdbea019114e48e01040c5364e794c75617bd75a91b0874637d5938e588f5b509dd430d810e0fb43619f

data/README.mdown

@@ -163,6 +163,40 @@ 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)
 
+## Secrets
+
+If you intend on committing movefiles to your repos, consider using ERB tags to hide sensitive variables and credentials:
+
+```yaml
+production:
+  database:
+    user: "<%= ENV['PROD_DB_USER'] %>"
+    password: "<%= ENV['PROD_DB_PASS'] %>"
+```
+
+This can either be specified through shell variables or a dotenv file.
+
+### Shell
+You can set variables like so:
+
+```bash
+# bash
+export PROD_DB_USER="username" PROD_DB_PASS="password"
+
+# fish
+set --export --global PROD_DB_USER "username"; set --export --global PROD_DB_PASS "password"
+```
+
+### Dotenv
+Wordmove supports the [dotenv](https://github.com/bkeepers/dotenv) module. Simply create a file named `.env` next to your movefile:
+
+```dosini
+PROD_DB_USER=username
+PROD_DB_PASS=password
+```
+
+You may also use `.env.{environmentname}`, but this is discouraged.
+
 ## Supports
 
 ### OS

data/lib/wordmove.rb

@@ -1,16 +1,17 @@
 require 'English'
 
-require 'thor'
-require 'thor/group'
-require 'colorize'
-require 'logger'
-require 'yaml'
-require 'ostruct'
-require 'erb'
-require 'open-uri'
 require 'active_support'
 require 'active_support/core_ext'
+require 'colorize'
+require 'dotenv'
+require 'erb'
 require 'kwalify'
+require 'logger'
+require 'open-uri'
+require 'ostruct'
+require 'thor'
+require 'thor/group'
+require 'yaml'
 
 require 'photocopier'
 

data/lib/wordmove/deployer/base.rb

@@ -8,6 +8,8 @@ module Wordmove
       class << self
         def deployer_for(cli_options)
           movefile = Wordmove::Movefile.new(cli_options[:config])
+          movefile.load_dotenv(cli_options)
+
           options = movefile.fetch.merge! cli_options
           environment = movefile.environment(cli_options)
 
@@ -54,16 +56,19 @@ module Wordmove
       %w[uploads themes plugins mu_plugins languages].each do |task|
         define_method "push_#{task}" do
           logger.task "Pushing #{task.titleize}"
-          local_path = send("local_#{task}_dir").path
-          remote_path = send("remote_#{task}_dir").path
-          remote_put_directory(local_path, remote_path, paths_to_exclude)
+          local_path = local_options[:wordpress_path]
+          remote_path = remote_options[:wordpress_path]
+
+          remote_put_directory(local_path, remote_path,
+                               push_exclude_paths, push_inlcude_paths(task))
         end
 
         define_method "pull_#{task}" do
           logger.task "Pulling #{task.titleize}"
-          local_path = send("local_#{task}_dir").path
-          remote_path = send("remote_#{task}_dir").path
-          remote_get_directory(remote_path, local_path, paths_to_exclude)
+          local_path = local_options[:wordpress_path]
+          remote_path = remote_options[:wordpress_path]
+          remote_get_directory(remote_path, local_path,
+                               pull_exclude_paths, pull_include_paths(task))
         end
       end
 
@@ -172,7 +177,6 @@ module Wordmove
         command << "--best"
         command << "--force"
         command << "\"#{path}\""
-        puts command.join(" ")
         command.join(" ")
       end
 
@@ -181,7 +185,6 @@ module Wordmove
         command << "-d"
         command << "--force"
         command << "\"#{path}\""
-        puts command.join(" ")
         command.join(" ")
       end
 
@@ -202,6 +205,34 @@ module Wordmove
       def local_options
         options[:local].clone
       end
+
+      def push_inlcude_paths(task)
+        [
+          "/#{local_wp_content_dir.relative_path}/",
+          "/#{local_wp_content_dir.relative_path}/#{task}/"
+        ]
+      end
+
+      def push_exclude_paths
+        paths_to_exclude + [
+          "/*",
+          "/#{local_wp_content_dir.relative_path}/*"
+        ]
+      end
+
+      def pull_include_paths(task)
+        [
+          "/#{remote_wp_content_dir.relative_path}/",
+          "/#{remote_wp_content_dir.relative_path}/#{task}/"
+        ]
+      end
+
+      def pull_exclude_paths
+        paths_to_exclude + [
+          "/*",
+          "/#{remote_wp_content_dir.relative_path}/*"
+        ]
+      end
     end
   end
 end

data/lib/wordmove/generators/movefile.yml

@@ -21,12 +21,14 @@ production:
     password: password
     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
+    # 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'
+    - '.gitmodules'
+    - '.env'
     - 'node_modules/'
     - 'bin/'
     - 'tmp/*'
@@ -52,7 +54,7 @@ production:
   #   user: user
   #   password: password # password is optional, will use public keys if available.
   #   port: 22 # Port is optional
-  #   rsync_options: --verbose --itemize-changes# Additional rsync options, optional
+  #   rsync_options: '--verbose --itemize-changes' # Additional rsync options, optional
   #   gateway: # Gateway is optional
   #     host: host
   #     user: user

data/lib/wordmove/logger.rb

@@ -19,19 +19,23 @@ module Wordmove
     end
 
     def error(message)
-      puts "    ✗ error".red + " | ".black + message.to_s
+      puts "    ❌  error".red + " | ".black + message.to_s
     end
 
     def success(message)
-      puts "    ✓ success".green + " | ".black + message.to_s
+      puts "    ✅  success".green + " | ".black + message.to_s
     end
 
     def debug(message)
-      puts "    ⚠ debug".magenta + " | ".black + message.to_s
+      puts "    🛠  debug".magenta + " | ".black + message.to_s
     end
 
     def warn(message)
-      puts "    ⚠ warning".yellow + " | ".black + message.to_s
+      puts "    ⚠️  warning".yellow + " | ".black + message.to_s
+    end
+
+    def info(message)
+      puts "    ℹ️  info".yellow + " | ".black + message.to_s
     end
 
     private

data/lib/wordmove/movefile.rb

@@ -26,6 +26,18 @@ module Wordmove
       YAML.safe_load(ERB.new(File.read(found)).result, [], [], true).deep_symbolize_keys!
     end
 
+    def load_dotenv(cli_options = {})
+      env = environment(cli_options)
+      env_files = Dir[File.join(start_dir, ".env{.#{env},}")]
+
+      found_env = env_files.first
+
+      return false unless found_env.present?
+
+      logger.info("Using .env file: #{found_env}")
+      Dotenv.load(found_env)
+    end
+
     def environment(cli_options = {})
       options = fetch(false)
       available_enviroments = extract_available_envs(options)

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "3.0.2".freeze
+  VERSION = "3.1.0".freeze
 end

data/wordmove.gemspec

@@ -31,8 +31,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport", '~> 5.1', '>= 5.1.1'
   spec.add_runtime_dependency "colorize", "~> 0.8.1"
+  spec.add_runtime_dependency "dotenv", "~> 2.2.1"
   spec.add_runtime_dependency "kwalify", "~> 0"
-  spec.add_runtime_dependency "photocopier", "~> 1.1", ">= 1.1.3"
+  spec.add_runtime_dependency "photocopier", "~> 1.2", ">= 1.2.0"
   spec.add_runtime_dependency "thor", "~> 0.19.4"
 
   spec.required_ruby_version = ">= 2.4.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Stefano Verna
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,6 +48,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: kwalify
   requirement: !ruby/object:Gem::Requirement
@@ -68,20 +82,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement