rubocop-socketry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 445a5ee210147c4a5ff2fd64e9b9b652c05d8d367a5e22c6e021ad7ae32c9b0b
+  data.tar.gz: 68a660ee1a45d210fd1aff0a1fd95b6111231e6e94b8d415fa480d7e804756a0
+SHA512:
+  metadata.gz: 8c3386766d825b8fa057c71f8dc58ee484378f0ec47a3a6445705f0a7d6e03ea54c0595ad946a445651a6a7952a49c8b23d258465f047415c13a98558617bf63
+  data.tar.gz: 4e20dfca038f92fd398fcf3d1dbf64fbab9d639de3c9dc86b41080f1dd231531fe5786338836c6a486544e745c1c7d8f90374a28db8996792e53c5ed3b80b034

data/agent.md

@@ -0,0 +1,47 @@
+# Agent
+
+## Context
+
+This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
+
+**Important:** Before performing any code, documentation, or analysis tasks, always read and apply the full content of any relevant documentation referenced in the following sections. These context files contain authoritative standards and best practices for documentation, code style, and project-specific workflows. **Do not proceed with any actions until you have read and incorporated the guidance from relevant context files.**
+
+### agent-context
+
+Install and manage context files from Ruby gems.
+
+#### [Usage Guide](.context/agent-context/usage.md)
+
+`agent-context` is a tool that helps you discover and install contextual information from Ruby gems for AI agents. Gems can provide additional documentation, examples, and guidance in a `context/` ...
+
+### decode
+
+Code analysis for documentation generation.
+
+#### [Getting Started with Decode](.context/decode/getting-started.md)
+
+The Decode gem provides programmatic access to Ruby code structure and metadata. It can parse Ruby files and extract definitions, comments, and documentation pragmas, enabling code analysis, docume...
+
+#### [Documentation Coverage](.context/decode/coverage.md)
+
+This guide explains how to test and monitor documentation coverage in your Ruby projects using the Decode gem's built-in bake tasks.
+
+#### [Ruby Documentation](.context/decode/ruby-documentation.md)
+
+This guide covers documentation practices and pragmas supported by the Decode gem for documenting Ruby code. These pragmas provide structured documentation that can be parsed and used to generate A...
+
+### sus
+
+A fast and scalable test runner.
+
+#### [Using Sus Testing Framework](.context/sus/usage.md)
+
+Sus is a modern Ruby testing framework that provides a clean, BDD-style syntax for writing tests. It's designed to be fast, simple, and expressive.
+
+#### [Mocking](.context/sus/mocking.md)
+
+There are two types of mocking in sus: `receive` and `mock`. The `receive` matcher is a subset of full mocking and is used to set expectations on method calls, while `mock` can be used to replace m...
+
+#### [Shared Test Behaviors and Fixtures](.context/sus/shared.md)
+
+Sus provides shared test contexts which can be used to define common behaviours or tests that can be reused across one or more test files.

data/lib/rubocop/socketry/layout/consistent_blank_line_indentation.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "rubocop"
+
+module RuboCop
+	module Socketry
+		module Layout
+			# A RuboCop cop that enforces consistent blank line indentation based on AST structure.
+			# This cop ensures that blank lines are indented correctly according to their context in the code,
+			# using a two-pass algorithm that analyzes the AST to determine proper indentation levels.
+			class ConsistentBlankLineIndentation < RuboCop::Cop::Base
+				extend Cop::AutoCorrector
+				include Cop::Alignment
+				include Cop::RangeHelp
+				
+				# @attribute [String] The message displayed when a blank line has incorrect indentation.
+				MESSAGE = "Blank lines must have the correct indentation."
+				
+				# Get the configured indentation width from cop configuration or fallback to default.
+				# @returns [Integer] The number of spaces or tabs to use for each indentation level.
+				def configured_indentation_width
+					cop_config["IndentationWidth"] || config.for_cop("Layout/IndentationWidth")["Width"] || 1
+				end
+				
+				# Get the configured indentation style from cop configuration or fallback to default.
+				# @returns [String] The indentation style, either "tab" or "space".
+				def configured_indentation_style
+					cop_config["IndentationStyle"] || config.for_cop("Layout/IndentationStyle")["Style"] || "tab"
+				end
+				
+				# Generate indentation string based on the current level and configured style.
+				# @parameter width [Integer] The number of indentation levels to apply.
+				# @returns [String] The indentation string (tabs or spaces).
+				def indentation(width)
+					case configured_indentation_style
+					when "tab"
+						"\t" * (width * configured_indentation_width)
+					when "space"
+						" " * (width * configured_indentation_width)
+					end
+				end
+				
+				# Main investigation method that processes the source code and checks blank line indentation.
+				# This method implements a two-pass algorithm: first building indentation deltas from the AST,
+				# then processing each line to check blank lines against expected indentation.
+				def on_new_investigation
+					indentation_deltas = build_indentation_deltas
+					current_level = 0
+					
+					processed_source.lines.each_with_index do |line, index|
+						line_number = index + 1
+						
+						# Check blank lines for correct indentation:
+						if line.strip.empty?
+							expected_indentation = indentation(current_level)
+							if line != expected_indentation
+								add_offense(
+									source_range(processed_source.buffer, line_number, 0, line.length),
+									message: MESSAGE
+								) do |corrector|
+									corrector.replace(
+										source_range(processed_source.buffer, line_number, 0, line.length),
+										expected_indentation
+									)
+								end
+							end
+						end
+						
+						# Apply indentation delta for this line:
+						delta = indentation_deltas[line_number] || 0
+						current_level += delta
+					end
+				end
+				
+				private
+				
+				# Build a hash mapping line numbers to indentation deltas (+1 for indent, -1 for dedent).
+				# This method walks the AST to identify where indentation should increase or decrease.
+				# @returns [Hash(Integer, Integer)] A hash where keys are line numbers and values are deltas.
+				def build_indentation_deltas
+					deltas = Hash.new(0)
+					walk_ast_for_indentation(processed_source.ast, deltas)
+					deltas
+				end
+				
+				# Recursively walk the AST to build indentation deltas for block structures.
+				# This method identifies nodes that should affect indentation and records the deltas.
+				# @parameter node [Parser::AST::Node] The current AST node to process.
+				# @parameter deltas [Hash(Integer, Integer)] The deltas hash to populate.
+				def walk_ast_for_indentation(node, deltas)
+					return unless node.is_a?(Parser::AST::Node)
+					
+					case node.type
+					when :block, :hash, :array, :class, :module, :sclass, :def, :defs, :if, :case, :while, :until, :for, :kwbegin
+						if location = node.location
+							deltas[location.line] += 1
+							deltas[location.last_line] -= 1
+						end
+					end
+					
+					node.children.each do |child|
+						walk_ast_for_indentation(child, deltas)
+					end
+				end
+				
+				# Create a source range for a specific line and column position.
+				# @parameter buffer [Parser::Source::Buffer] The source buffer.
+				# @parameter line [Integer] The line number (1-indexed).
+				# @parameter column [Integer] The column position.
+				# @parameter length [Integer] The length of the range.
+				# @returns [Parser::Source::Range] The source range object.
+				def source_range(buffer, line, column, length)
+					Parser::Source::Range.new(buffer, buffer.line_range(line).begin_pos + column, buffer.line_range(line).begin_pos + column + length)
+				end
+			end
+		end
+	end
+end 

data/lib/rubocop/socketry/plugin.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "lint_roller"
+require_relative "version"
+
+module RuboCop
+	module Socketry
+		# Represents a LintRoller plugin that provides RuboCop rules for Socketry projects.
+		# This plugin integrates custom RuboCop cops and configuration into the LintRoller system.
+		class Plugin < LintRoller::Plugin
+			# Initialize the plugin with version information.
+			def initialize(...)
+				super
+				@version = RuboCop::Socketry::VERSION
+			end
+			
+			# Get information about this plugin for the LintRoller system.
+			# @returns [LintRoller::About] Plugin metadata including name, version, and description.
+			def about
+				LintRoller::About.new(
+					name: "rubocop-socketry",
+					version: @version,
+					homepage: "https://github.com/socketry/rubocop-socketry",
+					description: "RuboCop rules for Socketry projects."
+				)
+			end
+			
+			# Define the rules configuration for this plugin.
+			# @parameter context [Object] The LintRoller context object.
+			# @returns [LintRoller::Rules] Rules configuration specifying the path to the default RuboCop config.
+			def rules(context)
+				LintRoller::Rules.new(
+					type: :path,
+					config_format: :rubocop,
+					value: Pathname.new(__dir__).join("../../../config/default.yml")
+				)
+			end
+		end
+	end
+end 

data/lib/rubocop/socketry/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module RuboCop
+	module Socketry
+		VERSION = "0.1.0"
+	end
+end 

data/lib/rubocop/socketry.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "socketry/version"
+require_relative "socketry/plugin"
+require_relative "socketry/layout/consistent_blank_line_indentation"
+
+# @namespace
+module RuboCop
+	# @namespace
+	module Socketry
+		# @namespace
+		module Layout
+		end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2025, by Samuel Williams.  
+
+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,50 @@
+# RuboCop::Socketry
+
+RuboCop rules for Socketry projects.
+
+[![Development Status](https://github.com/socketry/rubocop-socketry/workflows/Test/badge.svg)](https://github.com/socketry/rubocop-socketry/actions?workflow=Test)
+
+## Installation
+
+    bundle add rubocop-socketry
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/rubocop-socketry/) for more details.
+
+## Available Cops
+
+### Layout/ConsistentBlankLineIndentation
+
+Ensures that blank lines have the same indentation as the previous non-blank line.
+
+``` yaml
+Layout/ConsistentBlankLineIndentation:
+  Enabled: true
+```
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/rubocop-socketry/releases/index) for all releases.
+
+### v0.1.0
+
+  - Initial implementaiton of `Layout/ConsistentBlankLineIndentation`.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.1.0
+
+  - Initial implementaiton of `Layout/ConsistentBlankLineIndentation`.

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-socketry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- agent.md
+- lib/rubocop/socketry.rb
+- lib/rubocop/socketry/layout/consistent_blank_line_indentation.rb
+- lib/rubocop/socketry/plugin.rb
+- lib/rubocop/socketry/version.rb
+- license.md
+- readme.md
+- releases.md
+homepage: https://github.com/socketry/rubocop-socketry
+licenses:
+- MIT
+metadata:
+  default_lint_roller_plugin: RuboCop::Socketry::Plugin
+  documentation_uri: https://socketry.github.io/rubocop-socketry/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/rubocop-socketry.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: RuboCop rules for Socketry projects
+test_files: []

metadata.gz.sig

@@ -0,0 +1,4 @@
+m˴���;�#�<�4z��su�(�
G9����K@�.bXM�T��g�/��J���y�l�4!�o�{J���{�����P
C�wx��_c�Q(���ƭ���9Я�K�ދ��n1�4��#q���L��a��o����פkߛ_2�'vh���?��m!�u���+,��fqCۿ-�7��?�8������2r�� .K��d��|%#�Kd�C���U<��$S��o�	fDO�(��{�F�c��s��c���BM�Z>y7!�󠊸b�
+%"B�T����F6��/�&&
��0���_�8��L~���r^{�+F�K
�<3#��K
+��˲1�0�L|X��t�qW��zB��Ņ�L��Nt"
+�Q