radius-spec 0.6.0 → 0.10.0

data/common_rubocop.yml

@@ -1,5 +1,11 @@
 AllCops:
-  TargetRubyVersion: 2.5.0
+  TargetRubyVersion: 2.7.0
+  # We choose to opt-in to new checks by default. This allows us to update
+  # version by version without having to worry about adding an entry for each
+  # new "enabled by default" check. If we want to jump multiple versions and
+  # wish to be notified of all the enw check, then we'll need to change
+  # `NewCops` to `pending`.
+  NewCops: enable
   Exclude:
     # Exclude generated binstubs
     - 'bin/bundle'
@@ -56,7 +62,7 @@ Layout/AccessModifierIndentation:
 # SupportedHashRocketStyles: key, separator, table
 # SupportedColonStyles: key, separator, table
 # SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: true
   EnforcedHashRocketStyle: key
   EnforcedColonStyle: key
@@ -79,17 +85,46 @@ Layout/BlockAlignment:
 # Configuration parameters: EnforcedStyle, IndentationWidth.
 # SupportedStyles: consistent, consistent_relative_to_receiver,
 #                  special_for_inner_method_call, special_for_inner_method_call_in_parentheses
-Layout/FirstParameterIndentation:
+#
+# TODO: At some point this is split into both Layout/FirstArgumentIndentation
+# and Layout/FirstParameterIndentation
+Layout/FirstArgumentIndentation:
   Enabled: false
 
-# This project only uses newer Ruby versions which all support the "squiggly"
-# style. We prefer to use pure Ruby calls when possible instead of relying on
-# alternatives; even for Rails app.
+# We generally prefer to use the default line length of 80. Though sometimes
+# we just need a little extra space because it makes it easier to read.
 #
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  EnforcedStyle: squiggly
+# The only way to disable Rubocop for a single line is either to wrap the line
+# with two comments or append the disable comment to the end of the line. For
+# guard clauses, we tend to prefer trailing comments to avoid adding two lines
+# just to disable a cop on one line.
+#
+# Sometimes comments include ASCII diagrams, flow charts, etc. These cannot
+# always be reformatted to fit within the 80 column limit. Also, we write most
+# comments in markdown format. Rubocop isn't very good at understanding when
+# the line is long because of a URL in a markdown link. Instead of requiring
+# additional comments to turn this cop off for comments we ignore any long
+# lines which are only comments.
+#
+# There are also cases where for one valid reason or another we have a trailing
+# comment that extends a little too far. We'd like to be able to ignore those
+# as well. This _attempts_ to do that, however, as this uses simple regular
+# expressions we can only attempt to match so much. We probably should change
+# this for a node pattern matcher in the future.
+#
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes,
+#                           IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  IgnoreCopDirectives: true
+  IgnoredPatterns:
+    # Leading comments
+    - '\A\s*#'
+    # Attempt at trailing comments
+    - '\A.{1,78}\s#\s.*\z'
+  Max: 100
+  Exclude:
+    - '**/*.gemspec'
 
 # We tend to indent multi-line operation statements. I think this is because it
 # tends to be the default style auto-formatted by VIM (which many of us use).
@@ -124,6 +159,31 @@ Lint/AmbiguousBlockAssociation:
   Exclude:
     - 'spec/**/*_spec.rb'
 
+# We prefer to enforce a consistent usage for readability
+#
+#     <<~SQL.strip
+#       bar
+#     SQL
+#
+#     display(<<~SQL.strip)
+#       bar
+#     SQL
+#
+# Alternatively, refactoring the heredoc into a local also improves
+# readability:
+#
+#     custom_sql = <<~SQL
+#       bar
+#     SQL
+#     display(custom_sql.strip)
+Lint/HeredocMethodCallPosition:
+  Enabled: true
+
+# We prefer people suggesting people subclass `StandardError` for their custom
+# exceptions as this is a relatively common Ruby idiom.
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
 # Often with benchmarking we don't explicitly "use" a variable or return value.
 # We simply need to perform the operation which generates said value for the
 # benchmark.
@@ -133,9 +193,22 @@ Lint/Void:
   Exclude:
     - 'benchmarks/**/*'
 
+Metrics/AbcSize:
+  # TODO: When we are able to upgrade to Rubocop 1.5.0 we want to enable the
+  # following `CountRepeatedAttributes` option. We often find the
+  # multi-references to the same object to be necessary for reability and that
+  # for our team it does not increase complexity.
+  #
+  # CountRepeatedAttributes: false
+  Max: 17
+
 # Configuration parameters: CountComments, ExcludedMethods, Max.
 # ExcludedMethods: refine
 Metrics/BlockLength:
+  CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
   Exclude:
     - '**/Rakefile'
     - '**/*.rake'
@@ -144,46 +217,36 @@ Metrics/BlockLength:
     - 'spec/support/model_factories.rb'
   ExcludedMethods:
     - 'chdir'
+    - 'describe'
     - 'refine'
+    - 'shared_context'
+    - 'shared_examples'
     - 'Capybara.register_driver'
-    - 'Gem::Specification.new'
     - 'RSpec.configure'
+    - 'RSpec.describe'
+    - 'RSpec.shared_context'
+    - 'RSpec.shared_examples'
     - 'VCR.configure'
 
-# We generally prefer to use the default line length of 80. Though sometimes
-# we just need a little extra space because it makes it easier to read.
-#
-# The only way to disable Rubocop for a single line is either to wrap the line
-# with two comments or append the disable comment to the end of the line. For
-# guard clauses, we tend to prefer trailing comments to avoid adding two lines
-# just to disable a cop on one line.
-#
-# Sometimes comments include ASCII diagrams, flow charts, etc. These cannot
-# always be reformatted to fit within the 80 column limit. Also, we write most
-# comments in markdown format. Rubocop isn't very good at understanding when
-# the line is long because of a URL in a markdown link. Instead of requiring
-# additional comments to turn this cop off for comments we ignore any long
-# lines which are only comments.
-#
-# There are also cases where for one valid reason or another we have a trailing
-# comment that extends a little too far. We'd like to be able to ignore those
-# as well. This _attempts_ to do that, however, as this uses simple regular
-# expressions we can only attempt to match so much. We probably should change
-# this for a node pattern matcher in the future.
-#
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes,
-#                           IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  IgnoreCopDirectives: true
-  IgnoredPatterns:
-    # Leading comments
-    - '\A\s*#'
-    # Attempt at trailing comments
-    - '\A.{1,78}\s#\s.*\z'
-  Max: 100
-  Exclude:
-    - '**/*.gemspec'
+# We want length related code metrics to count Hashs, Arrays, and
+# Heredocs as one "line"
+Metrics/ClassLength:
+  CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
+
+Metrics/ModuleLength:
+  CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
+
+Metrics/MethodLength:
+    CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
 
 # This is overly pedantic (only allowing `other` as the parameter name). Ruby
 # core doesn't follow this consistently either. Looking at several classes
@@ -206,14 +269,14 @@ Naming/FileName:
 # `EOF` is a common terminal abbreviate indicating end-of-file. We allow this
 # for those heredocs which represent "file" text.
 #
-# Configuration parameters: Blacklist.
-# Blacklist: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
 Naming/HeredocDelimiterNaming:
   Details: |
 
     Use meaningful delimiter names to provide context to the text. The only
     allowed `EO*` variant if `EOF` which has specific meaning for file content.
-  Blacklist:
+  ForbiddenDelimiters:
     - !ruby/regexp '/(^|\s)(EO[A-EG-Z]{1}|END)(\s|$)/'
 
 # It is generally a good idea to match the instance variable names with their
@@ -235,6 +298,13 @@ Naming/MemoizedInstanceVariableName:
     acceptable.
   EnforcedStyleForLeadingUnderscores: optional
 
+# We don't really care about this check. Sometimes using something simple such
+# as `err` is just fine. Other times it may improve readability to have a more
+# descriptive name. We feel this is a personal judgement call and not something
+# that needs to be enforced.
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
 # `alias` behavior changes on scope. In general we expect the behavior to be
 # that which is defined by `alias_method`.
 #
@@ -284,7 +354,10 @@ Style/AsciiComments:
 #   - Prefer `{...}` over `do...end` for functional blocks.
 #
 # When the return value of the method receiving the block is important prefer
-# `{..}` over `do..end`.
+# `{...}` over `do...end`.
+#
+# Some people enjoy the compact readability of `{...}` for one-liners so we
+# allow that style as well.
 #
 # Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods.
 # SupportedStyles: line_count_based, semantic, braces_for_chaining
@@ -297,6 +370,7 @@ Style/BlockDelimiters:
 
     When the return value of the method receiving the block is important prefer
     `{..}` over `do..end`.
+  AllowBracesOnProceduralOneLiners: true
   Enabled: true
   EnforcedStyle: semantic
   ProceduralMethods:
@@ -327,6 +401,15 @@ Style/BlockDelimiters:
     - proc
     - it
 
+# As a team we prefer the more explicit `def self.method_name` style. We find
+# the explicitness easier to read and grep for on the CLI.
+#
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: def_self, self_class
+Style/ClassMethodsDefinitions:
+  Enabled: true
+  EnforcedStyle: def_self
+
 # Prefer `Time` over `DateTime`.
 #
 # While these are not necessarily interchangeable we prefer `Time`. According
@@ -401,6 +484,13 @@ Style/EmptyCaseCondition:
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
+# Always require the pragma comment to be true
+#
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true
+
 # Prefer symbol keys using the 1.9 hash syntax. However, when keys are mixed
 # use a consistent mapping style; which generally means using hash rockets:
 #
@@ -574,6 +664,11 @@ Style/RescueStandardError:
     Avoid rescuing `Exception` as this may hide system errors.
   EnforcedStyle: implicit
 
+# We don't really care which style we use here and would prefer rubocop not
+# complain about this.
+Style/SlicingWithRange:
+  Enabled: false
+
 # We generally prefer double quotes but many generators use single quotes. We
 # don't view the performance difference to be all that much so we don't care
 # if the style is mixed or double quotes are used for static strings.

data/common_rubocop_rails.yml

@@ -1,3 +1,5 @@
+require: rubocop-rails
+
 inherit_mode:
   merge:
     - Exclude
@@ -5,10 +7,6 @@ inherit_mode:
 
 inherit_from: common_rubocop.yml
 
-# Enable additional Rails cops
-Rails:
-  Enabled: true
-
 AllCops:
   Exclude:
     - 'bin/puma'
@@ -22,26 +20,26 @@ AllCops:
     - 'db/migrate/**/*'
 
 # Rails project's are not concerned with API docs normally
-Documentation:
+Style/Documentation:
   Enabled: false
 
-Metrics/BlockLength:
-  Exclude:
-    - 'bin/setup'
-    - 'bin/update'
-    - 'config/routes.rb'
-    - 'spec/rails_helper.rb'
-
 # Rails foreign keys and indexes can get long. We want to ignore our annotation
 # comments which are for these entries.
 #
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   IgnoredPatterns:
     - '\A#  fk_rails_'
     - '\A#  index_'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'bin/setup'
+    - 'bin/update'
+    - 'config/routes.rb'
+    - 'spec/rails_helper.rb'
+
 # For our Rails apps several of them use the `respond_to` with `format` blocks
 # to handle various mime types (mostly HTML and JSON). Given our `do` / `end`
 # block style for non-functional blocks (which includes both `respond_to` and
@@ -108,6 +106,11 @@ Rails/ApplicationRecord:
 Rails/CreateTableWithTimestamps:
   Enabled: false
 
+# This cop looks for uses of default_scope because named scopes are preferred:
+# https://rails.rubystyle.guide/#named-scopes
+Rails/DefaultScope:
+  Enabled: true
+
 # Usage of `find_by` is more expressive of intent than `where.first`. We should
 # check all app code, not just the models to improve intent expression.
 #
@@ -121,6 +124,11 @@ Rails/FindBy:
     - 'app/**/*.rb'
     - 'lib/**/*.rb'
 
+# This cop enforces that ActiveRecord#find is used instead of where.take!, find_by!, and find_by_id!
+# to retrieve a single record by primary key when you expect it to be found.
+Rails/FindById:
+  Enabled: true
+
 # Usage of `each` for large datasets can be a performance issue; specially a
 # drain on system memory. When possible it's better to use `find_each` so that
 # chunks of data are evaluated at a time.
@@ -145,6 +153,52 @@ Rails/FindEach:
 Rails/HasAndBelongsToMany:
   Enabled: false
 
+# We find the combo `:only` and `:if` readable. While the `:except` and `:if`
+# combo is easier to read as a combined proc. As a team we are fine with
+# handling this in PR reviews, until such time which Rubocop provides an option
+# for us to configure this.
+Rails/IgnoredSkipActionFilterOption:
+  Enabled: false
+
+# We do not care about this check due to its lack of configuration.
+#
+# Some of the team finds the naming of this method is more confusing than using
+# `each_with_object`. We all agree the other examples are bad and should not be
+# used:
+#
+#     # OK for us
+#     [1, 2, 3].each_with_object({}) { |el, h| h[foo(el)] = el }
+#
+#     # Bad
+#     [1, 2, 3].to_h { |el| [foo(el), el] }
+#     [1, 2, 3].map { |el| [foo(el), el] }.to_h
+#     Hash[[1, 2, 3].collect { |el| [foo(el), el] }]
+#
+# If this check supports configuration in the future so that we can allow
+# `each_with_object` then we'll turn it back on.
+Rails/IndexBy:
+  Enabled: false
+
+# We find the name of this method to be very confusing. We'd prefer this method
+# is never used.
+Rails/IndexWith:
+  Enabled: false
+
+# This cop enforces the use of ids over pluck(:id) and pluck(primary_key).
+# https://rails.rubystyle.guide/#ids
+Rails/PluckId:
+  Enabled: true
+
+# This cop identifies places where pluck is used in where query methods and can be replaced with
+# select. Since pluck is an eager method and hits the database immediately, using select helps to
+# avoid additional database queries.
+#
+# When the EnforcedStyle is aggressive then all calls to pluck in the where is used as offenses.
+# This may lead to false positives as the cop cannot replace to select between calls to pluck on an
+# ActiveRecord::Relation instance vs a call to pluck on an Array instance.
+Rails/PluckInWhere:
+  EnforcedStyle: aggressive
+
 # The ActiveSupport monkey patches for `present?` are nearly all defined as:
 #
 #     !blank?
@@ -205,6 +259,13 @@ Rails/ReadWriteAttribute:
 Rails/SaveBang:
   Enabled: true
 
+# This cop enforces that short forms of I18n methods are used: t instead of translate and l instead
+# of localize. We want this because it's a pain to use the full method names over and over in view
+# code. When the EnforcedStyle is aggressive then all translate and localize calls without a
+# receiver are added as offenses.
+Rails/ShortI18n:
+  EnforcedStyle: aggressive
+
 # According to the Rails docs while the following methods skip validations they
 # only update the specified (single) attribute reducing risks. We'd rather not
 # warn for those cases:
@@ -222,14 +283,19 @@ Rails/SaveBang:
 #   - http://api.rubyonrails.org/classes/ActiveRecord/Persistence.html
 #   - http://api.rubyonrails.org/classes/ActiveRecord/Relation.html
 #
-# Configuration parameters: Blacklist, Whitelist.
-# Blacklist: decrement!, decrement_counter, increment!, increment_counter, toggle!, touch, update_all, update_attribute, update_column, update_columns, update_counters
+# Configuration parameters: ForbiddenMethods, AllowedMethods.
+# ForbiddenMethods: decrement!, decrement_counter, increment!, increment_counter, toggle!, touch, update_all, update_attribute, update_column, update_columns, update_counters
 Rails/SkipsModelValidations:
-  Whitelist:
+  AllowedMethods:
     - 'decrement!'
     - 'increment!'
     - 'touch'
 
+# We don't want to be forced to use squish in SQL or JSON heredocs (especially
+# in specs).
+Rails/SquishedSQLHeredocs:
+  Enabled: false
+
 # Rails uses compact style by default so we're disabling this with a :hammer:
 # for things likely to be generated by Rails (i.e. most things in app).
 #

data/lib/radius/spec/model_factory.rb

@@ -110,6 +110,14 @@ module Radius
       class TemplateNotFound < KeyError; end
 
       class << self
+        # rubocop:disable Style/ClassMethodsDefinitions
+        # Style Note: We are using this class method style because we need to
+        # call `alias_method` within this module's singleton class context.
+        # Ruby did not introduce access to `singleton_class` until 2.7. Once we
+        # drop support for Ruby < 2.7 we can switch styles and use:
+        #
+        #     singleton_class.alias_method :factory, :define_factory
+
         # Suggested method for defining multiple factory templates at once.
         #
         # Most projects end up having many domain models which need factories
@@ -283,6 +291,7 @@ module Radius
         def templates
           @templates ||= {}
         end
+        # rubocop:enable Style/ClassMethodsDefinitions
       end
 
     module_function
@@ -482,10 +491,8 @@ module Radius
 end
 
 # Try to load the factories defined for the specs
-# rubocop:disable Lint/HandleExceptions
 begin
   require 'support/model_factories'
 rescue LoadError
   # Ignore as this is an optional convenience feature
 end
-# rubocop:enable Lint/HandleExceptions

data/lib/radius/spec/rspec.rb

@@ -22,6 +22,10 @@ RSpec.configure do |config|
     # ...rather than:
     #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+
+    # The default is to warn, but this normally just gets ignored by
+    # developers. It's best to fix the problem then live with the warning.
+    expectations.on_potential_false_positives = :raise
   end
 
   # rspec-mocks config goes here. You can use an alternate test double
@@ -101,6 +105,11 @@ RSpec.configure do |config|
   # as the one that triggered the failure.
   Kernel.srand config.seed
 
+  # Common shared_example / shared_context inclusion alias for behavior driven
+  # development
+  config.alias_it_should_behave_like_to :has_behavior
+  config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+
   config.when_first_matching_example_defined(
     :model_factory,
     :model_factories,

data/lib/radius/spec/vcr.rb

@@ -91,10 +91,8 @@ RSpec.configure do |config|
 end
 
 # Try to any custom VCR config for the app
-# rubocop:disable Lint/HandleExceptions
 begin
   require 'support/vcr'
 rescue LoadError
   # Ignore as this is an optional convenience feature
 end
-# rubocop:enable Lint/HandleExceptions

data/lib/radius/spec/version.rb

@@ -2,6 +2,6 @@
 
 module Radius
   module Spec
-    VERSION = "0.6.0"
+    VERSION = "0.10.0"
   end
 end

data/radius-spec.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata      = {
     "bug_tracker_uri" => "https://github.com/RadiusNetworks/radius-spec/issues",
-    "changelog_uri"   => "https://github.com/RadiusNetworks/radius-spec/blob/v#{Radius::Spec::VERSION}/CHANGELOG.md",
+    "changelog_uri" => "https://github.com/RadiusNetworks/radius-spec/blob/v#{Radius::Spec::VERSION}/CHANGELOG.md",
     "source_code_uri" => "https://github.com/RadiusNetworks/radius-spec/tree/v#{Radius::Spec::VERSION}",
   }
   spec.summary       = "Radius Networks RSpec setup and plug-ins"
@@ -21,18 +21,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/RadiusNetworks/radius-spec"
   spec.license       = "Apache-2.0"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f|
     f.match(%r{^(test|spec|features)/})
-  end
+  }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.5" # rubocop:disable Gemspec/RequiredRubyVersion
 
   spec.add_runtime_dependency "rspec", "~> 3.7"
-  spec.add_runtime_dependency "rubocop", "~> 0.62.0"
+  spec.add_runtime_dependency "rubocop", "~> 0.90.0"
+  spec.add_runtime_dependency "rubocop-rails", "~> 2.9.1"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "bundler", ">= 2.2.10"
+  spec.add_development_dependency "rake", ">= 12.0", "< 14.0"
 end