Skip to content
This repository has been archived by the owner on Feb 19, 2025. It is now read-only.

Commit

Permalink
Add rubocop rules
Browse files Browse the repository at this point in the history
Use ADRL rubocop config
  • Loading branch information
bess committed Dec 4, 2018
1 parent 97478c4 commit 84d0db7
Show file tree
Hide file tree
Showing 9 changed files with 349 additions and 8 deletions.
97 changes: 97 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,102 @@
require: rubocop-rspec
inherit_from: .rubocop_todo.yml

AllCops:
DisplayCopNames: true
TargetRubyVersion: 2.3
Exclude:
- '**/*~'
- 'db/**/*'
- 'tmp/**/*'
- 'provisioning/**/*'
- 'vendor/bundle/**/*'

Layout/IndentationConsistency:
EnforcedStyle: rails

Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented

Metrics/BlockLength:
ExcludedMethods:
- before
- config
- configure
- configure_blacklight
- context
- describe
- draw
- feature
- it
- let
- namespace
- scenario
- setup
- task

Metrics/ClassLength:
# Vocabulary classes are auto-generated so we don't have much
# control over length
Exclude:
- 'lib/vocabularies/*'

Metrics/LineLength:
Exclude:
- 'lib/vocabularies/*'
- 'spec/indexers/image_indexer_spec.rb'

Metrics/ModuleLength:
Enabled: false

Naming/HeredocDelimiterNaming:
Enabled: false

Rails:
Enabled: true

Rails/ActiveRecordAliases:
# this class has its own #update_attributes method
Exclude:
- 'lib/importer/factory/object_factory.rb'

Rails/ApplicationRecord:
Enabled: false

Style/ClassAndModuleChildren:
EnforcedStyle: compact
# Vocabulary classes are auto-generated
Exclude:
- 'lib/vocabularies/*'
- 'config/**/**'

Style/Documentation:
# Vocabulary classes are auto-generated
Exclude:
- 'lib/vocabularies/*'
- 'spec/**/*'

Style/Lambda:
EnforcedStyle: lambda

# RSpec's `include` method causes this to false-positive
Style/MixinGrouping:
Exclude:
- 'spec/**/*'

Style/MultilineBlockChain:
Enabled: false

Style/StringLiterals:
EnforcedStyle: double_quotes

Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes

Style/SymbolArray:
EnforcedStyle: brackets

Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: consistent_comma

Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: consistent_comma
220 changes: 220 additions & 0 deletions .rubocop_todo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2018-12-04 08:59:13 -0500 using RuboCop version 0.60.0.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
# Include: **/*.gemfile, **/Gemfile, **/gems.rb
Bundler/OrderedGems:
Exclude:
- 'Gemfile'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnabledMethods.
Capybara/FeatureMethods:
Exclude:
- 'spec/features/create_exhibit_spec.rb'

# Offense count: 1
# Cop supports --auto-correct.
Layout/CommentIndentation:
Exclude:
- 'spec/spec_helper.rb'

# Offense count: 1
# Cop supports --auto-correct.
Layout/EmptyLineAfterGuardClause:
Exclude:
- 'lib/parse.rb'

# Offense count: 3
# Cop supports --auto-correct.
Layout/EmptyLineAfterMagicComment:
Exclude:
- 'config/deploy/cd.rb'
- 'config/deploy/localhost.rb'
- 'config/deploy/qa.rb'

# Offense count: 1
# Cop supports --auto-correct.
Layout/EmptyLines:
Exclude:
- 'spec/rails_helper.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: empty_lines, no_empty_lines
Layout/EmptyLinesAroundBlockBody:
Exclude:
- 'lib/importer/exhibit.rb'

# Offense count: 1
# Cop supports --auto-correct.
Layout/LeadingBlankLines:
Exclude:
- 'lib/importer/exhibit.rb'

# Offense count: 3
Metrics/AbcSize:
Max: 44

# Offense count: 1
# Configuration parameters: CountComments, ExcludedMethods.
# ExcludedMethods: refine
Metrics/BlockLength:
Max: 30

# Offense count: 1
Metrics/CyclomaticComplexity:
Max: 7

# Offense count: 6
# Configuration parameters: CountComments, ExcludedMethods.
Metrics/MethodLength:
Max: 32

# Offense count: 1
# Configuration parameters: EnforcedStyleForLeadingUnderscores.
# SupportedStylesForLeadingUnderscores: disallowed, required, optional
Naming/MemoizedInstanceVariableName:
Exclude:
- 'config/initializers/ldap_authenticatable.rb'

# Offense count: 1
# Configuration parameters: Prefixes.
# Prefixes: when, with, without
RSpec/ContextWording:
Exclude:
- 'spec/features/create_exhibit_spec.rb'

# Offense count: 1
# Configuration parameters: Max.
RSpec/ExampleLength:
Exclude:
- 'spec/features/create_exhibit_spec.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: implicit, each, example
RSpec/HookArgument:
Exclude:
- 'spec/rails_helper.rb'

# Offense count: 1
# Configuration parameters: AggregateFailuresByDefault.
RSpec/MultipleExpectations:
Max: 6

# Offense count: 1
# Configuration parameters: EnforcedStyle.
# SupportedStyles: slashes, arguments
Rails/FilePath:
Exclude:
- 'config/environments/development.rb'

# Offense count: 1
Rails/OutputSafety:
Exclude:
- 'config/initializers/explain.rb'

# Offense count: 5
# Cop supports --auto-correct.
# Configuration parameters: AutoCorrect, EnforcedStyle.
# SupportedStyles: nested, compact
Style/ClassAndModuleChildren:
Exclude:
- 'lib/vocabularies/*'
- 'app/channels/application_cable/channel.rb'
- 'app/channels/application_cable/connection.rb'
- 'config/application.rb'
- 'config/initializers/ldap_authenticatable.rb'

# Offense count: 17
Style/Documentation:
Enabled: false

# Offense count: 1
# Cop supports --auto-correct.
Style/ExpandPathArguments:
Exclude:
- 'spec/rails_helper.rb'

# Offense count: 48
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: when_needed, always, never
Style/FrozenStringLiteralComment:
Enabled: false

# Offense count: 1
# Cop supports --auto-correct.
Style/IfUnlessModifier:
Exclude:
- 'app/models/user.rb'

# Offense count: 2
Style/MixinUsage:
Exclude:
- 'bin/setup'
- 'bin/update'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: only_raise, only_fail, semantic
Style/SignalException:
Exclude:
- 'config/initializers/ldap_authenticatable.rb'

# Offense count: 270
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiterals:
Enabled: false

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: single_quotes, double_quotes
Style/StringLiteralsInInterpolation:
Exclude:
- 'bin/import'
- 'bin/yarn'
- 'config/initializers/git_sha.rb'
- 'config/initializers/ldap_authenticatable.rb'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: .
# SupportedStyles: percent, brackets
Style/SymbolArray:
EnforcedStyle: percent
MinSize: 4

# Offense count: 7
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyleForMultiline.
# SupportedStylesForMultiline: comma, consistent_comma, no_comma
Style/TrailingCommaInHashLiteral:
Exclude:
- 'app/controllers/catalog_controller.rb'
- 'config/environments/development.rb'
- 'config/environments/test.rb'
- 'config/initializers/ldap_authenticatable.rb'
- 'lib/importer/exhibit.rb'
- 'lib/tasks/ci.rake'

# Offense count: 70
# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
# URISchemes: http, https
Metrics/LineLength:
Max: 152
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ group :development, :test do
gem 'pry'
gem 'pry-doc'
gem 'rspec-rails'
gem 'rubocop-rails_config'
gem 'rubocop-rspec'
gem 'selenium-webdriver'
gem 'shoulda-matchers'
gem 'solr_wrapper', '>= 0.3'
Expand Down
Loading

0 comments on commit 84d0db7

Please sign in to comment.