Merge branch 'bikeshedding'

Gemfile

@@ -13,7 +13,7 @@ unless ENV.key?('VAGRANT_INSTALLER_EMBEDDED_DIR')
   $stderr.puts "Couldn't find a packaged install of vagrant, and we need this"
   $stderr.puts 'in order to make use of the RubyEncoder libraries.'
   $stderr.puts 'I looked in:'
-  embedded_locations.each do |path|
+  embedded_directories.each do |path|
     $stderr.puts "  #{path}"
   end
 end

LICENSE.txt → LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Tang Rufus
+Copyright (c) 2017-2020 Typist Tech
+Copyright (c) 2017-2020 Tang Rufus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,50 +1,45 @@
+<div align="center">
+
 # Vagrant Trellis Sequel
 
-[![Gem](https://img.shields.io/gem/v/vagrant-trellis-sequel.svg)](https://rubygems.org/gems/vagrant-trellis-sequel)
-[![Gem](https://img.shields.io/gem/dt/vagrant-trellis-sequel.svg)](https://rubygems.org/gems/vagrant-trellis-sequel)
-[![Dependency Status](https://gemnasium.com/badges/github.com/TypistTech/vagrant-trellis-sequel.svg)](https://gemnasium.com/github.com/TypistTech/vagrant-trellis-sequel)
-[![license](https://img.shields.io/github/license/TypistTech/vagrant-trellis-sequel.svg)](https://github.com/TypistTech/vagrant-trellis-sequel/blob/master/LICENSE)
-[![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.typist.tech/donate/vagrant-trellis-sequel/)
-[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-ff69b4.svg)](https://www.typist.tech/contact/)
-
-Open Trellis databases in Sequel Pro with a single command
-
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Noob](#noob)
-  - [Specify which site's database](#specify-which-sites-database)
-  - [Specify vault password file](#specify-vault-password-file)
-  - [Specify vault password](#specify-vault-password)
-- [Common Errors](#common-errors)
-  - [DB password not found for `example_dev`](#db-password-not-found-for-example_dev)
-  - [HMAC encoded in the file does not match calculated one](#hmac-encoded-in-the-file-does-not-match-calculated-one)
-- [Connection Errors](#connection-errors)
-  - [`key_load_public: No such file or directory`](#key_load_public-no-such-file-or-directory)
-- [Support!](#support)
-  - [Donate via PayPal *](#donate-via-paypal-)
-  - [Why don't you hire me?](#why-dont-you-hire-me)
-  - [Want to help in other way? Want to be a sponsor?](#want-to-help-in-other-way-want-to-be-a-sponsor)
-- [Feedback](#feedback)
-- [Change log](#change-log)
-- [Credits](#credits)
-- [Contributing](#contributing)
-- [License](#license)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+</div>
 
-## Installation
+<div align="center">
 
-```bash
-$ vagrant plugin install vagrant-trellis-sequel
-```
+[![Gem](https://img.shields.io/gem/v/vagrant-trellis-sequel.svg?style=flat-square)](https://rubygems.org/gems/vagrant-trellis-sequel)
+[![Gem](https://img.shields.io/gem/dt/vagrant-trellis-sequel.svg?style=flat-square)](https://rubygems.org/gems/vagrant-trellis-sequel)
+[![license](https://img.shields.io/github/license/TypistTech/vagrant-trellis-sequel.svg?style=flat-square)](https://github.com/TypistTech/vagrant-trellis-sequel/blob/master/LICENSE)
+[![Twitter Follow @TangRufus](https://img.shields.io/twitter/follow/TangRufus?style=flat-square&color=1da1f2&logo=twitter)](https://twitter.com/tangrufus)
+[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-ff69b4.svg?style=flat-square)](https://www.typist.tech/contact/)
+
+</div>
+
+<p align="center">
+  <strong>Open Trellis databases in Sequel Pro with a single command</strong>
+  <br />
+  <br />
+  Built with ♥ by <a href="https://www.typist.tech/">Typist Tech</a>
+</p>
+
+---
+
+**Vagrant Trellis Sequel** is an open source project and completely free to use.
+
+However, the amount of effort needed to maintain and develop new features is not sustainable without proper financial backing. If you have the capability, please consider donating using the links below:
+
+<div align="center">
+
+[![GitHub via Sponsor](https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=flat-square&logo=github)](https://github.com/sponsors/TangRufus)
+[![Sponsor via PayPal](https://img.shields.io/badge/Sponsor-PayPal-blue.svg?style=flat-square&logo=paypal)](https://typist.tech/go/paypal-donate/)
+[![More Sponsorship Information](https://img.shields.io/badge/Sponsor-More%20Details-ff69b4?style=flat-square)](https://typist.tech/donate/vagrant-trellis-sequel/)
+
+</div>
+
+---
 
 ## Usage
 
-```bash
+```sh-session
 $ vagrant trellis-sequel open --help
 Usage: vagrant trellis-sequel open [options] [vm-id]
 
@@ -57,7 +52,7 @@ Usage: vagrant trellis-sequel open [options] [vm-id]
 
 ### Noob
 
-```bash
+```sh-session
 $ vagrant trellis-sequel open
 ```
 
@@ -69,7 +64,7 @@ This works for most of the cases:
 
 ### Specify which site's database
 
-```
+```sh-session
 $ vagrant trellis-sequel open --site example.com
 ```
 
@@ -78,7 +73,7 @@ Note: This is the **site key** of `vault_wordpress_sites` in `vault.yml`, usuall
 
 ### Specify vault password file
 
-```
+```sh-session
 $ vagrant trellis-sequel open --vault-password-file .my_vault_password_file
 $ vagrant trellis-sequel open --vault-password-file /my/top/secret.txt
 ```
@@ -88,12 +83,26 @@ Default value is `.vault_pass` if `vault.yml` is encrypted.
 
 ### Specify vault password
 
-```
+```sh-session
 $ vagrant trellis-sequel open --vault-pass my-top-secret
 ```
 
 Use the `--vault-pass` option to provide vault password if you encrypted `vault.yml` but don't have a vault password file.
 
+---
+
+<p align="center">
+  <strong>Typist Tech is ready to build your next awesome WordPress site. <a href="https://typist.tech/contact/">Hire us!</a></strong>
+</p>
+
+---
+
+## Installation
+
+```sh-session
+$ vagrant plugin install vagrant-trellis-sequel
+```
+
 ## Common Errors
 
 ### DB password not found for `example_dev`
@@ -115,20 +124,19 @@ vault_wordpress_sites:
 ```
 
 For the above `vault.yml`, these 3 commands are valid:
-```bash
+```sh-session
 $ vagrant trellis-sequel open # Open one of the DB, most likely the first one
 $ vagrant trellis-sequel open --site example.com
 $ vagrant trellis-sequel open --site www.typist.tech
 ```
 
-
 ### HMAC encoded in the file does not match calculated one
 
 That means vault password is incorrect.
 
 ## Connection Errors
 
-(This part is stolen from from [Sequel Pro for Chassis](https://github.com/Chassis/SequelPro/tree/b3236ca5205e34f6c2e135a9f1b8aa0f1686717b#connection-errors).)
+*This part is stolen from from [Sequel Pro for Chassis](https://github.com/Chassis/SequelPro/tree/b3236ca5205e34f6c2e135a9f1b8aa0f1686717b#connection-errors).*
 
 If you get a connection error, the first thing to attempt to debug is to check the details that Sequel Pro gives you (under the Show Details button).
 
@@ -154,29 +162,49 @@ The simple solution is to add this to your `~/.ssh/config` file:
 
 This disables using system-level keys (both from the agent, and your regular SSH keys), and disables host checks (which are not necessary for localhost). This does not affect `vagrant ssh`, which already uses these options.
 
-## Support!
+## FAQs
+
+### What about remote databases?
+
+If you want to open non-vagrant databases, i.e: production or staging databases on remote sevrers, use [`$ trellis db open`](https://github.com/roots/trellis-cli/pull/72) instead.
+
+### What to do when `getaddrinfo: nodename nor servname provided, or not known`
 
-### Donate via PayPal [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.typist.tech/donate/vagrant-trellis-sequel/)
+Make sure your hosts file (`/etc/hosts`) contains all the domains you're self-signing.
 
-Love Vagrant Trellis Sequel? Help me maintain it, a [donation here](https://www.typist.tech/donate/vagrant-trellis-sequel/) can help with it.
+Usually it can be rectified by `$ vagrant reload --provision` or `$ vagrant hostmanager`.
 
-### Why don't you hire me?
+Ask on [Root Discourse](https://discourse.roots.io/) if the problem persists.
 
-Ready to take freelance WordPress jobs. Contact me via the contact form [here](https://www.typist.tech/contact/) or, via email [[email protected]](mailto:[email protected])
+### It looks awesome. Where can I find some more goodies like this
 
-### Want to help in other way? Want to be a sponsor?
+- Articles on [Typist Tech's blog](https://typist.tech)
+- [Tang Rufus' WordPress plugins](https://profiles.wordpress.org/tangrufus#content-plugins) on wp.org
+- More projects on [Typist Tech's GitHub profile](https://github.com/TypistTech)
+- Stay tuned on [Typist Tech's newsletter](https://typist.tech/go/newsletter)
+- Follow [Tang Rufus' Twitter account](https://twitter.com/TangRufus)
+- **Hire [Tang Rufus](https://typist.tech/contact) to build your next awesome site**
 
-Contact: [Tang Rufus](mailto:[email protected])
+### Where can I give 5-star reviews?
+
+Thanks! Glad you like it. It's important to let me knows somebody is using this project. Please consider:
+
+- [tweet](https://twitter.com/intent/tweet?text=Vagrant%20Trellis%20Sequel%20-%20Open%20Trellis%20databases%20in%20%40sequelpro%20with%20a%20single%20command&url=https://github.com/TypistTech/vagrant-trellis-sequel&hashtags=webdev,wordpress&via=TangRufus&url=https://github.com/TypistTech/vagrant-trellis-sequel&hashtags=webdev,wordpress&via=TangRufus) something good with mentioning [@TangRufus](https://twitter.com/tangrufus)
+- ★ star [the Github repo](https://github.com/TypistTech/vagrant-trellis-sequel)
+- [👀 watch](https://github.com/TypistTech/vagrant-trellis-sequel/subscription) the Github repo
+- write tutorials and blog posts
+- **[hire](https://www.typist.tech/contact/) Typist Tech**
 
 ## Feedback
 
-**Please provide feedback!** We want to make this library useful in as many projects as possible.
-Please submit an [issue](https://github.com/TypistTech/vagrant-trellis-sequel/issues/new) and point out what you do and don't like, or fork the project and make suggestions.
+**Please provide feedback!** We want to make this project as useful as possible.
+Please [submit an issue](https://github.com/TypistTech/vagrant-trellis-sequel/issues/new) and point out what you do and don't like, or fork the project and [send pull requests](https://github.com/TypistTech/vagrant-trellis-sequel/pulls/).
 **No issue is too small.**
 
-## Change log
+## Security Vulnerabilities
 
-Please see [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.
+If you discover a security vulnerability within this project, please email us at [[email protected]](mailto:[email protected]). 
+All security vulnerabilities will be promptly addressed.
 
 ## Credits
 
@@ -188,10 +216,6 @@ Special thanks to [the Roots team](https://roots.io/about/) whose [Trellis](http
 
 Full list of contributors can be found [here](https://github.com/TypistTech/vagrant-trellis-sequel/graphs/contributors).
 
-## Contributing
-
-Please see [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md) for details.
-
 ## License
 
 [Vagrant Trellis Sequel](https://github.com/TypistTech/vagrant-trellis-sequel) is released under the [MIT License](https://opensource.org/licenses/MIT).

lib/vagrant_plugins/trellis_sequel/identity.rb

@@ -8,7 +8,7 @@ def self.name
       end
 
       def self.version
-        '0.2.1'
+        '0.2.2'
       end
 
       def self.description

vagrant-trellis-sequel.gemspec

@@ -9,7 +9,12 @@ Gem::Specification.new do |spec|
   spec.version       = VagrantPlugins::TrellisSequel::Identity.version
   spec.authors       = ['Tang Rufus', 'Typist Tech']
   spec.email         = ['[email protected]', '[email protected]']
-
+  spec.metadata      = {
+    'homepage_uri' => 'https://typist.tech/projects/vagrant-trellis-sequel/',
+    'source_code_uri' => 'https://github.com/TypistTech/vagrant-trellis-sequel',
+    'bug_tracker_uri' => 'https://github.com/TypistTech/vagrant-trellis-sequel/issues',
+    'mailing_list_uri' => 'https://typist.tech/go/newsletter/',
+  }
   spec.summary       = VagrantPlugins::TrellisSequel::Identity.summary
   spec.homepage      = 'https://www.typist.tech/projects/vagrant-trellis-sequel'
   spec.license       = 'MIT'
@@ -25,7 +30,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'ansible-vault', '~> 0.2.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.50'
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.4'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
 end