geordi 3.1.0 → 4.1.1

data/lib/geordi/commands/rake.rb

@@ -10,12 +10,16 @@ Example: `geordi rake db:migrate`
 LONGDESC
 
 def rake(*args)
+  invoke_geordi 'bundle_install'
+
   %w[development test cucumber].each do |env| # update long_desc when changing this
     if File.exist? "config/environments/#{env}.rb"
-      call = %w[bundle exec rake] + args + ["RAILS_ENV=#{env}"]
-      Interaction.note_cmd call.join(' ')
+      command = []
+      command << Util.binstub_or_fallback('rake')
+      command += args
+      command << "RAILS_ENV=#{env}"
 
-      Util.system! *call
+      Util.run!(command, show_cmd: true)
     end
   end
 end

data/lib/geordi/commands/rspec.rb

@@ -2,20 +2,19 @@ desc 'rspec [FILES]', 'Run RSpec'
 long_desc <<-LONGDESC
 Example: `geordi rspec spec/models/user_spec.rb:13`
 
-Runs RSpec as you want: with RSpec 1/2 detection, `bundle exec`, rspec_spinner
-detection, etc.
+Runs RSpec with RSpec 1/2 support, parallel_tests detection and `bundle exec`.
 LONGDESC
 
 def rspec(*files)
   if File.exist?('spec/spec_helper.rb')
-    invoke_cmd 'bundle_install'
-    invoke_cmd 'yarn_install'
+    invoke_geordi 'bundle_install'
+    invoke_geordi 'yarn_install'
 
     Interaction.announce 'Running specs'
 
     if Util.file_containing?('Gemfile', /parallel_tests/) && files.empty?
       Interaction.note 'All specs at once (using parallel_tests)'
-      Util.system! 'bundle exec rake parallel:spec', fail_message: 'Specs failed.'
+      Util.run!([Util.binstub_or_fallback('rake'), 'parallel:spec'], fail_message: 'Specs failed.')
 
     else
       # tell which specs will be run
@@ -26,19 +25,16 @@ def rspec(*files)
         Interaction.note 'Only: ' + files.join(', ')
       end
 
-      command = ['bundle exec']
-      command << if File.exist?('script/spec')
-        'spec -c' # RSpec 1
-      elsif File.exist?('bin/rspec')
-        'bin/rspec'
+      command = if File.exist?('script/spec')
+        ['bundle exec spec -c'] # RSpec 1
       else
-        'rspec'
+        [Util.binstub_or_fallback('rspec')]
       end
       command << '-r rspec_spinner -f RspecSpinner::Bar' if Util.file_containing?('Gemfile', /rspec_spinner/)
       command << files.join(' ')
 
       puts
-      Util.system! command.join(' '), fail_message: 'Specs failed.'
+      Util.run!(command.join(' '), fail_message: 'Specs failed.')
     end
   else
     Interaction.note 'RSpec not employed.'

data/lib/geordi/commands/security_update.rb

@@ -1,31 +1,30 @@
 desc 'security-update [STEP]', 'Support for performing security updates'
 long_desc <<-LONGDESC
-Preparation for security update: `geordi security-update`
+Preparation for security update: `geordi security-update`. Checks out production
+and pulls.
 
-Checks out production and pulls.
+After performing the update: `geordi security-update finish`. Switches branches,
+pulls, pushes and deploys as required by our workflow.
 
-After performing the update: `geordi security-update finish`
+This command tells what it will do before it does it. In detail:
 
-Switches branches, pulls, pushes and deploys as required by our workflow. Tells
-what it will do before it does it. In detail:
+1. Ask user if tests are green
 
-1. Asks user, if tests are green
+2. Push production
 
-2. Pushes production
+3. Check out master and pull
 
-3. Checks out master and pulls
+4. Merge production and push in master
 
-4. Merges production and pushes in master
+5. Deploy staging, if there is a staging environment
 
-5. Deploys staging first, if there is a staging environment
+6. Ask user if deployment log is okay and staging application is still running
 
-6. Asks user, if deployment log is okay and application is still running on staging
+7. Deploy other stages
 
-7. Deploys other stages
+8. Ask user if deployment log is okay and application is still running on all stages
 
-8. Asks user, if deployment log is okay and application is still running on all other stages
-
-9. Informs user about the next steps
+9. Inform user about the next (manual) steps
 LONGDESC
 
 def security_update(step = 'prepare')
@@ -36,8 +35,8 @@ def security_update(step = 'prepare')
     Interaction.note 'About to checkout production and pull.'
     Interaction.prompt('Continue?', 'y', /y|yes/) || Interaction.fail('Cancelled.')
 
-    Util.system! 'git checkout production', show_cmd: true
-    Util.system! 'git pull', show_cmd: true
+    Util.run!('git checkout production', show_cmd: true)
+    Util.run!('git pull', show_cmd: true)
 
     Interaction.success 'Successfully prepared for security update'
     puts
@@ -48,7 +47,7 @@ def security_update(step = 'prepare')
   when 'f', 'finish'
     # ensure everything is committed
     if Util.testing?
-      puts 'Util.system! git status --porcelain'
+      puts 'Util.run! git status --porcelain'
     else
       `git status --porcelain`.empty? || Interaction.fail('Please commit your changes before finishing the update.')
     end
@@ -60,11 +59,11 @@ def security_update(step = 'prepare')
     Interaction.note 'About to: push production, checkout & pull master, merge production, push master.'
     Interaction.prompt('Continue?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
 
-    Util.system! 'git push', show_cmd: true
-    Util.system! 'git checkout master', show_cmd: true
-    Util.system! 'git pull', show_cmd: true
-    Util.system! 'git merge production', show_cmd: true
-    Util.system! 'git push', show_cmd: true
+    Util.run!('git push', show_cmd: true)
+    Util.run!('git checkout master', show_cmd: true)
+    Util.run!('git pull', show_cmd: true)
+    Util.run!('git merge production', show_cmd: true)
+    Util.run!('git push', show_cmd: true)
 
     Interaction.announce 'Deployment'
     deploy = (Util.gem_major_version('capistrano') == 3) ? 'deploy' : 'deploy:migrations'
@@ -77,7 +76,7 @@ def security_update(step = 'prepare')
       Interaction.prompt('Deploy staging now?', 'y', /y|yes/) || Interaction.fail('Cancelled.')
 
       Interaction.announce 'Deploy staging'
-      Util.system! "bundle exec cap staging #{deploy}", show_cmd: true
+      Util.run! "bundle exec cap staging #{deploy}", show_cmd: true
 
       Interaction.prompt('Is the deployment log okay and the application is still running on staging?', 'y', /y|yes/) || Interaction.fail('Please fix the deployment issues on staging before you continue.')
     else
@@ -97,7 +96,7 @@ def security_update(step = 'prepare')
 
       deploy_targets_without_staging.each do |target|
         Interaction.announce "Deploy #{target}"
-        Util.system! "bundle exec cap #{target} #{deploy}", show_cmd: true
+        Util.run!("bundle exec cap #{target} #{deploy}", show_cmd: true)
       end
 
       Interaction.prompt('Is the application still running on all other stages and the logs are okay?', 'y', /y|yes/) || Interaction.fail('Please fix the application immediately!')

data/lib/geordi/commands/server.rb

@@ -3,11 +3,11 @@ 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'
-  invoke_cmd 'yarn_install'
+  invoke_geordi 'bundle_install'
+  invoke_geordi 'yarn_install'
   require 'geordi/util'
 
   Interaction.announce 'Booting a development server'
@@ -18,7 +18,7 @@ def server(port = nil)
   command = Util.server_command
   command << ' -b 0.0.0.0' if options.public
   command << ' -p ' << port
-  Util.system! command
+  Util.run!(command)
 end
 
 map 'devserver' => 'server'

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',
@@ -28,14 +19,14 @@ def setup
     Interaction.announce 'Running bin/setup'
     Interaction.note "Geordi's own setup routine is skipped"
 
-    Util.system! 'bin/setup'
+    Util.run!('bin/setup')
   else
-    invoke_cmd 'create_databases'
-    invoke_cmd 'migrate'
+    invoke_geordi 'create_databases'
+    invoke_geordi 'migrate'
   end
 
   Interaction.success 'Successfully set up the project.'
 
-  invoke_cmd 'dump', options.dump, load: true if options.dump
-  invoke_cmd 'tests' if options.test
+  invoke_geordi 'dump', options.dump, load: true if options.dump
+  invoke_geordi 'tests' if options.test
 end

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_geordi 'bundle_install'
+
   Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end

data/lib/geordi/commands/tests.rb

@@ -1,13 +1,13 @@
 desc 'tests', 'Run all employed tests'
 def tests
-  rake_result = invoke_cmd 'with_rake'
+  rake_result = invoke_geordi 'with_rake'
 
   # Since `rake` usually is configured to run all tests, only run them if `rake`
   # did not perform
   if rake_result == :did_not_perform
-    invoke_cmd 'unit'
-    invoke_cmd 'rspec'
-    invoke_cmd 'cucumber'
+    invoke_geordi 'unit'
+    invoke_geordi 'rspec'
+    invoke_geordi 'cucumber'
   end
 
   Interaction.success 'Successfully ran tests.'

data/lib/geordi/commands/unit.rb

@@ -1,11 +1,11 @@
 desc 'unit', 'Run Test::Unit'
 def unit
   if File.exist?('test/test_helper.rb')
-    invoke_cmd 'bundle_install'
-    invoke_cmd 'yarn_install'
+    invoke_geordi 'bundle_install'
+    invoke_geordi 'yarn_install'
 
     Interaction.announce 'Running Test::Unit'
-    Util.system! 'bundle exec rake test'
+    Util.run!([Util.binstub_or_fallback('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',
@@ -22,12 +11,12 @@ option :test, type: :boolean, aliases: '-t', desc: 'After updating, run tests'
 
 def update
   Interaction.announce 'Updating repository'
-  Util.system! 'git pull', show_cmd: true
+  Util.run!('git pull', show_cmd: true)
 
-  invoke_cmd 'migrate'
+  invoke_geordi 'migrate'
 
   Interaction.success 'Successfully updated the project.'
 
-  invoke_cmd 'dump', options.dump, load: true if options.dump
-  invoke_cmd 'tests' if options.test
+  invoke_geordi 'dump', options.dump, load: true if options.dump
+  invoke_geordi 'tests' if options.test
 end

data/lib/geordi/commands/vnc.rb

@@ -4,15 +4,13 @@ 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
-    invoke_cmd :_setup_vnc
+    invoke_geordi :_setup_vnc
   else
     require 'geordi/cucumber'
     Geordi::Cucumber.new.launch_vnc_viewer

data/lib/geordi/commands/with_rake.rb

@@ -1,11 +1,11 @@
 desc 'with-rake', 'Run tests with `rake`', hide: true
 def with_rake
   if Util.file_containing?('Rakefile', /^task.+default.+(spec|test|feature)/)
-    invoke_cmd 'bundle_install'
-    invoke_cmd 'yarn_install'
+    invoke_geordi 'bundle_install'
+    invoke_geordi 'yarn_install'
 
     Interaction.announce 'Running tests with `rake`'
-    Util.system! 'rake'
+    Util.run!(Util.binstub_or_fallback('rake'))
   else
     Interaction.note '`rake` does not run tests.'
     :did_not_perform

data/lib/geordi/commands/yarn_install.rb

@@ -3,6 +3,6 @@ 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')
     Interaction.announce 'Yarn install'
-    Util.system! 'yarn install'
+    Util.run!('yarn install')
   end
 end

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,16 +17,17 @@ 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]
 
       puts # Make newline
-      system command # Util.system! would reset the Firefox PATH
+      system command # Util.run! would reset the Firefox PATH
     end
 
     def launch_vnc_viewer
@@ -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_or_fallback('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/dump_loader.rb

@@ -57,7 +57,7 @@ module Geordi
       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.run! source_command, fail_message: "An error occured loading #{File.basename(dump_file)}"
     end
 
   end

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|
@@ -127,15 +89,11 @@ No staged changes. Will create an empty commit.
     extra = highline.ask("\nAdd an optional message").strip
     message << ' - ' << extra if extra != ''
 
-    Geordi::Util.system! 'git', 'commit', '--allow-empty', '-m', message, *git_args
+    Geordi::Util.run!(['git', 'commit', '--allow-empty', '-m', message, *git_args])
   end
 
   def bold(string)
     HighLine::BOLD + string + HighLine::RESET
   end
 
-  def highlight(string)
-    bold HighLine::BLUE + string
-  end
-
 end