rubocop-rhino-project 0.21.0.beta.35 → 0.21.0.beta.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e138d8dfc9aa01209d58d208b2d7d4e1d9c571dea924e606da446a35f1108e
-  data.tar.gz: f61cbc2949ad06a3f0b841fd476a47df1283bbd4a8a97978d8a37b440b362ba5
+  metadata.gz: a9e03d22a4a2592db9f1d8ab043d3aeff065bc1398ec035e707418d68ef6c2e6
+  data.tar.gz: e2720fc71261d851c75ccc52bd2781c0fa9f00482d0f9e5ebbff264550581d8e
 SHA512:
-  metadata.gz: d6ef46c456de287126e82161412eb27612ed6125a31f9937e3295494547072f756294fbf0bfe271c4d9497cde5135af033b5f2e3e9f25f6991a45172555add31
-  data.tar.gz: f518c2b126f09b79fbaa8e9634c53b75658ff259360ca5232da29c353f4b691b006abe93eab9a104e0f0c5c98a428964b6779208a1eac8f5444bb4feaf46bb77
+  metadata.gz: 37446aa28dbb529fb3feb8f3e3cd2c4c7721ba0dd0cf02046610d122ceb918d9a8cf266223d9b08321286abb28d3e7b6dffe1a72dc6a83f19302f16035165fd0
+  data.tar.gz: e66e5e8f4403316080fe0c8d4fa62ede3db7ef98a3617dbe6bd568abf46495e4eaffee0357dbb6c80a79205ce2ea500e0059a9d6095331565e618d439f9a81d3

data/config/default.yml

@@ -16,6 +16,11 @@ AllCops:
     - storage/**/*
 
 RhinoProject/DuplicateRhinoReferences:
-  Description: ''
+  Description: 'Check for duplicate rhino_reference calls in the same file.'
+  Enabled: true
+  SafeAutoCorrect: false
+
+RhinoProject/OwnerSpecified:
+  Description: 'Check for rhino_owner_global, rhino_owner_base or rhino_owner calls'
   Enabled: true
   SafeAutoCorrect: false

data/lib/rubocop/cop/rhino_project/owner_specified.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "parser/current"
+module RuboCop
+  module Cop
+    module RhinoProject
+      # Call `rhino_owner`, `rhino_owner_base` or `rhino_owner_global` for the model class.
+      #
+      #
+      # @example
+      #   # bad
+      #   class Blog < ApplicationRecord
+      #     belongs_to :user
+      #     belongs_to :category
+      #
+      #     rhino_references %i[user]
+      #   end
+      #
+      #   # good
+      #   class Blog < ApplicationRecord
+      #     belongs_to :user
+      #     belongs_to :category
+      #
+      #     rhino_owner :user
+      #     rhino_references %i[user category]
+      #   end
+      #
+      class OwnerSpecified < Cop
+        MSG = "ActiveRecord models listed in rhino.rb must specify exactly one ownership method (rhino_owner_global, rhino_owner_reference, or rhino_owner :symbol)."
+
+        REQUIRED_METHODS = [:rhino_owner_global, :rhino_owner_base, :rhino_owner].freeze
+
+        def investigate(processed_source)
+          return unless applicable_model?(processed_source)
+
+          class_node = find_class_node(processed_source.ast)
+          return unless class_node
+
+          method_calls = find_rhino_owner_calls(class_node)
+
+          if method_calls.size != 1
+            add_offense(class_node, message: MSG)
+          end
+        end
+
+        private
+          def applicable_model?(processed_source)
+            model_name = extract_class_name(processed_source)
+
+            return false if inherits_from_rhino?(processed_source)
+
+            rhino_resources.include?(model_name)
+          end
+
+          def extract_class_name(processed_source)
+            class_node = find_class_node(processed_source.ast)
+            return unless class_node
+
+            class_name_node = class_node.children[0]
+            class_name_node.const_name
+          end
+
+          def find_rhino_owner_calls(class_node)
+            # Search only within the class body for Rhino ownership method calls
+            body_node = class_node.children[2]
+            find_descendants(body_node).select do |send_node|
+              send_node.type == :send && REQUIRED_METHODS.include?(send_node.children[1])
+            end
+          end
+
+          def find_class_node(ast)
+            find_descendants(ast).find { |node| node.type == :class }
+          end
+
+          # Check if the class inherits from a Rhino:: class
+          def inherits_from_rhino?(processed_source)
+            class_node = find_class_node(processed_source.ast)
+            return false unless class_node
+
+            superclass_node = class_node.children[1]
+            return false unless superclass_node
+
+            superclass_name = superclass_node.const_name
+            superclass_name&.start_with?("Rhino::")
+          end
+
+          def rhino_resources
+            @rhino_resources ||= read_rhino_resources
+          end
+
+          def read_rhino_resources
+            rhino_initializer_path = File.join(Dir.pwd, "config", "initializers", "rhino.rb")
+            return [] unless File.exist?(rhino_initializer_path)
+
+            rhino_initializer_content = File.read(rhino_initializer_path)
+            ast = Parser::CurrentRuby.parse(rhino_initializer_content)
+            parse_rhino_resources(ast)
+          end
+
+          # Parse the rhino.rb AST and extract the resources added to config.resources
+          def parse_rhino_resources(ast)
+            resources = []
+
+            find_resources_assignments(ast).each do |assignment_node|
+              next unless assignment_node
+
+              # Looking for array elements in `config.resources += [...]`
+              array_node = assignment_node.children[2] # Accessing the right-hand side of `+=`
+              if array_node&.type == :array
+                resources.concat(array_node.children.map { |node| extract_string(node) })
+              end
+            end
+
+            resources.compact
+          end
+
+          # Now looking for `op_asgn` nodes that represent `config.resources += [...]`
+          def find_resources_assignments(ast)
+            find_descendants(ast).select do |node|
+              node.type == :op_asgn && node.children[1] == :+
+            end
+          end
+
+          def extract_string(node)
+            return unless node.type == :str
+
+            node.children[0]
+          end
+
+          # Custom method to recursively find descendants in a generic AST node (Parser or RuboCop)
+          def find_descendants(node, &block)
+            return [] unless node.is_a?(Parser::AST::Node)
+
+            results = [node]
+            node.children.each do |child|
+              next unless child.is_a?(Parser::AST::Node)
+
+              results.concat(find_descendants(child, &block))
+            end
+            results
+          end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rhino_project_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative "rhino_project/duplicate_rhino_references"
+require_relative "rhino_project/owner_specified"

data/lib/rubocop/rhino_project/version.rb

@@ -10,7 +10,7 @@ module RubocopRhinoProject
     MAJOR = 0
     MINOR = 21
     TINY  = 0
-    PRE   = "beta.35"
+    PRE   = "beta.38"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rhino-project
 version: !ruby/object:Gem::Version
-  version: 0.21.0.beta.35
+  version: 0.21.0.beta.38
 platform: ruby
 authors:
 - JP Rosevear
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-06 00:00:00.000000000 Z
+date: 2024-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,6 +88,7 @@ files:
 - config/default.yml
 - lib/rubocop-rhino-project.rb
 - lib/rubocop/cop/rhino_project/duplicate_rhino_references.rb
+- lib/rubocop/cop/rhino_project/owner_specified.rb
 - lib/rubocop/cop/rhino_project_cops.rb
 - lib/rubocop/rhino_project.rb
 - lib/rubocop/rhino_project/inject.rb
@@ -98,7 +99,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.16
-signing_key: 
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []