activerecord-originator 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7824731d65843f11d6514b7d600dfc5732ad8adf8bd91b7330f8ff95d2347070
-  data.tar.gz: d352ceb565b52b2d2108d8a48b7d5c44e7553ff651cf507eadbe36603844a055
+  metadata.gz: 1b3d3acaaba956be55494c54004735ba2fb569fa02dfc8f2f66cc2066cb64355
+  data.tar.gz: a92f7d7f51fe48150f3602e5ddef970a6ee2b7db3aa806b9bfb0d67a9616e84f
 SHA512:
-  metadata.gz: 1c09b7fa08b19e0ec51057508e0a0da9e2ce0708757749aa7715625ed8fcc072921f350515b30a5a0e4c928c94825eac8d3a078c8477fcc5c561f7ad15de7f68
-  data.tar.gz: f5adfacbbba8ff05d832805c7ff22193f71de89feeccb8d5d519c3566711725623fb2a2fe84161136d5f148a4a3e70721b2051e7bde2ebfc4ea868f5b3be7e80
+  metadata.gz: 621707bfd9fc495c9d48cfc06002039f087edd6cf551999d0cae6b5d567af31ec517ebe9d9119cfc90d659a1012a055dc4f6ba03d21bf502065a3ad6d8ddcd3a
+  data.tar.gz: 2f606407113491b99c46f34d55a4eb0b97c4f42239518ac10add4c0f3dca201ec79479ae2e7bb482177b4d8fd54c8a7bc490f52d54aaaea4916a2f7770e932cc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.3.0 - 2025-04-25
+
+* Support `ActiveRecord::Originator.format` option. [#26](https://github.com/pocke/activerecord-originator/pull/26)
+
 ## v0.2.2 - 2024-08-14
 
 * Support Rails 7.2 [#22](https://github.com/pocke/activerecord-originator/pull/22)

data/README.md

@@ -26,6 +26,21 @@ $ 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.
 
+### Configure format
+
+You can set `ActiveRecord::Originator.format` to `:one_liner` if you prefer your SQL log in one line.
+
+```ruby
+# in your configuration file
+ActiveRecord::Originator.format = :one_liner
+```
+
+Then you can get logs like below.
+
+```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' */
+```
+
 ## 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.

data/gemfiles/activerecord_6_1.gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 
 gem 'activerecord', '~> 6.1.0'
+gem 'benchmark', require: false
+gem 'logger', require: false
 gem "sqlite3", "~> 1.4"
 
 gemspec path: '../'

data/gemfiles/activerecord_7_0.gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 
 gem 'activerecord', '~> 7.0.0'
+gem 'benchmark', require: false
+gem 'logger', require: false
 gem "sqlite3", "~> 1.4"
 
 gemspec path: '../'

data/gemfiles/activerecord_7_1.gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 
 gem 'activerecord', '~> 7.1.0'
+gem 'benchmark', require: false
+gem 'logger', require: false
 gem "sqlite3", "~> 1.4"
 
 gemspec path: '../'

data/gemfiles/activerecord_7_2.gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'activerecord', '~> 7.2.0'
+gem 'benchmark', require: false
+gem 'logger', require: false
 
 gemspec path: '../'

data/lib/activerecord/originator/arel_visitor_extension.rb

@@ -44,7 +44,7 @@ module ActiveRecord
         frame = traces.first
         return unless frame
 
-        " /* #{escape_comment(frame)} */\n"
+        Originator.current_formatter.format(escape_comment(frame))
       end
 
       def escape_comment(comment)

data/lib/activerecord/originator/formatter/default.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Originator
+    module Formatter
+      module Default
+        def self.format(comment)
+          " /* #{comment} */\n"
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/originator/formatter/one_liner.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Originator
+    module Formatter
+      module OneLiner
+        def self.format(comment)
+          " /* <- #{comment} */"
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/originator/formatter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "formatter/default"
+require_relative "formatter/one_liner"
+
+module ActiveRecord
+  module Originator
+    module Formatter
+      attr_reader :format, :current_formatter
+
+      def format=(format)
+        @format = format
+        resolve_formatter
+      end
+
+      def resolve_formatter
+        case format
+        when :one_liner
+          @current_formatter = OneLiner
+        else
+          @current_formatter = Default
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/originator/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Originator
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/lib/activerecord/originator.rb

@@ -9,6 +9,7 @@ require_relative "originator/version"
 require_relative "originator/arel_node_extension"
 require_relative "originator/arel_visitor_extension"
 require_relative "originator/collector_proxy"
+require_relative "originator/formatter"
 
 ActiveRecord::Originator::ArelVisitorExtension::TARGET_NODE_CLASSESS.each do |name|
   begin
@@ -23,8 +24,12 @@ Arel::Visitors::ToSql.prepend ActiveRecord::Originator::ArelVisitorExtension
 
 module ActiveRecord
   module Originator
+    extend Formatter
+
     mattr_accessor :backtrace_cleaner
   end
 end
 
+ActiveRecord::Originator.format = :default
+
 require_relative "originator/railtie" if defined?(Rails)

data/rbs_collection.lock.yaml

@@ -2,19 +2,19 @@
 path: ".gem_rbs_collection"
 gems:
 - name: activemodel
-  version: '7.0'
+  version: '7.1'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: be76a75932e8ed6ee91a95ba936cf88b674bf044
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: activerecord
-  version: '7.0'
+  version: '8.0'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: be76a75932e8ed6ee91a95ba936cf88b674bf044
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: activesupport
@@ -22,23 +22,35 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: be76a75932e8ed6ee91a95ba936cf88b674bf044
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: base64
+  version: '0.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: benchmark
   version: '0'
   source:
     type: stdlib
 - name: bigdecimal
-  version: '0'
+  version: '3.1'
   source:
-    type: stdlib
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: concurrent-ruby
   version: '1.1'
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: be76a75932e8ed6ee91a95ba936cf88b674bf044
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: connection_pool
@@ -46,13 +58,21 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: be76a75932e8ed6ee91a95ba936cf88b674bf044
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: date
   version: '0'
   source:
     type: stdlib
+- name: delegate
+  version: '0'
+  source:
+    type: stdlib
+- name: digest
+  version: '0'
+  source:
+    type: stdlib
 - name: erb
   version: '0'
   source:
@@ -62,7 +82,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: be76a75932e8ed6ee91a95ba936cf88b674bf044
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: logger
@@ -70,14 +90,22 @@ gems:
   source:
     type: stdlib
 - name: minitest
-  version: '0'
+  version: '5.25'
   source:
-    type: stdlib
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: monitor
   version: '0'
   source:
     type: stdlib
 - name: mutex_m
+  version: 0.3.0
+  source:
+    type: rubygems
+- name: openssl
   version: '0'
   source:
     type: stdlib
@@ -89,6 +117,18 @@ gems:
   version: '0'
   source:
     type: stdlib
+- name: socket
+  version: '0'
+  source:
+    type: stdlib
+- name: sqlite3
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: time
   version: '0'
   source:
@@ -97,4 +137,16 @@ gems:
   version: '0'
   source:
     type: stdlib
+- name: tzinfo
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: eb6867fdb70e82e3aac6b51623ed1b6760c3c072
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
 gemfile_lock_path: Gemfile.lock

data/sig/activerecord/originator/collector_proxy.rbs

@@ -15,6 +15,10 @@ module ActiveRecord
       def add_binds: (*untyped, **untyped) -> self
 
       def value: () -> untyped
+
+      def retryable: () -> untyped
+
+      def retryable=: [T] (T) -> T
     end
   end
 end

data/sig/activerecord/originator/formatter/default.rbs

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Originator
+    module Formatter
+      module Default
+        extend _Formatter
+      end
+    end
+  end
+end

data/sig/activerecord/originator/formatter/one_liner.rbs

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Originator
+    module Formatter
+      module OneLiner
+        extend _Formatter
+      end
+    end
+  end
+end

data/sig/activerecord/originator/formatter.rbs

@@ -0,0 +1,12 @@
+module ActiveRecord
+  module Originator
+    module Formatter
+      attr_reader format: Symbol
+      def format=: (Symbol) -> void
+                 
+      attr_reader current_formatter: _Formatter
+
+      def resolve_formatter: () -> _Formatter
+    end
+  end
+end

data/sig/activerecord/originator.rbs

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

data/sig/interfaces.rbs

@@ -9,4 +9,8 @@ module ActiveRecord::Originator
     def add_binds: (untyped, ?untyped) -> self
     def value: () -> untyped
   end
+
+  interface _Formatter
+    def format: (String) -> String
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-originator
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
 bindir: exe
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -144,6 +144,9 @@ files:
 - lib/activerecord/originator/arel_node_extension.rb
 - lib/activerecord/originator/arel_visitor_extension.rb
 - lib/activerecord/originator/collector_proxy.rb
+- lib/activerecord/originator/formatter.rb
+- lib/activerecord/originator/formatter/default.rb
+- lib/activerecord/originator/formatter/one_liner.rb
 - lib/activerecord/originator/railtie.rb
 - lib/activerecord/originator/version.rb
 - rbs_collection.lock.yaml
@@ -153,6 +156,9 @@ files:
 - sig/activerecord/originator/arel_node_extension.rbs
 - sig/activerecord/originator/arel_visitor_extension.rbs
 - sig/activerecord/originator/collector_proxy.rbs
+- sig/activerecord/originator/formatter.rbs
+- sig/activerecord/originator/formatter/default.rbs
+- sig/activerecord/originator/formatter/one_liner.rbs
 - sig/activerecord/originator/version.rbs
 - sig/interfaces.rbs
 homepage: https://github.com/pocke/activerecord-originator
@@ -177,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Add SQL comments to indicate the origin of the SQL.
 test_files: []