https://github.com/instructure/guardrail

ActiveRecord extension to allow multiple database environments (secondary, deploy) enabling least privilege when possible.
https://github.com/instructure/guardrail

Last synced: about 1 year ago
JSON representation

ActiveRecord extension to allow multiple database environments (secondary, deploy) enabling least privilege when possible.

• Host: GitHub
• URL: https://github.com/instructure/guardrail
• Owner: instructure
• License: mit
• Created: 2013-03-29T19:29:24.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2025-03-21T23:49:34.000Z (about 1 year ago)
• Last Synced: 2025-03-29T21:03:13.391Z (about 1 year ago)
• Language: Ruby
• Homepage:
• Size: 66.4 KB
• Stars: 17
• Watchers: 13
• Forks: 15
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
GuardRail

==========

## About

GuardRail is a thin wrapper around Rail 6.1's native role switching.

## Installation

Add `gem 'guardrail'` to your Gemfile.

## Usage

See https://guides.rubyonrails.org/active_record_multiple_databases.html. GuardRail simply adds

syntactic sugar to easily switch to different roles:

```ruby

def some_method

  GuardRails.activate(:secondary) do

    MyModel.some_really_long_query

  end

end

```

Additionally you can include GuardRail::HelperMethods and use several helpers

to execute methods on specific environments:

```ruby

class SomeModel

  include GuardRail::HelperMethods

  def expensive_read_only

    ...

  end

  guard_rail_method :expensive_read_only, environment: :replica

  def self.class_level_expensive_read_only

    ...

  end

  guard_rail_class_method :class_level_expensive_read_only, environment: :replica

  # helpers for multiple methods are also available

  guard_rail_methods :instance_method_foo, :instance_method_bar, environment: :replica

  guard_rail_class_methods :class_method_foo, :class_method_bar, environment: :replica

end

```