q4m 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kazuyoshi tlacaelel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= q4m
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 kazuyoshi tlacaelel. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "q4m"
+    gem.summary = %Q{Queue job for the Q4M MySQL engine}
+    gem.description = %Q{Interface to pragmatically setup a queue job for Q4M!}
+    gem.email = "kazu.dev@gmail.com"
+    gem.homepage = "http://github.com/ktlacaelel/q4m"
+    gem.authors = ["kazuyoshi tlacaelel"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "q4m #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/q4m.rb

@@ -0,0 +1,130 @@
+require 'rubygems'
+require 'mysql'
+require 'logger'
+
+module Q4m
+
+  module Queue
+
+    class Job
+
+      # Job initializer.
+      #
+      # ::mysql:: a Mysql instance
+      # ::log:: a Logger instance
+      #
+      def initialize mysql, log
+        @mysql, @log = mysql, log
+        look_for_jobs!
+      end
+
+      # Job runner.
+      #
+      # - Locks the queue.
+      # - Executes the latest job.
+      # - Restores the queue so other worker can execute a process.
+      #
+      def run
+        return unless @has_jobs
+        queue_wait
+        execute latest_job
+        queue_end
+      end
+
+      private
+
+      # Job availability checker.
+      #
+      # Check if queue has any jobs.
+      #
+      def look_for_jobs!
+        @has_jobs = true
+        @mysql.query("select count(*) from #{table_name}").each do |queue|
+          if queue == ['0']
+            @has_jobs = false
+            @log.warn 'No job in queue'
+          end
+        end
+      end
+
+      protected
+
+      # Latest job fetcher.
+      #
+      # Retrives one mysql record representing a queue-job.
+      #
+      def latest_job
+        @mysql.query("select * from #{table_name}").each do |job|
+          return job
+        end
+      end
+
+      # Job locker.
+      #
+      # Tells the queue to operate in locked mode. By pulling out the
+      # latest job, and locking the whole queue-stack.
+      #
+      # When anyone tries to pull jobs from the queue the very same
+      # job will be returned until the queue status is changed with
+      # one of the following options:
+      #
+      #  - terminated (queue_end)
+      #  - aborted    (queue_abort)
+      #
+      def queue_wait
+        @mysql.query "select queue_wait('#{table_name}')"
+      end
+
+      # Job unlocker.
+      #
+      # Tells the q4m engine that this job is terminated. Then mysql
+      # will internally delete the job from the queue/database.
+      #
+      # Once this is done all jobs will be available until someone
+      # locks the queue again.
+      #
+      def queue_end
+        @mysql.query 'select queue_end()'
+      end
+
+      # Job rollback.
+      #
+      # This method should be executed after the queue has been locked
+      # only!
+      #
+      # If executed, it'll tell the engine that the job failed to be
+      # terminated and should stay in the queue for later processing.
+      #
+      # When this happens the job is restored to the queue for later
+      # processing. But you should still unlock the queue so it can
+      # start serving other workers
+      #
+      def queue_abort
+        @mysql.query 'select queue_abort()'
+      end
+
+      # Job table name.
+      #
+      # This method is here so child classes should define the tablename
+      # that they pull out jobs from!
+      #
+      # TODO: resolve tablename by underscoring child-class name.
+      #
+      def table_name
+        raise 'Must implement in a child class!'
+      end
+
+      # Job execution.
+      #
+      # Child classes should define how exactly the job is to be
+      # executed!
+      #
+      def execute job
+        raise 'Must implement in a child class!'
+      end
+
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'q4m'
+
+class Test::Unit::TestCase
+end

data/test/test_q4m.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestQ4m < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: q4m
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- kazuyoshi tlacaelel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-04 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Interface to pragmatically setup a queue job for Q4M!
+email: kazu.dev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/q4m.rb
+- test/helper.rb
+- test/test_q4m.rb
+has_rdoc: true
+homepage: http://github.com/ktlacaelel/q4m
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Queue job for the Q4M MySQL engine
+test_files: 
+- test/helper.rb
+- test/test_q4m.rb