Skip to content

3 Executing the Tools

Lazaro Herrera edited this page May 28, 2017 · 3 revisions

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

This page has been written at the "highly proficient 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"

Additionally, they should have an installation of:

  1. bundler-audit
  2. brakeman
  3. rails-bestpractices

If the previous does not sound like you, maybe you should head to the "Installing the Tools" page.

Care will be taken to provide "plain English" documentation, but without using excessive "nerd English". There will very few pictures in this page, I will show just the first few lines. The complete execution logs will go under "Execution Output"

Executing bundler-audit

  1. Open your terminal and move to the project folder.
  2. Execute the command bundle-audit. Run bundle-audit

Executing brakeman

  1. Open your terminal and move to the project folder.
  2. Execute the command brakeman. Run brakeman

Executing rails-bestpractices

  1. Open your terminal and move to the project folder.
  2. Execute the command rails-best-practices .. Run rails-best-practices .

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.)

Clone this wiki locally