click_house 1.3.4 → 1.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55de5fd75c50aca5227537365eca6c1042bdff12833c8803f66b1022b6bbefd4
-  data.tar.gz: 101d57eeb3a903a9b95a9955a0ac093c80796ef5fc6163837d49fc7fc64464b2
+  metadata.gz: a840e675477999a80f7ceee3f2364df83fc0efcc4ee4d0e16212dba1bb495acf
+  data.tar.gz: 1d8ad01d6dc2e1720c0d499f2f7168cdf83018151bc24dbbe1f8a8244da1d5ee
 SHA512:
-  metadata.gz: 860b3f17e95893e7cdd0d43c37ca42557492b7e44b8e0c61d326a8d83c9211a942775131d5a4705d53b6cdab3dc8acd716b5c2d629e7f95f9f95c74b9310398f
-  data.tar.gz: dc0fd575a9b1c22ae571fda8edb639a8d16df3ddb6497b97b63b3886933b8904e9d94a97f0f8b17619b4c4dca987282265a3002833c3318775e74d201c6f23fa
+  metadata.gz: 76172279bdf916f3b1ff68e55ad576a3e05a5651e47e22547a20b8d87159b7920edc72c5bb8b449833d50409c30738dc4374259df7096af53a99141e8d67c9d5
+  data.tar.gz: 5542180b24e7d7e7b747cfd09eca9a999371b26b0013d783ef1fa888623eb6854803e38286aa3f0fb3893b158ffed6977ea92aa089c91f25523f0882a99b514e

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.12.3.3
+        ports: 
+          - 8123:8123
+
+    strategy:
+      matrix:
+        ruby-version: [2.7, 2.6, 2.5, 2.4]
+
+    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
 
@@ -36,6 +36,16 @@ 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:
@@ -44,8 +54,6 @@ Metrics/BlockLength:
   Enabled: true
 Metrics/MethodLength:
   Max: 25
-Metrics/LineLength:
-  Max: 140
 Metrics/AbcSize:
   Max: 40
 
@@ -63,6 +71,8 @@ Naming/AccessorMethodName:
   Enabled: false
 
 # ============================== Layout =============================
+Layout/LineLength:
+  Max: 140
 Layout/HashAlignment:
   EnforcedHashRocketStyle: key
   EnforcedColonStyle: key
@@ -193,6 +203,20 @@ 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:
@@ -247,3 +271,19 @@ 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,6 +1,23 @@
+# 1.3.9
+* add `ClickHouse.connection.add_index`, `ClickHouse.connection.drop_index`
+
+# 1.3.8
+* fix `DateTime` casting for queries like `ClickHouse.connection.select_value('select NOW()')` 
+* fix resulting set console inspection
+
+# 1.3.7
+* specify required ruby version [#10](https://github.com/shlima/click_house/issues/10)
+
+# 1.3.6
+* fix ruby 2.7 warning `maybe ** should be added to the call` on `ClickHouse.connection.databases`
+
+# 1.3.5
+* added `ClickHouse.connection.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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    click_house (1.3.4)
+    click_house (1.3.9)
       faraday
       faraday_middleware
 
@@ -18,42 +18,42 @@ GEM
       faraday (~> 1.0)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    parallel (1.19.2)
+    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.8.2)
+    rake (13.0.3)
+    regexp_parser (2.0.1)
     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.3)
-      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.93.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.6.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.8.0)
+    rubocop-ast (1.3.0)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.8.1)
-      rubocop (>= 0.87.0)
+    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)

data/README.md

@@ -2,12 +2,11 @@
 
 # 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 Ruby >= 2.5
 gem install click_house
 ```
 
@@ -105,6 +104,13 @@ 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.add_index('table', 'ix', 'has(b, a)', type: 'minmax', granularity: 2, cluster: nil)
+ClickHouse.connection.drop_index('table', 'ix', 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
@@ -399,6 +405,10 @@ development:
 test:
   database: ecliptic_test
   <<: *default
+  
+production:
+  <<: *default
+  database: ecliptic_production
 ```
 
 ```ruby
@@ -489,6 +499,10 @@ class ClickHouseRecord < ActiveRecord::Base
     def select_all
       agent.select_all(current_scope.to_sql)
     end
+
+    def explain
+      agent.explain(current_scope.to_sql)
+    end
   end
 end
 ````

data/click_house.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Modern Ruby database driver for ClickHouse'
   spec.description   = 'Yandex ClickHouse database interface for Ruby'
   spec.homepage      = 'https://github.com/shlima/click_house'
+  spec.required_ruby_version = '>= 2.4.0'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/docker-compose.yml

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

data/lib/click_house.rb

@@ -34,7 +34,7 @@ module ClickHouse
     add_type column, Type::StringType.new
   end
 
-  ['DateTime(%s)'].each do |column|
+  %w[DateTime DateTime(%s)].each do |column|
     add_type column, Type::DateTimeType.new
   end
 

data/lib/click_house/config.rb

@@ -2,10 +2,6 @@
 
 module ClickHouse
   class Config
-    DEFAULT_SCHEME = 'http'
-    DEFAULT_HOST = 'localhost'
-    DEFAULT_PORT = '8123'
-
     DEFAULTS = {
       adapter: Faraday.default_adapter,
       url: nil,

data/lib/click_house/connection.rb

@@ -8,6 +8,7 @@ module ClickHouse
     include Extend::ConnectionSelective
     include Extend::ConnectionInserting
     include Extend::ConnectionAltering
+    include Extend::ConnectionExplaining
 
     attr_reader :config
 

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_altering.rb

@@ -66,6 +66,33 @@ module ClickHouse
 
         execute(format(template, pattern)).success?
       end
+
+      def add_index(
+        table_name,
+        name,
+        expression,
+        type:,
+        granularity: nil,
+        after: nil,
+        cluster: nil
+      )
+        template = 'ADD INDEX %<name>s %<expression>s TYPE %<type>s GRANULARITY %<granularity>d %<after>s'
+        pattern = {
+          name: name,
+          expression: expression,
+          type: type,
+          granularity: granularity,
+          after: Util::Statement.ensure(after, "AFTER #{after}"),
+        }
+
+        alter_table(table_name, format(template, pattern), cluster: cluster)
+      end
+
+      def drop_index(table_name, name, cluster: nil)
+        alter_table(table_name, <<~SQL, cluster: cluster)
+          DROP INDEX #{name}
+        SQL
+      end
     end
   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

@@ -4,6 +4,7 @@ module ClickHouse
   module Extend
     module TypeDefinition
       NULLABLE = 'Nullable'
+      NULLABLE_RE = /#{NULLABLE}/i.freeze
 
       def types
         @types ||= Hash.new(Type::UndefinedType.new)
@@ -16,7 +17,7 @@ module ClickHouse
 
       # @return [Enum<String>]
       def type_names(nullable:)
-        nullable ? types.keys : types.keys.grep_v(/#{NULLABLE}/i)
+        nullable ? types.keys : types.keys.grep_v(NULLABLE_RE)
       end
     end
   end

data/lib/click_house/middleware/parse_csv.rb

@@ -10,7 +10,7 @@ module ClickHouse
       end
 
       define_parser do |body, parser_options|
-        CSV.parse(body, parser_options || {}) unless body.strip.empty?
+        CSV.parse(body, **Hash.new(parser_options)) unless body.strip.empty?
       end
     end
   end

data/lib/click_house/response/result_set.rb

@@ -8,9 +8,11 @@ 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
+                     :inspect, :each, :fetch, :length, :count, :size,
+                     :first, :last, :[], :to_h
 
       attr_reader :meta, :data, :statistics
 
@@ -28,7 +30,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 = []
 
@@ -71,10 +73,6 @@ module ClickHouse
           }
         end
       end
-
-      def inspect
-        to_a
-      end
     end
   end
 end

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.4'
+  VERSION = '1.3.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_house
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.9
 platform: ruby
 authors:
 - Aliaksandr Shylau
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2020-12-21 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
@@ -202,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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