geordi 2.10.1 → 3.0.3

data/lib/geordi/commands/shell.rb

@@ -7,13 +7,13 @@ Lets you select the server to connect to when called with `--select-server`:
     geordi shell production -s
 LONGDESC
 
-option :select_server, :default => false, :type => :boolean, :aliases => '-s'
+option :select_server, default: false, type: :boolean, aliases: '-s'
 
 # 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)
+def shelll(target, *_args)
   require 'geordi/remote'
 
-  announce 'Opening a shell on ' + target
+  Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end

data/lib/geordi/commands/tests.rb

@@ -10,5 +10,5 @@ def tests
     invoke_cmd 'cucumber'
   end
 
-  success 'Successfully ran tests.'
+  Interaction.success 'Successfully ran tests.'
 end

data/lib/geordi/commands/unit.rb

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

data/lib/geordi/commands/update.rb

@@ -16,18 +16,18 @@ After updating, runs all tests when called with the `--test` option:
 See `geordi help update` for details.
 LONGDESC
 
-option :dump, :type => :string, :aliases => '-d', :banner => 'TARGET',
-  :desc => 'After updating, dump the TARGET db and source it into the development db'
-option :test, :type => :boolean, :aliases => '-t', :desc => 'After updating, run tests'
+option :dump, type: :string, aliases: '-d', banner: 'TARGET',
+  desc: 'After updating, dump the TARGET db and source it into the development db'
+option :test, type: :boolean, aliases: '-t', desc: 'After updating, run tests'
 
 def update
-  announce 'Updating repository'
-  Util.system! 'git pull', :show_cmd => true
+  Interaction.announce 'Updating repository'
+  Util.system! 'git pull', show_cmd: true
 
   invoke_cmd 'migrate'
 
-  success 'Successfully updated the project.'
+  Interaction.success 'Successfully updated the project.'
 
-  invoke_cmd 'dump', options.dump, :load => true if options.dump
+  invoke_cmd 'dump', options.dump, load: true if options.dump
   invoke_cmd 'tests' if options.test
 end

data/lib/geordi/commands/vnc.rb

@@ -8,7 +8,7 @@ tests.
 When called with `--setup`, will guide through the setup of VNC.
 LONGDESC
 
-option :setup, :type => :boolean
+option :setup, type: :boolean
 
 def vnc
   if options.setup

data/lib/geordi/commands/with_rake.rb

@@ -1,13 +1,13 @@
-desc 'with-rake', 'Run tests with `rake`', :hide => true
+desc 'with-rake', 'Run tests with `rake`', hide: true
 def with_rake
   if Util.file_containing?('Rakefile', /^task.+default.+(spec|test|feature)/)
     invoke_cmd 'bundle_install'
     invoke_cmd 'yarn_install'
 
-    announce 'Running tests with `rake`'
+    Interaction.announce 'Running tests with `rake`'
     Util.system! 'rake'
   else
-    note '`rake` does not run tests.'
+    Interaction.note '`rake` does not run tests.'
     :did_not_perform
   end
 end

data/lib/geordi/commands/yarn_install.rb

@@ -1,8 +1,8 @@
-desc 'yarn-install', 'Runs yarn install if required', :hide => true
+desc 'yarn-install', 'Runs yarn install if required', hide: true
 
 def yarn_install
-  if File.exists?('package.json') and !system('yarn check --integrity > /dev/null 2>&1')
-    announce 'Yarn install'
+  if File.exist?('package.json') && !system('yarn check --integrity > /dev/null 2>&1')
+    Interaction.announce 'Yarn install'
     Util.system! 'yarn install'
   end
 end

data/lib/geordi/cucumber.rb

@@ -3,17 +3,16 @@ require 'tempfile'
 
 # This require-style is to prevent Ruby from loading files of a different
 # version of Geordi.
-require File.expand_path('../interaction', __FILE__)
-require File.expand_path('../firefox_for_selenium', __FILE__)
+require File.expand_path('interaction', __dir__)
+require File.expand_path('firefox_for_selenium', __dir__)
 
 module Geordi
   class Cucumber
-    include Geordi::Interaction
 
-    VNC_DISPLAY = ':17'
-    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024"
-    VNC_VIEWER_COMMAND = "vncviewer #{VNC_DISPLAY}"
-    VNC_ENV_VARIABLES = %w[DISPLAY BROWSER LAUNCHY_BROWSER]
+    VNC_DISPLAY = ':17'.freeze
+    VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024".freeze
+    VNC_VIEWER_COMMAND = "vncviewer #{VNC_DISPLAY}".freeze
+    VNC_ENV_VARIABLES = %w[DISPLAY BROWSER LAUNCHY_BROWSER].freeze
 
     def run(files, cucumber_options, options = {})
       self.argv = files + cucumber_options.map { |option| option.split('=') }.flatten
@@ -23,27 +22,27 @@ module Geordi
       setup_vnc
 
       command = use_parallel_tests?(options) ? parallel_execution_command : serial_execution_command
-      note_cmd(command) if options[:verbose]
+      Interaction.note_cmd(command) if options[:verbose]
 
       puts # Make newline
       system command # Util.system! would reset the Firefox PATH
     end
 
     def launch_vnc_viewer
-      fork {
+      fork do
         error = capture_stderr do
           system(VNC_VIEWER_COMMAND)
         end
         unless $?.success?
           if $?.exitstatus == 127
-            fail 'VNC viewer not found. Install it with `geordi vnc --setup`.'
+            Interaction.fail 'VNC viewer not found. Install it with `geordi vnc --setup`.'
           else
-            note 'VNC viewer could not be opened:'
+            Interaction.note 'VNC viewer could not be opened:'
             puts error
             puts
           end
         end
-      }
+      end
     end
 
     def restore_env
@@ -57,10 +56,10 @@ module Geordi
         VNC_ENV_VARIABLES.each do |variable|
           ENV["OUTER_#{variable}"] = ENV[variable] if ENV[variable]
         end
-        ENV["BROWSER"] = ENV["LAUNCHY_BROWSER"] = File.expand_path('../../../bin/launchy_browser', __FILE__)
-        ENV["DISPLAY"] = VNC_DISPLAY
+        ENV['BROWSER'] = ENV['LAUNCHY_BROWSER'] = File.expand_path('../../bin/launchy_browser', __dir__)
+        ENV['DISPLAY'] = VNC_DISPLAY
 
-        note 'Run `geordi vnc` to view the Selenium test browsers'
+        Interaction.note 'Run `geordi vnc` to view the Selenium test browsers'
       end
     end
 
@@ -73,11 +72,11 @@ module Geordi
       unless argv.include?('--format') || argv.include?('-f')
         format_args = spinner_available? ? ['--format', 'CucumberSpinner::CuriousProgressBarFormatter'] : ['--format', 'progress']
       end
-      [use_firefox_for_selenium, "b", "cucumber", format_args, escape_shell_args(argv)].flatten.compact.join(" ")
+      [use_firefox_for_selenium, 'b', 'cucumber', format_args, escape_shell_args(argv)].flatten.compact.join(' ')
     end
 
     def parallel_execution_command
-      note 'Using parallel_tests'
+      Interaction.note 'Using parallel_tests'
       self.argv = argv - command_line_features
 
       type_arg = Util.gem_version('parallel_tests') > Gem::Version.new('0.7.0') ? 'cucumber' : 'features'
@@ -87,8 +86,8 @@ module Geordi
       [
         use_firefox_for_selenium,
         'b parallel_test -t ' + type_arg,
-        %(-o '#{ command_line_options.join(' ') } --tags "#{not_tag('@solo')}"'),
-        "-- #{ features.join(' ') }"
+        %(-o '#{command_line_options.join(' ')} --tags "#{not_tag('@solo')}"'),
+        "-- #{features.join(' ')}",
       ].compact.join(' ')
     end
 
@@ -109,21 +108,21 @@ module Geordi
 
     def escape_shell_args(*args)
       args.flatten.collect do |arg|
-        arg.gsub(/([\\ "])/) { |match| "\\#{$1}" }
+        arg.gsub(/([\\ "])/) { |_match| "\\#{Regexp.last_match(1)}" }
       end
     end
 
     def show_features_to_run
       if command_line_options.include? '@solo'
-        note 'All features tagged with @solo'
+        Interaction.note 'All features tagged with @solo'
       elsif command_line_options.include? 'rerun'
-        note 'Rerunning failed scenarios'
+        Interaction.note 'Rerunning failed scenarios'
       elsif features_to_run.empty?
-        note 'All features in features/'
+        Interaction.note 'All features in features/'
       else
         notification = 'Only: ' + features_to_run.join(', ')
         notification << ' (from rerun.txt)' if (features_to_run == rerun_txt_features) && (features_to_run != command_line_features)
-        note notification
+        Interaction.note notification
       end
     end
 
@@ -137,8 +136,8 @@ module Geordi
 
     def rerun_txt_features
       @rerun_txt_features ||= begin
-        if File.exists?("rerun.txt")
-          IO.read("rerun.txt").to_s.strip.split(/\s+/)
+        if File.exist?('rerun.txt')
+          IO.read('rerun.txt').to_s.strip.split(/\s+/)
         else
           []
         end
@@ -150,7 +149,7 @@ module Geordi
     end
 
     def command_line_options
-      @command_line_options ||= Array.new.tap do |args|
+      @command_line_options ||= [].tap do |args|
         # Sorry for this mess. Option parsing doesn't get much prettier.
         argv.each_cons(2) do |a, b|
           break if a == '--' # This is the common no-options-beyond marker
@@ -171,9 +170,9 @@ module Geordi
     end
 
     def consolidate_rerun_txt_files
-      parallel_rerun_files = Dir.glob("parallel_rerun*.txt")
+      parallel_rerun_files = Dir.glob('parallel_rerun*.txt')
       unless parallel_rerun_files.empty?
-        note 'Consolidating parallel_rerun.txt files ...'
+        Interaction.note 'Consolidating parallel_rerun.txt files ...'
 
         rerun_content = []
         parallel_rerun_files.each do |filename|
@@ -181,8 +180,8 @@ module Geordi
           File.unlink(filename)
         end
 
-        File.open("rerun.txt", "w") do |f|
-          f.puts(rerun_content.join(" "))
+        File.open('rerun.txt', 'w') do |f|
+          f.puts(rerun_content.join(' '))
         end
       end
     end
@@ -190,14 +189,14 @@ module Geordi
     def find_all_features_recursively(files_or_dirs)
       Array(files_or_dirs).map do |file_or_dir|
         if File.directory?(file_or_dir)
-          file_or_dir = Dir.glob(File.join(file_or_dir, "**", "*.feature"))
+          file_or_dir = Dir.glob(File.join(file_or_dir, '**', '*.feature'))
         end
         file_or_dir
       end.flatten.uniq.compact
     end
 
     def spinner_available?
-      @spinner_available ||= File.exists?('Gemfile') && File.open('Gemfile').read.scan(/cucumber_spinner/).any?
+      @spinner_available ||= File.exist?('Gemfile') && File.open('Gemfile').read.scan(/cucumber_spinner/).any?
     end
 
     def use_parallel_tests?(options)
@@ -209,7 +208,7 @@ module Geordi
 
     def try_and_start_vnc
       # check if vnc is already running
-      #return true if vnc_server_running?
+      # return true if vnc_server_running?
       error = capture_stderr do
         system(VNC_SERVER_COMMAND)
       end
@@ -218,10 +217,10 @@ module Geordi
         98 # was already running after all
         true
       when 127 # not installed
-        warn 'Could not launch VNC server. Install it with `geordi vnc --setup`.'
+        Interaction.warn 'Could not launch VNC server. Install it with `geordi vnc --setup`.'
         false
       else
-        warn 'Starting VNC failed:'
+        Interaction.warn 'Starting VNC failed:'
         puts error
         puts
         false

data/lib/geordi/db_cleaner.rb

@@ -4,17 +4,16 @@ require 'tempfile'
 
 module Geordi
   class DBCleaner
-    include Geordi::Interaction
 
     def initialize(extra_flags)
       puts 'Please enter your sudo password if asked, for db operations as system users'
       puts "We're going to run `sudo -u postgres psql` for PostgreSQL"
       puts '               and `sudo mysql`            for MariaDB (which uses PAM auth)'
       `sudo true`
-      fail 'sudo access is required for database operations as database users' if $? != 0
+      Interaction.fail 'sudo access is required for database operations as database users' if $? != 0
       @derivative_dbname = /_(test\d*|development|cucumber)$/
       base_directory = ENV['XDG_CONFIG_HOME']
-      base_directory = "#{Dir.home}" if base_directory.nil?
+      base_directory = Dir.home.to_s if base_directory.nil?
       @whitelist_directory = File.join(base_directory, '.config', 'geordi', 'whitelists')
       FileUtils.mkdir_p(@whitelist_directory) unless File.directory? @whitelist_directory
       @mysql_command = decide_mysql_command(extra_flags['mysql'])
@@ -23,11 +22,11 @@ module Geordi
 
     def edit_whitelist(dbtype)
       whitelist = whitelist_fname(dbtype)
-      if File.exist? whitelist
-        whitelisted_dbs = Geordi::Util.stripped_lines(File.read(whitelist))\
+      whitelisted_dbs = if File.exist? whitelist
+        Geordi::Util.stripped_lines(File.read(whitelist))\
           .delete_if { |l| l.start_with? '#' }
       else
-        whitelisted_dbs = Array.new
+        []
       end
       all_dbs = list_all_dbs(dbtype)
       tmp = Tempfile.open("geordi_whitelist_#{dbtype}")
@@ -66,7 +65,7 @@ HEREDOC
         tmpfile_content.push(['keep', db_name]) unless db_name.empty?
       end
       if warn_manual_whitelist
-        warn <<-ERROR_MSG.gsub(/^\s*/, '')
+        Interaction.warn <<-ERROR_MSG.gsub(/^\s*/, '')
         Your whitelist #{whitelist} seems to have been generated manually.
         In that case, make sure to use only one database name per line and omit the 'keep' prefix."
 
@@ -82,16 +81,16 @@ HEREDOC
       texteditor = Geordi::Util.decide_texteditor
       system("#{texteditor} #{tmp.path}")
       File.open(tmp.path, 'r') do |wl_edited|
-        whitelisted_dbs = Array.new
+        whitelisted_dbs = []
         whitelist_storage = File.open(whitelist, 'w')
         lines = Geordi::Util.stripped_lines(wl_edited.read)
         lines.each do |line|
           next if line.start_with?('#')
           unless line.split.length == 2
-            fail "Invalid edit to whitelist file: \`#{line}\` - Syntax is: ^[keep|drop] dbname$"
+            Interaction.fail "Invalid edit to whitelist file: \`#{line}\` - Syntax is: ^[keep|drop] dbname$"
           end
           unless %w[keep drop k d].include? line.split.first
-            fail "Invalid edit to whitelist file: \`#{line}\` - must start with either drop or keep."
+            Interaction.fail "Invalid edit to whitelist file: \`#{line}\` - must start with either drop or keep."
           end
           db_status, db_name = line.split
           if db_status == 'keep'
@@ -107,32 +106,32 @@ HEREDOC
       cmd = 'sudo mysql'
       unless extra_flags.nil?
         if extra_flags.include? 'port'
-          port = Integer(extra_flags.split('=')[1].split()[0])
-          fail "Port #{port} is not open" unless Geordi::Util.is_port_open? port
+          port = Integer(extra_flags.split('=')[1].split[0])
+          Interaction.fail "Port #{port} is not open" unless Geordi::Util.is_port_open? port
         end
         cmd << " #{extra_flags}"
       end
-      Open3.popen3("#{cmd} -e 'QUIT'") do |stdin, stdout, stderr, thread|
+      Open3.popen3("#{cmd} -e 'QUIT'") do |_stdin, _stdout, stderr, thread|
         break if thread.value.exitstatus == 0
         # sudo mysql was not successful, switching to mysql-internal user management
         mysql_error = stderr.read.lines[0].chomp.strip.split[1]
-        if %w[1045 1698].include? mysql_error  # authentication failed
+        if %w[1045 1698].include? mysql_error # authentication failed
           cmd = 'mysql -uroot'
           cmd << " #{extra_flags}" unless extra_flags.nil?
           unless File.exist? File.join(Dir.home, '.my.cnf')
             puts "Please enter your MySQL/MariaDB password for account 'root'."
-            warn "You should create a ~/.my.cnf file instead, or you'll need to enter your MySQL root password for each db."
-            warn "See https://makandracards.com/makandra/50813-store-mysql-passwords-for-development for more information."
-            cmd << ' -p'  # need to ask for password now
+            Interaction.warn "You should create a ~/.my.cnf file instead, or you'll need to enter your MySQL root password for each db."
+            Interaction.warn 'See https://makandracards.com/makandra/50813-store-mysql-passwords-for-development for more information.'
+            cmd << ' -p' # need to ask for password now
           end
-          Open3.popen3("#{cmd} -e 'QUIT'") do |stdin2, stdout2, stderr2, thread2|
-            fail 'Could not connect to MySQL/MariaDB' unless thread2.value.exitstatus == 0
+          Open3.popen3("#{cmd} -e 'QUIT'") do |_stdin_2, _stdout_2, _stderr_2, thread_2|
+            Interaction.fail 'Could not connect to MySQL/MariaDB' unless thread_2.value.exitstatus == 0
           end
-        elsif mysql_error == '2013'  # connection to port or socket failed
-          fail 'MySQL/MariaDB connection failed, is this the correct port?'
+        elsif mysql_error == '2013' # connection to port or socket failed
+          Interaction.fail 'MySQL/MariaDB connection failed, is this the correct port?'
         end
       end
-      return cmd
+      cmd
     end
     private :decide_mysql_command
 
@@ -141,22 +140,22 @@ HEREDOC
       unless extra_flags.nil?
         begin
           port = Integer(extra_flags.split('=')[1])
-          fail "Port #{port} is not open" unless Geordi::Util.is_port_open? port
+          Interaction.fail "Port #{port} is not open" unless Geordi::Util.is_port_open? port
         rescue ArgumentError
           socket = extra_flags.split('=')[1]
-          fail "Socket #{socket} does not exist" unless File.exist? socket
+          Interaction.fail "Socket #{socket} does not exist" unless File.exist? socket
         end
         cmd << " #{extra_flags}"
       end
-      return cmd
+      cmd
     end
     private :decide_postgres_command
 
     def list_all_dbs(dbtype)
       if dbtype == 'postgres'
-        return list_all_postgres_dbs
+        list_all_postgres_dbs
       else
-        return list_all_mysql_dbs
+        list_all_mysql_dbs
       end
     end
 
@@ -172,7 +171,7 @@ HEREDOC
     end
 
     def clean_mysql
-      announce 'Checking for MySQL databases'
+      Interaction.announce 'Checking for MySQL databases'
       database_list = list_all_dbs('mysql')
       # confirm_deletion includes option for whitelist editing
       deletable_dbs = confirm_deletion('mysql', database_list)
@@ -181,19 +180,19 @@ HEREDOC
         if @mysql_command.include? '-p'
           puts "Please enter your MySQL/MariaDB account 'root' for: DROP DATABASE #{db}"
         else
-          note "Dropping MySQL/MariaDB database #{db}"
+          Interaction.note "Dropping MySQL/MariaDB database #{db}"
         end
         `#{@mysql_command} -e 'DROP DATABASE \`#{db}\`;'`
       end
     end
 
     def clean_postgres
-      announce 'Checking for Postgres databases'
+      Interaction.announce 'Checking for Postgres databases'
       database_list = list_all_dbs('postgres')
       deletable_dbs = confirm_deletion('postgres', database_list)
       return if deletable_dbs.nil?
       deletable_dbs.each do |db|
-        note "Dropping PostgreSQL database `#{db}`."
+        Interaction.note "Dropping PostgreSQL database `#{db}`."
         `#{@postgres_command} -c 'DROP DATABASE "#{db}";'`
       end
     end
@@ -207,27 +206,27 @@ HEREDOC
       until %w[y n].include? proceed
         deletable_dbs = filter_whitelisted(dbtype, database_list)
         if deletable_dbs.empty?
-          note "No #{dbtype} databases found that were not whitelisted"
-          if prompt('Edit the whitelist? [y]es or [n]o') == 'y'
+          Interaction.note "No #{dbtype} databases found that were not whitelisted"
+          if Interaction.prompt('Edit the whitelist? [y]es or [n]o') == 'y'
             proceed = 'e'
           else
             return []
           end
         end
         if proceed.empty?
-          note "The following #{dbtype} databases are not whitelisted and could be deleted:"
+          Interaction.note "The following #{dbtype} databases are not whitelisted and could be deleted:"
           deletable_dbs.sort.each do |db|
             puts db
           end
-          note "Those #{dbtype} databases are not whitelisted and could be deleted."
-          proceed = prompt('Proceed? [y]es, [n]o or [e]dit whitelist')
+          Interaction.note "Those #{dbtype} databases are not whitelisted and could be deleted."
+          proceed = Interaction.prompt('Proceed? [y]es, [n]o or [e]dit whitelist')
         end
         case proceed
         when 'e'
-          proceed = ''  # reset user selection
+          proceed = '' # reset user selection
           edit_whitelist dbtype
         when 'n'
-          success 'Not deleting anything'
+          Interaction.success 'Not deleting anything'
           return []
         when 'y'
           return deletable_dbs
@@ -245,10 +244,10 @@ HEREDOC
     end
 
     def is_whitelisted?(dbtype, database_name)
-      if File.exist? whitelist_fname(dbtype)
-        whitelist_content = Geordi::Util.stripped_lines(File.open(whitelist_fname(dbtype), 'r').read)
+      whitelist_content = if File.exist? whitelist_fname(dbtype)
+        Geordi::Util.stripped_lines(File.open(whitelist_fname(dbtype), 'r').read)
       else
-        whitelist_content = Array.new
+        []
       end
       # Allow explicit whitelisting of derivative databases like projectname_test2
       if whitelist_content.include? database_name