rubocop-nueca 1.0.0

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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      class CollectionContext
+        ROUTE_CATEGORIES = {
+          simple: [:get, :post, :put, :patch, :delete, :head, :options, :match, :root],
+          resource: [:resource, :resources],
+          namespace: [:namespace, :scope, :concern],
+          draw: [:draw]
+        }.freeze
+
+        ALL_ROUTE_METHODS = ROUTE_CATEGORIES.values.flatten.freeze
+
+        def initialize(collector, namespace_level, namespace_path = [])
+          @collector = collector
+          @namespace_level = namespace_level
+          @namespace_path = namespace_path
+        end
+
+        def process_node(node)
+          case node.type
+          when :begin
+            node.children.each { |child| process_node(child) }
+          when :send
+            add_route_if_valid(node)
+          when :block
+            process_block(node)
+          end
+        end
+
+        private
+
+        def add_route_if_valid(node)
+          return unless route_method?(node)
+
+          route_info = build_route_info(node)
+          @collector.add_route(route_info) if route_info
+        end
+
+        def process_block(node)
+          send_node = node.send_node
+          return unless send_node.send_type? && route_method?(send_node)
+
+          add_route_if_valid(send_node)
+
+          body = node.body
+          return unless body
+
+          new_namespace_path = @namespace_path.dup
+          if send_node.method_name == :namespace
+            namespace_name = extract_namespace_name(send_node)
+            new_namespace_path << namespace_name if namespace_name
+          end
+
+          nested_context = CollectionContext.new(@collector, @namespace_level + 1, new_namespace_path)
+          nested_context.process_node(body)
+        end
+
+        def extract_namespace_name(node)
+          first_arg = node.arguments.first
+          return first_arg.value.to_s if first_arg&.sym_type? || first_arg&.str_type?
+
+          'unknown'
+        end
+
+        def route_method?(node)
+          return false unless node.send_type?
+
+          receiver = node.receiver
+          return false if receiver && !simple_receiver?(receiver)
+
+          ALL_ROUTE_METHODS.include?(node.method_name)
+        end
+
+        def simple_receiver?(receiver)
+          receiver.nil? || receiver.send_type?
+        end
+
+        def build_route_info(node)
+          method_name = node.method_name
+          route_name = extract_route_name(node)
+          return nil unless route_name
+
+          source_range = node.source_range
+          {
+            node: node,
+            method: method_name,
+            name: route_name,
+            line: source_range.line,
+            end_line: source_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
+
+          case method_name
+          when :root then 'root'
+          when :draw then extract_symbol_or_default(first_arg, 'draw')
+          when *ROUTE_CATEGORIES[:simple] then extract_simple_route_name(first_arg)
+          when *ROUTE_CATEGORIES[:resource], *ROUTE_CATEGORIES[:namespace]
+            extract_symbol_or_default(first_arg, 'unknown')
+          else
+            'unknown'
+          end
+        end
+
+        def extract_symbol_or_default(arg, default)
+          arg&.sym_type? ? arg.value.to_s : default
+        end
+
+        def extract_simple_route_name(first_arg)
+          return first_arg.value.to_s if first_arg&.str_type?
+          return extract_hash_route_name(first_arg) if first_arg&.hash_type?
+
+          'unknown'
+        end
+
+        def extract_hash_route_name(hash_arg)
+          first_pair = hash_arg.pairs.first
+          first_pair&.key&.value&.to_s || 'unknown' # rubocop:disable Style/SafeNavigationChainLength
+        end
+
+        def categorize_route_method(method_name)
+          ROUTE_CATEGORIES.each do |category, methods|
+            return category if methods.include?(method_name)
+          end
+          :other
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'collection_context'
+
+module RuboCop
+  module Cop
+    module Rails
+      class RouteCollector
+        attr_reader :routes
+
+        def initialize
+          @routes = []
+        end
+
+        def collect(node, namespace_level = 0, namespace_path = [])
+          context = CollectionContext.new(self, namespace_level, namespace_path)
+          context.process_node(node)
+        end
+
+        def add_route(route_info)
+          @routes << route_info
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/nueca/plugin.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Nueca
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-nueca',
+          version: VERSION,
+          homepage: 'https://github.com/tieeeeen1994/rubocop-nueca',
+          description: 'Custom RuboCop rules for Nueca according to culture.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/nueca/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Nueca
+    VERSION = '1.0.0'
+  end
+end

data/lib/rubocop-nueca.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'rubocop/nueca/version'
+require 'rubocop'
+
+# Load the plugin
+require_relative 'rubocop/nueca/plugin'
+
+# Load all custom Rails cops
+Dir[File.join(__dir__, 'rubocop', 'cop', 'rails', '*.rb')].each do |file|
+  require file
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-nueca
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tien
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.72'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.27'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.33'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.33'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.31'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.31'
+email:
+- tieeeeen1994@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- config/default.yml
+- lib/rubocop-nueca.rb
+- lib/rubocop/cop/rails/date_time_conversion.rb
+- lib/rubocop/cop/rails/date_time_current.rb
+- lib/rubocop/cop/rails/migration_table_variable.rb
+- lib/rubocop/cop/rails/model_association_consistent_spacing.rb
+- lib/rubocop/cop/rails/model_association_grouping.rb
+- lib/rubocop/cop/rails/model_association_scattering.rb
+- lib/rubocop/cop/rails/model_association_separation.rb
+- lib/rubocop/cop/rails/model_association_sorting.rb
+- lib/rubocop/cop/rails/postgres_timestamp.rb
+- lib/rubocop/cop/rails/route_consistent_spacing.rb
+- lib/rubocop/cop/rails/route_grouping.rb
+- lib/rubocop/cop/rails/route_root_position.rb
+- lib/rubocop/cop/rails/route_separation.rb
+- lib/rubocop/cop/rails/route_sorting.rb
+- lib/rubocop/cop/rails/time_zone_today.rb
+- lib/rubocop/cop/shared/collection_context.rb
+- lib/rubocop/cop/shared/route_collector.rb
+- lib/rubocop/nueca/plugin.rb
+- lib/rubocop/nueca/version.rb
+homepage: https://github.com/tieeeeen1994/rubocop-nueca
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/tieeeeen1994/rubocop-nueca
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Nueca::Plugin
+  rubocop_extension: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: This enforces custom rules for Nueca according to culture.
+test_files: []