rubocop-nueca 1.1.6 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb582e05cf23ba7da4d65218fa4715cf0086c8ddb3dcfc56f71870e8693fd072
-  data.tar.gz: 7e4dbe75693071c28501ed3798dbff546d3dafa5b6badea85b9db99c3cc92685
+  metadata.gz: a3678eac28f6575b9cee5fb58f88a02e46de0c91bf36437a242fc34208cd4da3
+  data.tar.gz: a11bbc18d306047a0b8c1b329430b15d92bff287190adcd99e9994eceb4d33d8
 SHA512:
-  metadata.gz: 032bc84ea0bfce6f02a97967a97d59e163a188b6d38cdc257e2160b1bfc77865dfecd82d66d136ec590ebf021375fd4a878ab0e055406178a17da4fd05545995
-  data.tar.gz: 75fb6fdd200abd96efdd9b75dc40b24a87c53ea3527d67131ba6ab103216db7843aac91ccce2e320e98c1f7b76e66e8ab72b50b85b52b85b98ea6a5c8b0f7131
+  metadata.gz: a5ab9039fb41adbeb81026aa2d7bfa8f4f542c6566f01c0c853fce78ee6b987919750c983524eef7cc467902f7b6b1e7921a542ea48c1ff624d8eece8d96e5f1
+  data.tar.gz: '078491a8477ad8a25a19c0a6a6e38541f599cc5d44efc35ec24974e86eec267fd1026c5517063367e7a64163f595014f1d912d6cc467f1fd828c7b044b2eb550'

data/.github/workflows/publish.yml

@@ -1,12 +1,16 @@
 name: Publish Gem
 
 on:
-  push:
+  workflow_run:
+    workflows: ["RuboCop"]
+    types:
+      - completed
     branches: [ master ]
 
 jobs:
   publish:
     runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
 
     steps:
     - uses: actions/checkout@v4

data/.github/workflows/rubocop.yml

@@ -0,0 +1,23 @@
+name: RuboCop
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.4'
+        bundler-cache: true
+
+    - name: Run RuboCop
+      run: bundle exec rubocop

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,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      class CollectionContext
+      class CollectionContext # rubocop:disable Metrics/ClassLength
         ROUTE_CATEGORIES = {
           simple: [:get, :post, :put, :patch, :delete, :head, :options, :match, :root],
           resource: [:resource, :resources],
@@ -12,6 +12,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
@@ -43,19 +44,40 @@ module RuboCop
           send_node = node.send_node
           return unless send_node.send_type? && route_method?(send_node)
 
-          add_route_if_valid(send_node)
+          add_route_block_if_valid(node)
+          process_nested_context(node)
+        end
+
+        def add_route_block_if_valid(node)
+          send_node = node.send_node
+          return unless route_method?(send_node)
+
+          route_info = build_route_info_from_block(node)
+          @collector.add_route(route_info) if route_info
+        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 +87,46 @@ module RuboCop
           'unknown'
         end
 
+        def extract_scope_name(node)
+          scope_name = extract_scope_option_value(node)
+          return scope_name if scope_name
+
+          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?
 
@@ -96,6 +158,26 @@ module RuboCop
           }
         end
 
+        def build_route_info_from_block(block_node)
+          send_node = block_node.send_node
+          method_name = send_node.method_name
+          route_name = extract_route_name(send_node)
+          return nil unless route_name
+
+          send_range = send_node.source_range
+          block_range = block_node.source_range
+          {
+            node: send_node,
+            method: method_name,
+            name: route_name,
+            line: send_range.line,
+            end_line: block_range.last_line,
+            namespace_level: @namespace_level,
+            namespace_path: @namespace_path.dup,
+            type: categorize_route_method(method_name)
+          }
+        end
+
         def extract_route_name(node)
           method_name = node.method_name
           first_arg = node.arguments.first

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.6'
+    VERSION = '1.2.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-nueca
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.3
 platform: ruby
 authors:
 - Tien
@@ -134,6 +134,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/publish.yml"
+- ".github/workflows/rubocop.yml"
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -160,6 +161,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