rubocop-vibe 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdbef6b6693f735e021fc40b2ff54c091942cacc146e6d7314b93597d92d5f0a
-  data.tar.gz: 1d612390dcb873c62803cfce7357dc6e73f2dd76cc63adff21478f62d513743f
+  metadata.gz: 32efe500f7fb50e4005a4ef34081405eee947bc058b96c684e60d3edb1095976
+  data.tar.gz: 79b4d44786594d509536e369756ead61b0cd34cd54cf288f857b4fa04e90f0a5
 SHA512:
-  metadata.gz: 4b57b54a638c0cd84c19e2096d5792c145964bfab9c96f5f47f6a19d44f17bf8830260b536f6913cacb1f154da30dd26226ac688b3c5fa074fbcd90346cfbfb9
-  data.tar.gz: dfec2e07080d666343b0ebd686042299eaa129884fa47c35cab9b0f5ccdd54747d7227edecc970bff1e0e3a1279c4ac8c6eedc7a29e0da54df9fbd3edbed7a8e
+  metadata.gz: 62fb11ebb915d21241f1c0da9b6684564e457aeaa0469ce2fc5ec708bfaf1754f8b4f85dfc7167b7ea68b9e498424d6feb3e6afb57673f28a2921e88fba56f3d
+  data.tar.gz: 10bdf89f1dcfd15dbdfe06d293d3a6633193ecf953d50133be333d50b70b3ed7f84f081f6d40c4cbafd3fa68ae50839958ad1fe92eafddd44151b3f1c068e090

data/config/default.yml

@@ -62,6 +62,12 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
+Vibe/AttrOrder:
+  Description: "Enforces alphabetical ordering of attr_reader, attr_writer, and attr_accessor arguments."
+  Enabled: true
+  SafeAutoCorrect: true
+  VersionAdded: "0.5.0"
+
 Vibe/BlankLineAfterAssignment:
   Description: "Enforces a blank line after variable assignments when followed by other code."
   Enabled: true
@@ -79,6 +85,7 @@ Vibe/ClassOrganization:
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: "0.1.0"
+  VersionChanged: "0.6.0"
 
 Vibe/ConsecutiveAssignmentAlignment:
   Description: "Enforces alignment of consecutive variable assignments at the = operator."
@@ -110,11 +117,24 @@ Vibe/ConsecutiveLetAlignment:
   SafeAutoCorrect: true
   VersionAdded: "0.2.0"
 
+Vibe/ConsecutiveScopeAlignment:
+  Description: "Enforces alignment of consecutive scope declarations at the -> arrow."
+  Enabled: true
+  SafeAutoCorrect: true
+  VersionAdded: "0.5.0"
+
+Vibe/ConstantAlphaOrder:
+  Description: "Enforces alphabetical ordering of consecutive constant declarations by name."
+  Enabled: true
+  SafeAutoCorrect: false
+  VersionAdded: "0.5.0"
+
 Vibe/DescribeBlockOrder:
   Description: "Enforces consistent ordering of describe blocks in RSpec files."
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: "0.1.0"
+  VersionChanged: "0.6.0"
 
 Vibe/ExplicitReturnConditional:
   Description: "Enforces explicit if/else/end blocks instead of ternary or trailing conditionals for return values."
@@ -128,6 +148,12 @@ Vibe/IsExpectedOneLiner:
   SafeAutoCorrect: true
   VersionAdded: "0.1.0"
 
+Vibe/KeywordArgumentOrder:
+  Description: "Enforces alphabetical ordering of keyword arguments and their YARD documentation."
+  Enabled: true
+  SafeAutoCorrect: true
+  VersionAdded: "0.5.0"
+
 Vibe/LetOrder:
   Description: "Enforces alphabetical ordering of consecutive let declarations."
   Enabled: true
@@ -196,3 +222,15 @@ Vibe/ServiceCallMethod:
   Description: "Service objects should define `self.call` and `call` methods."
   Enabled: true
   VersionAdded: "0.1.0"
+
+Vibe/ValidateAfterValidates:
+  Description: "Enforces that validate calls appear after validates declarations in Rails models."
+  Enabled: true
+  SafeAutoCorrect: true
+  VersionAdded: "0.5.0"
+
+Vibe/ValidatesAlphaOrder:
+  Description: "Enforces alphabetical ordering of consecutive validates declarations by attribute name."
+  Enabled: true
+  SafeAutoCorrect: true
+  VersionAdded: "0.5.0"

data/lib/rubocop/cop/vibe/attr_order.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vibe
+      # Enforces alphabetical ordering of arguments to `attr_reader`,
+      # `attr_writer`, and `attr_accessor` declarations.
+      #
+      # @example
+      #   # bad
+      #   attr_reader :id, :content, :timestamp, :raw
+      #
+      #   # good
+      #   attr_reader :content, :id, :raw, :timestamp
+      #
+      #   # bad
+      #   attr_accessor :zebra, :apple
+      #
+      #   # good
+      #   attr_accessor :apple, :zebra
+      class AttrOrder < Base
+        extend AutoCorrector
+
+        MSG = "Order `%<method>s` arguments alphabetically."
+
+        ATTR_METHODS = %i(attr_reader attr_writer attr_accessor).freeze
+
+        # Check attr_* method calls for alphabetical ordering.
+        #
+        # @param [RuboCop::AST::Node] node The send node.
+        # @return [void]
+        def on_send(node)
+          return unless attr_method?(node)
+          return unless node.arguments.size > 1
+          return if all_symbols?(node.arguments) && alphabetically_ordered?(node.arguments)
+
+          add_offense(node, message: format(MSG, method: node.method_name)) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        # Check if all arguments are symbols.
+        #
+        # @param [Array<RuboCop::AST::Node>] arguments The arguments.
+        # @return [Boolean]
+        def all_symbols?(arguments)
+          arguments.all?(&:sym_type?)
+        end
+
+        # Check if arguments are alphabetically ordered.
+        #
+        # @param [Array<RuboCop::AST::Node>] arguments The arguments.
+        # @return [Boolean]
+        def alphabetically_ordered?(arguments)
+          names = arguments.map { |arg| arg.value.to_s }
+
+          names == names.sort
+        end
+
+        # Check if the node is an attr_* method call.
+        #
+        # @param [RuboCop::AST::Node] node The send node.
+        # @return [Boolean]
+        def attr_method?(node)
+          node.receiver.nil? && ATTR_METHODS.include?(node.method_name)
+        end
+
+        # Auto-correct by reordering arguments alphabetically.
+        #
+        # @param [RuboCop::AST::Corrector] corrector The corrector.
+        # @param [RuboCop::AST::Node] node The send node.
+        # @return [void]
+        def autocorrect(corrector, node)
+          sorted_args   = node.arguments.sort_by { |arg| arg.value.to_s }
+          sorted_source = sorted_args.map(&:source).join(", ")
+
+          args_range = node.first_argument.source_range.join(node.last_argument.source_range)
+
+          corrector.replace(args_range, sorted_source)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vibe/blank_line_after_assignment.rb

@@ -53,6 +53,7 @@ module RuboCop
           end
         end
         alias on_numblock on_block
+        alias on_itblock on_block
 
         # Check method definitions for assignment statements.
         #
@@ -67,6 +68,45 @@ module RuboCop
 
         private
 
+        # Get the variable name from an assignment node.
+        #
+        # @param [RuboCop::AST::Node] node The assignment node.
+        # @return [Symbol, nil]
+        def assigned_variable_name(node)
+          return node.children.first if node.lvasgn_type?
+
+          target = node.children.first
+
+          if target.lvasgn_type?
+            target.children.first
+          end
+        end
+
+        # Check if a node is a variable assignment.
+        #
+        # @param [RuboCop::AST::Node] node The node to check.
+        # @return [Boolean]
+        def assignment?(node)
+          node.type?(:lvasgn, :op_asgn, :or_asgn, :and_asgn)
+        end
+
+        # Get the value being assigned.
+        #
+        # @param [RuboCop::AST::Node] node The assignment node.
+        # @return [RuboCop::AST::Node, nil]
+        def assignment_value(node)
+          node.children.last
+        end
+
+        # Check if there's a blank line between two statements.
+        #
+        # @param [RuboCop::AST::Node] previous_node The previous statement.
+        # @param [RuboCop::AST::Node] current_node The current statement.
+        # @return [Boolean]
+        def blank_line_between?(previous_node, current_node)
+          current_node.loc.line - previous_node.loc.last_line > 1
+        end
+
         # Check the body for missing blank lines after assignments.
         #
         # @param [RuboCop::AST::Node] body The body node.
@@ -81,18 +121,6 @@ module RuboCop
           end
         end
 
-        # Extract statements from a body node.
-        #
-        # @param [RuboCop::AST::Node] body The body node.
-        # @return [Array<RuboCop::AST::Node>]
-        def extract_statements(body)
-          if body.begin_type?
-            body.children
-          else
-            [body]
-          end
-        end
-
         # Check a pair of statements for missing blank line after assignment.
         #
         # @param [RuboCop::AST::Node] current The current statement.
@@ -113,17 +141,6 @@ module RuboCop
           end
         end
 
-        # Get the inner statement from a modifier node.
-        #
-        # @param [RuboCop::AST::Node] node The node to unwrap.
-        # @return [RuboCop::AST::Node]
-        def inner_statement(node)
-          return node.if_branch if node.type?(:if) && node.modifier_form?
-          return node.body if node.type?(:while, :until) && node.modifier_form?
-
-          node
-        end
-
         # Check if both statements are FactoryBot calls.
         #
         # @param [RuboCop::AST::Node] assignment The assignment node.
@@ -133,12 +150,16 @@ module RuboCop
           factory_bot_call?(assignment_value(assignment)) && factory_bot_call?(following)
         end
 
-        # Get the value being assigned.
+        # Extract statements from a body node.
         #
-        # @param [RuboCop::AST::Node] node The assignment node.
-        # @return [RuboCop::AST::Node, nil]
-        def assignment_value(node)
-          node.children.last
+        # @param [RuboCop::AST::Node] body The body node.
+        # @return [Array<RuboCop::AST::Node>]
+        def extract_statements(body)
+          if body.begin_type?
+            body.children
+          else
+            [body]
+          end
         end
 
         # Check if a node is a FactoryBot method call.
@@ -166,18 +187,15 @@ module RuboCop
           receiver.lvar_type? && receiver.children.first == var_name
         end
 
-        # Get the variable name from an assignment node.
+        # Get the inner statement from a modifier node.
         #
-        # @param [RuboCop::AST::Node] node The assignment node.
-        # @return [Symbol, nil]
-        def assigned_variable_name(node)
-          return node.children.first if node.lvasgn_type?
-
-          target = node.children.first
+        # @param [RuboCop::AST::Node] node The node to unwrap.
+        # @return [RuboCop::AST::Node]
+        def inner_statement(node)
+          return node.if_branch if node.type?(:if) && node.modifier_form?
+          return node.body if node.type?(:while, :until) && node.modifier_form?
 
-          if target.lvasgn_type?
-            target.children.first
-          end
+          node
         end
 
         # Get the leftmost receiver in a method chain.
@@ -194,23 +212,6 @@ module RuboCop
 
           current
         end
-
-        # Check if a node is a variable assignment.
-        #
-        # @param [RuboCop::AST::Node] node The node to check.
-        # @return [Boolean]
-        def assignment?(node)
-          node.type?(:lvasgn, :op_asgn, :or_asgn, :and_asgn)
-        end
-
-        # Check if there's a blank line between two statements.
-        #
-        # @param [RuboCop::AST::Node] previous_node The previous statement.
-        # @param [RuboCop::AST::Node] current_node The current statement.
-        # @return [Boolean]
-        def blank_line_between?(previous_node, current_node)
-          current_node.loc.line - previous_node.loc.last_line > 1
-        end
       end
     end
   end

data/lib/rubocop/cop/vibe/blank_line_before_expectation.rb

@@ -51,39 +51,17 @@ module RuboCop
           end
         end
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 
-        # Check if the block should be processed.
+        # Check if there's a blank line between two statements.
         #
-        # @param [RuboCop::AST::Node] node The block node.
+        # @param [RuboCop::AST::Node] previous_node The previous statement.
+        # @param [RuboCop::AST::Node] current_node The current statement.
         # @return [Boolean]
-        def processable_block?(node)
-          spec_file? && example_block?(node) && node.body
-        end
-
-        # Extract statements from the block body.
-        #
-        # @param [RuboCop::AST::Node] body The block body.
-        # @return [Array<RuboCop::AST::Node>]
-        def extract_statements(body)
-          if body.begin_type?
-            body.children
-          else
-            [body]
-          end
-        end
-
-        # Check statements for missing blank lines before expectations.
-        #
-        # @param [Array<RuboCop::AST::Node>] statements The statements to check.
-        # @return [void]
-        def check_statements(statements)
-          statements.each_with_index do |statement, index|
-            next if index.zero?
-
-            check_statement_pair(statements[index - 1], statement)
-          end
+        def blank_line_between?(previous_node, current_node)
+          current_node.loc.line - previous_node.loc.last_line > 1
         end
 
         # Check a pair of statements for missing blank line.
@@ -101,14 +79,27 @@ module RuboCop
           register_offense(expect_node, previous_statement)
         end
 
-        # Register an offense for missing blank line.
+        # Check statements for missing blank lines before expectations.
         #
-        # @param [RuboCop::AST::Node] expect_node The expect node.
-        # @param [RuboCop::AST::Node] previous_statement The previous statement.
+        # @param [Array<RuboCop::AST::Node>] statements The statements to check.
         # @return [void]
-        def register_offense(expect_node, previous_statement)
-          add_offense(expect_node.loc.selector) do |corrector|
-            corrector.insert_after(previous_statement, "\n")
+        def check_statements(statements)
+          statements.each_with_index do |statement, index|
+            next if index.zero?
+
+            check_statement_pair(statements[index - 1], statement)
+          end
+        end
+
+        # Extract statements from the block body.
+        #
+        # @param [RuboCop::AST::Node] body The block body.
+        # @return [Array<RuboCop::AST::Node>]
+        def extract_statements(body)
+          if body.begin_type?
+            body.children
+          else
+            [body]
           end
         end
 
@@ -132,13 +123,23 @@ module RuboCop
           node.each_descendant(:send).find { |send_node| expect_call?(send_node) }
         end
 
-        # Check if there's a blank line between two statements.
+        # Check if the block should be processed.
         #
-        # @param [RuboCop::AST::Node] previous_node The previous statement.
-        # @param [RuboCop::AST::Node] current_node The current statement.
+        # @param [RuboCop::AST::Node] node The block node.
         # @return [Boolean]
-        def blank_line_between?(previous_node, current_node)
-          current_node.loc.line - previous_node.loc.last_line > 1
+        def processable_block?(node)
+          spec_file? && example_block?(node) && node.body
+        end
+
+        # Register an offense for missing blank line.
+        #
+        # @param [RuboCop::AST::Node] expect_node The expect node.
+        # @param [RuboCop::AST::Node] previous_statement The previous statement.
+        # @return [void]
+        def register_offense(expect_node, previous_statement)
+          add_offense(expect_node.loc.selector) do |corrector|
+            corrector.insert_after(previous_statement, "\n")
+          end
         end
       end
     end