shinq 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 963044a99e6d106db2b057aada7d494cad2b08e7
-  data.tar.gz: 0aed9ca078d588390f1f60e31848c890d67b6f47
+  metadata.gz: 27fb65cd784140db7180182ee23747354ea16316
+  data.tar.gz: d3b16bae80c1e983ddff5a417caa23ae28f1ad0b
 SHA512:
-  metadata.gz: 335d663a56d4583364ca9c566347396488e3caa5170141c8f3b6dec869a1f9c6a99adbfc591721e4972b4859f1aa32de5cc0b5a2a853515d7d0e89218474af6f
-  data.tar.gz: 36edfb7ed38029b700f71718e68549a3fcdb60e2a00a4bcf5aa90ff81ce6b0859fe5395702b94013a8b64513110cdb3fe4f24d68f0fd783d52ef2b74fdaecd3a
+  metadata.gz: d9636a00d1c4d5c9a57fa5a3bdf697bb0814fb3c3caa3f61f4dc775473fb967b0c4f81980609025aaf4d475553bee80d03e6d872f3b428724938aa3f2acc7280
+  data.tar.gz: 36076bca1dfb6cb3c6d89f18dada6116a22b0b8123ad3e1987980cc030c0d21eec495e0326590ceb6695779d7b32e5c2ece588aa4dc5b5dc98a3bef8fcf82230

data/README.md

@@ -31,23 +31,70 @@ end
 ```
 
 ### Worker
+
+#### Generate worker, migration file
+
+```
+$ rails generate shinq:worker worker_name title:string
+      create  db/migrate/20141110061243_create_worker_names.rb
+      create  app/workers/worker_name.rb
+```
+
+Generated worker file (app/workers/worker_name.rb)
 ```ruby
-class FooWorker < ActiveJob::Base
-  aueue_as :my_queues #name of queue table
+class WorkerName < ActiveJob::Base
+  queue_as :worker_names
 
   def perform(args)
-    #perform asynchronous
+    #do something
   end
 end
 ```
 
+Generated migration file
+```ruby
+class CreateWorkerNames < ActiveRecord::Migration
+  def change
+    create_table :worker_names, {id: false, options: "ENGINE=QUEUE"} do |t|
+      t.string :job_id, null: false
+      t.string :title
+      t.datetime :enqueued_at, null: false
+    end
+  end
+end
+```
+
+#### migrate
+```
+$ rake db:migrate
+== 20141110061243 CreateWorkerNames: migrating ================================
+-- create_table(:worker_names, {:id=>false, :options=>"ENGINE=QUEUE"})
+   -> 0.0260s
+== 20141110061243 CreateWorkerNames: migrated (0.0261s) =======================
+
+mysql> show create table worker_names\G
+*************************** 1. row ***************************
+       Table: worker_names
+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,
+  `enqueued_at` datetime NOT NULL
+) ENGINE=QUEUE DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci
+```
+
 ### Enqueue
 ```ruby
-FooWorker.perform_later(foo: 'bar', baz: 'qux')
+WorkerName.perform_later(title: 'foo')
 ```
 
 ### Worker execution
-TBD
+
+#### Basic execution
+```
+$ bundle exec shinq --worker worker_name
+```
+
+You can specify some options. see `bundle exec shinq --help`
 
 ## Contributing
 

data/lib/shinq/cli.rb

@@ -23,37 +23,37 @@ module Shinq
     def parse_options(args)
       opts = {}
       parser = OptionParser.new do |opt|
-        opt.on('-d', '--daemon') do |v|
+        opt.on('-d', '--daemon', 'Daemonize process') do |v|
           opts[:daemonize] = v
         end
 
-        opt.on('--worker value') do |v|
+        opt.on('--worker value', 'Name of worker class') do |v|
           opts[:worker_name] = v
         end
 
-        opt.on('--process VALUE') do |v|
+        opt.on('--process VALUE', 'Number of workers') do |v|
           opts[:process] = v.to_i
         end
 
-        opt.on('--queue-timeout VALUE') do |v|
+        opt.on('--queue-timeout VALUE', 'Waiting queue time(sec). use function of queue_wait(Q4M)') do |v|
           opts[:queue_timeout] = v.to_i
         end
 
-        opt.on('--db-config VALUE') do |v|
+        opt.on('--db-config VALUE', 'Specify configuration file') do |v|
           raise OptionParseError, "#{v} does not exist" unless File.exist?(v)
           opts[:db_config] = YAML.load_file(v)
         end
 
-        opt.on('--queue-database VALUE') do |v|
+        opt.on('--queue-database VALUE', 'Name of queue database') do |v|
           raise OptionParseError, "#{v}'s settings does not exist" unless opts[:db_config][v]
           opts[:queue_db] = v
         end
 
-        opt.on('--require VALUE') do |v|
+        opt.on('--require VALUE', 'Add require path') do |v|
           opts[:require] = v
         end
 
-        opt.on('-v', '--version') do |v|
+        opt.on('-v', '--version', 'Print version') do |v|
           puts "Shinq #{Shinq::VERSION}"
           exit(0)
         end

data/lib/shinq/client.rb

@@ -35,6 +35,22 @@ module Shinq
       end
     end
 
+    def self.queue_stats(table_name:)
+      quoted = SQL::Maker::Quoting.quote(table_name)
+
+      stats_query = "queue_stats(#{quoted})"
+      result = Shinq.connection.query("select #{stats_query}")
+
+      stats = result.first[stats_query].split(/\n/).each_with_object({}) do |s, h|
+        (k,v) = s.split(/:/)
+        h[k.to_sym] = v.to_i
+      end
+
+      stats.merge(
+        queue_count: stats[:rows_removed] - stats[:rows_written]
+      )
+    end
+
     def self.done
       Shinq.connection.query('select queue_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.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ["Ryoichi SEKIGUCHI"]
   spec.email         = ["ryopeko@gmail.com"]
   spec.summary       = %q{Worker and enqueuer for Q4M using the interface of ActiveJob.}

data/spec/integration_spec.rb

@@ -2,26 +2,95 @@ require 'spec_helper'
 require 'shinq'
 require 'shinq/client'
 
-describe "Integration" do
+describe "Integration", skip: ENV['TRAVIS'] do
+  let(:queue_table) { 'queue_test' }
+
   before do
     load_database_config(Shinq)
   end
 
-  context "When create queue", skip: ENV['TRAVIS'] do
-    let(:queue_table) { 'queue_test' }
-    let(:args) { {title: 'foo'} }
+  after do
+    Shinq.connection.query("delete from #{queue_table}")
+  end
+
+  describe "Shinq::Client.enqueue,dequeue" do
+    context "valid args" do
+      let(:args) { {title: 'foo'} }
+
+      before do
+        Shinq::Client.enqueue(
+          table_name: queue_table,
+          job_id: 'jobid',
+          args: args
+        )
+
+        @queue = Shinq::Client.dequeue(table_name: queue_table)
+        Shinq::Client.done
+      end
 
-    before do
-      Shinq::Client.enqueue(
-        table_name: queue_table,
-        job_id: 'jobid',
-        args: args
-      )
+      it { expect(@queue[:title]).to eq args[:title] }
+    end
 
-      @queue = Shinq::Client.dequeue(table_name: queue_table)
-      Shinq::Client.done
+    context "invalid args" do
+      it {
+        expect {
+          Shinq::Client.enqueue(
+            table_name: queue_table,
+            job_id: 'jobid',
+            args: Array.new
+          )
+        }.to raise_error(ArgumentError)
+      }
     end
+  end
+
+  describe "Shinq::Client.abort" do
+    context "When client has a queue" do
+      before do
+        Shinq::Client.enqueue(
+          table_name: queue_table,
+          job_id: 'jobid',
+          args: {title: 'foo'}
+        )
+
+        @queue_count = Shinq.connection.query("select count(*) as c from #{queue_table}").first['c']
+
+        Shinq::Client.dequeue(table_name: queue_table)
+        Shinq::Client.abort
 
-    it { expect(@queue[:title]).to eq args[:title] }
+        @after_queue_count = Shinq.connection.query("select count(*) as c from #{queue_table}").first['c']
+      end
+
+      it { expect(@after_queue_count).to be @queue_count }
+    end
+
+    context "When client does not have a queue" do
+      it {
+        expect {
+          Shinq::Client.abort
+        }.to raise_error (/not in owner mode/)
+      }
+    end
+  end
+
+  describe "Shinq::Client.queue_stats" do
+    subject(:stats) {
+      Shinq::Client.queue_stats(table_name: queue_table)
+    }
+
+    it { expect(stats).to have_key :rows_written }
+    it { expect(stats).to have_key :rows_removed }
+    it { expect(stats).to have_key :wait_immediate }
+    it { expect(stats).to have_key :wait_delayed }
+    it { expect(stats).to have_key :wait_timeout }
+    it { expect(stats).to have_key :restored_by_abort }
+    it { expect(stats).to have_key :restored_by_close }
+    it { expect(stats).to have_key :bytes_total }
+    it { expect(stats).to have_key :bytes_removed }
+    it { expect(stats).to have_key :queue_count }
+
+    it "queue_count expect to be equal rows_removed - rows_written" do
+      expect(stats[:queue_count]).to eq (stats[:rows_removed] - stats[:rows_written])
+    end
   end
 end

data/spec/shinq/configuration_spec.rb

@@ -12,6 +12,7 @@ describe Shinq::Configuration do
     it { is_expected.to respond_to(:default_db) }
     it { is_expected.to respond_to(:process) }
     it { is_expected.to respond_to(:queue_timeout) }
+    it { is_expected.to respond_to(:daemonize) }
   end
 
   describe ".new" do
@@ -42,9 +43,16 @@ describe Shinq::Configuration do
     end
 
     context "when default_db's config is present" do
-      let(:configuration) { Shinq::Configuration.new(default_db: :test) }
-
-      it {expect { configuration.default_db_config }.to raise_error(Shinq::ConfigurationError)}
+      let(:test_db_config) { {foo: :bar} }
+      let(:configuration) {
+        Shinq::Configuration.new(
+          default_db: :test,
+          db_config: {
+            test: test_db_config
+          })
+      }
+
+      it { expect(configuration.default_db_config).to be test_db_config }
     end
   end
 

data/spec/shinq_spec.rb

@@ -31,7 +31,7 @@ describe Shinq do
   end
 
   describe ".configuration=" do
-    context "when specify args" do
+    context "when specify args is Hash" do
       let(:shinq) { shinq_class }
       let(:args) { Hash.new }
 
@@ -39,6 +39,15 @@ describe Shinq do
         expect(shinq.configuration=(args)).to eq args
       end
     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
+        expect(shinq.configuration=(args)).to eq args
+      end
+    end
   end
 
   describe ".connection" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shinq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryoichi SEKIGUCHI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler