click_house-client 0.8.2 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27b81975f1f934997c497bd13dd33b01e9808f96640bea06bd79dbedb1fdaafd
-  data.tar.gz: 92534981627408a2654ea29bca98746e99c205064c3a8ecd863bc54a84662f9a
+  metadata.gz: 0e2ca8f0530ff3f9a48853609325b69481909e1bf4b6d208cee425430cc3b3e0
+  data.tar.gz: 98c2180b46b3345de18d3525c070fc59f7acd88897a6f8e593a8b7b97e69d2d0
 SHA512:
-  metadata.gz: 730256f383d8a48927fe2a9a13541dacf6c63300a899c68e647d5457757b32db840e43eab17f2b19b02bed86582e5dbec8bbaa32d24215c5efa9f0c528b32169
-  data.tar.gz: '09e366a8fbb135fe7bb6eee89f7cdb98c3e91a70b350045cfebaeb2ec4db1bc459343e38d5eb902cc30ee1cba7b9ed2ddb10cb17e9726f791abe7dc1800e132b'
+  metadata.gz: 23f2d4022f33b6795030e73a68f0549d06d1925221f08d49f0a314e87096de83fdd641d12597960f71e08656d81bf2af5b46483f8e113464d6e8bcd83fe2a7a4
+  data.tar.gz: 5492a6fb7bbb700722fbf4684570ba4d4d220be2c5316a98461e9e6b857cb549b5bfa7fb1173dc38beae27b9df9f945eca1ed1568a061774f3fd6b3b6b2aca63

data/.gitignore

@@ -0,0 +1 @@
+.rspec_status

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    click_house-client (0.8.2)
+    click_house-client (0.8.4)
       activerecord (>= 7.0, < 9.0)
       activesupport (>= 7.0, < 9.0)
       addressable (~> 2.8)
@@ -136,7 +136,7 @@ CHECKSUMS
   benchmark (0.4.1) sha256=d4ef40037bba27f03b28013e219b950b82bace296549ec15a78016552f8d2cce
   bigdecimal (3.2.2) sha256=39085f76b495eb39a79ce07af716f3a6829bc35eb44f2195e2753749f2fa5adc
   byebug (12.0.0) sha256=d4a150d291cca40b66ec9ca31f754e93fed8aa266a17335f71bb0afa7fca1a1e
-  click_house-client (0.8.2)
+  click_house-client (0.8.4)
   concurrent-ruby (1.3.5) sha256=813b3e37aca6df2a21a3b9f1d497f8cbab24a2b94cab325bffe65ee0f6cbebc6
   connection_pool (2.5.3) sha256=cfd74a82b9b094d1ce30c4f1a346da23ee19dc8a062a16a85f58eab1ced4305b
   diff-lcs (1.5.0) sha256=49b934001c8c6aedb37ba19daec5c634da27b318a7a3c654ae979d6ba1929b67

data/lib/click_house/client/arel_visitor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_record'
+
 module ClickHouse
   module Client
     class ArelVisitor < Arel::Visitors::ToSql

data/lib/click_house/client/query_builder.rb

@@ -29,8 +29,15 @@ module ClickHouse
         Arel::Nodes::As
       ].freeze
 
-      def initialize(table_name)
-        @table = Arel::Table.new(table_name)
+      delegate :[], to: :table
+
+      def initialize(table, alias_name = nil)
+        @table = if table.is_a?(self.class) # subquery
+                   Arel::Nodes::TableAlias.new(table.to_arel, alias_name)
+                 else
+                   Arel::Table.new(table)
+                 end
+
         @manager = Arel::SelectManager.new(Arel::Table.engine).from(@table).project(Arel.star)
       end
 
@@ -63,6 +70,15 @@ module ClickHouse
         end
       end
 
+      # Evaluates given block in scope of current builder. Example:
+      # query = ClickHouse::Client::QueryBuilder.new('test_table').build do
+      #   select(named_func('argMax', [table[:id], table[:timestamp]]).as('max_id')).limit(10)
+      # end
+      # @return [ClickHouse::QueryBuilder] New instance of query builder.
+      def build(&)
+        instance_eval(&)
+      end
+
       # The `having` method applies constraints to the HAVING clause, similar to how
       # `where` applies constraints to the WHERE clause. It supports the same constraint types.
       # Correct usage:
@@ -181,6 +197,20 @@ module ClickHouse
         end
       end
 
+      # Shortcut for `Arel::Nodes::NamedFunction.new`
+      # @return [Arel::Nodes::NamedFunction]
+      def named_func(*args)
+        Arel::Nodes::NamedFunction.new(*args)
+      end
+
+      # Shortcut for `Arel::Nodes.build_quoted`
+      # @return [Arel::Nodes::Node]
+      def quote(...)
+        Arel::Nodes.build_quoted(...)
+      end
+
+      alias_method :func, :named_func
+
       # Aggregation helper methods
 
       # Creates an AVG aggregate function node
@@ -315,7 +345,9 @@ module ClickHouse
       end
 
       def to_redacted_sql(bind_index_manager = ClickHouse::Client::BindIndexManager.new)
-        ClickHouse::Client::Redactor.redact(self, bind_index_manager)
+        visitor = ClickHouse::Client::ToRedactedSqlVisitor.new(ClickHouse::Client::ArelEngine.new,
+          bind_manager: bind_index_manager)
+        visitor.accept(manager.ast, Arel::Collectors::SQLString.new).value
       end
 
       def to_arel

data/lib/click_house/client/to_redacted_sql_visitor.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Client
+    # Redacts the SQL query represented by the query builder.
+    #
+    # Example:
+    #   query_builder = ClickHouse::QueryBuilder.new('users').where(name: 'John Doe')
+    #   redacted_query = query_builder.to_redacted_sql
+    #   # The redacted_query will contain the SQL query with values replaced by placeholders.
+    #   output: "SELECT * FROM \"users\" WHERE \"users\".\"name\" = $1"
+    class ToRedactedSqlVisitor < ArelVisitor
+      attr_reader :bind_manager
+
+      def initialize(*args, bind_manager: ClickHouse::Client::BindIndexManager.new)
+        @bind_manager = bind_manager
+        super(*args)
+      end
+
+      private
+
+      def redaction_enabled?
+        !!@redaction_enabled
+      end
+
+      def collect_nodes_for(nodes, collector, spacer, *args)
+        return super unless spacer.strip.in?(%w[WHERE HAVING])
+
+        redaction_was = @redaction_enabled
+        @redaction_enabled = true
+        super
+        @redaction_enabled = redaction_was
+      end
+
+      # rubocop:disable Naming/MethodName -- following Arel::Visitors::Visitor pattern
+      # rubocop:disable Naming/MethodParameterName -- following Arel::Visitors::Visitor pattern
+
+      def visit_Arel_Nodes_In(o, collector)
+        return super unless redaction_enabled?
+
+        return super if o.right.is_a? Arel::Nodes::SelectStatement
+
+        super(redact_right(o), collector)
+      end
+
+      def visit_Arel_Nodes_Equality(o, collector)
+        return super unless redaction_enabled?
+
+        super(redact_right(o), collector)
+      end
+
+      def visit_Arel_Nodes_LessThan(o, collector)
+        return super unless redaction_enabled?
+
+        super(redact_right(o), collector)
+      end
+
+      def visit_Arel_Nodes_LessThanOrEqual(o, collector)
+        return super unless redaction_enabled?
+
+        super(redact_right(o), collector)
+      end
+
+      def visit_Arel_Nodes_GreaterThan(o, collector)
+        return super unless redaction_enabled?
+
+        super(redact_right(o), collector)
+      end
+
+      def visit_Arel_Nodes_GreaterThanOrEqual(o, collector)
+        return super unless redaction_enabled?
+
+        super(redact_right(o), collector)
+      end
+
+      def visit_Arel_Nodes_NamedFunction(o, collector)
+        return super unless redaction_enabled?
+
+        redacted_o = Arel::Nodes::NamedFunction.new(o.name, o.expressions.dup)
+
+        case redacted_o.name
+        when 'startsWith'
+          redacted_o.expressions[1] = Arel.sql(bind_manager.next_bind_str)
+        else
+          redacted_o.expressions = redacted_o.expressions.map do
+            Arel.sql(bind_manager.next_bind_str)
+          end
+        end
+
+        super(redacted_o, collector)
+      end
+
+      def visit_Arel_Nodes_Matches(o, collector)
+        return super unless redaction_enabled?
+
+        super(redact_right(o), collector)
+      end
+
+      def redact_right(o)
+        cloned_o = o.clone
+
+        redacted_right = if o.right.is_a?(Array)
+                           Array.new(o.right.size) do
+                             Arel.sql(bind_manager.next_bind_str)
+                           end
+                         else
+                           Arel.sql(bind_manager.next_bind_str)
+                         end
+
+        cloned_o.right = redacted_right
+        cloned_o
+      end
+
+      # rubocop:enable Naming/MethodName
+      # rubocop:enable Naming/MethodParameterName
+    end
+  end
+end

data/lib/click_house/client/version.rb

@@ -2,6 +2,6 @@
 
 module ClickHouse
   module Client
-    VERSION = "0.8.2"
+    VERSION = "0.8.4"
   end
 end

data/lib/click_house/client.rb

@@ -15,11 +15,11 @@ require_relative "client/quoting"
 require_relative "client/arel_engine"
 require_relative "client/query_like"
 require_relative "client/query"
-require_relative "client/redactor"
+require_relative "client/arel_visitor"
+require_relative "client/to_redacted_sql_visitor"
 require_relative "client/query_builder"
 require_relative "client/formatter"
 require_relative "client/response"
-require_relative "client/arel_visitor"
 
 module ClickHouse
   module Client

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_house-client
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.4
 platform: ruby
 authors:
 - group::optimize
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-13 00:00:00.000000000 Z
+date: 2025-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -170,6 +170,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -193,8 +194,8 @@ files:
 - lib/click_house/client/query_builder.rb
 - lib/click_house/client/query_like.rb
 - lib/click_house/client/quoting.rb
-- lib/click_house/client/redactor.rb
 - lib/click_house/client/response.rb
+- lib/click_house/client/to_redacted_sql_visitor.rb
 - lib/click_house/client/version.rb
 homepage: https://gitlab.com/gitlab-org/ruby/gems/clickhouse-client
 licenses:

data/lib/click_house/client/redactor.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module ClickHouse
-  module Client
-    module Redactor
-      class << self
-        # Redacts the SQL query represented by the query builder.
-        #
-        # @param query_builder [::ClickHouse::Querybuilder] The query builder object to be redacted.
-        # @return [String] The redacted SQL query as a string.
-        # @raise [ArgumentError] when the condition in the query is of an unsupported type.
-        #
-        # Example:
-        #   query_builder = ClickHouse::QueryBuilder.new('users').where(name: 'John Doe')
-        #   redacted_query = ClickHouse::Redactor.redact(query_builder)
-        #   # The redacted_query will contain the SQL query with values replaced by placeholders.
-        #   output: "SELECT * FROM \"users\" WHERE \"users\".\"name\" = $1"
-        def redact(query_builder, bind_manager = ClickHouse::Client::BindIndexManager.new)
-          redacted_constraints = query_builder.manager.constraints.map do |constraint|
-            redact_constraint(constraint, bind_manager)
-          end
-
-          cloned_query_builder = query_builder.clone
-
-          cloned_query_builder.manager.constraints.clear
-          redacted_constraints.each do |constraint|
-            cloned_query_builder.manager.where(constraint)
-          end
-
-          cloned_query_builder.to_sql
-        end
-
-        private
-
-        def redact_constraint(constraint, bind_manager)
-          case constraint
-          when Arel::Nodes::In
-            if constraint.right.is_a? Arel::Nodes::SelectStatement
-              constraint.left.in(redact_select_statement(constraint.right, bind_manager))
-            else
-              constraint.left.in(Array.new(constraint.right.size) { Arel.sql(bind_manager.next_bind_str) })
-            end
-          when Arel::Nodes::Equality
-            constraint.left.eq(Arel.sql(bind_manager.next_bind_str))
-          when Arel::Nodes::LessThan
-            constraint.left.lt(Arel.sql(bind_manager.next_bind_str))
-          when Arel::Nodes::LessThanOrEqual
-            constraint.left.lteq(Arel.sql(bind_manager.next_bind_str))
-          when Arel::Nodes::GreaterThan
-            constraint.left.gt(Arel.sql(bind_manager.next_bind_str))
-          when Arel::Nodes::GreaterThanOrEqual
-            constraint.left.gteq(Arel.sql(bind_manager.next_bind_str))
-          when Arel::Nodes::NamedFunction
-            redact_named_function(constraint, bind_manager)
-          when Arel::Nodes::Matches
-            constraint.left.matches(Arel.sql(bind_manager.next_bind_str), constraint.escape, constraint.case_sensitive)
-          else
-            raise ArgumentError, "Unsupported Arel node type for Redactor: #{constraint.class}"
-          end
-        end
-
-        def redact_named_function(constraint, bind_manager)
-          redacted_constraint =
-            Arel::Nodes::NamedFunction.new(constraint.name, constraint.expressions.dup)
-
-          case redacted_constraint.name
-          when 'startsWith'
-            redacted_constraint.expressions[1] = Arel.sql(bind_manager.next_bind_str)
-          else
-            redacted_constraint.expressions = redacted_constraint.expressions.map do
-              Arel.sql(bind_manager.next_bind_str)
-            end
-          end
-
-          redacted_constraint
-        end
-
-        def redact_select_statement(select_statement, bind_manager)
-          cloned_statement = select_statement.clone
-          cloned_statement.cores.map! do |select_core|
-            select_core.wheres = select_core.wheres.map do |where|
-              redact_constraint(where, bind_manager)
-            end
-
-            select_core
-          end
-
-          cloned_statement
-        end
-      end
-    end
-  end
-end