radius-spec 0.4.0 → 0.8.0

data/benchmarks/unfreeze_string.rb

@@ -5,7 +5,6 @@ require_relative 'bm_setup'
 
 display_benchmark_header
 
-# rubocop:disable Performance/UnfreezeString
 section "Unfreezing empty string" do |bench|
   bench.report("String.new") do
     String.new
@@ -34,7 +33,6 @@ section "Unfreezing string" do |bench|
     STRING.dup
   end
 end
-# rubocop:enable Performance/UnfreezeString
 
 __END__
 

data/bin/ci

@@ -15,7 +15,7 @@ bin/rspec
 # bundle-audit provides patch-level verification for Bundler
 # https://github.com/rubysec/bundler-audit.
 echo " ---> Running bundler-audit"
-gem install --no-rdoc --no-ri bundler-audit
+gem install --no-document bundler-audit
 bundle-audit check --update
 
 # Run style checker

data/common_rubocop.yml

@@ -1,15 +1,26 @@
 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'
     - 'bin/bundler-travis'
+    - 'bin/pronto'
     - 'bin/pry'
+    - 'bin/radius-cli'
     - 'bin/rake'
     - 'bin/rspec'
     - 'bin/rubocop'
     - 'bin/travis'
+    - 'bin/webpack'
+    - 'bin/webpack-dev-server'
     - 'bin/yard'
+    - 'bin/yarn'
     # Exclude vendored content
     - 'vendor/**/*'
 
@@ -25,6 +36,37 @@ Layout/AccessModifierIndentation:
     similar to `rescue` and `ensure` in a method.
   EnforcedStyle: outdent
 
+# Rubocop 0.60.0 changed how it handled value alignments in this cop. This
+# breaks our preference for wanting keys to be aligned, but allowing values to
+# either use the `key` or `table` style:
+#
+#     key_style = {
+#       key: :value,
+#       another: :value,
+#       yet_another: :value
+#     }
+#     table_style = {
+#       key:         :value,
+#       another:     :value
+#       yet_another: :value
+#     }
+#
+# This is logged with Rubocop: https://github.com/rubocop-hq/rubocop/issues/6410
+#
+# Until Rubocop resolves this we've decided to enforce the key style so that we
+# do not lose all associated formatting checks. Additionally, in response to
+# the referenced issue the Rubocop disables the alignment check by default. To
+# continue using it we force enable it here.
+#
+# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+
 # Disabling this until it is fixed to support multi-line block chains using the
 # semantic style.
 #
@@ -43,7 +85,10 @@ 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"
@@ -52,9 +97,44 @@ Layout/FirstParameterIndentation:
 #
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   EnforcedStyle: squiggly
 
+# 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
+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).
 # It also helps show the continuation of the statement instead of it
@@ -88,6 +168,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.
@@ -97,6 +202,15 @@ 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:
@@ -106,39 +220,18 @@ Metrics/BlockLength:
     - 'spec/spec_helper.rb'
     - 'spec/**/*_spec.rb'
     - 'spec/support/model_factories.rb'
+  ExcludedMethods:
+    - 'chdir'
+    - 'refine'
+    - 'Capybara.register_driver'
+    - 'RSpec.configure'
+    - '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.
+# TODO: Remove this when we get to 0.89.0 as the new default max is 8
 #
-# 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
+# Configuration parameters: IgnoredMethods, Max
+Metrics/PerceivedComplexity:
+  Max: 8
 
 # This is overly pedantic (only allowing `other` as the parameter name). Ruby
 # core doesn't follow this consistently either. Looking at several classes
@@ -161,14 +254,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
@@ -190,6 +283,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`.
 #
@@ -239,7 +339,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
@@ -252,6 +355,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:
@@ -266,7 +370,9 @@ Style/BlockDelimiters:
     - create!
     - build
     - build!
+    - default_scope
     - each_with_object
+    - filter_sensitive_data
     - find
     - git_source
     - let
@@ -280,6 +386,19 @@ Style/BlockDelimiters:
     - proc
     - it
 
+# Prefer `Time` over `DateTime`.
+#
+# While these are not necessarily interchangeable we prefer `Time`. According
+# to the Ruby docs `DateTime` is meant more for historical dates; it also does
+# not consider leap seconds or summer time rules.
+#
+# Lastly, `DateTime` is part of the stdlib which is written in Ruby; where as
+# `Time` is part of core and written in C.
+#
+# Configuration parameters: AllowCoercion
+Style/DateTime:
+  Enabled: true
+
 # The double negation idiom is a common Ruby-ism. All languages have various
 # idioms and part of learning the language is learning the common idioms. Once
 # learning the meaning it is not cryptic as Rubocop implies.
@@ -341,6 +460,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:
 #
@@ -391,9 +517,10 @@ Style/MethodCalledOnDoEndBlock:
 Style/MultilineBlockChain:
   Enabled: false
 
-# Context for this cop is too dependent. Often using the numeric comparison is
-# faster. An in certain contexts, Also, depending on the context a numeric
-# comparison is more consistent and can even be more natural:
+# Context for this cop is too dependent.
+#
+# Often using the numeric comparison is faster. Also, depending on the context
+# a numeric comparison may produce a more consistent style:
 #
 #     # numeric comparison is more natural and consistent
 #     if n < 0

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,24 +20,26 @@ AllCops:
     - 'db/migrate/**/*'
 
 # Rails project's are not concerned with API docs normally
-Documentation:
+Style/Documentation:
   Enabled: false
 
-Metrics/BlockLength:
-  Exclude:
-    - '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
@@ -106,6 +106,34 @@ Rails/ApplicationRecord:
 Rails/CreateTableWithTimestamps:
   Enabled: false
 
+# 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.
+#
+# Since rake tasks often live in `lib` we also check all of lib as well.
+#
+# Configuration parameters: Include.
+# Include: app/models/**/*.rb
+Rails/FindBy:
+  Enabled: true
+  Include:
+    - 'app/**/*.rb'
+    - 'lib/**/*.rb'
+
+# 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.
+#
+# We should check all app code, not just the models to help prevent this. Since
+# rake tasks often live in `lib` we also check all of lib as well.
+#
+# Configuration parameters: Include.
+# Include: app/models/**/*.rb
+Rails/FindEach:
+  Enabled: true
+  Include:
+    - 'app/**/*.rb'
+    - 'lib/**/*.rb'
+
 # We understand the trade-offs for using the through model versus a lookup
 # table. As such this cop is just noise as it flags only those cases we really
 # do want a lookup table.
@@ -115,6 +143,37 @@ Rails/CreateTableWithTimestamps:
 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
+
 # The ActiveSupport monkey patches for `present?` are nearly all defined as:
 #
 #     !blank?
@@ -122,7 +181,7 @@ Rails/HasAndBelongsToMany:
 # For most of us `unless blank?` reads just as easily as `if present?`.
 # Sometimes contextually, it can read better depending on the branch logic and
 # surrounding context. As `if present?` requires an additional negation and
-# method call it is technically slower. In the general case the perf different
+# method call it is technically slower. In the general case the perf difference
 # isn't much but in some cases it matters. Thus, we are not enforcing changing
 # `unless blank?` to `if present?` and are leaving it up to the context to
 # decide which is a better fit.
@@ -144,6 +203,37 @@ Rails/Present:
 Rails/ReadWriteAttribute:
   Enabled: false
 
+# This ensures we do not ignore potential validation issues in the code. Doing
+# so can lead to strange and surprising bugs where records are expected to
+# be created, or be modified, but are not.
+#
+#     # If author is a new record the book may not be created since the FK is
+#     # invalid. Perhaps omitting other fields, maybe new required fields, is
+#     # an oversight in the book creation as well.
+#     author.save
+#     Book.create(author: author)
+#
+# Or side effects are expected to occur but they do not:
+#
+#     # This is a condensed default Rails scaffold controller for `destroy`.
+#     #
+#     # Once a `has_many` or `has_one` associations is added which specifies
+#     # `dependent: :restrict_with_error` this no longer behaves as expected.
+#     # Given such associations are often added much later in time errors in
+#     # this action are an all to common oversight in Rails.
+#     def destroy
+#       @book.destroy
+#       respond_to do |format|
+#         format.html do
+#           redirect_to books_url, notice: 'Book was successfully destroyed.'
+#         end
+#       end
+#     end
+#
+# Configuration parameters: AllowImplicitReturn, AllowedReceivers.
+Rails/SaveBang:
+  Enabled: true
+
 # 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:
@@ -161,17 +251,13 @@ Rails/ReadWriteAttribute:
 #   - 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
 Rails/SkipsModelValidations:
-  Blacklist:
-    - 'decrement_counter'
-    - 'increment_counter'
-    - 'toggle!'
-    - 'update_all'
-    - 'update_attribute'
-    - 'update_column'
-    - 'update_columns'
-    - 'update_counters'
+  Whitelist:
+    - 'decrement!'
+    - 'increment!'
+    - 'touch'
 
 # 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).