geordi 3.2.0 → 4.0.0

data/Rakefile

@@ -32,21 +32,31 @@ 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.
   TEXT
 
   Geordi::CLI.all_commands.sort.each do |_, command|
-    unless command.hidden?
-      geordi_section << "### `geordi #{command.usage}`\n\n"
-      geordi_section << "#{command.description.sub /(\.)?$/, '.'}\n\n"
-      geordi_section << "#{command.long_description.strip}\n\n" if command.long_description
+    next if command.hidden?
+
+    geordi_section << "\n### `geordi #{command.usage}`\n"
+    geordi_section << "#{command.description.sub /(\.)?$/, '.'}\n\n"
+    geordi_section << "#{command.long_description.strip}\n\n" if command.long_description
+
+    if command.options.any?
+      geordi_section << "**Options**\n"
+      # Taken from thor-1.0.1/lib/thor/base.rb:557
+      command.options.values.each do |option|
+        next if option.hide
+
+        geordi_section << "- `#{option.usage}`"
+        geordi_section << ": #{option.description}" if option.description
+        geordi_section << "\n"
+      end
       geordi_section << "\n"
     end
   end
 
   updated_readme = readme.sub(geordi_section_regex, geordi_section)
   File.open('README.md', 'w') { |f| f.puts updated_readme.strip }
-  puts 'README.me updated.'
+  puts 'README.md updated.'
 end

data/geordi.gemspec

@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.post_install_message = <<-ATTENTION
 * Binary `geordi` installed
+* Geordi 4.0.0 has removed its deprecated executables. If you want to invoke these commands like before, you may create aliases on your machine. For the alias mapping, please refer to https://github.com/makandra/geordi/commit/68fa92acb146ebde3acb92d7b9556bd4eaa2b4ff
   ATTENTION
 end

data/lib/geordi/COMMAND_TEMPLATE

@@ -12,7 +12,9 @@ Detailed description with anything the user needs to know.
 
 Short and long description are printed on the console AND included in the README
 by `rake update_readme`. Thus, please format descriptions in a way that's reader
-friendly both in Markdown and the console.
+friendly both in Markdown and the console. In particular, note that simple line
+breaks (\n) will be squished. Only paragraphs (\n\n) will work both on the bash
+and in Markdown.
 LONGDESC
 
 option :opt, type: :boolean, aliases: '-o', banner: 'VALUE_NAME', desc: 'If set, VALUE_NAME will be used for something'

data/lib/geordi/commands/chromedriver_update.rb

@@ -1,9 +1,9 @@
 desc 'chromedriver-update', 'Update the chromedriver'
-
 long_desc <<-LONGDESC
 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.
 LONGDESC
 
 def chromedriver_update

data/lib/geordi/commands/commit.rb

@@ -1,13 +1,9 @@
 desc 'commit', 'Commit using a story title from Pivotal Tracker'
-
 long_desc <<-LONGDESC
 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`.
 LONGDESC
@@ -18,6 +14,5 @@ Unsupported Ruby Version #{RUBY_VERSION}. `geordi commit` requires Ruby 2.1+.
   TEXT
 
   require 'geordi/gitpt'
-
   Gitpt.new.run(git_args)
 end

data/lib/geordi/commands/console.rb

@@ -1,23 +1,20 @@
 desc 'console [TARGET]', 'Open a Rails console locally or on a Capistrano deploy target'
 long_desc <<-LONGDESC
-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`:
-
-    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
+Selecting the server: `geordi console staging -s` shows a menu with all available
+servers. When passed a number, directly connects to the selected server.
 LONGDESC
 
-
-option :select_server, type: :string, aliases: '-s'
+# This option is duplicated in shelll.rb
+option :select_server, type: :string, aliases: '-s', banner: '[SERVER_NUMBER]',
+  desc: 'Select a server to connect to'
 
 def console(target = 'development', *_args)
   require 'geordi/remote'
+  invoke_cmd 'bundle_install'
 
   if target == 'development'
     invoke_cmd 'yarn_install'

data/lib/geordi/commands/create_databases.rb

@@ -6,7 +6,8 @@ def create_databases
   Interaction.announce 'Creating databases'
 
   if File.exist?('config/database.yml')
-    command = 'bundle exec rake db:create:all'
+    command = Util.binstub 'rake'
+    command << ' db:create:all'
     command << ' parallel:create' if Util.file_containing?('Gemfile', /parallel_tests/)
 
     Util.system! command

data/lib/geordi/commands/cucumber.rb

@@ -2,26 +2,24 @@ desc 'cucumber [FILES and OPTIONS]', 'Run Cucumber features'
 long_desc <<-LONGDESC
 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:
-
-    use_vnc: false
-
+headless test browser anyway, you can disable VNC by setting `use_vnc: false`
+in `.geordi.yml` in the project root.
 LONGDESC
 
 option :modified, aliases: '-m', type: :boolean,
@@ -29,9 +27,9 @@ option :modified, aliases: '-m', type: :boolean,
 option :containing, aliases: '-c', banner: 'STRING',
   desc: 'Run all features that contain STRING'
 option :verbose, aliases: '-v', type: :boolean,
-  desc: 'Print the testrun command'
+  desc: 'Show the test run command'
 option :debug, aliases: '-d', type: :boolean,
-  desc: 'Run with `-f pretty -b` which helps hunting down bugs'
+  desc: 'Run Cucumber with `-f pretty -b`, which helps hunting down bugs'
 option :rerun, aliases: '-r', type: :numeric, default: 0,
   desc: 'Rerun features up to N times while failing'
 

data/lib/geordi/commands/delete_dumps.rb

@@ -7,7 +7,6 @@ no argument is given, two default directories are searched for dump files: the
 current working directory and `~/dumps` (for dumps created with geordi).
 
 Geordi will ask for confirmation before actually deleting files.
-
 LONGDESC
 
 def delete_dumps(dump_directory = nil)

data/lib/geordi/commands/deploy.rb

@@ -5,18 +5,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.
@@ -94,6 +94,8 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
     git_call << "git merge #{source_branch}" if merge_needed
     git_call << 'git push' if push_needed
 
+    invoke_cmd 'bundle_install'
+
     capistrano_call = "cap #{target_stage} deploy"
     capistrano_call << ':migrations' unless Util.gem_major_version('capistrano') == 3 || options.no_migrations
     capistrano_call = "bundle exec #{capistrano_call}" if Util.file_containing?('Gemfile', /capistrano/)
@@ -103,8 +105,6 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
       Util.system! git_call.join(' && '), show_cmd: true
     end
 
-    invoke_cmd 'bundle_install'
-
     Util.system! capistrano_call, show_cmd: true
 
     Interaction.success 'Deployment complete.'

data/lib/geordi/commands/drop_databases.rb

@@ -7,12 +7,6 @@ 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.
 LONGDESC

data/lib/geordi/commands/dump.rb

@@ -1,26 +1,18 @@
-desc 'dump [TARGET]', 'Handle dumps (see `geordi help dump` for details)'
+desc 'dump [TARGET]', 'Handle (remote) database dumps'
 long_desc <<-DESC
-When called without arguments, dumps the development database with `dumple`.
+`geordi dump` (without arguments) dumps the development database with `dumple`.
 
-    geordi dump
+`geordi dump -l tmp/staging.dump` (with the `--load` option) sources the
+specified dump file into the development database.
 
-When called with the `--load` option, sources the specified dump into the
-development database.
+`geordi dump staging` (with a Capistrano deploy target) remotely dumps the
+specified target's database and downloads it to `tmp/`.
 
-    geordi dump -l tmp/staging.dump
-
-When called with a capistrano deploy target (e.g. `staging`), remotely dumps
-the specified target's database and downloads it to `tmp/`.
-
-    geordi dump staging
-
-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
+`geordi dump staging -l` (with a Capistrano deploy target and the `--load`
+option) sources the dump into the development database after downloading it.
 DESC
 
-option :load, aliases: ['-l'], type: :string, desc: 'Load a dump'
+option :load, aliases: '-l', type: :string, desc: 'Load a dump', banner: '[DUMP_FILE]'
 
 def dump(target = nil, *_args)
   require 'geordi/dump_loader'

data/lib/geordi/commands/firefox.rb

@@ -3,11 +3,8 @@ long_desc <<-LONGDESC
 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>`.
-
-This command is aliased `chrome` for users running Selenium in Chrome.
+`geordi cucumber` command. This command is aliased `chrome` for users running
+Selenium in Chrome.
 LONGDESC
 
 option :setup, banner: 'FIREFOX_VERSION',

data/lib/geordi/commands/migrate.rb

@@ -17,7 +17,7 @@ def migrate
       Interaction.note 'Development and parallel test databases'
       puts
 
-      Util.system! 'bundle exec rake db:migrate parallel:prepare'
+      Util.system! Util.binstub('rake'), 'db:migrate parallel:prepare'
     else
       invoke_cmd 'rake', 'db:migrate'
     end

data/lib/geordi/commands/rake.rb

@@ -10,9 +10,11 @@ Example: `geordi rake db:migrate`
 LONGDESC
 
 def rake(*args)
+  invoke_cmd 'bundle_install'
+
   %w[development test cucumber].each do |env| # update long_desc when changing this
     if File.exist? "config/environments/#{env}.rb"
-      call = %w[bundle exec rake] + args + ["RAILS_ENV=#{env}"]
+      call = [Util.binstub('rake')] + args + ["RAILS_ENV=#{env}"]
       Interaction.note_cmd call.join(' ')
 
       Util.system! *call

data/lib/geordi/commands/rspec.rb

@@ -2,8 +2,7 @@ desc 'rspec [FILES]', 'Run RSpec'
 long_desc <<-LONGDESC
 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`.
 LONGDESC
 
 def rspec(*files)
@@ -15,7 +14,7 @@ def rspec(*files)
 
     if Util.file_containing?('Gemfile', /parallel_tests/) && files.empty?
       Interaction.note 'All specs at once (using parallel_tests)'
-      Util.system! 'bundle exec rake parallel:spec', fail_message: 'Specs failed.'
+      Util.system! Util.binstub('rake'), 'parallel:spec', fail_message: 'Specs failed.'
 
     else
       # tell which specs will be run
@@ -26,13 +25,10 @@ def rspec(*files)
         Interaction.note 'Only: ' + files.join(', ')
       end
 
-      command = ['bundle exec']
-      command << if File.exist?('script/spec')
-        'spec -c' # RSpec 1
-      elsif File.exist?('bin/rspec')
-        'bin/rspec'
+      command = if File.exist?('script/spec')
+        ['bundle exec spec -c'] # RSpec 1
       else
-        'rspec'
+        [Util.binstub('rspec')]
       end
       command << '-r rspec_spinner -f RspecSpinner::Bar' if Util.file_containing?('Gemfile', /rspec_spinner/)
       command << files.join(' ')

data/lib/geordi/commands/security_update.rb

@@ -1,31 +1,30 @@
 desc 'security-update [STEP]', 'Support for performing security updates'
 long_desc <<-LONGDESC
-Preparation for security update: `geordi security-update`
+Preparation for security update: `geordi security-update`. Checks out production
+and pulls.
 
-Checks out production and pulls.
+After performing the update: `geordi security-update finish`. Switches branches,
+pulls, pushes and deploys as required by our workflow.
 
-After performing the update: `geordi security-update finish`
+This command tells what it will do before it does it. In detail:
 
-Switches branches, pulls, pushes and deploys as required by our workflow. Tells
-what it will do before it does it. In detail:
+1. Ask user if tests are green
 
-1. Asks user, if tests are green
+2. Push production
 
-2. Pushes production
+3. Check out master and pull
 
-3. Checks out master and pulls
+4. Merge production and push in master
 
-4. Merges production and pushes in master
+5. Deploy staging, if there is a staging environment
 
-5. Deploys staging first, if there is a staging environment
+6. Ask user if deployment log is okay and staging application is still running
 
-6. Asks user, if deployment log is okay and application is still running on staging
+7. Deploy other stages
 
-7. Deploys other stages
+8. Ask user if deployment log is okay and application is still running on all stages
 
-8. Asks user, if deployment log is okay and application is still running on all other stages
-
-9. Informs user about the next steps
+9. Inform user about the next (manual) steps
 LONGDESC
 
 def security_update(step = 'prepare')

data/lib/geordi/commands/server.rb

@@ -3,7 +3,7 @@ desc 'server [PORT]', 'Start a development server'
 option :port, aliases: '-p', default: '3000',
   desc: 'Choose a port'
 option :public, aliases: '-P', type: :boolean,
-  desc: 'Make the server accessible in the local network'
+  desc: 'Make the server accessible from the local network'
 
 def server(port = nil)
   invoke_cmd 'bundle_install'

data/lib/geordi/commands/setup.rb

@@ -6,17 +6,8 @@ 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:
-
-    geordi setup -d staging
-
-After setting up, runs all tests when called with the `--test` option:
-
-    geordi setup -t
+If a local bin/setup file is found, Geordi skips its routine and runs bin/setup
+instead.
 LONGDESC
 
 option :dump, type: :string, aliases: '-d', banner: 'TARGET',

data/lib/geordi/commands/shell.rb

@@ -2,22 +2,21 @@ desc 'shell TARGET', 'Open a shell on a Capistrano deploy target'
 long_desc <<-LONGDESC
 Example: `geordi shell production`
 
-Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
-
-    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
+Selecting the server: `geordi shell staging -s` shows a menu with all available
+servers. When passed a number, directly connects to the selected server.
 LONGDESC
 
-option :select_server, type: :string, aliases: '-s'
+# This option is duplicated in console.rb
+option :select_server, type: :string, aliases: '-s', banner: '[SERVER_NUMBER]',
+  desc: 'Select a server to connect to'
 
 # This method has a triple 'l' because :shell is a Thor reserved word. However,
 # it can still be called with `geordi shell` :)
 def shelll(target, *_args)
   require 'geordi/remote'
 
+  invoke_cmd 'bundle_install'
+
   Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end