geordi 3.0.3 → 4.1.0

data/lib/geordi/commands/server.rb

@@ -3,7 +3,7 @@ desc 'server [PORT]', 'Start a development server'
 option :port, aliases: '-p', default: '3000',
   desc: 'Choose a port'
 option :public, aliases: '-P', type: :boolean,
-  desc: 'Make the server accessible in the local network'
+  desc: 'Make the server accessible from the local network'
 
 def server(port = nil)
   invoke_cmd 'bundle_install'

data/lib/geordi/commands/setup.rb

@@ -6,17 +6,8 @@ Check out a repository and cd into its directory. Then let `setup` do the tiring
 work: run `bundle install`, create `database.yml`, create databases, migrate
 (all if applicable).
 
-If a local bin/setup file is found, Geordi skips these steps runs bin/setup
-for setup instead.
-
-After setting up, loads a remote database dump into the development db when
-called with the `--dump` option:
-
-    geordi setup -d staging
-
-After setting up, runs all tests when called with the `--test` option:
-
-    geordi setup -t
+If a local bin/setup file is found, Geordi skips its routine and runs bin/setup
+instead.
 LONGDESC
 
 option :dump, type: :string, aliases: '-d', banner: 'TARGET',

data/lib/geordi/commands/shell.rb

@@ -2,18 +2,21 @@ 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`:
-
-    geordi shell production -s
+Selecting the server: `geordi shell staging -s` shows a menu with all available
+servers. When passed a number, directly connects to the selected server.
 LONGDESC
 
-option :select_server, default: false, type: :boolean, aliases: '-s'
+# This option is duplicated in console.rb
+option :select_server, type: :string, aliases: '-s', banner: '[SERVER_NUMBER]',
+  desc: 'Select a server to connect to'
 
 # 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'
 
+  invoke_cmd 'bundle_install'
+
   Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end

data/lib/geordi/commands/unit.rb

@@ -5,7 +5,7 @@ def unit
     invoke_cmd 'yarn_install'
 
     Interaction.announce 'Running Test::Unit'
-    Util.system! 'bundle exec rake test'
+    Util.system! Util.binstub('rake'), 'test'
   else
     Interaction.note 'Test::Unit not employed.'
   end

data/lib/geordi/commands/update.rb

@@ -3,17 +3,6 @@ long_desc <<-LONGDESC
 Example: `geordi update`
 
 Performs: `git pull`, `bundle install` (if necessary) and migrates (if applicable).
-
-After updating, loads a dump into the development db when called with the
-`--dump` option:
-
-    geordi update -d staging
-
-After updating, runs all tests when called with the `--test` option:
-
-    geordi update -t
-
-See `geordi help update` for details.
 LONGDESC
 
 option :dump, type: :string, aliases: '-d', banner: 'TARGET',

data/lib/geordi/commands/vnc.rb

@@ -4,11 +4,9 @@ Example: `geordi vnc` or `geordi vnc --setup`
 
 Launch a VNC session to the hidden screen where `geordi cucumber` runs Selenium
 tests.
-
-When called with `--setup`, will guide through the setup of VNC.
 LONGDESC
 
-option :setup, type: :boolean
+option :setup, type: :boolean, desc: 'Guide through the setup of VNC'
 
 def vnc
   if options.setup

data/lib/geordi/commands/with_rake.rb

@@ -5,7 +5,7 @@ def with_rake
     invoke_cmd 'yarn_install'
 
     Interaction.announce 'Running tests with `rake`'
-    Util.system! 'rake'
+    Util.system! Util.binstub('rake')
   else
     Interaction.note '`rake` does not run tests.'
     :did_not_perform

data/lib/geordi/cucumber.rb

@@ -5,6 +5,7 @@ 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
@@ -16,10 +17,11 @@ 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
       Interaction.note_cmd(command) if options[:verbose]
@@ -65,14 +67,14 @@ module Geordi
 
     private
 
-    attr_accessor :argv
+    attr_accessor :argv, :settings
 
     def serial_execution_command
       format_args = []
       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, Util.binstub('cucumber'), format_args, escape_shell_args(argv)].flatten.compact.join(' ')
     end
 
     def parallel_execution_command
@@ -85,7 +87,7 @@ module Geordi
 
       [
         use_firefox_for_selenium,
-        'b parallel_test -t ' + type_arg,
+        'bundle exec parallel_test -t ' + type_arg,
         %(-o '#{command_line_options.join(' ')} --tags "#{not_tag('@solo')}"'),
         "-- #{features.join(' ')}",
       ].compact.join(' ')

data/lib/geordi/gitpt.rb

@@ -3,12 +3,14 @@ class Gitpt
   require 'highline'
   require 'tracker_api'
 
-  SETTINGS_FILE_NAME = '.gitpt'.freeze
-  PROJECT_IDS_FILE_NAME = '.pt_project_id'.freeze
+  # This require-style is to prevent Ruby from loading files of a different
+  # version of Geordi.
+  require File.expand_path('settings', __dir__)
 
   def initialize
     self.highline = HighLine.new
-    self.client = build_client(read_settings)
+    self.settings = Geordi::Settings.new
+    self.client = build_client
   end
 
   def run(git_args)
@@ -24,57 +26,17 @@ No staged changes. Will create an empty commit.
 
   private
 
-  attr_accessor :highline, :client
+  attr_accessor :highline, :client, :settings
 
-  def read_settings
-    file_path = File.join(ENV['HOME'], SETTINGS_FILE_NAME)
-
-    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:') + ' '
-      highline.say "\n"
-
-      settings = { token: token }
-      File.open(file_path, 'w') do |file|
-        file.write settings.to_yaml
-      end
-    end
-
-    YAML.load_file(file_path)
-  end
-
-  def build_client(settings)
-    TrackerApi::Client.new(token: settings.fetch(:token))
+  def build_client
+    TrackerApi::Client.new(token: settings.pivotal_tracker_api_key)
   end
 
   def load_projects
-    project_ids = read_project_ids
+    project_ids = settings.pivotal_tracker_project_ids
     project_ids.collect { |project_id| client.project(project_id) }
   end
 
-  def read_project_ids
-    file_path = PROJECT_IDS_FILE_NAME
-
-    if File.exist?(file_path)
-      project_ids = File.read('.pt_project_id').split(/[\s]+/).map(&:to_i)
-    end
-
-    if project_ids && (project_ids.size > 0)
-      project_ids
-    else
-      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."
-      puts 'You may add multiple IDs, separated using white space.'
-      exit 1
-    end
-  end
-
   def applicable_stories
     projects = load_projects
     projects.collect do |project|
@@ -134,8 +96,4 @@ No staged changes. Will create an empty commit.
     HighLine::BOLD + string + HighLine::RESET
   end
 
-  def highlight(string)
-    bold HighLine::BLUE + string
-  end
-
 end

data/lib/geordi/remote.rb

@@ -34,7 +34,6 @@ module Geordi
       # 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
       })
 
       destination_directory = File.join(@config.root, 'tmp')
@@ -56,7 +55,20 @@ module Geordi
     end
 
     def shell(options = {})
-      server = options[:select_server] ? select_server : @config.primary_server
+      server_option = options[:select_server]
+      server_number = server_option.to_i
+
+      server =  if server_option == 'select_server'
+        select_server
+      elsif server_number != 0 && server_number <= @config.servers.count
+        server_index = server_number - 1
+        @config.servers[server_index]
+      elsif server_option.nil?
+        @config.primary_server
+      else
+        Interaction.warn "Invalid server number: #{server_option}"
+        select_server
+      end
 
       remote_command = "cd #{@config.remote_root} && #{@config.shell}"
       remote_command << " -c '#{options[:remote_command]}'" if options[:remote_command]

data/lib/geordi/settings.rb

@@ -0,0 +1,155 @@
+require 'yaml'
+
+require File.expand_path('util', __dir__)
+require File.expand_path('interaction', __dir__)
+
+module Geordi
+  class Settings
+    GLOBAL_SETTINGS_FILE_NAME = Util.testing? ? './tmp/global_settings.yml'.freeze : File.join(ENV['HOME'], '.config/geordi/global.yml').freeze
+    LOCAL_SETTINGS_FILE_NAME = Util.testing? ? './tmp/local_settings.yml'.freeze : './.geordi.yml'.freeze
+
+    ALLOWED_GLOBAL_SETTINGS = %w[ pivotal_tracker_api_key ].freeze
+    ALLOWED_LOCAL_SETTINGS = %w[ use_vnc pivotal_tracker_project_ids ].freeze
+
+    def initialize
+      read_settings
+    end
+
+    # Global settings
+    def pivotal_tracker_api_key
+      @global_settings['pivotal_tracker_api_key'] || gitpt_api_key_old || inquire_pt_api_key
+    end
+
+    def pivotal_tracker_api_key=(value)
+      @global_settings['pivotal_tracker_api_key'] = value
+      save_global_settings
+    end
+
+    # Local settings
+    # They should not be changed by geordi to avoid unexpected diffs, therefore
+    # there are no setters for these settings
+    def use_vnc?
+      @local_settings.fetch('use_vnc', true)
+    end
+
+    def pivotal_tracker_project_ids
+      project_ids = @local_settings['pivotal_tracker_project_ids'] || pt_project_ids_old
+
+      case project_ids
+      when Array
+        # nothing to do
+      when String
+        project_ids = project_ids.split(/[\s]+/).map(&:to_i)
+      when Integer
+        project_ids = [project_ids]
+      else
+        project_ids = []
+      end
+
+      if project_ids.empty?
+        puts
+        Geordi::Interaction.warn "Sorry, I could not find a project ID in .geordi.yml :("
+        puts
+
+        puts "Please put at least one Pivotal Tracker project id into the .geordi.yml file in this directory, e.g."
+        puts
+        puts "pivotal_tracker_project_ids:"
+        puts "- 123456"
+        puts
+        puts 'You may add multiple IDs.'
+        exit 1
+      end
+
+      project_ids
+    end
+
+    private
+
+    def read_settings
+      global_path = GLOBAL_SETTINGS_FILE_NAME
+      local_path = LOCAL_SETTINGS_FILE_NAME
+
+      if File.exists?(global_path)
+        global_settings = YAML.safe_load(File.read(global_path))
+        check_for_invalid_keys(global_settings, ALLOWED_GLOBAL_SETTINGS, global_path)
+      end
+
+      if File.exists?(local_path)
+        local_settings = YAML.safe_load(File.read(local_path))
+        check_for_invalid_keys(local_settings, ALLOWED_LOCAL_SETTINGS, local_path)
+      end
+
+      @global_settings = global_settings || {}
+      @local_settings = local_settings || {}
+    end
+
+    def check_for_invalid_keys(settings, allowed_keys, file)
+      invalid_keys = settings.keys - allowed_keys
+      unless invalid_keys.empty?
+        Geordi::Interaction.warn "Geordi detected unknown keys in #{file}.\n"
+
+        invalid_keys.sort.each do |key|
+          puts "* #{key}"
+        end
+
+        puts "\nAllowed keys are:"
+        allowed_keys.sort.each do |key|
+          puts "* #{key}"
+        end
+        puts
+
+        exit 1
+      end
+    end
+
+    def save_global_settings
+      global_path = GLOBAL_SETTINGS_FILE_NAME
+      global_directory = File.dirname(global_path)
+      FileUtils.mkdir_p(global_directory) unless File.directory? global_directory
+      File.open(global_path, 'w') do |file|
+        file.write @global_settings.to_yaml
+      end
+    end
+
+    # deprecated
+    def gitpt_api_key_old
+      file_path = File.join(ENV['HOME'], '.gitpt')
+      if File.exist?(file_path) && !Util.testing?
+        token = YAML.load_file(file_path).fetch :token
+        self.pivotal_tracker_api_key = token
+
+        Geordi::Interaction.warn "The ~/.gitpt file is deprecated."
+        Geordi::Interaction.note "The contained setting has been moved to ~/.config/geordi/global.yml."
+        Geordi::Interaction.note "If you don't need to work with an older version of geordi you can delete ~/.gitpt now."
+
+        token
+      end
+    end
+
+    def inquire_pt_api_key
+      Geordi::Interaction.warn 'Your settings are missing or invalid.'
+      Geordi::Interaction.warn "Please configure your Pivotal Tracker access."
+      token = Geordi::Interaction.prompt 'Your API key:'
+      self.pivotal_tracker_api_key = token
+      puts
+
+      token
+    end
+
+    # deprecated
+    def pt_project_ids_old
+      if File.exist?('.pt_project_id')
+        project_ids = File.read('.pt_project_id')
+        puts # Make sure to start on a new line (e.g. when invoked after a #print)
+        Geordi::Interaction.warn "The usage of the .pt_project_id file is deprecated."
+        Geordi::Interaction.note Util.strip_heredoc(<<-INSTRUCTIONS)
+          Please remove this file from your project and add or extend the .geordi.yml file with the following content:
+            pivotal_tracker_project_ids: #{project_ids}
+        INSTRUCTIONS
+
+        project_ids
+      end
+    end
+
+  end
+end

data/lib/geordi/util.rb

@@ -62,13 +62,21 @@ module Geordi
         end
       end
 
+      def binstub(executable, *arguments)
+        binstub_file = "bin/#{executable}"
+
+        command = File.exists?(binstub_file) ? [binstub_file] : ['bundle exec', executable]
+        command.push(*arguments)
+        command.join(' ')
+      end
+
       def console_command(environment)
         if gem_major_version('rails') == 2
           'script/console ' + environment
         elsif gem_major_version('rails') == 3
-          'bundle exec rails console ' + environment
+          binstub 'rails', 'console', environment
         else
-          "bundle exec rails console -e #{environment}"
+          binstub 'rails', 'console -e', environment
         end
       end
 
@@ -76,7 +84,7 @@ module Geordi
         if gem_major_version('rails') == 2
           'script/server ""'
         else
-          'bundle exec rails server'
+          binstub 'rails', 'server'
         end
       end
 
@@ -93,7 +101,7 @@ module Geordi
           ENV['GEORDI_TESTING_STAGED_CHANGES'] == 'true'
         else
           statuses = `git status --porcelain`.split("\n")
-          statuses.any? { |l| l.start_with? /[A-Z]/i }
+          statuses.any? { |l| /^[A-Z]/i =~ l }
         end
       end