wordmove 5.0.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 827af36f1540f218650df064024c9fcd661d3bd87df075e2ba71f15bc8598fcd
-  data.tar.gz: f744dd778926c98cb5071902b8b410c84f2a8b102f0db4e9890e3cb9b6dc8337
+  metadata.gz: 223beeb2dffe00e753186e62859f3e2512935bed78d0de7a01b4370051333b76
+  data.tar.gz: d146a0409203df99fe3a94c1cdb69cbb907e33cdbab83adf45dc51bf4a9ed373
 SHA512:
-  metadata.gz: a37976a8841050d1e25b158c4fb47c30bbc87f6b7d15bba88d0eecbf40a2b193dd4a4b93b868e44f72689dd1ef074f804429b3f714b7d9b9e9cd753cef467dff
-  data.tar.gz: 244d0333c938b18cb7c8bcb479c7876c9d9d4626d4eb1d0e6c9d2efe69a09e3274232fdd7819de2ce3e9018ac13fbe1d488fd48acbad8a4428a14eeebb414bac
+  metadata.gz: d25af04e6678422ee1bb26d790591d625946af17e04842869468eebdab4634ef32ff795b6a2f3882b9bfc02886511b80674d13bbf90d0d905c5d539b5d7fd543
+  data.tar.gz: 48f68062be511a820a21ead03b0f5e3fdbb5beff7caedd97e1b02d860cf00055629ae28f6d47c13c1d29a600d27895d71ae85517a6add0bd11b2f50c30ef7bf7

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Wordmove command**
+Command used on the CLI: (e.g.: `wordmove pull --all --no-db`)
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**movefile.yml**
+Paste (removing personal data) the interesting part, if any, of your `movefile.yml` formatting it inside a code block with `yml` syntax and double checking the indentation.
+
+**Exception/trace**
+Paste (removing personal data) the entire trace of error/exception you encountered, if any
+
+**Environment (please complete the following information):**
+- OS:
+- Ruby: (`ruby --version`)
+- Wordmove: (`wordmove --version`)
+
+**Doctor**
+* [x] `wordmove doctor` is all green
+
+(If it is not, report the error you got.)

data/.github/ISSUE_TEMPLATE/discussion.md

@@ -0,0 +1,10 @@
+---
+name: Discussion
+about: Open discussions are welcome :)
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - feature
+  - bug
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.travis.yml

@@ -6,8 +6,7 @@ rvm:
 cache: bundler
 
 before_install:
-  - gem update --system
-  - gem install bundler
+  - gem install bundler -v '~> 2.0'
 
 install:
   - bundle install --jobs=3 --retry=3

data/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+Welcome to the contributor guide. If you can't find important information you're welcome
+to edit this page or open a discussion issue to talk with maintainers.
+
+In this guide you'll find informations about:
+* [Bug reporting](#bug-reporting)
+* [Development](#development)
+* [Maintainer tasks](#maintainer-tasks)
+
+### Bug reporting
+
+Wordmove is an hard piece of software to debug and it is used by many users with many
+different environments - Windows also, even if it isn't officially supported by the dev team.
+
+So *please*, help the community adding some crucial informations and posting well
+formatted code. Inspirational details:
+
+* OS
+* Ruby version
+* Wordmove version
+* Are you using system Ruby, rbenv or RVM?
+* Describe at your best the action you required to Wordmove: push/pull, ftp/ssh
+* Paste (safely) your full or partial `movefile.yml`
+* Paste (safely) the entire trace of error/exception you encountered, if any
+* If you paste code or the STDOUT log/trace **format them**. If it sound as a joke I swear I'm serious:
+use GitHub's Markdown syntax to keep things readable if you'd like to discuss your problem with the community.
+* Label the issue if you can
+
+As a general advise: we tend to not support Wordmove's versions older than the latest stable.
+We'd appreciate your help opening an in depth report if you'd find that an older version is working
+better for you.
+
+Thank you all for your support and for the love <3
+
+### Development
+
+#### Get Wordmove
+
+* fork wordmove
+* clone your own repo
+* be sure to check-out the right branch, usually `master`
+
+##### Installing Ruby
+
+To install ruby, please, use [rbenv](https://github.com/rbenv/rbenv) or [RVM](https://rvm.io).
+
+##### Contribute
+
+* run `bundle install` to install gem dependencies
+* `git checkout -b my_feature_or_fix_name`
+* code, commit, push and send a pull request on GitHub
+
+> Version bump is considered to be a maintainer's task, so please leave the version
+alone while working on your branch.
+
+
+##### Test Wordmove
+
+Wordmove has a decent test coverage. We _require_ that pull requests does not break tests launched by the CI.
+In order to launch tests on you dev machine
+
+```fish
+rake
+```
+
+The command will launch the test suite - written with RSpec - and rubocop.
+
+In order to use the gem locally you can install it
+
+```fish
+rake install
+wordmove --version
+```
+
+or run the executable directly
+
+```fish
+bin/wordmove --version
+```
+
+### Maintainer tasks
+
+ToDo:
+
+* [ ] versioning and version dumping
+* [ ] changelog/release
+* [ ] publishing the gem

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2019 weLaika Soc. Coop.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.mdown

@@ -2,16 +2,15 @@
 
 ![logo](https://raw.githubusercontent.com/welaika/wordmove/master/assets/images/wordmove.png)
 
-Wordmove is a gem that lets you automatically mirror local WordPress
+Wordmove is a command line tool that lets you automatically mirror local WordPress
 installations and DB data back and forth from your local development machine to
-the remote server.
+one or more remote servers.
 
-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.
+Wordmove has also a neat [hook](https://github.com/welaika/wordmove/wiki/Hooks) system which enables you to run arbitrary commands
+before and after push/pull actions. Local and remote commands are both supported (remote
+ones only on SSH protocol).
 
-[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.
+[FTP support development has been discontinued](https://github.com/welaika/wordmove/wiki/FTP-support-disclaimer), thus not all features are granted when using this protocol.
 
 [![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/)
@@ -21,7 +20,9 @@ while base functionalities are granted.
 
 ## Installation
 
-That's easy:
+Wordmove is developed in ruby and packaged and distributed as a gem.
+
+To install:
 
     gem install wordmove
 
@@ -29,17 +30,21 @@ And to update:
 
     gem update wordmove
 
+You can read more about ruby gems ecosystem on the official site https://rubygems.org/.
+
 ## Peer dependencies
 
-Wordmove just acts as automation glue between tools you already have and love. These are its peer dependencies which you need to have installed and in your $PATH:
+Wordmove acts as automation glue between tools you already have and love. These are its peer dependencies which **you need to have installed** and executable through your system $PATH:
+
+| Program   | Mandatory?                       |
+| --------- | -------------------------------- |
+| rsync     | Yes for SSH protocol             |
+| mysql     | Yes                              |
+| mysqldump | Yes                              |
+| wp-cli    | Yes by default, but configurable |
+| lftp      | Yes, for FTP protocol            |
 
-| 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 default, but configurable|
-| lftp      | all                          | Yes, for FTP connections        |
+Wordmove also expect that the remote server will have the following commands: `gzip`, `nice`, `mysql`, `rsync`. All of these should be always present by default on any WordPress hosting.
 
 ## Usage
 
@@ -59,11 +64,17 @@ Move inside the WordPress folder and use `wordmove init` to generate a new `move
 
 **See the wiki article: [Usage and flags explained](https://github.com/welaika/wordmove/wiki/Usage-and-flags-explained) for more info.**
 
-### Screencasts
 
-* Push all WordPress, including database and uploads: http://vimeo.com/74648079
-* Pull database and uploads, adapting paths and urls: http://vimeo.com/74646861
-* Push only theme, transfer only modified files: http://vimeo.com/74647529
+
+### Multistage
+
+You can define multiple remote environments in your `movefile.yml`, such as production, staging, etc. Every first level key in the YAML other than the defaults and mandatory `global` and `local` will be interpreted as a remote environment.
+
+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.
+
+We warmly **recommend to read the wiki article**: [Multiple environments explained](https://github.com/welaika/wordmove/wiki/Multiple-environments-explained)
 
 ## movefile.yml
 
@@ -141,24 +152,12 @@ production:
 #          where: remote
 ```
 
-**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.**
+We warmly **recommend to read the wiki articles**
 
-## Multistage
+* [Multiple environments explained](https://github.com/welaika/wordmove/wiki/Multiple-environments-explained)
+* [Movefile configurations explained](https://github.com/welaika/wordmove/wiki/movefile.yml-configurations-explained)
 
-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)
+to understand more about  supported configurations.
 
 ## Environment Variables
 
@@ -171,6 +170,7 @@ Environment variables are written using the **ERB tags** syntax:
 ```
 
 ### Variables set up
+
 Environment variables can be set up using two methods:
 
 #### Using the shell:
@@ -281,38 +281,10 @@ Visit [Wordpress Tools](https://www.wptools.it).
 
 ## Contribute
 
-In order to promote a simpler contribution workflow we have decided to fork and PR the `master` branch.
-We will accordingly tag and release or pre-release versions to the rubygems.org repository.
-Do not consider the `dev` branch for your forks and PR.
-We will never more use version-named branches as in the past, but we'll tag release on `master` and pre-release on `dev`.
-
-### Please, **read the full [contributor guide](https://github.com/welaika/wordmove/wiki/Contributor-Guide)**.
+Please, read the [contributor guide](https://github.com/welaika/wordmove/blob/master/CONTRIBUTING.md).
 
-Feel free to open an issue about contribution if more you need more info
+Feel free to open a discussion issue about contribution if you need more info.
 
 ## Author
 
 made with ❤️ and ☕️ by [weLaika](https://dev.welaika.com)
-
-## License
-
-(The MIT License)
-
-Copyright © 2013-2019 weLaika
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the ‘Software’), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/wordmove/deployer/base.rb

@@ -100,11 +100,9 @@ module Wordmove
 
         return true if simulate?
 
-        # rubocop:todo Security/Open
-        open(local_path, 'w') do |file|
-          file << open(url).read
+        File.open(local_path, 'w') do |file|
+          file << URI.open(url).read
         end
-        # rubocop:enable Security/Open
       end
 
       def simulate?

data/lib/wordmove/movefile.rb

@@ -47,11 +47,20 @@ module Wordmove
       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"
-        )
+      if options[:environment] != 'local'
+        if available_enviroments.size > 1 && options[:environment].nil?
+          raise(
+            UndefinedEnvironment,
+            "You need to specify an environment with --environment parameter"
+          )
+        end
+
+        if options[:environment].present?
+          unless available_enviroments.include?(options[:environment].to_sym)
+            raise UndefinedEnvironment, "No environment found for \"#{options[:environment]}\". "\
+                                        "Available Environments: #{available_enviroments.join(' ')}"
+          end
+        end
       end
 
       (options[:environment] || available_enviroments.first).to_sym

data/lib/wordmove/sql_adapter/wpcli.rb

@@ -15,8 +15,17 @@ module Wordmove
           raise UnmetPeerDependencyError, "WP-CLI is not installed or not in your $PATH"
         end
 
-        "wp search-replace --path=#{local_path} #{from} #{to} --quiet "\
-        "--skip-columns=guid --all-tables --allow-root"
+        opts = [
+          "--path=#{cli_config_path}",
+          from,
+          to,
+          "--quiet",
+          "--skip-columns=guid",
+          "--all-tables",
+          "--allow-root"
+        ]
+
+        "wp search-replace #{opts.join(' ')}"
       end
 
       private
@@ -24,6 +33,22 @@ module Wordmove
       def wp_in_path?
         system('which wp > /dev/null 2>&1')
       end
+
+      def cli_config_path
+        load_from_yml || load_from_cli || local_path
+      end
+
+      def load_from_yml
+        cli_config_path = File.join(local_path, "wp-cli.yml")
+        return unless File.exist?(cli_config_path)
+
+        YAML.load_file(cli_config_path).with_indifferent_access["path"]
+      end
+
+      def load_from_cli
+        cli_config = JSON.parse(`wp cli param-dump --with-values`, symbolize_names: true)
+        cli_config.dig(:path, :current)
+      end
     end
   end
 end

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "5.0.2".freeze
+  VERSION = "5.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Stefano Verna
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,6 +220,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/discussion.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/stale.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -228,7 +232,9 @@ files:
 - ".travis.yml"
 - ".vscode/launch.json"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
+- LICENSE
 - README.mdown
 - Rakefile
 - assets/images/wordmove.png