upennlib-rubocop 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9e4e8cd547cf1648e25a760f15c6463a6b59e07
+  data.tar.gz: f24e2d6ce2af49f642968fa16490f85fb6dcfae2
+SHA512:
+  metadata.gz: c0f77802ed8278d3a71e0dea370860d6c6ada800b6cf531dded97bd6219f25dd55604304374c500b5bf71d56ed0a7df75fd8ba1b4e4e07a19f71fdf94000ecfa
+  data.tar.gz: dcd4a8dff50fe032635e2a1beb3b0ac8f35656d0d511a23dba770b81b9c347ed8b2c0f6483ba7d59603da349b18ffaddbf61025d3678249852c33797d135b27d

data/README.md

@@ -0,0 +1,36 @@
+# UPenn Libraries RuboCop
+[RuboCop](https://rubocop.org/) defaults for UPenn Libraries projects. Enforces a consistent Ruby style on our applications and gems.
+
+## 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
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+In your `.rubocop.yml`:
+
+```yml
+inherit_gem:
+  upennlib-rubocop: upennlib_rubocop_defaults.yml
+```
+
+## .rubocop_todo.yml
+Understandably, it can be difficult to address all RuboCop issues when adding rubocop to a current project. If you want to delay fixing these issues, creating a `.rubocop_todo.yml` creates a list of exclusions for your RuboCop configuration. Using the following command creates a rubocop_todo configuration that only excludes files from cops instead of enabling/disabling cops and changing configuration values.
+
+```
+rubocop --auto-gen-config  --auto-gen-only-exclude --exclude-limit 10000
+```
+
+

data/upennlib-rubocop.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'upennlib-rubocop'
+  s.version     = '1.0.1'
+  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.email       = 'cgalarza@upenn.edu'
+  s.files       = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+
+  s.add_dependency 'rubocop', '~> 1.24'
+  s.add_dependency 'rubocop-performance'
+  s.add_dependency 'rubocop-rails'
+  s.add_dependency 'rubocop-rake'
+  s.add_dependency 'rubocop-rspec'
+end

data/upennlib_rubocop_defaults.yml

@@ -0,0 +1,36 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - 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.
+
+Metrics/BlockLength:
+  IgnoredMethods: ['configure_blacklight']
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - '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
+
+# 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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: upennlib-rubocop
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Carla Galarza
+- Mike Kanning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: UPenn Libraries Rubocop Configuration
+email: cgalarza@upenn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- upennlib-rubocop.gemspec
+- upennlib_rubocop_defaults.yml
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Rubocop style configuration to be used in UPenn Libraries Projects
+test_files: []