click_house 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73a7b3a1d277214b437bf34712185e436d372a6396d0e388a446e3f29c61ac0e
-  data.tar.gz: 42869ca836d053d80299126149dc88266da4a0b31ce96837fc02348d60dc0394
+  metadata.gz: fd545a5ce410be500540a02ef1f46e57b9a7a2dfe2df8b5be47022ac2cd1f5b4
+  data.tar.gz: 19b872a4901d7543ddf7fbb23ca53ac8f6731023b74ae5af24a52aac4b054fc3
 SHA512:
-  metadata.gz: 5e308c6f52fc984e3532453a869603d727620d3db61533ff80307caa06c481a5dec29685c38fb46527dea94e9d3577ee5c8918af79aa85bd8697ae7a22063b26
-  data.tar.gz: 9dc3e6b31f65c6b3cee80aaa657fe924face07474d256714da34d4287128a26563a463e7b14019564895d4d6821b5b2aaf7324418530fd8c548d629522f15008
+  metadata.gz: 6ad04e10ecb7acce32f3c18225b62aad8b83ef79f46e176678bbaadf0b274e8b0cefbe72c678e7ba9d047a22d98912a4de2e89b73957b721731e3666caf3850c
+  data.tar.gz: 0155f69f8faf71b9fbf95a1d32f04dce4c3eb2a9b43752aac786ee29a3f0db882afd85c1e44178e366938a18053f99eead8d247267d53a49f6dffd63ac0223f5

data/.github/workflows/main.yml

@@ -0,0 +1,68 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    services:
+      clickhouse:
+        image: yandex/clickhouse-server:20.11.4.13
+        ports: 
+          - 8123:8123
+
+    strategy:
+      matrix:
+        ruby-version: [2.7, 2.6, 2.5]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Cache gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby-version }}-bundler-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby-version }}-bundler-
+
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby 2.7
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+
+      - name: Cache gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-bundler-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-bundler-
+
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run Rubocop
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -3,13 +3,13 @@ require:
 
 AllCops:
   AutoCorrect: false
+  SuggestExtensions: false
   Exclude:
     - 'click_house.gemspec'
     - 'bin/*'
     - 'spec/**/*'
     - 'vendor/**/*'
   TargetRubyVersion: 2.7
-
 Bundler/OrderedGems:
   Enabled: false
 
@@ -34,6 +34,18 @@ Performance/Squeeze:
   Enabled: true
 Performance/StringInclude:
   Enabled: true
+Performance/Sum:
+  Enabled: true
+Performance/ArraySemiInfiniteRangeSlice:
+  Enabled: true
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+Performance/ConstantRegexp:
+  Enabled: true
+Performance/MethodObjectAsBlock:
+  Enabled: false
 
 # ============================== Metrics ============================
 Metrics/ClassLength:
@@ -181,6 +193,30 @@ Style/SingleArgumentDig:
   Enabled: true
 Style/StringConcatenation:
   Enabled: true
+Style/ClassEqualityComparison:
+  Enabled: true
+Style/CombinableLoops:
+  Enabled: true
+Style/KeywordParametersOrder:
+  Enabled: false
+Style/RedundantSelfAssignment:
+  Enabled: true
+Style/SoleNestedConditional:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
 
 # ============================== Lint ==============================
 Lint/DuplicateMethods:
@@ -215,3 +251,39 @@ Lint/TopLevelReturnWithArgument:
   Enabled: true
 Lint/UnreachableLoop:
   Enabled: true
+Layout/BeginEndAlignment:
+  Enabled: true
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
+Lint/DuplicateRequire:
+  Enabled: true
+Lint/EmptyFile:
+  Enabled: true
+Lint/HashCompareByIdentity:
+  Enabled: true
+Lint/IdentityComparison:
+  Enabled: true
+Lint/RedundantSafeNavigation:
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+Lint/UselessMethodDefinition:
+  Enabled: true
+Lint/UselessTimes:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 1.3.5
+* added `ClickHouse.connexction.explain("sql")` 
+
+# 1.3.4
+* added `ClickHouse.type_names(nullable: false)`
+* fixed `connection#create_table` column definitions
+* `ClickHouse.add_type` now handles Nullable types automatically
+
+# 1.3.3
+* fix logger typo
+
+# 1.3.2
+* fix null logger for windows users
+
+# 1.3.1
+* added request [headers](https://github.com/shlima/click_house/pull/8) support
+
 # 1.3.0
 * added support for IPv4/IPv6 types
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    click_house (1.3.0)
+    click_house (1.3.5)
       faraday
       faraday_middleware
 
@@ -11,49 +11,52 @@ GEM
     ast (2.4.1)
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    faraday (1.0.1)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (2.0.0)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.89.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.5.2)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/README.md

@@ -2,12 +2,12 @@
 
 # ClickHouse Ruby driver
 
-[![pipeline status](https://travis-ci.com/shlima/click_house.svg?branch=master)](https://travis-ci.com/shlima/click_house)
+![CI](https://github.com/shlima/click_house/workflows/CI/badge.svg)
 [![Code Climate](https://codeclimate.com/github/shlima/click_house/badges/gpa.svg)](https://codeclimate.com/github/shlima/click_house)
 [![Gem Version](https://badge.fury.io/rb/click_house.svg)](https://badge.fury.io/rb/click_house)
 
 ```bash
-# Requires modern Ruby (>= 2.5), tested with Yandex.Clickhouse v 20.9.2.20
+# Requires Ruby >= 2.5
 gem install click_house
 ```
 
@@ -53,6 +53,7 @@ ClickHouse.config do |config|
   config.timeout = 60
   config.open_timeout = 3
   config.ssl_verify = false
+  config.headers = {}
   
   # or provide connection options separately
   config.scheme = 'http' 
@@ -104,6 +105,11 @@ ClickHouse.connection.truncate_tables(['table_1', 'table_2'], if_exists: true, c
 ClickHouse.connection.truncate_tables # will truncate all tables in database
 ClickHouse.connection.rename_table('old_name', 'new_name', cluster: nil)
 ClickHouse.connection.rename_table(%w[table_1 table_2], %w[new_1 new_2], cluster: nil)
+
+ClickHouse.connection.select_all('SELECT * FROM visits')
+ClickHouse.connection.select_one('SELECT * FROM visits LIMIT 1')
+ClickHouse.connection.select_value('SELECT ip FROM visits LIMIT 1')
+ClickHouse.connection.explain('SELECT * FROM visits CROSS JOIN visits')
 ```
 
 ## Queries
@@ -216,7 +222,8 @@ ClickHouse.connection.create_table('visits', if_not_exists: true, engine: 'Merge
   t.Decimal     :money, 5, 4
   t.String      :event
   t.UInt32      :user_id
-  t.UInt32      :Float32
+  t.IPv4        :ipv4
+  t.IPv6        :ipv6
 end
 ```
 
@@ -328,11 +335,11 @@ ClickHouse.add_type('Date', DateType.new)
 Actually `serialize` function is not used for now, but you may use it manually:
 
 ```ruby
-time_type = DateTimeType.new
-string_type = FixedStringType.new 
+time_type = ClickHouse::Type::DateTimeType.new
+string_type = ClickHouse::Type::FixedStringType.new 
 
 ClickHouse.connection.insert('table', columns: %i[name time]) do |buffer|
-  buffer << [string_type.serialize('a' * 1000, 20), time.serialize(Time.current, 'Europe/Moscow')]
+  buffer << [string_type.serialize('a' * 1000, 20), time_type.serialize(Time.current, 'Europe/Moscow')]
 end
 
 ## alternatively
@@ -344,7 +351,8 @@ data = @records.map do |record|
 end
 ```
 
-If native type supports arguments, define type with `%s` argument:
+If native type supports arguments, define *String* type with `%s` 
+argument and *Numeric* type with `%d` argument:
 
 ```ruby
 class DateTimeType
@@ -396,6 +404,10 @@ development:
 test:
   database: ecliptic_test
   <<: *default
+  
+production:
+  <<: *default
+  database: ecliptic_production
 ```
 
 ```ruby
@@ -448,11 +460,6 @@ class CreateAdvertVisits < ActiveRecord::Migration[6.0]
       t.UInt16   :account_id
       t.UInt16   :user_id
       t.Date     :date
-      t.DateTime :time, 'UTC'
-      t.IPv4     :ipv4
-      t.IPv6     :ipv6
-      t.UInt32   :device_type_id
-      t.UInt32   :os_family_id
     end
   end
 

data/docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.5'
 
 services:
   clickhouse:
-    image: yandex/clickhouse-server:20.9.2.20
+    image: yandex/clickhouse-server:20.11.4.13
     ports:
       - "8123:8123"
       - "9000:9000"

data/lib/click_house.rb

@@ -28,41 +28,33 @@ module ClickHouse
 
   %w[Date].each do |column|
     add_type column, Type::DateType.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::DateType.new)
   end
 
-  %w[String].each do |column|
+  %w[String FixedString(%d) UUID].each do |column|
     add_type column, Type::StringType.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::StringType.new)
   end
 
   ['DateTime(%s)'].each do |column|
     add_type column, Type::DateTimeType.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::DateTimeType.new)
   end
 
   ['DateTime64(%d, %s)'].each do |column|
     add_type column, Type::DateTime64Type.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::DateTime64Type.new)
   end
 
-  ['Decimal(%s, %s)', 'Decimal32(%s)', 'Decimal64(%s)', 'Decimal128(%s)'].each do |column|
+  ['Decimal(%d, %d)', 'Decimal32(%d)', 'Decimal64(%d)', 'Decimal128(%d)'].each do |column|
     add_type column, Type::DecimalType.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::DecimalType.new)
   end
 
   %w[UInt8 UInt16 UInt32 UInt64 Int8 Int16 Int32 Int64].each do |column|
     add_type column, Type::IntegerType.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::IntegerType.new)
   end
 
   %w[Float32 Float64].each do |column|
     add_type column, Type::FloatType.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::IntegerType.new)
   end
 
   %w[IPv4 IPv6].each do |column|
     add_type column, Type::IPType.new
-    add_type "Nullable(#{column})", Type::NullableType.new(Type::IPType.new)
   end
 end

data/lib/click_house/config.rb

@@ -18,7 +18,8 @@ module ClickHouse
       password: nil,
       timeout: nil,
       open_timeout: nil,
-      ssl_verify: false
+      ssl_verify: false,
+      headers: {}
     }.freeze
 
     attr_accessor :adapter
@@ -33,6 +34,7 @@ module ClickHouse
     attr_accessor :timeout
     attr_accessor :open_timeout
     attr_accessor :ssl_verify
+    attr_accessor :headers
 
     def initialize(params = {})
       assign(DEFAULTS.merge(params))
@@ -51,7 +53,7 @@ module ClickHouse
     end
 
     def logger!
-      @logger || Logger.new('/dev/null')
+      @logger || Logger.new(IO::NULL)
     end
 
     def url!

data/lib/click_house/connection.rb

@@ -8,9 +8,11 @@ module ClickHouse
     include Extend::ConnectionSelective
     include Extend::ConnectionInserting
     include Extend::ConnectionAltering
+    include Extend::ConnectionExplaining
 
     attr_reader :config
 
+    # @param [Config]
     def initialize(config)
       @config = config
     end
@@ -31,6 +33,7 @@ module ClickHouse
       @transport ||= Faraday.new(config.url!) do |conn|
         conn.options.timeout = config.timeout
         conn.options.open_timeout = config.open_timeout
+        conn.headers = config.headers
         conn.ssl.verify = config.ssl_verify
         conn.basic_auth(config.username, config.password) if config.auth?
         conn.response Middleware::Logging, logger: config.logger!

data/lib/click_house/definition/column_set.rb

@@ -3,17 +3,7 @@
 module ClickHouse
   module Definition
     class ColumnSet
-      TYPES = [
-        'UInt8', 'UInt16', 'UInt32', 'UInt64', 'Int8', 'Int16', 'Int32', 'Int64',
-        'Float32', 'Float64',
-        'Decimal(%d, %d)', 'Decimal32(%d)', 'Decimal64(%d)', 'Decimal128(%d)',
-        'String',
-        'FixedString(%d)',
-        'UUID',
-        'Date',
-        'IPv4', 'IPv6',
-        "DateTime('%s')", "DateTime64(%d, '%s')"
-      ].freeze
+      TYPES = ClickHouse.type_names(nullable: false).map { |s| s.sub('%s', "'%s'") }.freeze
 
       class << self
         # @input "DateTime('%s')"

data/lib/click_house/extend.rb

@@ -11,5 +11,6 @@ module ClickHouse
     autoload :ConnectionSelective, 'click_house/extend/connection_selective'
     autoload :ConnectionInserting, 'click_house/extend/connection_inserting'
     autoload :ConnectionAltering, 'click_house/extend/connection_altering'
+    autoload :ConnectionExplaining, 'click_house/extend/connection_explaining'
   end
 end

data/lib/click_house/extend/connection_explaining.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Extend
+    module ConnectionExplaining
+      EXPLAIN = 'EXPLAIN'
+      EXPLAIN_RE = /\A(\s*#{EXPLAIN})/io.freeze
+
+      def explain(sql, io: $stdout)
+        res = execute("#{EXPLAIN} #{sql.gsub(EXPLAIN_RE, '')}")
+        io << res.body
+      end
+    end
+  end
+end

data/lib/click_house/extend/type_definition.rb

@@ -3,12 +3,21 @@
 module ClickHouse
   module Extend
     module TypeDefinition
+      NULLABLE = 'Nullable'
+      NULLABLE_RE = /#{NULLABLE}/i.freeze
+
       def types
         @types ||= Hash.new(Type::UndefinedType.new)
       end
 
-      def add_type(type, klass)
+      def add_type(type, klass, nullable: true)
         types[type] = klass
+        types["#{NULLABLE}(#{type})"] = Type::NullableType.new(klass) if nullable
+      end
+
+      # @return [Enum<String>]
+      def type_names(nullable:)
+        nullable ? types.keys : types.keys.grep_v(NULLABLE_RE)
       end
     end
   end

data/lib/click_house/middleware/logging.rb

@@ -34,7 +34,7 @@ module ClickHouse
 
         logger.info("\e[1mSQL (#{Util::Pretty.measure(elapsed)})\e[0m #{query};")
         logger.debug(body) if body
-        logger.info("\e[1mRead: #{summary.fetch(:read_rows)} rows, #{summary.fetch(:read_bytes)}. Written: #{summary.fetch(:written_rows)}, rows #{summary.fetch(:written_bytes)}\e[0m")
+        logger.info("\e[1mRead: #{summary.fetch(:read_rows)} rows, #{summary.fetch(:read_bytes)}. Written: #{summary.fetch(:written_rows)} rows, #{summary.fetch(:written_bytes)}\e[0m")
       end
       # rubocop:enable Layout/LineLength
 

data/lib/click_house/response/result_set.rb

@@ -8,6 +8,7 @@ module ClickHouse
 
       TYPE_ARGV_DELIM = ','
       NULLABLE = 'Nullable'
+      NULLABLE_TYPE_RE = /#{NULLABLE}\((.+)\)/i.freeze
 
       def_delegators :to_a,
                      :each, :fetch, :length, :count, :size, :first, :last, :[], :to_h
@@ -28,7 +29,7 @@ module ClickHouse
         # @input "Decimal(10, 5)"
         # @output "Decimal(%s, %s)"
         def extract_type_info(type)
-          type = type.gsub(/#{NULLABLE}\((.+)\)/i, '\1')
+          type = type.gsub(NULLABLE_TYPE_RE, '\1')
           nullable = Regexp.last_match(1)
           argv = []
 

data/lib/click_house/util/statement.rb

@@ -4,6 +4,7 @@ module ClickHouse
   module Util
     module Statement
       END_OF_STATEMENT = ';'
+      END_OF_STATEMENT_RE = /#{END_OF_STATEMENT}(\s+|\Z)/.freeze
 
       module_function
 
@@ -14,7 +15,7 @@ module ClickHouse
       def format(sql, format)
         return sql if sql.match?(/FORMAT/i)
 
-        "#{sql.sub(/#{END_OF_STATEMENT}(\s+|\Z)/, '')} FORMAT #{format};"
+        "#{sql.sub(END_OF_STATEMENT_RE, '')} FORMAT #{format};"
       end
     end
   end

data/lib/click_house/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClickHouse
-  VERSION = '1.3.0'
+  VERSION = '1.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_house
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - Aliaksandr Shylau
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -129,10 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -158,6 +158,7 @@ files:
 - lib/click_house/extend/connectible.rb
 - lib/click_house/extend/connection_altering.rb
 - lib/click_house/extend/connection_database.rb
+- lib/click_house/extend/connection_explaining.rb
 - lib/click_house/extend/connection_healthy.rb
 - lib/click_house/extend/connection_inserting.rb
 - lib/click_house/extend/connection_selective.rb

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.6.5
-
-services:
-  - docker
-
-before_install:
-  - docker pull yandex/clickhouse-server
-  - docker run -d -p 127.0.0.1:8123:8123 yandex/clickhouse-server
-  - bundle install
-
-script:
-  - bundle exec rubocop
-  - bundle exec rspec