Valley Rails Generator

The Valley Rails Generator is a project heavily based on suspenders by thoughtbot and used to generate our base rails applications at OSU Libraries & Press.

It includes our common testing solutions and what we consider "best practice" defaults.

Install the gem

gem install valley-rails-generator

To run the generator use:

valleyrailsgen projectname

This will create a Rails 3.2 app in projectname. This script creates a new git repository. It is not meant to be used against an existing repo.

The following are system dependencies required for this generator to work:

1. Ruby 1.9.2 or greater
2. PhantomJS (for capybara's poltergeist driver)

This generator installs a variety of gems, primarily for testing purposes.

1. RSpec for unit testing
2. Shoulda-Matchers for commonly used single-line rspec tests.
3. Factory Girl for factory generation.
4. Capybara for integration testing.
5. Poltergeist for headless javascript testing.
6. simplecov for test coverage reports.
7. Guard and guard-rspec for automated running of tests.
8. Spring for Rails preloading (integrated with guard-rspec).
9. Better_Errors for improved error pages in development.
10. Jazz Hands for a combination of pry tools to improve the Rails console in development.
11. Active Model Serializers for defining the JSON output of a model.
12. Yard for tag-based in-code documentation.
13. Simple Form for easier form generation.