jmongo 1.1.2 → 1.1.3

data/Gemfile

@@ -5,4 +5,7 @@ gem 'rake'
 gem 'shoulda'
 gem 'mocha'
 
-
+if RUBY_PLATFORM !~ /java/
+  gem 'bson_ext'
+  gem 'mongo'
+end

data/Gemfile.lock

@@ -32,6 +32,7 @@ GEM
 
 PLATFORMS
   java
+  ruby
 
 DEPENDENCIES
   awesome_print (~> 0.4)

data/README.txt

@@ -26,7 +26,7 @@ the collection and cursor test suites pass. NOTE: a few (2/3) tests have been sk
 them to see if they affect you.
 
 The Mongoid rspec functional suite runs 2607 examples with 28 failures when using JMongo
-My Mongoid repo was forked after this commit (so newer funtionality/spec will be missing)
+My Mongoid repo was forked after this commit (so newer funtionality/specs will be missing)
   commit 6cc97092bc10535b8b65647a3d14b10ca1b94c8c
   Author: Bernerd Schaefer <bj.schaefer@gmail.com>
   Date:   Tue Jun 28 12:59:34 2011 +0200
@@ -36,7 +36,7 @@ The failures are classed in this way:
   * Managing Replica Sets directly
   * Managing Connection Pools directly
   * XML serialization
-  * Ruby RegExp to BSON encode and decode
+  * Ruby RegExp to BSON encode and decode (FIXED)
 
 I will fix these problems in due course
 
@@ -46,3 +46,12 @@ JMongo lets the Java driver handle reading from slaves and writing to master, al
 tested JMongo with Replica Sets yet.
 If you intend to use the fsync=true uri option to imply safe=true on your queries, at the moment you will also
 need to specify the w option in the uri. e.g. mongodb://0.0.0.0:27017/?fsync=true;w=1;
+
+2011-10-18
+  I have added non-blocking support to the Cursor if it is tailable and bound to a Capped Collection.
+  This is to have similar behaviour to the ruby driver as far as test expectations.
+  The unblocking behaviour is achieved by inserting a "poison doc" into the capped collection in a timeout thread.
+  In the Cursor.new options hash if you set await_data to hash, float or true it will not block on cursor.next.
+  a value of true will use the defaults, a value of float will set the timeout whaile a hash will allow you to
+  control the timeout as well as your own poison doc and the poison doc equality (lambda/proc) mechanism.
+  The default timeout is 0.125 seconds.

data/jmongo.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name              = 'jmongo'
-  s.version           = '1.1.2'
-  s.date              = '2011-10-10'
+  s.version           = '1.1.3'
+  s.date              = '2011-10-18'
   s.platform          = Gem::Platform::RUBY
   s.authors           = ["Chuck Remes","Guy Boertje", "Lee Henson"]
   s.email             = ["cremes@mac.com", "guyboertje@gmail.com", "lee.m.henson@gmail.com"]

data/lib/jmongo/cursor.rb

@@ -17,6 +17,8 @@ module Mongo
   class Cursor
     include Mongo::JavaImpl::Utils
 
+    NEXT_DOCUMENT_TIMEOUT = 0.125
+
     attr_reader :j_cursor, :collection, :selector, :fields,
       :order, :hint, :snapshot, :timeout,
       :full_collection_name, :transformer,
@@ -25,7 +27,6 @@ module Mongo
     def initialize(collection, options={})
       @collection = collection
       @j_collection = collection.j_collection
-      @query_run = false
       @selector   = convert_selector_for_query(options[:selector])
       @fields     = convert_fields_for_query(options[:fields])
       @admin      = options.fetch(:admin, false)
@@ -42,8 +43,25 @@ module Mongo
       @explain    = options[:explain]
       @socket     = options[:socket]
       @timeout    = options.fetch(:timeout, true)
-      @tailable   = options.fetch(:tailable, false)
       @transformer = options[:transformer]
+      @tailable   = options.fetch(:tailable, false)
+      @await_data  = @tailable ? options[:await_data] : nil
+      @next_timeout = NEXT_DOCUMENT_TIMEOUT
+      @is_poison_function = nil
+      case @await_data
+      when Hash
+        @poison_doc = @await_data.fetch(:poison_doc, default_poison_doc)
+        @is_poison_function = @await_data[:is_poison_function]
+        @next_timeout = @await_data.fetch(:next_timeout, NEXT_DOCUMENT_TIMEOUT).to_f
+      when Numeric
+        @poison_doc = default_poison_doc
+        @next_timeout = @await_data.to_f
+      when TrueClass
+        @poison_doc = default_poison_doc
+      else
+        @poison_doc = nil
+      end
+      @timeout_thread = TimeoutThread.new(@collection, @poison_doc, @next_timeout) if @tailable && @poison_doc
 
       @full_collection_name = "#{@collection.db.name}.#{@collection.name}"
 
@@ -52,12 +70,13 @@ module Mongo
 
     def rewind!
       close
-      @query_run = false
       spawn_cursor
     end
 
     def close
-      @query_run = true
+      if @j_cursor.num_seen == 0 && !@tailable
+        @j_cursor.next rescue nil
+      end
       @j_cursor.close
     end
 
@@ -74,13 +93,13 @@ module Mongo
     end
 
     def add_option(opt)
-      check_modifiable
+      raise_invalid_op if @j_cursor.num_seen != 0
       @j_cursor.addOption(opt)
       options
     end
 
     def options
-      @j_cursor.getOptions
+      @j_cursor.options
     end
 
     def query_opts
@@ -90,7 +109,7 @@ module Mongo
     end
 
     def remove_option(opt)
-      check_modifiable
+      raise_invalid_op if @j_cursor.num_seen != 0
       @j_cursor.setOptions(options & ~opt)
       options
     end
@@ -100,7 +119,15 @@ module Mongo
     end
 
     def next_document
-      _xform(has_next? ? __next : nil)
+      doc = nil
+      trap_raise(Mongo::OperationFailure) do
+        if @tailable
+          doc = __next
+        elsif has_next?
+          doc = __next
+        end
+      end
+      _xform(doc)
     end
     alias :next :next_document
 
@@ -114,12 +141,15 @@ module Mongo
     private :_xform
 
     def has_next?
-      @j_cursor.has_next?
+      if @tailable
+        true
+      else
+        @j_cursor.has_next?
+      end
     end
 
     # iterate directly from the mongo db
     def each
-      check_modifiable
       while has_next?
         yield next_document
       end
@@ -127,7 +157,6 @@ module Mongo
 
     def _batch_size(size=nil)
       return if size.nil?
-      check_modifiable
       raise ArgumentError, "batch_size requires an integer" unless size.is_a? Integer
       @batch_size = size
     end
@@ -140,8 +169,7 @@ module Mongo
     end
 
     def _limit(number_to_return=nil)
-      return if number_to_return.nil?
-      check_modifiable
+      return if number_to_return.nil? && @limit
       raise ArgumentError, "limit requires an integer" unless number_to_return.is_a? Integer
       @limit = number_to_return
     end
@@ -150,14 +178,13 @@ module Mongo
     def limit(number_to_return=nil)
       _limit(number_to_return)
       wrap_invalid_op do
-        @j_cursor = @j_cursor.limit(@limit) if @limit
+        @j_cursor = @j_cursor.limit(@limit)
       end
       self
     end
 
     def _skip(number_to_skip=nil)
-      return if number_to_skip.nil?
-      check_modifiable
+      return if number_to_skip.nil? && @skip
       raise ArgumentError, "skip requires an integer" unless number_to_skip.is_a? Integer
       @skip = number_to_skip
     end
@@ -166,14 +193,13 @@ module Mongo
     def skip(number_to_skip=nil)
       _skip(number_to_skip)
       wrap_invalid_op do
-        @j_cursor = @j_cursor.skip(@skip) if @skip
+        @j_cursor = @j_cursor.skip(@skip)
       end
       self
     end
 
     def _sort(key_or_list=nil, direction=nil)
-      return if key_or_list.nil?
-      check_modifiable
+      return if key_or_list.nil? && @order
       @order = prep_sort(key_or_list, direction)
     end
     private :_sort
@@ -181,7 +207,7 @@ module Mongo
     def sort(key_or_list, direction=nil)
       _sort(key_or_list, direction)
       wrap_invalid_op do
-        @j_cursor = @j_cursor.sort(@order) if @order
+        @j_cursor = @j_cursor.sort(@order)
       end
       self
     end
@@ -191,11 +217,12 @@ module Mongo
     end
 
     def count(skip_and_limit = false)
-      if skip_and_limit && @skip && @limit
-        check_modifiable
-        @j_cursor.size
-      else
-        @j_cursor.count
+      wrap_invalid_op do
+        if skip_and_limit && @skip && @limit
+          @j_cursor.size
+        else
+          @j_cursor.count
+        end
       end
     end
 
@@ -225,11 +252,45 @@ module Mongo
       Set.new self.to_a
     end
 
+    def done_size
+      @j_cursor.num_seen
+    end
+
+    def to_do_size
+      @j_cursor.size - @j_cursor.num_seen
+    end
+
     private
 
+    def default_poison_doc
+      { 'jmongo_poison_document' => true }
+    end
+
+    def default_is_poison?(doc)
+      !!doc['jmongo_poison_document']
+    end
+
     def __next
-      @query_run = true
-      from_dbobject(@j_cursor.next)
+      @timeout_thread.trigger if @tailable
+      doc = from_dbobject(@j_cursor.next)
+      if @tailable
+        if poisoned?(doc)
+          nil
+        else
+          @timeout_thread.cancel
+          doc
+        end
+      else
+        doc
+      end
+    end
+
+    def poisoned?(doc)
+      if @is_poison_function
+        @is_poison_function.call(doc)
+      else
+        default_is_poison?(doc)
+      end
     end
 
     # Convert the +:fields+ parameter from a single field name or an array
@@ -260,19 +321,26 @@ module Mongo
         @j_cursor = @j_cursor.sort(@order) if @order
         @j_cursor = @j_cursor.skip(@skip) if @skip && @skip > 0
         @j_cursor = @j_cursor.limit(@limit) if @limit && @limit > 0
+        @j_cursor = @j_cursor.hint(@hint) if @hint
+        @j_cursor = @j_cursor.snapshot if @snapshot
         @j_cursor = @j_cursor.batchSize(@batch_size) if @batch_size && @batch_size > 0
-
-        @j_cursor = @j_cursor.addOption JMongo::Bytes::QUERYOPTION_NOTIMEOUT unless @timeout
-        @j_cursor = @j_cursor.addOption JMongo::Bytes::QUERYOPTION_TAILABLE if @tailable
+        opts_bf = @j_cursor.options
+        opts_bf = mask_option(opts_bf, JMongo::Bytes::QUERYOPTION_NOTIMEOUT, !@timeout)
+        opts_bf = mask_option(opts_bf, JMongo::Bytes::QUERYOPTION_TAILABLE, !!@tailable)
+        opts_bf = mask_option(opts_bf, JMongo::Bytes::QUERYOPTION_AWAITDATA, !!@await_data)
+        @j_cursor.options = opts_bf
       end
 
       self
     end
 
-    def check_modifiable
-      if @query_run
-        raise_invalid_op
+    def mask_option(bitfield, bit, set = true)
+      if set
+        bitfield |= bit
+      else
+        bitfield &= ~bit
       end
+      bitfield
     end
 
     def wrap_invalid_op

data/lib/jmongo/mongo/utils.rb

@@ -1,6 +1,48 @@
 # Copyright (C) 2010 Guy Boertje
 
 module Mongo
+
+  class TimeoutThread
+    attr_reader :thread, :timeout
+    def initialize(collection, doc, timeout)
+      @collection = collection
+      @doc = doc
+      @timeout = timeout
+      @queue = SizedQueue.new(1)
+      spawn_thread
+    end
+
+    def trigger
+      @queue.push(true) if @queue.length == 0
+    end
+
+    def cancel
+      return if @thread[:cancel]
+      @thread[:cancel] = true
+    end
+
+    def stop
+      @queue.push false
+    end
+
+    private
+
+    def spawn_thread
+      @thread = Thread.new do
+        while true
+          going = @queue.pop
+          break if !going
+          sleep @timeout
+          unless Thread.current[:cancel]
+            @collection.insert(@doc)
+          end
+          Thread.current[:cancel] = false
+        end
+      end
+      @thread[:cancel] = false
+    end
+  end
+
   module JavaImpl
 
     module NoImplYetClass
@@ -10,6 +52,7 @@ module Mongo
     end
 
     module Utils
+            
       def raise_not_implemented
         raise NoMethodError, "This method hasn't been implemented yet."
       end

data/lib/jmongo/version.rb

@@ -1,3 +1,3 @@
 module Mongo
-  VERSION = '1.1.2'
+  VERSION = '1.1.3'
 end

data/test/collection_test.rb

@@ -878,41 +878,61 @@ describe "Collection" do
     end
   end
 
-  # describe "Capped collections" do
-  #   before do
-  #     Cfg.db.drop_collection('log')
-  #     @capped = Cfg.db.create_collection('log', :capped => true, :size => 1024)
-
-  #     10.times { |n| @capped.insert({:n => n}) }
-  #   end
-
-  #   it "should find using a standard cursor" do
-  #     cursor = @capped.find
-  #     10.times do
-  #       assert cursor.next_document
-  #     end
-  #     assert_nil cursor.next_document
-  #     @capped.insert({:n => 100})
-  #     assert_nil cursor.next_document
-  #   end
-
-  #   it "should fail tailable cursor on a non-capped collection" do
-  #     col = Cfg.db['regular-collection']
-  #     col.insert({:a => 1000})
-  #     tail = Cursor.new(col, :tailable => true, :order => [['$natural', 1]])
-  #     assert_raises OperationFailure do
-  #       tail.next_document
-  #     end
-  #   end
-
-  #   it "should find using a tailable cursor" do
-  #     tail = Cursor.new(@capped, :tailable => true, :order => [['$natural', 1]])
-  #     10.times do
-  #       assert tail.next_document
-  #     end
-  #     assert_nil tail.next_document
-  #     @capped.insert({:n => 100})
-  #     assert tail.next_document
-  #   end
-  # end
+  describe "Capped collections" do
+    before do
+      Cfg.db.drop_collection('log')
+      @capped = Cfg.db.create_collection('log', :capped => true, :max => 1000, :size => 400000)
+
+      1000.times { |n| @capped.insert({:n => n}) }
+    end
+
+    it "should find using a standard cursor" do
+      cursor = @capped.find
+      1000.times do
+        assert cursor.next_document
+      end
+      assert_nil cursor.next_document
+      @capped.insert({:n => 100})
+      assert_nil cursor.next_document
+    end
+
+    it "should fail tailable cursor on a non-capped collection" do
+      col = Cfg.db['regular-collection']
+      col.insert({:a => 1000})
+      tail = Mongo::Cursor.new(col, :tailable => true, :order => [['$natural', 1]])
+      assert_raises Mongo::OperationFailure do
+        tail.next_document
+      end
+    end
+
+    it "should find using a tailable cursor" do
+      tail = Mongo::Cursor.new(@capped, :timeout => false, :tailable => true, :await_data => true, :order => [['$natural', 1]])
+      1000.times do
+        assert tail.next_document
+      end
+      assert true, tail.has_next?
+      assert_nil tail.next_document
+    end
+
+    it "should find using a tailable cursor with await_data set to a float" do
+      tail = Mongo::Cursor.new(@capped, :timeout => false, :tailable => true, :await_data => 3.0, :order => [['$natural', 1]])
+      1000.times do
+        assert tail.next_document
+      end
+      assert true, tail.has_next?
+      assert_nil tail.next_document
+    end
+
+    it "should find using a tailable cursor with await_data set to hash" do
+      await = {:poison_doc => {'pppppoisoned' => 42},
+               :is_poison_function => lambda { |doc| doc['pppppoisoned'] == 42 },
+               :next_timeout => 2.0}
+      tail = Mongo::Cursor.new(@capped, :timeout => false, :tailable => true, :await_data => await, :order => [['$natural', 1]])
+      1000.times do
+        assert tail.next_document
+      end
+      assert true, tail.has_next?
+      assert_nil tail.next_document
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jmongo
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-10 00:00:00.000000000 Z
+date: 2011-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
-  requirement: &10546520 !ruby/object:Gem::Requirement
+  requirement: &10865120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *10546520
+  version_requirements: *10865120
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &10546040 !ruby/object:Gem::Requirement
+  requirement: &10864640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *10546040
+  version_requirements: *10864640
 - !ruby/object:Gem::Dependency
   name: fuubar
-  requirement: &10545480 !ruby/object:Gem::Requirement
+  requirement: &10864180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: '0.0'
   type: :development
   prerelease: false
-  version_requirements: *10545480
+  version_requirements: *10864180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10544920 !ruby/object:Gem::Requirement
+  requirement: &10863300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,7 +56,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *10544920
+  version_requirements: *10863300
 description: Thin jruby wrapper around Mongo Java Driver
 email:
 - cremes@mac.com
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Thin ruby wrapper around Mongo Java Driver; for JRuby only