geordi 2.10.1 → 3.0.3

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

data/lib/geordi/interaction.rb

@@ -3,6 +3,8 @@
 module Geordi
   module Interaction
 
+    module_function
+
     # Start your command by `announce`-ing what you're about to do
     def announce(text)
       message = "\n# #{text}"
@@ -42,12 +44,6 @@ module Geordi
       puts "\e[32m#{message}\e[0m" # green
     end
 
-    def strip_heredoc(string)
-      leading_whitespace = (string.match(/\A( +)[^ ]+/) || [])[1]
-      string.gsub! /^#{leading_whitespace}/, '' if leading_whitespace
-      string
-    end
-
     # Returns the user's input.
     # If agreement_regex is given, returns whether the input matches the regex.
     def prompt(text, default = nil, agreement_regex = nil)

data/lib/geordi/remote.rb

@@ -6,9 +6,8 @@ require 'pathname'
 
 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 +33,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')
@@ -43,17 +42,17 @@ module Geordi
       destination_path = File.join(destination_directory, "#{@stage}.dump")
       relative_destination = Pathname.new(destination_path).relative_path_from Pathname.new(@config.root)
 
-      note "Downloading remote dump to #{relative_destination} ..."
+      Interaction.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}."
+      Interaction.success "Dumped the #{@stage} database to #{relative_destination}."
 
       destination_path
     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 = {})
@@ -62,8 +61,8 @@ module Geordi
       remote_command = "cd #{@config.remote_root} && #{@config.shell}"
       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
+      Interaction.note 'Connecting to ' + server.to_s
+      Util.system! 'ssh', "#{@config.user(server)}@#{server}", '-t', remote_command
     end
 
   end

data/lib/geordi/util.rb

@@ -4,29 +4,28 @@ require 'socket'
 module Geordi
   class Util
     class << self
-      include Geordi::Interaction
 
       # Geordi commands sometimes require external gems. However, we don't want
       # 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
+        Interaction.warn 'Probably missing gem: ' + gem_name
+        Interaction.prompt('Install it now?', 'y', /y|yes/) || Interaction.fail('Missing Gems.')
+        system! install_command, show_cmd: true
 
         # retry
         Gem.clear_paths
-        note 'Retrying ...'
+        Interaction.note 'Retrying ...'
         require gem_name
         retry
       end
@@ -39,27 +38,27 @@ module Geordi
       # @option fail_message: The text to print on command failure
       def system!(*commands)
         options = commands.last.is_a?(Hash) ? commands.pop : {}
-        note_cmd commands.join(' ') if options[:show_cmd]
+        Interaction.note_cmd commands.join(' ') if options[:show_cmd]
 
         if options[:confirm]
-          prompt('Run this now?', 'n', /y|yes/) or fail('Cancelled.')
+          Interaction.prompt('Run this now?', 'n', /y|yes/) or Interaction.fail('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('2.1.2')
-            Bundler.with_unbundled_env do
+            Bundler.with_original_env do
               system(*commands)
             end
           else
             Bundler.clean_system(*commands)
           end
 
-          success or fail(options[:fail_message] || 'Something went wrong.')
+          success || Interaction.fail(options[:fail_message] || 'Something went wrong.')
         end
       end
 
@@ -94,7 +93,7 @@ module Geordi
           ENV['GEORDI_TESTING_STAGED_CHANGES'] == 'true'
         else
           statuses = `git status --porcelain`.split("\n")
-          statuses.any? { |l| l.start_with? 'A' }
+          statuses.any? { |l| l.start_with? /[A-Z]/i }
         end
       end
 
@@ -107,7 +106,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 +115,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?
+        $?.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
@@ -162,13 +159,19 @@ module Geordi
       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?
         !!ENV['GEORDI_TESTING']
       end
 
+      def strip_heredoc(string)
+        leading_whitespace = (string.match(/\A( +)[^ ]+/) || [])[1]
+        string.gsub! /^#{leading_whitespace}/, '' if leading_whitespace
+        string
+      end
+
       private
 
       def bundle_list