how-we-ruby

Quick-referencing guidelines for working with ruby on rails

What is this repository for?

Quick-referencing our current rails stack on Superintendência de Tecnologia da Informação - Universidade Federal Fluminense (STI-UFF, for short)

Ruby

• ruby 2.1.5 or higher
• rvm with .ruby-version and .ruby-gemset instead of .rvmrc

Code quality checks

"All code in any code-base should look like a single person typed it, no matter how many people contributed."

• Style Guide: Shortened version of the ruby community style guide
• Linting: Rubocop
• Query analysis: Bullet
• Code quality: Rubycritic
• Security Checks: Brakeman

Gems:

• Framework: Ruby on Rails (>= 4.2)
• Database: Mysql (mysql2) (Change this to what suits your case better)
• Internal authentication: portal-sso (Internal solution)
• Non-university authentication: Devise
• Authorization: CanCanCan
• Pagination: Kaminari or will_paginate
• PDF: Prawn
• Dynamic nested forms: cocoon

Testing:

• testing framework: rspec-rails, shoulda-matchers, factory-girl-rails
• testing webservices: vcr
• integration: capybara with selenium-webdriver (no cucumber)
• page opening: launchy
• email testing: email-spec

Contributing

We really appreciate your contribution, just read the follow guidelines to do it.