rubocop-rhino-project 0.21.0.beta.37 → 0.21.0.beta.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59120d377f945685bd29d1bade7c79743640fd4327b0bdd3c8ca4654c4c1208c
-  data.tar.gz: 5871e96f507643c715c6d4a9f786b069e56572bcd84365abede6967063fad797
+  metadata.gz: d36a5ece31362299777682a89706b49ad706f622c7cbcc55284c509e9c2354fa
+  data.tar.gz: 3111527595a88362daf801f0c65d727b4006cab53f669eaff65e59cc1abac8da
 SHA512:
-  metadata.gz: 22af500ae0ef5d8ba3f02d1ab67a84c9ee3de235748a98f35f91d5fc5b2cd2cffb26fd7defe40d053af022688025abd4a922cc3fc4a53e21941411ab815bedcc
-  data.tar.gz: ca97eb363b632a4fa0e744537d276644b02f0e635f3f11d04031dfc6342ea95e8d5c1c1a2e7d71851b2878e682144a3b7cc89175bc78914b8daa482432f8ba5a
+  metadata.gz: a2d18259b933ad6044c99a0de5cca607ce03de3423e50fa3d237fd23c075a4d4a760ec747fc6ed9e147ff9ae0fcafdf545ec82ebcad7c12c0cae1055fc28deb3
+  data.tar.gz: 7eff1bbb5924122e185ef819c399c21f7cb263582a578589a41d364f996b13f17041cf3a705b82eed74379b205e5a9fbf88b43882415d2cab685dd1dee5c1693

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.37"
+    PRE   = "beta.39"
 
     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.37
+  version: 0.21.0.beta.39
 platform: ruby
 authors:
 - JP Rosevear
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +64,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5.0
 description: ''
 email:
 - jp@codalio.com
@@ -88,6 +94,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