clickhouse 0.1.4 → 0.1.8

data/lib/clickhouse/connection/query/result_set.rb

@@ -8,6 +8,8 @@ module Clickhouse
         def_delegators :@rows, :size, :empty?
         def_delegators :to_a, :first, :last, :flatten
 
+        attr_reader :names, :types
+
         def initialize(rows = [], names = nil, types = nil)
           @rows = rows
           @names = names

data/lib/clickhouse/utils.rb

@@ -0,0 +1,23 @@
+module Clickhouse
+  module Utils
+    extend self
+
+    def normalize_url(url)
+      if url.match(/^\w+:\/\//)
+        url
+      else
+        "#{Clickhouse::Connection::DEFAULT_CONFIG[:scheme]}://#{url}"
+      end
+    end
+
+    def extract_format(query)
+      format = nil
+      query = query.gsub(/ FORMAT (\w+)/i) do
+        format = $1
+        ""
+      end
+      [query.strip, format]
+    end
+
+  end
+end

data/lib/clickhouse/version.rb

@@ -1,7 +1,7 @@
 module Clickhouse
   MAJOR = 0
   MINOR = 1
-  TINY  = 4
+  TINY  = 8
 
   VERSION = [MAJOR, MINOR, TINY].join(".")
 end

data/test/unit/connection/test_client.rb

@@ -11,6 +11,8 @@ module Unit
       describe Clickhouse::Connection::Client do
         before do
           @connection = Connection.new
+          @connection.stubs(:parse_stats)
+          @connection.stubs(:write_log)
         end
 
         describe "#connect!" do
@@ -60,18 +62,18 @@ module Unit
         describe "#get" do
           it "sends a GET request the server" do
             @connection.instance_variable_set :@client, (client = mock)
-            client.expects(:get).with("/?query=foo", nil).returns(stub(:status => 200, :body => ""))
+            client.expects(:get).with("/?query=foo&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => ""))
             @connection.stubs(:log)
-            @connection.get(:foo)
+            @connection.get("foo")
           end
         end
 
         describe "#post" do
           it "sends a POST request the server" do
             @connection.instance_variable_set :@client, (client = mock)
-            client.expects(:post).with("/?query=foo", "body").returns(stub(:status => 200, :body => ""))
+            client.expects(:post).with("/?query=foo&output_format_write_statistics=1", "body").returns(stub(:status => 200, :body => ""))
             @connection.stubs(:log)
-            @connection.post(:foo, "body")
+            @connection.post("foo", "body")
           end
         end
 
@@ -89,14 +91,15 @@ module Unit
 
           it "queries the server returning the response" do
             @connection.instance_variable_set :@client, (client = mock)
-            client.expects(:get).with("/?query=SELECT+1", nil).returns(response = stub(:status => 200, :body => ""))
-            assert_equal response, @connection.send(:request, :get, "SELECT 1")
+            client.expects(:get).with("/?query=SELECT+1&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => ""))
+            @connection.expects(:parse_body).returns(data = mock)
+            assert_equal data, @connection.send(:request, :get, "SELECT 1")
           end
 
           describe "when not receiving status 200" do
             it "raises a Clickhouse::QueryError" do
               @connection.instance_variable_set :@client, (client = mock)
-              client.expects(:get).with("/?query=SELECT+1", nil).returns(stub(:status => 500, :body => ""))
+              client.expects(:get).with("/?query=SELECT+1&output_format_write_statistics=1", nil).returns(stub(:status => 500, :body => ""))
               assert_raises Clickhouse::QueryError do
                 @connection.send(:request, :get, "SELECT 1")
               end
@@ -112,16 +115,25 @@ module Unit
               end
             end
           end
+
+          it "parses the body" do
+            json = <<-JSON
+              {"meta": []}
+            JSON
+            @connection.instance_variable_set :@client, (client = mock)
+            client.expects(:get).with("/?query=SELECT+1+FORMAT+JSONCompact&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => json))
+            assert_equal({"meta" => []}, @connection.send(:request, :get, "SELECT 1 FORMAT JSONCompact"))
+          end
         end
 
         describe "configuration" do
           describe "database" do
             it "includes the database in the querystring" do
-              @connection.expects(:log)
               @connection.instance_variable_get(:@config)[:database] = "system"
               @connection.instance_variable_set(:@client, (client = mock))
-              client.expects(:get).with("/?database=system&query=SELECT+1", nil).returns(response = stub(:status => 200, :body => ""))
-              assert_equal response, @connection.send(:request, :get, "SELECT 1")
+              client.expects(:get).with("/?database=system&query=SELECT+1&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => ""))
+              @connection.expects(:parse_body).returns(data = mock)
+              assert_equal data, @connection.send(:request, :get, "SELECT 1")
             end
           end
 
@@ -134,6 +146,59 @@ module Unit
             end
           end
         end
+
+        describe "statistics" do
+          before do
+            @connection = Connection.new
+            @json = <<-JSON
+              {
+                "rows": 1947,
+                "statistics": {
+                  "elapsed": 0.1882,
+                  "rows_read": 1982,
+                  "bytes_read": 2003
+                }
+              }
+            JSON
+          end
+
+          it "parses the statistics" do
+            @connection.stubs(:log)
+            @connection.instance_variable_set :@client, (client = mock)
+            Time.expects(:now).returns(1882).twice
+
+            client.expects(:get).with("/?query=SELECT+1+FORMAT+JSONCompact&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => @json))
+            @connection.expects(:write_log).with(
+              0, "SELECT 1", {
+                "elapsed" => "188.2ms",
+                "rows_read" => "1.98 thousand",
+                "bytes_read" => 2003,
+                "rows" => 1947,
+                "rows_per_second" => "10.53 thousand",
+                "data_per_second" => "10.39 KB",
+                "data_read" => "1.96 KB"
+              }
+            )
+            @connection.send(:request, :get, "SELECT 1 FORMAT JSONCompact")
+          end
+
+          it "write the expected logs" do
+            @connection.instance_variable_set :@client, (client = mock)
+            Time.expects(:now).returns(1882).twice
+
+            client.expects(:get).with("/?query=SELECT+1+FORMAT+JSONCompact&output_format_write_statistics=1", nil).returns(stub(:status => 200, :body => @json))
+            log = "\n \e[1m\e[35mSQL (0.0ms)\e\e[0m  SELECT 1;\e\n  \e[1m\e[36m1947 rows in set. Elapsed: 188.2ms. Processed: 1.98 thousand rows, 1.96 KB (10.53 thousand rows/s, 10.39 KB/s)\e[0m "
+
+            @connection.expects(:log).with(:debug, log)
+            @connection.send(:request, :get, "SELECT 1 FORMAT JSONCompact")
+          end
+
+          describe "#number_to_human_duration" do
+            it "returns in seconds when more than 1 seconds" do
+              assert_equal "2.0s", @connection.send(:number_to_human_duration, 2)
+            end
+          end
+        end
       end
 
     end

data/test/unit/connection/test_cluster.rb

@@ -13,7 +13,7 @@ module Unit
         it "does not modify the passed config" do
           config = {:urls => %w(localhost:1234 localhost:1235 localhost:1236)}
           Clickhouse::Cluster.new config
-          assert_equal({:urls => %w(localhost:1234 localhost:1235 localhost:1236)}, config)
+          assert_equal({:urls => %w(http://localhost:1234 http://localhost:1235 http://localhost:1236)}, config)
         end
 
         describe "when connection succeeds" do

data/test/unit/connection/test_logger.rb

@@ -16,15 +16,15 @@ module Unit
         describe "#log" do
           describe "when having specified a logger" do
             it "delegates to logger" do
-              (logger = mock).expects(:info, "Hello world!")
+              (logger = mock).expects(:debug, "Hello world!")
               Clickhouse.expects(:logger).returns(logger).twice
-              @connection.send(:log, :info, "Hello world!")
+              @connection.send(:log, :debug, "Hello world!")
             end
           end
 
           describe "when not having specified a logger" do
             it "does nothing" do
-              assert_nil @connection.send(:log, :info, "Boo!")
+              assert_nil @connection.send(:log, :debug, "Boo!")
             end
           end
         end

data/test/unit/connection/test_query.rb

@@ -12,17 +12,19 @@ module Unit
       describe Clickhouse::Connection::Query do
         before do
           @connection = Connection.new
+          @connection.stubs(:parse_stats)
+          @connection.stubs(:write_log)
         end
 
         describe "#execute" do
           it "sends a POST request" do
-            @connection.expects(:post).with("sql", nil).returns(stub(:status => 200, :body => ""))
+            @connection.expects(:post).with("sql", nil).returns("")
             assert_equal true, @connection.execute("sql")
           end
 
           describe "when server returns a non-empty body" do
             it "returns the body of the response" do
-              @connection.expects(:post).with("sql", "body").returns(stub(:status => 200, :body => "Ok."))
+              @connection.expects(:post).with("sql", "body").returns("Ok.")
               assert_equal "Ok.", @connection.execute("sql", "body")
             end
           end
@@ -30,24 +32,24 @@ module Unit
 
         describe "#query" do
           it "sends a GET request requesting a TSV response including names and types" do
-            @connection.expects(:get).with("sql FORMAT JSONCompact").returns(stub(:status => 200, :body => ""))
-            @connection.stubs(:parse_response)
+            @connection.expects(:get).with("sql FORMAT JSONCompact")
+            @connection.stubs(:parse_data)
             assert_equal [], @connection.query("sql").to_a
           end
         end
 
         describe "#databases" do
           it "sends a 'SHOW DATABASES' query" do
-            @connection.expects(:get).with("SHOW DATABASES FORMAT JSONCompact").returns(stub(:status => 200, :body => "{}"))
-            @connection.stubs(:parse_response).returns([])
-            @connection.databases
+            @connection.expects(:get).with("SHOW DATABASES FORMAT JSONCompact")
+            @connection.stubs(:parse_data).returns([])
+            assert_equal [], @connection.databases
           end
         end
 
         describe "#tables" do
           it "sends a 'SHOW TABLES' query" do
-            @connection.expects(:get).with("SHOW TABLES FORMAT JSONCompact").returns(stub(:status => 200, :body => "{}"))
-            @connection.stubs(:parse_response).returns([])
+            @connection.expects(:get).with("SHOW TABLES FORMAT JSONCompact")
+            @connection.stubs(:parse_data).returns([])
             @connection.tables
           end
         end
@@ -65,7 +67,7 @@ CREATE TABLE logs_test (
 )
 ENGINE = MergeTree(date, 8192)
             SQL
-            @connection.expects(:post).with(sql.strip, nil).returns(stub(:status => 200, :body => ""))
+            @connection.expects(:post).with(sql.strip, nil).returns("")
             @connection.create_table("logs_test") do |t|
               t.uint8        :id
               t.float32      :price
@@ -80,8 +82,8 @@ ENGINE = MergeTree(date, 8192)
 
         describe "#describe_table" do
           it "sends a 'DESCRIBE TABLE <name>' query" do
-            @connection.expects(:get).with("DESCRIBE TABLE logs FORMAT JSONCompact").returns(stub(:status => 200, :body => ""))
-            @connection.stubs(:parse_response)
+            @connection.expects(:get).with("DESCRIBE TABLE logs FORMAT JSONCompact")
+            @connection.stubs(:parse_data)
             @connection.describe_table("logs")
           end
         end
@@ -89,7 +91,7 @@ ENGINE = MergeTree(date, 8192)
         describe "#rename_table" do
           describe "when passing an array with an even number of names" do
             it "sends a POST request containing a RENAME TABLE statement" do
-              @connection.expects(:post).with("RENAME TABLE foo TO bar, baz TO qux", nil).returns(stub(:status => 200, :body => "")).twice
+              @connection.expects(:post).with("RENAME TABLE foo TO bar, baz TO qux", nil).returns("").twice
               assert_equal true, @connection.rename_table("foo", "bar", "baz", "qux")
               assert_equal true, @connection.rename_table(["foo", "bar"], ["baz", "qux"])
             end
@@ -108,7 +110,7 @@ ENGINE = MergeTree(date, 8192)
 
           describe "when passing a hash" do
             it "sends a POST request containing a RENAME TABLE statement" do
-              @connection.expects(:post).with("RENAME TABLE foo TO bar, baz TO qux", nil).returns(stub(:status => 200, :body => ""))
+              @connection.expects(:post).with("RENAME TABLE foo TO bar, baz TO qux", nil).returns("")
               assert_equal true, @connection.rename_table(:foo => "bar", :baz => "qux")
             end
           end
@@ -116,7 +118,7 @@ ENGINE = MergeTree(date, 8192)
 
         describe "#drop_table" do
           it "sends a POST request containing a 'DROP TABLE' statement" do
-            @connection.expects(:post).with("DROP TABLE logs", nil).returns(stub(:status => 200, :body => ""))
+            @connection.expects(:post).with("DROP TABLE logs", nil).returns("")
             assert_equal true, @connection.drop_table("logs")
           end
         end
@@ -133,7 +135,7 @@ ENGINE = MergeTree(date, 8192)
 
           describe "when using hashes" do
             it "sends a POST request containing a 'INSERT INTO' statement using CSV" do
-              @connection.expects(:post).with("INSERT INTO logs FORMAT CSVWithNames", @csv).returns(stub(:status => 200, :body => ""))
+              @connection.expects(:post).with("INSERT INTO logs FORMAT CSVWithNames", @csv).returns("")
               assert_equal true, @connection.insert_rows("logs") { |rows|
                 rows << {:id => 12345, :first_name => "Paul", :last_name => "Engel"}
                 rows << {:id => 67890, :first_name => "Bruce", :last_name => "Wayne"}
@@ -143,7 +145,7 @@ ENGINE = MergeTree(date, 8192)
 
           describe "when using arrays" do
             it "sends a POST request containing a 'INSERT INTO' statement using CSV" do
-              @connection.expects(:post).with("INSERT INTO logs FORMAT CSVWithNames", @csv).returns(stub(:status => 200, :body => ""))
+              @connection.expects(:post).with("INSERT INTO logs FORMAT CSVWithNames", @csv).returns("")
               assert_equal true, @connection.insert_rows("logs", :names => %w(id first_name last_name)) { |rows|
                 rows << [12345, "Paul", "Engel"]
                 rows << [67890, "Bruce", "Wayne"]
@@ -167,8 +169,8 @@ ENGINE = MergeTree(date, 8192)
               }
             JAVASCRIPT
 
-            @connection.expects(:to_select_query).with(options = {:from => "logs"})
-            @connection.expects(:get).returns(stub(:body => body))
+            @connection.expects(:to_select_query).with(options = {:from => "logs"}).returns("")
+            @connection.expects(:get).returns(JSON.parse(body))
 
             assert_equal [
               [1982, "Paul"],
@@ -187,9 +189,9 @@ ENGINE = MergeTree(date, 8192)
         describe "#select_values" do
           describe "when empty result set" do
             it "returns an empty array" do
-              @connection.expects(:to_select_query)
+              @connection.expects(:to_select_query).returns("")
               @connection.expects(:get).returns(stub(:body => ""))
-              @connection.stubs(:parse_response).returns([])
+              @connection.stubs(:parse_data).returns([])
               assert_equal [], @connection.select_values({})
             end
           end
@@ -209,8 +211,8 @@ ENGINE = MergeTree(date, 8192)
                 }
               JAVASCRIPT
 
-              @connection.expects(:to_select_query)
-              @connection.expects(:get).returns(stub(:body => body))
+              @connection.expects(:to_select_query).returns("")
+              @connection.expects(:get).returns(JSON.parse(body))
               assert_equal [
                 1982,
                 1947

data/test/unit/test_utils.rb

@@ -0,0 +1,39 @@
+require_relative "../test_helper"
+
+module Unit
+  class TestUtils < MiniTest::Test
+
+    describe Clickhouse::Utils do
+      describe ".normalize_url" do
+        describe "when passing scheme" do
+          it "returns the passed url" do
+            assert_equal "paul://engel", Clickhouse::Utils.normalize_url("paul://engel")
+          end
+        end
+
+        describe "when not passing scheme" do
+          it "prepends the default scheme" do
+            assert_equal "http://engel", Clickhouse::Utils.normalize_url("engel")
+          end
+        end
+      end
+
+      describe ".extract_format" do
+        describe "when not having a format" do
+          it "returns the query and nil as format" do
+            assert_equal ["SELECT 1", nil], Clickhouse::Utils.extract_format("SELECT 1")
+          end
+        end
+
+        it "strips the query" do
+          assert_equal ["SELECT 1", nil], Clickhouse::Utils.extract_format("SELECT 1     ")
+        end
+
+        it "extracts the format from the query" do
+          assert_equal ["SELECT 1", "SomeFormat"], Clickhouse::Utils.extract_format("SELECT 1 FORMAT SomeFormat")
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Paul Engel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.4
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,13 +192,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby database driver for ClickHouse
+description: A Ruby database driver for ClickHouse (also Clickhouse CLI and web GUI
+  included)
 email:
 - pm_engel@icloud.com
-executables: []
+executables:
+- clickhouse
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -151,8 +210,25 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/clickhouse
 - clickhouse.gemspec
 - lib/clickhouse.rb
+- lib/clickhouse/cli.rb
+- lib/clickhouse/cli/client.rb
+- lib/clickhouse/cli/console.rb
+- lib/clickhouse/cli/server.rb
+- lib/clickhouse/cli/server/assets/css/clickhouse.css
+- lib/clickhouse/cli/server/assets/css/codemirror.css
+- lib/clickhouse/cli/server/assets/css/datatables.css
+- lib/clickhouse/cli/server/assets/css/normalize.css
+- lib/clickhouse/cli/server/assets/css/skeleton.css
+- lib/clickhouse/cli/server/assets/js/clickhouse.js
+- lib/clickhouse/cli/server/assets/js/codemirror.js
+- lib/clickhouse/cli/server/assets/js/datatables.js
+- lib/clickhouse/cli/server/assets/js/disableswipeback.js
+- lib/clickhouse/cli/server/assets/js/jquery.js
+- lib/clickhouse/cli/server/assets/js/sql.js
+- lib/clickhouse/cli/server/views/index.erb
 - lib/clickhouse/cluster.rb
 - lib/clickhouse/connection.rb
 - lib/clickhouse/connection/client.rb
@@ -162,6 +238,7 @@ files:
 - lib/clickhouse/connection/query/result_set.rb
 - lib/clickhouse/connection/query/table.rb
 - lib/clickhouse/error.rb
+- lib/clickhouse/utils.rb
 - lib/clickhouse/version.rb
 - script/console
 - test/test_helper.rb
@@ -177,8 +254,10 @@ files:
 - test/unit/connection/test_query.rb
 - test/unit/test_clickhouse.rb
 - test/unit/test_connection.rb
+- test/unit/test_utils.rb
 homepage: https://github.com/archan937/clickhouse
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -199,7 +278,7 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby database driver for ClickHouse
+summary: A Ruby database driver for ClickHouse (also Clickhouse CLI and web GUI included)
 test_files:
 - test/test_helper.rb
 - test/test_helper/coverage.rb
@@ -214,3 +293,4 @@ test_files:
 - test/unit/connection/test_query.rb
 - test/unit/test_clickhouse.rb
 - test/unit/test_connection.rb
+- test/unit/test_utils.rb