altmetric / house_style Goto Github PK

It is possible for Rails apps to not have a db folder (e.g., if the app consumes only JSON API requests for display and has no DB persistence of its own).

In such situations, the Rails generator should not include the database-specific YAML file template.

Currently, running rails generate house_style:install creates new .rubocop.yml files with the relevant inheritance commands to set up the use of house_style.

However, when adding the gem to existing projects, we should really accommodate existing Rubocop settings. While we want all projects to be written to a consistent style, that's not always practical – hence why the Rubocop documentation provides an example workflow of creating a .rubocop_todo.yml file to accommodate existing style violations.

In the house_style:install process, we should maybe perform the same process for each .rubocop.yml file that we are creating:

1. If a .rubocop.yml file exists in that location, insert a inherit_from: block at the top of the file so that the house_style defaults are handled first, and are then overridden by existing rules.
2. If no file exists in the desired location, create them from the templates (as now).

This is consistent with the way in which house_style is intended to be used – a centralised "ideal" set of rules, and local overrides that explicitly set out where a project is currently diverging from those.

Implementing house_style on an internal project, I noticed that the following line triggered a warning in our configured Style/BlockDelimiters cop

specify { should_not render_template(:show) }

Changing to it did not trigger the warning:

it { should_not render_template(:show) }

it is in the cop's IgnoredMethods collection, along with lambda and proc. specify should be treated the same.