queue_classic 2.0.0rc12 → 2.0.0rc13

data/lib/queue_classic.rb

@@ -9,6 +9,7 @@ require "queue_classic/conn"
 require "queue_classic/queries"
 require "queue_classic/queue"
 require "queue_classic/worker"
+require "queue_classic/setup"
 
 module QC
   # ENV["LOG_LEVEL"] is used in Scrolls
@@ -17,6 +18,7 @@ module QC
   Root = File.expand_path("..", File.dirname(__FILE__))
   SqlFunctions = File.join(QC::Root, "/sql/ddl.sql")
   DropSqlFunctions = File.join(QC::Root, "/sql/drop_ddl.sql")
+  CreateTable = File.join(QC::Root, "/sql/create_table.sql")
 
   # You can use the APP_NAME to query for
   # postgres related process information in the

data/lib/queue_classic/queries.rb

@@ -38,21 +38,5 @@ module QC
       Conn.execute(*[s, q_name].compact)
     end
 
-    def load_functions
-      file = File.open(SqlFunctions)
-      Conn.transaction do
-        Conn.execute(file.read)
-      end
-      file.close
-    end
-
-    def drop_functions
-      file = File.open(DropSqlFunctions)
-      Conn.transaction do
-        Conn.execute(file.read)
-      end
-      file.close
-    end
-
   end
 end

data/lib/queue_classic/setup.rb

@@ -0,0 +1,40 @@
+module QC
+  module Setup
+    extend self
+
+    def create
+      create_table
+      create_functions
+    end
+
+    def drop
+      drop_functions
+      drop_table
+    end
+
+    def create_table
+      Conn.transaction do
+        Conn.execute(File.read(CreateTable))
+      end
+    end
+
+    def drop_table
+      Conn.transaction do
+        Conn.execute("DROP TABLE IF EXISTS queue_classic_jobs")
+      end
+    end
+
+    def create_functions
+      Conn.transaction do
+        Conn.execute(File.read(SqlFunctions))
+      end
+    end
+
+    def drop_functions
+      Conn.transaction do
+        Conn.execute(File.read(DropSqlFunctions))
+      end
+    end
+
+  end
+end

data/lib/queue_classic/tasks.rb

@@ -6,33 +6,21 @@ end
 namespace :qc do
   desc "Start a new worker for the (default or $QUEUE) queue"
   task :work  => :environment do
-    QC::Worker.new(
-      QC::QUEUE,
-      QC::TOP_BOUND,
-      QC::FORK_WORKER,
-      QC::LISTENING_WORKER,
-      QC::MAX_LOCK_ATTEMPTS
-    ).start
+    QC::Worker.new.start
   end
 
   desc "Returns the number of jobs in the (default or QUEUE) queue"
-  task :length => :environment do
-    puts QC::Worker.new(
-      QC::QUEUE,
-      QC::TOP_BOUND,
-      QC::FORK_WORKER,
-      QC::LISTENING_WORKER,
-      QC::MAX_LOCK_ATTEMPTS
-    ).length
+  task :count => :environment do
+    QC::Worker.new.queue.count
   end
 
-  desc "Ensure the database has the necessary functions for QC"
-  task :load_functions => :environment do
-    QC::Queries.load_functions
+  desc "Setup queue_classic tables and funtions in database"
+  task :create => :environment do
+    QC::Setup.create
   end
 
-  desc "Remove queue_classic functions from database."
-  task :drop_functions => :environment do
-    QC::Queries.drop_functions
+  desc "Remove queue_classic tables and functions from database."
+  task :drop => :environment do
+    QC::Setup.drop
   end
 end

data/lib/queue_classic/worker.rb

@@ -1,6 +1,8 @@
 module QC
   class Worker
 
+    attr_reader :queue
+
     def initialize(*args)
       if args.length == 5
         q_name, top_bound, fork_worker, listening_worker, max_attempts = *args

data/readme.md

@@ -1,6 +1,6 @@
 # queue_classic
 
-v2.0.0rc12
+v2.0.0rc13
 
 queue_classic is a PostgreSQL-backed queueing library that is focused on
 concurrent job locking, minimizing database load & providing a simple &
@@ -10,7 +10,7 @@ queue_classic features:
 
 * Support for multiple queues with heterogeneous workers
 * Utilization of Postgres' PUB/SUB
-* JSON encoding for jobs
+* JSON encoding
 * Forking workers
 * Postgres' rock-solid locking mechanism
 * Fuzzy-FIFO support [academic paper](http://www.cs.tau.ac.il/~shanir/nir-pubs-web/Papers/Lock_Free.pdf)
@@ -19,7 +19,7 @@ queue_classic features:
 
 ## Proven
 
-Queue_classic was designed out of necessity. I needed a message queue that was
+queue_classic was designed out of necessity. I needed a message queue that was
 fast, reliable, and low maintenance. It was built upon PostgreSQL out of a motivation
 of not wanting to add a redis or 0MQ service to my network of services. It boasts
 a small API and very few features. It was designed to be simple. Thus, if you need
@@ -55,13 +55,12 @@ database migration.
 ### Quick Start
 
 ```bash
+$ gem install queue_classic
 $ createdb queue_classic_test
-$ psql queue_classic_test -c "CREATE TABLE queue_classic_jobs (id serial, q_name varchar(255), method varchar(255), args text, locked_at timestamp);"
 $ export QC_DATABASE_URL="postgres://username:password@localhost/queue_classic_test"
-$ gem install queue_classic
-$ ruby -r queue_classic -e "QC::Queries.load_functions"
+$ ruby -r queue_classic -e "QC::Setup.create"
 $ ruby -r queue_classic -e "QC.enqueue('Kernel.puts', 'hello world')"
-$ ruby -r queue_classic -e "QC::Worker.new.start"
+$ ruby -r queue_classic -e "QC::Worker.new.work"
 ```
 
 ### Ruby on Rails Setup
@@ -90,24 +89,16 @@ ENV["DATABASE_URL"] = "postgres://username:password@localhost/database_name"
 **db/migrations/add_queue_classic.rb**
 
 ```ruby
-class CreateJobsTable < ActiveRecord::Migration
+require 'queue_classic'
+
+class AddQueueClassic < ActiveRecord::Migration
 
   def self.up
-    create_table :queue_classic_jobs do |t|
-      t.string :q_name
-      t.string :method
-      t.text :args
-      t.timestamp :locked_at
-    end
-    add_index :queue_classic_jobs, :id
-    require "queue_classic"
-    QC::Queries.load_functions
+    QC::Setup.create
   end
 
   def self.down
-    drop_table :queue_classic_jobs
-    require "queue_classic"
-    QC::Queries.drop_functions
+    QC::Setup.drop
   end
 
 end
@@ -118,23 +109,11 @@ end
 **db/migrations/1_add_queue_classic.rb**
 
 ```ruby
-Sequel.migration do
-  up do
-    create_table :queue_classic_jobs do
-      primary_key :id
-      String :q_name
-      String :details
-      Time   :locked_at
-    end
-    require "queue_classic"
-    QC::Queries.load_functions
-  end
+require 'queue_classic'
 
-  down do
-    drop_table :queue_classic_jobs
-    require "queue_classic"
-    QC::Queries.drop_functions
-  end
+Sequel.migration do
+  up {QC::Setup.create}
+  down {QC::Setup.down}
 end
 ```
 
@@ -178,7 +157,7 @@ QC.enqueue("Kernel.printf", "hello %s", "world")
 # This method has a hash argument.
 QC.enqueue("Kernel.puts", {"hello" => "world"})
 
-# This method has a array argument.
+# This method has an array argument.
 QC.enqueue("Kernel.puts", ["hello", "world"])
 ```
 
@@ -219,7 +198,7 @@ p_queue.enqueue("Kernel.printf", "hello %s", "world")
 # This method has a hash argument.
 p_queue.enqueue("Kernel.puts", {"hello" => "world"})
 
-# This method has a array argument.
+# This method has an array argument.
 p_queue.enqueue("Kernel.puts", ["hello", "world"])
 ```
 
@@ -265,8 +244,7 @@ trap('TERM') {exit}
 
 require "your_app"
 require "queue_classic"
-worker = QC::Worker.new(q_name, top_bound, fork_worker, listening_worker, max_attempts)
-worker.start
+QC::Worker.new.start
 ```
 
 #### Sublcass QC::Worker
@@ -312,8 +290,7 @@ require "your_app"
 require "queue_classic"
 require "my_worker"
 
-worker = MyWorker.new(q_name, top_bound, fork_worker, listening_worker, max_attempts)
-worker.start
+MyWorker.new.start
 ```
 
 #### QC::Worker Details

data/sql/drop_ddl.sql

@@ -1,2 +1,3 @@
 DROP FUNCTION IF EXISTS lock_head(tname varchar);
 DROP FUNCTION IF EXISTS lock_head(tname name, top_boundary integer);
+DROP FUNCTION IF EXISTS lock_head(q_name varchar, top_boundary integer)

data/test/helper.rb

@@ -19,9 +19,8 @@ class QCTest < MiniTest::Unit::TestCase
 
   def init_db(table_name="queue_classic_jobs")
     QC::Conn.execute("SET client_min_messages TO 'warning'")
-    QC::Conn.execute("DROP TABLE IF EXISTS #{table_name} CASCADE")
-    QC::Conn.execute("CREATE TABLE #{table_name} (id serial, q_name varchar(255), method varchar(255), args text, locked_at timestamptz)")
-    QC::Queries.load_functions
+    QC::Setup.drop
+    QC::Setup.create
     QC::Conn.disconnect
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: queue_classic
 version: !ruby/object:Gem::Version
-  version: 2.0.0rc12
+  version: 2.0.0rc13
   prerelease: 5
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &11432220 !ruby/object:Gem::Requirement
+  requirement: &18438700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.13.2
   type: :runtime
   prerelease: false
-  version_requirements: *11432220
+  version_requirements: *18438700
 - !ruby/object:Gem::Dependency
   name: scrolls
-  requirement: &11431140 !ruby/object:Gem::Requirement
+  requirement: &18438040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 0.0.8
   type: :runtime
   prerelease: false
-  version_requirements: *11431140
+  version_requirements: *18438040
 description: queue_classic is a queueing library for Ruby apps. (Rails, Sinatra, Etc...)
   queue_classic features asynchronous job polling, database maintained locks and no
   ridiculous dependencies. As a matter of fact, queue_classic only requires pg.
@@ -49,6 +49,7 @@ files:
 - lib/queue_classic/worker.rb
 - lib/queue_classic/queue.rb
 - lib/queue_classic/tasks.rb
+- lib/queue_classic/setup.rb
 - lib/queue_classic/queries.rb
 - lib/queue_classic.rb
 - test/worker_test.rb