clickhouse-rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7f0fc0991b11eab9bacb6ae43c87f5cbefefe1bdb35144fdb599753017e884a
-  data.tar.gz: df7b20d8b908a66ee5622025a3f3407a5902d502eb9f56b25869732571403a75
+  metadata.gz: fb4718899c50eee5d790b88331caa67e07cdc38eac66ea865aeee62401db37b0
+  data.tar.gz: 15b86279df212a677bccf8437d1e4e52715fb0e515b3b8fcaaf8a5cad3bcd9d0
 SHA512:
-  metadata.gz: 1bcfb1c9b9ca2a208ad148cdf0ace5b951d26bd09d79d2c7b92ab2570493c90da886cfac9d5b8568d16373f23c1cc50d0af536e0e2bcb7e906e1a7331fb777f8
-  data.tar.gz: e230acf543be8220bfbd0ce150e1831f65a9e59bb9d13efb1d1feab48f0f3a590fbf80b21d7f33213d6abebd4f5c2cee4476c73fb7c7fb0535791336b8dba936
+  metadata.gz: 887ed3d0538f74d8ea648445d04fcb1d941ee2009a8baf5ad05ff3c4783c9dd2f63b08d4f96b8a41578c8d0016e1799df2bfb5a3d7252ff1788fb0b86a5aebf1
+  data.tar.gz: 2d2dc371a8fa84e164505913a6151dd479d82918ec8b54f4b7b042cee8432e0993d3371109097b65008de0694bcce10a9d28099caf22eb0d531e0984d4823927

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clickhouse-rails (0.1.0)
+    clickhouse-rails (0.1.1)
       clickhouse
       railties
 

data/README.md

@@ -22,13 +22,15 @@ $ rails g clickhouse:install
 
 4. Change clickhouse.yml at `config/clickhouse.yml` path
 
-5. Create migrations
+## Usage
+
+1. Create migrations
 ```bash
 $ rails g clickhouse:migration add_tmp_table
       create  db/clickhouse/migrate/002_add_tmp_table.rb
 ```
 
-6. Edit file like this:
+2. Edit file like this:
 ```ruby
 # db/clickhouse/migrate/002_add_tmp_table.rb
 class AddTmpTable < Clickhouse::Rails::Migrations::Base
@@ -43,6 +45,19 @@ class AddTmpTable < Clickhouse::Rails::Migrations::Base
 end
 ```
 
+3. Run migrations
+```bash
+$ rake clickhouse:db:migrate
+```
+
+You can create class of clickhouse table:
+```
+# app/models/custom_table.rb
+class CustomTable
+  include Clickhouse::Table
+end
+```
+
 ## TODO:
 
 1. Rollback migrations

data/lib/clickhouse-rails.rb

@@ -1,2 +1,3 @@
 require 'clickhouse'
+require 'clickhouse/table'
 require 'clickhouse/rails'

data/lib/clickhouse/rails/migrations/base.rb

@@ -68,30 +68,32 @@ module Clickhouse
           def fetch_column(column, type)
             return if @table_info.find { |c_info| c_info.first == column.to_s }
 
-            type = type.to_s
-                       .gsub(/(^.|_\w)/) do
+            type = type.to_s.gsub(/(^.|_\w)/) do
               Regexp.last_match(1).upcase
             end
-                       .gsub('Uint', 'UInt')
-                       .delete('_')
+            type = type.gsub('Uint', 'UInt').delete('_')
 
             connection.execute("ALTER TABLE #{@table_name} ADD COLUMN #{column} #{type}")
           end
 
           def run_migration(migration)
-            puts "# >========== #{migration.name} ==========="
+            logger.info "# >========== #{migration.name} ==========="
             migration.up
             migration.add_version
           rescue Clickhouse::QueryError => e
-            puts "# Error #{e.class}:"
-            puts "#  #{e.message}"
+            logger.info "# Error #{e.class}:"
+            logger.info "#  #{e.message}"
           ensure
-            puts "# <========== #{migration.name} ===========\n\n"
+            logger.info "# <========== #{migration.name} ===========\n\n"
           end
 
           def connection
             Clickhouse.connection
           end
+
+          def logger
+            ::Rails.logger
+          end
         end
       end
     end

data/lib/clickhouse/rails/version.rb

@@ -1,5 +1,5 @@
 module Clickhouse
   module Rails
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

data/lib/clickhouse/table.rb

@@ -0,0 +1,66 @@
+module Clickhouse
+  module Table
+    class WrongTypeRowError < StandardError; end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def table_name
+        @table_name ||= to_s.tableize
+      end
+
+      def insert_rows(rows)
+        connection.insert_rows(table_name) do |table_rows|
+          rows.each do |row|
+            next if row.nil?
+
+            complete_row = prepare_row(block_given? ? yield(row) : row)
+
+            table_rows << complete_row
+          end
+
+          table_rows
+        end
+      end
+
+      def table_columns
+        @table_columns ||=
+          connection.select_rows(
+            select: 'name, type',
+            from: 'system.columns',
+            where: "table = '#{table_name}'"
+          ).to_h
+      end
+
+      def rows(attributes = {})
+        connection.select_rows(attributes.merge(from: table_name))
+      end
+
+      def empty_row
+        @empty_row ||= table_columns.map do |k, v|
+          value =
+            case v
+            when /UInt/ then 0
+            when /Float/ then 0.0
+            else
+              ''
+            end
+
+          [k, value]
+        end.to_h
+      end
+
+      def prepare_row(row)
+        return empty_row.merge(row.stringify_keys) if row.is_a?(Hash)
+
+        raise WrongTypeRowError, "#{row.inspect} has wrong type"
+      end
+
+      def connection
+        ::Clickhouse.connection
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -5,7 +5,6 @@ SimpleCov.start
 
 require 'codecov'
 SimpleCov.formatter = SimpleCov::Formatter::Codecov
-
 require 'rails'
 require 'action_view/railtie'
 require 'action_controller/railtie'
@@ -16,3 +15,6 @@ require 'ammeter/init'
 require_relative '../lib/clickhouse-rails'
 require_relative 'support/generators'
 require_relative 'support/init'
+require_relative 'support/migration'
+
+Rails.logger = Logger.new('/dev/null')

data/spec/support/migration.rb

@@ -0,0 +1,4 @@
+def with_table(table_name, &block)
+  Clickhouse::Rails::Migrations::Base.soft_drop_table(table_name)
+  Clickhouse::Rails::Migrations::Base.create_table(table_name, &block)
+end

data/spec/table_spec.rb

@@ -0,0 +1,57 @@
+require_relative 'rails_helper'
+
+class CustomTable
+  include Clickhouse::Table
+end
+
+describe Clickhouse::Table do
+  before do
+    with_table 'custom_tables' do |t|
+      t.string 'field'
+
+      t.engine 'File(TabSeparated)'
+    end
+  end
+
+  describe '#table_columns' do
+    subject(:method) { CustomTable.table_columns }
+
+    it 'returns all info' do
+      is_expected.to eq('field' => 'String')
+    end
+  end
+
+  describe '#insert_rows' do
+    let(:inserted_rows) { CustomTable.rows.to_a }
+
+    context 'when row is a hash' do
+      let(:rows) { [{ 'field' => 'a' }, { 'field' => 2 }] }
+
+      it 'adds two rows' do
+        CustomTable.insert_rows(rows)
+
+        expect(inserted_rows).to eq([['a'], ['2']])
+      end
+    end
+
+    context 'when row is an array' do
+      # TODO: implement array logic
+      let(:rows) { [['a'], ['2']] }
+
+      it 'raises an error' do
+        expect { CustomTable.insert_rows(rows) }
+          .to raise_error(Clickhouse::Table::WrongTypeRowError)
+      end
+    end
+
+    context 'when row has empty attributes' do
+      let(:rows) { [{}] }
+
+      it 'adds empty row' do
+        CustomTable.insert_rows(rows)
+
+        expect(inserted_rows).to eq([['']])
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Vsevolod Avramov
@@ -103,6 +103,7 @@ files:
 - lib/clickhouse/rails/config.rb
 - lib/clickhouse/rails/migrations/base.rb
 - lib/clickhouse/rails/version.rb
+- lib/clickhouse/table.rb
 - lib/generators/clickhouse/install/install_generator.rb
 - lib/generators/clickhouse/install/templates/config/clickhouse.yml
 - lib/generators/clickhouse/install/templates/db/clickhouse/migrate/001_init.rb
@@ -119,6 +120,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/generators.rb
 - spec/support/init.rb
+- spec/support/migration.rb
+- spec/table_spec.rb
 homepage: https://github.com/vsevolod/clickhouse-rails
 licenses:
 - MIT