radius-spec 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8cf443a1c6510d208f4c05e3411461e850d11243ddfb8c72403cd6ad5cf42bb
-  data.tar.gz: b3eb1c7facabda9825bda8fd5d112e61bb9f356dabb0924846e103dda307633b
+  metadata.gz: 8866a2f90557e85b2974af975e2461737ee1393031ffa7ab5aeacfcd9b2b2c46
+  data.tar.gz: 5f04fb6044c683d90c7cd331423c069fd97b6bd1e2de54a6251051a52b86c23c
 SHA512:
-  metadata.gz: 6c9172e6e540bc8826a5ba39084c7a26fbccace68c54445dc9ed67c07228ed83044be16547fd1ec4524fbe649cf000f384a0f430928a79c903a9ba2389ea3f47
-  data.tar.gz: 7a1903a1749717032feeea5f02c171e48173ea16a5bbc1f6ec5a3e487462aa47be3608906954d10f37d4526768e614c4ea5a023cf1b75fa9ca76e27e902d961d
+  metadata.gz: ee3d463a37fee11380d6700ed966068fdf20ac19d1636a9e577959c633bdde2d04657dca074b6e6c53a24f536d637f254340c7c775853a20214691698218f0fd
+  data.tar.gz: 014b79fb72b9ef1ecb07e8d6ec01e660755eef2dc484d807e525a62d975e624392ab92f990f2ee80acbaa6b8b3bcd6020a8b27613e0d7a6c67bca94bf6a1476f

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 0.11.0 (January 21, 2022)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.10.0...0.11.0)
+
+### Enhancements
+
+- Adjust common Rubocop configuration (Aaron Hill, Aaron Kromer, Ben Reynolds, James Nebeker, JC Avena, Sam Kim)
+  - Enable `Lint/NoReturnInBeginEndBlocks` by default
+  - Set `AllowHttpProtocol: false` for `Bundler/InsecureProtocolSource` cop
+  - Set `AllowNil: false` for `Lint/SuppressedException` cop
+  - Enable `Naming/BlockForwarding` cop for future Ruby 3.1 usage
+  - Disallow Ruby 3 `Style/NumberedParameters`
+  - Enable `Style/StringChars` by default
+  - Set `AllowMethodsWithArguments: true` for `Style/SymbolProc` cop
+  - Disallow combined `&&` and `||` in single `unless` clauses
+  - Enable `Naming/InclusiveLanguage` by default
+- Adjust common Rubocop-Rails configuration (Alex Stone, James Nebeker, Aaron Kromer, Ben Reynolds, Sam Kim)
+  - Enable `Rails/EnvironmentVariableAccess` (`AllowReads` to `true`)
+  - Changed `Rails/FindBy`:`IgnoreWhereFirst` to `false`
+  - Enable `Rails/ReversibleMigrationMethodDefinition`
+- Upgrade to Rubocop Rails 2.12.x (Alex Stone, James Nebeker, Aaron Kromer, Ben Reynolds, Sam Kim)
+- Upgrade to Rubocop Rails 2.13.x (Alex Stone, James Nebeker, Aaron Kromer, Ben Reynolds, Sam Kim)
+- Upgrade to Rubocop 1.25.x (Alex Stone, James Nebeker, Aaron Kromer, Ben Reynolds, Sam Kim, JC Avena, Eric Ouellette, Aaron Hill)
+- Include model factory helpers in helper specs by default (Alex Stone, James Nebeker, Aaron Kromer, Ben Reynolds, JC Avena, Eric Ouellette)
+
+### Bug Fixes
+
+None
+
 ## 0.10.0 (October 18, 2021)
 
 [Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.9.0...v0.10.0)

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' # rubocop:disable Style/FormatStringToken
+    '%10s' % 'hoge'
   end
 
   bench.report("format") do
-    format '%10s', 'hoge' # rubocop:disable Style/FormatStringToken
+    format '%10s', 'hoge'
   end
 
   bench.report("sprintf") do
-    sprintf '%10s', 'hoge' # rubocop:disable Style/FormatStringToken
+    sprintf '%10s', 'hoge'
   end
 end
 # rubocop:enable Style/FormatString

data/benchmarks/hash_transform.rb

@@ -13,7 +13,7 @@ end
 
 # Bad per Rubocop
 def hash_transform_key_hash_collect(hash)
-  Hash[hash.collect { |k, v| [k + 100, v] }]
+  Hash[hash.collect { |k, v| [k + 100, v] }] # rubocop:disable Style/HashConversion
 end
 
 # Bad per Rubocop
@@ -73,7 +73,7 @@ end
 
 # Bad per Rubocop
 def hash_transform_value_hash_collect(hash)
-  Hash[hash.collect { |k, v| [k, v + 100] }]
+  Hash[hash.collect { |k, v| [k, v + 100] }] # rubocop:disable Style/HashConversion
 end
 
 # Bad per Rubocop

data/common_rubocop.yml

@@ -24,6 +24,11 @@ AllCops:
     # Exclude vendored content
     - 'vendor/**/*'
 
+# We would like to disallow http for bundler sources and enforce https
+# as it is more secure.
+Bundler/InsecureProtocolSource:
+  AllowHttpProtocol: false
+
 # We prefer outdented access modifiers as we feel they provide demarcation of
 # the class similar to `rescue` and `ensure` in a method.
 #
@@ -36,6 +41,18 @@ Layout/AccessModifierIndentation:
     similar to `rescue` and `ensure` in a method.
   EnforcedStyle: outdent
 
+# This cop checks whether the end keyword of begin is aligned properly.
+#
+# Two modes are supported through the EnforcedStyleAlignWith configuration parameter. If it’s set to
+# begin, the end shall be aligned with the begin keyword. We chose this to be consistent with our if
+# statement styles, if you want the end to be aligned with the start of the line just put the begin
+# on the next line.
+#
+# Configuration parameters: EnforcedStyleAlignWith
+# SupportedStyles: start_of_line, begin
+Layout/BeginEndAlignment:
+  EnforcedStyleAlignWith: begin
+
 # 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:
@@ -155,6 +172,18 @@ Layout/MultilineOperationIndentation:
 #     }.to change {
 #       object.state
 #     }
+#
+# WARNING TO FUTURE READERS (future being after 2021-12-10):
+# We tried to allowlist certain methods using the IgnoredMethods option (introduced 1.13.0),
+# and Rubocop successfully ignored `change` and `not_change` constructions, but it flag false
+# positives against code like
+#
+# expect { something }
+#   .to enqueue_job(SomeJobClass)
+#   .with { custom expectations about the enqueued payload }
+#
+# no matter what combination of `enqueue_job` and `with` we tried to add to the IgnoredMethods
+# array. We suspect the AST matching is somewhat half-baked.
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - 'spec/**/*_spec.rb'
@@ -184,6 +213,10 @@ Lint/HeredocMethodCallPosition:
 Lint/InheritException:
   EnforcedStyle: standard_error
 
+# Make developers explain themselves in a comment if they want their rescue block to do nothing.
+Lint/SuppressedException:
+  AllowNil: false
+
 # 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.
@@ -194,16 +227,11 @@ Lint/Void:
     - '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
+  CountRepeatedAttributes: false
   Max: 17
 
-# Configuration parameters: CountComments, ExcludedMethods, Max.
-# ExcludedMethods: refine
+# Configuration parameters: CountComments, IgnoredMethods, Max.
+# IgnoredMethods: refine
 Metrics/BlockLength:
   CountAsOne:
     - 'array'
@@ -215,7 +243,7 @@ Metrics/BlockLength:
     - 'spec/spec_helper.rb'
     - 'spec/**/*_spec.rb'
     - 'spec/support/model_factories.rb'
-  ExcludedMethods:
+  IgnoredMethods:
     - 'chdir'
     - 'describe'
     - 'refine'
@@ -256,6 +284,21 @@ Metrics/MethodLength:
 Naming/BinaryOperatorParameterName:
   Enabled: false
 
+# We don't need this configured just yet, because we dont have any applications on
+# Ruby 3.1, but pre-emptively, we want to configure this to prefer the explicit style.
+# 
+# bad
+# def foo(&)
+#   bar(&)
+# end
+
+# good
+# def foo(&block)
+#   bar(&block)
+# end
+Naming/BlockForwarding:
+  EnforcedStyle: explicit
+
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
@@ -345,6 +388,9 @@ Style/AndOr:
 # These days most people have editors which support unicode and other
 # non-ASCII characters.
 #
+# In version 1.21.0, this is disabled by default. We've chosen to leave
+# it in the config, in case it changes in future versions.
+#
 # Configuration parameters: AllowedChars.
 Style/AsciiComments:
   Enabled: false
@@ -511,6 +557,7 @@ Style/HashSyntax:
     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.
   EnforcedStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: either
 
 # As part of our semantic style we generally use the literal `-> { }` format to
 # indicate this is a function with a return value we care about. As this cop
@@ -541,6 +588,11 @@ Style/MethodCalledOnDoEndBlock:
 Style/MultilineBlockChain:
   Enabled: false
 
+# Disallowing numbered parameter usage because we dont prefer this style.
+# We would rather name the paramaters to clearly communicate intent.
+Style/NumberedParameters:
+  EnforcedStyle: disallow
+
 # Context for this cop is too dependent.
 #
 # Often using the numeric comparison is faster. Also, depending on the context
@@ -557,6 +609,12 @@ Style/MultilineBlockChain:
 Style/NumericPredicate:
   Enabled: false
 
+# As a general rule, we want to be explicit here instead of requiring readers
+# of our code to know what the default arguments to methods like `#join` and
+# and `#split` so we disable this cop here.
+Style/RedundantArgument:
+  Enabled: false
+
 # In Ruby every method returns a value. Implicitly this is the value of the
 # last line of the method. This means using `return` is often redundant.
 # However, there isn't anything inherently wrong about doing so. In fact, in
@@ -669,6 +727,15 @@ Style/RescueStandardError:
 Style/SlicingWithRange:
   Enabled: false
 
+# We want to turn this cop on so that rubocop can yell at us instead of Aaron
+# yelling at us.
+Style/StaticClass:
+  Enabled: true
+
+# Enable Style/StringChars
+Style/StringChars:
+  Enabled: true
+
 # 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.
@@ -699,6 +766,13 @@ Style/StringLiteralsInInterpolation:
 Style/SymbolArray:
   MinSize: 3
 
+# Allow either
+#   something.do_something(foo, &:bar)
+# or
+#   something.do_something(foo) { |s| s.bar }
+Style/SymbolProc:
+  AllowMethodsWithArguments: true
+
 # When ternaries become complex they can be difficult to read due to increased
 # cognitive load parsing the expression. Cognitive load can increase further
 # when assignment is involved.
@@ -761,6 +835,11 @@ Style/TrailingCommaInHashLiteral:
     simplifies adding, removing, and re-arranging the elements.
   EnforcedStyleForMultiline: consistent_comma
 
+# Don't combine && & || inside the same `unless` guard clause.
+Style/UnlessLogicalOperators:
+  Enabled: true
+  EnforcedStyle: forbid_mixed_logical_operators
+
 # We don't feel too strongly about percent vs bracket array style. We tend to
 # use the percent style, which also happens to be Rubocop's default. So for
 # pedantic consistency we'll enforce this.
@@ -780,3 +859,7 @@ Style/WordArray:
 # SupportedStyles: all_comparison_operators, equality_operators_only
 Style/YodaCondition:
   Enabled: false
+
+# Disabled in 1.21.0. Radius Networks has chosen to enable it.
+Naming/InclusiveLanguage:
+  Enabled: true

data/common_rubocop_rails.yml

@@ -111,15 +111,25 @@ Rails/CreateTableWithTimestamps:
 Rails/DefaultScope:
   Enabled: true
 
+# We were originally going to disable this, but after much discussion agreed that enabling
+# this cop with AllowReads: true should be relatively painless.
+Rails/EnvironmentVariableAccess:
+  Enabled: true
+  AllowReads: 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.
 #
 # Since rake tasks often live in `lib` we also check all of lib as well.
 #
+# We are also disabling the default IgnoreWhereFirst that was added in version
+# 2.11
+#
 # Configuration parameters: Include.
 # Include: app/models/**/*.rb
 Rails/FindBy:
   Enabled: true
+  IgnoreWhereFirst: false
   Include:
     - 'app/**/*.rb'
     - 'lib/**/*.rb'
@@ -228,6 +238,10 @@ Rails/Present:
 Rails/ReadWriteAttribute:
   Enabled: false
 
+# Enabling this because it is disabled by default and we want it.
+Rails/ReversibleMigrationMethodDefinition:
+  Enabled: true
+
 # 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.

data/lib/radius/spec/model_factory.rb

@@ -109,8 +109,7 @@ module Radius
       # factory {Radius::Spec::ModelFactory.catalog}.
       class TemplateNotFound < KeyError; end
 
-      class << self
-        # rubocop:disable Style/ClassMethodsDefinitions
+      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
@@ -291,7 +290,6 @@ module Radius
         def templates
           @templates ||= {}
         end
-        # rubocop:enable Style/ClassMethodsDefinitions
       end
 
     module_function

data/lib/radius/spec/rspec.rb

@@ -133,6 +133,11 @@ RSpec.configure do |config|
     config.include Radius::Spec::ModelFactory, type: :feature
   end
 
+  config.when_first_matching_example_defined(type: :helper) do
+    require 'radius/spec/model_factory'
+    config.include Radius::Spec::ModelFactory, type: :helper
+  end
+
   config.when_first_matching_example_defined(type: :job) do
     require 'radius/spec/model_factory'
     config.include Radius::Spec::ModelFactory, type: :job

data/lib/radius/spec/vcr.rb

@@ -10,15 +10,15 @@ VCR.configure do |config|
   config.ignore_localhost = true
 
   record_mode = case
+                when ENV['CI']
+                  # Never let CI record
+                  :none
                 when RSpec.configuration.files_to_run.one?
                   # When developing new features we often run new specs in
                   # isolation as we write the code. This is the time to allow
                   # creating the cassettes.
                   :once
-                when ENV['CI']
-                  # Never let CI record
-                  :none
-                else
+                else # rubocop:disable Lint/DuplicateBranch
                   # Default to blocking new requests to catch issues
                   :none
                 end

data/lib/radius/spec/version.rb

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

data/radius-spec.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
     "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",
     "source_code_uri" => "https://github.com/RadiusNetworks/radius-spec/tree/v#{Radius::Spec::VERSION}",
+    "rubygems_mfa_required" => "true",
   }
   spec.summary       = "Radius Networks RSpec setup and plug-ins"
   spec.description   = "Standard RSpec setup and a collection of plug-ins " \
@@ -31,8 +32,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.90.0"
-  spec.add_runtime_dependency "rubocop-rails", "~> 2.9.1"
+  spec.add_runtime_dependency "rubocop", "~> 1.25.0"
+  spec.add_runtime_dependency "rubocop-rails", "~> 2.13.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.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Radius Networks
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 1.25.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.1
+        version: 2.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.1
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,8 +151,9 @@ 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.10.0/CHANGELOG.md
-  source_code_uri: https://github.com/RadiusNetworks/radius-spec/tree/v0.10.0
+  changelog_uri: https://github.com/RadiusNetworks/radius-spec/blob/v0.11.0/CHANGELOG.md
+  source_code_uri: https://github.com/RadiusNetworks/radius-spec/tree/v0.11.0
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -168,7 +169,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