why_query 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02cb599669704dcfaae94307fc9ad94d8e5a89f953523c642d342132c124fcc2
+  data.tar.gz: b37df34ce1fafc9b75d91004cdea4f4c6b0ec165b70ffa37ecdd9fdbae235d54
+SHA512:
+  metadata.gz: eaca64f9fc625d3949813da60dd25d103f60e98a63e42dc6928eee4e1b1f6840ce2fc0c450e2e1c003fc6102bf72a2696cb0c420ceb6fce82c74e9469c36306e
+  data.tar.gz: 07da22bc6e4e612f94415f4e650f71715d73cfacc8835c2de7ea80506c7097399966bb1dbf5cfa2a056edc4f237e9a18457b743de0fc4abc8dc36c723cb29e5f

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-16
+
+- Initial release of `why_query`
+- Logs file + line number for every SQL query via ActiveRecord
+- Configurable output via `WhyQuery.configure`
+- Support for `Rails.root` filtering (`app_only: true`)
+- Fully tested with Minitest

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 lahiru.lahirumadusanka@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in why_query.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2025 Lahiru Himesh
+
+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,102 @@
+# 🔍 why_query
+
+**Find out exactly where your SQL queries come from.**  
+No more grepping logs or blaming ActiveRecord. `why_query` prints the file and line of code that triggered every query in development.
+
+```ruby
+User.where(active: true).first
+# => ↳ Called from: app/controllers/users_controller.rb:12
+```
+
+---
+
+## ✨ Features
+
+- 📍 Logs **where each SQL query was called from**
+- 🧠 Filters to **your app code only** (no gems, no noise)
+- 🛠 Simple configuration (log anywhere, toggle anytime)
+- 🧪 Great for debugging N+1s and finding rogue queries
+
+---
+
+## 🚀 Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem "why_query", group: :development
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+---
+
+## ⚙️ Configuration
+
+Create an initializer in your Rails app:
+
+```ruby
+# config/initializers/why_query.rb
+
+WhyQuery.configure do |config|
+  config.enabled = Rails.env.development?       # Toggle globally
+  config.app_only = true                        # Only log queries from your app files
+  config.logger = ->(msg) { Rails.logger.debug("[WHY_QUERY] #{msg}") } # Custom logger
+end
+```
+
+You can also toggle at runtime:
+
+```ruby
+WhyQuery.config.enabled = false
+```
+
+---
+
+## 💡 Output Examples
+
+In logs or console:
+
+```sql
+SELECT "users".* FROM "users" WHERE "users"."active" = TRUE
+↳ Called from: app/services/users/fetcher.rb:7
+```
+
+---
+
+## ❓ Why Use This?
+
+- “Where did this query come from?”
+- “Who’s loading all users in a loop?”
+- “Why is my controller generating 20 queries?”
+
+Now you’ll know. Instantly.
+
+---
+
+## 🧠 Tips
+
+Want to log stack traces? Set `app_only = false`:
+
+```ruby
+WhyQuery.configure do |config|
+  config.app_only = false
+end
+```
+
+You’ll get:
+
+```
+↳ Called from: app/models/post.rb:18
+↳ Called from: app/controllers/posts_controller.rb:42
+```
+
+---
+
+## 🙏 Acknowledgements
+
+Inspired by hours of wondering “Where the heck is this query coming from?”

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/why_query/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhyQuery
+    class Config
+      attr_accessor :enabled, :app_only, :logger
+  
+      def initialize
+        @enabled = true
+        @app_only = true
+        @logger = ->(msg) { puts msg }
+      end
+    end
+  end
+  

data/lib/why_query/railtile.rb

@@ -0,0 +1,10 @@
+module WhyQuery
+    class Railtie < ::Rails::Railtie
+      initializer "why_query.initialize" do
+        ActiveSupport.on_load(:active_record) do
+          require "why_query"
+        end
+      end
+    end
+  end
+  

data/lib/why_query/version.rb

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

data/lib/why_query.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "why_query/version"
+require_relative "why_query/config"
+require "active_support/notifications"
+require "active_record"
+require "rails" if defined?(Rails)
+require "why_query/railtie" if defined?(Rails)
+
+module WhyQuery
+  class << self
+    attr_accessor :config
+
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def enabled?
+      config.enabled
+    end
+
+    def log_origin
+      stack = caller_locations(3, 10)
+
+      location = stack.find do |loc|
+        path = loc.path
+        path.start_with?(Rails.root.to_s) && !path.include?("/gems/")
+      end if config.app_only
+
+      location ||= stack[0] # fallback to any top stack
+
+      if location
+        config.logger.call("↳ Called from: #{location.path.sub(Rails.root.to_s + "/", "")}:#{location.lineno}")
+      end
+    end
+  end
+end
+
+ActiveSupport::Notifications.subscribe("sql.active_record") do |_, _, _, _, payload|
+  next unless WhyQuery.enabled?
+  
+  SKIPPED_NAMES = ["SCHEMA", "TRANSACTION"]
+
+  next if SKIPPED_NAMES.include?(payload[:name])
+
+  WhyQuery.log_origin
+end

data/sig/why_query.rbs

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

data/why_query.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/why_query/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "why_query"
+  spec.version       = WhyQuery::VERSION
+  spec.authors       = ["Lahiru Himesh Madusanka"]
+  spec.email         = ["lahiru.lahirumadusanka@gmail.com"]
+  
+  spec.summary       = "Log the origin of every ActiveRecord query."
+  spec.description   = "WhyQuery helps you trace where each SQL query in your Rails app comes from by logging the Ruby file and line that triggered it. Great for debugging N+1s and rogue queries in development."
+  
+  spec.homepage      = "https://github.com/sdglhm/why_query"
+  spec.required_ruby_version = ">= 2.6.0"
+  
+  spec.files         = Dir["lib/**/*.rb", "README.md", "LICENSE.txt"]
+  spec.require_paths = ["lib"]
+  
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = "https://github.com/sdglhm/why_query"
+  spec.metadata["changelog_uri"]     = "https://github.com/sdglhm/why_query/blob/main/CHANGELOG.md"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: why_query
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lahiru Himesh Madusanka
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-16 00:00:00.000000000 Z
+dependencies: []
+description: WhyQuery helps you trace where each SQL query in your Rails app comes
+  from by logging the Ruby file and line that triggered it. Great for debugging N+1s
+  and rogue queries in development.
+email:
+- lahiru.lahirumadusanka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/why_query.rb
+- lib/why_query/config.rb
+- lib/why_query/railtile.rb
+- lib/why_query/version.rb
+- sig/why_query.rbs
+- why_query.gemspec
+homepage: https://github.com/sdglhm/why_query
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sdglhm/why_query
+  source_code_uri: https://github.com/sdglhm/why_query
+  changelog_uri: https://github.com/sdglhm/why_query/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Log the origin of every ActiveRecord query.
+test_files: []