rubocop-nueca 1.1.5 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d780fbfedb280b9cb1348a3559a27639ea9139b726de9de211d2fb8bc908dc8
-  data.tar.gz: 90b26a394731353973252722260e66f080fab38d6f94ccea5da2f9ac43caca72
+  metadata.gz: a49b9e5e060e7ec154ef9feaf553325fb156d58c59aba67ea3cc2ac1e1e13b67
+  data.tar.gz: 3e110fe0c9a710158865e3f67a443dacde11a7aba68f92df3ff305016cc2fdbc
 SHA512:
-  metadata.gz: ac985c1f32b83fdec80085a665a0219f75558df08be4ed73ef5828397822ab214cc7c605fcaf9ec464a51fc3ed7614cd717a9e1e4ea1b8310c4e2356c639dddc
-  data.tar.gz: 7334aae4c9f2d30c41d55bfbc51135f8985b5be4b6699fc32caf79a06fd058b17a126bdea0528186b301103a9bd0de3997926ca3709c5af0b1adfe8b986b4791
+  metadata.gz: 376a36b1a4e897c49af1fc553504471e2c9014e8bfb1b147dc9f0d1af5f5202acb3e91feaf382310f17468e7515b1c59d2cb8d0198285418d5733cf2a643742d
+  data.tar.gz: 910aef0f0fd56d15ef56c1fe7b2e3bb2ebc18d65dfb35aa7c88ab698e6e6ed8fe8bd21635ff3ca94f85c10f9c730d81b5fc3b247a4412dfb180f9f869093d693

data/lib/rubocop/cop/rails/model_association_missing_through.rb

@@ -7,6 +7,7 @@ module RuboCop
         MSG = 'Association %<association>s references through %<through>s, ' \
               'but %<through>s is not defined in this model.'
         ASSOCIATION_METHODS = [
+          :belongs_to,
           :has_one,
           :has_many,
           :has_and_belongs_to_many

data/lib/rubocop/cop/rails/route_consistent_spacing.rb

@@ -1,39 +1,27 @@
 # frozen_string_literal: true
 
-require_relative '../shared/route_collector'
+require_relative '../shared/route_helper'
 
 module RuboCop
   module Cop
     module Rails
       class RouteConsistentSpacing < RuboCop::Cop::Base
+        include RouteHelper
+
         MSG = 'Do not leave blank lines between routes of the same type at the same namespace level.'
 
         def on_block(node)
-          return unless rails_routes_draw_block?(node)
-
-          routes = collect_routes(node)
-          return if routes.size < 2
+          process_route_block(node)
+        end
 
-          check_consistent_spacing(routes)
+        def investigate(processed_source)
+          process_route_file(processed_source)
         end
 
         private
 
-        def rails_routes_draw_block?(node)
-          return false unless node.block_type?
-
-          send_node = node.send_node
-          receiver = send_node.receiver
-          return false unless receiver
-
-          receiver.source == 'Rails.application.routes' && send_node.method_name == :draw
-        end
-
-        def collect_routes(routes_block)
-          collector = RouteCollector.new
-          body = routes_block.body
-          collector.collect(body) if body
-          collector.routes.sort_by { |route| route[:line] }
+        def check_routes(routes)
+          check_consistent_spacing(routes)
         end
 
         def check_consistent_spacing(routes)

data/lib/rubocop/cop/rails/route_grouping.rb

@@ -1,39 +1,27 @@
 # frozen_string_literal: true
 
-require_relative '../shared/route_collector'
+require_relative '../shared/route_helper'
 
 module RuboCop
   module Cop
     module Rails
       class RouteGrouping < RuboCop::Cop::Base
+        include RouteHelper
+
         MSG = 'Group routes by type. Keep simple routes, resources, and namespaces grouped together.'
 
         def on_block(node)
-          return unless rails_routes_draw_block?(node)
-
-          routes = collect_routes(node)
-          return if routes.size < 2
+          process_route_block(node)
+        end
 
-          check_for_scattered_routes(routes)
+        def investigate(processed_source)
+          process_route_file(processed_source)
         end
 
         private
 
-        def rails_routes_draw_block?(node)
-          return false unless node.block_type?
-
-          send_node = node.send_node
-          receiver = send_node.receiver
-          return false unless receiver
-
-          receiver.source == 'Rails.application.routes' && send_node.method_name == :draw
-        end
-
-        def collect_routes(routes_block)
-          collector = RouteCollector.new
-          body = routes_block.body
-          collector.collect(body) if body
-          collector.routes.sort_by { |route| route[:line] }
+        def check_routes(routes)
+          check_for_scattered_routes(routes)
         end
 
         def check_for_scattered_routes(routes)

data/lib/rubocop/cop/rails/route_root_position.rb

@@ -1,39 +1,33 @@
 # frozen_string_literal: true
 
-require_relative '../shared/route_collector'
+require_relative '../shared/route_helper'
 
 module RuboCop
   module Cop
     module Rails
       class RouteRootPosition < RuboCop::Cop::Base
+        include RouteHelper
+
         MSG = 'The root route should be positioned at the top of routes within the same namespace level.'
 
         def on_block(node)
-          return unless rails_routes_draw_block?(node)
-
-          routes = collect_routes(node)
-          return if routes.empty?
+          process_route_block(node)
+        end
 
-          check_root_position(routes)
+        def investigate(processed_source)
+          process_route_file(processed_source)
         end
 
         private
 
-        def rails_routes_draw_block?(node)
-          return false unless node.block_type?
-
-          send_node = node.send_node
-          receiver = send_node.receiver
-          return false unless receiver
-
-          receiver.source == 'Rails.application.routes' && send_node.method_name == :draw
+        def minimum_routes_for_check
+          0
         end
 
-        def collect_routes(routes_block)
-          collector = RouteCollector.new
-          body = routes_block.body
-          collector.collect(body) if body
-          collector.routes.sort_by { |route| route[:line] }
+        def check_routes(routes)
+          return if routes.empty?
+
+          check_root_position(routes)
         end
 
         def check_root_position(routes)

data/lib/rubocop/cop/rails/route_separation.rb

@@ -1,39 +1,27 @@
 # frozen_string_literal: true
 
-require_relative '../shared/route_collector'
+require_relative '../shared/route_helper'
 
 module RuboCop
   module Cop
     module Rails
       class RouteSeparation < RuboCop::Cop::Base
+        include RouteHelper
+
         MSG = 'Separate different route types with a blank line.'
 
         def on_block(node)
-          return unless rails_routes_draw_block?(node)
-
-          routes = collect_routes(node)
-          return if routes.size < 2
+          process_route_block(node)
+        end
 
-          check_route_separation(routes)
+        def investigate(processed_source)
+          process_route_file(processed_source)
         end
 
         private
 
-        def rails_routes_draw_block?(node)
-          return false unless node.block_type?
-
-          send_node = node.send_node
-          receiver = send_node.receiver
-          return false unless receiver
-
-          receiver.source == 'Rails.application.routes' && send_node.method_name == :draw
-        end
-
-        def collect_routes(routes_block)
-          collector = RouteCollector.new
-          body = routes_block.body
-          collector.collect(body) if body
-          collector.routes.sort_by { |route| route[:line] }
+        def check_routes(routes)
+          check_route_separation(routes)
         end
 
         def check_route_separation(routes)

data/lib/rubocop/cop/rails/route_sorting.rb

@@ -1,40 +1,28 @@
 # frozen_string_literal: true
 
-require_relative '../shared/route_collector'
+require_relative '../shared/route_helper'
 
 module RuboCop
   module Cop
     module Rails
       class RouteSorting < RuboCop::Cop::Base
+        include RouteHelper
+
         MSG = 'Sort routes of the same type alphabetically within the same namespace level. ' \
               'Expected order: %<expected>s.'
 
         def on_block(node)
-          return unless rails_routes_draw_block?(node)
-
-          routes = collect_routes(node)
-          return if routes.size < 2
+          process_route_block(node)
+        end
 
-          check_route_sorting(routes)
+        def investigate(processed_source)
+          process_route_file(processed_source)
         end
 
         private
 
-        def rails_routes_draw_block?(node)
-          return false unless node.block_type?
-
-          send_node = node.send_node
-          receiver = send_node.receiver
-          return false unless receiver
-
-          receiver.source == 'Rails.application.routes' && send_node.method_name == :draw
-        end
-
-        def collect_routes(routes_block)
-          collector = RouteCollector.new
-          body = routes_block.body
-          collector.collect(body) if body
-          collector.routes.sort_by { |route| route[:line] }
+        def check_routes(routes)
+          check_route_sorting(routes)
         end
 
         def check_route_sorting(routes)

data/lib/rubocop/cop/shared/collection_context.rb

@@ -3,6 +3,7 @@
 module RuboCop
   module Cop
     module Rails
+      # rubocop:disable Metrics/ClassLength
       class CollectionContext
         ROUTE_CATEGORIES = {
           simple: [:get, :post, :put, :patch, :delete, :head, :options, :match, :root],
@@ -12,6 +13,7 @@ module RuboCop
         }.freeze
 
         ALL_ROUTE_METHODS = ROUTE_CATEGORIES.values.flatten.freeze
+        SCOPE_OPTIONS = [:module, :path].freeze
 
         def initialize(collector, namespace_level, namespace_path = [])
           @collector = collector
@@ -44,18 +46,31 @@ module RuboCop
           return unless send_node.send_type? && route_method?(send_node)
 
           add_route_if_valid(send_node)
+          process_nested_context(node)
+        end
 
+        def process_nested_context(node)
           body = node.body
           return unless body
 
+          new_namespace_path = build_namespace_path(node.send_node)
+          nested_context = CollectionContext.new(@collector, @namespace_level + 1, new_namespace_path)
+          nested_context.process_node(body)
+        end
+
+        def build_namespace_path(send_node)
           new_namespace_path = @namespace_path.dup
-          if send_node.method_name == :namespace
+
+          case send_node.method_name
+          when :namespace
             namespace_name = extract_namespace_name(send_node)
             new_namespace_path << namespace_name if namespace_name
+          when :scope
+            scope_name = extract_scope_name(send_node)
+            new_namespace_path << scope_name if scope_name
           end
 
-          nested_context = CollectionContext.new(@collector, @namespace_level + 1, new_namespace_path)
-          nested_context.process_node(body)
+          new_namespace_path
         end
 
         def extract_namespace_name(node)
@@ -65,6 +80,47 @@ module RuboCop
           'unknown'
         end
 
+        def extract_scope_name(node)
+          scope_name = extract_scope_option_value(node)
+          return scope_name if scope_name
+
+          # If no module/path specified, use first argument if it's a symbol/string
+          first_arg = node.arguments.first
+          return first_arg.value.to_s if first_arg&.sym_type? || first_arg&.str_type?
+
+          'scope'
+        end
+
+        def extract_scope_option_value(node)
+          node.arguments.each do |arg|
+            next unless arg.hash_type?
+
+            scope_value = find_scope_option_in_hash(arg)
+            return scope_value if scope_value
+          end
+
+          nil
+        end
+
+        def find_scope_option_in_hash(hash_arg)
+          hash_arg.pairs.each do |pair|
+            value = extract_scope_value_from_pair(pair)
+            return value if value
+          end
+
+          nil
+        end
+
+        def extract_scope_value_from_pair(pair)
+          key = pair.key
+          return nil unless key&.sym_type? && SCOPE_OPTIONS.include?(key.value)
+
+          value = pair.value
+          return value.value.to_s if value&.sym_type? || value&.str_type?
+
+          nil
+        end
+
         def route_method?(node)
           return false unless node.send_type?
 
@@ -134,6 +190,7 @@ module RuboCop
           :other
         end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/rubocop/cop/shared/route_helper.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative 'route_collector'
+
+module RuboCop
+  module Cop
+    module Rails
+      module RouteHelper
+        def route_file?
+          processed_source.file_path&.end_with?('routes.rb')
+        end
+
+        def route_block?(node)
+          return false unless node.block_type?
+
+          send_node = node.send_node
+          return false unless send_node.send_type?
+          return true if send_node.receiver&.source == 'Rails.application.routes' && send_node.method_name == :draw
+          return false unless route_file?
+
+          [:scope, :namespace, :concern].include?(send_node.method_name)
+        end
+
+        def collect_routes(routes_block)
+          collector = RouteCollector.new
+          body = routes_block.body
+          collector.collect(body) if body
+          collector.routes.sort_by { |route| route[:line] }
+        end
+
+        def collect_routes_from_file(ast_node)
+          collector = RouteCollector.new
+          collector.collect(ast_node) if ast_node
+          collector.routes.sort_by { |route| route[:line] }
+        end
+
+        def process_route_block(node)
+          return unless route_block?(node)
+
+          routes = collect_routes(node)
+          return if routes.size < minimum_routes_for_check
+
+          check_routes(routes)
+        end
+
+        def process_route_file(processed_source)
+          return unless route_file?
+          return if processed_source.ast.nil?
+
+          routes = collect_routes_from_file(processed_source.ast)
+          return if routes.size < minimum_routes_for_check
+
+          check_routes(routes)
+        end
+
+        private
+
+        def minimum_routes_for_check
+          2
+        end
+
+        def check_routes(routes)
+          raise NotImplementedError, 'Subclasses must implement check_routes method'
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/nueca/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Nueca
-    VERSION = '1.1.5'
+    VERSION = '1.2.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-nueca
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.2
 platform: ruby
 authors:
 - Tien
@@ -160,6 +160,7 @@ files:
 - lib/rubocop/cop/rails/time_zone_today.rb
 - lib/rubocop/cop/shared/collection_context.rb
 - lib/rubocop/cop/shared/route_collector.rb
+- lib/rubocop/cop/shared/route_helper.rb
 - lib/rubocop/nueca/plugin.rb
 - lib/rubocop/nueca/version.rb
 homepage: https://github.com/tieeeeen1994/rubocop-nueca