radius-spec 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6b5e94783c4ccbdf8bdf80de184fc19cd52ac9ee9f2a7f92329b261bdb00f59
-  data.tar.gz: e492ea78f99e146011d2279e74fc1a3b1091aac13f311ef81324df43088ce440
+  metadata.gz: e8cf443a1c6510d208f4c05e3411461e850d11243ddfb8c72403cd6ad5cf42bb
+  data.tar.gz: b3eb1c7facabda9825bda8fd5d112e61bb9f356dabb0924846e103dda307633b
 SHA512:
-  metadata.gz: 83005750c2029b0a2765e176a8d819ed7984376c13ac17b881b442d055956ffd28548c32af56bb7298b1cc60d976c0c3cb25d10bbc2aed5bec0f4b16c72e8324
-  data.tar.gz: 95d8183b73cfa36c5f3e01680bf6d2212016e2355d0a14ed95b7d38800b4d2e44ce9d08dbcdd0336bf6beb20731bfb3a834258a13b6ad357443918c4ec505ae8
+  metadata.gz: 6c9172e6e540bc8826a5ba39084c7a26fbccace68c54445dc9ed67c07228ed83044be16547fd1ec4524fbe649cf000f384a0f430928a79c903a9ba2389ea3f47
+  data.tar.gz: 7a1903a1749717032feeea5f02c171e48173ea16a5bbc1f6ec5a3e487462aa47be3608906954d10f37d4526768e614c4ea5a023cf1b75fa9ca76e27e902d961d

data/CHANGELOG.md

@@ -1,3 +1,47 @@
+## 0.10.0 (October 18, 2021)
+
+[Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.9.0...v0.10.0)
+
+### Enhancements
+
+- Upgrade to Rubocop Rails 2.8.x (Aaron Hill, Aaron Kromer, Ben Reynolds, James Nebeker, JC Avena, Sam Kim, Alex
+  Stone #30, #32)
+- Adjust common Rubocop Rails configuration (Aaron Hill, Aaron Kromer, Ben Reynolds, James Nebeker, JC Avena,
+  Sam Kim, Alex Stone #30, #32)
+  - Enable `Rails/AttributeDefaultBlockValue` by default
+  - Enable `Rails/ArelStar` by default
+  - Enable `Rails/DefaultScope` by default
+  - Enable `Rails/FindById` by default
+  - Enable `Rails/PluckId` by default
+  - Enable `Rails/WhereEquals` by default
+  - Use the more aggressive `aggressive` check for `Rails/PluckInWhere`
+  - Use the more aggressive `aggressive` check for `Rails/ShortI18n`
+  - Switch to new `AllowedMethods` attribute name for `Rails/SkipsModelValidations`
+  - Disable `Rails/SquishedSQLHeredocs` by default
+- Adjust common Rubocop configuration (Aaron Hill, Aaron Kromer, JC Avena, Sam
+  Kim #32, #34)
+  - Enable `Style/ClassMethodsDefinitions` by default
+  - Enable `Style/CombinableLoops` by default
+  - Enable `Style/KeywordParametersOrder` by default
+  - Enable `Style/RedundantSelfAssignment` by default
+  - Enable `Style/SoleNestedConditional` by default
+  - Enable `Lint/DuplicateRequire` by default
+  - Enable `Lint/EmptyFile` by default
+  - Enable `Lint/TrailingCommaInAttributeDeclaration` by default
+  - Enable `Lint/UselessMethodDefinition` by default
+  - Exclude the following testing methods from `Metrics/BlockLength`
+    - 'describe'
+    - 'shared_context'
+    - 'shared_examples'
+    - 'RSpec.describe'
+    - 'RSpec.shared_context'
+    - 'RSpec.shared_examples'
+
+### Bug Fixes
+
+None
+
+
 ## 0.9.0 (September 30, 2021)
 
 [Full Changelog](https://github.com/RadiusNetworks/radius-spec/compare/v0.8.0...v0.9.0)

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/common_rubocop.yml

@@ -4,7 +4,7 @@ AllCops:
   # 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` to `pending`.
   NewCops: enable
   Exclude:
     # Exclude generated binstubs
@@ -217,9 +217,15 @@ Metrics/BlockLength:
     - 'spec/support/model_factories.rb'
   ExcludedMethods:
     - 'chdir'
+    - 'describe'
     - 'refine'
+    - 'shared_context'
+    - 'shared_examples'
     - 'Capybara.register_driver'
     - 'RSpec.configure'
+    - 'RSpec.describe'
+    - 'RSpec.shared_context'
+    - 'RSpec.shared_examples'
     - 'VCR.configure'
 
 # We want length related code metrics to count Hashs, Arrays, and
@@ -395,6 +401,15 @@ Style/BlockDelimiters:
     - proc
     - it
 
+# As a team we prefer the more explicit `def self.method_name` style. We find
+# the explicitness easier to read and grep for on the CLI.
+#
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: def_self, self_class
+Style/ClassMethodsDefinitions:
+  Enabled: true
+  EnforcedStyle: def_self
+
 # Prefer `Time` over `DateTime`.
 #
 # While these are not necessarily interchangeable we prefer `Time`. According

data/common_rubocop_rails.yml

@@ -106,6 +106,11 @@ Rails/ApplicationRecord:
 Rails/CreateTableWithTimestamps:
   Enabled: false
 
+# This cop looks for uses of default_scope because named scopes are preferred:
+# https://rails.rubystyle.guide/#named-scopes
+Rails/DefaultScope:
+  Enabled: 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.
 #
@@ -119,6 +124,11 @@ Rails/FindBy:
     - 'app/**/*.rb'
     - 'lib/**/*.rb'
 
+# This cop enforces that ActiveRecord#find is used instead of where.take!, find_by!, and find_by_id!
+# to retrieve a single record by primary key when you expect it to be found.
+Rails/FindById:
+  Enabled: true
+
 # 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.
@@ -174,6 +184,21 @@ Rails/IndexBy:
 Rails/IndexWith:
   Enabled: false
 
+# This cop enforces the use of ids over pluck(:id) and pluck(primary_key).
+# https://rails.rubystyle.guide/#ids
+Rails/PluckId:
+  Enabled: true
+
+# This cop identifies places where pluck is used in where query methods and can be replaced with
+# select. Since pluck is an eager method and hits the database immediately, using select helps to
+# avoid additional database queries.
+#
+# When the EnforcedStyle is aggressive then all calls to pluck in the where is used as offenses.
+# This may lead to false positives as the cop cannot replace to select between calls to pluck on an
+# ActiveRecord::Relation instance vs a call to pluck on an Array instance.
+Rails/PluckInWhere:
+  EnforcedStyle: aggressive
+
 # The ActiveSupport monkey patches for `present?` are nearly all defined as:
 #
 #     !blank?
@@ -234,6 +259,13 @@ Rails/ReadWriteAttribute:
 Rails/SaveBang:
   Enabled: true
 
+# This cop enforces that short forms of I18n methods are used: t instead of translate and l instead
+# of localize. We want this because it's a pain to use the full method names over and over in view
+# code. When the EnforcedStyle is aggressive then all translate and localize calls without a
+# receiver are added as offenses.
+Rails/ShortI18n:
+  EnforcedStyle: aggressive
+
 # 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:
@@ -251,14 +283,19 @@ Rails/SaveBang:
 #   - 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
+# Configuration parameters: ForbiddenMethods, AllowedMethods.
+# ForbiddenMethods: decrement!, decrement_counter, increment!, increment_counter, toggle!, touch, update_all, update_attribute, update_column, update_columns, update_counters
 Rails/SkipsModelValidations:
-  Whitelist:
+  AllowedMethods:
     - 'decrement!'
     - 'increment!'
     - 'touch'
 
+# We don't want to be forced to use squish in SQL or JSON heredocs (especially
+# in specs).
+Rails/SquishedSQLHeredocs:
+  Enabled: false
+
 # 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).
 #

data/lib/radius/spec/model_factory.rb

@@ -110,6 +110,14 @@ module Radius
       class TemplateNotFound < KeyError; end
 
       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
+        # drop support for Ruby < 2.7 we can switch styles and use:
+        #
+        #     singleton_class.alias_method :factory, :define_factory
+
         # Suggested method for defining multiple factory templates at once.
         #
         # Most projects end up having many domain models which need factories
@@ -283,6 +291,7 @@ module Radius
         def templates
           @templates ||= {}
         end
+        # rubocop:enable Style/ClassMethodsDefinitions
       end
 
     module_function

data/lib/radius/spec/version.rb

@@ -2,6 +2,6 @@
 
 module Radius
   module Spec
-    VERSION = "0.9.0"
+    VERSION = "0.10.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.89.0"
-  spec.add_runtime_dependency "rubocop-rails", "~> 2.6.0"
+  spec.add_runtime_dependency "rubocop", "~> 0.90.0"
+  spec.add_runtime_dependency "rubocop-rails", "~> 2.9.1"
 
   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.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Radius Networks
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.0
+        version: 0.90.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.0
+        version: 0.90.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.9.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - benchmarks/style_hash_like_case.rb
 - benchmarks/unfreeze_string.rb
 - benchmarks/unpack_first.rb
+- bin/bundle
 - bin/ci
 - bin/console
 - bin/pry
@@ -150,8 +151,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.9.0/CHANGELOG.md
-  source_code_uri: https://github.com/RadiusNetworks/radius-spec/tree/v0.9.0
+  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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Radius Networks RSpec setup and plug-ins