geordi 3.0.2 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d986326069739e97e8b46b2ce91a663b6093e9a664c178f531db389604e1541d
-  data.tar.gz: 1e859ace1b375e7991f4bae8ef4bb7119b8225dfe4c37a945ec6e745c3a5911b
+  metadata.gz: e713daa0ffee8f9a861ebdc77dcfb4bffe177f2342b05ae7fc442494d4384c18
+  data.tar.gz: 36b09dd4952b71a1f3851b6cbcb9e5f823d575a707b6ebae9bdd4e459d366a68
 SHA512:
-  metadata.gz: 0c6fd3c2e616e309751be4e32fbc34680add641a3b9b87e843a28da0514f0b64d19ada3928f1f14426ddf12ed9dec12c702cf8e1d345346b7e5e763f959e65b9
-  data.tar.gz: a3f45c1931254a0a61fd06dbdaad148cad1fa6627518e1209797a41c6c55816ef0a9cefee6a95444dec2f819960298bac0e4ccfcb132fc3011b4ee43429e8e05
+  metadata.gz: c1f9c002b9035c57ccef219eae0a1f51b64b22ef74ed37ec2a18257b6c230ab3dd1d2f457f93a60df0bf409b5c4ab69b02af9bf2f43ea8c9ba0fe44799616b57
+  data.tar.gz: 6c74ac5333a1a44b3c5ecd8522829e3984b7e1c2fdd2c37d29c99fe5e450a95945a6d8de6c8103ab5b3d58f09ef83f137f2b95bc8c3ea68163cf8c2fba0451f8

data/.gitignore

@@ -3,6 +3,5 @@
 .idea
 pkg/*
 .DS_Store
-.pt_project_id
 tmp
 .byebug_history

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.5

data/CHANGELOG.md

@@ -1,23 +1,63 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-
 ## Unreleased
+### Compatible changes
+### Breaking changes
 
+
+## 4.0.1 2020-08-11
 ### Compatible changes
 
+* Fix `geordi migrate` command, that fails with:
+
+```
+Don't know how to build task 'db:migrate parallel:prepare'
+```
+
+
+## 4.0.0 2020-07-30
+
+### Compatible changes
+- Improved documentation; README now includes command options.
+- Fix #90: `geordi console`, `geordi deploy`, `geordi rake` and `geordi shell` now work correctly if the project hasn't been bundled before
+
 ### Breaking changes
+- Removed deprecated executables
+- Removed `eurest` command
+- Respect binstubs if available, otherwise fallback to geordi's previous behaviour. Note that this might cause failures, when your binstubs are not working. Please have a look at #109 for how a failure might look like and how you can fix it.
 
 
-## 3.0.2 2020-05-18
+## 3.2.0 2020-07-15
 
 ### Compatible changes
+- Improvement #43: `--select-server` option on `geordi shell` and `geordi console` can take the number of the server to connect to it directly and to skip the menu.
+- Add a `.geordi.yml` file to change multiple settings in the project and  `~/.config/geordi/global.yml` for global settings.
+- Deprecated the `.pt_project_id` file in favor of `.geordi.yml`.
+- Deprecated the `~/.gitpt` file in favor of `~/.config/geordi/global.yml`.
+- Add #91: Now there is an option to start cucumber without a VNC session. This is configured by the .geordi.yml file.
+- Fixed `git#staged_changes?` detection on Ruby < 2.5.
 
-- Fix #95: Method change from `! *.include?` to `*.exclude?` was not valid as we do not have active support in Geordi. Affected commands where `geordi cucumber` and `geordi deploy`.
 
-### Breaking changes
+## 3.1.0 2020-06-03
+
+### Compatible changes
+- Update security-update for improved workflow (#89): Deploy staging first and ask user, if application is still running. Then deploy other stages.
+
+
+## 3.0.3 2020-05-27
+
+### Compatible changes
+- Fix #98: Changing the `config/database.yml` reader from `YAML.load` to `YAML.safe_load` dropped the support for aliases. We now allow aliases and the classes `Time` and `Symbol`. If we encounter further issues with this approach a revert to `YAML.load` would be an option, too.
+
+
+## 3.0.2 2020-05-18
+
+### Compatible changes
+- Fix #95: Method change from `! *.include?` to `*.exclude?` was not valid as we do not have active support in Geordi. Affected commands were `geordi cucumber` and `geordi deploy`.
 
 
 ## 3.0.1 2020-05-13
@@ -29,8 +69,6 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## 3.0.0 2020-05-04
 
-### Compatible changes
-
 ### Breaking changes
 - Remove support for Ruby 1.8.7 and Ruby 1.9.3. Bug fixes might still be backported to 2.x, but we will not add any features to 2.x anymore. Please consider to upgrade the Ruby version of your project.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (3.0.2)
+    geordi (4.0.1)
       thor (~> 1)
 
 GEM

data/README.md

@@ -19,77 +19,89 @@ You may abbreviate commands by typing only their first letters, e.g. `geordi
 con` will boot a development console, `geordi set -t` will setup a project and
 run tests afterwards.
 
-For details on commands, e.g. supported options, you may always run
-`geordi help <command>`.
+You can always run `geordi help <command>` to quickly look up command help.
 
 ### `geordi apache-site VIRTUAL_HOST`
-
 Enable the given virtual host, disabling all others.
 
 
 ### `geordi capistrano COMMAND`
-
 Run a capistrano command on all deploy targets.
 
 Example: `geordi capistrano deploy`
 
 
 ### `geordi chromedriver-update`
-
 Update the chromedriver.
 
 Example: `geordi chromedriver_update`
 
-This command will find and install the matching chromedriver for the currently installed Chrome.
+This command will find and install the matching chromedriver for the currently
+installed Chrome.
 
 
 ### `geordi clean`
-
 Remove unneeded files from the current directory.
 
 
 ### `geordi commit`
-
 Commit using a story title from Pivotal Tracker.
 
 Example: `geordi commit`
 
+Any extra arguments are forwarded to `git commit -m <message>`.
+
 On the first execution we ask for your Pivotal Tracker API token. It will be
-stored in `~/.gitpt`.
+stored in `~/.config/geordi/global.yml`.
 
 
 ### `geordi console [TARGET]`
-
 Open a Rails console locally or on a Capistrano deploy target.
 
-Open a local Rails console: `geordi console`
+Local (development): `geordi console`
 
-Open a Rails console on `staging`: `geordi console staging`
+Remote: `geordi console staging`
 
+Selecting the server: `geordi console staging -s` shows a menu with all available
+servers. When passed a number, directly connects to the selected server.
+
+**Options**
+- `-s, [--select-server=[SERVER_NUMBER]]`: Select a server to connect to
 
-### `geordi cucumber [FILES and OPTIONS]`
 
+### `geordi cucumber [FILES and OPTIONS]`
 Run Cucumber features.
 
 Example: `geordi cucumber features/authentication_feature:3`
 
-Runs Cucumber as you want: with `bundle exec`, using parallel tests, with
-a VNC session holding Selenium test browsers, support for using a dedicated
-testing firefox and beta support for rerunning failed scenarios.
+Runs Cucumber with `bundle exec`, using parallel tests, with a VNC session
+holding Selenium test browsers, support for using a dedicated testing browser
+and beta support for re-running failed scenarios.
 
 - *@solo:* Generally, features are run in parallel. However, scenarios tagged
-with @solo are excluded and will be run sequentially, _after_ the parallel run.
+with @solo are excluded from the parallel run and executed sequentially instead.
 
-- *Debugging:* Sometimes, the dot-printing Cucumber formatter does not show
-errors. In case a feature fails without a message, try running it with `--debug`
-or `-d`.
+- *Debugging:* In some cases, the dot-printing Cucumber formatter swallows
+errors. In case a feature fails without an error message, try running it with
+`--debug` or `-d`.
 
 - *Options:* Any unknown option will be passed through to Cucumber,
-e.g. `--format pretty`.
+e.g. `--format=pretty`. Make sure to connect option and value with an equals
+sign, i.e. have each option a contiguous string.
 
+- *VNC:* By default, test browsers will run in a VNC session. When using a
+headless test browser anyway, you can disable VNC by setting `use_vnc: false`
+in `.geordi.yml` in the project root.
 
-### `geordi delete-dumps [DIRECTORY]`
+**Options**
+- `-m, [--modified], [--no-modified]`: Run all modified features
+- `-c, [--containing=STRING]`: Run all features that contain STRING
+- `-v, [--verbose], [--no-verbose]`: Show the test run command
+- `-d, [--debug], [--no-debug]`: Run Cucumber with `-f pretty -b`, which helps hunting down bugs
+- `-r, [--rerun=N]`: Rerun features up to N times while failing
 
+
+### `geordi delete-dumps [DIRECTORY]`
 Delete database dump files (*.dump).
 
 Example: `geordi delete_dumps` or `geordi delete_dumps ~/tmp/dumps`
@@ -102,7 +114,6 @@ Geordi will ask for confirmation before actually deleting files.
 
 
 ### `geordi deploy [STAGE]`
-
 Guided deployment across branches.
 
 Example: `geordi deploy` or `geordi deploy p[roduction]` or `geordi deploy --current-branch`
@@ -110,18 +121,18 @@ Example: `geordi deploy` or `geordi deploy p[roduction]` or `geordi deploy --cur
 Merge, push and deploy with a single command! **It always tells what it will do
 before it does it.** There are different scenarios where this command is handy:
 
-1) *Production deploy:* From the master branch, run `geordi deploy production`.
-   This will merge `master` to `production`, push and deploy to production.
+- *Production deploy:* From the master branch, run `geordi deploy production`.
+  This will merge `master` to `production`, push and deploy to production.
 
-2) *Feature branch deploy:* From a feature branch, run `geordi deploy staging`.
-   This will merge the feature branch to `master`, push and deploy to staging.
+- *Feature branch deploy:* From a feature branch, run `geordi deploy staging`.
+  This will merge the feature branch to `master`, push and deploy to staging.
 
-   To deploy a feature branch directly without merging, run
-   `geordi deploy --current-branch`. This feature depends on the environment
-   variable `DEPLOY_BRANCH` to be picked up in the respective deploy file.
+  To deploy a feature branch directly without merging, run
+  `geordi deploy --current-branch`. This feature depends on the environment
+  variable `DEPLOY_BRANCH` to be picked up in the respective deploy file.
 
-3) *Simple deploy:* If the source branch matches the target branch, merging will
-   be skipped.
+- *Simple deploy:* If the source branch matches the target branch, merging will
+  be skipped.
 
 Calling the command without arguments will infer the target stage from the
 current branch and fall back to master/staging.
@@ -134,9 +145,12 @@ When your project is running Capistrano 3, deployment will use `cap deploy`
 instead of `cap deploy:migrations`. You can force using `deploy` by passing the
 -M option: `geordi deploy -M staging`.
 
+**Options**
+- `-M, [--no-migrations], [--no-no-migrations]`: Run cap deploy instead of cap deploy:migrations
+- `-c, [--current-branch], [--no-current-branch]`: Set DEPLOY_BRANCH to the current branch during deploy
 
-### `geordi drop-databases`
 
+### `geordi drop-databases`
 Interactively delete local databases.
 
 Example: `geordi drop_databases`
@@ -146,61 +160,52 @@ and offer to delete them. Excluded are databases that are whitelisted. This come
 in handy when you're keeping your currently active projects in the whitelist files
 and perform regular housekeeping with Geordi.
 
-When called with `-P` or `-M` options, only handles Postgres resp. MySQL/MariaDB.
-
-When called with `--postgres <port or local socket>` or `--mysql <port or local socket>`,
-will instruct the underlying management commands to use those connection methods
-instead of the defaults. This is useful when running multiple installations.
-
 Geordi will ask for confirmation before actually dropping databases and will
 offer to edit the whitelist instead.
 
+**Options**
+- `-P, [--postgres-only], [--no-postgres-only]`: Only clean Postgres
+- `-M, [--mysql-only], [--no-mysql-only]`: Only clean MySQL/MariaDB
+- `[--postgres=PORT_OR_SOCKET]`: Use Postgres port or socket
+- `[--mysql=PORT_OR_SOCKET]`: Use MySQL/MariaDB port or socket
 
-### `geordi dump [TARGET]`
-
-Handle dumps (see `geordi help dump` for details).
-
-When called without arguments, dumps the development database with `dumple`.
 
-    geordi dump
-
-When called with the `--load` option, sources the specified dump into the
-development database.
+### `geordi dump [TARGET]`
+Handle (remote) database dumps.
 
-    geordi dump -l tmp/staging.dump
+`geordi dump` (without arguments) dumps the development database with `dumple`.
 
-When called with a capistrano deploy target (e.g. `staging`), remotely dumps
-the specified target's database and downloads it to `tmp/`.
+`geordi dump -l tmp/staging.dump` (with the `--load` option) sources the
+specified dump file into the development database.
 
-    geordi dump staging
+`geordi dump staging` (with a Capistrano deploy target) remotely dumps the
+specified target's database and downloads it to `tmp/`.
 
-When called with a capistrano deploy target and the `--load` option, sources the
-dump into the development database after downloading it.
+`geordi dump staging -l` (with a Capistrano deploy target and the `--load`
+option) sources the dump into the development database after downloading it.
 
-    geordi dump staging -l
+**Options**
+- `-l, [--load=[DUMP_FILE]]`: Load a dump
 
 
 ### `geordi firefox COMMAND`
-
 Run a command with VNC and test browser set up (alias: chrome).
 
 Example: `geordi firefox b cucumber` or `geordi firefox --setup 24.0`
 
 Useful when you need Firefox for Selenium or the VNC set up, but can't use the
-`geordi cucumber` command.
-
-*Install* a special Firefox by calling with `--setup <version>`.
+`geordi cucumber` command. This command is aliased `chrome` for users running
+Selenium in Chrome.
 
-This command is aliased `chrome` for users running Selenium in Chrome.
+**Options**
+- `[--setup=FIREFOX_VERSION]`: Install a special test runner Firefox with the given version
 
 
 ### `geordi help [COMMAND]`
-
 Describe available commands or one specific command.
 
 
 ### `geordi migrate`
-
 Migrate all databases.
 
 Example: `geordi migrate`
@@ -211,7 +216,6 @@ with `db:migrate`.
 
 
 ### `geordi png-optimize PATH`
-
 Optimize .png files.
 
 Example: `geordi png-optimize some/directory`
@@ -222,7 +226,6 @@ Example: `geordi png-optimize some/directory`
 
 
 ### `geordi rake TASK`
-
 Run a rake task in several Rails environments.
 
 Example: `geordi rake db:migrate`
@@ -235,39 +238,56 @@ Example: `geordi rake db:migrate`
 
 
 ### `geordi remove-executable-flags`
-
 Remove executable-flags from files that should not be executable.
 
 
 ### `geordi rspec [FILES]`
-
 Run RSpec.
 
 Example: `geordi rspec spec/models/user_spec.rb:13`
 
-Runs RSpec as you want: with RSpec 1/2 detection, `bundle exec`, rspec_spinner
-detection, etc.
+Runs RSpec with RSpec 1/2 support, parallel_tests detection and `bundle exec`.
 
 
 ### `geordi security-update [STEP]`
-
 Support for performing security updates.
 
-Preparation for security update: `geordi security-update`
+Preparation for security update: `geordi security-update`. Checks out production
+and pulls.
 
-After performing the update: `geordi security-update finish`
+After performing the update: `geordi security-update finish`. Switches branches,
+pulls, pushes and deploys as required by our workflow.
 
-Switches branches, pulls, pushes and deploys as required by our workflow. Tells
-what it will do before it does it.
+This command tells what it will do before it does it. In detail:
 
+1. Ask user if tests are green
 
-### `geordi server [PORT]`
+2. Push production
 
+3. Check out master and pull
+
+4. Merge production and push in master
+
+5. Deploy staging, if there is a staging environment
+
+6. Ask user if deployment log is okay and staging application is still running
+
+7. Deploy other stages
+
+8. Ask user if deployment log is okay and application is still running on all stages
+
+9. Inform user about the next (manual) steps
+
+
+### `geordi server [PORT]`
 Start a development server.
 
+**Options**
+- `-p, [--port=PORT]`: Choose a port
+- `-P, [--public], [--no-public]`: Make the server accessible from the local network
 
-### `geordi setup`
 
+### `geordi setup`
 Setup a project for the first time.
 
 Example: `geordi setup`
@@ -276,67 +296,51 @@ Check out a repository and cd into its directory. Then let `setup` do the tiring
 work: run `bundle install`, create `database.yml`, create databases, migrate
 (all if applicable).
 
-If a local bin/setup file is found, Geordi skips these steps runs bin/setup
-for setup instead.
-
-After setting up, loads a remote database dump into the development db when
-called with the `--dump` option:
+If a local bin/setup file is found, Geordi skips its routine and runs bin/setup
+instead.
 
-    geordi setup -d staging
-
-After setting up, runs all tests when called with the `--test` option:
-
-    geordi setup -t
+**Options**
+- `-d, [--dump=TARGET]`: After setup, dump the TARGET db and source it into the development db
+- `-t, [--test], [--no-test]`: After setup, run tests
 
 
 ### `geordi shell TARGET`
-
 Open a shell on a Capistrano deploy target.
 
 Example: `geordi shell production`
 
-Lets you select the server to connect to when called with `--select-server`:
+Selecting the server: `geordi shell staging -s` shows a menu with all available
+servers. When passed a number, directly connects to the selected server.
 
-    geordi shell production -s
+**Options**
+- `-s, [--select-server=[SERVER_NUMBER]]`: Select a server to connect to
 
 
 ### `geordi tests`
-
 Run all employed tests.
 
 
 ### `geordi unit`
-
 Run Test::Unit.
 
 
 ### `geordi update`
-
 Bring a project up to date.
 
 Example: `geordi update`
 
 Performs: `git pull`, `bundle install` (if necessary) and migrates (if applicable).
 
-After updating, loads a dump into the development db when called with the
-`--dump` option:
-
-    geordi update -d staging
-
-After updating, runs all tests when called with the `--test` option:
-
-    geordi update -t
-
-See `geordi help update` for details.
+**Options**
+- `-d, [--dump=TARGET]`: After updating, dump the TARGET db and source it into the development db
+- `-t, [--test], [--no-test]`: After updating, run tests
 
 
 ### `geordi version`
-
 Print the current version of geordi.
 
 
 ### `geordi vnc`
-
 Show the hidden VNC window.
 
 Example: `geordi vnc` or `geordi vnc --setup`
@@ -344,8 +348,8 @@ Example: `geordi vnc` or `geordi vnc --setup`
 Launch a VNC session to the hidden screen where `geordi cucumber` runs Selenium
 tests.
 
-When called with `--setup`, will guide through the setup of VNC.
-
+**Options**
+- `[--setup], [--no-setup]`: Guide through the setup of VNC
 
 b
 ---
@@ -355,7 +359,7 @@ working directory. If no `Gemfile` is present just runs the given command:
 
     b spec spec/models
 
-More information at http://makandracards.com/makandra/684-automatically-run-bundle-exec-if-required
+See http://makandracards.com/makandra/684-automatically-run-bundle-exec-if-required
 
 
 dumple
@@ -365,7 +369,7 @@ Stores a timestamped database dump for the given Rails environment in `~/dumps`:
 
     dumple development
 
-More information at http://makandracards.com/makandra/1008-dump-your-database-with-dumple
+See http://makandracards.com/makandra/1008-dump-your-database-with-dumple
 
 
 launchy_browser
@@ -378,21 +382,37 @@ browser, as opposed to opening it within the VNC window.
 Contributing
 ============
 
-* Run the tests for the oldest supported ruby version with `bundle exec rake`. Ensure that all other ruby versions in the `travis.yml` pass as well after pushing your feature branch and triggering the travis build.
-* Update this `README`. The whole `geordi` section is auto-generated
-  by `rake readme`.
-* Document your changes in the `CHANGELOG.md` file.
+When making changes to Geordi, please make sure your code is tested. Not all,
+but most features of Geordi can be tested. See other tests for inspiration.
+
+Once you have completed your modifications, please update CHANGELOG and README
+as needed. Use `rake readme` to regenerate the Geordi section of the README from
+the command documentations.
+
+Make sure tests are green in the default Ruby *plus* in the oldest Ruby > 1.8
+that you have installed on your system (1.8.7 support has been dropped).
+
+Before releasing your changes, wait for the Travis results to see that tests
+passed in all Ruby versions.
+
 
 Adding a new command
 ---------------
 
 Copy `lib/geordi/COMMAND_TEMPLATE` to `lib/geordi/commands/your_command` and
-edit it to do what you need it to do. Usually, it is hard to automatedly test
-Geordi commands, so make sure you've manually tested it. You can do so by
-calling your local geordi like so (adjust paths to your needs):
+edit it to do what you need it to do. Please add a feature test for the new
+command; see features/ for inspiration.
+
+To try Geordi locally, call it like this:
 
-    # @option -I: add directory to load path
-    ruby -I ../geordi/lib ../geordi/bin/geordi <command>
+    # -I means "add the following directory to load path"
+    ruby -Ilib exe/geordi
     
-    # with debugger
-    ruby -r byebug -I ../geordi/lib ../geordi/bin/geordi <command>
+    # From another directory
+    ruby -I ../geordi/lib ../geordi/exe/geordi
+
+    # With debugger
+    ruby -r byebug -I ../geordi/lib ../geordi/exe/geordi
+
+You can also *install* Geordi locally from its project directory with
+`rake install`. Make sure to switch to the expected Ruby version before.