rubocop-boochtek 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b02de4ada297f8524fa07a7104ba7ba709df9bdf01293b644ee407b6a8459dd
+  data.tar.gz: 79828971327eb8186d681f022f40028e0118c97bd81e287ea04c105276ebbbdf
+SHA512:
+  metadata.gz: b5189e192ba4e1cb7a33e4b1356de89fb468399d73983ea3573bab18d369434804426a74b2f6a01939838a11c543ebc03f4b0b5fc661af84f39695c50e2075de
+  data.tar.gz: '08cc3863e0eb14aad60668b1d66d570e396f9d9d59e9f5eaea2e375c93030a3a62cecc711a03af319b7a1172cdb1a32040254b4b5dfbe1f7e8838aeee761b59c'

data/.rubocop.yml

@@ -0,0 +1,8 @@
+---
+# Use our own configuration for this gem.
+inherit_from:
+  - config/default.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2025-12-06
+
+### Added
+- New custom cop `Boochtek/CompactEndlessMethods` - removes blank lines between consecutive endless method definitions
+- Comprehensive test suite with RSpec for the custom cop
+- Support for both instance methods (`def foo = @foo`) and class methods (`def self.foo = "foo"`)
+
+### Changed
+- Updated gemspec to explicitly list included files instead of using `git ls-files`
+- Added RSpec as a development dependency
+
+## [0.1.0] - 2024-12-05
+
+### Added
+- Initial release
+- Base RuboCop configuration extracted from BoochTek projects
+- LintRoller plugin for modern RuboCop (1.72+)
+- Dependencies on rubocop-rspec and rubocop-performance
+- Support for custom cops in `lib/rubocop/cop/boochtek/`

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Craig Buchek / BoochTek, LLC
+
+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,130 @@
+# RuboCop BoochTek
+
+BoochTek's shared RuboCop configuration for Ruby projects.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem "rubocop-boochtek", github: "boochtek/rubocop-boochtek"
+end
+```
+
+Or install directly:
+
+```bash
+gem install rubocop-boochtek
+```
+
+## Usage
+
+Create a `.rubocop.yml` in your project root:
+
+```yaml
+plugins:
+  - rubocop-boochtek
+```
+
+That's it! The gem automatically loads `rubocop-rspec` and `rubocop-performance`.
+
+### Overriding Settings
+
+Override any settings in your project's `.rubocop.yml`:
+
+```yaml
+plugins:
+  - rubocop-boochtek
+
+Layout/LineLength:
+  Max: 160
+
+AllCops:
+  NewCops: enable
+```
+
+## Key Style Decisions
+
+### `private def` (Inline Access Modifiers)
+
+We prefer `private def` over a separate `private` section:
+
+```ruby
+# Good
+private def my_method
+  # ...
+end
+
+# Avoided
+private
+
+def my_method
+  # ...
+end
+```
+
+This makes it easier to see at a glance which methods are private, and makes moving methods around simpler.
+
+### Semantic Block Delimiters
+
+Use `{}` for blocks that return a value; use `do`/`end` otherwise:
+
+```ruby
+# Good - returns a value
+names = users.map { |u| u.name }
+
+# Good - side effects only
+users.each do |user|
+  send_email(user)
+end
+```
+
+### Double Quotes
+
+We use double quotes by default for strings, as they require fewer changes when you later need interpolation.
+
+### Other Notable Preferences
+
+- Line length: 120 characters
+- No frozen string literal comments required
+- No documentation required for classes/modules
+- `fail` for raising exceptions, `raise` for re-raising
+- `%x[]` for shell commands (not backticks)
+- Unicode allowed in comments and identifiers
+
+## Adding Custom Cops
+
+Create cops in `lib/rubocop/cop/boochtek/`:
+
+```ruby
+# lib/rubocop/cop/boochtek/my_custom_cop.rb
+module RuboCop
+  module Cop
+    module Boochtek
+      class MyCustomCop < Base
+        MSG = "Custom message here"
+
+        def on_send(node)
+          # ...
+        end
+      end
+    end
+  end
+end
+```
+
+Custom cops are auto-loaded when the gem is required.
+
+## Development
+
+```bash
+git clone https://github.com/boochtek/rubocop-boochtek
+cd rubocop-boochtek
+bundle install
+bundle exec rake
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task default: %i[]

data/config/default.yml

@@ -0,0 +1,277 @@
+---
+# BoochTek's RuboCop Configuration
+# https://github.com/boochtek/rubocop-boochtek
+
+plugins:
+  - rubocop-performance
+  - rubocop-rspec
+
+# Provide more details in output.
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  NewCops: pending
+  SuggestExtensions: false
+
+# Gem convention uses hyphens in filenames.
+Naming/FileName:
+  Exclude:
+    - "**/rubocop-*.rb"
+
+# Allow longer lines.
+Layout/LineLength:
+  Max: 120
+
+# Don't require documentation for everything.
+Style/Documentation:
+  Enabled: false
+
+# Allow any Unicode in comments.
+Style/AsciiComments:
+  Enabled: false
+
+# Require `private` to be used as a prefix to private method definitions.
+# We find this easier to read and move code.
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+# Use `{}` for blocks that return a value; otherwise use `do` and `end`.
+# We make a few exceptions, mostly for RSpec and DSLs.
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  FunctionalMethods:
+    - expect
+  AllowedMethods:
+    # RSpec
+    - let
+    - let!
+    - subject
+    # DSL methods (grammar/parser DSLs)
+    - rule
+    - rule!
+    - token
+    - terminal
+    - terminal!
+    - grammar
+    - transforms
+    - transform
+
+# Don't require `freeze` on every immutable constant.
+Style/MutableConstant:
+  Enabled: false
+
+# Don't require adding `# frozen_string_literal: true` to every file.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Don't use backticks for shell commands -- they're too hard to distinguish.
+Style/CommandLiteral:
+  EnforcedStyle: percent_x
+
+# Don't require underscores for long numeric literals (but warn about them).
+Style/NumericLiterals:
+  Severity: warning
+
+# Allow (but don't require) extra empty lines.
+Layout/EmptyLines:
+  Enabled: false
+
+# Don't require empty methods to have the `def` and `end` on a single line.
+Style/EmptyMethod:
+  Enabled: false
+
+# Use `[]` for `%w`, to remind us that we're creating an Array.
+# Use `[]` for `%x`, because it looks kind of like an input box.
+# Use `{}` for `%q`, because it's set off a bit nicer than `()`.
+# Use `{}` for `%r`, because regular expressions might have unbalanced `()` or `<>`.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+    '%x': '[]'
+    '%': '{}'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+
+# Allow explicit `self`, as it adds clarity on occasion.
+Style/RedundantSelf:
+  Enabled: false
+
+# Use `%r` for regular expressions that span more than 1 line.
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+# Use Jim Weirich's suggestion of using `fail`, except when re-raising an exception.
+Style/SignalException:
+  EnforcedStyle: semantic
+
+# Provide a better description, due to high probability of false positives.
+Lint/RaiseException:
+  Enabled: true
+  Description: Use `StandardError`, or prefix `Exception` with a namespace.
+
+# Default to double quotes, as they require less incidental changes.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Allow either type of quotes within Ruby code inside interpolations.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# Allow (but don't require) a space before a block brace.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+# Don't allow a space directly inside a Hash literal.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Require a space directly inside a block delineated with braces.
+# This is the default, but I wanted to call it out in contrast to Hash literals.
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: true
+
+# When using multi-line Arrays and Hashes, ensure the first element is also on its own line.
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+# Allow (but don't require) trailing comma in Array and Hash literals.
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+# Don't complain about the block comments generated by RSpec.
+Style/BlockComments:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Prefer `__send__` or `public_send` over `send`.
+Style/Send:
+  Enabled: true
+
+# Don't complain that `has_many` doesn't end with a question mark.
+Naming/PredicatePrefix:
+  AllowedMethods:
+    - is_a?
+    - has_many
+    - has_rule?
+
+# Allow `has_key?` and `has_value?` on Hash, as I think they read better than `key?` and `value?`.
+Style/PreferredHashMethods:
+  Enabled: false
+
+# Ensure there's a newline at the end of the file, but not a blank line.
+Layout/TrailingEmptyLines:
+  EnforcedStyle: final_newline
+
+# Allow assigning to the same variable in multiple branches of an `if` or `case`.
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Allow long blocks in specs and tests.
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+# Don't require use of Ruby 2.3+ safe navigation operator.
+Style/SafeNavigation:
+  Enabled: false
+
+# Allow `!!` to force a boolean result.
+Style/DoubleNegation:
+  Enabled: false
+
+# I prefer to order my gems in order of "importance".
+Bundler/OrderedGems:
+  Enabled: false
+
+# Don't require an empty line after a guard clause.
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# Allow (but don't require) putting each accessor on its own line.
+Style/AccessorGrouping:
+  Enabled: false
+
+# I don't see any good reason to call `super` when the superclass has no explicit `initialize`.
+# See https://github.com/rubocop-hq/rubocop/issues/8506 for more details.
+Lint/MissingSuper:
+  Enabled: false
+
+# Don't require any specific format when using exponential notation (like `10e6` or `1.0e7`).
+Style/ExponentialNotation:
+  Enabled: false
+
+# Allow `nil` to be the only thing inside a lambda block.
+Style/NilLambda:
+  Enabled: false
+
+# Allow `chars.last(count)` and `chars.drop(count)` on String.
+Performance/RedundantStringChars:
+  Enabled: false
+
+# Allow passing a method object as a block (using `&` and `method`).
+Performance/MethodObjectAsBlock:
+  Enabled: false
+
+# Prefer `class X < Data.define(...)` over `X = Data.define(...)`.
+# It makes nested constants work as expected.
+# See https://allaboutcoding.ghinda.com/more-about-how-to-create-a-data-class-in-ruby for details.
+Style/DataInheritance:
+  Enabled: false
+
+# Allow long specs.
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+
+
+# =============================================================================
+# BoochTek Custom Cops
+# =============================================================================
+
+# Remove blank lines between consecutive endless (one-liner) method definitions.
+Boochtek/CompactEndlessMethods:
+  Enabled: true
+
+
+# =============================================================================
+# RSpec Configuration
+# =============================================================================
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/ExampleLength:
+  Max: 10
+
+
+# =============================================================================
+# Workarounds for RuboCop bugs
+# =============================================================================
+
+# These cops seem to be broken; I *have* empty lines around class/module/block bodies.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# This is broken. It assumes that a comment following a `private def` should be indented 2 extra spaces.
+Layout/CommentIndentation:
+  Enabled: false
+
+# This rule requires arrays in arguments to be formatted poorly.
+Layout/FirstArrayElementIndentation:
+  Enabled: false

data/lib/rubocop/boochtek/plugin.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+require_relative "version"
+
+# Load custom cops
+cop_dir = File.expand_path("../cop/boochtek", __dir__)
+if File.directory?(cop_dir)
+  Dir.glob(File.join(cop_dir, "**", "*.rb")).each do |cop_file|
+    require cop_file
+  end
+end
+
+module RuboCop
+  module Boochtek
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-boochtek",
+          version: VERSION,
+          homepage: "https://github.com/boochtek/rubocop-boochtek",
+          description: "BoochTek's RuboCop configuration and custom cops"
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: config_path
+        )
+      end
+
+      private def config_path
+        File.expand_path("../../../config/default.yml", __dir__)
+      end
+    end
+  end
+end

data/lib/rubocop/boochtek/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Boochtek
+    VERSION = "0.2.0"
+  end
+end

data/lib/rubocop/boochtek.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "boochtek/version"
+require_relative "boochtek/plugin"
+
+module RuboCop
+  module Boochtek
+    class Error < StandardError; end
+
+    # Auto-discover and load custom cops from lib/rubocop/cop/boochtek/
+    COP_DIR = File.expand_path("cop/boochtek", __dir__)
+    if File.directory?(COP_DIR)
+      Dir.glob(File.join(COP_DIR, "**", "*.rb")).each do |cop_file|
+        require cop_file
+      end
+    end
+  end
+end

data/lib/rubocop/cop/boochtek/compact_endless_methods.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Boochtek
+      # Removes blank lines between consecutive endless (one-liner) method definitions.
+      #
+      # This cop allows grouping related endless methods together without
+      # the blank line that `Layout/EmptyLineBetweenDefs` normally requires.
+      #
+      # @example
+      #   # bad
+      #   def foo = @foo
+      #
+      #   def bar = @bar
+      #
+      #   # good
+      #   def foo = @foo
+      #   def bar = @bar
+      #
+      #   # good - blank line between endless and regular method is fine
+      #   def foo = @foo
+      #
+      #   def bar
+      #     @bar
+      #   end
+      #
+      class CompactEndlessMethods < Base
+        extend AutoCorrector
+
+        MSG = "Remove blank line between consecutive endless methods."
+
+        def on_def(node)
+          check_endless_method(node)
+        end
+
+        def on_defs(node)
+          check_endless_method(node)
+        end
+
+        private
+
+        def check_endless_method(node)
+          return unless endless_def?(node)
+
+          prev_sibling = previous_sibling_def(node)
+          return unless prev_sibling
+          return unless endless_def?(prev_sibling)
+
+          blank_lines = blank_lines_between(prev_sibling, node)
+          return if blank_lines.empty?
+
+          add_offense(node) do |corrector|
+            blank_lines.each do |line_range|
+              corrector.remove(line_range)
+            end
+          end
+        end
+
+        def endless_def?(node)
+          return false unless node&.def_type? || node&.defs_type?
+
+          node.endless?
+        end
+
+        def previous_sibling_def(node)
+          return nil unless node.parent
+
+          siblings = node.parent.children
+          index = siblings.index(node)
+          return nil if index.nil? || index.zero?
+
+          prev = siblings[index - 1]
+          prev if prev&.def_type? || prev&.defs_type?
+        end
+
+        def blank_lines_between(prev_node, current_node)
+          prev_end_line = prev_node.loc.expression.end.line
+          current_start_line = current_node.loc.expression.line
+
+          return [] if current_start_line <= prev_end_line + 1
+
+          blank_line_numbers = ((prev_end_line + 1)...current_start_line).to_a
+          return [] if blank_line_numbers.empty?
+
+          blank_line_numbers.map do |line_num|
+            line_begin = processed_source.buffer.line_range(line_num)
+            # Include the newline character
+            range_with_newline(line_begin)
+          end
+        end
+
+        def range_with_newline(range)
+          Parser::Source::Range.new(
+            range.source_buffer,
+            range.begin_pos,
+            range.end_pos + 1
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-boochtek.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rubocop/boochtek"

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-boochtek
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Craig Buchek
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Shared RuboCop configuration for BoochTek projects. Includes opinionated
+  defaults and support for custom cops.
+email:
+- craig@boochtek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-boochtek.rb
+- lib/rubocop/boochtek.rb
+- lib/rubocop/boochtek/plugin.rb
+- lib/rubocop/boochtek/version.rb
+- lib/rubocop/cop/boochtek/compact_endless_methods.rb
+homepage: https://github.com/boochtek/rubocop-boochtek
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boochtek/rubocop-boochtek
+  source_code_uri: https://github.com/boochtek/rubocop-boochtek
+  changelog_uri: https://github.com/boochtek/rubocop-boochtek/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Boochtek::Plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: BoochTek's RuboCop configuration and custom cops
+test_files: []