rubocop-asjer 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a228c899c0ddc18cd12cc18f5d43dced28ade2a8e230b61db7d2b4eff348671b
-  data.tar.gz: 3bee7420da10095a5d2c2eb4cbbde60f3fbb787f46bf73875288da5a07eb4372
+  metadata.gz: 6401e9b5d10c63a9c3ff7f3292aac36e8368a54fdd4df3062efda177ee331c11
+  data.tar.gz: a7e90b0a705e59b161b575fdedb087d82b54dd8af3cfec7509bc54553012c5f5
 SHA512:
-  metadata.gz: c63346eb316976ed2c79a48d52354f55b533d2c45aff4b9ebecb1989a5f023b2456a9078bc7ce92fd29f774960bb616da32841f9280c48424fc81005c66bf9ca
-  data.tar.gz: 9dd4c7226b6f413d716a5cb4687d6233f301284d21fb1c9c9e67850a92ed5f394b685fbe2518712573d261ece51fb7e3517ffa7dbfc9327030efa1923cf50787
+  metadata.gz: a0f223e4e32b83736f21750b9ebb06ab49eacd9e2ccb45d37f047b231d763cb4f4dd1effa7bb87e0376f04db89287b48a7727c544b84b96585b657a02d2fa092
+  data.tar.gz: '0810af3f8f3b56e7ae3b4ee4295805a9a01ee0cb34911da8d6197db60ff1d0f8ad3a37d596d8411ced98e2eae0fb13c60f904903bebea26b2302b52cdc66d3de'

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.3.1"
+  ".": "0.4.1"
 }

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.4.1](https://github.com/asjer/rubocop-asjer/compare/v0.4.0...v0.4.1) (2026-01-28)
+
+
+### Bug Fixes
+
+* improve autocorrect functionality for `RailsClassOrder` cop and add Ruby 4.0 to ci ([#23](https://github.com/asjer/rubocop-asjer/issues/23)) ([16fc637](https://github.com/asjer/rubocop-asjer/commit/16fc63770f05f74e2bc005becd136af7d8ccb0d1))
+
+## [0.4.0](https://github.com/asjer/rubocop-asjer/compare/v0.3.1...v0.4.0) (2026-01-23)
+
+
+### Features
+
+* add `RailsClassOrder` cop to enforce method ordering in Rails models ([#20](https://github.com/asjer/rubocop-asjer/issues/20)) ([bce5d9b](https://github.com/asjer/rubocop-asjer/commit/bce5d9b2affbf207ad34c99d574340d7437e3a04))
+
 ## [0.3.1](https://github.com/asjer/rubocop-asjer/compare/v0.3.0...v0.3.1) (2026-01-03)
 
 

data/README.md

@@ -44,6 +44,58 @@ t('some.key')
 I18n.t('some.key')
 ```
 
+### Asjer/RailsClassOrder
+
+Enforces consistent ordering of declarative methods in Rails models. Methods are grouped into three categories: associations, callbacks, and others. Groups are separated by blank lines.
+
+**Supports autocorrect** with `rubocop -a` or `rubocop -A`.
+
+```ruby
+# bad
+class User < ApplicationRecord
+  belongs_to :plan
+  validate :validate_name
+  after_create :after_create_1
+  has_many :messages
+  attr_readonly :email
+  after_create :after_create_2
+  belongs_to :role
+  before_create :set_name
+end
+
+# good
+class User < ApplicationRecord
+  belongs_to :plan
+  belongs_to :role
+  has_many :messages
+
+  validate :validate_name
+  before_create :set_name
+  after_create :after_create_1
+  after_create :after_create_2
+
+  attr_readonly :email
+end
+```
+
+By default, this cop only runs on files matching `app/models/**/*.rb`. The method lists are fully configurable:
+
+```yaml
+Asjer/RailsClassOrder:
+  Associations:
+    - belongs_to
+    - has_many
+    - has_one
+    - has_and_belongs_to_many
+  Callbacks:
+    - after_initialize
+    - after_find
+    # ... (see config/default.yml for full list)
+  Others:
+    - attr_readonly
+    - serialize
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.

data/config/default.yml

@@ -2,3 +2,40 @@ Asjer/NoDefaultTranslation:
   Description: Checks for use of the `default:` option in translation calls.
   Enabled: true
   VersionAdded: "0.1.0"
+
+Asjer/RailsClassOrder:
+  Description: Enforces consistent ordering of declarative methods in Rails models.
+  Enabled: true
+  VersionAdded: "0.4.0"
+  Include:
+    - 'app/models/**/*.rb'
+  Associations:
+    - belongs_to
+    - has_many
+    - has_one
+    - has_and_belongs_to_many
+  Callbacks:
+    - after_initialize
+    - after_find
+    - after_touch
+    - before_validation
+    - validates
+    - validate
+    - after_validation
+    - before_save
+    - around_save
+    - before_create
+    - around_create
+    - before_update
+    - around_update
+    - before_destroy
+    - around_destroy
+    - after_destroy
+    - after_update
+    - after_create
+    - after_save
+    - after_commit
+    - after_rollback
+  Others:
+    - attr_readonly
+    - serialize

data/lib/rubocop/asjer/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Asjer
-    VERSION = '0.3.1'
+    VERSION = '0.4.1'
   end
 end

data/lib/rubocop/asjer.rb

@@ -5,6 +5,7 @@ require 'rubocop'
 require_relative 'asjer/version'
 require_relative 'asjer/plugin'
 require_relative 'cop/asjer/no_default_translation'
+require_relative 'cop/asjer/rails_class_order'
 
 module RuboCop
   module Asjer

data/lib/rubocop/cop/asjer/rails_class_order.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Asjer
+      # Enforces consistent ordering of declarative methods in Rails models.
+      #
+      # Methods are grouped into three categories: associations, callbacks,
+      # and others. Within each category, methods are sorted by their position
+      # in the configured list. Groups are separated by blank lines.
+      #
+      # The order is: associations, then callbacks, then others.
+      #
+      # @example
+      #   # bad
+      #   class User < ApplicationRecord
+      #     belongs_to :plan
+      #     validate :validate_name
+      #     after_create :after_create_1
+      #     has_many :messages
+      #     attr_readonly :email
+      #     after_create :after_create_2
+      #     belongs_to :role
+      #     before_create :set_name
+      #   end
+      #
+      #   # good
+      #   class User < ApplicationRecord
+      #     belongs_to :plan
+      #     belongs_to :role
+      #     has_many :messages
+      #
+      #     validate :validate_name
+      #     before_create :set_name
+      #     after_create :after_create_1
+      #     after_create :after_create_2
+      #
+      #     attr_readonly :email
+      #   end
+      #
+      # Default method lists for RailsClassOrder cop
+      module RailsClassOrderDefaults
+        ASSOCIATIONS = %w[
+          belongs_to has_many has_one has_and_belongs_to_many
+        ].freeze
+
+        CALLBACKS = %w[
+          after_initialize after_find after_touch
+          before_validation validates validate after_validation
+          before_save around_save before_create around_create
+          before_update around_update before_destroy around_destroy
+          after_destroy after_update after_create after_save
+          after_commit after_rollback
+        ].freeze
+
+        OTHERS = %w[attr_readonly serialize].freeze
+      end
+
+      # Autocorrect helpers for RailsClassOrder cop
+      module RailsClassOrderCorrector
+        def autocorrect(corrector, body, original, sorted)
+          first_target = original.min_by { |m| body.children.index(m) }
+          new_source = build_sorted_source(sorted, original)
+          corrector.replace(range_with_comments(first_target), new_source.rstrip)
+
+          (original - [first_target]).each do |method|
+            corrector.remove(full_method_range(method))
+          end
+        end
+
+        def range_with_comments(node)
+          comments = preceding_comments(node)
+          start_pos = comments.empty? ? node.loc.expression.begin_pos : comments.first.loc.expression.begin_pos
+          range_between(start_pos, node.loc.expression.end_pos)
+        end
+
+        def preceding_comments(node)
+          collect_adjacent_comments(node.loc.expression)
+        end
+
+        def collect_adjacent_comments(node_pos)
+          expected_line = node_pos.first_line - 1
+          comments_before_node(node_pos).take_while do |comment|
+            pos = comment.loc.expression
+            (pos.last_line == expected_line).tap { expected_line = pos.first_line - 1 }
+          end.reverse
+        end
+
+        def comments_before_node(node_pos)
+          processed_source.comments.select { |c| c.loc.expression.end_pos < node_pos.begin_pos }.reverse
+        end
+
+        def full_method_range(node)
+          range = range_with_comments(node)
+          source = processed_source.buffer.source
+          line_start = source.rindex("\n", range.begin_pos - 1)&.+(1) || 0
+          end_pos = source[range.end_pos] == "\n" ? range.end_pos + 1 : range.end_pos
+          range_between(line_start, end_pos)
+        end
+
+        def build_sorted_source(sorted, original)
+          indent = ' ' * original.first.loc.column
+          grouped = sorted.group_by { |m| method_type(m) }
+
+          %i[association callback other].filter_map do |type|
+            next unless grouped[type]&.any?
+
+            grouped[type].map { |m| source_with_comments(m) }.join("\n#{indent}")
+          end.join("\n\n#{indent}")
+        end
+
+        def source_with_comments(node)
+          range = range_with_comments(node)
+          processed_source.buffer.source[range.begin_pos...range.end_pos].lstrip
+        end
+      end
+
+      # Enforces consistent ordering of declarative methods in Rails models.
+      #
+      # @see RailsClassOrderDefaults for default method lists
+      class RailsClassOrder < Base
+        extend AutoCorrector
+        include RangeHelp
+        include RailsClassOrderCorrector
+
+        MSG = 'Declarative methods should be sorted by type: associations, callbacks, then others.'
+        TYPE_ORDER = { association: 0, callback: 1, other: 2 }.freeze
+
+        def on_class(node)
+          _name, _superclass, body = *node
+          return unless body&.begin_type?
+
+          check_order(body)
+        end
+
+        private
+
+        def check_order(body)
+          targets = target_methods(body)
+          return if targets.empty?
+
+          sorted = sort_methods(targets)
+          return if targets == sorted
+
+          first_misplaced = targets.zip(sorted).find { |a, e| a != e }&.first
+          add_offense(first_misplaced) { |corrector| autocorrect(corrector, body, targets, sorted) }
+        end
+
+        def associations
+          @associations ||= cop_config.fetch('Associations', RailsClassOrderDefaults::ASSOCIATIONS).map(&:to_sym)
+        end
+
+        def callbacks
+          @callbacks ||= cop_config.fetch('Callbacks', RailsClassOrderDefaults::CALLBACKS).map(&:to_sym)
+        end
+
+        def others
+          @others ||= cop_config.fetch('Others', RailsClassOrderDefaults::OTHERS).map(&:to_sym)
+        end
+
+        def all_target_methods
+          @all_target_methods ||= associations + callbacks + others
+        end
+
+        def target_methods(body)
+          body.children.select { |child| child.send_type? && all_target_methods.include?(child.method_name) }
+        end
+
+        def sort_methods(methods)
+          methods.each_with_index.sort_by { |m, i| [method_type_order(m), method_position_in_type(m), i] }.map(&:first)
+        end
+
+        def method_type(method)
+          name = method.method_name
+          return :association if associations.include?(name)
+          return :callback if callbacks.include?(name)
+
+          :other
+        end
+
+        def method_type_order(method)
+          TYPE_ORDER[method_type(method)]
+        end
+
+        def method_position_in_type(method)
+          method_list_for_type(method_type(method)).index(method.method_name) || 999
+        end
+
+        def method_list_for_type(type)
+          { association: associations, callback: callbacks, other: others }[type]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-asjer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Asjer Querido
@@ -57,6 +57,7 @@ files:
 - lib/rubocop/asjer/plugin.rb
 - lib/rubocop/asjer/version.rb
 - lib/rubocop/cop/asjer/no_default_translation.rb
+- lib/rubocop/cop/asjer/rails_class_order.rb
 - release-please-config.json
 - sig/rubocop/i18n.rbs
 homepage: https://github.com/asjer/rubocop-asjer