geordi 2.10.1 → 3.0.3

data/lib/geordi/cli.rb

@@ -5,10 +5,13 @@ require 'geordi/util'
 
 module Geordi
   class CLI < Thor
-    include Geordi::Interaction
+
+    def self.exit_on_failure?
+      true
+    end
 
     # load all tasks defined in lib/geordi/commands
-    Dir[File.expand_path '../commands/*.rb', __FILE__].each do |file|
+    Dir[File.expand_path 'commands/*.rb', __dir__].each do |file|
       class_eval File.read(file), file
     end
 

data/lib/geordi/commands/_setup_vnc.rb

@@ -1,34 +1,34 @@
-desc '-setup-vnc', 'Setup VNC for running Selenium tests there', :hide => true
+desc '-setup-vnc', 'Setup VNC for running Selenium tests there', hide: true
 def _setup_vnc
   `clear`
 
-  note 'This script will help you install a VNC server and a VNC viewer.'
+  Interaction.note 'This script will help you install a VNC server and a VNC viewer.'
   puts
-  puts strip_heredoc <<-TEXT
+  puts Util.strip_heredoc <<-TEXT
     With those you will be able to use our cucumber script without being
     disturbed by focus-stealing Selenium windows. Instead, they will open
     inside a VNC session.
 
     You can still inspect everything with:
   TEXT
-  note_cmd 'geordi vnc'
+  Interaction.note_cmd 'geordi vnc'
   puts
-  note 'Please open a second shell to execute instructions.'
-  prompt 'Continue ...'
+  Interaction.note 'Please open a second shell to execute instructions.'
+  Interaction.prompt 'Continue ...'
 
-  announce 'Setup VNC server'
+  Interaction.announce 'Setup VNC server'
 
   vnc_server_installed = system('which vncserver > /dev/null 2>&1')
   if vnc_server_installed
-    success 'It appears you already have a VNC server installed. Good job!'
+    Interaction.success 'It appears you already have a VNC server installed. Good job!'
   else
     puts 'Please run:'
-    note_cmd 'sudo apt-get install vnc4server'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'sudo apt-get install vnc4server'
+    Interaction.prompt 'Continue ...'
 
     puts
-    note 'We will now set a password for your VNC server.'
-    puts strip_heredoc <<-TEXT
+    Interaction.note 'We will now set a password for your VNC server.'
+    puts Util.strip_heredoc <<-TEXT
       When running our cucumber script, you will not actually need this
       password, and there is no security risk. However, if you start a vncserver
       without our cucumber script, a user with your password can connect to
@@ -36,31 +36,31 @@ def _setup_vnc
 
     TEXT
     puts 'Please run:'
-    note_cmd 'vncserver :20'
-    warn 'Enter a secure password!'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'vncserver :20'
+    Interaction.warn 'Enter a secure password!'
+    Interaction.prompt 'Continue ...'
 
     puts 'Now stop the server again. Please run:'
-    note_cmd 'vncserver -kill :20'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'vncserver -kill :20'
+    Interaction.prompt 'Continue ...'
   end
 
-  announce 'Setup VNC viewer'
+  Interaction.announce 'Setup VNC viewer'
 
   vnc_viewer_installed = system('which vncviewer > /dev/null 2>&1')
   if vnc_viewer_installed
-    success 'It appears you already have a VNC viewer installed. Good job!'
+    Interaction.success 'It appears you already have a VNC viewer installed. Good job!'
   else
     puts 'Please run:'
-    note_cmd 'sudo apt-get install xtightvncviewer'
-    prompt 'Continue ...'
+    Interaction.note_cmd 'sudo apt-get install xtightvncviewer'
+    Interaction.prompt 'Continue ...'
   end
 
   puts
-  puts strip_heredoc <<-TEXT
+  puts Util.strip_heredoc <<-TEXT
     All done. Our cucumber script will now automatically run Selenium features
     in VNC.
   TEXT
 
-  success 'Happy cuking!'
+  Interaction.success 'Happy cuking!'
 end

data/lib/geordi/commands/apache_site.rb

@@ -10,13 +10,13 @@ def apache_site(*args)
     puts 'Please call: apache-site my-site'
     puts
     puts 'Available sites:'
-    Dir.new(".").each do |file|
+    Dir.new('.').each do |file|
       puts "- #{file}" if file != '.' && file != '..'
     end
     exit
   end
 
-  has_default = File.exists?('default')
-  exec "sudo a2dissite \*; sudo a2ensite #{"default " if has_default}#{site} && sudo apache2ctl restart"
+  has_default = File.exist?('default')
+  exec "sudo a2dissite \*; sudo a2ensite #{'default ' if has_default}#{site} && sudo apache2ctl restart"
   Dir.chdir old_cwd
 end

data/lib/geordi/commands/bundle_install.rb

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

data/lib/geordi/commands/capistrano.rb

@@ -6,18 +6,17 @@ LONGDESC
 def capistrano(*args)
   targets = Dir['config/deploy/*.rb'].map { |file| File.basename(file, '.rb') }.sort
 
-  note 'Found the following deploy targets:'
+  Interaction.note 'Found the following deploy targets:'
   puts targets
-  prompt('Continue?', 'n', /y|yes/) or fail 'Cancelled.'
+  Interaction.prompt('Continue?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
 
   targets << nil if targets.empty? # default target
   targets.each do |stage|
-    announce 'Target: ' + (stage || '(default)')
+    Interaction.announce 'Target: ' + (stage || '(default)')
 
     command = "bundle exec cap #{stage} " + args.join(' ')
-    note_cmd command
+    Interaction.note_cmd command
 
-    Util.system!(command, :fail_message => 'Capistrano failed. Have a look!')
+    Util.system!(command, fail_message: 'Capistrano failed. Have a look!')
   end
-
 end

data/lib/geordi/commands/chromedriver_update.rb

@@ -9,14 +9,5 @@ LONGDESC
 def chromedriver_update
   require 'geordi/chromedriver_updater'
 
-  # Ruby 1.9.3 introduces #capture3 in open3
-  supported_ruby_version = '1.9.2'
-
-  # We do not want to backport this command to Ruby 1.8.7, a user can just use a newer Ruby version to run it. For all
-  # other commands it still is necessary to have a proper Ruby 1.8.7 support.
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(supported_ruby_version)
-    raise("Unsupported ruby version #{RUBY_VERSION}, please use at least #{supported_ruby_version} to run this command!")
-  end
-
   ChromedriverUpdater.new.run
 end

data/lib/geordi/commands/clean.rb

@@ -1,16 +1,15 @@
 desc 'clean', 'Remove unneeded files from the current directory'
 def clean
 
-  announce 'Removing tempfiles'
+  Interaction.announce 'Removing tempfiles'
   for pattern in %w[ webrat-* capybara-* tmp/webrat-* tmp/capybara-* tmp/rtex/* log/*.log ]
-    note pattern
+    Interaction.note pattern
     puts `rm -vfR #{pattern}`
   end
 
-  announce 'Finding recursively and removing backup files'
-  for pattern in %w[ *~ ]
-    note pattern
+  Interaction.announce 'Finding recursively and removing backup files'
+  %w[*~].each do |pattern|
+    Interaction.note pattern
     `find . -name #{pattern} -exec rm {} ';'`
   end
-
 end

data/lib/geordi/commands/commit.rb

@@ -21,4 +21,3 @@ Unsupported Ruby Version #{RUBY_VERSION}. `geordi commit` requires Ruby 2.1+.
 
   Gitpt.new.run(git_args)
 end
-

data/lib/geordi/commands/console.rb

@@ -6,19 +6,19 @@ Open a Rails console on `staging`: `geordi console staging`
 LONGDESC
 
 
-option :select_server, :default => false, :type => :boolean, :aliases => '-s'
+option :select_server, default: false, type: :boolean, aliases: '-s'
 
-def console(target = 'development', *args)
+def console(target = 'development', *_args)
   require 'geordi/remote'
 
   if target == 'development'
     invoke_cmd 'yarn_install'
 
-    announce 'Opening a local Rails console'
+    Interaction.announce 'Opening a local Rails console'
 
     Util.system! Util.console_command(target)
   else
-    announce 'Opening a Rails console on ' + target
+    Interaction.announce 'Opening a Rails console on ' + target
 
     Geordi::Remote.new(target).console(options)
   end

data/lib/geordi/commands/create_database_yml.rb

@@ -1,10 +1,10 @@
-desc 'create-database-yml', '[sic]', :hide => true
+desc 'create-database-yml', '[sic]', hide: true
 def create_database_yml
   real_yml = 'config/database.yml'
   sample_yml = 'config/database.sample.yml'
 
-  if File.exists?(sample_yml) and not File.exists?(real_yml)
-    announce 'Creating ' + real_yml
+  if File.exist?(sample_yml) && !File.exist?(real_yml)
+    Interaction.announce 'Creating ' + real_yml
 
     sample = File.read(sample_yml)
     adapter = sample.match(/adapter: (\w+)\n/).captures.first
@@ -15,6 +15,6 @@ def create_database_yml
     real = sample.gsub(/password:.*$/, "password: #{db_password}")
     File.open(real_yml, 'w') { |f| f.write(real) }
 
-    note "Created #{real_yml}."
+    Interaction.note "Created #{real_yml}."
   end
 end

data/lib/geordi/commands/create_databases.rb

@@ -1,11 +1,11 @@
-desc 'create-databases', 'Create all databases', :hide => true
+desc 'create-databases', 'Create all databases', hide: true
 def create_databases
   invoke_cmd 'create_database_yml'
   invoke_cmd 'bundle_install'
 
-  announce 'Creating databases'
+  Interaction.announce 'Creating databases'
 
-  if File.exists?('config/database.yml')
+  if File.exist?('config/database.yml')
     command = 'bundle exec rake db:create:all'
     command << ' parallel:create' if Util.file_containing?('Gemfile', /parallel_tests/)
 

data/lib/geordi/commands/cucumber.rb

@@ -17,30 +17,30 @@ or `-d`.
 e.g. `--format pretty`.
 LONGDESC
 
-option :modified, :aliases => '-m', :type => :boolean,
-  :desc => 'Run all modified features'
-option :containing, :aliases => '-c', :banner => 'STRING',
-  :desc => 'Run all features that contain STRING'
-option :verbose, :aliases => '-v', :type => :boolean,
-  :desc => 'Print the testrun command'
-option :debug, :aliases => '-d', :type => :boolean,
-  :desc => 'Run 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'
+option :modified, aliases: '-m', type: :boolean,
+  desc: 'Run all modified features'
+option :containing, aliases: '-c', banner: 'STRING',
+  desc: 'Run all features that contain STRING'
+option :verbose, aliases: '-v', type: :boolean,
+  desc: 'Print the testrun command'
+option :debug, aliases: '-d', type: :boolean,
+  desc: 'Run 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'
 
 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($/).map do |line|
+      modified_features = `git status --short`.split($INPUT_RECORD_SEPARATOR).map do |line|
         indicators = line.slice!(0..2) # Remove leading indicators
-        line if line.include?('.feature') and not indicators.include?('D')
+        line if line.include?('.feature') && !indicators.include?('D')
       end.compact
       args = modified_features
     end
 
     if options.containing
-      matching_features = `grep -lri '#{options.containing}' --include=*.feature features/`.split($/)
+      matching_features = `grep -lri '#{options.containing}' --include=*.feature features/`.split($INPUT_RECORD_SEPARATOR)
       args = matching_features.uniq
     end
   end
@@ -56,7 +56,7 @@ def cucumber(*args)
 
     # Serial run of @solo scenarios ############################################
     if files.any? { |f| f.include? ':' }
-      note '@solo run skipped when called with line numbers' if options.verbose
+      Interaction.note '@solo run skipped when called with line numbers' if options.verbose
     else
       solo_files = if files.empty?
         'features' # Proper grepping
@@ -64,37 +64,37 @@ def cucumber(*args)
         files.join(' ')
       end
 
-      solo_tag_usages = `grep -r '@solo' #{ solo_files }`.split("\n")
+      solo_tag_usages = `grep -r '@solo' #{solo_files}`.split("\n")
 
       if solo_tag_usages.any?
         solo_cmd_opts = cmd_opts.dup
         solo_cmd_opts << '--tags' << '@solo'
 
-        announce 'Running @solo features'
-        solo_success = Geordi::Cucumber.new.run files, solo_cmd_opts, :verbose => options.verbose, :parallel => false
-        solo_success or fail 'Features failed.'
+        Interaction.announce 'Running @solo features'
+        solo_success = Geordi::Cucumber.new.run files, solo_cmd_opts, verbose: options.verbose, parallel: false
+        solo_success || Interaction.fail('Features failed.')
       end
     end
 
     # Parallel run of all given features + reruns ##############################
-    announce 'Running features'
-    normal_run_successful = Geordi::Cucumber.new.run(files, cmd_opts, :verbose => options.verbose)
+    Interaction.announce 'Running features'
+    normal_run_successful = Geordi::Cucumber.new.run(files, cmd_opts, verbose: options.verbose)
 
     unless normal_run_successful
       cmd_opts << '--profile' << 'rerun'
 
       # Reruns
       (options.rerun + 1).times do |i|
-        fail 'Features failed.' if (i == options.rerun) # All reruns done?
+        Interaction.fail 'Features failed.' if i == options.rerun # All reruns done?
 
-        announce "Rerun ##{ i + 1 } of #{ options.rerun }"
-        break if Geordi::Cucumber.new.run([], cmd_opts, :verbose => options.verbose, :parallel => false)
+        Interaction.announce "Rerun ##{i + 1} of #{options.rerun}"
+        break if Geordi::Cucumber.new.run([], cmd_opts, verbose: options.verbose, parallel: false)
       end
     end
 
-    success 'Features green.'
+    Interaction.success 'Features green.'
 
   else
-    note 'Cucumber not employed.'
+    Interaction.note 'Cucumber not employed.'
   end
 end

data/lib/geordi/commands/delete_dumps.rb

@@ -12,32 +12,32 @@ LONGDESC
 
 def delete_dumps(dump_directory = nil)
   deletable_dumps = []
-  if dump_directory.nil?
-    dump_directories = [
+  dump_directories = if dump_directory.nil?
+    [
       File.join(Dir.home, 'dumps'),
-      Dir.pwd
+      Dir.pwd,
     ]
   else
-    dump_directories = [dump_directory]
+    [dump_directory]
   end
-  announce 'Looking for *.dump in ' << dump_directories.join(',')
+  Interaction.announce 'Looking for *.dump in ' << dump_directories.join(',')
   dump_directories.each do |d|
-    d2 = File.expand_path(d)
-    unless File.directory? File.realdirpath(d2)
-      warn "Directory #{d2} does not exist"
+    d_2 = File.expand_path(d)
+    unless File.directory? File.realdirpath(d_2)
+      Interaction.warn "Directory #{d_2} does not exist"
       next
     end
-    deletable_dumps.concat(Dir.glob("#{d2}/**/*.dump"))
+    deletable_dumps.concat(Dir.glob("#{d_2}/**/*.dump"))
   end
   if deletable_dumps.empty?
-    success 'No dumps to delete' if deletable_dumps.empty?
+    Interaction.success 'No dumps to delete' if deletable_dumps.empty?
     exit 0
   end
   deletable_dumps.uniq!.sort!
-  note 'The following dumps can be deleted:'
+  Interaction.note 'The following dumps can be deleted:'
   puts
   puts deletable_dumps
-  prompt 'Delete those dumps', 'n', /y|yes/ or fail 'Cancelled.'
+  Interaction.prompt('Delete those dumps', 'n', /y|yes/) || raise('Cancelled.')
   deletable_dumps.each do |dump|
     File.delete dump unless File.directory? dump
   end

data/lib/geordi/commands/deploy.rb

@@ -30,25 +30,25 @@ instead of `cap deploy:migrations`. You can force using `deploy` by passing the
 -M option: `geordi deploy -M staging`.
 LONGDESC
 
-option :no_migrations, :aliases => '-M', :type => :boolean,
-  :desc => 'Run cap deploy instead of cap deploy:migrations'
-option :current_branch, :aliases => '-c', :type => :boolean,
-  :desc => 'Set DEPLOY_BRANCH to the current branch during deploy'
+option :no_migrations, aliases: '-M', type: :boolean,
+  desc: 'Run cap deploy instead of cap deploy:migrations'
+option :current_branch, aliases: '-c', type: :boolean,
+  desc: 'Set DEPLOY_BRANCH to the current branch during deploy'
 
 def deploy(target_stage = nil)
   # Set/Infer default values
-  branch_stage_map = { 'master' => 'staging', 'production' => 'production'}
-  if target_stage and not Util.deploy_targets.include? target_stage
+  branch_stage_map = { 'master' => 'staging', 'production' => 'production' }
+  if target_stage && !Util.deploy_targets.include?(target_stage)
     # Target stage autocompletion from available stages
     target_stage = Util.deploy_targets.find { |t| t.start_with? target_stage }
-    target_stage || warn('Given deployment stage not found')
+    target_stage || Interaction.warn('Given deployment stage not found')
   end
 
   # Ask for required information
-  target_stage ||= prompt 'Deployment stage:', branch_stage_map.fetch(Util.current_branch, 'staging')
+  target_stage ||= Interaction.prompt 'Deployment stage:', branch_stage_map.fetch(Util.current_branch, 'staging')
   if options.current_branch
     stage_file = "config/deploy/#{target_stage}.rb"
-    Util.file_containing? stage_file, 'DEPLOY_BRANCH' or fail <<-ERROR
+    Util.file_containing?(stage_file, 'DEPLOY_BRANCH') || Interaction.fail(<<-ERROR)
 To deploy from the current branch, configure #{stage_file} to respect the
 environment variable DEPLOY_BRANCH. Example:
 
@@ -57,38 +57,38 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
 
     source_branch = target_branch = Util.current_branch
   else
-    source_branch = prompt 'Source branch:', Util.current_branch
-    target_branch = prompt 'Deploy branch:', branch_stage_map.invert.fetch(target_stage, 'master')
+    source_branch = Interaction.prompt 'Source branch:', Util.current_branch
+    target_branch = Interaction.prompt 'Deploy branch:', branch_stage_map.invert.fetch(target_stage, 'master')
   end
 
   merge_needed = (source_branch != target_branch)
   push_needed = merge_needed || `git cherry -v | wc -l`.strip.to_i > 0
   push_needed = false if Util.testing? # Hard to test
 
-  announce "Checking whether your #{source_branch} branch is ready" ############
+  Interaction.announce "Checking whether your #{source_branch} branch is ready" ############
   Util.system! "git checkout #{source_branch}"
-  if `git status -s | wc -l`.strip != '0' and not Util.testing?
-    warn "Your #{source_branch} branch holds uncommitted changes."
-    prompt('Continue anyway?', 'n', /y|yes/) or fail 'Cancelled.'
+  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.')
   else
-    note 'All good.'
+    Interaction.note 'All good.'
   end
 
   if merge_needed
-    announce "Checking what's in your #{target_branch} branch right now" #######
+    Interaction.announce "Checking what's in your #{target_branch} branch right now" #######
     Util.system! "git checkout #{target_branch} && git pull"
   end
 
-  announce 'You are about to:' #################################################
-  note "Merge branch #{source_branch} into #{target_branch}" if merge_needed
+  Interaction.announce 'You are about to:' #################################################
+  Interaction.note "Merge branch #{source_branch} into #{target_branch}" if merge_needed
   if push_needed
-    note 'Push these commits:' if push_needed
+    Interaction.note 'Push these commits:' if push_needed
     Util.system! "git --no-pager log origin/#{target_branch}..#{source_branch} --oneline"
   end
-  note "Deploy to #{target_stage}"
-  note "From current branch #{source_branch}" if options.current_branch
+  Interaction.note "Deploy to #{target_stage}"
+  Interaction.note "From current branch #{source_branch}" if options.current_branch
 
-  if prompt('Go ahead with the deployment?', 'n', /y|yes/)
+  if Interaction.prompt('Go ahead with the deployment?', 'n', /y|yes/)
     puts
     git_call = []
     git_call << "git merge #{source_branch}" if merge_needed
@@ -100,17 +100,16 @@ set :branch, ENV['DEPLOY_BRANCH'] || 'master'
     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.system! git_call.join(' && '), show_cmd: true
     end
 
     invoke_cmd 'bundle_install'
 
-    Util.system! capistrano_call, :show_cmd => true
+    Util.system! capistrano_call, show_cmd: true
 
-    success 'Deployment complete.'
+    Interaction.success 'Deployment complete.'
   else
     Util.system! "git checkout #{source_branch}"
-    fail 'Deployment cancelled.'
+    Interaction.fail 'Deployment cancelled.'
   end
-
 end