rubocop-sorted_methods_by_call 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a05a73b134e3c92389b69552df981d71c730623059376b90029f1875bdf6945
+  data.tar.gz: cf522e97fabcf31eafb02ddf9b52980d9c681adc6f04bc297729dfe1f9f53af7
+SHA512:
+  metadata.gz: 2f5e49e6eefca4dcce2a4de646afae45292170f2389672fcc6a17120ac6d16d22e50e81fafaaf0c8e008300da816d1d886f4d43e5180ebe5c40b267d6a36e064
+  data.tar.gz: 7a0dc929281d31759bdef79d990d61427bc277421ae096df8f49662a04fd74fcae98b6f785912308d360ce35d9ac4a1a26947208c167265da00d0f240bd66f81

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from: .rubocop_todo.yml
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.4
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Exclude:
+    - 'lib/rubocop-sorted_methods_by_call.rb'
+
+Style/WhileUntilDo:
+  Enabled: false
+
+Style/RedundantFetchBlock:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,59 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-11-05 21:07:30 UTC using RuboCop version 1.81.7.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+# Configuration parameters: EnforcedStyle, AllowedGems.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'rubocop-sorted_methods_by_call.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity.
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'rubocop-sorted_methods_by_call.gemspec'
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 61
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 43
+
+# Offense count: 5
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+# Offense count: 7
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 58
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 22
+
+# Offense count: 11
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 26
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'spec/rubocop/cop/sorted_methods_by_call/waterfall_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.4.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-sorted_methods_by_call.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    rubocop-sorted_methods_by_call (1.0.0)
+      lint_roller
+      rubocop (>= 1.72.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    diff-lcs (1.5.0)
+    fasterer (0.11.0)
+      ruby_parser (>= 3.19.1)
+    json (2.15.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.6.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.11.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.47.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.26.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.7.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    ruby_parser (3.21.1)
+      racc (~> 1.5)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.17.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-24
+  arm64-darwin-25
+  x86_64-linux
+
+DEPENDENCIES
+  fasterer
+  rake (>= 13.0)
+  rspec (>= 3.0)
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  rubocop-sorted_methods_by_call!
+  yard
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,11 @@
+Copyright 2022 unurgunite
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,222 @@
+# RuboCop::SortedMethodsByCall
+
+![Repobeats](https://repobeats.axiom.co/api/embed/7926fec94bffd7fcaa69700fb9464ed96cf69083.svg "Repobeats analytics image")
+[![CI](https://github.com/unurgunite/rubocop-sorted_methods_by_call/actions/workflows/ci.yml/badge.svg)](https://github.com/unurgunite/rubocop-sorted_methods_by_call/actions)
+[![Gem Version](https://badge.fury.io/rb/rubocop-sorted_methods_by_call.svg)](https://rubygems.org/gems/rubocop-sorted_methods_by_call)
+
+* [RuboCop::SortedMethodsByCall](#rubocopsortedmethodsbycall)
+    * [Features](#features)
+    * [Installation](#installation)
+    * [Configuration](#configuration)
+        * [Basic Setup](#basic-setup)
+        * [Configuration Options](#configuration-options)
+    * [Usage Examples](#usage-examples)
+        * [Good Code (waterfall order)](#good-code-waterfall-order)
+        * [Bad Code (violates waterfall order)](#bad-code-violates-waterfall-order)
+        * [Autocorrection](#autocorrection)
+    * [Testing](#testing)
+    * [Development](#development)
+        * [Available Commands](#available-commands)
+        * [Release Process](#release-process)
+    * [Requirements](#requirements)
+    * [Contributing](#contributing)
+    * [License](#license)
+    * [Code of Conduct](#code-of-conduct)
+
+**Enforces "waterfall" method ordering**: define methods *after* any method that calls them within the same scope.
+
+## Features
+
+- **Waterfall ordering enforcement**: Caller methods must be defined before their callees
+- **Smart visibility handling**: Respects `private`/`protected`/`public` sections
+- **Safe mutual recursion**: Handles recursive method calls gracefully
+- **Autocorrection support**: Automatically reorders methods (opt-in with `-A`)
+- **Full RuboCop integration**: Works seamlessly with modern RuboCop plugin system
+- **Comprehensive scope support**: Classes, modules, singleton classes, and top-level
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-sorted_methods_by_call'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself:
+
+```bash
+gem install rubocop-sorted_methods_by_call
+```
+
+## Configuration
+
+### Basic Setup
+
+Add to your `.rubocop.yml`:
+
+```yaml
+plugins:
+  - rubocop-sorted_methods_by_call
+
+SortedMethodsByCall/Waterfall:
+  Enabled: true
+```
+
+### Configuration Options
+
+```yaml
+SortedMethodsByCall/Waterfall:
+  Enabled: true
+  SafeAutoCorrect: false          # Autocorrection requires -A flag
+  AllowedRecursion: true          # Allow mutual recursion (default: true)
+```
+
+## Usage Examples
+
+### Good Code (waterfall order)
+
+```ruby
+
+class Service
+  def call
+    do_smth
+  end
+
+  private
+
+  def do_smth
+    well
+  end
+
+  def well
+    123
+  end
+end
+```
+
+### Bad Code (violates waterfall order)
+
+```ruby
+
+class Service
+  def call
+    do_smth
+  end
+
+  private
+
+  def well # ❌ Offense: Define #well after its caller #do_smth
+    123
+  end
+
+  def do_smth
+    well
+  end
+end
+```
+
+### Autocorrection
+
+Run with unsafe autocorrection to automatically fix violations:
+
+```bash
+bundle exec rubocop -A
+```
+
+This will reorder the methods while preserving comments and visibility modifiers:
+
+```ruby
+
+class Service
+  def call
+    do_smth
+  end
+
+  private
+
+  def do_smth
+    well
+  end
+
+  def well
+    123
+  end
+end
+```
+
+## Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+Run RuboCop on the gem itself:
+
+```bash
+bundle exec rubocop
+bundle exec rubocop --config .rubocop.test.yml lib/ -A
+```
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bin/setup
+```
+
+This will install dependencies and start an interactive console.
+
+### Available Commands
+
+- `bin/console` - Interactive development console
+- `bin/setup` - Install dependencies and build gem
+- `bundle exec rake` - Run tests and linting
+
+### Release Process
+
+1. Update version in `lib/rubocop/sorted_methods_by_call/version.rb`
+2. Create and push a git tag: `git tag v0.1.0 && git push origin v0.1.0`
+3. GitHub Actions will automatically:
+    - Build the gem
+    - Publish to RubyGems.org
+    - Create a GitHub release
+
+## Requirements
+
+- **Ruby**: >= 2.7
+- **RuboCop**: >= 1.72.0 (required for plugin system)
+
+## Contributing
+
+Bug reports and pull requests are welcome! Please follow these guidelines:
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -am 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a pull request
+
+Please ensure your code passes all tests and follows the existing style.
+
+## License
+
+The gem is available as open source under the terms of
+the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause).
+
+## Code of Conduct
+
+Everyone interacting with this project is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+---
+
+> **Note**: This gem is now stable and ready for production use! The "waterfall" ordering pattern helps create more
+> readable code by ensuring that methods are defined in the order they're conceptually needed.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/default.yml

@@ -0,0 +1,7 @@
+# Default configuration for rubocop-sorted_methods_by_call
+SortedMethodsByCall/Waterfall:
+  Description: "Enforces waterfall ordering: define methods after the methods that call them."
+  Enabled: false
+  VersionAdded: "1.0.0"
+  SafeAutoCorrect: false
+  AllowedRecursion: true

data/exe/rubocop-sorted_methods_by_call

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubocop-sorted_methods_by_call'