radius-spec 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16d76ff7cb5e21c33abfc4c3aa27330b08a770f8a2fd48f58d23de2aacf98b2c
-  data.tar.gz: 53ff6d4b55e268f649de67e4c595a14a570a56ecfa567d45dd0348f2610b5cdc
+  metadata.gz: c90e6b5072e71e6bb5c5ef37ccbbc9f0b874c151d156bdb3e9af92aeba0caeb1
+  data.tar.gz: 2781ec9668af9583f4ac7c73de5de2f52e634e3d063e94feb305095de4b36f75
 SHA512:
-  metadata.gz: abc5b8ad94e8f206621f0f505fabfc39e8d9d870ebe516a82499ebe435aa5581e16c3a7b2f23f371c78eaa5ae5f14cf55cbd99ae296cc3a2649d0843eb2accf9
-  data.tar.gz: 31e9b983fea8c4248cf4424d172f1be48d50bc4b4b82ba1aabc93705c96abd9ea3a806cc919178c5dd2fe387325f4bdabc4238bda97864ffa62736af7b2c71b7
+  metadata.gz: 9b685ea0852391ce5a52c1810bd10d923ff007d9968a4dce483ca147d2057c0e320c15c413abcef900c810cb241dc98b2e633d7b65176a87fbc863d5f2dad26b
+  data.tar.gz: 97ea01566899ea8641f86771f54147875e649eb18669871b2f6db640d6bce912982e5e53690b051b70aece3cd231275fe38c074c3e28cdc5670860c04d6579e4

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: ./bin/ci

data/.github/workflows/reviewdog.yml

@@ -0,0 +1,21 @@
+name: Review Dog
+on: [pull_request]
+jobs:
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+      - uses: ruby/setup-ruby@v1 # ruby-version pulled .ruby-version file automatically
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: rubocop
+        uses: reviewdog/action-rubocop@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          reporter: github-pr-review # Default is github-pr-check
+          rubocop_version: gemfile
+          rubocop_extensions: rubocop-rails:gemfile
+

data/.rubocop.yml

@@ -5,18 +5,18 @@ inherit_mode:
 
 inherit_from: common_rubocop_rails.yml
 
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'radius-spec.gemspec'
+
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
   Exclude:
     - 'benchmarks/**/*'
     - 'lib/radius/spec/rspec.rb'
 
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Exclude:
-    - 'radius-spec.gemspec'
-
 Style/Documentation:
   Exclude:
     - 'benchmarks/**/*'

data/CHANGELOG.md

@@ -1,14 +1,39 @@
+## 0.8.0 (August 26, 2021)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.7.0...v0.8.0)
+
+### Enhancements
+
+- Upgrade to Rubocop 0.82.x (Aaron Hill, Aaron Kromer, Ben Reynolds, Chris
+  Hoffman, James Nebeker, JC Avena #26)
+- Upgrade to Rubocop Rails 2.5.x (Aaron Hill, Aaron Kromer, Ben Reynolds, Chris
+  Hoffman, James Nebeker, JC Avena #26)
+- Adjust common Rubocop configuration (Aaron Hill, Aaron Kromer, Ben Reynolds,
+  Chris Hoffman, James Nebeker, JC Avena #26)
+  - Rename metrics/configuration parameters per version upgrade requirements
+  - Use the stricter `always_true` check for `Style/FrozenStringLiteralComment`
+  - Opt-in to new cops/checks behaving per their default settings
+- Adjust common Rubocop Rails configuration (Aaron Hill, Aaron Kromer, Ben
+  Reynolds, Chris Hoffman, James Nebeker, JC Avena #26)
+  - Disable `Rails/IndexBy` by default
+  - Disable `Rails/IndexWith` by default
+
+### Bug Fixes
+
+None
+
+
 ## 0.7.0 (July 23, 2021)
 
 [Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.6.0...0.7.0)
 
 ### Enhancements
 
-- Upgrade to Rubocop 0.73.x (Aaron Hill, Aaron Kromer, Ben Reynold, Chris
+- Upgrade to Rubocop 0.73.x (Aaron Hill, Aaron Kromer, Ben Reynolds, Chris
   Hoffman, James Nebeker #24)
-- Upgrade to Rubocop Rails 2.2.x (Aaron Hill, Aaron Kromer, Ben Reynold, Chris
+- Upgrade to Rubocop Rails 2.2.x (Aaron Hill, Aaron Kromer, Ben Reynolds, Chris
   Hoffman, James Nebeker #24)
-- Adjust common Rubocop configuration (Aaron Hill, Aaron Kromer, Ben Reynold,
+- Adjust common Rubocop configuration (Aaron Hill, Aaron Kromer, Ben Reynolds,
   Chris Hoffman, James Nebeker #24)
   - Target Ruby 2.7 by default
   - Enable `Lint/HeredocMethodCallPosition` by default
@@ -16,7 +41,7 @@
   - Bump metric check maximums to provide a little more wiggle room
   - Disable `Naming/RescuedExceptionsVariableName` by default
 - Adjust common Rubocop Rails configuration (Aaron Hill, Aaron Kromer, Ben
-  Reynold, Chris Hoffman, James Nebeker #24)
+  Reynolds, Chris Hoffman, James Nebeker #24)
   - Disable `Rails/IgnoredSkipActionFilterOption` by default
 
 ### Bug Fixes

data/Gemfile

@@ -10,9 +10,7 @@ gemspec
 group :benchmark, optional: true do
   gem 'activesupport', require: false
   gem 'benchmark-ips', require: false
-  # TODO: See if this gem has an update in the future as it's gemspec is too
-  # strict and it was blocking other gems from installing / updating
-  gem 'kalibera', require: false, git: 'https://github.com/cupakromer/libkalibera.git'
+  gem 'kalibera', require: false
 end
 
 group :debug do

data/README.md

@@ -1,6 +1,5 @@
 # Common RSpec Setup and Plug-ins
 
-[![Build Status](https://travis-ci.org/RadiusNetworks/radius-spec.svg?branch=master)](https://travis-ci.org/RadiusNetworks/radius-spec)
 [![Maintainability](https://api.codeclimate.com/v1/badges/701295df43d53e25eafe/maintainability)](https://codeclimate.com/github/RadiusNetworks/radius-spec/maintainability)
 [![Gem Version](https://badge.fury.io/rb/radius-spec.svg)](https://badge.fury.io/rb/radius-spec)
 
@@ -123,17 +122,17 @@ inherit_mode:
 
 # Available for projects which cannot include this gem (i.e. Ruby < 2.5)
 inherit_from:
-  - https://raw.githubusercontent.com/RadiusNetworks/radius-spec/master/common_rubocop.yml
+  - https://raw.githubusercontent.com/RadiusNetworks/radius-spec/main/common_rubocop.yml
   # Use the following instead if it is a Rails project
-  - https://raw.githubusercontent.com/RadiusNetworks/radius-spec/master/common_rubocop_rails.yml
+  - https://raw.githubusercontent.com/RadiusNetworks/radius-spec/main/common_rubocop_rails.yml
 ```
 
 When using the raw URL you may need to add the following to the project's
 `.gitignore` file:
 
 ```
-.rubocop-https---raw-githubusercontent-com-RadiusNetworks-radius-spec-master-common-rubocop-rails-yml
-.rubocop-https---raw-githubusercontent-com-RadiusNetworks-radius-spec-master-common-rubocop-yml
+.rubocop-https---raw-githubusercontent-com-RadiusNetworks-radius-spec-main-common-rubocop-rails-yml
+.rubocop-https---raw-githubusercontent-com-RadiusNetworks-radius-spec-main-common-rubocop-yml
 ```
 
 #### General Inheritance Notes
@@ -798,4 +797,4 @@ conduct.
 
 Everyone interacting in the Radius::Spec project’s codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the [code of
-conduct](https://github.com/RadiusNetworks/radius-spec/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/RadiusNetworks/radius-spec/blob/main/CODE_OF_CONDUCT.md).

data/benchmarks/call_vs_yield.rb

@@ -5,7 +5,6 @@ require_relative 'bm_setup'
 
 display_benchmark_header
 
-# rubocop:disable Performance/RedundantBlockCall
 def block_call(&block)
   block.call
 end
@@ -77,7 +76,6 @@ section "Block call vs yield" do |bench|
     end
   end
 end
-# rubocop:enable Performance/RedundantBlockCall
 
 __END__
 

data/benchmarks/cover_vs_include.rb

@@ -5,7 +5,7 @@ require_relative 'bm_setup'
 
 display_benchmark_header
 
-INT_RANGE = (0..15)
+INT_RANGE = (0..15).freeze
 INT_VAR = 10
 
 section "Integer ranges" do |bench|
@@ -30,7 +30,7 @@ BEGIN_OF_JULY = Time.utc(2015, 7, 1)
 END_OF_JULY = Time.utc(2015, 7, 31)
 DAY_IN_JULY = Time.utc(2015, 7, 15)
 
-TIME_RANGE = (BEGIN_OF_JULY..END_OF_JULY)
+TIME_RANGE = (BEGIN_OF_JULY..END_OF_JULY).freeze
 
 section "Time ranges" do |bench|
   bench.report('range#cover?') do

data/benchmarks/format_string.rb

@@ -15,15 +15,15 @@ MULTI_TOKEN_HASH = {
 # rubocop:disable Style/FormatString
 section "Format String" do |bench|
   bench.report("String#%") do
-    '%10s' % 'hoge'
+    '%10s' % 'hoge' # rubocop:disable Style/FormatStringToken
   end
 
   bench.report("format") do
-    format '%10s', 'hoge'
+    format '%10s', 'hoge' # rubocop:disable Style/FormatStringToken
   end
 
   bench.report("sprintf") do
-    sprintf '%10s', 'hoge'
+    sprintf '%10s', 'hoge' # rubocop:disable Style/FormatStringToken
   end
 end
 # rubocop:enable Style/FormatString

data/benchmarks/hash_each.rb

@@ -0,0 +1,305 @@
+# frozen_string_literal: true
+
+# Run from the command line: bundle exec ruby benchmarks/hash_merge.rb
+require_relative 'bm_setup'
+
+# rubocop:disable Style/HashEachMethods
+
+display_benchmark_header
+
+# Bad per Rubocop
+def hash_keys_each(hash)
+  hash.keys.each { |k| k + 1 }
+
+  # Return nil to avoid array creation penalty which may skew benchmark
+  nil
+end
+
+# Good per Rubocop
+def hash_each_key(hash)
+  hash.each_key { |k| k + 1 }
+
+  # Return nil to avoid array creation penalty which may skew benchmark
+  nil
+end
+
+[
+  [],
+  (1..5),
+  (1..10),
+  (1..20),
+  (1..100),
+  (1..500),
+].each do |data|
+  test_hash = data.zip(data).to_h
+
+  section "Hash key enumeration (size=#{data.size})" do |bench|
+    bench.report("Hash.keys.each") do
+      hash_keys_each(test_hash)
+    end
+
+    bench.report("Hash.each_key") do
+      hash_each_key(test_hash)
+    end
+  end
+end
+
+# Bad per Rubocop
+def hash_values_each(hash)
+  hash.values.each { |v| v + 1 }
+
+  # Return nil to avoid array creation penalty which may skew benchmark
+  nil
+end
+
+# Good per Rubocop
+def hash_each_value(hash)
+  hash.each_value { |v| v + 1 }
+
+  # Return nil to avoid array creation penalty which may skew benchmark
+  nil
+end
+
+[
+  [],
+  (1..5),
+  (1..10),
+  (1..20),
+  (1..100),
+  (1..500),
+].each do |data|
+  test_hash = data.zip(data).to_h
+
+  section "Hash value enumeration (size=#{data.size})" do |bench|
+    bench.report("Hash.values.each") do
+      hash_values_each(test_hash)
+    end
+
+    bench.report("Hash.each_value") do
+      hash_each_value(test_hash)
+    end
+  end
+end
+
+# rubocop:enable Style/HashEachMethods
+
+__END__
+
+### Environment
+
+Heroku Performance-L Dyno
+
+ruby 2.7.3p183 (2021-04-05 revision 6847ee089d) [x86_64-linux]
+GC Disabled: false
+
+### Test Cases
+
+Behavior for the keys and value enumerations is roughly equivalent. As
+hypothesized the `each_xyz` versions are faster. What is surprising is that the
+performance difference drops off drastically the larger the hash, even for
+small hash sizes. Basically, once the hash reaches 10 times, the performance
+gains are constant after that point (around 1 - 4%).
+
+#### Hash key enumeration (size=0)
+
+```
+Warming up --------------------------------------
+      Hash.keys.each   913.942k i/100ms
+       Hash.each_key     1.376M i/100ms
+Calculating -------------------------------------
+      Hash.keys.each      9.167M (± 0.0%) i/s -     46.611M in   5.084564s
+       Hash.each_key     13.734M (± 0.2%) i/s -     68.779M in   5.008581s
+                   with 95.0% confidence
+
+Comparison:
+       Hash.each_key: 13734476.7 i/s
+      Hash.keys.each:  9167168.9 i/s - 1.50x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash key enumeration (size=5)
+
+```
+Warming up --------------------------------------
+      Hash.keys.each   319.678k i/100ms
+       Hash.each_key   360.081k i/100ms
+Calculating -------------------------------------
+      Hash.keys.each      3.190M (± 0.4%) i/s -     15.984M in   5.012434s
+       Hash.each_key      3.596M (± 0.0%) i/s -     18.004M in   5.006636s
+                   with 95.0% confidence
+
+Comparison:
+       Hash.each_key:  3596043.0 i/s
+      Hash.keys.each:  3189893.5 i/s - 1.13x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash key enumeration (size=10)
+
+```
+Warming up --------------------------------------
+      Hash.keys.each   201.546k i/100ms
+       Hash.each_key   209.461k i/100ms
+Calculating -------------------------------------
+      Hash.keys.each      2.019M (± 0.3%) i/s -     10.279M in   5.092727s
+       Hash.each_key      2.095M (± 0.0%) i/s -     10.683M in   5.099576s
+                   with 95.0% confidence
+
+Comparison:
+       Hash.each_key:  2094785.3 i/s
+      Hash.keys.each:  2018768.6 i/s - 1.04x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash key enumeration (size=20)
+
+```
+Warming up --------------------------------------
+      Hash.keys.each   118.004k i/100ms
+       Hash.each_key   118.320k i/100ms
+Calculating -------------------------------------
+      Hash.keys.each      1.176M (± 0.4%) i/s -      5.900M in   5.021554s
+       Hash.each_key      1.182M (± 0.2%) i/s -      5.916M in   5.006809s
+                   with 95.0% confidence
+
+Comparison:
+       Hash.each_key:  1181738.4 i/s
+      Hash.keys.each:  1175522.6 i/s - same-ish: difference falls within error
+                   with 95.0% confidence
+```
+
+#### Hash key enumeration (size=100)
+
+```
+Warming up --------------------------------------
+      Hash.keys.each    27.217k i/100ms
+       Hash.each_key    26.138k i/100ms
+Calculating -------------------------------------
+      Hash.keys.each    272.497k (± 0.0%) i/s -      1.388M in   5.093882s
+       Hash.each_key    260.563k (± 0.4%) i/s -      1.307M in   5.017483s
+                   with 95.0% confidence
+
+Comparison:
+      Hash.keys.each:   272497.2 i/s
+       Hash.each_key:   260563.2 i/s - 1.05x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash key enumeration (size=500)
+
+```
+Warming up --------------------------------------
+      Hash.keys.each     5.592k i/100ms
+       Hash.each_key     5.404k i/100ms
+Calculating -------------------------------------
+      Hash.keys.each     55.763k (± 0.2%) i/s -    279.600k in   5.014897s
+       Hash.each_key     54.060k (± 0.1%) i/s -    275.604k in   5.098253s
+                   with 95.0% confidence
+
+Comparison:
+      Hash.keys.each:    55763.3 i/s
+       Hash.each_key:    54060.3 i/s - 1.03x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash value enumeration (size=0)
+
+```
+Warming up --------------------------------------
+    Hash.values.each   922.361k i/100ms
+     Hash.each_value     1.372M i/100ms
+Calculating -------------------------------------
+    Hash.values.each      9.229M (± 0.0%) i/s -     47.040M in   5.096857s
+     Hash.each_value     13.736M (± 0.0%) i/s -     69.983M in   5.094986s
+                   with 95.0% confidence
+
+Comparison:
+     Hash.each_value: 13735592.7 i/s
+    Hash.values.each:  9229287.5 i/s - 1.49x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash value enumeration (size=5)
+
+```
+Warming up --------------------------------------
+    Hash.values.each   317.174k i/100ms
+     Hash.each_value   358.507k i/100ms
+Calculating -------------------------------------
+    Hash.values.each      3.190M (± 0.0%) i/s -     16.176M in   5.071511s
+     Hash.each_value      3.582M (± 0.0%) i/s -     17.925M in   5.004607s
+                   with 95.0% confidence
+
+Comparison:
+     Hash.each_value:  3581759.4 i/s
+    Hash.values.each:  3189555.5 i/s - 1.12x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash value enumeration (size=10)
+
+```
+Warming up --------------------------------------
+    Hash.values.each   201.766k i/100ms
+     Hash.each_value   209.128k i/100ms
+Calculating -------------------------------------
+    Hash.values.each      2.032M (± 0.0%) i/s -     10.290M in   5.065224s
+     Hash.each_value      2.093M (± 0.0%) i/s -     10.666M in   5.096053s
+                   with 95.0% confidence
+
+Comparison:
+     Hash.each_value:  2092905.3 i/s
+    Hash.values.each:  2031517.4 i/s - 1.03x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash value enumeration (size=20)
+
+```
+Warming up --------------------------------------
+    Hash.values.each   117.255k i/100ms
+     Hash.each_value   117.577k i/100ms
+Calculating -------------------------------------
+    Hash.values.each      1.182M (± 0.1%) i/s -      5.980M in   5.058729s
+     Hash.each_value      1.176M (± 0.0%) i/s -      5.996M in   5.098809s
+                   with 95.0% confidence
+
+Comparison:
+    Hash.values.each:  1182126.7 i/s
+     Hash.each_value:  1176047.5 i/s - 1.01x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash value enumeration (size=100)
+
+```
+Warming up --------------------------------------
+    Hash.values.each    27.263k i/100ms
+     Hash.each_value    26.208k i/100ms
+Calculating -------------------------------------
+    Hash.values.each    275.209k (± 0.0%) i/s -      1.390M in   5.052242s
+     Hash.each_value    261.696k (± 0.0%) i/s -      1.310M in   5.007358s
+                   with 95.0% confidence
+
+Comparison:
+    Hash.values.each:   275209.0 i/s
+     Hash.each_value:   261696.2 i/s - 1.05x  (± 0.00) slower
+                   with 95.0% confidence
+```
+
+#### Hash value enumeration (size=500)
+
+```
+Warming up --------------------------------------
+    Hash.values.each     5.586k i/100ms
+     Hash.each_value     5.408k i/100ms
+Calculating -------------------------------------
+    Hash.values.each     56.245k (± 0.2%) i/s -    284.886k in   5.066190s
+     Hash.each_value     54.104k (± 0.0%) i/s -    275.808k in   5.097780s
+                   with 95.0% confidence
+
+Comparison:
+    Hash.values.each:    56244.5 i/s
+     Hash.each_value:    54104.0 i/s - 1.04x  (± 0.00) slower
+                   with 95.0% confidence
+```