acts_as_queue 0.1.2 → 0.1.3

data/README.rdoc

@@ -0,0 +1,31 @@
+= acts_as_queue
+
+<tt>acts_as_queue</tt> is a gem for ActiveRecord that allows you to turn any of your ActiveRecord models into a queue.
+
+acts_as_queue provides you with methods to simplify using your ActiveRecord as a queue. The two key methods it provides are <tt>Push</tt> and <tt>Pop</tt>.
+
+<tt>Push</tt> is used when you want to add an item to your queue. <tt>Pop</tt> is used when you need to process or remove the earliest item from your queue.
+
+== Using the default unbounded queue
+
+  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 bounded queue
+
+  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/acts_as_queue.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "acts_as_queue"
-  s.version     = "0.1.2"
+  s.version     = "0.1.3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Matthew Lang"]
   s.email       = ["matthew@matthewlang.co.uk"]

data/lib/acts_as_queue.rb

@@ -4,8 +4,27 @@ module ActsAsQueue
     base.extend(ClassMethods)
   end
   
+  # +acts_as_queue+ allows you to turn any ActiveRecord model into a queue, providing you with the necessary actions to manipulate your model.
+  # The class also allows you to define a queue size so that your queue can then become a bounded queue.
+  #
+  # acts_as_queue example
+  #
+  #  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
   module ClassMethods
     
+    # Configuration options are:
+    #
+    # +size+ - specifies the bounded queue size.
+    # Example: +acts_as_queue :size => 20+
     def acts_as_queue(options = {})
       configuration = { :size => "0" }
       configuration.update(options) if options.is_a?(Hash)
@@ -18,6 +37,7 @@ module ActsAsQueue
       EOV
     end
     
+    # Pushes an item onto the queue.
     def push(attributes)
       if (self.queue_size > 0) && (self.count == self.queue_size)
         popped = self.pop
@@ -26,12 +46,14 @@ module ActsAsQueue
       self.create(attributes)   
     end
     
+    # Pops the earliest item from the queue.
     def pop
       attributes = self.first.attributes
       self.first.delete
       attributes.inject({}) { |attribute,(k,v)| attribute[k.to_sym] = v; attribute } 
     end
     
+    # Returns the number of items in the queue.
     def count
       self.find(:all).count
     end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_queue
 version: !ruby/object:Gem::Version 
-  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Matthew Lang
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 +01:00
+date: 2010-11-06 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 37
         segments: 
         - 2
         - 11
@@ -47,7 +44,7 @@ files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
-- README
+- README.rdoc
 - Rakefile
 - acts_as_queue.gemspec
 - init.rb
@@ -63,27 +60,23 @@ rdoc_options: []
 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
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Allows you to turn your ActiveRecord models into queues.

data/README

@@ -1,27 +0,0 @@
-= 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