geordi 2.11.0 → 3.1.0

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

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::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,16 +48,16 @@ module Geordi
         available_dumps = Dir.glob(dumps_glob).sort
 
         HighLine.new.choose(*available_dumps) do |menu|
-          menu.hidden('') { fail '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)}"
+      Util.system! source_command, fail_message: "An error occured loading #{File.basename(dump_file)}"
     end
 
   end

data/lib/geordi/firefox_for_selenium.rb

@@ -1,13 +1,12 @@
 require 'pathname'
 require 'tempfile'
-require File.expand_path('../interaction', __FILE__)
+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'
+    FIREFOX_FOR_SELENIUM_PROFILE_NAME = 'firefox-for-selenium'.freeze
     FIREFOX_VERSION_FILE = Pathname.new('.firefox-version')
 
     def self.install(version)
@@ -17,16 +16,16 @@ module Geordi
     def self.path_from_config
       version = FIREFOX_VERSION_FILE.exist? && File.read(FIREFOX_VERSION_FILE).strip
 
-      if version and version != 'system'
+      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 }
+            geordi firefox --setup #{version}
           INSTRUCTIONS
 
-          prompt 'Run tests anyway?', 'n', /y|yes/ or fail 'Cancelled.'
+          Interaction.prompt('Run tests anyway?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
         end
 
         path(version)
@@ -37,7 +36,7 @@ module Geordi
       FIREFOX_FOR_SELENIUM_BASE_PATH.join(version)
     end
 
-    def self.binary(version, name = "firefox")
+    def self.binary(version, name = 'firefox')
       path(version).join(name)
     end
 
@@ -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
@@ -72,7 +70,7 @@ module Geordi
       private
 
       def execute_command(cmd)
-        system(cmd) or raise "Error while executing command: #{cmd}"
+        system(cmd) || raise("Error while executing command: #{cmd}")
       end
 
       def run_firefox_for_selenium(args = '')
@@ -92,13 +90,13 @@ module Geordi
       end
 
       def original_binary
-        FirefoxForSelenium.binary(@version, "firefox-original")
+        FirefoxForSelenium.binary(@version, 'firefox-original')
       end
 
       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) or raise "Could not find #{binary}"
+        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,14 +147,14 @@ 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
+        PATCH
         patched_binary.close
         execute_command("mv #{patched_binary.path} #{binary}")
         execute_command("chmod +x #{binary}")
@@ -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:
@@ -200,4 +198,3 @@ module Geordi
     end
   end
 end
-

data/lib/geordi/gitpt.rb

@@ -1,11 +1,10 @@
 class Gitpt
-  include Geordi::Interaction
   require 'yaml'
   require 'highline'
   require 'tracker_api'
 
-  SETTINGS_FILE_NAME = '.gitpt'
-  PROJECT_IDS_FILE_NAME = '.pt_project_id'
+  SETTINGS_FILE_NAME = '.gitpt'.freeze
+  PROJECT_IDS_FILE_NAME = '.pt_project_id'.freeze
 
   def initialize
     self.highline = HighLine.new
@@ -13,7 +12,7 @@ class Gitpt
   end
 
   def run(git_args)
-    warn <<-WARNING if !Geordi::Util.staged_changes?
+    Geordi::Interaction.warn <<-WARNING unless Geordi::Util.staged_changes?
 No staged changes. Will create an empty commit.
     WARNING
 
@@ -30,16 +29,16 @@ No staged changes. Will create an empty commit.
   def read_settings
     file_path = File.join(ENV['HOME'], SETTINGS_FILE_NAME)
 
-    unless File.exists?(file_path)
+    unless File.exist?(file_path)
       highline.say HighLine::RESET
       highline.say "Welcome to #{bold 'gitpt'}.\n\n"
 
       highline.say highlight('Your settings are missing or invalid.')
       highline.say "Please configure your Pivotal Tracker access.\n\n"
-      token = highline.ask bold("Your API key:") + " "
+      token = highline.ask bold('Your API key:') + ' '
       highline.say "\n"
 
-      settings = { :token => token }
+      settings = { token: token }
       File.open(file_path, 'w') do |file|
         file.write settings.to_yaml
       end
@@ -49,7 +48,7 @@ No staged changes. Will create an empty commit.
   end
 
   def build_client(settings)
-    TrackerApi::Client.new(:token => settings.fetch(:token))
+    TrackerApi::Client.new(token: settings.fetch(:token))
   end
 
   def load_projects
@@ -60,14 +59,14 @@ No staged changes. Will create an empty commit.
   def read_project_ids
     file_path = PROJECT_IDS_FILE_NAME
 
-    if File.exists?(file_path)
+    if File.exist?(file_path)
       project_ids = File.read('.pt_project_id').split(/[\s]+/).map(&:to_i)
     end
 
-    if project_ids and project_ids.size > 0
+    if project_ids && (project_ids.size > 0)
       project_ids
     else
-      warn "Sorry, I could not find a project ID in #{file_path} :("
+      Geordi::Interaction.warn "Sorry, I could not find a project ID in #{file_path} :("
       puts
 
       puts "Please put at least one Pivotal Tracker project id into #{file_path} in this directory."
@@ -79,19 +78,19 @@ No staged changes. Will create an empty commit.
   def applicable_stories
     projects = load_projects
     projects.collect do |project|
-      project.stories(:filter => 'state:started,finished,rejected')
+      project.stories(filter: 'state:started,finished,rejected')
     end.flatten
   end
 
   def choose_story
     if Geordi::Util.testing?
-      return OpenStruct.new(:id => 12, :name => 'Test Story')
+      return OpenStruct.new(id: 12, name: 'Test Story')
     end
 
     loading_message = 'Connecting to Pivotal Tracker ...'
     print(loading_message)
     stories = applicable_stories
-    reset_loading_message = "\r#{ ' ' * (loading_message.length + stories.length)}\r"
+    reset_loading_message = "\r#{' ' * (loading_message.length + stories.length)}\r"
 
     highline.choose do |menu|
       menu.header = 'Choose a story'
@@ -126,7 +125,7 @@ No staged changes. Will create an empty commit.
 
   def create_commit(message, *git_args)
     extra = highline.ask("\nAdd an optional message").strip
-    message << ' - ' << extra if (extra != "")
+    message << ' - ' << extra if extra != ''
 
     Geordi::Util.system! 'git', 'commit', '--allow-empty', '-m', message, *git_args
   end