geordi 3.0.0 → 3.2.0

data/lib/geordi/commands/server.rb

@@ -10,9 +10,9 @@ def server(port = nil)
   invoke_cmd 'yarn_install'
   require 'geordi/util'
 
-  announce 'Booting a development server'
+  Interaction.announce 'Booting a development server'
   port ||= options.port
-  note "URL: http://#{File.basename(Dir.pwd)}.vcap.me:#{port}"
+  Interaction.note "URL: http://#{File.basename(Dir.pwd)}.vcap.me:#{port}"
   puts
 
   command = Util.server_command

data/lib/geordi/commands/setup.rb

@@ -25,8 +25,8 @@ option :test, type: :boolean, aliases: '-t', desc: 'After setup, run tests'
 
 def setup
   if File.exist? 'bin/setup'
-    announce 'Running bin/setup'
-    note "Geordi's own setup routine is skipped"
+    Interaction.announce 'Running bin/setup'
+    Interaction.note "Geordi's own setup routine is skipped"
 
     Util.system! 'bin/setup'
   else
@@ -34,7 +34,7 @@ def setup
     invoke_cmd 'migrate'
   end
 
-  success 'Successfully set up the project.'
+  Interaction.success 'Successfully set up the project.'
 
   invoke_cmd 'dump', options.dump, load: true if options.dump
   invoke_cmd 'tests' if options.test

data/lib/geordi/commands/shell.rb

@@ -2,18 +2,22 @@ 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 when called with `--select-server`:
+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
 LONGDESC
 
-option :select_server, default: false, type: :boolean, aliases: '-s'
+option :select_server, type: :string, 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)
   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

@@ -4,9 +4,9 @@ def unit
     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

@@ -21,12 +21,12 @@ option :dump, type: :string, aliases: '-d', banner: 'TARGET',
 option :test, type: :boolean, aliases: '-t', desc: 'After updating, run tests'
 
 def update
-  announce 'Updating repository'
+  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 'tests' if options.test

data/lib/geordi/commands/with_rake.rb

@@ -4,10 +4,10 @@ def with_rake
     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

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

data/lib/geordi/cucumber.rb

@@ -5,10 +5,10 @@ require 'tempfile'
 # version of Geordi.
 require File.expand_path('interaction', __dir__)
 require File.expand_path('firefox_for_selenium', __dir__)
+require File.expand_path('settings', __dir__)
 
 module Geordi
   class Cucumber
-    include Geordi::Interaction
 
     VNC_DISPLAY = ':17'.freeze
     VNC_SERVER_COMMAND = "vncserver #{VNC_DISPLAY} -localhost -nolisten tcp -SecurityTypes None -geometry 1280x1024".freeze
@@ -17,13 +17,14 @@ module Geordi
 
     def run(files, cucumber_options, options = {})
       self.argv = files + cucumber_options.map { |option| option.split('=') }.flatten
+      self.settings = Geordi::Settings.new
 
       consolidate_rerun_txt_files
       show_features_to_run
-      setup_vnc
+      setup_vnc if settings.use_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
@@ -34,11 +35,11 @@ module Geordi
         error = capture_stderr do
           system(VNC_VIEWER_COMMAND)
         end
-        unless $CHILD_STATUS.success?
-          if $CHILD_STATUS.exitstatus == 127
-            raise 'VNC viewer not found. Install it with `geordi vnc --setup`.'
+        unless $?.success?
+          if $?.exitstatus == 127
+            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
@@ -60,13 +61,13 @@ module Geordi
         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
 
     private
 
-    attr_accessor :argv
+    attr_accessor :argv, :settings
 
     def serial_execution_command
       format_args = []
@@ -77,7 +78,7 @@ module Geordi
     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'
@@ -115,15 +116,15 @@ module Geordi
 
     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
 
@@ -173,7 +174,7 @@ module Geordi
     def consolidate_rerun_txt_files
       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|
@@ -218,10 +219,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,14 +4,13 @@ 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`
-      raise 'sudo access is required for database operations as database users' if $CHILD_STATUS != 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.to_s if base_directory.nil?
@@ -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."
 
@@ -88,10 +87,10 @@ HEREDOC
         lines.each do |line|
           next if line.start_with?('#')
           unless line.split.length == 2
-            raise "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
-            raise "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'
@@ -108,7 +107,7 @@ HEREDOC
       unless extra_flags.nil?
         if extra_flags.include? 'port'
           port = Integer(extra_flags.split('=')[1].split[0])
-          raise "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
         end
         cmd << " #{extra_flags}"
       end
@@ -121,15 +120,15 @@ HEREDOC
           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.'
+            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 |_stdin_2, _stdout_2, _stderr_2, thread_2|
-            raise 'Could not connect to MySQL/MariaDB' unless thread_2.value.exitstatus == 0
+            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
-          raise 'MySQL/MariaDB connection failed, is this the correct port?'
+          Interaction.fail 'MySQL/MariaDB connection failed, is this the correct port?'
         end
       end
       cmd
@@ -141,10 +140,10 @@ HEREDOC
       unless extra_flags.nil?
         begin
           port = Integer(extra_flags.split('=')[1])
-          raise "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]
-          raise "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
@@ -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
           edit_whitelist dbtype
         when 'n'
-          success 'Not deleting anything'
+          Interaction.success 'Not deleting anything'
           return []
         when 'y'
           return deletable_dbs

data/lib/geordi/dump_loader.rb

@@ -5,7 +5,6 @@ require 'geordi/util'
 
 module Geordi
   class DumpLoader
-    include Geordi::Interaction
 
     def initialize(file)
       @dump_file = file
@@ -14,7 +13,9 @@ module Geordi
     def development_database_config
       require 'yaml'
 
-      @config ||= YAML.safe_load(ERB.new(File.read('config/database.yml')).result)
+      evaluated_config_file = ERB.new(File.read('config/database.yml')).result
+      # Allow aliases and a special set of classes like symbols and time objects
+      @config ||= YAML.safe_load(evaluated_config_file, [Symbol, Time], [], true)
       @config['development']
     end
     alias_method :config, :development_database_config
@@ -47,13 +48,13 @@ module Geordi
         available_dumps = Dir.glob(dumps_glob).sort
 
         HighLine.new.choose(*available_dumps) do |menu|
-          menu.hidden('') { raise 'Abort.' }
+          menu.hidden('') { Interaction.fail 'Abort.' }
         end
       end
     end
 
     def load
-      note 'Source file: ' + dump_file
+      Interaction.note 'Source file: ' + dump_file
 
       source_command = send("#{config['adapter']}_command")
       Util.system! source_command, fail_message: "An error occured loading #{File.basename(dump_file)}"

data/lib/geordi/firefox_for_selenium.rb

@@ -4,7 +4,6 @@ require File.expand_path('interaction', __dir__)
 
 module Geordi
   module FirefoxForSelenium
-    extend Geordi::Interaction
 
     FIREFOX_FOR_SELENIUM_BASE_PATH = Pathname.new('~/bin/firefoxes').expand_path
     FIREFOX_FOR_SELENIUM_PROFILE_NAME = 'firefox-for-selenium'.freeze
@@ -19,14 +18,14 @@ module Geordi
 
       if version && (version != 'system')
         unless FirefoxForSelenium.binary(version).exist?
-          warn "Firefox #{version} not found"
+          Interaction.warn "Firefox #{version} not found"
 
-          note strip_heredoc(<<-INSTRUCTIONS)
+          Interaction.note Util.strip_heredoc(<<-INSTRUCTIONS)
           Install it with
             geordi firefox --setup #{version}
           INSTRUCTIONS
 
-          prompt('Run tests anyway?', 'n', /y|yes/) || raise('Cancelled.')
+          Interaction.prompt('Run tests anyway?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
         end
 
         path(version)
@@ -46,13 +45,12 @@ module Geordi
 
       if path
         ENV['PATH'] = "#{path}:#{ENV['PATH']}"
-        note 'Firefox for Selenium set up'
+        Interaction.note 'Firefox for Selenium set up'
       end
     end
 
 
     class Installer
-      include Geordi::Interaction
 
       def initialize(version)
         @version = version
@@ -98,7 +96,7 @@ module Geordi
       def say_hello
         execute_command('clear')
 
-        puts strip_heredoc(<<-HELLO)
+        puts Util.strip_heredoc(<<-HELLO)
         Whenever Firefox updates, Selenium breaks. This is annoying. This
         script will help you create an unchanging version of Firefox for your
         Selenium tests.
@@ -117,31 +115,31 @@ module Geordi
         - It will live in #{path}
         HELLO
 
-        prompt "Press ENTER when you're ready to begin."
+        Interaction.prompt "Press ENTER when you're ready to begin."
       end
 
       def check_if_run_before
         if original_binary.exist?
-          note 'This version seems to be already installed.'
-          prompt 'Press ENTER to continue anyway or press CTRL+C to abort.'
+          Interaction.note 'This version seems to be already installed.'
+          Interaction.prompt 'Press ENTER to continue anyway or press CTRL+C to abort.'
         end
       end
 
       def download_firefox
         path.mkpath
 
-        puts strip_heredoc(<<-INSTRUCTION)
+        puts Util.strip_heredoc(<<-INSTRUCTION)
         Please download an old version of Firefox from: #{download_url}
         Unpack it with: tar xjf firefox-#{@version}.tar.bz2 -C #{path} --strip-components=1
         Now #{path.join('firefox')} should be the firefox binary, not a directory.
         INSTRUCTION
-        prompt 'Continue?'
+        Interaction.prompt 'Continue?'
 
         File.file?(binary) || raise("Could not find #{binary}")
       end
 
       def create_separate_profile
-        note "Creating a separate profile named '#{FIREFOX_FOR_SELENIUM_PROFILE_NAME}' so your own profile will be safe..."
+        Interaction.note "Creating a separate profile named '#{FIREFOX_FOR_SELENIUM_PROFILE_NAME}' so your own profile will be safe..."
         # don't use the patched firefox binary for this, we don't want to give
         # a -p option here
         execute_command("PATH=#{path}:$PATH firefox -no-remote -CreateProfile #{FIREFOX_FOR_SELENIUM_PROFILE_NAME}")
@@ -149,11 +147,11 @@ module Geordi
       end
 
       def patch_old_firefox
-        note "Patching #{binary} so it uses the new profile and never re-uses windows from other Firefoxes..."
+        Interaction.note "Patching #{binary} so it uses the new profile and never re-uses windows from other Firefoxes..."
         execute_command("mv #{binary} #{original_binary}")
         execute_command("mv #{binary}-bin #{original_binary}-bin")
         patched_binary = Tempfile.new('firefox')
-        patched_binary.write strip_heredoc(<<-PATCH)
+        patched_binary.write Util.strip_heredoc(<<-PATCH)
           #!/usr/bin/env ruby
           exec('#{original_binary}', '-no-remote', '-P', '#{FIREFOX_FOR_SELENIUM_PROFILE_NAME}', *ARGV)
         PATCH
@@ -164,7 +162,7 @@ module Geordi
       end
 
       def configure_old_firefox
-        puts strip_heredoc(<<-INSTRUCTION)
+        puts Util.strip_heredoc(<<-INSTRUCTION)
         You will now have to do some manual configuration.
 
         This script will open the patched copy of Firefox when you press ENTER.
@@ -178,15 +176,15 @@ module Geordi
           Firefox profile
         INSTRUCTION
 
-        prompt 'Will open the patched copy of Firefox now'
+        Interaction.prompt 'Will open the patched copy of Firefox now'
         run_firefox_for_selenium
       end
 
       def kkthxbb
-        success "Congratulations, you're done!"
+        Interaction.success "Congratulations, you're done!"
 
         puts
-        puts strip_heredoc(<<-INSTRUCTION)
+        puts Util.strip_heredoc(<<-INSTRUCTION)
         Your patched copy of Firefox will be used when you run Cucumber using
         the cucumber script that comes with the geordi gem. If you cannot use
         `geordi cucumber`, but still need the test browser set up, you can use: