Snap-Style

Snapsheet shared style configurations.

Installation

Add this line to your application's Gemfile:

gem 'snap-style'

And then execute:

$ bundle

Or install it yourself as:

$ gem install snap-style

Also since this gem includes rubocop it should be removed from your projects Gemfile.

Usage

Inheriting from the gem

In your project create a .rubocop.yml with the following configuration:

inherit_gem:
  snap-style:
    - "rubocop/rubocop.yml"

To check your application against the new style configurations:

$ rubocop

Overriding Styles

If you chose to add some exceptions in your .rubocop.yml be aware it will completely override the snap-style's defaults. It is something to be aware of - especially if you are just looking to modify a style rules.

For example:

# In snap-style/rubocop.yml
AllCops:
  DisplayCopNames: true
  Exclude:
    - 'db/schema.rb'
    - 'config/**/*'
    - 'node_modules/**/*'

# In your project's .rubocop.yml
inherit_gem:
  snap-style:
    - "rubocop/rubocop.yml"

AllCops:
  DisplayCopNames: true
  Exclude:
    - 'log/**/*'

It would seem you can just add another folder when in reality you are overwriting the original folder list. You will need to add prior elements from snap-style in order to have correct style.

Codeclimate

Codeclimate enables github status checks for pull requests when there are rubocop errors. However codeclimate does not install dependencies on their containers, so in order to use this alongside codelimate we make use of a prepare fetch and second rubocop file:

# .codeclimate.yml
prepare:
  fetch:
    - url: "https://raw.githubusercontent.com/bodyshopbidsdotcom/snap-style/master/rubocop/rubocop.yml"
      path: ".rubocop-shared.yml"

# .rubocop-shared.yml
# NOTE: this file is only relevant locally. In codeclimate it gets overwritten by the snap-style gem from the prepare fetch

inherit_gem:
  snap-style:
    - "rubocop/rubocop.yml"

Then in your project's .rubocop.yml, change the inherit_gem part to this instead:

# .rubocop.yml
inherit_from:
  - "./.rubocop-shared.yml"

# any overrides that will be applied for the project:
# Metrics/ModuleLength:
#  Max: 150

Building/Publishing New Version

To release a new version, update the Snap::Style::VERSION version number in version.rb.

Then run gem build snap-style.gemspec to ensure it builds, then update the CHANGELOG.md and commit the version

Create and push tags:

$ git tag -a v{version} -m "Release {version}"
$ git push origin v{version}

Example:

$ git tag -a v1.0.0 -m "Release 1.0.0"
$ git push origin v1.0.0

Finally, publish the new version to the Github Package Registry (see https://snapsheettech.atlassian.net/wiki/spaces/TECH/pages/149946563/Github+Package+Registry):

gem push --key github --host https://rubygems.pkg.github.com/bodyshopbidsdotcom snap-style-<VERSION>.gem