Module: RspecStarter::Help

Included in:
LegacyRunner
Defined in:
lib/rspec_starter/legacy/help.rb

Overview

Method that support the help option on the bin/start_rspec script.

Instance Method Summary collapse

Instance Method Details

#calling_file_name ⇒ Object

This is ugly, but it gives us some added flexibility. Users can invoke the rspec_starter method from any script or executable. This method attempts to find out the name of the script/exectuable. “caller” returns the method stack, and because of the location of this file in the gem, we happen to be the 4th item in the the array (hence “caller” below).

This method may not return a pretty result in all cases, but it’s decent if the user has defined a script in their project (possibly in the bin folder, or root of the project).



34
35
36
37
38
 
# File 'lib/rspec_starter/legacy/help.rb', line 34

def calling_file_name
  # rubocop:disable Performance/Caller
  caller[3].split(":")[0]
  # rubocop:enable Performance/Caller
end

#should_show_help? ⇒ Boolean

Returns:

  • (Boolean) 


4
5
6
 
# File 'lib/rspec_starter/legacy/help.rb', line 4

def should_show_help?
  ARGV.any? { |option| option.include? "--help" }
end

#show_help ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/rspec_starter/legacy/help.rb', line 8

def show_help
  # Figure out the file name that invoked the rspec_starter helper.  This is the name of the script; it be called anything.
  script_name = calling_file_name
  puts "Usage: #{script_name.colorize(:light_blue)} #{'[options] [options for RSpec]'.colorize(:light_blue)}\n"
  puts "       #{script_name} will look for its own options first then pass any remaining options to rspec"

  # rubocop:disable Metrics/LineLength
  puts "\nOptions: (run 'rspec --help' to see RSpec's options)"
  puts "       #{'--no-xvfb'.colorize(:light_blue)}   DO NOT run XVFB (this can speed up RSpec when running tests that don't need XVFB)"
  puts "       #{'--no-prep'.colorize(:light_blue)}   DO NOT prepare the test database (can speed up testing if you know the DB is clean)"

  puts "\nExamples:"
  puts "       #{script_name.colorize(:light_blue)} #{'spec/features'.colorize(:light_blue)} (only run specs in the specs/features folder)"
  puts "       #{script_name.colorize(:light_blue)} #{'spec/features/some_spec:53'.colorize(:light_blue)} (run the spec on line 53 of the spec/features_some_spec.rb file)"
  puts "       #{script_name.colorize(:light_blue)} #{'--no-xvfb'.colorize(:light_blue)} #{'spec/requests/some_spec'.colorize(:light_blue)} (don't start XVFB since it's not needed for request specs)"
  puts "       #{'SIMPLECOV_FORMATTER=rcov'.colorize(:light_blue)} #{script_name.colorize(:light_blue)} (use with environment variables)\n"
  # rubocop:enable Metrics/LineLength
end