rubocop-betterment 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b10cf1d3a3bef89c85b5a7f08a0a01b95714d482
+  data.tar.gz: f57b6cdd276dbe147956aeb1713078f55a853df3
+SHA512:
+  metadata.gz: 870b5f8c0f8826e2f4084aedfc51917ba3c996721006536de5c16046474f0d223f492de9b7b15d241442c77f5ecd615c86cbc265e2f08ba56358c7213e4b9c06
+  data.tar.gz: bf9806bdf1d6811256f4babef01910e4624624fa16039c6f443f668aa8ef844c5703f2931bd1dc128a3568f453fa7f28439b4be81577d5f455c17aaf0208022e

data/README.md

@@ -0,0 +1,25 @@
+# RuboCop Betterment [![Build Status](https://travis-ci.com/Betterment/rubocop-betterment.svg?token=6b6DErRMUHX47kEoBZ3t&branch=master)](https://travis-ci.com/Betterment/rubocop-betterment)
+
+Shared rubocop configuration for Betterment Rails apps/engines.
+
+Check out the [styleguide](STYLEGUIDE.md) for some additional commentary on our cop configurations.
+
+## Installation
+
+Gemfile:
+
+```ruby
+gem 'rubocop-betterment'
+```
+
+.rubocop.yml:
+
+```yml
+inherit_gem:
+  rubocop-betterment:
+    - config/default.yml
+```
+
+## Custom Cops:
+
+All cops are located under [`lib/rubocop/cop/betterment`](lib/rubocop/cop/betterment)

data/STYLEGUIDE.md

@@ -0,0 +1,70 @@
+# Style Guide
+
+## Block Delimeters for multi-line chaining
+
+Prefer {...} over do...end for multi-line chained blocks.
+
+We use the enforced style `braces_for_chaining`.
+
+For example:
+
+### BAD:
+
+```ruby
+array_of_things.each do |thing|
+  thing if thing.condition?
+end.compact
+```
+
+### GOOD:
+
+```ruby
+array_of_things.each { |thing|
+  thing if thing.condition?
+}.compact
+```
+
+## Timeout.timeout needs custom exception
+
+If we use `Timeout.timeout` without a custom exception, rescue blocks may be prevented from executing.
+
+For example:
+
+### BAD:
+
+```ruby
+Timeout.timeout(run_timeout)
+```
+
+### GOOD:
+
+```ruby
+Timeout.timeout(run_timeout, SomeModule::SomeError)
+```
+
+## Rails/OutputSafety
+
+We explictly enabled the `Rails/OutputSafety` cop to ensure its usage. It prevents usage of `raw`, `html_safe`, or `safe_concat` unless they are explicitly disabled.
+
+This [blog post](https://engineering.betterment.qa/2017/05/15/unsafe-html-rendering.html) explains our feelings on unsafe HTML rendering.
+
+## Use parentheses for percent literal delimeters
+
+We enforce usage of parentheses for all percent literal delimeters besides `%r` (the macro for regexps) for which we use curly braces.
+
+### GOOD:
+
+```ruby
+%w(one two three)
+%i(one two three)
+%r{(\w+)-(\d+)}
+```
+
+### BAD:
+
+```ruby
+%w[one two three]
+%i[one two three]
+%w!one two three!
+%r((\w+)-(\d+))
+```

data/config/default.yml

@@ -0,0 +1,154 @@
+# please keep this file alphabetically ordered!
+
+require: rubocop/cop/betterment
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'vendor/**/*'
+    - 'frontend/**/*'
+    - 'build/**/*'
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'Gemfile'
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+
+Layout/AlignParameters:
+  Enabled: false
+
+Layout/CaseIndentation:
+  IndentOneStep: true
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/BooleanSymbol:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 250
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 140
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ModuleLength:
+  Max: 250
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'spec/**/*'
+
+Performance/RedundantMatch:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+Rails/Delegate:
+  EnforceForPrefixed: false
+
+Rails/FindEach:
+  Enabled: false
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+Rails/OutputSafety:
+  Enabled: true
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/LambdaCall:
+  Exclude:
+    - 'app/views/**/*.jbuilder'
+
+Style/MissingElse:
+  Enabled: true
+  EnforcedStyle: case
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i': '()'
+    '%I': '()'
+    '%r': '{}'
+    '%w': '()'
+    '%W': '()'
+
+Naming/PredicateName:
+  NamePrefix:
+    - is_
+  NamePrefixBlacklist:
+    - is_
+
+Style/SignalException:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/YodaCondition:
+  Enabled: false

data/lib/rubocop/cop/betterment.rb

@@ -0,0 +1 @@
+require 'rubocop/cop/betterment/timeout'

data/lib/rubocop/cop/betterment/timeout.rb

@@ -0,0 +1,18 @@
+module RuboCop
+  module Cop
+    module Betterment
+      class Timeout < Cop
+        MSG = 'Using Timeout.timeout without a custom exception can prevent rescue blocks from executing'.freeze
+
+        def on_send(node)
+          target_receiver = s(:const, nil, :Timeout)
+          target_method = :timeout
+
+          if node.receiver == target_receiver && node.method_name == target_method && node.arguments.one?
+            add_offense(node, location: node.source_range)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-betterment
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Development
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Betterment rubocop configuration
+email:
+- development@betterment.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- STYLEGUIDE.md
+- config/default.yml
+- lib/rubocop/cop/betterment.rb
+- lib/rubocop/cop/betterment/timeout.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Betterment rubocop configuration
+test_files: []