2 Installing the Tools

This is the second page of the wiki, and will deal with the installation of tools for running code analysis.

This page has been written at the "highly technical manager" level, with the assumptions that they

1. "know what Github is"
2. "know what code is"

The assumption is that they additionally have

1. "a copy of Github Desktop"
2. "an updated version of ruby"
3. "know how to open their local Terminal in their MacBook and install / execute command-line software"
4. "an understanding of basic Linux functions / how to navigate folders"

If the previous does not sound like you, maybe you should head to the "Getting Started" page

Care will be taken to provide "plain English" documentation, but without using excessive "nerd English". Pictures will only be added for sections that are not showing in the "Getting Started" page.

Install Bundler-Audit

bundler-audit is a ruby gem designed for "Patch-level verification for Bundler."

1. Open the terminal and navigate to the project
2. Run the gem install bundler-audit command

Install Brakeman

Brakeman is an open source static analysis tool which checks Ruby on Rails applications for security vulnerabilities. They have a sexy Pro version that is highly recommended if you do anything relating to Rails that requires high security, but be warned, it costs money.

1. Open the terminal and navigate to the project
2. Run the gem install brakeman command

Install Rails Best Practices

Rails Best Practices is a code metric tool to check the quality of Rails code.

1. Open the terminal and navigate to the project
2. Run the gem install rails_best_practices command

Per the installation, you should consider checking out the rails-bestpractices site before running the tool (there is a lot of stuff there that just couldn't be included that may apply to your company's code, and certain sections in this project just aren't picked up by it.)