shinq 0.8.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 01d64906303f1f93f1c58963b07d97b8d5f63ac7
-  data.tar.gz: 478a6b80464b1b399c19da69a8e37f4dc8dd7fbd
+SHA256:
+  metadata.gz: c0cdad6cb88d95c3f54ef38ac64b7db0314850912693d9f87eae2d88c59c11be
+  data.tar.gz: aed02806856d77fda982ae5d2039be2bf4558f32e7732a6d3681299fc25aac26
 SHA512:
-  metadata.gz: b165ea04629a8dd68d9e2ea480a27cdd663d69530562721cc726e8ce360a86d61188b031dde01c7da7fbd35d8a639cd2d63441f39e947563043206ff3c82a077
-  data.tar.gz: 7d8bef34453211d6e7e9bf6abc1ba19c881b7a42552dc76146d65d6e96bff947d090eeb68929e58c229a2998126fbb670a95adef3416f6e304f3aee5c5f20f5e
+  metadata.gz: 7f8e92ee4d147158524f66aa2d1bfb596abe66c0dddf49924d1e642a379f8ae30075127cee711dc535da8c97305025a983753802ead7b5f11eebccda399522f7
+  data.tar.gz: 45ee3dcf8f20c696c078cb2db67475da5aa66160f1699b0db03108540a42cf641595f05ebd529e5110a9972e61710b7e9644e9881d74e2ffd799618a5cef3207

data/.travis.yml

@@ -3,14 +3,14 @@ sudo: false
 cache: bundler
 rvm:
   - 2.1
-  - 2.2.0
-  - 2.2.1
-  - 2.2.2
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.6
+  - 2.7
 gemfile:
   - Gemfile
 before_install:
+  - gem update bundler
   - mysql -e "create database IF NOT EXISTS shinq_test;" -uroot
 script: bundle exec rspec

data/README.md

@@ -58,6 +58,7 @@ class CreateWorkerNames < ActiveRecord::Migration
     create_table :worker_names, id: false, options: "ENGINE=QUEUE" do |t|
       t.string :job_id, null: false
       t.string :title
+      t.integer :scheduled_at, limit: 8, default: 0, null: false
       t.datetime :enqueued_at, null: false
     end
   end
@@ -78,6 +79,7 @@ mysql> show create table worker_names\G
 Create Table: CREATE TABLE `worker_names` (
   `job_id` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
   `title` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
+  `scheduled_at` bigint(20) NOT NULL DEFAULT '0',
   `enqueued_at` datetime NOT NULL
 ) ENGINE=QUEUE DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci
 ```

data/lib/generators/shinq/worker/templates/create_table_migration.erb

@@ -5,6 +5,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
 <% attributes.each do |attribute| -%>
       t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
 <% end -%>
+      t.integer :scheduled_at, limit: 8, default: 0, null: false
       t.datetime :enqueued_at, null: false
     end
   end

data/lib/shinq.rb

@@ -24,12 +24,20 @@ module Shinq
 
   def self.setup_db_connection(db_name)
     raise Shinq::ConfigurationError unless self.configuration.db_defined?(db_name)
-    @connections[db_name] = Mysql2::Client.new(self.configuration.db_config[db_name])
+    @connections[db_name.to_sym] = Mysql2::Client.new(self.configuration.db_config[db_name])
   end
 
   def self.connection(db_name: self.default_db)
     @connections ||= {}
-    @connections[db_name] ||= setup_db_connection(db_name)
+    @connections[db_name.to_sym] ||= setup_db_connection(db_name)
+  end
+
+  def self.clear_all_connections!
+    return unless @connections
+    @connections.each do |_db_name, connection|
+      connection && connection.close
+    end
+    @connections = {}
   end
 
   def self.logger

data/lib/shinq/active_job/queue_adapters/shinq_adapter.rb

@@ -1,6 +1,14 @@
 module ActiveJob
   module QueueAdapters
     class ShinqAdapter
+      def enqueue(job)
+        self.class.enqueue job
+      end
+
+      def enqueue_at(job, timestamp)
+        self.class.enqueue_at job, timestamp
+      end
+
       class << self
         def enqueue(job)
           Shinq::Client.enqueue(
@@ -9,6 +17,15 @@ module ActiveJob
             args: job.arguments.first
           )
         end
+
+        def enqueue_at(job, timestamp)
+          Shinq::Client.enqueue(
+            table_name: job.queue_name,
+            job_id: job.job_id,
+            args: job.arguments.first,
+            scheduled_at: timestamp,
+          )
+        end
       end
     end
   end

data/lib/shinq/cli.rb

@@ -15,6 +15,7 @@ module Shinq
     def initialize(args=ARGV)
       setup_option(args)
       bootstrap
+      initialize_shinq
     end
 
     def setup_option(args)
@@ -31,10 +32,7 @@ module Shinq
         end
 
         opt.on('-w', '--worker VALUE', 'Name of worker class') do |v|
-          worker_class = v.camelize.safe_constantize
-          raise OptionParseError, "worker class #{v.camelize} corresponding to #{v} does not exist" unless worker_class
           opts[:worker_name] = v
-          opts[:worker_class] = worker_class
         end
 
         opt.on('-p', '--process VALUE', 'Number of workers') do |v|
@@ -75,6 +73,10 @@ module Shinq
           opts[:abort_on_error] = v
         end
 
+        opt.on('--sleep-sec-on-error N', Integer, 'Allow worker to sleep(sec) after exception') do |v|
+          opts[:sleep_sec_on_error] = v
+        end
+
         opt.on('-v', '--version', 'Print version') do |v|
           puts "Shinq #{Shinq::VERSION}"
           exit(0)
@@ -104,6 +106,11 @@ module Shinq
       end
     end
 
+    def initialize_shinq
+      Shinq::Client.fetch_column_names(table_name: Shinq.configuration.worker_name.pluralize)
+      Shinq.configuration.worker_class # check if worker_class is constantizable before running ServerEngine
+    end
+
     def run
       klass = !options.statistics.nil? && options.statistics ? Shinq::Statistics : Shinq::Launcher
 
@@ -112,8 +119,8 @@ module Shinq
         worker_type: 'process',
         pid_file: 'shinq.pid',
         workers: options.process,
-        worker_graceful_kill_timeout: options.graceful_kill_timeout
-        logger: options.daemonize ? Shinq.logger : nil
+        worker_graceful_kill_timeout: options.graceful_kill_timeout,
+        logger: options.daemonize ? Shinq.logger : nil,
       })
 
       se.run

data/lib/shinq/client.rb

@@ -8,13 +8,19 @@ module Shinq
       @builder ||= SQL::Maker.new(driver: 'mysql', auto_bind: true)
     end
 
-    def self.enqueue(table_name: , job_id: , args:)
+    def self.enqueue(table_name: , job_id: , args:, scheduled_at: nil)
+      if scheduled_at && !schedulable?(table_name: table_name)
+        raise ArgumentError, "table #{table_name} is not schedulable. You need column `scheduled_at`"
+      end
+
       case args
       when Hash
-        sql = builder.insert(table_name, args.merge(
+        attributes = args.merge(
           job_id: job_id,
-          enqueued_at: Time.now
-        ))
+          scheduled_at: scheduled_at ? scheduled_at.to_i : nil,
+          enqueued_at: Time.now,
+        ).compact
+        sql = builder.insert(table_name, attributes)
         Shinq.connection.query(sql)
       else
         raise ArgumentError, "`args` should be a Hash"
@@ -22,7 +28,9 @@ module Shinq
     end
 
     def self.dequeue(table_name:)
-      quoted = SQL::Maker::Quoting.quote(table_name)
+      condition = schedulable?(table_name: table_name) ? ":scheduled_at<=#{Time.now.to_i}" : ''
+      quoted = SQL::Maker::Quoting.quote("#{table_name}#{condition}")
+
       queue_timeout_quoted = SQL::Maker::Quoting.quote(Shinq.configuration.queue_timeout)
 
       wait_query = "queue_wait(#{quoted}, #{queue_timeout_quoted})"
@@ -52,6 +60,26 @@ module Shinq
       )
     end
 
+    def self.schedulable?(table_name:)
+      self.column_names(table_name: table_name).include?('scheduled_at')
+    end
+
+    def self.column_names(table_name:)
+      @column_names_by_table_name ||= {}
+      @column_names_by_table_name[table_name.to_sym] ||= begin
+        quoted = SQL::Maker::Quoting.quote(table_name)
+        column = Shinq.connection.query(<<-EOS).map { |record| record['column_name'] }
+select column_name from information_schema.columns where table_schema = database() and table_name = #{quoted}
+        EOS
+      end
+    end
+
+    def self.fetch_column_names(table_name:)
+      @column_names_by_table_name ||= {}
+      @column_names_by_table_name.delete(table_name.to_sym)
+      column_names(table_name: table_name)
+    end
+
     def self.done
       Shinq.connection.query('select queue_end()')
     end

data/lib/shinq/configuration.rb

@@ -10,7 +10,7 @@ module Shinq
   #   You may need to set it +false+ for jobs which take very long time to proceed.
   #   You may also need to handle performing error manually then.
   class Configuration
-    attr_accessor :require, :worker_name, :worker_class, :db_config, :queue_db, :default_db, :process, :graceful_kill_timeout, :queue_timeout, :daemonize, :statistics, :lifecycle, :abort_on_error
+    attr_accessor :require, :worker_name, :db_config, :queue_db, :default_db, :process, :graceful_kill_timeout, :queue_timeout, :daemonize, :statistics, :lifecycle, :abort_on_error, :sleep_sec_on_error
 
     DEFAULT = {
       require: '.',
@@ -18,15 +18,25 @@ module Shinq
       graceful_kill_timeout: 600,
       queue_timeout: 1,
       daemonize: false,
-      abort_on_error: true
+      abort_on_error: true,
+      sleep_sec_on_error: 1,
     }
 
     def initialize(opts)
-      %i(require worker_name db_config queue_db default_db process queue_timeout daemonize statistics lifecycle abort_on_error).each do |k|
-        send(:"#{k}=", opts[k] || DEFAULT[k])
+      %i(require worker_name db_config queue_db default_db process queue_timeout daemonize statistics lifecycle abort_on_error sleep_sec_on_error).each do |k|
+        value = opts.key?(k) ? opts[k] : DEFAULT[k]
+        send(:"#{k}=", value)
       end
     end
 
+    def worker_class
+      worker_class = worker_name.camelize.safe_constantize
+      unless worker_class
+        raise ConfigurationError, "worker class #{worker_name.camelize} corresponding to #{worker_name} does not exist"
+      end
+      worker_class
+    end
+
     def default_db_config
       raise ConfigurationError if !(default_db && db_defined?(default_db))
       db_config[default_db]

data/lib/shinq/launcher.rb

@@ -3,6 +3,10 @@ require 'active_support/inflector'
 
 module Shinq
   module Launcher
+    def initialize
+      Shinq.clear_all_connections!
+    end
+
     # Wait configured queue and proceed each of them until stop.
     # @see Shinq::Configuration#abort_on_error
     def run
@@ -12,21 +16,26 @@ module Shinq
       @loop_count = 0
 
       until @stop
-        queue = Shinq::Client.dequeue(table_name: worker_name.pluralize)
-        next Shinq.logger.info("Queue is empty (#{Time.now})") unless queue
+        begin
+          queue = Shinq::Client.dequeue(table_name: worker_name.pluralize)
+          next Shinq.logger.info("Queue is empty (#{Time.now})") unless queue
 
-        if Shinq.configuration.abort_on_error
-          begin
+          if Shinq.configuration.abort_on_error
+            worker_class.new.perform(queue)
+            Shinq::Client.done
+          else
+            Shinq::Client.done
             worker_class.new.perform(queue)
-          rescue => e
-            Shinq::Client.abort
-            raise e
           end
 
-          Shinq::Client.done
-        else
-          Shinq::Client.done
-          worker_class.new.perform(queue)
+          Shinq.clear_all_connections!
+        rescue => e
+          Shinq.logger.error(format_error_message(e))
+          sleep Shinq.configuration.sleep_sec_on_error
+
+          Shinq::Client.abort if Shinq.configuration.abort_on_error && queue
+          Shinq.clear_all_connections!
+          break
         end
 
         @loop_count += 1
@@ -46,5 +55,16 @@ module Shinq
       return false unless Shinq.configuration.lifecycle
       return (Shinq.configuration.lifecycle < @loop_count)
     end
+
+    private
+
+    def format_error_message(error)
+      if defined?(::Rails) && ::Rails.backtrace_cleaner
+        backtrace = ::Rails.backtrace_cleaner.clean(error.backtrace || []).presence || error.backtrace
+      else
+        backtrace = error.backtrace
+      end
+      "#{error.message} at #{backtrace.join('  <<<   ')}"
+    end
   end
 end

data/shinq.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "shinq"
-  spec.version       = '0.8.0'
+  spec.version       = '1.0.2'
   spec.authors       = ["Ryoichi SEKIGUCHI"]
   spec.email         = ["ryopeko@gmail.com"]
   spec.summary       = %q{Worker and enqueuer for Q4M using the interface of ActiveJob.}
@@ -16,17 +16,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "tapp"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-mocks"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "timecop"
 
-  spec.add_dependency "mysql2", ">= 0.3.16", "< 0.5"
+  spec.add_dependency "mysql2", ">= 0.3.16", "< 0.6"
   spec.add_dependency "sql-maker", "~> 0.0.4"
-  spec.add_dependency "activesupport", "~> 4.2.0"
-  spec.add_dependency "activejob", "~> 4.2.0"
+  spec.add_dependency "activesupport", ">= 4.2.0", "< 6"
+  spec.add_dependency "activejob", ">= 4.2.0", "< 6"
   spec.add_dependency 'serverengine', '~> 1.5.9'
 end

data/spec/db/structure.sql.erb

@@ -0,0 +1,15 @@
+DROP TABLE IF EXISTS `queue_test`;
+CREATE TABLE `queue_test` (
+  `job_id` varchar(255) NOT NULL,
+  `title` varchar(255),
+  `scheduled_at` bigint(20) NOT NULL DEFAULT '0',
+  `enqueued_at` datetime NOT NULL
+) ENGINE=<%= engine %>;
+
+DROP TABLE IF EXISTS `queue_test_without_scheduled_at`;
+
+CREATE TABLE `queue_test_without_scheduled_at` (
+  `job_id` varchar(255) NOT NULL,
+  `title` varchar(255),
+  `enqueued_at` datetime NOT NULL
+) ENGINE=<%= engine %>;

data/spec/helpers/my_worker.rb

@@ -0,0 +1,4 @@
+require 'active_job'
+class MyWorker < ActiveJob::Base
+  queue_as :my_workers
+end

data/spec/integration_spec.rb

@@ -3,7 +3,6 @@ require 'shinq'
 require 'shinq/client'
 
 describe "Integration", skip: ENV['TRAVIS'] do
-  let(:queue_table) { 'queue_test' }
 
   before do
     Shinq.configuration = {
@@ -13,28 +12,97 @@ describe "Integration", skip: ENV['TRAVIS'] do
   end
 
   after do
-    Shinq.connection.query("delete from #{queue_table}")
+    Shinq.clear_all_connections! # Return from owner mode
+    tables = Shinq.connection.query('show tables').flat_map(&:values)
+    tables.each do |table|
+      Shinq.connection.query("delete from #{table}")
+    end
+    Shinq.clear_all_connections!
   end
 
   describe "Shinq::Client.enqueue,dequeue" do
-    context "valid args" do
-      let(:args) { {title: 'foo'} }
+    before do
+      Timecop.freeze
+    end
+    after do
+      Timecop.return
+    end
+
+    context 'with scheduled_at on table' do
+      let(:queue_table) { 'queue_test' }
+      let(:job_id) { SecureRandom.uuid }
 
       before do
         Shinq::Client.enqueue(
           table_name: queue_table,
-          job_id: 'jobid',
-          args: args
+          job_id: job_id,
+          args: { title: :foo },
+          scheduled_at: scheduled_at
         )
+      end
 
-        @queue = Shinq::Client.dequeue(table_name: queue_table)
-        Shinq::Client.done
+      context 'when scheduled_at is not specified' do
+        let(:scheduled_at) { nil }
+
+        it 'can dequeue immediately' do
+          expect(Shinq::Client.dequeue(table_name: queue_table)[:job_id]).to eq job_id
+        end
       end
 
-      it { expect(@queue[:title]).to eq args[:title] }
+      context 'when scheduled_at is specified' do
+        let(:scheduled_at) { 1.minute.since }
+
+        it 'can not dequeue job immediately' do
+          expect(Shinq::Client.dequeue(table_name: queue_table)).to be nil
+        end
+
+        context 'when specified time elapsed' do
+          before do
+            Timecop.travel(scheduled_at)
+          end
+
+          it 'can dequeue job' do
+            expect(Shinq::Client.dequeue(table_name: queue_table)[:job_id]).to eq job_id
+          end
+        end
+      end
     end
 
-    context "invalid args" do
+    context 'without scheduled_at on table' do
+      let(:job_id) { SecureRandom.uuid }
+      let(:unschedulable_queue_table) { 'queue_test_without_scheduled_at' }
+
+      context 'when scheduled_at is not specified' do
+        before do
+          Shinq::Client.enqueue(
+            table_name: unschedulable_queue_table,
+            job_id: job_id,
+            args: { title: :foo },
+          )
+        end
+
+        it 'can dequeue job' do
+          expect(Shinq::Client.dequeue(table_name: unschedulable_queue_table)[:job_id]).to eq job_id
+        end
+      end
+
+      context 'when scheduled_at is specified' do
+        it 'cannot enqueue job' do
+          expect {
+            Shinq::Client.enqueue(
+              table_name: unschedulable_queue_table,
+              job_id: job_id,
+              args: { title: :foo },
+              scheduled_at: 1.minute.since,
+            )
+          }.to raise_error ArgumentError
+        end
+      end
+    end
+
+
+    context "with invalid args" do
+      let(:queue_table) { 'queue_test' }
       it {
         expect {
           Shinq::Client.enqueue(
@@ -48,6 +116,8 @@ describe "Integration", skip: ENV['TRAVIS'] do
   end
 
   describe "Shinq::Client.abort" do
+    let(:queue_table) { 'queue_test' }
+
     context "When client has a queue" do
       before do
         Shinq::Client.enqueue(
@@ -77,6 +147,8 @@ describe "Integration", skip: ENV['TRAVIS'] do
   end
 
   describe "Shinq::Client.queue_stats" do
+    let(:queue_table) { 'queue_test' }
+
     subject(:stats) {
       Shinq::Client.queue_stats(table_name: queue_table)
     }

data/spec/shinq/cli_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'shinq/cli'
+
+describe Shinq::CLI do
+  after do
+    Shinq.clear_all_connections!
+  end
+
+  describe '.new' do
+    context 'when there are require statement' do
+      it 'requires and run the code' do
+        # NOTE: As CLI alters global process irreversibly, we only check the result
+        Shinq::CLI.new(%W[
+          --require my_worker
+          --db-config #{File.expand_path('../config/database.yml', __dir__)}
+          --worker my_worker
+        ])
+        expect(defined? MyWorker).to eq 'constant'
+      end
+    end
+  end
+
+  describe '#run' do
+    before do
+      allow_any_instance_of(ServerEngine::Daemon).to receive(:run).and_return(nil)
+    end
+
+    it 'launches Shinq::Launcher backended by ServerEngine' do
+      expect {
+        Shinq::CLI.new(%W[
+          --require my_worker
+          --db-config #{File.expand_path('../config/database.yml', __dir__)}
+          --worker my_worker
+        ]).run
+      }.not_to raise_error
+    end
+  end
+end

data/spec/shinq/client_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'shinq'
+require 'shinq/client'
+
+describe Shinq::Client do
+  subject(:shinq_client) do
+    Shinq::Client.dup.tap do |client|
+      client.instance_variables.each do |variable|
+        client.remove_instance_variable(variable)
+      end
+    end
+  end
+
+  before do
+    Shinq.configuration = {
+      default_db: :test,
+      db_config: load_database_config
+    }
+  end
+
+  after do
+    Shinq.clear_all_connections!
+  end
+
+  describe '.schedulable?' do
+    context 'when target table have scheduled_at' do
+      it { expect(shinq_client.schedulable?(table_name: :queue_test)).to be true }
+    end
+
+    context 'when target table does NOT have scheduled_at' do
+      it { expect(shinq_client.schedulable?(table_name: :queue_test_without_scheduled_at)).to be false }
+    end
+  end
+
+  describe '.column_names' do
+    it 'fetches column_names' do
+      expect(shinq_client.column_names(table_name: :queue_test)).to eq(['job_id', 'title', 'scheduled_at', 'enqueued_at'])
+    end
+  end
+
+  describe 'fetch_column_names' do
+    it 'fetches column_names' do
+      expect(shinq_client.fetch_column_names(table_name: :queue_test)).to eq(['job_id', 'title', 'scheduled_at', 'enqueued_at'])
+    end
+  end
+end

data/spec/shinq/configuration_spec.rb

@@ -33,6 +33,21 @@ describe Shinq::Configuration do
     end
   end
 
+  describe '#worker_class' do
+    context 'when worker_name is valid' do
+      let(:configuration) { Shinq::Configuration.new(worker_name: 'shinq') }
+      it 'constantizes worker_name to corresponding constant' do
+        expect(configuration.worker_class).to eq Shinq
+      end
+    end
+
+    context 'when worker_name is invalid' do
+      let(:configuration) { Shinq::Configuration.new(worker_name: 'invalid_shinq') }
+
+      it {expect { configuration.worker_class }.to raise_error(Shinq::ConfigurationError)}
+    end
+  end
+
   describe "#default_db_config" do
     context "when default_db is present" do
       let(:configuration) { Shinq::Configuration.new({}) }

data/spec/shinq_spec.rb

@@ -3,29 +3,32 @@ require 'shinq'
 require 'shinq/configuration'
 require 'logger'
 
-def shinq_class
-  Shinq.dup
-end
-
 describe Shinq do
-  subject { shinq_class }
+  # remove instance variable deliberately or indeliberately defined by other specs
+  subject(:shinq) do
+    Shinq.dup.tap do |shinq|
+      shinq.instance_variables.each do |variable|
+        shinq.remove_instance_variable(variable)
+      end
+    end
+  end
+
+  after do
+    shinq.clear_all_connections!
+  end
 
   it { is_expected.to respond_to(:configuration) }
   it { is_expected.to respond_to(:configuration=) }
 
   describe ".configuration" do
     context "when configuration is not present" do
-      let(:shinq) { shinq_class }
-
       it { expect(shinq.configuration).to be_a_kind_of(Shinq::Configuration) }
     end
 
     context "when configuration is present" do
-      let(:shinq) {
-        shinq_class.tap {|s|
-          s.configuration = Hash.new
-        }
-      }
+      before do
+        shinq.configuration = Hash.new
+      end
 
       it { expect(shinq.configuration).to be_a_kind_of(Shinq::Configuration) }
     end
@@ -33,7 +36,6 @@ describe Shinq do
 
   describe ".configuration=" do
     context "when specify args is Hash" do
-      let(:shinq) { shinq_class }
       let(:args) { Hash.new }
 
       it 'is expect to return specified args' do
@@ -42,7 +44,6 @@ describe Shinq do
     end
 
     context "when specify args is Shinq::Configuration" do
-      let(:shinq) { shinq_class }
       let(:args) { Shinq::Configuration.new({}) }
 
       it 'is expect to return specified args' do
@@ -52,39 +53,56 @@ describe Shinq do
   end
 
   describe ".connection" do
+    context "when db_config is not present" do
+      it { expect{ shinq.connection(db_name: :unknown) }.to raise_error(Shinq::ConfigurationError) }
+    end
+
     context "when db_config is present" do
-      let(:shinq) { shinq_class }
+      before do
+        shinq.configuration = { db_config: load_database_config, default_db: :test }
+      end
 
-      it { expect{ shinq.connection(db_name: :unknown) }.to raise_error(Shinq::ConfigurationError) }
+      it do
+        shinq.connection(db_name: :test)
+        expect(shinq.connection(db_name: :test)).to be_a_kind_of(Mysql2::Client)
+      end
     end
+  end
 
-    context "when db_config is not preset" do
-      let(:shinq) {
-        shinq_class.tap {|s|
-          s.configuration = {
-            db_config: load_database_config,
-            default_db: :test,
-          }
-        }
-      }
-
-      it { expect(shinq.connection(db_name: :test)).to be_a_kind_of(Mysql2::Client) }
+  describe '.clear_all_connections!' do
+    before do
+      shinq.configuration = { db_config: load_database_config, default_db: :test }
+    end
+
+    context 'when there are no connections' do
+      it { expect { shinq.clear_all_connections! }.not_to raise_error }
+    end
+
+    context 'when there is a connection' do
+      let!(:connection) { shinq.connection(db_name: :test) }
+
+      it 'closes connection' do
+        shinq.clear_all_connections!
+        expect(connection.ping).to be false
+      end
+
+      it 'clears connection cache' do
+        shinq.clear_all_connections!
+        expect(shinq.connection(db_name: :test)).not_to eq connection
+      end
     end
   end
 
   describe ".logger" do
-    context "when logger is present" do
-      let(:shinq) { shinq_class }
+    context "when logger is not present" do
       it { expect(shinq.logger).to be nil }
     end
 
     context "when logger is present" do
       let(:logger) { Logger.new(STDOUT) }
-      let(:shinq) {
-        shinq_class.tap {|s|
-          s.logger = logger
-        }
-      }
+      before do
+        shinq.logger = logger
+      end
 
       it { expect(shinq.logger).to be logger }
     end

data/spec/spec_helper.rb

@@ -1,7 +1,13 @@
+ENV['RAILS_ENV'] ||= 'test'
+$LOAD_PATH << File.expand_path('../helpers', __FILE__)
+
 require 'rspec/mocks/standalone'
 require 'simplecov'
+require 'erb'
 require 'yaml'
 require 'active_support/core_ext/hash'
+require 'mysql2'
+require 'timecop'
 
 def load_database_config
   db_config = YAML.load_file(File.expand_path('./config/database.yml', __dir__)).symbolize_keys
@@ -25,8 +31,19 @@ RSpec.configure do |config|
   end
 
   config.before(:suite) do
+    # MySQL on Travis does not have Q4M plugins.
+    # We use QUEUE engine and run Q4M specific spec (integration_spec) only when ENV['TRAVIS'] is nil.
+    engine = ENV['TRAVIS'] ? 'InnoDB' : 'QUEUE' # Travis MySQL does not have Q4M plugins.
+    sql = ERB.new(File.read(File.expand_path('./db/structure.sql.erb', __dir__))).result(binding)
+
     connection = Mysql2::Client.new(load_database_config[:test].merge(flags: Mysql2::Client::MULTI_STATEMENTS))
-    connection.query(File.read(File.expand_path('./db/structure.sql', __dir__)))
+    result = connection.query(sql)
+
+    while connection.next_result
+      connection.store_result
+    end
+
+    connection.close
   end
 
   config.order = :random

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: shinq
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Ryoichi SEKIGUCHI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +131,7 @@ dependencies:
         version: 0.3.16
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -127,7 +141,7 @@ dependencies:
         version: 0.3.16
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: sql-maker
   requirement: !ruby/object:Gem::Requirement
@@ -146,30 +160,42 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: serverengine
   requirement: !ruby/object:Gem::Requirement
@@ -214,8 +240,11 @@ files:
 - lib/shinq/statistics.rb
 - shinq.gemspec
 - spec/config/database.yml
-- spec/db/structure.sql
+- spec/db/structure.sql.erb
+- spec/helpers/my_worker.rb
 - spec/integration_spec.rb
+- spec/shinq/cli_spec.rb
+- spec/shinq/client_spec.rb
 - spec/shinq/configuration_spec.rb
 - spec/shinq_spec.rb
 - spec/spec_helper.rb
@@ -238,15 +267,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Worker and enqueuer for Q4M using the interface of ActiveJob.
 test_files:
 - spec/config/database.yml
-- spec/db/structure.sql
+- spec/db/structure.sql.erb
+- spec/helpers/my_worker.rb
 - spec/integration_spec.rb
+- spec/shinq/cli_spec.rb
+- spec/shinq/client_spec.rb
 - spec/shinq/configuration_spec.rb
 - spec/shinq_spec.rb
 - spec/spec_helper.rb

data/spec/db/structure.sql

@@ -1,6 +0,0 @@
-DROP TABLE IF EXISTS `queue_test`;
-CREATE TABLE `queue_test` (
-  `job_id` varchar(255) NOT NULL,
-  `title` varchar(255),
-  `enqueued_at` datetime NOT NULL
-) ENGINE=QUEUE;