upennlib-rubocop 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d92f8d5475c4a64b24e783ac198b2fa9e61faac9c3eb3029d87e2043824dedf0
-  data.tar.gz: 74851036d3023c32527f0acb1dd202601b64c91f8fe74481e11cf5b7c4625bf8
+  metadata.gz: 84a418d12e8ff592448b93d31b55d6ba579bd70a47f5fffbdd86b7987f277605
+  data.tar.gz: c94df285474498d629afe33c0e4a54b8b30452d4f90826b047f60d7791dac545
 SHA512:
-  metadata.gz: 2d47baa68d167f7113258550cf2bba49e986fe90d69860e7e07fae0c12ef3835eadcf3f31d8aeaddae031ec04a9b9518b139179e5c8b32f8f292ee5b0772136a
-  data.tar.gz: a4708f8fe29b941da92f1dd12d194c34cb01ff20ec4955ac4aca5c9485c6cedf13f6c3a9658af911d8abc8a5cfe686aa3082ba4d70f66a371ca708a4a6e32029
+  metadata.gz: d2518b3dcc8638aeb97752ed9769f659503fe0788022013079a8dec254459caadbfa5b9453c119a53fbf025ebff7c30909435f556bebe8d8a64be30f70e14040
+  data.tar.gz: 81da4fb784aae040581460316111056581a58c59838745b6669b231b924f608ed0e21e235639be7e238c63f471d0e790224e215c52e6aec174d0c762816e4661

data/README.md

@@ -4,13 +4,12 @@
 ## Purpose
 This gem will centralize our RuboCop configuration and ensure we are using the same version of RuboCop across various projects. Projects that use this gem should avoid adding their own custom, project-specific RuboCop configuration. Instead developers should make an MR to this project with the suggested changes and an explanation as to why its necessary. The goal of this gem is to avoid having projects with different RuboCop rules because it makes it hard for developers to focus on writing code if the style changes from project to project.
 
-
 ## Installation & Usage
 
 Add this line to your Gemfile:
 
 ```ruby
-gem 'upennlib-rubocop', require: false
+gem 'upennlib-rubocop', '~> 1.0', require: false
 ```
 
 And then execute:
@@ -33,6 +32,10 @@ Understandably, it can be difficult to address all RuboCop issues when adding ru
 rubocop --auto-gen-config  --auto-gen-only-exclude --exclude-limit 10000
 ```
 
+# Versioning
+The major versions of this gem will mirror the major RuboCop versions. New cops are disabled and new offenses will have
+to be addressed when upgrading to a major version.
+
 ## Publishing Gem
 To publish a new version of this gem to RubyGems:
 1. Update the version number in `upennlib-rubocop.gemspec`

data/upennlib-rubocop.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'upennlib-rubocop'
-  s.version     = '1.1.0'
+  s.version     = '1.2.0'
   s.summary     = "Rubocop style configuration to be used in UPenn Libraries Projects"
   s.description = "UPenn Libraries Rubocop Configuration"
-  s.authors     = ["Carla Galarza", "Mike Kanning"]
+  s.authors     = ["Carla Galarza", "Mike Kanning", "Patrick Perkins", "Amrey Mathurin"]
   s.email       = 'cgalarza@upenn.edu'
   s.files       = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
 

data/upennlib_rubocop_defaults.yml

@@ -10,7 +10,21 @@ inherit_mode:
     - Exclude # Merging exclude array values, instead of overriding
 
 AllCops:
-  NewCops: enable # Enabling all new cops. Problematic cops can be disabled on a case-by-case basis.
+  NewCops: disable # Disabling all new cops. New offenses will be addresses with major upgrades.
+
+# Allow for hashes to be aligned by `key` or in a `table` format. Default is just to allow `key`.
+Layout/HashAlignment:
+  EnforcedColonStyle:
+    - key
+    - table
+  EnforcedHashRocketStyle:
+    - key
+    - table
+
+# Don't require calls to +super+ because sometimes the superclass method has no behavior or behavior you explicitly want to avoid
+# See: https://github.com/rubocop/ruby-style-guide/issues/809
+Lint/MissingSuper:
+  Enabled: false
 
 Metrics/BlockLength:
   AllowedMethods: ['configure_blacklight']
@@ -20,25 +34,27 @@ Metrics/BlockLength:
     - 'spec/**/*.rb'
     - 'config/environments/**.rb'
 
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always_true # Force frozen string literal comment to always be set to true
-
-Style/Documentation:
-  Exclude:
-    - db/migrate/* # Migrations don't need top-level class documentation
+# Count multiline literals as one line in RSpec examples
+RSpec/ExampleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
 
 # Allowing two expectations per test in order to allow for aggregated failures, see: https://rspec.rubystyle.guide/#expectation-per-example
 RSpec/MultipleExpectations:
   Max: 2
 
-# Don't require calls to +super+ because sometimes the superclass method has no behavior or behavior you explicitly want to avoid
-# See: https://github.com/rubocop/ruby-style-guide/issues/809
-Lint/MissingSuper:
-  Enabled: false
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/Documentation:
+  Exclude:
+    - db/migrate/* # Migrations don't need top-level class documentation
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true # Force frozen string literal comment to always be set to true
 
 # Don't use ruby 3.1 hash value shorthand, see: https://docs.rubocop.org/rubocop/cops_style.html#enforcedshorthandsyntax-never
 Style/HashSyntax:
   EnforcedShorthandSyntax: never
-
-Style/BlockDelimiters:
-  EnforcedStyle: braces_for_chaining

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: upennlib-rubocop
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Carla Galarza
 - Mike Kanning
-autorequire:
+- Patrick Perkins
+- Amrey Mathurin
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -105,10 +107,10 @@ files:
 - README.md
 - upennlib-rubocop.gemspec
 - upennlib_rubocop_defaults.yml
-homepage:
+homepage: 
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -123,8 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Rubocop style configuration to be used in UPenn Libraries Projects
 test_files: []