Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 1.86 KB

README.md

File metadata and controls

53 lines (31 loc) · 1.86 KB
Raw

Trailblazer::Rails

Trailblazer in your Rails controllers.

Build Status Gem Version

Endpoint

This gem is slowly being superseded by TRB's endpoint gem. Endpoints are "controller operations" that invoke your business logic operation. They are much easier to use and customize and are explained in part II of the BUILDALIB book.

Overview

trailblazer-rails helps you with the following.

  • Running operations in your controller actions.
  • Minimalistic integration tests ("smoke tests") to test controller/operation wiring.
  • Rendering cells instead of an ActionView in a controller action.

Please refer to the full documentation for more.

Installation

Add this line to your application's Gemfile:

gem 'trailblazer-rails'

Note that the 2.x version only runs with TRB >= 2.1.0.

Setting flags

Before trailblazer-rails 2.3.0 you could activate or disable the trailblazer-loader gem. In versions >= 2.3.0 this component has been removed in favor of Rails autoloading.

  • config.trailblazer.enable_loader = false to disable Trailblazer loader (default TRUE)
  • config.trailblazer.enable_tracing = true to enable tracing when using run (default FALSE)

Testing

If you feel like contributing, you can run the test suite per Rails version as follows.

$ BUNDLE_GEMFILE=gemfiles/rails_7.0.gemfile bundle exec rake db:create db:schema:load test

Successful merges will be rewarded with at least one beer!

License

The gem is available as open source under the terms of the MIT License.