couchbase 1.2.1 → 1.2.2

data/lib/couchbase.rb

@@ -21,6 +21,7 @@ require 'ext/multi_json_fix'
 require 'yaji'
 require 'uri'
 require 'couchbase_ext'
+require 'couchbase/constants'
 require 'couchbase/utils'
 require 'couchbase/bucket'
 require 'couchbase/view_row'

data/lib/couchbase/bucket.rb

@@ -109,7 +109,7 @@ module Couchbase
           if obj['doc']
             obj['doc']['value'] = obj['doc'].delete('json')
           end
-          doc = ViewRow.wrap(self, obj)
+          doc = DesignDoc.wrap(self, obj)
           key = doc.id.sub(/^_design\//, '')
           next if self.environment == :production && key =~ /dev_/
             docmap[key] = doc

data/lib/couchbase/constants.rb

@@ -0,0 +1,12 @@
+module Couchbase
+  module Constants # :nodoc:
+    S_ID = 'id'.freeze
+    S_DOC = 'doc'.freeze
+    S_VALUE = 'value'.freeze
+    S_META = 'meta'.freeze
+    S_FLAGS = 'flags'.freeze
+    S_CAS = 'cas'.freeze
+    S_KEY = 'key'.freeze
+    S_IS_LAST = Object.new.freeze
+  end
+end

data/lib/couchbase/version.rb

@@ -17,5 +17,5 @@
 
 # Couchbase ruby client
 module Couchbase
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/couchbase/view.rb

@@ -47,8 +47,9 @@ module Couchbase
         str = super
         if @type || @reason
           str.sub(/ \(/, ": #{[@type, @reason].compact.join(": ")} (")
+        else
+          str
         end
-        str
       end
     end
   end
@@ -58,6 +59,88 @@ module Couchbase
   # @see http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views.html
   class View
     include Enumerable
+    include Constants
+
+    class ArrayWithTotalRows < Array # :nodoc:
+      attr_accessor :total_rows
+      alias total_entries total_rows
+    end
+
+    class AsyncHelper # :nodoc:
+      include Constants
+      EMPTY = []
+
+      def initialize(wrapper_class, bucket, include_docs, quiet, block)
+        @wrapper_class = wrapper_class
+        @bucket = bucket
+        @block = block
+        @quiet = quiet
+        @include_docs = include_docs
+        @queue = []
+        @first = @shift = 0
+        @completed = false
+      end
+
+      # Register object in the emitter.
+      def push(obj)
+        if @include_docs
+          @queue << obj
+          @bucket.get(obj[S_ID], :extended => true, :quiet => @quiet) do |res|
+            obj[S_DOC] = {
+              S_VALUE => res.value,
+              S_META => {
+                S_ID => obj[S_ID],
+                S_FLAGS => res.flags,
+                S_CAS => res.cas
+              }
+            }
+            check_for_ready_documents
+          end
+        else
+          old_obj = @queue.shift
+          @queue << obj
+          block_call(old_obj) if old_obj
+        end
+      end
+
+      def complete!
+        if @include_docs
+          @completed = true
+          check_for_ready_documents
+        elsif !@queue.empty?
+          obj = @queue.shift
+          obj[S_IS_LAST] = true
+          block_call obj
+        end
+      end
+
+      private
+
+      def block_call(obj)
+        @block.call @wrapper_class.wrap(@bucket, obj)
+      end
+
+      def check_for_ready_documents
+        shift = @shift
+        queue = @queue
+        save_last = @completed ? 0 : 1
+        while @first < queue.size + shift - save_last
+          obj = queue[@first - shift]
+          break unless obj[S_DOC]
+          queue[@first - shift] = nil
+          @first += 1
+          if @completed && @first == queue.size + shift
+            obj[S_IS_LAST] = true
+          end
+          block_call obj
+        end
+        if @first - shift > queue.size / 2
+          queue[0, @first - shift] = EMPTY
+          @shift = @first
+        end
+      end
+
+    end
 
     attr_reader :params
 
@@ -112,6 +195,16 @@ module Couchbase
       fetch(params) {|doc| yield(doc)}
     end
 
+    def first(params = {})
+      params = params.merge(:limit => 1)
+      fetch(params).first
+    end
+
+    def take(n, params = {})
+      params = params.merge(:limit => n)
+      fetch(params)
+    end
+
     # Registers callback function for handling error objects in view
     # results stream.
     #
@@ -259,93 +352,150 @@ module Couchbase
     #   doc.recent_posts_with_comments(:start_key => [post_id, 0],
     #                                  :end_key => [post_id, 1],
     #                                  :include_docs => true)
-    def fetch(params = {})
+    def fetch(params = {}, &block)
       params = @params.merge(params)
+      include_docs = params.delete(:include_docs)
+      quiet = params.delete(:quiet){ true }
+
       options = {:chunked => true, :extended => true, :type => :view}
       if body = params.delete(:body)
         body = MultiJson.dump(body) unless body.is_a?(String)
         options.update(:body => body, :method => params.delete(:method) || :post)
       end
-      include_docs = params.delete(:include_docs)
-      quiet = true
-      if params.has_key?(:quiet)
-        quiet = params.delete(:quiet)
-      end
       path = Utils.build_query(@endpoint, params)
       request = @bucket.make_http_request(path, options)
-      res = []
+
+      if @bucket.async?
+        if block
+          fetch_async(request, include_docs, quiet, block)
+        end
+      else
+        fetch_sync(request, include_docs, quiet, block)
+      end
+    end
+
+    # Method for fetching asynchronously all rows and passing array to callback
+    #
+    # Parameters are same as for {View#fetch} method, but callback is called for whole set for
+    # rows instead of one by each.
+    #
+    # @example
+    #   con.run do
+    #     doc.recent_posts.fetch_all do |posts|
+    #       do_something_with_all_posts(posts)
+    #     end
+    #   end
+    def fetch_all(params = {}, &block)
+      return fetch(params) unless @bucket.async?
+      raise ArgumentError, "Block needed for fetch_all in async mode" unless block
+
+      all = []
+      fetch(params) do |row|
+        all << row
+        if row.last?
+          @bucket.create_timer(0) { block.call(all) }
+        end
+      end
+    end
+
+
+    # Returns a string containing a human-readable representation of the {View}
+    #
+    # @return [String]
+    def inspect
+      %(#<#{self.class.name}:#{self.object_id} @endpoint=#{@endpoint.inspect} @params=#{@params.inspect}>)
+    end
+
+    private
+
+    def send_error(*args)
+      if @on_error
+        @on_error.call(*args.take(2))
+      else
+        raise Error::View.new(*args)
+      end
+    end
+
+    def fetch_async(request, include_docs, quiet, block)
+      filter = ["/rows/", "/errors/"]
+      parser = YAJI::Parser.new(:filter => filter, :with_path => true)
+      helper = AsyncHelper.new(@wrapper_class, @bucket, include_docs, quiet, block)
+
       request.on_body do |chunk|
-        res << chunk
-        request.pause if chunk.value.nil? || chunk.error
+        if chunk.success?
+          parser << chunk.value if chunk.value
+          helper.complete! if chunk.completed?
+        else
+          send_error("http_error", chunk.error)
+        end
+      end
+
+      parser.on_object do |path, obj|
+        case path
+        when "/errors/"
+          from, reason = obj["from"], obj["reason"]
+          send_error(from, reason)
+        else
+          helper.push(obj)
+        end
       end
+
+      request.perform
+      nil
+    end
+
+    def fetch_sync(request, include_docs, quiet, block)
+      res = []
       filter = ["/rows/", "/errors/"]
-      filter << "/total_rows" unless block_given?
+      unless block
+        filter << "/total_rows"
+        docs = ArrayWithTotalRows.new
+      end
       parser = YAJI::Parser.new(:filter => filter, :with_path => true)
-      docs = []
+      last_chunk = nil
+
+      request.on_body do |chunk|
+        last_chunk = chunk
+        res << chunk.value  if chunk.success?
+      end
+
       parser.on_object do |path, obj|
         case path
         when "/total_rows"
           # if total_rows key present, save it and take next object
-          docs.instance_eval("def total_rows; #{obj}; end")
+          docs.total_rows = obj
         when "/errors/"
           from, reason = obj["from"], obj["reason"]
-          if @on_error
-            @on_error.call(from, reason)
-          else
-            raise Error::View.new(from, reason)
-          end
+          send_error(from, reason)
         else
           if include_docs
-            val, flags, cas = @bucket.get(obj['id'], :extended => true, :quiet => quiet)
-            obj['doc'] = {
-              'value' => val,
-              'meta' => {
-                'id' => obj['id'],
-                'flags' => flags,
-                'cas' => cas
+            val, flags, cas = @bucket.get(obj[S_ID], :extended => true, :quiet => quiet)
+            obj[S_DOC] = {
+              S_VALUE => val,
+              S_META => {
+                S_ID => obj[S_ID],
+                S_FLAGS => flags,
+                S_CAS => cas
               }
             }
           end
-          if block_given?
-            yield @wrapper_class.wrap(@bucket, obj)
-          else
-            docs << @wrapper_class.wrap(@bucket, obj)
-          end
+          doc = @wrapper_class.wrap(@bucket, obj)
+          block ? block.call(doc) : docs << doc
         end
       end
-      # run event loop until the terminating chunk will be found
-      # last_res variable keeps latest known chunk of the result
-      last_res = nil
-      while true
-        # feed response received chunks to the parser
-        while r = res.shift
-          if r.error
-            if @on_error
-              @on_error.call("http_error", r.error)
-              break
-            else
-              raise Error::View.new("http_error", r.error, nil)
-            end
-          end
-          last_res = r
-          parser << r.value
-        end
-        if last_res.nil? || !last_res.completed?  # shall we run the event loop?
-          request.continue
-        else
-          break
+
+      request.continue
+
+      if last_chunk.success?
+        while value = res.shift
+          parser << value
         end
+      else
+        send_error("http_error", last_chunk.error, nil)
       end
-      # return nil for call with block
-      block_given? ? nil : docs
-    end
-
 
-    # Returns a string containing a human-readable representation of the {View}
-    #
-    # @return [String]
-    def inspect
-      %(#<#{self.class.name}:#{self.object_id} @endpoint=#{@endpoint.inspect} @params=#{@params.inspect}>)
+      # return nil for call with block
+      docs
     end
   end
 end

data/lib/couchbase/view_row.rb

@@ -20,11 +20,11 @@ module Couchbase
   #
   # @since 1.2.0
   #
-  # It behaves like Hash, but also defines special methods for each view if
-  # the documnent considered as Design document.
+  # It behaves like Hash for document included into row, and has access methods to row data as well.
   #
   # @see http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-datastore.html
   class ViewRow
+    include Constants
 
     # Undefine as much methods as we can to free names for views
     instance_methods.each do |m|
@@ -84,26 +84,11 @@ module Couchbase
     # @return [Hash]
     attr_accessor :meta
 
-    # The list of views defined or empty array
-    #
-    # @since 1.2.0
-    #
-    # @return [Array<View>]
-    attr_accessor :views
-
-    # The list of spatial views defined or empty array
-    #
-    # @since 1.2.0
-    #
-    # @return [Array<View>]
-    attr_accessor :spatial
-
     # Initialize the document instance
     #
     # @since 1.2.0
     #
-    # It takes reference to the bucket, data hash. It will define view
-    # methods if the data object looks like design document.
+    # It takes reference to the bucket, data hash.
     #
     # @param [Couchbase::Bucket] bucket the reference to connection
     # @param [Hash] data the data hash, which was built from JSON document
@@ -111,37 +96,14 @@ module Couchbase
     def initialize(bucket, data)
       @bucket = bucket
       @data = data
-      @key = data['key']
-      @value = data['value']
-      if data['doc']
-        @meta = data['doc']['meta']
-        @doc = data['doc']['value']
-      end
-      @id = data['id'] || @meta && @meta['id']
-      @views = []
-      @spatial = []
-      if design_doc?
-        if @doc.has_key?('views')
-          @doc['views'].each do |name, _|
-            @views << name
-            self.instance_eval <<-EOV, __FILE__, __LINE__ + 1
-              def #{name}(params = {})
-                View.new(@bucket, "\#{@id}/_view/#{name}", params)
-              end
-            EOV
-          end
-        end
-        if @doc.has_key?('spatial')
-          @doc['spatial'].each do |name, _|
-            @spatial << name
-            self.instance_eval <<-EOV, __FILE__, __LINE__ + 1
-              def #{name}(params = {})
-                View.new(@bucket, "\#{@id}/_spatial/#{name}", params)
-              end
-            EOV
-          end
-        end
+      @key = data[S_KEY]
+      @value = data[S_VALUE]
+      if data[S_DOC]
+        @meta = data[S_DOC][S_META]
+        @doc = data[S_DOC][S_VALUE]
       end
+      @id = data[S_ID] || @meta && @meta[S_ID]
+      @last = data.delete(S_IS_LAST) || false
     end
 
     # Wraps data hash into ViewRow instance
@@ -156,7 +118,7 @@ module Couchbase
     #
     # @return [ViewRow]
     def self.wrap(bucket, data)
-      ViewRow.new(bucket, data)
+      self.new(bucket, data)
     end
 
     # Get attribute of the document
@@ -198,33 +160,113 @@ module Couchbase
       @doc[key] = value
     end
 
-    # Check if the document is design
+    # Signals if this row is last in a stream
     #
-    # @since 1.2.0
+    # @since 1.2.1
     #
-    # @return [true, false]
-    def design_doc?
-      !!(@doc && @id =~ %r(_design/))
+    # @return [true, false] +true+ if this row is last in a stream
+    def last?
+      @last
+    end
+
+    def inspect
+      desc = "#<#{self.class.name}:#{self.object_id}"
+      [:@id, :@key, :@value, :@doc, :@meta].each do |iv|
+        desc << " #{iv}=#{instance_variable_get(iv).inspect}"
+      end
+      desc << ">"
+      desc
     end
+  end
+
+  # This class encapsulates information about design docs
+  #
+  # @since 1.2.1
+  #
+  # It is subclass of ViewRow, but also gives access to view creation through method_missing
+  #
+  # @see http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-datastore.html
+  class DesignDoc < ViewRow
+    # It isn't allowed to change design document ID after
+    # initialization
+    undef id=
+
+    # Initialize the design doc instance
+    #
+    # @since 1.2.1
+    #
+    # It takes reference to the bucket, data hash. It will define view
+    # methods if the data object looks like design document.
+    #
+    # @param [Couchbase::Bucket] bucket the reference to connection
+    # @param [Hash] data the data hash, which was built from JSON document
+    #   representation
+    def initialize(bucket, data)
+      super
+      @all_views = {}
+      @views = @doc.has_key?('views') ? @doc['views'].keys : []
+      @spatial = @doc.has_key?('spatial') ? @doc['spatial'].keys : []
+      @views.each{|name| @all_views[name] = "#{@id}/_view/#{name}"}
+      @spatial.each{|name| @all_views[name] = "#{@id}/_spatial/#{name}"}
+    end
+
+    def method_missing(meth, *args)
+      if path = @all_views[meth.to_s]
+        View.new(@bucket, path, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth, *args)
+      if @all_views[meth.to_s]
+        true
+      else
+        super
+      end
+    end
+
+    def method(meth, *args)
+      if path = @all_views[meth.to_s]
+        lambda{|*p| View.new(@bucket, path, *p)}
+      else
+        super
+      end
+    end
+
+    # The list of views defined or empty array
+    #
+    # @since 1.2.1
+    #
+    # @return [Array<View>]
+    attr_accessor :views
+
+    # The list of spatial views defined or empty array
+    #
+    # @since 1.2.1
+    #
+    # @return [Array<View>]
+    attr_accessor :spatial
 
     # Check if the document has views defines
     #
-    # @since 1.2.0
+    # @since 1.2.1
     #
-    # @see ViewRow#views
+    # @see DesignDoc#views
     #
     # @return [true, false] +true+ if the document have views
     def has_views?
-      !!(design_doc? && !@views.empty?)
+      !@views.empty?
     end
 
     def inspect
-      desc = "#<#{self.class.name}:#{self.object_id} "
-      desc << [:@id, :@key, :@value, :@doc, :@meta, :@views].map do |iv|
-        "#{iv}=#{instance_variable_get(iv).inspect}"
-      end.join(' ')
+      desc = "#<#{self.class.name}:#{self.object_id}"
+      [:@id, :@views, :@spatial].each do |iv|
+        desc << " #{iv}=#{instance_variable_get(iv).inspect}"
+      end
       desc << ">"
       desc
     end
+
   end
 end