https://github.com/rolemodel/rolemodel_rails
Gem for generating new rails projects
https://github.com/rolemodel/rolemodel_rails
Last synced: about 1 year ago
JSON representation
Gem for generating new rails projects
- Host: GitHub
- URL: https://github.com/rolemodel/rolemodel_rails
- Owner: RoleModel
- License: mit
- Created: 2019-06-20T21:18:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T19:33:06.000Z (about 1 year ago)
- Last Synced: 2025-04-12T06:08:12.261Z (about 1 year ago)
- Language: Ruby
- Size: 1.11 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RoleModel Rails
Executable Best Practices for Rails apps, based on RoleModel's best approaches
Attempts to solve the pain of:
* Setup of a new Rails app is harder than it needs to be
* We've tried application templates, but only useful onetime
* Our BestPractice learns don't often get ported into other projects as it isn't straightforward to do so
* There is an emerging pattern of libraries using generators (e.g. webpacker) to migrate a setup between library versions
## Precondition
The rolemodel_rails gem expects to be added to an existing Rails project. Typically those are started with:
```shell
rails new --javascript=webpack --database=postgresql --skip-test
```
The Devise generator requires your database to exist before running.
```shell
rails db:create
```
## Installation
Add this line to your application's Gemfile:
```ruby
group :development do
gem 'rolemodel_rails', github: 'RoleModel/rolemodel_rails'
end
```
And then execute:
$ bundle
## Usage
Run all generators (useful on a new app)
```shell
bin/rails g rolemodel:all
```
Or run a single generator
```shell
bin/rails g rolemodel:webpack
```
Or run a category subset
```shell
bin/rails g rolemodel:testing:all
```
You can see complete list of available generators (including those under the RoleModel namespace) by running
```shell
bin/rails g
```
## Generators
* [Github](./lib/generators/rolemodel/github)
* [Semaphore](./lib/generators/rolemodel/semaphore)
* [Heroku](./lib/generators/rolemodel/heroku)
* [Readme](./lib/generators/rolemodel/readme)
* [Webpack](./lib/generators/rolemodel/webpack)
* [React](./lib/generators/rolemodel/react)
* [Slim](./lib/generators/rolemodel/slim)
* [Optics](./lib/generators/rolemodel/optics)
* [Base](./lib/generators/rolemodel/optics/base)
* [Icons](./lib/generators/rolemodel/optics/icons)
* [Testing](./lib/generators/rolemodel/testing)
* [RSpec](./lib/generators/rolemodel/testing/rspec)
* [Factory Bot](./lib/generators/rolemodel/testing/factory_bot)
* [Test Prof](./lib/generators/rolemodel/testing/test_prof)
* [SimpleForm](./lib/generators/rolemodel/simple_form)
* [SoftDestroyable](./lib/generators/rolemodel/soft_destroyable)
* [SaaS](./lib/generators/rolemodel/saas)
* [Devise](./lib/generators/rolemodel/saas/devise)
* [Mailers](./lib/generators/rolemodel/mailers)
* [Linters](./lib/generators/rolemodel/linters)
* [Rubocop](./lib/generators/rolemodel/linters/rubocop)
* [ESLint](./lib/generators/rolemodel/linters/eslint)
* [Modals](./lib/generators/rolemodel/modals)
* [Source Map](./lib/generators/rolemodel/source_map)
* [Kaminari](./lib/generators/rolemodel/kaminari)
* [GoodJob](./lib/generators/rolemodel/good_job)
* [Editors](./lib/generators/rolemodel/editors)
* [Tailored Select](./lib/generators/rolemodel/tailored_select)
* [Lograge](./lib/generators/rolemodel/lograge)
## Development
Install the versions of Node and Ruby specified in `.node-version` and `.ruby-version` on your machine. https://asdf-vm.com/ is a great tool for managing language versions. Then run `npm install -g yarn`.
We use the embeded Rails apps [Rails 8 Example](./recreate_rails8_example) to test the usage of the generators.
`recreate_rails8_example` is simply a freshly generated Rails 8 app. To recreate it use:
```shell
bin/recreate_rails8_example
```
Then, cd into `example_rails8` and run a rolemodel generator to see how it affects a new Rails 8 project. For example:
```shell
cd example_rails8
bin/rails g rolemodel:webpack
```
## Testing
Generator specs should be added to the [spec](./spec) directory.
Setup & Teardown of the test-dummy app is handled for you, but there are 2 things that each spec needs in order to work correctly.
1. A destination directory for the test-dummy app.
2. To have your generator run against the test-dummy app.
e.g.
```ruby
RSpec.describe Rolemodel::MyGenerator, type: :generator do
destination File.expand_path('tmp/', File.dirname(__FILE__))
before { run_generator_against_test_app }
end
```
Additional information about testing generators and the available assertions & matchers can be found at the following resources.
* [Rails Guide](https://guides.rubyonrails.org/generators.html#testing-generators)
* [API Documentation](https://api.rubyonrails.org/classes/Rails/Generators/Testing/Assertions.html)
* [Generator Spec Gem](https://github.com/stevehodgkiss/generator_spec)
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/RoleModel/rolemodel_rails.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).