geordi 3.2.0 → 4.2.0

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,30 +1,30 @@
-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
+`geordi dump staging -l` (with a Capistrano deploy target and the `--load`
+option) sources the dump into the development database after downloading it.
 
-When called with a capistrano deploy target (e.g. `staging`), remotely dumps
-the specified target's database and downloads it to `tmp/`.
+If you are using multiple databases per environment, pass the database name like this:
 
-    geordi dump staging
+    geordi dump -d primary
 
-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
+Loading a dump into one of multiple local databases is not supported yet.
 DESC
 
-option :load, aliases: ['-l'], type: :string, desc: 'Load a dump'
+option :load, aliases: '-l', type: :string, desc: 'Load a dump', banner: '[DUMP_FILE]'
+option :database, aliases: '-d', type: :string, desc: 'Database name, if there are multiple databases', banner: 'NAME'
 
 def dump(target = nil, *_args)
   require 'geordi/dump_loader'
   require 'geordi/remote'
+  database = options[:database] ? "#{options[:database]} " : ''
 
   if target.nil?
     if options.load
@@ -41,12 +41,14 @@ def dump(target = nil, *_args)
 
     else
       Interaction.announce 'Dumping the development database'
-      Util.system! 'dumple development'
-      Interaction.success 'Successfully dumped the development database.'
+      Util.run!("dumple development #{database}")
+      Interaction.success "Successfully dumped the #{database}development database."
     end
 
   else
-    Interaction.announce 'Dumping the database of ' + target
+    database_label = options[:database] ? " (#{database}database)" : ""
+
+    Interaction.announce "Dumping the database of #{target}#{database_label}"
     dump_path = Geordi::Remote.new(target).dump(options)
 
     if options.load
@@ -55,7 +57,7 @@ def dump(target = nil, *_args)
       Interaction.announce "Sourcing dump into the #{loader.config['database']} db"
       loader.load
 
-      Interaction.success "Your #{loader.config['database']} database has now the data of #{target}."
+      Interaction.success "Your #{loader.config['database']} database has now the data of #{target}#{database_label}."
     end
   end
 end

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',
@@ -28,7 +25,7 @@ def firefox(*command)
 
     puts
     Interaction.note_cmd command.join(' ')
-    system *command # Util.system! would reset the Firefox PATH
+    system *command # Util.run! would reset the Firefox PATH
   end
 end
 

data/lib/geordi/commands/migrate.rb

@@ -8,8 +8,8 @@ with `db:migrate`.
 LONGDESC
 
 def migrate
-  invoke_cmd 'bundle_install'
-  invoke_cmd 'yarn_install'
+  invoke_geordi 'bundle_install'
+  invoke_geordi 'yarn_install'
   Interaction.announce 'Migrating'
 
   if File.directory?('db/migrate')
@@ -17,9 +17,9 @@ def migrate
       Interaction.note 'Development and parallel test databases'
       puts
 
-      Util.system! 'bundle exec rake db:migrate parallel:prepare'
+      Util.run!([Util.binstub_or_fallback('rake'), 'db:migrate', 'parallel:prepare'])
     else
-      invoke_cmd 'rake', 'db:migrate'
+      invoke_geordi 'rake', 'db:migrate'
     end
   else
     Interaction.note 'No migrations directory found.'

data/lib/geordi/commands/rake.rb

@@ -10,12 +10,16 @@ Example: `geordi rake db:migrate`
 LONGDESC
 
 def rake(*args)
+  invoke_geordi '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}"]
-      Interaction.note_cmd call.join(' ')
+      command = []
+      command << Util.binstub_or_fallback('rake')
+      command += args
+      command << "RAILS_ENV=#{env}"
 
-      Util.system! *call
+      Util.run!(command, show_cmd: true)
     end
   end
 end

data/lib/geordi/commands/rspec.rb

@@ -2,20 +2,19 @@ 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)
   if File.exist?('spec/spec_helper.rb')
-    invoke_cmd 'bundle_install'
-    invoke_cmd 'yarn_install'
+    invoke_geordi 'bundle_install'
+    invoke_geordi 'yarn_install'
 
     Interaction.announce 'Running specs'
 
     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.run!([Util.binstub_or_fallback('rake'), 'parallel:spec'], fail_message: 'Specs failed.')
 
     else
       # tell which specs will be run
@@ -26,19 +25,16 @@ 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_or_fallback('rspec')]
       end
       command << '-r rspec_spinner -f RspecSpinner::Bar' if Util.file_containing?('Gemfile', /rspec_spinner/)
       command << files.join(' ')
 
       puts
-      Util.system! command.join(' '), fail_message: 'Specs failed.'
+      Util.run!(command.join(' '), fail_message: 'Specs failed.')
     end
   else
     Interaction.note 'RSpec not employed.'

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')
@@ -36,8 +35,8 @@ def security_update(step = 'prepare')
     Interaction.note 'About to checkout production and pull.'
     Interaction.prompt('Continue?', 'y', /y|yes/) || Interaction.fail('Cancelled.')
 
-    Util.system! 'git checkout production', show_cmd: true
-    Util.system! 'git pull', show_cmd: true
+    Util.run!('git checkout production', show_cmd: true)
+    Util.run!('git pull', show_cmd: true)
 
     Interaction.success 'Successfully prepared for security update'
     puts
@@ -48,7 +47,7 @@ def security_update(step = 'prepare')
   when 'f', 'finish'
     # ensure everything is committed
     if Util.testing?
-      puts 'Util.system! git status --porcelain'
+      puts 'Util.run! git status --porcelain'
     else
       `git status --porcelain`.empty? || Interaction.fail('Please commit your changes before finishing the update.')
     end
@@ -60,11 +59,11 @@ def security_update(step = 'prepare')
     Interaction.note 'About to: push production, checkout & pull master, merge production, push master.'
     Interaction.prompt('Continue?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
 
-    Util.system! 'git push', show_cmd: true
-    Util.system! 'git checkout master', show_cmd: true
-    Util.system! 'git pull', show_cmd: true
-    Util.system! 'git merge production', show_cmd: true
-    Util.system! 'git push', show_cmd: true
+    Util.run!('git push', show_cmd: true)
+    Util.run!('git checkout master', show_cmd: true)
+    Util.run!('git pull', show_cmd: true)
+    Util.run!('git merge production', show_cmd: true)
+    Util.run!('git push', show_cmd: true)
 
     Interaction.announce 'Deployment'
     deploy = (Util.gem_major_version('capistrano') == 3) ? 'deploy' : 'deploy:migrations'
@@ -77,7 +76,7 @@ def security_update(step = 'prepare')
       Interaction.prompt('Deploy staging now?', 'y', /y|yes/) || Interaction.fail('Cancelled.')
 
       Interaction.announce 'Deploy staging'
-      Util.system! "bundle exec cap staging #{deploy}", show_cmd: true
+      Util.run! "bundle exec cap staging #{deploy}", show_cmd: true
 
       Interaction.prompt('Is the deployment log okay and the application is still running on staging?', 'y', /y|yes/) || Interaction.fail('Please fix the deployment issues on staging before you continue.')
     else
@@ -97,7 +96,7 @@ def security_update(step = 'prepare')
 
       deploy_targets_without_staging.each do |target|
         Interaction.announce "Deploy #{target}"
-        Util.system! "bundle exec cap #{target} #{deploy}", show_cmd: true
+        Util.run!("bundle exec cap #{target} #{deploy}", show_cmd: true)
       end
 
       Interaction.prompt('Is the application still running on all other stages and the logs are okay?', 'y', /y|yes/) || Interaction.fail('Please fix the application immediately!')

data/lib/geordi/commands/server.rb

@@ -3,11 +3,11 @@ 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'
-  invoke_cmd 'yarn_install'
+  invoke_geordi 'bundle_install'
+  invoke_geordi 'yarn_install'
   require 'geordi/util'
 
   Interaction.announce 'Booting a development server'
@@ -18,7 +18,7 @@ def server(port = nil)
   command = Util.server_command
   command << ' -b 0.0.0.0' if options.public
   command << ' -p ' << port
-  Util.system! command
+  Util.run!(command)
 end
 
 map 'devserver' => 'server'

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',
@@ -28,14 +19,14 @@ def setup
     Interaction.announce 'Running bin/setup'
     Interaction.note "Geordi's own setup routine is skipped"
 
-    Util.system! 'bin/setup'
+    Util.run!('bin/setup')
   else
-    invoke_cmd 'create_databases'
-    invoke_cmd 'migrate'
+    invoke_geordi 'create_databases'
+    invoke_geordi 'migrate'
   end
 
   Interaction.success 'Successfully set up the project.'
 
-  invoke_cmd 'dump', options.dump, load: true if options.dump
-  invoke_cmd 'tests' if options.test
+  invoke_geordi 'dump', options.dump, load: true if options.dump
+  invoke_geordi 'tests' if options.test
 end

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_geordi 'bundle_install'
+
   Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end

data/lib/geordi/commands/tests.rb

@@ -1,13 +1,13 @@
 desc 'tests', 'Run all employed tests'
 def tests
-  rake_result = invoke_cmd 'with_rake'
+  rake_result = invoke_geordi 'with_rake'
 
   # Since `rake` usually is configured to run all tests, only run them if `rake`
   # did not perform
   if rake_result == :did_not_perform
-    invoke_cmd 'unit'
-    invoke_cmd 'rspec'
-    invoke_cmd 'cucumber'
+    invoke_geordi 'unit'
+    invoke_geordi 'rspec'
+    invoke_geordi 'cucumber'
   end
 
   Interaction.success 'Successfully ran tests.'

data/lib/geordi/commands/unit.rb

@@ -1,11 +1,11 @@
 desc 'unit', 'Run Test::Unit'
 def unit
   if File.exist?('test/test_helper.rb')
-    invoke_cmd 'bundle_install'
-    invoke_cmd 'yarn_install'
+    invoke_geordi 'bundle_install'
+    invoke_geordi 'yarn_install'
 
     Interaction.announce 'Running Test::Unit'
-    Util.system! 'bundle exec rake test'
+    Util.run!([Util.binstub_or_fallback('rake'), 'test'])
   else
     Interaction.note 'Test::Unit not employed.'
   end

data/lib/geordi/commands/update.rb

@@ -3,17 +3,6 @@ long_desc <<-LONGDESC
 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.
 LONGDESC
 
 option :dump, type: :string, aliases: '-d', banner: 'TARGET',
@@ -22,12 +11,12 @@ option :test, type: :boolean, aliases: '-t', desc: 'After updating, run tests'
 
 def update
   Interaction.announce 'Updating repository'
-  Util.system! 'git pull', show_cmd: true
+  Util.run!('git pull', show_cmd: true)
 
-  invoke_cmd 'migrate'
+  invoke_geordi 'migrate'
 
   Interaction.success 'Successfully updated the project.'
 
-  invoke_cmd 'dump', options.dump, load: true if options.dump
-  invoke_cmd 'tests' if options.test
+  invoke_geordi 'dump', options.dump, load: true if options.dump
+  invoke_geordi 'tests' if options.test
 end