diff --git a/.github_changelog_generator b/.github_changelog_generator
deleted file mode 100644
index ebce930..0000000
--- a/.github_changelog_generator
+++ /dev/null
@@ -1,2 +0,0 @@
-unreleased=true
-future-release=v0.2.0
diff --git a/.hound.yml b/.hound.yml
deleted file mode 100644
index cdf1016..0000000
--- a/.hound.yml
+++ /dev/null
@@ -1,4 +0,0 @@
-fail_on_violations: true
-
-ruby:
- config_file: .rubocop.yml
diff --git a/.rubocop.yml b/.rubocop.yml
deleted file mode 100644
index dbced75..0000000
--- a/.rubocop.yml
+++ /dev/null
@@ -1,15 +0,0 @@
-AllCops:
- TargetRubyVersion: 2.3
-
-Naming/FileName:
- Exclude:
- - 'lib/vagrant-trellis-sequel.rb'
-
-Metrics/LineLength:
- Max: 120
-
-Metrics/MethodLength:
- Max: 12
-
-Style/Documentation:
- Enabled: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index 1d63fa0..0000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# Change Log
-
-## [v0.2.0](https://github.com/TypistTech/vagrant-trellis-sequel/tree/v0.2.0) (2017-09-17)
-[Full Changelog](https://github.com/TypistTech/vagrant-trellis-sequel/compare/v0.1.0...v0.2.0)
-
-**Merged pull requests:**
-
-- Re-raise `StandardError` as `Vagrant::Errors::CLIInvalidUsage` [\#9](https://github.com/TypistTech/vagrant-trellis-sequel/pull/9) ([TangRufus](https://github.com/TangRufus))
-- Refactor [\#8](https://github.com/TypistTech/vagrant-trellis-sequel/pull/8) ([TangRufus](https://github.com/TangRufus))
-- Try harder to determine vault password by looking through more possible paths [\#7](https://github.com/TypistTech/vagrant-trellis-sequel/pull/7) ([TangRufus](https://github.com/TangRufus))
-- Extract class `Spf` [\#6](https://github.com/TypistTech/vagrant-trellis-sequel/pull/6) ([TangRufus](https://github.com/TangRufus))
-- Fix unable to open unencrypted vault file and refactor [\#5](https://github.com/TypistTech/vagrant-trellis-sequel/pull/5) ([TangRufus](https://github.com/TangRufus))
-- Use default Rubocop style [\#4](https://github.com/TypistTech/vagrant-trellis-sequel/pull/4) ([TangRufus](https://github.com/TangRufus))
-- Require ruby version `~\> 2.3` [\#3](https://github.com/TypistTech/vagrant-trellis-sequel/pull/3) ([TangRufus](https://github.com/TangRufus))
-- Support Ansible vault encrypted config file [\#2](https://github.com/TypistTech/vagrant-trellis-sequel/pull/2) ([TangRufus](https://github.com/TangRufus))
-
-## [v0.1.0](https://github.com/TypistTech/vagrant-trellis-sequel/tree/v0.1.0) (2017-09-15)
-**Merged pull requests:**
-
-- first release [\#1](https://github.com/TypistTech/vagrant-trellis-sequel/pull/1) ([TangRufus](https://github.com/TangRufus))
-
-
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
\ No newline at end of file
diff --git a/Gemfile b/Gemfile
index fdaade6..24c9a0d 100644
--- a/Gemfile
+++ b/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
diff --git a/LICENSE.txt b/LICENSE
similarity index 93%
rename from LICENSE.txt
rename to LICENSE
index 730503d..20fb293 100644
--- a/LICENSE.txt
+++ b/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
diff --git a/README.md b/README.md
index fd3b8f1..0894919 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,45 @@
+
+
# Vagrant Trellis Sequel
-[](https://rubygems.org/gems/vagrant-trellis-sequel)
-[](https://rubygems.org/gems/vagrant-trellis-sequel)
-[](https://gemnasium.com/github.com/TypistTech/vagrant-trellis-sequel)
-[](https://github.com/TypistTech/vagrant-trellis-sequel/blob/master/LICENSE)
-[](https://www.typist.tech/donate/vagrant-trellis-sequel/)
-[](https://www.typist.tech/contact/)
-
-Open Trellis databases in Sequel Pro with a single command
-
-
-
-
-
-- [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)
-
-
+
-## Installation
+
-```bash
-$ vagrant plugin install vagrant-trellis-sequel
-```
+[](https://rubygems.org/gems/vagrant-trellis-sequel)
+[](https://rubygems.org/gems/vagrant-trellis-sequel)
+[](https://github.com/TypistTech/vagrant-trellis-sequel/blob/master/LICENSE)
+[](https://twitter.com/tangrufus)
+[](https://www.typist.tech/contact/)
+
+
+
+
+ Open Trellis databases in Sequel Pro with a single command
+
+
+ Built with ♥ by Typist Tech
+
+
+---
+
+**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:
+
+
+
+[](https://github.com/sponsors/TangRufus)
+[](https://typist.tech/go/paypal-donate/)
+[](https://typist.tech/donate/vagrant-trellis-sequel/)
+
+
+
+---
## 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.
+---
+
+
+ Typist Tech is ready to build your next awesome WordPress site. Hire us!
+
+
+---
+
+## 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 [](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 [info@typist.tech](mailto:info@typist.tech)
+### 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:tangrufus@gmail.com)
+### 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 [vagrant-trellis-sequel@typist.tech](mailto:vagrant-trellis-sequel@typist.tech).
+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).
diff --git a/lib/vagrant_plugins/trellis_sequel/identity.rb b/lib/vagrant_plugins/trellis_sequel/identity.rb
index fc14680..e1de0c7 100644
--- a/lib/vagrant_plugins/trellis_sequel/identity.rb
+++ b/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
diff --git a/vagrant-trellis-sequel.gemspec b/vagrant-trellis-sequel.gemspec
index 9e0c045..e462058 100644
--- a/vagrant-trellis-sequel.gemspec
+++ b/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 = ['tangrufus@gmail.com', 'vagrant-trellis-sequel@typist.tech']
-
+ 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