activerecord-originator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa3749b460f4bf88f4ae707b69db1e2c32f41d7bfac6780ebafbc4e96375a730
+  data.tar.gz: b130e6f429f7cd6acc167715a08797f9816f16d06fa990fc1ddda22c4d17700b
+SHA512:
+  metadata.gz: 30ce59ca0d48a39793d27a959db9a93dff186006ac83bb4fe220469cde766ac7627c9fe1e0b9f429ecb16e339481f95dbbc39ad7d656d82b1875ef88281f4216
+  data.tar.gz: c502f0bf40254b8d92484e4a9fa5e5bdc20eb28a096e4a265fb94616dcca7f3ce4dc6f37e9c2e9a740666f4aeac31e68886fcd50ceb16797c43abd46506480fd

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Masataka Pocke Kuwabara
+
+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,37 @@
+# ActiveRecord::Originator
+
+Add SQL comments to indicate the origin of the SQL.
+
+This gem adds SQL comments indicating the origin of the part of the query. This is useful for debugging large queries.
+
+Rails tells us where the SQL is executed, but it doesn't tell us where the SQL is constructed.
+This gem lets you know where the SQL is constructed! For example:
+
+```sql
+Article Load (0.1ms)  SELECT "articles".* FROM "articles" WHERE "articles"."status" = ? /* app/models/article.rb:3:in `published' */
+ AND "articles"."category_id" = ? /* app/controllers/articles_controller.rb:3:in `index' */
+ ORDER BY "articles"."created_at" DESC /* app/models/article.rb:4:in `order_by_latest' */
+```
+
+You can see where `.where` and `.order` methods are called without reading the source code. It is helpful if the query builder is complex.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```console
+$ bundle add activerecord-originator
+```
+
+You do not need to do anything else. The gem will automatically add comments to the SQL.
+Check the logs to see the comments.
+
+## 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/pocke/activerecord-originator.

data/Rakefile

@@ -0,0 +1,16 @@
+# 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 :steep do
+  sh 'steep', 'check'
+end
+
+task default: %i[rubocop steep spec]

data/Steepfile

@@ -0,0 +1,7 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  check "lib"
+  configure_code_diagnostics(D::Ruby.strict)
+end

data/lib/activerecord/originator/arel_node_extension.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Originator
+    module ArelNodeExtension
+      def initialize(...)
+        __skip__ = super
+        @ar_originator_backtrace = caller
+      end
+
+      attr_reader :ar_originator_backtrace
+    end
+  end
+end

data/lib/activerecord/originator/arel_visitor_extension.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Originator
+    module ArelVisitorExtension
+      def accept(object, collector)
+        super(object, CollectorProxy.new(collector))
+      end
+
+      private
+
+      %i[
+        Ascending
+        Descending
+        Equality
+        NotEqual
+        InnerJoin
+        HomogeneousIn
+        GreaterThanOrEqual
+        GreaterThan
+        LessThan
+        LessThanOrEqual
+        GreaterThanOrEqual
+      ].each do |klass_name|
+        define_method(:"visit_Arel_Nodes_#{klass_name}") do |o, collector|
+          __skip__ = begin
+            comment = originator_comment(o)
+            res = super(o, collector)
+            if comment && !collector.last_str.end_with?(comment)
+              res << comment if comment && !collector.last_str.end_with?(comment)
+            end
+            res
+          end
+        end
+      end
+
+      def originator_comment(o)
+        traces = o.ar_originator_backtrace
+        if c = Originator.backtrace_cleaner
+          traces = c.clean(traces)
+        end
+        frame = traces.first
+        return unless frame
+
+        " /* #{escape_comment(frame)} */\n"
+      end
+
+      def escape_comment(comment)
+        while comment.include?('/*') || comment.include?('*/')
+          comment = comment.gsub('/*', '').gsub('*/', '')
+        end
+        comment
+      end
+    end
+  end
+end

data/lib/activerecord/originator/collector_proxy.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Originator
+    # This class is a proxy to deduplicate the originator comment.
+    class CollectorProxy
+      attr_accessor :preparable
+
+      def initialize(collector)
+        @collector = collector
+        @last_str = nil
+      end
+
+      attr_reader :last_str
+
+      def <<(str)
+        @collector << str
+        @last_str = str
+        self
+      end
+
+      def add_bind(...)
+        @collector.add_bind(...)
+        self
+      end
+
+      def add_binds(...)
+        @collector.add_binds(...)
+        self
+      end
+
+      def value
+        @collector.value
+      end
+    end
+  end
+end

data/lib/activerecord/originator/railtie.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Originator.backtrace_cleaner = Rails.backtrace_cleaner
+end

data/lib/activerecord/originator/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Originator
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/originator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/class/subclasses'
+
+require_relative "originator/version"
+
+require_relative "originator/arel_node_extension"
+require_relative "originator/arel_visitor_extension"
+require_relative "originator/collector_proxy"
+
+Arel::Nodes::Node.descendants.each do |klass|
+  klass.prepend ActiveRecord::Originator::ArelNodeExtension
+end
+Arel::Visitors::ToSql.prepend ActiveRecord::Originator::ArelVisitorExtension
+
+module ActiveRecord
+  module Originator
+    mattr_accessor :backtrace_cleaner
+  end
+end
+
+require_relative "originator/railtie" if defined?(Rails)

data/rbs_collection.lock.yaml

@@ -0,0 +1,100 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: activemodel
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 372c833bb52be1bc34aef5e2793ab47c35c0dba9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 372c833bb52be1bc34aef5e2793ab47c35c0dba9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 372c833bb52be1bc34aef5e2793ab47c35c0dba9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: '0'
+  source:
+    type: stdlib
+- name: bigdecimal
+  version: '0'
+  source:
+    type: stdlib
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 372c833bb52be1bc34aef5e2793ab47c35c0dba9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 372c833bb52be1bc34aef5e2793ab47c35c0dba9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 372c833bb52be1bc34aef5e2793ab47c35c0dba9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,13 @@
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+path: .gem_rbs_collection
+
+gems:
+  - name: activerecord-originator
+    ignore: true
+  - name: activerecord

data/sig/activerecord/originator/arel_node_extension.rbs

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Originator
+    module ArelNodeExtension : Arel::Nodes::Node
+      @ar_originator_backtrace: Array[String]
+
+      def initialize: () -> void
+    end
+  end
+end

data/sig/activerecord/originator/arel_visitor_extension.rbs

@@ -0,0 +1,13 @@
+module ActiveRecord
+  module Originator
+    module ArelVisitorExtension : _ArelVisitor
+      def accept: (untyped object, _Collector collector) -> untyped
+
+      private
+
+      def originator_comment: (untyped o) -> String?
+
+      def escape_comment: (String comment) -> String
+    end
+  end
+end

data/sig/activerecord/originator/collector_proxy.rbs

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module Originator
+    # This class is a proxy to deduplicate the originator comment.
+    class CollectorProxy
+      @collector: untyped
+
+      @last_str: String | nil
+
+      def initialize: (untyped collector) -> void
+
+      def <<: (String str) -> self
+
+      def add_bind: (*untyped, **untyped) -> self
+
+      def add_binds: (*untyped, **untyped) -> self
+
+      def value: () -> untyped
+    end
+  end
+end

data/sig/activerecord/originator/version.rbs

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Originator
+    VERSION: String
+  end
+end

data/sig/activerecord/originator.rbs

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Originator
+    attr_accessor self.backtrace_cleaner: ActiveSupport::BacktraceCleaner?
+  end
+end

data/sig/polyfill.rbs

@@ -0,0 +1,16 @@
+module Rails
+  def self.backtrace_cleaner: () -> untyped
+end
+
+module ActiveRecord::Originator
+  interface _ArelVisitor
+    def accept: (untyped, untyped) -> untyped
+  end
+
+  interface _Collector
+    def <<: (String) -> self
+    def add_bind: (untyped obj) -> self
+    def add_binds: (untyped, ?untyped) -> self
+    def value: () -> untyped
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-originator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: This gem adds comments to the SQL to indicate where the SQL parts are
+  constructed.
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- Steepfile
+- lib/activerecord/originator.rb
+- lib/activerecord/originator/arel_node_extension.rb
+- lib/activerecord/originator/arel_visitor_extension.rb
+- lib/activerecord/originator/collector_proxy.rb
+- lib/activerecord/originator/railtie.rb
+- lib/activerecord/originator/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/activerecord/originator.rbs
+- sig/activerecord/originator/arel_node_extension.rbs
+- sig/activerecord/originator/arel_visitor_extension.rbs
+- sig/activerecord/originator/collector_proxy.rbs
+- sig/activerecord/originator/version.rbs
+- sig/polyfill.rbs
+homepage: https://github.com/pocke/activerecord-originator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pocke/activerecord-originator
+  source_code_uri: https://github.com/pocke/activerecord-originator
+  changelog_uri: https://github.com/pocke/activerecord-originator/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+signing_key:
+specification_version: 4
+summary: Add SQL comments to indicate the origin of the SQL.
+test_files: []