rubocop-ordered_methods 0.13 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4d888d565f892bba920e148aa967920188045908a193d44a7a1e672fc713a66
-  data.tar.gz: 70396bfc0679f49119a78b1e6e62d6b85492c308b93e31738c4148117a3ec6ec
+  metadata.gz: 0d24c41c59e9fe17e2a3332f1c05f5aa0794d33c5c5f7160fd04a5ad6f202cf6
+  data.tar.gz: 61222af4166b815ced54dbfa44b68243b47add3cc06d72d08e7ad19380cb40f0
 SHA512:
-  metadata.gz: e41e772f903aae3b9d92278bd09d3568ccb189c56a5c0ffece2d0b79eb97b3e7f6f03142d04d2bef61265717b2253c4c825d9bb953d042b45bb8124aef30a99e
-  data.tar.gz: 82ef17c01433200a393bed3fa2c812addaeb059ffc99b76b9c85287b972618f32e2b62acdbbeabe014e61dff597a490519835ab8118f7a65ae9a2123e4418e48
+  metadata.gz: ffee19b6a626df2c740a60b3fed5be2a3b7efbf62160ff277b771f70e4d3c3848f1f1056f3b96028043d254408eb3b67524912891ed9eb00dccec70d028ee394
+  data.tar.gz: e79fdf0f77a109507437bafbdf03f20debcc3e270a51a34a997ae9d46464b3f06fca2261097a4f69595a454c7df2addb0e1544cc98460dcf17f8551aecaadd83

data/.github/workflows/main.yml

@@ -2,9 +2,14 @@ name: CI
 
 on:
   pull_request:
+    paths-ignore:
+      - '**.md'
   push:
     branches:
       - master
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
 
 jobs:
   rspec:
@@ -18,6 +23,7 @@ jobs:
           - "3.2"
           - "3.3"
           - "3.4"
+          - "4.0"
 
     name: "Ruby ${{ matrix.ruby }}: run rspec"
     steps:
@@ -39,6 +45,7 @@ jobs:
           - "3.2"
           - "3.3"
           - "3.4"
+          - "4.0"
 
     name: "Ruby ${{ matrix.ruby }}: run rubocop"
     steps:

data/.rubocop.yml

@@ -1,6 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
-require: rubocop-ordered_methods
+plugins:
+  - rubocop-ordered_methods
 
 AllCops:
   NewCops: enable

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.14] - 2025-05-02
+
+### Fixed
+
+- rubocop-ordered_methods ignores outer classes when inspecting files [#19](https://github.com/shanecav84/rubocop-ordered_methods/pull/19). Thanks, @ShkumbinDelija.
+
 ## [0.13] - 2024-10-01
 
 ### Fixed

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/rubocop-ordered_methods.svg)](https://badge.fury.io/rb/rubocop-ordered_methods)
-[![Build Status](https://travis-ci.org/shanecav84/rubocop-ordered_methods.svg?branch=master)](https://travis-ci.org/shanecav84/rubocop-ordered_methods)
+[![Build Status](https://github.com/shanecav84/rubocop-ordered_methods/actions/workflows/main.yml/badge.svg)](https://github.com/shanecav84/rubocop-ordered_methods/actions)
 
 # RuboCop OrderedMethods
 
@@ -50,21 +50,33 @@ Or install it yourself as:
 
 ## Usage
 
-You need to tell RuboCop to load the OrderedMethods extension. There are two
-ways to do this:
+You need to tell RuboCop to load the OrderedMethods extension. We support RuboCop's official plugin system as well as 
+the old `require` system.
 
-### RuboCop configuration file
+### Plugin
 
-Put this into your `.rubocop.yml`.
+In `.rubocop.yml`, add `rubocop-ordered_methods` to `plugins`.
 
 ```
-require: rubocop-ordered_methods
+plugins: 
+  - rubocop-ordered_methods
 ```
 
-Now you can run `rubocop` and it will automatically load the RuboCop OrderedMethods
-cops together with the standard cops.
+#### Command line
+
+```bash
+rubocop --plugin rubocop-ordered_methods
+```
 
-### Command line
+### Require (deprecated)
+
+In `.rubocop.yml`, add `rubocop-ordered_methods` to `require`.
+
+```
+require: rubocop-ordered_methods
+```
+
+#### Command line
 
 ```bash
 rubocop --require rubocop-ordered_methods
@@ -94,6 +106,8 @@ Layout/OrderedMethods:
 
 ### Corrector
 
+See [Caveats](#caveats).
+
 The corrector will attempt to order methods based on the `EnforcedStyle`. It attempts to
 include surrounding comments and the qualifiers (e.g., aliases) listed in
 `::RuboCop::Cop::OrderedMethodsCorrector::QUALIFIERS`. The following (monstrous)
@@ -171,6 +185,12 @@ with `Signature: sorbet`.
   def a; end
   ```
 
+## Project status
+
+Development is ongoing. There might be extended periods between releases. 
+The maintenance goal is to add features as needed and to maintain compatibility 
+with Ruby and rubocop updates.
+
 ## Development
 
 ### Setup

data/lib/rubocop/cop/layout/ordered_methods.rb

@@ -49,8 +49,9 @@ module RuboCop
         end
 
         def on_begin(node)
-          start_node = node.children.find(&:class_type?)&.children&.last || node
-          check(start_node)
+          check(node)
+
+          node.each_descendant(:class, :module) { |descendant| check(descendant) }
         end
 
         private

data/lib/rubocop/ordered_methods/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module OrderedMethods
+    # Official plugin system for Rubocop
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-ordered_methods',
+          version: RuboCop::OrderedMethods::VERSION,
+          homepage: 'https://github.com/shanecav84/rubocop-ordered_methods',
+          description: 'Check that methods are defined alphabetically per access modifier block.'
+        )
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+    end
+  end
+end

data/lib/rubocop/ordered_methods/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module OrderedMethods
+    VERSION = '0.15'
+  end
+end

data/lib/rubocop/ordered_methods.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'rubocop'
+require_relative 'cop/layout/ordered_methods'
+require_relative 'cop/correctors/ordered_methods_corrector'
+require_relative 'ordered_methods/plugin'
+
 module RuboCop
   # Our namespace
   module OrderedMethods

data/lib/rubocop-ordered_methods.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
 require_relative 'rubocop/ordered_methods'
-require_relative 'rubocop/cop/layout/ordered_methods'
-require_relative 'rubocop/cop/correctors/ordered_methods_corrector'
 
-RuboCop::OrderedMethods.inject_defaults!
+# We support both the old, unsupported `require` and the new, supported `plugins`
+rubocop_version = Gem::Specification.find_by_name('rubocop').version.to_s
+RuboCop::OrderedMethods.inject_defaults! if Gem::Version.new(rubocop_version) < Gem::Version.new('1.72')

data/rubocop-ordered_methods.gemspec

@@ -3,9 +3,11 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require_relative 'lib/rubocop/ordered_methods/version'
+
 Gem::Specification.new do |spec|
   spec.name = 'rubocop-ordered_methods'
-  spec.version = '0.13'
+  spec.version = RuboCop::OrderedMethods::VERSION
   spec.authors = ['Shane Cavanaugh']
   spec.email = ['shane@shanecav.net']
 
@@ -26,7 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'lint_roller', '~> 1.0'
   spec.add_dependency 'rubocop', '>= 1.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['default_lint_roller_plugin'] = 'RuboCop::OrderedMethods::Plugin'
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-ordered_methods
 version: !ruby/object:Gem::Version
-  version: '0.13'
+  version: '0.15'
 platform: ruby
 authors:
 - Shane Cavanaugh
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2026-05-29 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -24,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-description:
 email:
 - shane@shanecav.net
 executables: []
@@ -33,10 +45,8 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
-- ".rakeTasks"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -51,13 +61,15 @@ files:
 - lib/rubocop/cop/layout/ordered_methods.rb
 - lib/rubocop/cop/qualifier_node_matchers.rb
 - lib/rubocop/ordered_methods.rb
+- lib/rubocop/ordered_methods/plugin.rb
+- lib/rubocop/ordered_methods/version.rb
 - rubocop-ordered_methods.gemspec
 homepage: https://github.com/shanecav84/rubocop-ordered_methods
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+  default_lint_roller_plugin: RuboCop::OrderedMethods::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Checks that methods are ordered alphabetically.
 test_files: []

data/.rakeTasks

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Settings><!--This file was automatically generated by Ruby plugin.
-You are allowed to: 
-1. Remove rake task
-2. Add existing rake tasks
-To add existing rake tasks automatically delete this file and reload the project.
---><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build rubocop-ordered_methods-0.5.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install rubocop-ordered_methods-0.5.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install rubocop-ordered_methods-0.5.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.5 and build and push rubocop-ordered_methods-0.5.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RuboCop" fullCmd="rubocop" taksId="rubocop" /><RakeGroup description="" fullCmd="" taksId="rubocop"><RakeTask description="Auto-correct RuboCop offenses" fullCmd="rubocop:auto_correct" taksId="auto_correct" /></RakeGroup><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.travis.yml

@@ -1,12 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-script: bundle exec rake
-before_install:
-  - gem install bundler || gem install bundler --version '< 2'