rubocop-sorted_methods_by_call 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a04b5916bbf8e91aa2792283ad7f15dc939907cb55e6fafec2f77e2cf966b6ff
-  data.tar.gz: 4f1475d1b0a3a5233b7f15010ae850dab4e696be9b209782d41d44cd5f1b3318
+  metadata.gz: e6a9eb4e66de83efb34a68cdac011fc7998f088ac56fd9f84a04e9b3e7e1a940
+  data.tar.gz: 7e920b6912bde4e32907e06336d21f141b79120021cb55a8270b46702a76d37d
 SHA512:
-  metadata.gz: 2bea6384c391d4a19a1cf83fb8ac9cb671d3325daeda8685d169c52ee8c1906e1f921b1da96a9ba128305b62bc99aaaf2d99567a8e5a9ea9aebd6630efb73383
-  data.tar.gz: d3cb6250866427b62ca907a9a4c73f8f30c69e94e6d9f767f105851394abb12d8444ac1e691f83df32f05abd1c40d09bf9da272e66d4dc0a1167dba439dcd83b
+  metadata.gz: af5acc7e6abc9e29ee7512892a129acd131c61a67641116b802dd106eb1e237005ddbe2953dc941270032a6a897adc9c39f24951d96d52f0abc55d632d5ff5f6
+  data.tar.gz: 762aba605e5cf9a40c03d0c15fe68d2d4c4fb9855d2bb1dacd11d6d877990d729f449bbb620f3d711f6291900e8746a1f970fb7fbd06130b0de4f6378de139b9

data/.rubocop.yml

@@ -5,11 +5,14 @@ plugins:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.4
+  TargetRubyVersion: 2.7
   NewCops: enable
 
 Layout/LineLength:
   Max: 120
+  AllowedPatterns:
+    - '\A\s*# \+'
+    - '@(param|return) \['
 
 Naming/FileName:
   Exclude:

data/.rubocop_todo.yml

@@ -1,69 +1,14 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-01-13 11:42:57 UTC using RuboCop version 1.81.7.
+# on 2026-06-11 20:55:54 UTC using RuboCop version 1.82.1.
 # 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
+# Offense count: 6
 # 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: 5
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 78
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 36
-
-# Offense count: 4
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 35
-
-# Offense count: 9
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 70
-
-# Offense count: 2
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
-Metrics/ParameterLists:
-  Max: 6
-
-# Offense count: 3
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 37
-
-# Offense count: 21
-# Configuration parameters: CountAsOne.
-RSpec/ExampleLength:
-  Max: 37
-
-# Offense count: 1
-# Configuration parameters: AllowedGroups.
-RSpec/NestedGroups:
-  Max: 4
-
-# 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/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+## [1.2.3] - 2026-06-12
+
+### Added
+- RBS type signatures for all source files (`sig/`)
+- Steep type checker integration (`Steepfile`, `steep check` in CI)
+- RBS collection via `rbs collection install`
+- Patch stub for `RuboCop::Cop::AutoCorrector` (RBS collection places it in wrong namespace)
+- Docscribe documentation for all ~50 methods with meaningful descriptions
+- `docscribe.yml` configuration
+- `docscribe lib` step in CI
+- RBS validation + Steep check in CI (Ruby >= 3.2)
+- CONTRIBUTING.md, SECURITY.md, issue/PR templates
+- CHANGELOG.md
+
+### Changed
+- Gemfile: `rbs` and `steep` in `:rbs` group, conditional on Ruby >= 3.2
+- CI: manual `bundle install` (no `bundler-cache`) for cross-Ruby compatibility
+- CI: split RBS/steep checks into conditional steps
+
+### Fixed
+- `CODE_OF_CONDUCT.md`: replaced placeholder email with link to GitHub Issues
+
+## [1.2.2] - 2026-06-11
+
+### Changed
+- Updated version to 1.2.2
+
+## [1.2.1] - 2026-06-11
+
+### Changed
+- Updated version to 1.2.1
+
+## [1.2.0] - 2026-06-11
+
+### Added
+- Initial release of RuboCop::SortedMethodsByCall
+- Waterfall ordering enforcement cop
+- Autocorrect support
+- Sibling ordering with cycle detection
+- `SkipCyclicSiblingEdges` configuration option

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## 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.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by creating an issue in the repository at https://github.com/unurgunite/rubocop-sorted_methods_by_call/issues 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.
 

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+Bug reports and pull requests are welcome!
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork: `git clone git@github.com:YOUR_USERNAME/rubocop-sorted_methods_by_call.git`
+3. Install dependencies: `bin/setup`
+
+## Making Changes
+
+1. Create a feature branch: `git checkout -b feature/amazing-feature`
+2. Make your changes
+3. Run the test suite: `bundle exec rspec`
+4. Run the linter: `bundle exec rubocop`
+5. If you changed RBS signatures, run: `bundle exec rbs validate && bundle exec steep check`
+6. Commit your changes: `git commit -am 'Add amazing feature'`
+7. Push: `git push origin feature/amazing-feature`
+8. Open a pull request
+
+## Code Style
+
+- Follow the existing code style
+- All code must pass RuboCop (no offenses)
+- Methods should be documented with YARD comments
+- If adding or changing types, update the corresponding RBS signatures in `sig/`
+
+## Testing
+
+- All pull requests must maintain or improve test coverage
+- Run `bundle exec rspec` to run the test suite
+- Run `bundle exec rubocop` to check code style
+- On Ruby >= 3.2, also run `bundle exec rbs validate && bundle exec steep check`
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

data/README.md

@@ -36,6 +36,11 @@
 - **Full RuboCop integration**: Works seamlessly with modern RuboCop plugin system;
 - **Comprehensive scope support**: Classes, modules, singleton classes, and top-level;
 
+> [!NOTE]
+> This gem implements **true waterfall ordering** that considers the complete call graph across all methods in
+> a scope. Methods are ordered so that every callee appears after all of its callers, creating a natural top-down
+> reading flow.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -93,7 +98,6 @@ In waterfall ordering, **callers come before callees**. This creates a top-down
 before implementation details.
 
 ```ruby
-
 class Service
   def call
     foo
@@ -119,7 +123,6 @@ end
 ### Bad Code (violates waterfall order)
 
 ```ruby
-
 class Service
   def call
     foo
@@ -261,9 +264,3 @@ The gem is available as open source under the terms of MIT License.
 ## Code of Conduct
 
 Everyone interacting with this project is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).
-
----
-
-> **Note**: This gem implements **true waterfall ordering** that considers the complete call graph across all methods in
-> a scope. Methods are ordered so that every callee appears after all of its callers, creating a natural top-down
-> reading flow.

data/SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please open an issue at:
+
+https://github.com/unurgunite/rubocop-sorted_methods_by_call/issues
+
+We will review and address it as soon as possible.

data/Steepfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+target :lib do
+  check 'lib'
+  signature 'sig'
+end

data/config/default.yml

@@ -1,7 +1,7 @@
 SortedMethodsByCall/Waterfall:
   Description: "Enforces method ordering based on call relationships."
   Enabled: true
-  VersionAdded: "1.2.1"
+  VersionAdded: "1.2.2"
   SafeAutoCorrect: false
   AllowedRecursion: true
   SkipCyclicSiblingEdges: false

data/docscribe.yml

@@ -0,0 +1,18 @@
+---
+rbs:
+  enabled: true
+  sig_dirs: ["sig"]
+  collection_dirs:
+    - ".gem_rbs_collection/rubocop-ast/1.46"
+    - ".gem_rbs_collection/rubocop/1.57"
+    - ".gem_rbs_collection/parser/3.2"
+    - ".gem_rbs_collection/ast/2.4"
+  collapse_generics: false
+
+emit:
+  header: false
+  include_default_message: true
+  include_param_documentation: true
+
+inference:
+  fallback_type: "Object"