Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/camertron/rails-middleware-extensions
Adds several additional operations useful for customizing your Rails middleware stack.
https://github.com/camertron/rails-middleware-extensions
Last synced: 2 months ago
JSON representation
Adds several additional operations useful for customizing your Rails middleware stack.
- Host: GitHub
- URL: https://github.com/camertron/rails-middleware-extensions
- Owner: camertron
- License: mit
- Created: 2019-04-20T04:05:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-15T17:23:04.000Z (over 4 years ago)
- Last Synced: 2024-04-26T21:03:04.980Z (9 months ago)
- Language: Ruby
- Homepage:
- Size: 9.77 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## rails-middleware-extensions [](http://travis-ci.org/camertron/rails-middleware-extensions)
Adds several additional operations useful for customizing your Rails middleware stack.
## Installation
`gem install rails-middleware-extensions`
## Usage
Just add this gem to your gemfile like so:
```ruby
gem 'rails-middleware-extensions'
```
## Extensions
Currently two extensions are supported: `move` and `insert_unless_exists`.
### Insert Unless Exists
As the name implies, the given middleware will only be inserted if it has not already been added to the middleware stack. For example, here's how we might insert our custom `MyCustomMiddleware` middleware before `Rails::Logger`:
```ruby
config.middleware.insert_unless_exists(Rails::Logger, MyCustomMiddleware)
```
`#insert_unless_exists` supports all the arguments regular 'ol `#insert` supports, meaning you can also pass an index to insert before. Here's how to insert our custom middleware at the very beginning of the stack:
```ruby
config.middleware.insert_unless_exists(0, MyCustomMiddleware)
```
Finally, use `#insert_after_unless_exists` to insert a particular middleware _after_ another one. For example, to insert `MyCustomMiddleware` after `Rails::Logger`:
```ruby
config.middleware.insert_after_unless_exists(Rails::Logger, MyCustomMiddleware)
```
### Move
As of Rails 5.0, it's not possible to delete a middleware and then re-add it (see [this issue](https://github.com/rails/rails/issues/26303)) because delete operations are always applied last. Instead, consider using `#move`. For example, to move our custom middleware before `Rails::Logger`:
```ruby
config.middleware.move(Rails::Logger, MyCustomMiddleware)
```
Consider `#move`'s cousin, `#move_after`, to move a piece of middleware after another:
```ruby
config.middleware.move_after(Rails::Logger, MyCustomMiddleware)
```
As with `#insert_unless_exists`, `#move` and `#move_after` also support numeric indices:
```ruby
config.middleware.move(0, MyCustomMiddleware)
```
## Running Tests
`bundle exec rspec` should do the trick :) Rails-middleware extensions supports a number of Rails versions, hence all the Gemfiles. There is one Gemfile per supported Rails version. If you'd like to run tests against a particular version, use the `BUNDLE_GEMFILE` environment variable like so:
```bash
BUNDLE_GEMFILE=Gemfile-rails-4.1.x bundle exec rspec
```
By default tests will run against Rails 5.2.x.
## License
Licensed under the MIT license. See LICENSE for details.
## Authors
* Cameron C. Dutro: http://github.com/camertron