geordi 3.2.0 → 4.2.0

data/Rakefile

@@ -5,7 +5,7 @@ desc 'Default: Run all tests'
 task default: :features
 
 task :features do
-  system 'bundle exec cucumber'
+  exec 'bundle exec cucumber'
 end
 
 task :readme do
@@ -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/exe/dumple

@@ -3,6 +3,7 @@
 require 'erb'
 
 fail_gently = ARGV.include?("--fail-gently")
+compress = ARGV.include?("--compress")
 
 if ARGV.include?("-i")
   puts "*******************************************************"
@@ -44,9 +45,13 @@ begin
   end
 
   config = YAML::load(ERB.new(File.read(config_path)).result)
+  environment, database = ARGV.reject{ |arg| arg[0].chr == '-' }
+  environment ||= 'production'
+  config = config[environment] or raise "No #{environment} database found.\nUsage: dumple ENVIRONMENT [DATABASE]"
 
-  environment = ARGV.reject{ |arg| arg[0].chr == '-' }.first || 'production'
-  config = config[environment] or raise "No #{environment} database found.\nUsage: dumple ENVIRONMENT"
+  if database
+    config = config[database] or raise %(Unknown #{environment} database "#{database}")
+  end
 
   dump_dir = "#{ENV['HOME']}/dumps"
   unless File.directory?(dump_dir)
@@ -60,7 +65,8 @@ begin
     dump_path = "#{dump_dir}/#{config['database']}_#{Time.now.strftime("%Y%m%d_%H%M%S")}.dump"
   end
 
-  puts "> Dumping database for \"#{environment}\" environment ..."
+  given_database = database ? %(#{database} ) : ""
+  puts "> Dumping #{given_database}database for \"#{environment}\" environment ..."
 
   host = config['host']
   port = config['port']
@@ -89,13 +95,22 @@ begin
     command << " --port=#{port}" if port
     command
   else
-    raise "Adapter \"#{config['adapter']} is not supported"
+    raise "Adapter \"#{config['adapter']}\" is not supported"
   end
   success = system(dump_command)
   success or raise "Creating the dump failed"
 
   system "chmod 600 #{dump_path}"
 
+  if compress
+    puts "> Compressing the dump ..."
+
+    # gzip compresses in place
+    compress_success = system("gzip #{dump_path}")
+    compress_success or raise "Compressing the dump failed"
+    dump_path << ".gz"
+  end
+
   dump_size_kb = (File.size(dump_path) / 1024).round
 
   puts "> Dumped to #{dump_path} (#{dump_size_kb} KB)"

data/geordi.gemspec

@@ -11,13 +11,13 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Collection of command line tools we use in our daily work with Ruby, Rails and Linux at makandra.'
   spec.description = 'Collection of command line tools we use in our daily work with Ruby, Rails and Linux at makandra.'
-  spec.homepage = 'http://makandra.com'
+  spec.homepage = 'https://makandra.com'
   spec.license = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
   end
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.post_install_message = <<-ATTENTION
 * Binary `geordi` installed
+* Geordi 4 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,14 +12,16 @@ 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'
 
 def example
   # Invoke other commands like this:
-  invoke_cmd 'other_command', 'argument', an: 'option'
+  invoke_geordi 'other_command', 'argument', an: 'option'
 
   Interaction.fail 'Option missing' unless options.opt?
 

data/lib/geordi/chromedriver_updater.rb

@@ -5,12 +5,12 @@ require 'tempfile'
 module Geordi
   class ChromedriverUpdater
 
-    def run
+    def run(options)
       chrome_version = determine_chrome_version
       chromedriver_version = determine_chromedriver_version
 
       if skip_update?(chrome_version, chromedriver_version)
-        Interaction.warn("No update required, you are using for both executables the same version #{chrome_version}!")
+        Interaction.note("No update required, you are using for both executables the same version #{chrome_version}!") unless options[:quiet_if_matching]
       else
         chromedriver_zip = download_chromedriver(chrome_version)
         unzip(chromedriver_zip, File.expand_path('~/bin'))

data/lib/geordi/cli.rb

@@ -18,7 +18,7 @@ module Geordi
     private
 
     # fix weird implementation of #invoke
-    def invoke_cmd(name, *args)
+    def invoke_geordi(name, *args)
       options = args.last.is_a?(Hash) ? args.pop : {}
       invoke(name, args, options)
     end

data/lib/geordi/commands/bundle_install.rb

@@ -2,6 +2,6 @@ desc 'bundle-install', 'Run bundle install if required', hide: true
 def bundle_install
   if File.exist?('Gemfile') && !system('bundle check > /dev/null 2>&1')
     Interaction.announce 'Bundling'
-    Util.system! 'bundle install'
+    Util.run!('bundle install')
   end
 end

data/lib/geordi/commands/capistrano.rb

@@ -17,6 +17,6 @@ def capistrano(*args)
     command = "bundle exec cap #{stage} " + args.join(' ')
     Interaction.note_cmd command
 
-    Util.system!(command, fail_message: 'Capistrano failed. Have a look!')
+    Util.run!(command, fail_message: 'Capistrano failed. Have a look!')
   end
 end

data/lib/geordi/commands/chromedriver_update.rb

@@ -1,13 +1,20 @@
 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.
+
+Setting `auto_update_chromedriver` to `true` in your global Geordi config file 
+(`~/.config/geordi/global.yml`), will automatically update chromedriver before 
+cucumber tests, in case Chrome and chromedriver versions don't match
 LONGDESC
 
+option :quiet_if_matching, type: :boolean, default: false,
+  desc: 'Suppress notification if chromedriver and chrome versions match'
+
 def chromedriver_update
   require 'geordi/chromedriver_updater'
 
-  ChromedriverUpdater.new.run
+  ChromedriverUpdater.new.run(options)
 end

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,30 +1,28 @@
 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_geordi 'bundle_install'
 
   if target == 'development'
-    invoke_cmd 'yarn_install'
+    invoke_geordi 'yarn_install'
 
     Interaction.announce 'Opening a local Rails console'
 
-    Util.system! Util.console_command(target)
+    command = Util.console_command(target)
+    Util.run!(command)
   else
     Interaction.announce 'Opening a Rails console on ' + target
 

data/lib/geordi/commands/create_databases.rb

@@ -1,15 +1,17 @@
 desc 'create-databases', 'Create all databases', hide: true
 def create_databases
-  invoke_cmd 'create_database_yml'
-  invoke_cmd 'bundle_install'
+  invoke_geordi 'create_database_yml'
+  invoke_geordi 'bundle_install'
 
   Interaction.announce 'Creating databases'
 
   if File.exist?('config/database.yml')
-    command = 'bundle exec rake db:create:all'
-    command << ' parallel:create' if Util.file_containing?('Gemfile', /parallel_tests/)
+    command = []
+    command << Util.binstub_or_fallback('rake')
+    command << 'db:create:all'
+    command << 'parallel:create' if Util.file_containing?('Gemfile', /parallel_tests/)
 
-    Util.system! command
+    Util.run!(command)
   else
     puts 'config/database.yml does not exist. Nothing to do.'
   end

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'
 
@@ -39,7 +37,7 @@ def cucumber(*args)
   if args.empty?
     # This is not testable as there is no way to stub `git` :(
     if options.modified?
-      modified_features = `git status --short`.split($INPUT_RECORD_SEPARATOR).map do |line|
+      modified_features = `git status --short`.split("\n").map do |line|
         indicators = line.slice!(0..2) # Remove leading indicators
         line if line.include?('.feature') && !indicators.include?('D')
       end.compact
@@ -47,7 +45,7 @@ def cucumber(*args)
     end
 
     if options.containing
-      matching_features = `grep -lri '#{options.containing}' --include=*.feature features/`.split($INPUT_RECORD_SEPARATOR)
+      matching_features = `grep -lri '#{options.containing}' --include=*.feature features/`.split("\n")
       args = matching_features.uniq
     end
   end
@@ -55,8 +53,13 @@ def cucumber(*args)
   if File.directory?('features')
     require 'geordi/cucumber'
 
-    invoke_cmd 'bundle_install'
-    invoke_cmd 'yarn_install'
+    settings = Geordi::Settings.new
+
+    invoke_geordi 'bundle_install'
+    invoke_geordi 'yarn_install'
+    if settings.auto_update_chromedriver
+      invoke_geordi 'chromedriver_update', quiet_if_matching: true
+    end
 
     cmd_opts, files = args.partition { |f| f.start_with? '-' }
     cmd_opts << '--format' << 'pretty' << '--backtrace' if options.debug

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.
@@ -66,7 +66,7 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
   push_needed = false if Util.testing? # Hard to test
 
   Interaction.announce "Checking whether your #{source_branch} branch is ready" ############
-  Util.system! "git checkout #{source_branch}"
+  Util.run!("git checkout #{source_branch}")
   if (`git status -s | wc -l`.strip != '0') && !Util.testing?
     Interaction.warn "Your #{source_branch} branch holds uncommitted changes."
     Interaction.prompt('Continue anyway?', 'n', /y|yes/) || raise('Cancelled.')
@@ -76,14 +76,14 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
 
   if merge_needed
     Interaction.announce "Checking what's in your #{target_branch} branch right now" #######
-    Util.system! "git checkout #{target_branch} && git pull"
+    Util.run!("git checkout #{target_branch} && git pull")
   end
 
   Interaction.announce 'You are about to:' #################################################
   Interaction.note "Merge branch #{source_branch} into #{target_branch}" if merge_needed
   if push_needed
     Interaction.note 'Push these commits:' if push_needed
-    Util.system! "git --no-pager log origin/#{target_branch}..#{source_branch} --oneline"
+    Util.run!("git --no-pager log origin/#{target_branch}..#{source_branch} --oneline")
   end
   Interaction.note "Deploy to #{target_stage}"
   Interaction.note "From current branch #{source_branch}" if options.current_branch
@@ -94,22 +94,22 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
     git_call << "git merge #{source_branch}" if merge_needed
     git_call << 'git push' if push_needed
 
+    invoke_geordi '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/)
     capistrano_call = "DEPLOY_BRANCH=#{source_branch} #{capistrano_call}" if options.current_branch
 
     if git_call.any?
-      Util.system! git_call.join(' && '), show_cmd: true
+      Util.run!(git_call.join(' && '), show_cmd: true)
     end
 
-    invoke_cmd 'bundle_install'
-
-    Util.system! capistrano_call, show_cmd: true
+    Util.run!(capistrano_call, show_cmd: true)
 
     Interaction.success 'Deployment complete.'
   else
-    Util.system! "git checkout #{source_branch}"
+    Util.run!("git checkout #{source_branch}")
     Interaction.fail 'Deployment cancelled.'
   end
 end