tiny-presto 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5cfb9c0253ac7eb2b296b4a97710919baf69f42ecbd08f673969108aee898cc
-  data.tar.gz: bad87113c014874ca0d72220926238ae79991d38ce70493e05331328d982791c
+  metadata.gz: 5e2bdd215986246b63650c85c8d78eabd47e481fa51a665e0a22264f079e24af
+  data.tar.gz: 3e9d922298a4ff0e9ac6e1d9aaf4993cdad8cc680b5fa1985914d176d2985cdf
 SHA512:
-  metadata.gz: 220689da8fdb7a820f5b269b79138d159a7018a891755665b9aa5dbff8a224c318d7fb82194bd2e8b0c9bd1fcaabc9aa07eec202f50f909f9a83c85ed5ff2153
-  data.tar.gz: 117d7e38e73cf70147afd5fd4c102130bee28e244675330ea186bc93a759ecb4cb82031e8bf8858ce5f89e28293f5926454f242d94b1e49b50c0b294cbe0166f
+  metadata.gz: c99b29e972147490ac5fbe3d50b3ce870aff7dd368d77ccbdd73739c36ca7f593718e89b2fc9b56c583d6e8a5b51d90a4a9ae3630f7cf22417cb7c3dfc974390
+  data.tar.gz: 4946f97714fab4f02b9235f5f87c2c615d097d4770fa3762115a7a3c8ce023704c182002773d6253e1b384daf81d48813720ccd0711b90a3df3f4d37f47deb3b

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: test
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake spec

data/Gemfile

@@ -8,6 +8,7 @@ gem 'docker-api'
 gem 'presto-client'
 gem 'rake'
 gem 'rubocop'
+gem 'rdoc'
 
 group :development, :test do
   gem 'rspec'

data/Gemfile.lock

@@ -21,6 +21,7 @@ GEM
       msgpack (>= 0.7.0)
     rainbow (3.0.0)
     rake (13.0.1)
+    rdoc (6.2.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -51,6 +52,7 @@ DEPENDENCIES
   docker-api
   presto-client
   rake
+  rdoc
   rspec
   rubocop
 

data/README.md

@@ -1,4 +1,4 @@
-# tiny-presto
+# tiny-presto [![Actions Status](https://github.com/Lewuathe/tiny-presto/workflows/test/badge.svg)](https://github.com/Lewuathe/tiny-presto/actions) ![Gem](https://img.shields.io/gem/v/tiny-presto) ![Gem](https://img.shields.io/gem/dt/tiny-presto)
 
 Tiny [Presto](https://prestosql.io/) cluster to check the compatibility of query result by using the specific Presto version.
 
@@ -36,4 +36,10 @@ To check the result consistency, `verify` method is available.
 ```ruby
 result = TinyPresto.verify('show schemas', [["default"], ["information_schema"]])
 # result is true if the returned value by the query matched with the given expected result.
-```
+```
+
+To ensure to delete the tiny-presto cluster, make sure to call `ensure_stop` before exiting.
+
+```ruby
+TinyPresto.ensure_stop
+```

data/lib/tiny-presto.rb

@@ -5,6 +5,7 @@ require 'singleton'
 require 'presto-client'
 
 module TinyPresto
+  # Singleton object representing a Presto cluster running in the local machine.
   class TinyPresto
     include Singleton
 
@@ -19,7 +20,7 @@ module TinyPresto
         begin
           @client.run('show schemas')
           break
-        rescue StandardError => e
+        rescue StandardError => _
           # Waiting for the cluster is launched
           sleep(1)
         end
@@ -31,20 +32,23 @@ module TinyPresto
     end
   end
 
+  # Run the given SQL.
   def self.run(sql)
     presto = TinyPresto.instance
     _, rows = presto.client.run(sql)
     rows
   end
 
+  # Run the given SQL and verify the result.
   def self.verify(sql, expected_result)
     presto = TinyPresto.instance
     _, rows = presto.client.run(sql)
     rows == expected_result
   end
 
+  # Make sure to stop the cluster.
   def self.ensure_stop
     presto = TinyPresto.instance
     presto.stop
   end
-end
+end

data/lib/tiny-presto/cluster.rb

@@ -1,6 +1,8 @@
 require 'docker-api'
 
 module TinyPresto
+  # Represents a Presto cluster
+  #
   class Cluster
     def initialize(url, tag = 'latest')
       @url = url
@@ -8,6 +10,7 @@ module TinyPresto
       @image_name = "prestosql/presto:#{@tag}"
     end
 
+    # Launch Presto cluster running on Docker container
     def run
       # Ensure to pull the specified image
       Docker::Image.create('fromImage' => @image_name)
@@ -27,6 +30,7 @@ module TinyPresto
       @container
     end
 
+    # Kill Presto cluster process
     def stop
       @container.stop
     end

data/lib/tiny-presto/version.rb

@@ -1,3 +1,3 @@
 module TinyPresto
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny-presto
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kai Sasaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".pre-commit-config.yaml"
 - ".rubocop.yml"