sharp_style_rubocop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2dde6c6fb7a92ad036e4ed2e6399e7bc3f9fdfc62e593cace245422da74c6afd
+  data.tar.gz: b38fc5c42ee28457adaca73692c4b1f774e87853b99f2f98e778fa45660cf576
+SHA512:
+  metadata.gz: f4923b6ff3f024e26b4048d355dec03f0f22e7fad232982591d43080bb132c22aba755cf4940dd868c883d3aa58be3692f18314da87a2b65bb286d3df590eb58
+  data.tar.gz: 44ac6573a7480cd6a300721afcb79106c37fb53d280f3297f6ff8c4cfada1b4516fa9b2bc0d9b2feb4bb52aebd5a8112d0b8ee16db37098077482c93d8c85a23

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+- Set `AllCops: NewCops: pending` so new cops added in RuboCop minor releases are reported but not enabled for consumers.
+- Set per-department `NewCops` so pending cops are enabled up to the versions reviewed: `Gemspec`, `Lint` and the other RuboCop departments are set to `1.92`, `Performance` to `1.24`, and `RSpec` to `3.10`.
+
+## [0.1.0] - 2026-10-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 joe-sharp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# SharpStyleRubocop
+
+My RuboCop style, packaged as a gem so every project can share the same rules.
+
+It bundles a RuboCop configuration (`config/default.yml`) along with the `rubocop-performance` and `rubocop-rspec` plugins it uses.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```bash
+bundle add sharp_style_rubocop --group development
+```
+
+Or install it directly:
+
+```bash
+gem install sharp_style_rubocop
+```
+
+## Usage
+
+Inherit the shared config from your project's `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  sharp_style_rubocop: config/default.yml
+```
+
+Then run RuboCop as usual:
+
+```bash
+bundle exec rubocop
+```
+
+Any rule you need to change for a single project can be overridden below the `inherit_gem` line in that project's `.rubocop.yml`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then run `bundle exec rake` to run the specs and RuboCop against this gem's own code.
+
+Run `bin/console` for an interactive prompt.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, bump `lib/sharp_style_rubocop/version.rb`, add an entry to `CHANGELOG.md`, and run `bundle exec rake release`.
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/joe-sharp/sharp_style_rubocop. Contributors are expected to follow the [code of conduct](https://github.com/joe-sharp/sharp_style_rubocop/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/default.yml

@@ -0,0 +1,310 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: pending
+  SuggestExtensions: false
+  # Preview of Rubocop 2.0 defaults to "warning"
+  FailLevel: refactor
+  Exclude:
+    - 'spec/fixtures/**/*'
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'node_modules/**/*'
+    - '.git/**/*'
+
+# Pending cops are enabled per department. A version value enables pending
+# cops added in that version or earlier; cops added after it stay pending.
+Bundler:
+  NewCops: '1.92'
+Gemspec:
+  NewCops: '1.92'
+Layout:
+  NewCops: '1.92'
+Lint:
+  NewCops: '1.92'
+Metrics:
+  NewCops: '1.92'
+Migration:
+  NewCops: '1.92'
+Naming:
+  NewCops: '1.92'
+# rubocop-performance plugin
+Performance:
+  NewCops: '1.24'
+# rubocop-rspec plugin
+RSpec:
+  NewCops: '3.10'
+Security:
+  NewCops: '1.92'
+Style:
+  NewCops: '1.92'
+# End NewCops overrides
+
+# Remove "Rubocop 2.0" overrides after upgrading to Rubocop 2.0
+
+# Prefer gems alphebetized in their groups
+Bundler/OrderedGems:
+  Enabled: true
+
+# Align 'when/else' with 'end', prevents wasting whitespace
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+# Prefer empty lines after Guard Clauses
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+# Rubocop 2.0
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+# Force Windows users to use lf
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+# Keep consistency, prevents wasting whitespace
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+# Keep consistency, prevents wasting whitespace
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Key is default for both, but also allow table alignment
+Layout/HashAlignment:
+  EnforcedHashRocketStyle:
+    - key
+    - table
+  EnforcedColonStyle:
+    - key
+    - table
+
+# Prevent wasting whitespace
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Prevent wasting whitespace
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Rubocop 2.0
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# Overriding median (Max: 28) from rubocop/rubocop#15363
+# Default (Max: 17)
+Metrics/AbcSize:
+  Max: 22
+
+# Disabling median (Max: 50), because CountAsOne makes
+# the default (Max: 25) reasonable
+Metrics/BlockLength:
+  AllowedMethods:
+    - describe
+    - context
+    - shared_examples
+    - shared_examples_for
+    - shared_context
+    - feature
+    - configure
+    - refine
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+# Overriding median (Max: 300), because CountAsOne makes
+# a lower number more reasonable. Default (Max: 100)
+Metrics/ClassLength:
+  Max: 200
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+# Thresholds are the median overrides from rubocop/rubocop#15363
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Thresholds are the median overrides from rubocop/rubocop#15363
+Metrics/MethodLength:
+  Max: 22
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+# Overriding median (Max: 240), because CountAsOne makes
+# a lower number more reasonable. Default (Max: 100)
+Metrics/ModuleLength:
+  Max: 200
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+# Thresholds are the median overrides from rubocop/rubocop#15363
+Metrics/ParameterLists:
+  Max: 6
+  CountKeywordArgs: false
+
+# Thresholds are the median overrides from rubocop/rubocop#15363
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Be kind
+Naming/InclusiveLanguage:
+  Enabled: true
+
+# Allow underscore to indicate private variable.
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: optional
+
+# Rubocop 2.0
+Naming/VariableNumber:
+  Enabled: false
+
+# CountAsOne makes ExampleLength default (Max: 5) more reasonable.
+# Keep an eye on this one, if it needs to be disabled frequently
+# we may want to raise it a little.
+RSpec/ExampleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+# Slight increase from default (Max: 3)
+RSpec/NestedGroups:
+  Max: 4
+
+# Increase from default (Max: 5), to avoid disabling entirely
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+# Rubocop 2.0
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+# Rubocop 2.0
+Style/BlockDelimiters:
+  Enabled: false
+
+# Rubocop 2.0
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Prefer documentation in my code, we like Boondoc!
+Style/Documentation:
+  Enabled: true
+
+# Rubocop 2.0
+Style/DoubleNegation:
+  Enabled: false
+
+# Rubocop 2.0
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Rubocop 2.0
+Style/FormatString:
+  Enabled: false
+
+# Rubocop 2.0
+Style/FormatStringToken:
+  Enabled: false
+
+# Rubocop 2.0
+# Don't disable this until Ruby 3.4 is minimum supported version
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always_true
+
+# Prefer early returns
+Style/GuardClause:
+  Enabled: true
+
+# Rubocop 2.0
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Rubocop 2.0
+Style/Lambda:
+  Enabled: false
+
+# Rubocop 2.0
+Style/ModuleFunction:
+  Enabled: false
+
+# Rubocop 2.0
+Style/NegatedIf:
+  Enabled: false
+
+# Rubocop 2.0
+Style/Next:
+  Enabled: false
+
+# Prefer underscores in long numbers
+# Disable inline for generated tables
+Style/NumericLiterals:
+  Enabled: true
+
+# Rubocop 2.0
+Style/NumericPredicate:
+  Enabled: false
+
+# Rubocop 2.0
+Style/ParallelAssignment:
+  Enabled: false
+
+# Rubocop 2.0
+Style/PerlBackrefs:
+  Enabled: false
+
+# Rubocop 2.0
+Style/RaiseArgs:
+  Enabled: false
+
+# Rubocop 2.0
+Style/RegexpLiteral:
+  Enabled: false
+
+# Rubocop 2.0
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+# Rubocop 2.0
+Style/SignalException:
+  Enabled: false
+
+# Prefer english names when available
+Style/SpecialGlobalVars:
+  Enabled: true
+  EnforcedStyle: use_builtin_english_names
+
+# Rubocop 2.0
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Rubocop 2.0
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Rubocop 2.0 override, allow consistency with WordArray
+Style/SymbolArray:
+  Enabled: false
+
+# Rubocop 2.0
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
+# Rubocop 2.0 override, saves a lot of characters
+Style/WordArray:
+  EnforcedStyle: percent
+  MinSize: 3

data/lib/sharp_style_rubocop/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SharpStyleRubocop
+  VERSION = "0.1.0"
+end

data/lib/sharp_style_rubocop.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "sharp_style_rubocop/version"
+
+# Shared RuboCop style. Projects load the rules with:
+#
+#   inherit_gem:
+#     sharp_style_rubocop: config/default.yml
+module SharpStyleRubocop
+  CONFIG_PATH = File.expand_path("../config/default.yml", __dir__)
+end

data/sig/sharp_style_rubocop.rbs

@@ -0,0 +1,4 @@
+module SharpStyleRubocop
+  VERSION: String
+  CONFIG_PATH: String
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sharp_style_rubocop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joe-sharp
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.92'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.92'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: RuboCop rules and plugin setup for Joe Sharp's Ruby projects, shared
+  as a gem so every project inherits the same style.
+email:
+- joesharp13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/sharp_style_rubocop.rb
+- lib/sharp_style_rubocop/version.rb
+- sig/sharp_style_rubocop.rbs
+homepage: https://github.com/joe-sharp/sharp_style_rubocop
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/joe-sharp/sharp_style_rubocop
+  changelog_uri: https://github.com/joe-sharp/sharp_style_rubocop/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: A shared RuboCop style configuration.
+test_files: []