rspec_starter 1.5.0 → 1.6.0

data/lib/rspec_starter/tasks/remove_tmp_folder.rb

@@ -0,0 +1,28 @@
+# RemoveTmpFolder deletes the tmp folder before RSpec runs.
+class RemoveTmpFolder < RspecStarterTask
+  def self.description
+    "Remove the #{'tmp'.colorize(:light_blue)} folder from the project."
+  end
+
+  # Let subsequent steps run if this task runs into a problem deleting the tmp folder. This value can be overridden in
+  # the applications bin/start_rspec file if the user adds 'stop_on_problem: true' to the task line.
+  def self.default_stop_on_problem
+    false
+  end
+
+  def starting_message
+    "Removing #{'tmp'.highlight} folder"
+  end
+
+  def execute
+    success "the tmp folder didn't exist" unless tmp_folder_exists?
+    system "rm -rf tmp/"
+    problem "the tmp folder could not be removed." if tmp_folder_exists?
+  end
+
+  private
+
+  def tmp_folder_exists?
+    File.exist?(File.join(Dir.pwd, "tmp"))
+  end
+end

data/lib/rspec_starter/tasks/start_rspec.rb

@@ -0,0 +1,68 @@
+# The step that actually starts the RSpec.
+class StartRspec < RspecStarterTask
+  def self.description
+    "Start RSpec."
+  end
+
+  def self.register_options
+    register_option name: "skip_display_server", default: false, switch: '--skip-display-server',
+                    switch_description: "DO NOT check for a display server",
+                    description: "true/false to enable/disable starting the display server"
+    register_option name: "command", default: "bundle exec rspec",
+                    description: "A command string that is used to start RSpec."
+  end
+
+  def self.default_quiet
+    false
+  end
+
+  def initialize(id, runner, options)
+    super
+
+    # Updated once task executes
+    @command = nil
+    @status = nil
+    @stdout = nil
+    @stderr = nil
+  end
+
+  def starting_message
+    "Running specs with '#{command.colorize(:light_blue)}'"
+  end
+
+  def execute
+    if quiet?
+      print @starting_message
+      @stdout, @stderr, @status = Open3.capture3(@command)
+    else
+      puts "\n\n"
+      @verbose_command_passed = system @command
+      @status = $CHILD_STATUS
+      print @starting_message
+    end
+
+    problem(exit_status: @status.exitstatus) if rspec_failed?
+  end
+
+  private
+
+  def rspec_failed?
+    @status.exitstatus > 0 || @verbose_command_passed == false
+  end
+
+  def command
+    @command ||= determine_command
+  end
+
+  def determine_command
+    cmd = enhanced_command
+    options.rspec_args_string.empty? ? cmd : cmd + " " + options.rspec_args_string
+  end
+
+  # Returns a string that will either be 'xvfb-run bundle exec rspec' or 'bundle exec rspec'
+  def enhanced_command
+    return options.command if RspecStarter.helpers.is_mac? || options.skip_display_server
+
+    RspecStarter.helpers.xvfb_installed? ? "xvfb-run #{options.command}" : options.command
+  end
+end

data/lib/rspec_starter/tasks/verify_display_server.rb

@@ -0,0 +1,43 @@
+# VerifyDisplayServer run tests on the display server. When feature tests run, they need a display server available to execute
+# the feature tests. MacOS provides its own display server that always runs. Linux needs one installed and activated. This
+# task is currently focused on the XVFB display server.
+class VerifyDisplayServer < RspecStarterTask
+  def self.description
+    "Test the installation of XVFB on Linux and ensure it is not installed on Macs."
+  end
+
+  def self.register_options
+    register_option default: false, switch: '--skip-display-server', switch_description: "DO NOT check for a display server"
+  end
+
+  # Let subsequent steps run if this task runs into a problem checking the display server. This value can be overridden in
+  # the applications bin/start_rspec file if the user adds 'stop_on_problem: true' to the task line.
+  def self.default_stop_on_problem
+    false
+  end
+
+  # The app's bin/start_rspec file might define this task, but the user can specific --skip-display-server at run time to
+  # dynamically disable the check.
+  def should_skip?
+    options.skip_display_server
+  end
+
+  def starting_message
+    "Verifying display server"
+  end
+
+  # rubocop:disable Style/IfUnlessModifier, Style/GuardClause
+  def execute
+    # Check if a Linux user is missing XVFB. XVFB is needed to run RSpec feature tests on Linux.
+    if helpers.is_linux? && helpers.xvfb_not_installed?
+      problem "XVFB isn't installed; feature specs will fail."
+    end
+
+    # Check if a Mac user has XVFB installed.  Macs have their own display server so xvfb is not needed. A dev might have
+    # mistakenly installed it so we can check just in case..
+    if helpers.is_mac? && helpers.xvfb_installed?
+      problem "XVFB is installed. (It's not needed on a Mac and may cause specs to fail.)"
+    end
+  end
+  # rubocop:enable Style/IfUnlessModifier, Style/GuardClause
+end

data/lib/rspec_starter/version.rb

@@ -1,3 +1,3 @@
 module RspecStarter
-  VERSION = "1.5.0".freeze
+  VERSION = "1.6.0".freeze
 end

data/lib/templates/rails_engine_start_rspec

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# Execute this script to run RSpec for the app.
+# To run all specs, navigate to the application's root folder and execute
+#   bin/start_rspec
+# rspec_starter takes command line options and forwards unknown options to rspec
+#   bin/start_rspec --no-prep-db spec/features
+# See the help output for more advanced ways to run the script
+#   bin/start_rspec --help
+
+require "bundler/setup"
+require "rspec_starter"
+
+# The path to the application's root folder.
+APP_ROOT = Pathname.new File.expand_path('../', __dir__)
+
+# Create a custom task. For more information about custom tasks, see
+# https://github.com/roberts1000/rspec_starter. Once defined, add
+# 'task :my_custom_task' to the start block to execute.
+#
+# class MyCustomTask < RspecStarterTask
+#   # Specify a message to show users when the task executes.
+#   def starting_message
+#     "Executing My Custom Task"
+#   end
+#
+#   # Execute task code.
+#   def execute
+#   end
+# end
+
+# Tasks are run from the top down.
+RspecStarter.start do
+  task :verify_display_server
+  task :remove_tmp_folder
+  task :rebuild_rails_app_database
+  task :start_rspec
+end

data/lib/templates/rails_start_rspec

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# Execute this script to run RSpec for the app.
+# To run all specs, navigate to the application's root folder and execute
+#   bin/start_rspec
+# rspec_starter takes command line options and forwards unknown options to rspec
+#   bin/start_rspec --no-prep-db spec/features
+# See the help output for more advanced ways to run the script
+#   bin/start_rspec --help
+
+require "bundler/setup"
+require "rspec_starter"
+
+# The path to the application's root folder.
+APP_ROOT = Pathname.new File.expand_path('../', __dir__)
+
+# Create a custom task. For more information about custom tasks, see
+# https://github.com/roberts1000/rspec_starter. Once defined, add
+# 'task :my_custom_task' to the start block to execute.
+#
+# class MyCustomTask < RspecStarterTask
+#   # Specify a message to show users when the task executes.
+#   def starting_message
+#     "Executing My Custom Task"
+#   end
+#
+#   # Execute task code.
+#   def execute
+#   end
+# end
+
+# Tasks are run from the top down.
+RspecStarter.start do
+  task :verify_display_server
+  task :remove_tmp_folder
+  task :rebuild_rails_app_database
+  task :start_rspec
+end

data/lib/templates/start_rspec

@@ -14,9 +14,24 @@ require "rspec_starter"
 # The path to the application's root folder.
 APP_ROOT = Pathname.new File.expand_path('../', __dir__)
 
-# Run commands in the context of the application's root folder.
-Dir.chdir APP_ROOT do
-  # Arguments passed to 'start' define the steps needed to cleanly run RSpec.
-  # Command line options may change execution on a per-run basis.
-  RspecStarter.start(prepare_db: true, remove_tmp: true, allow_xvfb: true)
+# Create a custom task. For more information about custom tasks, see
+# https://github.com/roberts1000/rspec_starter. Once defined, add
+# 'task :my_custom_task' to the start block to execute.
+#
+# class MyCustomTask < RspecStarterTask
+#   # Specify a message to show users when the task executes.
+#   def starting_message
+#     "Executing My Custom Task"
+#   end
+#
+#   # Execute task code.
+#   def execute
+#   end
+# end
+
+# Tasks are run from the top down.
+RspecStarter.start do
+  task :verify_display_server
+  task :remove_tmp_folder
+  task :start_rspec
 end

data/rspec_starter.gemspec

@@ -20,10 +20,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "pry-byebug", "~> 3.6.0"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.7.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
+  spec.add_dependency "activesupport", ">= 5.2.2"
   spec.add_dependency "colorize", "~> 0.8.1"
   spec.add_dependency "cri", "~> 2.0"
+  spec.add_dependency "os", "~> 1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_starter
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Roberts
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: A Ruby gem that helps run RSpec in a standard manner.
 email:
 - roberts@corlewsolutions.com
@@ -115,16 +143,38 @@ files:
 - bin/setup
 - exe/rspec_starter
 - lib/rspec_starter.rb
+- lib/rspec_starter/command.rb
+- lib/rspec_starter/command_context.rb
 - lib/rspec_starter/core_ext/string.rb
+- lib/rspec_starter/environment.rb
+- lib/rspec_starter/errors/step_error.rb
+- lib/rspec_starter/errors/step_stopper.rb
 - lib/rspec_starter/help.rb
+- lib/rspec_starter/helpers.rb
+- lib/rspec_starter/helpers/which.rb
+- lib/rspec_starter/legacy.rb
+- lib/rspec_starter/legacy/help.rb
+- lib/rspec_starter/legacy/legacy_runner.rb
+- lib/rspec_starter/legacy/steps/invoke_rspec_step.rb
+- lib/rspec_starter/legacy/steps/prepare_database_step.rb
+- lib/rspec_starter/legacy/steps/remove_tmp_folder_step.rb
+- lib/rspec_starter/legacy/steps/step.rb
+- lib/rspec_starter/legacy/steps/verify_xvfb_step.rb
+- lib/rspec_starter/option.rb
+- lib/rspec_starter/options.rb
+- lib/rspec_starter/rspec_starter_task.rb
 - lib/rspec_starter/runner.rb
-- lib/rspec_starter/steps/invoke_rspec_step.rb
-- lib/rspec_starter/steps/prepare_database_step.rb
-- lib/rspec_starter/steps/remove_tmp_folder_step.rb
-- lib/rspec_starter/steps/step.rb
-- lib/rspec_starter/steps/verify_xvfb_step.rb
+- lib/rspec_starter/step.rb
+- lib/rspec_starter/step_context.rb
+- lib/rspec_starter/step_options.rb
+- lib/rspec_starter/task_context.rb
+- lib/rspec_starter/tasks/rebuild_rails_app_database.rb
+- lib/rspec_starter/tasks/remove_tmp_folder.rb
+- lib/rspec_starter/tasks/start_rspec.rb
+- lib/rspec_starter/tasks/verify_display_server.rb
 - lib/rspec_starter/version.rb
-- lib/rspec_starter/which.rb
+- lib/templates/rails_engine_start_rspec
+- lib/templates/rails_start_rspec
 - lib/templates/start_rspec
 - rspec_starter.gemspec
 homepage: https://github.com/roberts1000/rspec_starter
@@ -145,8 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A Ruby gem that helps run RSpec in a standard manner.