radius-spec 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c90e6b5072e71e6bb5c5ef37ccbbc9f0b874c151d156bdb3e9af92aeba0caeb1
-  data.tar.gz: 2781ec9668af9583f4ac7c73de5de2f52e634e3d063e94feb305095de4b36f75
+  metadata.gz: b6b5e94783c4ccbdf8bdf80de184fc19cd52ac9ee9f2a7f92329b261bdb00f59
+  data.tar.gz: e492ea78f99e146011d2279e74fc1a3b1091aac13f311ef81324df43088ce440
 SHA512:
-  metadata.gz: 9b685ea0852391ce5a52c1810bd10d923ff007d9968a4dce483ca147d2057c0e320c15c413abcef900c810cb241dc98b2e633d7b65176a87fbc863d5f2dad26b
-  data.tar.gz: 97ea01566899ea8641f86771f54147875e649eb18669871b2f6db640d6bce912982e5e53690b051b70aece3cd231275fe38c074c3e28cdc5670860c04d6579e4
+  metadata.gz: 83005750c2029b0a2765e176a8d819ed7984376c13ac17b881b442d055956ffd28548c32af56bb7298b1cc60d976c0c3cb25d10bbc2aed5bec0f4b16c72e8324
+  data.tar.gz: 95d8183b73cfa36c5f3e01680bf6d2212016e2355d0a14ed95b7d38800b4d2e44ce9d08dbcdd0336bf6beb20731bfb3a834258a13b6ad357443918c4ec505ae8

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 0.9.0 (September 30, 2021)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.8.0...v0.9.0)
+
+### Enhancements
+
+- Upgrade to Rubocop 0.89.x (Aaron Hill, Aaron Kromer, Ben Reynolds, Chris
+  Hoffman, James Nebeker, JC Avena, Sam Kim #27)
+- Upgrade to Rubocop Rails 2.6.x (Aaron Hill, Aaron Kromer, Ben Reynolds, Chris
+  Hoffman, James Nebeker, JC Avena, Sam Kim #27)
+- Adjust common Rubocop configuration (Aaron Hill, Aaron Kromer, Ben Reynolds,
+  Chris Hoffman, James Nebeker, JC Avena, Sam Kim #27)
+  - Configure multiple metrics to use the `CountAsOne` option for array, hash
+    and heredocs
+  - Disable `Style/SlicingWithRange` as we do not care about the style
+- Includes new `shared_example` / `shared_context` inclusion aliases
+  `has_behavior` and `it_has_behavior` for behavior driven development language
+  (Aaron Kromer, Ben Reynolds #28)
+
+### Bug Fixes
+
+None
+
+### Breaking Change
+
+- Change the default behavior from `:warn` to `:raise` for RSpec expectations
+  behavior `on_potential_false_positives` (Aaron Kromer, Ben Reynolds #28)
+
+
 ## 0.8.0 (August 26, 2021)
 
 [Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.7.0...v0.8.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/common_rubocop.yml

@@ -91,15 +91,6 @@ Layout/BlockAlignment:
 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.
-#
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-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.
 #
@@ -214,6 +205,10 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, ExcludedMethods, Max.
 # ExcludedMethods: refine
 Metrics/BlockLength:
+  CountAsOne:
+    - 'array'
+    - 'hash'
+    - 'heredoc'
   Exclude:
     - '**/Rakefile'
     - '**/*.rake'
@@ -227,11 +222,25 @@ Metrics/BlockLength:
     - 'RSpec.configure'
     - 'VCR.configure'
 
-# TODO: Remove this when we get to 0.89.0 as the new default max is 8
-#
-# Configuration parameters: IgnoredMethods, Max
-Metrics/PerceivedComplexity:
-  Max: 8
+# 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
@@ -640,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.

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/version.rb

@@ -2,6 +2,6 @@
 
 module Radius
   module Spec
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

data/radius-spec.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.5" # rubocop:disable Gemspec/RequiredRubyVersion
 
   spec.add_runtime_dependency "rspec", "~> 3.7"
-  spec.add_runtime_dependency "rubocop", "~> 0.82.0"
-  spec.add_runtime_dependency "rubocop-rails", "~> 2.5.2"
+  spec.add_runtime_dependency "rubocop", "~> 0.89.0"
+  spec.add_runtime_dependency "rubocop-rails", "~> 2.6.0"
 
   spec.add_development_dependency "bundler", ">= 2.2.10"
   spec.add_development_dependency "rake", ">= 12.0", "< 14.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: radius-spec
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Radius Networks
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 0.89.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 0.89.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.2
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,7 @@ files:
 - benchmarks/kwargs.rb
 - benchmarks/max_ternary.rb
 - benchmarks/max_ternary_micro.rb
+- benchmarks/style_hash_like_case.rb
 - benchmarks/unfreeze_string.rb
 - benchmarks/unpack_first.rb
 - bin/ci
@@ -149,8 +150,8 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/RadiusNetworks/radius-spec/issues
-  changelog_uri: https://github.com/RadiusNetworks/radius-spec/blob/v0.8.0/CHANGELOG.md
-  source_code_uri: https://github.com/RadiusNetworks/radius-spec/tree/v0.8.0
+  changelog_uri: https://github.com/RadiusNetworks/radius-spec/blob/v0.9.0/CHANGELOG.md
+  source_code_uri: https://github.com/RadiusNetworks/radius-spec/tree/v0.9.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Radius Networks RSpec setup and plug-ins