rspec_configuration.md

RSpec Configuration

Because you will probably want to run RSpec tests that rely on compiled webpack assets (typically, your integration/feature specs where js: true), you will want to ensure you don't accidentally run tests on missing or stale webpack assets. If you did use stale Webpack assets, you will get invalid test results as your tests do not use the very latest JavaScript code.

ReactOnRails provides a helper method called ReactOnRails::TestHelper.configure_rspec_to_compile_assets. Call this method from inside of the RSpec.configure block in your spec/rails_helper.rb file, passing the config as an argument. See file lib/react_on_rails/test_helper.rb for more details. You can customize this to your particular needs by replacing any of the default components used by ReactOnRails::TestHelper.configure_rspec_to_compile_assets.

RSpec.configure do |config|
  # Next line will ensure that assets are built if webpack -w is not running to build the bundles
  ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)

You can pass an RSpec metatag as an optional second parameter to this helper method if you want this helper to run on examples other than where js: true (default). The helper will compile webpack files at most once per test run. The helper will not compile the webpack files unless they are out of date (stale).

Please take note of the following:

• This utility assumes your build tasks for the static generated files are npm run build:client and npm run build:server and do not have the --watch option enabled.
• By default, the webpack processes look for the app/assets/javascripts/generated and app/assets/stylesheets/generated folders. If these folders are missing, are empty, or contain files with mtimes older than any of the files in your client folder, the helper will recompile your assets. You can override this inside of config/initializers/react_on_rails.rb by passing an array of filepaths (relative to the root of the app) to the generated_assets_dirs configuration option.

If you want to speed up the re-compiling process, you can call npm run build:dev:client (and npm run build:dev:server if doing server rendering) to have webpack run in "watch" mode and recompile these files in the background, which will be much faster when making incremental changes than compiling from scratch.

If you want to use a testing framework other than RSpec, please submit let us know on the changes you need to do and we'll update the docs.