Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/airslie/engineer
Renalware plugin helper
https://github.com/airslie/engineer
Last synced: about 1 month ago
JSON representation
Renalware plugin helper
- Host: GitHub
- URL: https://github.com/airslie/engineer
- Owner: airslie
- License: mit
- Created: 2019-02-07T21:36:05.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-04-12T06:32:08.000Z (almost 2 years ago)
- Last Synced: 2024-08-09T18:18:13.880Z (5 months ago)
- Language: Ruby
- Homepage:
- Size: 60.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
[](https://codeclimate.com/github/airslie/engineer/maintainability)
[](https://codeclimate.com/github/airslie/engineer/test_coverage)
# Engineer
This gem makes developing a Renalware plugin (a Rails engine) a little easier.
It does most of the standard Engine initialization including:
- appending the engine's `db/migrate`, `db/triggers`, `db/functions` and `db/views` paths to the
application's `config.paths` so that migrations across all engines and the app itself - and any
sql definition files referenced in migrations - can be found during a `db:migrate`
- loading any `config/locale/**/*.yml` that exist in the engine.
- more to follow..
## Usage
In your Rails engine add the following to `lib/xxxx/engine.rb`:
```ruby
class Engine < ::Rails::Engine
isolate_namespace Renalware::Xxxx
include Engineer::DefaultInitializers
...
end
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'engineer'
```
And then execute:
```bash
$ bundle
```
# Development Tasks
- [ ] Add tests
- [ ] Add a generator to bring in standard files for a new Renalware plugin
- [ ] Look for other Engine boiler-plate code we can move here.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).