scope_hunter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84a24a8a4877ff65cf80bcdd785c069b81c63c29d3adced78ce085c6dc36c753
+  data.tar.gz: 8902d7b857368b9749e434c8814dc2b6332ed7f551d2ea1f7a81dc8172f34ca6
+SHA512:
+  metadata.gz: '088617f2e3b767fe88c51ea1aec98d669fed403a4971226270ead1aa055d9b8689e24a264de8bcb81005e3fec8993169bf58a3d8d01cec9e5d4866c504c011cb'
+  data.tar.gz: 1abfc00f4afe0bac98a6df26bbd568aac7aab4a38120d2389a915714b6a9e449faa60eb04fe4c10ce687b99d53f13cd62c53be50e8595824f29ed05bd1976b4a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# ScopeHunter
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/scope_hunter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scope_hunter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/scope_hunter/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ScopeHunter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/scope_hunter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/config/default.yml

@@ -0,0 +1,4 @@
+ScopeHunter/UseExistingScope:
+  Enabled: true
+  Autocorrect: conservative
+  SuggestPartialMatches: true

data/lib/rubocop/cop/scope_hunter/use_existing_scope.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "scope_hunter/ast_utils"
+require "scope_hunter/canonicalizer"
+require "scope_hunter/scope_index"
+
+module RuboCop
+  module Cop
+    module ScopeHunter
+      class UseExistingScope < Base
+        extend AutoCorrector
+
+        MSG = 'Query matches `%<model>s.%<scope>s`. Use the scope instead.'
+
+        def on_new_investigation
+          @index = ::ScopeHunter::ScopeIndex.new
+          index_scopes(processed_source.ast)
+        end
+
+        def on_send(node)
+          chain = ::ScopeHunter::ASTUtils.relation_chain(node)
+          return unless chain
+
+          sig = ::ScopeHunter::Canonicalizer.signature(chain)
+          match = @index.find(sig)
+          return unless match
+
+          add_offense(node, message: format(MSG, model: match.model, scope: match.name)) do |corrector|
+            replacement = replacement_for(node, match)
+            corrector.replace(node.loc.expression, replacement) if replacement
+          end
+        end
+
+        private
+
+        def index_scopes(ast)
+          return unless ast
+          # Find `scope :name, -> { ... }`
+          ast.each_node(:send) do |send|
+            next unless send.method_name == :scope
+            name_node = send.arguments[0]
+            next unless name_node&.sym_type?
+
+            model = enclosing_class_name(send)
+            next unless model
+
+            # The body is the lambda argument (second argument)
+            lambda_body = send.arguments[1]
+            next unless lambda_body&.block_type?
+
+            chain = ::ScopeHunter::ASTUtils.relation_chain(lambda_body.body, require_model: false)
+            next unless chain
+
+            sig = ::ScopeHunter::Canonicalizer.signature(chain, model: model)
+            @index.add(model:, name: name_node.value, signature: sig)
+          end
+        end
+
+        def enclosing_class_name(node)
+          klass = node.each_ancestor(:class).first
+          return nil unless klass&.identifier&.const_type?
+          klass.identifier.const_name
+        end
+
+        # Conservative autocorrect: replace the first AR part with Model.scope, keep trailing chain
+        def replacement_for(node, match)
+          trailing = trailing_after_first_ar(node)
+          ([ "#{match.model}.#{match.name}" ] + trailing).join
+        rescue
+          nil
+        end
+
+        def trailing_after_first_ar(node)
+          out = []
+          cur = node
+          # Gather segments like `.order(...).limit(5)` in reverse
+          while cur&.send_type?
+            seg = "." + cur.method_name.to_s
+            seg << "(#{cur.arguments.map(&:source).join(", ")})" unless cur.arguments.empty?
+            out.unshift(seg)
+            cur = cur.receiver
+          end
+          out.drop(1) # drop the first AR call; replaced by scope
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/scope_hunter/inject.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "cop/scope_hunter/use_existing_scope"
+
+module RuboCop
+  module ScopeHunter
+    def self.inject!
+      path = File.expand_path("../../config/default.yml", __FILE__)
+      hash = ::RuboCop::ConfigLoader.send(:load_yaml_configuration, path)
+      config = ::RuboCop::Config.new(hash, path)
+      ::RuboCop::ConfigLoader.default_configuration = ::RuboCop::ConfigLoader
+        .merge_with_default(config, ::RuboCop::ConfigLoader.default_configuration)
+    end
+  end
+end
+
+RuboCop::ScopeHunter.inject!

data/lib/scope_hunter/ast_utils.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "rubocop/ast"
+
+module ScopeHunter
+  module ASTUtils
+    extend self
+
+    AR_METHODS = %i[where rewhere joins order limit offset select distinct group having references includes preload].freeze
+
+    # Returns array of steps: [{recv: "User", msg: :where, args: [{status: :active}]}, ...]
+    def relation_chain(node, require_model: true)
+      return nil unless node&.send_type?
+
+      chain = []
+      cur = node
+      seen_ar = false
+
+      while cur&.send_type?
+        msg  = cur.method_name
+        recv = cur.receiver
+        args = cur.arguments
+
+        if AR_METHODS.include?(msg) || model_const?(recv)
+          chain.unshift({
+            recv: recv&.const_type? ? const_name(recv) : nil,
+            msg:  msg,
+            args: unwrap_args(args)
+          })
+          seen_ar ||= AR_METHODS.include?(msg)
+          cur = recv
+        else
+          break
+        end
+      end
+
+      return nil unless seen_ar
+      return nil if require_model && chain.first[:recv].nil? # must start from Model constant
+      chain
+    end
+
+    def model_const?(node)
+      node&.const_type?
+    end
+
+    def const_name(node)
+      node.const_name
+    rescue
+      nil
+    end
+
+    def unwrap_args(args)
+      args.map { |a| a.hash_type? ? hash_to_ruby(a) : literal(a) }
+    end
+
+    def hash_to_ruby(node)
+      node.pairs.to_h { |p| [literal(p.key), literal(p.value)] }
+    end
+
+    def literal(node)
+      case
+      when node.nil? then nil
+      when node.sym_type? then node.value
+      when node.str_type? then node.value
+      when node.int_type? then node.value
+      when node.float_type? then node.value
+      when node.true_type? then true
+      when node.false_type? then false
+      when node.const_type? then node.const_name.to_sym
+      else :__dynamic__
+      end
+    end
+  end
+end

data/lib/scope_hunter/canonicalizer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ScopeHunter
+    module Canonicalizer
+      extend self
+  
+      # chain: array of {recv:, msg:, args:}
+      # output: stable signature string
+      def signature(chain, model: nil)
+        state = { model: model, where: {}, joins: [], order: [] }
+  
+        chain.each do |step|
+          state[:model] ||= step[:recv] if step[:recv].is_a?(String)
+  
+          case step[:msg]
+          when :where, :rewhere
+            h = normalize_hash(step[:args].first)
+            state[:where].merge!(h)
+          when :joins
+            state[:joins] |= normalize_list(step[:args])
+            state[:joins].sort!
+          when :order
+            state[:order] += normalize_order(step[:args])
+          end
+        end
+  
+        w = state[:where].sort_by(&:first).map { |k,_| "#{k}:?" }.join(",")
+        j = state[:joins].join(",")
+        o = state[:order].map { |(c,d)| "(#{c},#{d || 'asc'})" }.join(",")
+  
+        "M=#{state[:model]}|W={#{w}}|J=[#{j}]|O=[#{o}]"
+      end
+  
+      def normalize_hash(obj)
+        h = (obj || {}).to_h
+        h.transform_keys { |k| k.to_s } .transform_values { |_| :"?" }
+      end
+  
+      def normalize_list(args)
+        Array(args).flatten.compact.map(&:to_s)
+      end
+  
+      def normalize_order(args)
+        first = args.first
+        case first
+        when Hash
+          first.map { |k, v| [k.to_s, v&.to_s] }
+        when Symbol, String
+          [[first.to_s, "asc"]]
+        else
+          []
+        end
+      end
+    end
+  end
+  

data/lib/scope_hunter/scope_index.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ScopeHunter
+    Scope = Struct.new(:model, :name, :signature, keyword_init: true)
+  
+    class ScopeIndex
+      def initialize
+        @by_signature = {}
+      end
+  
+      def add(model:, name:, signature:)
+        (@by_signature[signature] ||= []) << Scope.new(model:, name:, signature:)
+      end
+  
+      def find(signature)
+        Array(@by_signature[signature]).first
+      end
+    end
+  end
+  

data/lib/scope_hunter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ScopeHunter
+  VERSION = "0.1.0"
+end

data/lib/scope_hunter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "scope_hunter/version" if File.exist?(File.join(__dir__, "scope_hunter/version.rb"))
+
+require "scope_hunter/ast_utils"
+require "scope_hunter/canonicalizer"
+require "scope_hunter/scope_index"
+
+# When rubocop loads, inject our default config
+begin
+  require "rubocop"
+  require "rubocop/scope_hunter/inject"
+rescue LoadError
+  # rubocop not present (e.g., runtime only) — that's fine
+end

data/sig/scope_hunter.rbs

@@ -0,0 +1,4 @@
+module ScopeHunter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: scope_hunter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ajith kumar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.40'
+description: Scope Hunter is a RuboCop extension that detects ActiveRecord query chains
+  that duplicate existing named scopes and suggests using those scopes instead. It
+  indexes model scopes, canonicalizes relation chains, and flags matches with an autocorrect
+  that replaces the initial query with Model.scope while preserving any trailing methods.
+  This keeps query logic DRY, improves readability, and helps teams discover and reuse
+  well-named scopes.
+email:
+- ajithbuddy.kumar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/config/default.yml
+- lib/rubocop/cop/scope_hunter/use_existing_scope.rb
+- lib/rubocop/scope_hunter/inject.rb
+- lib/scope_hunter.rb
+- lib/scope_hunter/ast_utils.rb
+- lib/scope_hunter/canonicalizer.rb
+- lib/scope_hunter/scope_index.rb
+- lib/scope_hunter/version.rb
+- sig/scope_hunter.rbs
+homepage: https://github.com/ajithbuddy/scope_hunter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ajithbuddy/scope_hunter
+  source_code_uri: https://github.com/ajithbuddy/scope_hunter
+  changelog_uri: https://github.com/ajithbuddy/scope_hunter/blob/main/CHANGELOG.md
+post_install_message: 
+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.5.3
+signing_key: 
+specification_version: 4
+summary: RuboCop extension that suggests replacing ActiveRecord query chains with
+  existing named scopes (with autocorrect).
+test_files: []