geordi 2.12.3 → 3.0.0

data/lib/geordi/db_cleaner.rb

@@ -11,10 +11,10 @@ module Geordi
       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
+      raise 'sudo access is required for database operations as database users' if $CHILD_STATUS != 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 +23,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}")
@@ -82,16 +82,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$"
+            raise "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."
+            raise "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 +107,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])
+          raise "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
+            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|
+            raise '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
+          raise 'MySQL/MariaDB connection failed, is this the correct port?'
         end
       end
-      return cmd
+      cmd
     end
     private :decide_mysql_command
 
@@ -141,22 +141,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
+          raise "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
+          raise "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
 
@@ -224,7 +224,7 @@ HEREDOC
         end
         case proceed
         when 'e'
-          proceed = ''  # reset user selection
+          proceed = '' # reset user selection
           edit_whitelist dbtype
         when 'n'
           success 'Not deleting anything'
@@ -245,10 +245,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

@@ -14,7 +14,7 @@ module Geordi
     def development_database_config
       require 'yaml'
 
-      @config ||= YAML::load(ERB.new(File.read('config/database.yml')).result)
+      @config ||= YAML.safe_load(ERB.new(File.read('config/database.yml')).result)
       @config['development']
     end
     alias_method :config, :development_database_config
@@ -47,7 +47,7 @@ module Geordi
         available_dumps = Dir.glob(dumps_glob).sort
 
         HighLine.new.choose(*available_dumps) do |menu|
-          menu.hidden('') { fail 'Abort.' }
+          menu.hidden('') { raise 'Abort.' }
         end
       end
     end
@@ -56,7 +56,7 @@ module Geordi
       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,13 @@
 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 +17,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"
+          warn "Firefox #{version} not found"
 
           note 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.'
+          prompt('Run tests anyway?', 'n', /y|yes/) || raise('Cancelled.')
         end
 
         path(version)
@@ -37,7 +37,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
 
@@ -72,7 +72,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,7 +92,7 @@ module Geordi
       end
 
       def original_binary
-        FirefoxForSelenium.binary(@version, "firefox-original")
+        FirefoxForSelenium.binary(@version, 'firefox-original')
       end
 
       def say_hello
@@ -137,7 +137,7 @@ module Geordi
         INSTRUCTION
         prompt 'Continue?'
 
-        File.file?(binary) or raise "Could not find #{binary}"
+        File.file?(binary) || raise("Could not find #{binary}")
       end
 
       def create_separate_profile
@@ -156,7 +156,7 @@ module Geordi
         patched_binary.write 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}")
@@ -200,4 +200,3 @@ module Geordi
     end
   end
 end
-

data/lib/geordi/gitpt.rb

@@ -4,8 +4,8 @@ class Gitpt
   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 +13,7 @@ class Gitpt
   end
 
   def run(git_args)
-    warn <<-WARNING if !Geordi::Util.staged_changes?
+    warn <<-WARNING unless Geordi::Util.staged_changes?
 No staged changes. Will create an empty commit.
     WARNING
 
@@ -30,16 +30,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 +49,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,11 +60,11 @@ 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} :("
@@ -79,19 +79,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 +126,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

data/lib/geordi/remote.rb

@@ -8,7 +8,7 @@ module Geordi
   class Remote
     include Geordi::Interaction
 
-    REMOTE_DUMP_PATH = '~/dumps/dump_for_download.dump'
+    REMOTE_DUMP_PATH = '~/dumps/dump_for_download.dump'.freeze
 
     def initialize(stage)
       @stage = stage
@@ -34,8 +34,8 @@ module Geordi
     def dump(options = {})
       # Generate dump on the server
       shell options.merge({
-        :remote_command => "dumple #{@config.env} --for_download",
-        :select_server => nil # Dump must be generated on the primary server
+        remote_command: "dumple #{@config.env} --for_download",
+        select_server: nil, # Dump must be generated on the primary server
       })
 
       destination_directory = File.join(@config.root, 'tmp')
@@ -45,7 +45,7 @@ module Geordi
 
       note "Downloading remote dump to #{relative_destination} ..."
       server = @config.primary_server
-      Util.system! "scp -C #{ @config.user(server) }@#{ server }:#{REMOTE_DUMP_PATH} #{destination_path}"
+      Util.system! "scp -C #{@config.user(server)}@#{server}:#{REMOTE_DUMP_PATH} #{destination_path}"
 
       success "Dumped the #{@stage} database to #{relative_destination}."
 
@@ -53,7 +53,7 @@ module Geordi
     end
 
     def console(options = {})
-      shell(options.merge :remote_command => Util.console_command(@config.env))
+      shell(options.merge(remote_command: Util.console_command(@config.env)))
     end
 
     def shell(options = {})
@@ -63,7 +63,7 @@ module Geordi
       remote_command << " -c '#{options[:remote_command]}'" if options[:remote_command]
 
       note 'Connecting to ' + server.to_s
-      Util.system! 'ssh', "#{ @config.user(server) }@#{ server }", '-t', remote_command
+      Util.system! 'ssh', "#{@config.user(server)}@#{server}", '-t', remote_command
     end
 
   end

data/lib/geordi/util.rb

@@ -10,19 +10,19 @@ module Geordi
       # all employed gems as runtime dependencies because that would
       # unnecessarily slow down all commands.
       # Thus, we have this handy method here.
-      def installing_missing_gems(&block)
+      def installing_missing_gems
         yield
       rescue LoadError => error
         error.message =~ /-- (\S+)\Z/
-        $1 or raise # could not extract a gem name from the error message, re-raise the error
+        Regexp.last_match(1) || raise # could not extract a gem name from the error message, re-raise the error
 
-        gem_name = $1.strip.split('/').first
+        gem_name = Regexp.last_match(1).strip.split('/').first
         install_command = 'gem install ' + gem_name
 
         # install missing gem
         warn 'Probably missing gem: ' + gem_name
-        prompt('Install it now?', 'y', /y|yes/) or fail 'Missing Gems.'
-        system! install_command, :show_cmd => true
+        prompt('Install it now?', 'y', /y|yes/) || raise('Missing Gems.')
+        system! install_command, show_cmd: true
 
         # retry
         Gem.clear_paths
@@ -42,16 +42,16 @@ module Geordi
         note_cmd commands.join(' ') if options[:show_cmd]
 
         if options[:confirm]
-          prompt('Run this now?', 'n', /y|yes/) or fail('Cancelled.')
+          prompt('Run this now?', 'n', /y|yes/) || raise('Cancelled.')
         end
 
         if testing?
-          puts "Util.system! #{ commands.join ', ' }"
+          puts "Util.system! #{commands.join ', '}"
         else
           # Remove Geordi's Bundler environment when running commands.
           success = if !defined?(Bundler)
             system(*commands)
-          elsif Gem::Version.new(Bundler::VERSION) >= Gem::Version.new('1.17.3')
+          elsif Gem::Version.new(Bundler::VERSION) >= Gem::Version.new('2.1.2')
             Bundler.with_original_env do
               system(*commands)
             end
@@ -59,7 +59,7 @@ module Geordi
             Bundler.clean_system(*commands)
           end
 
-          success or fail(options[:fail_message] || 'Something went wrong.')
+          success || raise(options[:fail_message] || 'Something went wrong.')
         end
       end
 
@@ -107,7 +107,7 @@ module Geordi
       # try to guess user's favorite cli text editor
       def decide_texteditor
         %w[/usr/bin/editor vi].each do |texteditor|
-          if cmd_exists? texteditor and texteditor.start_with? '$'
+          if cmd_exists?(texteditor) && texteditor.start_with?('$')
             return ENV[texteditor[1..-1]]
           elsif cmd_exists? texteditor
             return texteditor
@@ -116,19 +116,17 @@ module Geordi
       end
 
       # check if given cmd is executable. Absolute path or command in $PATH allowed.
-      def cmd_exists? cmd
+      def cmd_exists?(cmd)
         system("which #{cmd} > /dev/null")
-        return $?.exitstatus.zero?
+        $CHILD_STATUS.exitstatus.zero?
       end
 
       def is_port_open?(port)
-        begin
-          socket = TCPSocket.new('127.0.0.1', port)
-          socket.close
-          return true
-        rescue Errno::ECONNREFUSED
-          return false
-        end
+        socket = TCPSocket.new('127.0.0.1', port)
+        socket.close
+        true
+      rescue Errno::ECONNREFUSED
+        false
       end
 
       # splint lines e.g. read from a file into lines and clean those up
@@ -161,12 +159,8 @@ module Geordi
         nil
       end
 
-      def ruby_version
-        Gem::Version.new(RUBY_VERSION)
-      end
-
       def file_containing?(file, regex)
-        File.exists?(file) and File.read(file).scan(regex).any?
+        File.exist?(file) && File.read(file).scan(regex).any?
       end
 
       def testing?