click_house-client 0.2.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36b8d9ccc7b257b2ab60133e35f73f118dc748cf5029aafb97cdd90e4451590
-  data.tar.gz: d553c4a604ad4a1eee9c3cce940cca796000c80d4950ee021d7d3e780d26bca4
+  metadata.gz: 979e02193855b98f131e5474d0dc16d84463740699425b5f10914bade2759a60
+  data.tar.gz: 172eb393746096c11d76b06a5dbcc59fd396a555f0186192e8b077e3ec08f687
 SHA512:
-  metadata.gz: 4e9a05e8fb98eef88eb042747100d36acb76b532099d323c799588d6ba0fa1db83616ff952155c3a305e87b93a8ba183d1fff6dc6884a3447b624b188c0a4647
-  data.tar.gz: f13f21ece21e0a9d98df50482965c288fe51ef2314b3662137085ea4150a9108bd5f04a7538c28a7689b1dcfd30889302360228f434d8643c6d3bc7d0bc05309
+  metadata.gz: 5e41352d705398e565ee0e828286e440da6c99893bb88598b2fd0f9cb0138a6f5f26a664e5f3998d9f7c0ee64ad3f68da55a26c040dc3f9c9fcfc6318d88b90f
+  data.tar.gz: 2839955caa8847c180b9286f3daf4477a8ab1e972329ebb7c6868001bebfcb673f36cc174fff38d8cc6c0aa3c30f579995c8abcfbec2b94231094aa978fdc9d6

data/.gitlab-ci.yml

@@ -34,7 +34,7 @@ default:
     - bundle install -j $(nproc) --path vendor
   parallel:
     matrix:
-      - RUBY_VERSION: ['3.0', '3.1', '3.2', '3.3']
+      - RUBY_VERSION: ['3.1', '3.2', '3.3']
 
 test:rspec:
   extends: .default-test-job

data/.rubocop.yml

@@ -6,7 +6,7 @@ CodeReuse/ActiveRecord:
   Enabled: false
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
   NewCops: enable
   SuggestExtensions: false
 

data/Gemfile.lock

@@ -1,24 +1,43 @@
 PATH
   remote: .
   specs:
-    click_house-client (0.2.4)
-      activesupport (< 8)
+    click_house-client (0.3.0)
+      activerecord (~> 7.0)
+      activesupport (~> 7.0)
       addressable (~> 2.8)
       json (~> 2.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.8.7)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activemodel (7.2.2.1)
+      activesupport (= 7.2.2.1)
+    activerecord (7.2.2.1)
+      activemodel (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      timeout (>= 0.4.0)
+    activesupport (7.2.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    concurrent-ruby (1.2.2)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
     diff-lcs (1.5.0)
+    drb (2.2.3)
     gitlab-styles (12.0.1)
       rubocop (~> 1.62.1)
       rubocop-factory_bot (~> 2.25.1)
@@ -30,6 +49,7 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.10.1)
     language_server-protocol (3.17.0.3)
+    logger (1.7.0)
     minitest (5.18.1)
     parallel (1.23.0)
     parser (3.3.3.0)
@@ -87,6 +107,8 @@ GEM
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
@@ -103,16 +125,24 @@ DEPENDENCIES
   rubocop-rspec
 
 CHECKSUMS
-  activesupport (7.0.8.7) sha256=df4702375de924aae81709c831605317c5417f0bd9e502a0373ff84a067204ff
+  activemodel (7.2.2.1) sha256=8398861f9ee2c4671a8357ab39e9b38a045fd656f6685a3dd5890c2419dbfdaf
+  activerecord (7.2.2.1) sha256=79a31f71c32d5138717c2104e0ff105f5d82922247c85bdca144f2720e67fab9
+  activesupport (7.2.2.1) sha256=842bcbf8a92977f80fb4750661a237cf5dd4fdd442066b3c35e88afb488647f5
   addressable (2.8.4) sha256=40a88af5285625b7fb14070e550e667d5b0cc91f748068701b4d897cacda4897
   ast (2.4.2) sha256=1e280232e6a33754cde542bc5ef85520b74db2aac73ec14acef453784447cc12
-  click_house-client (0.2.4)
-  concurrent-ruby (1.2.2) sha256=3879119b8b75e3b62616acc256c64a134d0b0a7a9a3fcba5a233025bcde22c4f
+  base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
+  benchmark (0.4.1) sha256=d4ef40037bba27f03b28013e219b950b82bace296549ec15a78016552f8d2cce
+  bigdecimal (3.2.2) sha256=39085f76b495eb39a79ce07af716f3a6829bc35eb44f2195e2753749f2fa5adc
+  click_house-client (0.3.0)
+  concurrent-ruby (1.3.5) sha256=813b3e37aca6df2a21a3b9f1d497f8cbab24a2b94cab325bffe65ee0f6cbebc6
+  connection_pool (2.5.3) sha256=cfd74a82b9b094d1ce30c4f1a346da23ee19dc8a062a16a85f58eab1ced4305b
   diff-lcs (1.5.0) sha256=49b934001c8c6aedb37ba19daec5c634da27b318a7a3c654ae979d6ba1929b67
+  drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
   gitlab-styles (12.0.1) sha256=d8a302b0ab0e1f18e2d11501760f1b85c5e70b5e5ca628828a0786c7984ed133
   i18n (1.14.1) sha256=9d03698903547c060928e70a9bc8b6b87fda674453cda918fc7ab80235ae4a61
   json (2.10.1) sha256=ddc88ad91a1baf3f0038c174f253af3b086d30dc74db17ca4259bbde982f94dc
   language_server-protocol (3.17.0.3) sha256=3d5c58c02f44a20d972957a9febe386d7e7468ab3900ce6bd2b563dd910c6b3f
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   minitest (5.18.1) sha256=ab5ee381871aaddc3a6aa2a6abcab5c4590fec9affc20947d63f312a0fe4e9cd
   parallel (1.23.0) sha256=27154713ad6ef32fa3dcb7788a721d6c07bca77e72443b4c6080a14145288c49
   parser (3.3.3.0) sha256=a2e23c90918d9b7e866b18dca2b6835f227769dd2fa8e59c5841f3389cf53eeb
@@ -137,6 +167,8 @@ CHECKSUMS
   rubocop-rails (2.24.1) sha256=03edf766954947468f3686cedb69142fae4f10e2007287f89cc0ea7072eeac19
   rubocop-rspec (2.27.1) sha256=2f27ce04700be75db65afe83d7993a36e0fafd07ec062222f4b3cc10137a7a9e
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
+  timeout (0.4.3) sha256=9509f079b2b55fe4236d79633bd75e34c1c1e7e3fb4b56cb5fda61f80a0fe30e
   tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b
   unicode-display_width (2.4.2) sha256=6a10205d1a19ca790c4e53064ba93f09d9eb234bf6bd135d9deb6001c21428be
 

data/click_house-client.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "This Gem provides a simple way to query ClickHouse databases using the HTTP interface."
   spec.homepage = "https://gitlab.com/gitlab-org/ruby/gems/clickhouse-client"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activesupport", "< 8"
+  spec.add_runtime_dependency "activerecord", "~> 7.0"
+  spec.add_runtime_dependency "activesupport", "~> 7.0"
   spec.add_runtime_dependency "addressable", "~> 2.8"
   spec.add_runtime_dependency 'json', '~> 2.7'
 

data/lib/click_house/client/arel_engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Client
+    class ArelEngine
+      def quote_table_name(name)
+        "`#{name}`" # Safest approach for ClickHouse
+      end
+
+      def quote_column_name(name)
+        quote_table_name(name)
+      end
+
+      def quote(value)
+        ClickHouse::Client::Quoting.quote(value)
+      end
+    end
+  end
+end

data/lib/click_house/client/database.rb

@@ -11,7 +11,7 @@ module ClickHouse
         @username = username
         @password = password
         @variables = {
-          database: database,
+          database:,
           enable_http_compression: 1 # enable HTTP compression by default
         }.merge(variables).freeze
       end

data/lib/click_house/client/query_builder.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module ClickHouse
+  module Client
+    class QueryBuilder < QueryLike
+      attr_reader :table
+      attr_accessor :conditions, :manager
+
+      VALID_NODES = [
+        Arel::Nodes::In,
+        Arel::Nodes::Equality,
+        Arel::Nodes::LessThan,
+        Arel::Nodes::LessThanOrEqual,
+        Arel::Nodes::GreaterThan,
+        Arel::Nodes::GreaterThanOrEqual,
+        Arel::Nodes::NamedFunction
+      ].freeze
+
+      def initialize(table_name)
+        @table = Arel::Table.new(table_name)
+        @manager = Arel::SelectManager.new(Arel::Table.engine).from(@table).project(Arel.star)
+        @conditions = []
+      end
+
+      # The `where` method currently only supports IN and equal to queries along
+      # with above listed VALID_NODES.
+      # For example, using a range (start_date..end_date) will result in incorrect SQL.
+      # If you need to query a range, use greater than and less than conditions with Arel.
+      #
+      # Correct usage:
+      #   query.where(query.table[:created_at].lteq(Date.today)).to_sql
+      #   "SELECT * FROM \"table\" WHERE \"table\".\"created_at\" <= '2023-08-01'"
+      #
+      # This also supports array conditions which will result in an IN query.
+      #   query.where(entity_id: [1,2,3]).to_sql
+      #   "SELECT * FROM \"table\" WHERE \"table\".\"entity_id\" IN (1, 2, 3)"
+      #
+      # Range support and more `Arel::Nodes` could be considered for future iterations.
+      # @return [ClickHouse::QueryBuilder] New instance of query builder.
+      def where(conditions)
+        validate_condition_type!(conditions)
+
+        deep_clone.tap do |new_instance|
+          if conditions.is_a?(Arel::Nodes::Node)
+            new_instance.conditions << conditions
+          else
+            add_conditions_to(new_instance, conditions)
+          end
+        end
+      end
+
+      def select(*fields)
+        deep_clone.tap do |new_instance|
+          existing_fields = new_instance.manager.projections.filter_map do |projection|
+            if projection.is_a?(Arel::Attributes::Attribute)
+              projection.name.to_s
+            elsif projection.to_s == '*'
+              nil
+            end
+          end
+
+          new_projections = (existing_fields + fields).map do |field|
+            if field.is_a?(Symbol)
+              field.to_s
+            else
+              field
+            end
+          end
+
+          new_instance.manager.projections = new_projections.uniq.map do |field|
+            if field.is_a?(Arel::Expressions)
+              field
+            else
+              new_instance.table[field.to_s]
+            end
+          end
+        end
+      end
+
+      def order(field, direction = :asc)
+        validate_order_direction!(direction)
+
+        deep_clone.tap do |new_instance|
+          table_field = new_instance.table[field]
+          new_order = direction.to_s.casecmp('desc').zero? ? table_field.desc : table_field.asc
+          new_instance.manager.order(new_order)
+        end
+      end
+
+      def group(*columns)
+        deep_clone.tap do |new_instance|
+          new_instance.manager.group(*columns)
+        end
+      end
+
+      def limit(count)
+        manager.take(count)
+        self
+      end
+
+      def offset(count)
+        manager.skip(count)
+        self
+      end
+
+      def to_sql
+        apply_conditions!
+
+        visitor = Arel::Visitors::ToSql.new(ClickHouse::Client::ArelEngine.new)
+        visitor.accept(manager.ast, Arel::Collectors::SQLString.new).value
+      end
+
+      def to_redacted_sql(bind_index_manager = ClickHouse::Client::BindIndexManager.new)
+        ClickHouse::Client::Redactor.redact(self, bind_index_manager)
+      end
+
+      private
+
+      def validate_condition_type!(condition)
+        return unless condition.is_a?(Arel::Nodes::Node) && VALID_NODES.exclude?(condition.class)
+
+        raise ArgumentError, "Unsupported Arel node type for QueryBuilder: #{condition.class.name}"
+      end
+
+      def add_conditions_to(instance, conditions)
+        conditions.each do |key, value|
+          instance.conditions << if value.is_a?(Array)
+                                   instance.table[key].in(value)
+                                 else
+                                   instance.table[key].eq(value)
+                                 end
+        end
+      end
+
+      def deep_clone
+        self.class.new(table.name).tap do |new_instance|
+          new_instance.manager = manager.clone
+          new_instance.conditions = conditions.map(&:clone)
+        end
+      end
+
+      def apply_conditions!
+        manager.constraints.clear
+        conditions.each { |condition| manager.where(condition) }
+      end
+
+      def validate_order_direction!(direction)
+        return if %w[asc desc].include?(direction.to_s.downcase)
+
+        raise ArgumentError, "Invalid order direction '#{direction}'. Must be :asc or :desc"
+      end
+    end
+  end
+end

data/lib/click_house/client/quoting.rb

@@ -6,12 +6,19 @@ module ClickHouse
       class << self
         def quote(value)
           case value
-          when String, Symbol then "'#{value.gsub('\\', '\&\&').gsub("'", "''")}'"
+          when Numeric then value.to_s
+          when String, Symbol then "'#{value.to_s.gsub('\\', '\&\&').gsub("'", "''")}'"
           when Array then "[#{value.map { |v| quote(v) }.join(',')}]"
           when nil then "NULL"
-          else value
+          else quote_str(value.to_s)
           end
         end
+
+        private
+
+        def quote_str(value)
+          "'#{value.gsub("'", "''")}'"
+        end
       end
     end
   end

data/lib/click_house/client/redactor.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Client
+    module Redactor
+      # 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 self.redact(query_builder, bind_manager = ClickHouse::Client::BindIndexManager.new)
+        cloned_query_builder = query_builder.clone
+
+        cloned_query_builder.conditions = cloned_query_builder.conditions.map do |condition|
+          redact_condition(condition, bind_manager)
+        end
+
+        cloned_query_builder.manager.constraints.clear
+        cloned_query_builder.conditions.each do |condition|
+          cloned_query_builder.manager.where(condition)
+        end
+
+        visitor = Arel::Visitors::ToSql.new(ClickHouse::Client::ArelEngine.new)
+        visitor.accept(cloned_query_builder.manager.ast, Arel::Collectors::SQLString.new).value
+      end
+
+      def self.redact_condition(condition, bind_manager)
+        case condition
+        when Arel::Nodes::In
+          condition.left.in(Array.new(condition.right.size) { Arel.sql(bind_manager.next_bind_str) })
+        when Arel::Nodes::Equality
+          condition.left.eq(Arel.sql(bind_manager.next_bind_str))
+        when Arel::Nodes::LessThan
+          condition.left.lt(Arel.sql(bind_manager.next_bind_str))
+        when Arel::Nodes::LessThanOrEqual
+          condition.left.lteq(Arel.sql(bind_manager.next_bind_str))
+        when Arel::Nodes::GreaterThan
+          condition.left.gt(Arel.sql(bind_manager.next_bind_str))
+        when Arel::Nodes::GreaterThanOrEqual
+          condition.left.gteq(Arel.sql(bind_manager.next_bind_str))
+        when Arel::Nodes::NamedFunction
+          redact_named_function(condition, bind_manager)
+        else
+          raise ArgumentError, "Unsupported Arel node type for Redactor: #{condition.class}"
+        end
+      end
+
+      def self.redact_named_function(condition, bind_manager)
+        redacted_condition =
+          Arel::Nodes::NamedFunction.new(condition.name, condition.expressions.dup)
+
+        case redacted_condition.name
+        when 'startsWith'
+          redacted_condition.expressions[1] = Arel.sql(bind_manager.next_bind_str)
+        else
+          redacted_condition.expressions = redacted_condition.expressions.map { Arel.sql(bind_manager.next_bind_str) }
+        end
+
+        redacted_condition
+      end
+    end
+  end
+end

data/lib/click_house/client/version.rb

@@ -2,6 +2,6 @@
 
 module ClickHouse
   module Client
-    VERSION = "0.2.4"
+    VERSION = "0.3.1"
   end
 end

data/lib/click_house/client.rb

@@ -2,16 +2,21 @@
 
 require 'addressable'
 require 'json'
+require 'active_support/deprecation'
 require 'active_support/time'
 require 'active_support/notifications'
+require 'active_support/core_ext/string'
 require 'active_support/core_ext/object/blank'
 require_relative "client/version"
 require_relative "client/database"
 require_relative "client/configuration"
 require_relative "client/bind_index_manager"
 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/query_builder"
 require_relative "client/formatter"
 require_relative "client/response"
 
@@ -76,7 +81,7 @@ module ClickHouse
       )
 
       query = ClickHouse::Client::Query.build(query)
-      ActiveSupport::Notifications.instrument('sql.click_house', { query: query, database: database }) do |instrument|
+      ActiveSupport::Notifications.instrument('sql.click_house', { query:, database: }) do |instrument|
         response = configuration.http_post_proc.call(
           db.build_custom_uri(extra_variables: { query: query.to_sql }).to_s,
           headers,
@@ -111,7 +116,7 @@ module ClickHouse
       log_contents = configuration.log_proc.call(query)
       configuration.logger.info(log_contents)
 
-      ActiveSupport::Notifications.instrument('sql.click_house', { query: query, database: database }) do |instrument|
+      ActiveSupport::Notifications.instrument('sql.click_house', { query:, database: }) do |instrument|
         # Use a multipart POST request where the placeholders are sent with the param_ prefix
         # See: https://github.com/ClickHouse/ClickHouse/issues/8842
         query_with_params = query.prepared_placeholders.transform_keys { |key| "param_#{key}" }

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: click_house-client
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.1
 platform: ruby
 authors:
 - group::optimize
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-30 00:00:00.000000000 Z
+date: 2025-07-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -141,13 +155,16 @@ files:
 - README.md
 - click_house-client.gemspec
 - lib/click_house/client.rb
+- lib/click_house/client/arel_engine.rb
 - lib/click_house/client/bind_index_manager.rb
 - lib/click_house/client/configuration.rb
 - lib/click_house/client/database.rb
 - lib/click_house/client/formatter.rb
 - lib/click_house/client/query.rb
+- 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/version.rb
 homepage: https://gitlab.com/gitlab-org/ruby/gems/clickhouse-client
@@ -162,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="