clickhouse 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ffb93716a6e9932f89d7d1942539402df85d1b0
-  data.tar.gz: 990fff529eb352d62076b01a2650a62242c9fb07
+  metadata.gz: acc4fd253999310d9bfa4038d1dddeddf60e9108
+  data.tar.gz: c03da9aecb9d94b1fffbc190df88a57c6ac49979
 SHA512:
-  metadata.gz: bca9c9ae26b8066ad10aae19b84b2c6c2c984125a7f9ed53299ff15b5ee9e1cec3cb4cef1733abb8515f51ee8a33f0dec61d9a03d7da36807f7935f980f9b761
-  data.tar.gz: e819b57c54e604df2810d7e2c7e55ae5c18087c959581dda41ebc378310f9d0365e31020e9ad35798413356b6a12be71fc3969fd9ab62a5307be73058c21ba30
+  metadata.gz: 93016aef4dd65ceb1c60a61c857a0f3bd2452e3476760f283d1c8374ed9b402d410e1e6d8e7c09216dc257adf8ba2d1cec4db7eadb9b9b8d283b3ea8b137606c
+  data.tar.gz: 248da8918613ba751cdf80db2667e8cb3b3a83f64b7e6973da57dfb80cfa76eb40647af4db0442aeec7984647f6a187c9857350418ee03313f6d5ea7ed1ece5f

data/.codeclimate.yml

@@ -0,0 +1,22 @@
+---
+engines:
+  csslint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  eslint:
+    enabled: true
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- lib/clickhouse/cli/
+- script/
+- test/

data/.travis.yml

@@ -1,5 +1,3 @@
 language: ruby
 rvm:
   - 2.3.1
-  - 2.1.2
-  - 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## Clickhouse CHANGELOG
 
+### Version 0.1.8 (November 6, 2016)
+
+* Fixed loading URLs in GUI
+
+### Version 0.1.7 (November 6, 2016) [YANKED]
+
+* Corrected interpolating nested patterns
+* Only upcasing whole (preserved) words
+
+### Version 0.1.6 (November 5, 2016) [YANKED]
+
+* Improved clickhouse console and server
+* Using Bundler >= 1.13.4
+* Changed cluster timeout to 5 seconds
+
+### Version 0.1.5 (November 4, 2016) [YANKED]
+
+* Added command line interface `clickhouse c`
+* Being able to start a Sinatra based Clickhouse client using `clickhouse s`
+* Using :debug to log queries
+
 ### Version 0.1.4 (October 25, 2016)
 
 * Ensured that Clickhouse does not modify the passed cluster config

data/README.md

@@ -1,6 +1,6 @@
 # Clickhouse [![Build Status](https://travis-ci.org/archan937/clickhouse.svg?branch=master)](https://travis-ci.org/archan937/clickhouse) [![Code Climate](https://codeclimate.com/github/archan937/clickhouse/badges/gpa.svg)](https://codeclimate.com/github/archan937/clickhouse) [![Test Coverage](https://codeclimate.com/github/archan937/clickhouse/badges/coverage.svg)](https://codeclimate.com/github/archan937/clickhouse/coverage) [![Gem](https://img.shields.io/gem/v/clickhouse.svg)](https://rubygems.org/gems/clickhouse) [![Gem](https://img.shields.io/gem/dt/clickhouse.svg)](https://rubygems.org/gems/clickhouse)
 
-A Ruby database driver for ClickHouse.
+A Ruby database driver for ClickHouse (also Clickhouse CLI and web GUI included).
 
 ## Introduction
 
@@ -179,6 +179,33 @@ If all the connections failed, it will just return `nil`.
 
 To see what more the `Clickhouse` gem has to offer, please take a look at the unit tests ( [test/unit/connection/test_query.rb](https://github.com/archan937/clickhouse/blob/master/test/unit/connection/test_query.rb) for instance).
 
+## Using the Sinatra-based browser GUI and Pry-based CLI
+
+As of `Clickhouse v0.1.7`, the gem is provided with both a Sinatra-based GUI and a Pry-based CLI. Starting either of them is very easy:
+
+* `clickhouse s localhost:8123` - (the `s` stands for server as we know from `rails s`)
+* `clickhouse c localhost:8123` - (the `c` stands for console as we know from `rails c`)
+
+Multiple connections should be passed comma separated:
+
+`clickhouse s https://myserver.com:8123,https://myserver.com:8124`
+
+Use `clickhouse help` to:
+
+```
+$ clickhouse help server
+Usage:
+  clickhouse server [HOSTS]
+
+Options:
+  -p, [--port=N]
+                             # Default: 1982
+  -u, [--username=USERNAME]
+  -P, [--password=PASSWORD]
+
+Start a Sinatra server as ClickHouse client (HOSTS should be comma separated URIs)
+```
+
 ## Using the console
 
 As you probably already noticed, the `Clickhouse` repo is provided with a `script/console` file which you can use for development / testing purposes. Please note that you need to have a ClickHouse server running.

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.8

data/bin/clickhouse

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "clickhouse/cli"
+
+begin
+  Clickhouse::CLI.start
+rescue Interrupt
+end

data/clickhouse.gemspec

@@ -4,8 +4,8 @@ require File.expand_path("../lib/clickhouse/version", __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Paul Engel"]
   gem.email         = ["pm_engel@icloud.com"]
-  gem.summary       = %q{A Ruby database driver for ClickHouse}
-  gem.description   = %q{A Ruby database driver for ClickHouse}
+  gem.summary       = %q{A Ruby database driver for ClickHouse (also Clickhouse CLI and web GUI included)}
+  gem.description   = %q{A Ruby database driver for ClickHouse (also Clickhouse CLI and web GUI included)}
   gem.homepage      = "https://github.com/archan937/clickhouse"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -14,9 +14,14 @@ Gem::Specification.new do |gem|
   gem.name          = "clickhouse"
   gem.require_paths = ["lib"]
   gem.version       = Clickhouse::VERSION
+  gem.licenses      = ["MIT"]
 
+  gem.add_dependency "bundler", ">= 1.13.4"
   gem.add_dependency "faraday"
   gem.add_dependency "pond"
+  gem.add_dependency "activesupport", ">= 4.1.8"
+  gem.add_dependency "thor"
+  gem.add_dependency "launchy"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "pry"

data/lib/clickhouse.rb

@@ -1,12 +1,17 @@
 require "uri"
 require "forwardable"
 require "csv"
+require "json"
 
 require "faraday"
 require "pond"
+require "active_support/dependencies/autoload"
+require "active_support/number_helper"
+require "active_support/core_ext/string/inflections"
 
 require "clickhouse/cluster"
 require "clickhouse/connection"
+require "clickhouse/utils"
 require "clickhouse/error"
 require "clickhouse/version"
 
@@ -37,12 +42,12 @@ module Clickhouse
     end
   end
 
-  def self.connect!(config)
+  def self.connect!(config = {})
     @connection = connect(config)
     @connection.connect!
   end
 
-  def self.connect(config)
+  def self.connect(config = {})
     klass = (config[:urls] || config["urls"]) ? Cluster : Connection
     klass.new(config)
   end

data/lib/clickhouse/cli.rb

@@ -0,0 +1,55 @@
+require "thor"
+require "launchy"
+require "clickhouse"
+
+module Clickhouse
+  class CLI < Thor
+
+    DEPENDENCIES = {:server => "sinatra"}
+    DEFAULT_URLS = "http://localhost:8123"
+
+    desc "server [HOSTS]", "Start a Sinatra server as ClickHouse client (HOSTS should be comma separated URIs)"
+    method_options [:port, "-p"] => 1982, [:username, "-u"] => :string, [:password, "-P"] => :string
+    def server(urls = DEFAULT_URLS)
+      run! :server, urls, options do
+        Launchy.open "http://localhost:#{options[:port]}"
+      end
+    end
+
+    desc "console [HOSTS]", "Start a Pry console as ClickHouse client (HOSTS should be comma separated URIs)"
+    method_options [:username, "-u"] => :string, [:password, "-P"] => :string
+    def console(urls = DEFAULT_URLS)
+      run! :console, urls, options
+    end
+
+    map "s" => :server
+    map "c" => :console
+
+  private
+
+    def run!(const, urls, options, &block)
+      require! DEPENDENCIES[const]
+      require_relative "cli/client"
+      require_relative "cli/#{const}"
+      connect! urls, options
+      self.class.const_get(const.to_s.capitalize).run!(:port => options["port"], &block)
+    end
+
+    def require!(name)
+      require(name) if name
+    rescue LoadError
+      puts "fatal: #{name.capitalize} not available. Please run `gem install #{name}` first."
+      exit!
+    end
+
+    def connect!(urls, options)
+      config = options.merge(:urls => urls.split(",")).inject({}){|h, (k, v)| h[k.to_sym] = v; h}
+      Clickhouse.establish_connection config
+    end
+
+    def method_missing(method, *_args)
+      raise Error, "Unrecognized command \"#{method}\". Please consult `clickhouse help`."
+    end
+
+  end
+end

data/lib/clickhouse/cli/client.rb

@@ -0,0 +1,149 @@
+module Clickhouse
+  class CLI < Thor
+    module Client
+
+      HISTORY_FILE = "#{ENV["HOME"]}/.clickhouse_history"
+
+      def self.included(base)
+        extended(base)
+      end
+
+      def self.extended(base)
+        Clickhouse.logger = self
+        load_history
+      end
+
+      def self.debug(message = nil)
+        @log = message.split("\n").detect{|line| line.include?("36m")}
+      end
+
+      def self.log
+        @log
+      end
+
+      def self.load_history
+        File.readlines(HISTORY_FILE).each do |line|
+          Readline::HISTORY.push line.gsub(";;", "\n").strip
+        end if File.exists?(HISTORY_FILE)
+      end
+
+      def alter_history(sql, current = true)
+        (Readline::HISTORY.to_a.count{|line| line[-1] != ";"} + (current ? 1 : 0)).times do
+          Readline::HISTORY.pop
+        end
+        unless Readline::HISTORY.to_a[-1] == sql
+          Readline::HISTORY.push(sql)
+        end
+      end
+
+      def dump_history
+        File.open(HISTORY_FILE, "w+") do |file|
+          Readline::HISTORY.each do |line|
+            file.puts line.strip.gsub("\n", ";;")
+          end
+        end
+      end
+
+      def prettify(sql)
+        sql, replaced = numerize_patterns(sql)
+
+        preserved_words = %w(
+          USE
+          SHOW
+          DATABASES
+          TABLES
+          PROCESSLIST
+          INSERT
+          INTO
+          FORMAT
+          SELECT
+          COUNT
+          DISTINCT
+          SAMPLE
+          AS
+          FROM
+          JOIN
+          UNION
+          ALL
+          PREWHERE
+          WHERE
+          AND
+          OR
+          NOT
+          IN
+          GROUP
+          BY
+          HAVING
+          ORDER
+          LIMIT
+          CREATE
+          DESCRIBE
+          ALTER
+          RENAME
+          DROP
+          DETACH
+          ATTACH
+          TABLE
+          VIEW
+          PARTITION
+          EXISTS
+          SET
+          OPTIMIZE
+          WITH
+          TOTALS
+        ).sort{|a, b| [b.size, a] <=> [a.size, b]}
+
+        sql.gsub!(/(\b)(#{preserved_words.join("|")})(\b)/i) do
+          "#{$1}#{$2.upcase}#{$3}"
+        end
+
+        interpolate_patterns(sql, replaced)
+      end
+
+      def numerize_patterns(sql, replaced = [])
+        sql = sql.gsub(/(["'])(?:(?=(\\?))\2.)*?\1/) do |match|
+          replaced << match
+          "${#{replaced.size - 1}}"
+        end
+
+        parenthesized = false
+
+        sql = sql.gsub(/\([^\(\)]*?\)/) do |match|
+          parenthesized = true
+          replaced << match
+          "%{#{replaced.size - 1}}"
+        end
+
+        parenthesized ? numerize_patterns(sql, replaced) : [sql, replaced]
+      end
+
+      def interpolate_patterns(sql, replaced)
+        matched = false
+
+        sql = sql.gsub(/(\$|%)\{(\d+)\}/) do |match|
+          matched = true
+          replaced[$2.to_i]
+        end
+
+        matched ? interpolate_patterns(sql, replaced) : sql
+      end
+
+      def execute(sql, &block)
+        if sql[-1] == ";"
+          dump_history
+          method = sql.match(/^(SELECT|SHOW|DESCRIBE)/i) ? :query : :execute
+          result = Clickhouse.connection.send(method, sql[0..-2])
+
+          if block_given?
+            block.call(result, Client.log)
+          else
+            process_result(result, Client.log)
+          end
+        else
+          sql
+        end
+      end
+
+    end
+  end
+end

data/lib/clickhouse/cli/console.rb

@@ -0,0 +1,73 @@
+require "readline"
+
+module Clickhouse
+  class CLI < Thor
+    module Console
+      extend self
+      extend Client
+
+      CLR = "\r\e[A\e[K"
+
+      def run!(options = {})
+        readline
+      end
+
+    # private
+
+      def readline(buffer = nil)
+        prompt = buffer ? ":-] " : ":) "
+        line = Readline.readline(prompt, true)
+
+        exit! unless line && !%w(exit quit).include?(line = line.strip)
+
+        line = prettify(line)
+        sql = [buffer, line].compact.join("\n").gsub(/\s+;$/, ";")
+
+        puts "#{CLR}#{prompt}#{line}"
+        alter_history(sql)
+
+        buffer = begin
+          execute(sql)
+        rescue Clickhouse::Error => e
+          puts "ERROR: #{e.message}"
+        end
+
+        readline buffer
+      end
+
+      def process_result(result, log)
+        if result.is_a?(Clickhouse::Connection::Query::ResultSet)
+          if result.size > 0
+            array = [result.names].concat(result.to_a)
+            lengths = array.inject([]) do |lengths, row|
+              row.each_with_index do |value, index|
+                length = value.to_s.strip.length
+                lengths[index] = [lengths[index].to_i, length].max
+              end
+              lengths
+            end
+            puts
+            array.each_with_index do |row, i|
+              values = [nil]
+              lengths.each_with_index do |length, index|
+                values << row[index].to_s.ljust(length, " ")
+              end
+              values << nil
+              separator = (i == 0) ? "+" : "|"
+              puts values.join(" #{separator} ")
+            end
+          end
+        else
+          puts result == true ? "Ok." : (result || "Fail.")
+        end
+
+        if log
+          puts
+          puts log.strip
+        end
+        puts
+      end
+
+    end
+  end
+end