acts_as_queue 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in acts_as_queue.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2010, Matthew Lang 
+
+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

@@ -0,0 +1,27 @@
+= acts_as_queue
+
+acts_as_queue is a plugin for ActiveRecord that allows you to turn any of your ActiveRecord models into a queue.
+
+== Using the default queue size
+
+  class Post < ActiveRecord::Base
+    acts_as_queue
+  end
+  
+  # Pushing new posts onto the queue.
+  Post.push :name => "Hello World"
+  Post.push :name => "Using Rails"
+  
+  # Popping the item at the front of the queue.
+  Post.pop
+  
+== Using a queue size
+
+  class Message < ActiveRecord::Base
+    acts_as_queue :size => 10
+  end
+  
+  # Pushing 20 new messages onto the queue.
+ (1..20).each { |i| Message.push :description => "Message #{i}" } 
+ 
+ Message.count # Just 10 messages on the queue

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run acts_as_queue unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_queue gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/acts_as_queue.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_queue"
+  s.version     = "0.1.2"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matthew Lang"]
+  s.email       = ["matthew@matthewlang.co.uk"]
+  s.homepage    = "http://github.com/matthewl/acts_as_queue"
+  s.summary     = %q{Allows you to turn your ActiveRecord models into queues.}
+  s.description = %q{Allows you to turn your ActiveRecord models into queues.}
+
+  s.add_development_dependency "shoulda", [">= 2.11.3"]
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/init.rb

@@ -0,0 +1 @@
+require 'acts_as_queue'

data/lib/acts_as_queue.rb

@@ -0,0 +1,41 @@
+module ActsAsQueue
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    
+    def acts_as_queue(options = {})
+      configuration = { :size => "0" }
+      configuration.update(options) if options.is_a?(Hash)
+      
+      class_eval <<-EOV
+        
+        def self.queue_size
+          '#{configuration[:size]}'.to_i
+        end
+      EOV
+    end
+    
+    def push(attributes)
+      if (self.queue_size > 0) && (self.count == self.queue_size)
+        popped = self.pop
+      end
+      
+      self.create(attributes)   
+    end
+    
+    def pop
+      attributes = self.first.attributes
+      self.first.delete
+      attributes.inject({}) { |attribute,(k,v)| attribute[k.to_sym] = v; attribute } 
+    end
+    
+    def count
+      self.find(:all).count
+    end
+  end    
+end
+
+ActiveRecord::Base.class_eval { include ActsAsQueue }

data/test/acts_as_queue_test.rb

@@ -0,0 +1,113 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'shoulda'
+
+require "#{File.dirname(__FILE__)}/../init.rb"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Migration.verbose = false
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :posts do |t|
+      t.string :name
+      t.string :slug
+      t.timestamps
+    end
+    
+    create_table :messages do |t|
+      t.string :description
+      t.timestamps
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Post < ActiveRecord::Base
+  acts_as_queue
+end
+
+class Message < ActiveRecord::Base
+  acts_as_queue :size => 3
+end
+
+class QueueTest < Test::Unit::TestCase
+  
+  def setup
+    setup_db
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  context "A default queue model" do
+    
+    should "have a zero queue size" do
+      assert_equal 0, Post.queue_size
+    end
+    
+    should "push items on the queue" do
+      Post.push(:name => "How to write a Ruby app in 5 minutes", :slug => "write-app-5-minutes")
+      assert_equal 1, Post.count
+      assert_equal "How to write a Ruby app in 5 minutes", Post.first.name
+      assert_equal "write-app-5-minutes", Post.first.slug
+
+      Post.push(:name => "Debug your gems like a pro!", :slug => "debug-gems-like-pro")
+      assert_equal 2, Post.count    
+      assert_equal "Debug your gems like a pro!", Post.last.name
+      assert_equal "debug-gems-like-pro", Post.last.slug
+    end
+    
+    should "allow items to be popped" do
+      (1..2).each { |i| Post.push :name => "Post #{i}" }  
+      assert_equal 2, Post.count
+
+      Post.pop
+      assert_equal 1, Post.count
+      assert_equal "Post 2", Post.first.name
+    end
+
+    should "return popped items as a hash" do
+      (1..2).each { |i| Post.push :name => "Post #{i}" }  
+      popped = Post.pop
+
+      assert_kind_of Hash, popped
+      assert_equal "Post 1", popped[:name]
+    end
+    
+  end
+  
+  context "A custom queue model" do
+    
+    should "allow a custom queue size" do
+      assert_equal 3, Message.queue_size
+    end
+
+    should "push items on the queue" do
+      (1..3).each { |i| Message.push :description => "Message #{i}" }    
+      assert_equal 3, Message.count
+    end
+
+    should "automatically pop items if the queue size has been reached" do
+      (1..3).each { |i| Message.push :description => "Message #{i}" }
+      assert_equal 3, Message.count
+
+      Message.push :description => "Message 4"
+      assert_equal 3, Message.count
+      assert_equal "Message 4", Message.last.description
+      assert_equal "Message 2", Message.first.description
+
+      Message.push :description => "Message 5"
+      assert_equal 3, Message.count
+      assert_equal "Message 5", Message.last.description
+      assert_equal "Message 3", Message.first.description
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_queue
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Matthew Lang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 +01:00
+date: 2010-10-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,8 +43,16 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- acts_as_queue.gemspec
+- init.rb
+- lib/acts_as_queue.rb
+- test/acts_as_queue_test.rb
 has_rdoc: true
 homepage: http://github.com/matthewl/acts_as_queue
 licenses: []
@@ -79,5 +87,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Allows you to turn your ActiveRecord models into queues.
-test_files: []
-
+test_files: 
+- test/acts_as_queue_test.rb