Module: TurboRspec

Defined in:
lib/turbo_rspec.rb,
lib/turbo_rspec/helpers.rb,
lib/turbo_rspec/version.rb,
lib/turbo_rspec/matchers.rb,
lib/turbo_rspec/assertions.rb,
lib/turbo_rspec/configuration.rb,
lib/turbo_rspec/capybara/matchers.rb,
lib/turbo_rspec/matchers/have_turbo_frame.rb,
lib/turbo_rspec/matchers/have_turbo_stream.rb,
lib/turbo_rspec/matchers/have_turbo_streams.rb,
lib/generators/turbo_rspec/install_generator.rb,
lib/turbo_rspec/capybara/matchers/have_turbo_frame.rb,
lib/turbo_rspec/capybara/matchers/have_turbo_stream_tag.rb,
lib/turbo_rspec/matchers/have_broadcasted_turbo_stream_to.rb

Overview

TurboRspec provides RSpec matchers and Minitest assertions for turbo-rails.

Examples:

Configure auto-include

TurboRspec.configure do |config|
  config.auto_include = false
end

Defined Under Namespace

Modules: Assertions, Capybara, Generators, Helpers, Matchers Classes: Configuration, Error

Constant Summary collapse

VERSION = 
"1.0.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

Returns the global configuration instance.

Returns:



38
39
40
 
# File 'lib/turbo_rspec.rb', line 38

def configuration
  @configuration ||= Configuration.new
end

.configure {|config| ... } ⇒ void

This method returns an undefined value.

Yields the configuration object for customization.

Examples:

TurboRspec.configure do |config|
  config.auto_include = false
end

Yield Parameters:



31
32
33
 
# File 'lib/turbo_rspec.rb', line 31

def configure
  yield configuration
end

.install_rspec_integration(config) ⇒ void

This method returns an undefined value.

Installs RSpec integration — includes matchers and helpers into the appropriate example groups. Called automatically when RSpec is present.

Parameters:

  • config (RSpec::Core::Configuration) 


54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/turbo_rspec.rb', line 54

def install_rspec_integration(config)
  return unless configuration.auto_include && Gem.loaded_specs.key?("turbo-rails")
  config.include Matchers, type: :request
  config.include Matchers, type: :controller
  config.include Helpers, type: :request
  config.include Helpers, type: :controller
  if Gem.loaded_specs.key?("capybara")
    config.include Capybara::Matchers, type: :system
    config.include Capybara::Matchers, type: :feature
  end
end

.reset_configuration! ⇒ void

This method returns an undefined value.

Resets configuration to defaults. Primarily for use in test suites.



45
46
47
 
# File 'lib/turbo_rspec.rb', line 45

def reset_configuration!
  @configuration = Configuration.new
end