radius-spec 0.5.0 → 0.9.0

data/benchmarks/style_hash_like_case.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+# Data values are taken from the Rubocop Style/HashLikeCase example
+#
+# https://docs.rubocop.org/rubocop/1.21/cops_style.html#styleredundantfileextensioninrequire
+
+# Run from the command line: bundle exec ruby benchmarks/style_hash_like_case.rb
+require_relative 'bm_setup'
+
+display_benchmark_header
+
+# rubocop:disable Style/HashLikeCase
+def case_check3(value)
+  case value
+  when 'europe'
+    'http://eu.example.com'
+  when 'america'
+    'http://us.example.com'
+  when 'australia'
+    'http://au.example.com'
+  end
+end
+
+HASH_CASE3 = {
+  'europe' => 'http://eu.example.com',
+  'america' => 'http://us.example.com',
+  'australia' => 'http://au.example.com',
+}.freeze
+
+def hash_check3(value)
+  HASH_CASE3[value]
+end
+
+section "Style/HashLikeCase(3) - First Match" do |bench|
+  bench.report("case") do |times|
+    i = 0
+    while i < times
+      case_check3('europe')
+      i += 1
+    end
+  end
+
+  bench.report("hash") do |times|
+    i = 0
+    while i < times
+      hash_check3('europe')
+      i += 1
+    end
+  end
+end
+
+section "Style/HashLikeCase(3) - Last Match" do |bench|
+  bench.report("case") do |times|
+    i = 0
+    while i < times
+      case_check3('australia')
+      i += 1
+    end
+  end
+
+  bench.report("hash") do |times|
+    i = 0
+    while i < times
+      hash_check3('australia')
+      i += 1
+    end
+  end
+end
+
+section "Style/HashLikeCase(3) - No Match" do |bench|
+  bench.report("case") do |times|
+    i = 0
+    while i < times
+      case_check3('any other place')
+      i += 1
+    end
+  end
+
+  bench.report("hash") do |times|
+    i = 0
+    while i < times
+      hash_check3('any other place')
+      i += 1
+    end
+  end
+end
+
+def case_check5(value) # rubocop:disable Metrics/MethodLength
+  case value
+  when 'europe'
+    'http://eu.example.com'
+  when 'america'
+    'http://us.example.com'
+  when 'australia'
+    'http://au.example.com'
+  when 'china'
+    'http://cn.example.com'
+  when 'japan'
+    'http://jp.example.com'
+  end
+end
+
+HASH_CASE5 = {
+  'europe' => 'http://eu.example.com',
+  'america' => 'http://us.example.com',
+  'australia' => 'http://au.example.com',
+  'china' => 'http://cn.example.com',
+  'japan' => 'http://jp.example.com',
+}.freeze
+
+def hash_check5(value)
+  HASH_CASE5[value]
+end
+
+section "Style/HashLikeCase(5) - First Match" do |bench|
+  bench.report("case") do |times|
+    i = 0
+    while i < times
+      case_check5('europe')
+      i += 1
+    end
+  end
+
+  bench.report("hash") do |times|
+    i = 0
+    while i < times
+      hash_check5('europe')
+      i += 1
+    end
+  end
+end
+
+section "Style/HashLikeCase(5) - Last Match" do |bench|
+  bench.report("case") do |times|
+    i = 0
+    while i < times
+      case_check5('japan')
+      i += 1
+    end
+  end
+
+  bench.report("hash") do |times|
+    i = 0
+    while i < times
+      hash_check5('japan')
+      i += 1
+    end
+  end
+end
+
+section "Style/HashLikeCase(5) - No Match" do |bench|
+  bench.report("case") do |times|
+    i = 0
+    while i < times
+      case_check5('any other place')
+      i += 1
+    end
+  end
+
+  bench.report("hash") do |times|
+    i = 0
+    while i < times
+      hash_check5('any other place')
+      i += 1
+    end
+  end
+end
+
+# rubocop:enable Style/HashLikeCase
+
+__END__
+
+Usage of `case` appears to be more performant than a hash. However, both are
+highly performant, so any difference is likely negligible compared to other
+performance issues.
+
+### Environment
+
+Performance-M Dyno
+ruby 2.7.4p191 (2021-07-07 revision a21a3b7d23) [x86_64-linux]
+GC Disabled: true
+
+### Test Cases
+
+#### Style/HashLikeCase(3) - First Match
+
+```
+Warming up --------------------------------------
+                case     1.768M i/100ms
+                hash     1.710M i/100ms
+Calculating -------------------------------------
+                case     17.630M (± 0.3%) i/s -     88.418M in   5.016811s
+                hash     17.044M (± 0.2%) i/s -     85.504M in   5.017564s
+                   with 95.0% confidence
+
+Comparison:
+                case: 17630438.8 i/s
+                hash: 17044158.0 i/s - 1.03x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Style/HashLikeCase(3) - Last Match
+
+```
+Warming up --------------------------------------
+                case     1.714M i/100ms
+                hash     1.644M i/100ms
+Calculating -------------------------------------
+                case     17.066M (± 0.7%) i/s -     85.718M in   5.027638s
+                hash     16.432M (± 0.1%) i/s -     82.205M in   5.002925s
+                   with 95.0% confidence
+
+Comparison:
+                case: 17066448.1 i/s
+                hash: 16432193.1 i/s - 1.04x  (± 0.01) slower
+                   with 95.0% confidence
+```
+
+#### Style/HashLikeCase(3) - No Match
+
+```
+Warming up --------------------------------------
+                case     1.706M i/100ms
+                hash     1.529M i/100ms
+Calculating -------------------------------------
+                case     16.944M (± 0.8%) i/s -     85.300M in   5.041700s
+                hash     15.210M (± 0.5%) i/s -     76.428M in   5.028693s
+                   with 95.0% confidence
+
+Comparison:
+                case: 16944279.7 i/s
+                hash: 15210481.2 i/s - 1.11x  (± 0.01) slower
+                   with 95.0% confidence
+```
+
+#### Style/HashLikeCase(5) - First Match
+
+```
+Warming up --------------------------------------
+                case     1.738M i/100ms
+                hash     1.704M i/100ms
+Calculating -------------------------------------
+                case     17.621M (± 0.5%) i/s -     88.642M in   5.033716s
+                hash     16.963M (± 0.5%) i/s -     85.198M in   5.025691s
+                   with 95.0% confidence
+
+Comparison:
+                case: 17621070.3 i/s
+                hash: 16963331.9 i/s - 1.04x  (± 0.01) slower
+                   with 95.0% confidence
+```
+
+#### Style/HashLikeCase(5) - Last Match
+
+```
+Warming up --------------------------------------
+                case     1.718M i/100ms
+                hash     1.634M i/100ms
+Calculating -------------------------------------
+                case     17.170M (± 0.0%) i/s -     85.898M in   5.002845s
+                hash     16.357M (± 0.3%) i/s -     83.338M in   5.097011s
+                   with 95.0% confidence
+
+Comparison:
+                case: 17170019.6 i/s
+                hash: 16356675.5 i/s - 1.05x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Style/HashLikeCase(5) - No Match
+
+```
+Warming up --------------------------------------
+                case     1.661M i/100ms
+                hash     1.501M i/100ms
+Calculating -------------------------------------
+                case     16.518M (± 0.6%) i/s -     83.046M in   5.031835s
+                hash     14.963M (± 0.5%) i/s -     75.058M in   5.019838s
+                   with 95.0% confidence
+
+Comparison:
+                case: 16517985.2 i/s
+                hash: 14962803.1 i/s - 1.10x  (± 0.01) slower
+                   with 95.0% confidence
+```

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,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).
@@ -88,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.
@@ -97,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'
@@ -107,42 +216,31 @@ Metrics/BlockLength:
     - '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.
-#
-# 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
+# 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
@@ -165,14 +263,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
@@ -194,6 +292,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`.
 #
@@ -243,7 +348,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
@@ -256,6 +364,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:
@@ -360,6 +469,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:
 #
@@ -533,6 +649,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.