geordi 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e775f88b224275cf01077937ba959b27666c1ae7ac18b58548a62bfa31161a12
-  data.tar.gz: 4e0efdb89bbf65b69a9753e8e05978b094915b613b1ded6ef1c1ea4716be0ea7
+  metadata.gz: a5ef220369795b8dc7615505cffc05a91776cf91a46580916ab30abd7902262a
+  data.tar.gz: e030a912bd16d9e805081cf4ce3669260223a0198ea1f1d0dfaf8e7c10b75b7f
 SHA512:
-  metadata.gz: 56146e32a18966efbe63a58074d158b888410cf19520150d175f3220be709820b7b05ed6f95df5f80993ed163ba9b59232f1d1f67c3bd43d2055e9b2d66cd812
-  data.tar.gz: e8e41bb61713a5f32dd4039cadee5b11a9f08bac20cad738e61975ea741bfd76cdf5e2d64a166579e701eda472f95f4f8ce15da27181fa0a8b11b748f5d222d3
+  metadata.gz: 49df1e803163f9d602f663d29da0f0036214a5ccb571727cbd02b9951094e4aa72fa7bf2654ceae3b7af47ace8286e6c26b94933277377a1ef5b5f21d7fe6ff5
+  data.tar.gz: 6cf4fafbb0e8f8c311279d61f3ea090ee9bb44589bb9f8566ab0796b26514862d52e89f93e9f5686aa63c8350951fb147c7a967ed2270ff29bb77cb07277da2d

data/.ruby-version

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

data/CHANGELOG.md

@@ -4,11 +4,20 @@ 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.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
 
 
 ## 3.2.0 2020-07-15

data/Gemfile.lock

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

data/README.md

@@ -19,96 +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>`.
 
-If there are no staged changes, prints a warning but will continue to create
-an empty commit.
-
 On the first execution we ask for your Pivotal Tracker API token. It will be
 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`
 
-Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
+Selecting the server: `geordi console staging -s` shows a menu with all available
+servers. When passed a number, directly connects to the selected server.
 
-    geordi console staging -s
-
-If you already know the number of the server you want to connect to, just pass it along:
-
-    geordi console staging -s2
+**Options**
+- `-s, [--select-server=[SERVER_NUMBER]]`: Select a server to connect to
 
 
 ### `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 putting the following
-config into `.geordi.yml` in the project root:
+headless test browser anyway, you can disable VNC by setting `use_vnc: false`
+in `.geordi.yml` in the project root.
 
-    use_vnc: false
+**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`
@@ -121,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`
@@ -129,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.
@@ -153,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`
@@ -165,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`
@@ -230,7 +216,6 @@ with `db:migrate`.
 
 
 ### `geordi png-optimize PATH`
-
 Optimize .png files.
 
 Example: `geordi png-optimize some/directory`
@@ -241,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`
@@ -254,59 +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`
-
-Checks out production and pulls.
+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. In detail:
+This command tells what it will do before it does it. In detail:
 
-1. Asks user, if tests are green
+1. Ask user if tests are green
 
-2. Pushes production
+2. Push production
 
-3. Checks out master and pulls
+3. Check out master and pull
 
-4. Merges production and pushes in master
+4. Merge production and push in master
 
-5. Deploys staging first, if there is a staging environment
+5. Deploy staging, if there is a staging environment
 
-6. Asks user, if deployment log is okay and application is still running on staging
+6. Ask user if deployment log is okay and staging application is still running
 
-7. Deploys other stages
+7. Deploy other stages
 
-8. Asks user, if deployment log is okay and application is still running on all other stages
+8. Ask user if deployment log is okay and application is still running on all stages
 
-9. Informs user about the next steps
+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`
@@ -315,71 +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.
+If a local bin/setup file is found, Geordi skips its routine and runs bin/setup
+instead.
 
-After setting up, loads a remote database dump into the development db when
-called with the `--dump` option:
-
-    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 from a menu when called with `--select-server` or the alias `-s`:
+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
-
-If you already know the number of the server you want to connect to, just pass it along:
-
-    geordi shell production -s2
+**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`
@@ -387,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
 ---
@@ -398,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
@@ -408,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
@@ -422,20 +383,28 @@ 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`.
+* Update this `README`. The whole `geordi` section is auto-generated from command
+  descriptions when running `rake readme`.
 * Document your changes in the `CHANGELOG.md` file.
 
+
 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.
 
-    # @option -I: add directory to load path
-    ruby -I ../geordi/lib ../geordi/bin/geordi <command>
+To try Geordi locally, call it like this:
+
+    # -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.