https://github.com/roberts1000/autorequire_rails

A Rails engine that requires all ruby files in lib/autorequire when a Rails app boots
https://github.com/roberts1000/autorequire_rails

rails-engine ruby-gem ruby-on-rails

Last synced: about 2 months ago
JSON representation

A Rails engine that requires all ruby files in lib/autorequire when a Rails app boots

• Host: GitHub
• URL: https://github.com/roberts1000/autorequire_rails
• Owner: roberts1000
• License: mit
• Created: 2018-01-08T03:25:37.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-14T23:02:40.000Z (over 3 years ago)
• Last Synced: 2024-04-25T12:01:49.480Z (9 months ago)
• Topics: rails-engine, ruby-gem, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 85 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# autorequire_rails

autorequire_rails is a Rails engine that automatically requires all ruby files in `lib/autorequire` when a Rails app boots.

Why is this useful? Rails has multiple strategies for loading code and there are scenarios that can cause Rails to ignore files in `lib`. One example where this frequently arises is when trying to monkey patch a core ruby class. Many people create a file like `lib/string.rb` and expect Rails to autoload or eagerload it. However, out of the box, Rails isn't configured to reach into `lib` so the code won't get loaded. On top of that, even if Rails were configured to look in `lib`, it still wouldn't work. Constants, like the `String` constant, are always defined so Rails never thinks it needs to find additional files to load.

To solve these kinds of problems, you typically have to explicitly require files on your own. autorequire_rails saves you the trouble and establishes a pattern.

## Versioning Scheme

Releases are versioned using [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) with the following caveats:

1. Support for a Ruby version, that reaches EOL, is removed in a major or minor release.

1. Support for a Ruby on Rails version, that reaches EOL, is removed in a major or minor release.

## Supported Ruby Versions

Ruby 3.1+ 

## Supported Ruby on Rails Versions

Rails 7.1+

## Installation

Add this line to your Rails application's Gemfile:

```ruby

gem 'autorequire_rails'

```

And then execute:

    $ bundle

## Usage

Add any file with a `.rb` extension to the `lib/autorequire` folder (or a sub folder). Rails will automatically load it during the boot process.

## Recommendations

#### Recommended Folder Stricture

You can use any folder structure you like, but it is recommended to put ruby core classes in `lib/autorequire/core_ext` and extensions to gems in a folder like `lib/autorequire/gem_ext/`.

#### What to Put in lib/autorequire

Ultimately, `lib/autorequire` is useful for adding code **to constants that are already defined**. As a result, it's ideal for changes to 3rd party libraries and ruby core classes/modules. It can also be used to hold reusable code that can be shared between applications.

If you're defining **application specific** custom classes and modules, consider using a sub folder inside `app`. If you're defining a new constant (and the file name follow proper Rails naming rules), Rails will happily discover it when needed. `app/lib` is a sensible place to hold these kind of classes and modules.

## Contributing

Bug reports and pull requests are welcome on the autorequire_rails [issues](https://github.com/roberts1000/autorequire_rails/issues) page.