Undercarriage

*Undercarriage is currently under development. It is not ready for production use.*

Undercarriage is a set of concerns to add to your application to trim some of the fat from controllers and models.

• Ruby >= 2.6
• Rails >= 6.0

Add to your application's Gemfile

gem 'undercarriage', '~> 0.5'

Run the bundle command

$ bundle install

TODO

• Allow a way to set locale instead of relying on browser preferred language in Undercarriage::Controllers::LocaleConcern
• Add support for Rails 5.2

Run tests with one of the following

$ bundle exec rspec
$ bundle exec rspec spec

Undercarriage uses Appraisal to ensure various dependency versions work as expected

When dependencies change, run

$ bundle exec appraisal install

To run tests with Appraisal, run

$ bundle exec appraisal rspec

To run tests with a specific version of Appraisal, run

$ bundle exec appraisal rails-60 rspec
$ bundle exec appraisal rails-61 rspec

Various tools are used to ensure code is linted and formatted correctly.

RuboCop is a Ruby static code analyzer.

$ rubocop

Yard is used to generate documentation. Online documentation is available

Build the documentation with one of the following

$ yard
$ yard doc

Build the documentation and list all undocumented objects

$ yard stats --list-undoc

The gem is available as open source under the terms of the MIT License.

1. Fork it (https://github.com/dfreerksen/undercarriage/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request