jmoses-couchbase 1.3.6

data/lib/couchbase/view_row.rb

@@ -0,0 +1,272 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011-2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Couchbase
+  # This class encapsulates structured JSON document
+  #
+  # @since 1.2.0
+  #
+  # 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|
+      undef_method(m) if m.to_s !~ /(?:^__|^nil\?$|^send$|^object_id$|^class$|)/
+    end
+
+    # The hash built from JSON document.
+    #
+    # @since 1.2.0
+    #
+    # This is complete response from the Couchbase
+    #
+    # @return [Hash]
+    attr_accessor :data
+
+    # The key which was emitted by map function
+    #
+    # @since 1.2.0
+    #
+    # @see http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-writing-map.html
+    #
+    # Usually it is String (the object +_id+) but it could be also any
+    # compount JSON value.
+    #
+    # @return [Object]
+    attr_accessor :key
+
+    # The value which was emitted by map function
+    #
+    # @since 1.2.0
+    #
+    # @see http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-views-writing-map.html
+    #
+    # @return [Object]
+    attr_accessor :value
+
+    # The document hash.
+    #
+    # @since 1.2.0
+    #
+    # It usually available when view executed with +:include_doc+ argument.
+    #
+    # @return [Hash]
+    attr_accessor :doc
+
+    # The identificator of the document
+    #
+    # @since 1.2.0
+    #
+    # @return [String]
+    attr_accessor :id
+
+    # The meta data linked to the document
+    #
+    # @since 1.2.0
+    #
+    # @return [Hash]
+    attr_accessor :meta
+
+    # Initialize the document instance
+    #
+    # @since 1.2.0
+    #
+    # 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
+    #   representation
+    def initialize(bucket, data)
+      @bucket = bucket
+      @data = data
+      @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
+    #
+    # @since 1.2.0
+    #
+    # @see ViewRow#initialize
+    #
+    # @param [Couchbase::Bucket] bucket the reference to connection
+    # @param [Hash] data the data hash, which was built from JSON document
+    #   representation
+    #
+    # @return [ViewRow]
+    def self.wrap(bucket, data)
+      self.new(bucket, data)
+    end
+
+    # Get attribute of the document
+    #
+    # @since 1.2.0
+    #
+    # Fetches attribute from underlying document hash
+    #
+    # @param [String] key the attribute name
+    #
+    # @return [Object] property value or nil
+    def [](key)
+      @doc[key]
+    end
+
+    # Check attribute existence
+    #
+    # @since 1.2.0
+    #
+    # @param [String] key the attribute name
+    #
+    # @return [true, false] +true+ if the given attribute is present in in
+    #   the document.
+    def has_key?(key)
+      @doc.has_key?(key)
+    end
+
+    # Set document attribute
+    #
+    # @since 1.2.0
+    #
+    # Set or update the attribute in the document hash
+    #
+    # @param [String] key the attribute name
+    # @param [Object] value the attribute value
+    #
+    # @return [Object] the value
+    def []=(key, value)
+      @doc[key] = value
+    end
+
+    # Signals if this row is last in a stream
+    #
+    # @since 1.2.1
+    #
+    # @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.1
+    #
+    # @see DesignDoc#views
+    #
+    # @return [true, false] +true+ if the document have views
+    def has_views?
+      !@views.empty?
+    end
+
+    def inspect
+      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

data/lib/ext/multi_json_fix.rb

@@ -0,0 +1,56 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011, 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# This patch fixing loading primitives like strings, numbers and booleans
+# using json_gem. It amends behaviour of MultiJson::Engines::JsonGem#load
+# when it receives JSON string which neither Array nor Object.
+
+if MultiJson.respond_to?(:engine)
+  multi_json_engine = MultiJson.send(:engine)
+else
+  multi_json_engine = MultiJson.send(:adapter)
+end
+
+# Patch for MultiJson versions < 1.3.3
+require 'multi_json/version'
+version = begin
+            MultiJson::VERSION
+          rescue NameError
+            MultiJson::Version.to_s
+          end.dup # because Gem::Version modifies it
+if Gem::Version.new(version) < Gem::Version.new('1.3.3')
+  class << MultiJson
+    alias :dump :encode
+    alias :load :decode
+  end
+end
+
+if multi_json_engine.name =~ /JsonGem$/
+  class << multi_json_engine
+    alias _load_object load
+    def load(string, options = {})
+      if string.respond_to?(:read)
+        string = string.read
+      end
+      if string =~ /\A\s*[{\[]/
+        _load_object(string, options)
+      else
+        _load_object("[#{string}]", options)[0]
+      end
+    end
+  end
+end

data/lib/rack/session/couchbase.rb

@@ -0,0 +1,108 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011, 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rack/session/abstract/id'
+require 'couchbase'
+require 'thread'
+
+module Rack
+  module Session
+
+    # This is Couchbase-powered session store for rack applications
+    #
+    # To use it just load it as usual middleware in your `config.ru` file
+    #
+    #   require 'rack/session/couchbase'
+    #   use Rack::Session::Couchbase
+    #
+    # You can also pass additional options:
+    #
+    #   require 'rack/session/couchbase'
+    #   use Rack::Session::Couchbase, :expire_after => 5.minutes,
+    #     :couchbase => {:bucket => "sessions", :default_format => :document}
+    #
+    # By default sessions will be serialized using Marshal class. But
+    # you can store them as JSON (+:default_format => :document+), to
+    # allow analyse them using Map/Reduce. In this case you should
+    # care about serialization of all custom objects like
+    # ActionDispatch::Flash::FlashHash
+    #
+    class Couchbase < Abstract::ID
+      attr_reader :mutex, :pool
+
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge(
+        :couchbase => {:quiet => true, :default_format => :marshal,
+                       :key_prefix => 'rack:session:'})
+
+      def initialize(app, options = {})
+        # Support old :expires option
+        options[:expire_after] ||= options[:expires]
+        super
+
+        @default_options[:couchbase][:default_ttl] ||= options[:expire_after]
+        @default_options[:couchbase][:key_prefix] ||= options[:namespace]
+        @namespace = @default_options[:couchbase][:key_prefix]
+        @mutex = Mutex.new
+        @pool = ::Couchbase.connect(@default_options[:couchbase])
+      end
+
+      def generate_sid
+        while true
+          sid = super
+          break sid unless @pool.get(sid)
+        end
+      end
+
+      def get_session(env, sid)
+        with_lock(env, [nil, {}]) do
+          unless sid and session = @pool.get(sid)
+            sid, session = generate_sid, {}
+            @pool.set(sid, session)
+          end
+          [sid, session]
+        end
+      end
+
+      def set_session(env, session_id, new_session, options)
+        with_lock(env, false) do
+          @pool.set(session_id, new_session, options)
+          session_id
+        end
+      end
+
+      def destroy_session(env, session_id, options)
+        with_lock(env) do
+          @pool.delete(session_id)
+          generate_sid unless options[:drop]
+        end
+      end
+
+      def with_lock(env, default = nil)
+        @mutex.lock if env['rack.multithread']
+        yield
+      rescue ::Couchbase::Error::Connect, ::Couchbase::Error::Timeout
+        if $VERBOSE
+          warn "#{self} is unable to find Couchbase server."
+          warn $!.inspect
+        end
+        default
+      ensure
+        @mutex.unlock if @mutex.locked?
+      end
+    end
+  end
+end

data/tasks/benchmark.rake

@@ -0,0 +1,6 @@
+desc 'Run benchmarks and compare them to memcached and dalli gems'
+task :benchmark => [:clean, :compile] do
+  cd File.expand_path(File.join(__FILE__, '..', '..', 'test', 'profile')) do
+    sh "bundle install && bundle exec ruby benchmark.rb | tee benchmark-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}.log"
+  end
+end

data/tasks/compile.rake

@@ -0,0 +1,160 @@
+# Author:: Couchbase <info@couchbase.com>
+# Copyright:: 2011, 2012 Couchbase, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+gem 'rake-compiler', '>= 0.7.5'
+require "rake/extensiontask"
+
+def gemspec
+  @clean_gemspec ||= eval(File.read(File.expand_path('../../couchbase.gemspec', __FILE__)))
+end
+
+version_router = lambda do |t|
+  File.open(t.name, 'wb') do |f|
+    f.write <<-RUBY
+      require "couchbase/\#{RUBY_VERSION.sub(/\\.\\d+$/, '')}/couchbase_ext"
+    RUBY
+  end
+end
+
+class Platform
+  attr_reader :name, :host, :versions
+
+  def initialize(params)
+    @name = params[:name]
+    @host = params[:host]
+    @versions = params[:versions]
+  end
+
+  def each_version
+    @versions.each do |v|
+      yield(v, v[/\d\.\d\.\d/])
+    end
+  end
+
+  def short_versions
+    res = []
+    each_version do |long, short|
+      res << short
+    end
+    res
+  end
+end
+
+recent = "2.0.0-p353"
+CROSS_PLATFORMS = [
+  Platform.new(:name => 'x64-mingw32', :host => 'x86_64-w64-mingw32', :versions => %w(1.9.3-p484 2.0.0-p353 2.1.0)),
+  Platform.new(:name => 'x86-mingw32', :host => 'i686-w64-mingw32', :versions => %w(1.8.7-p374 1.9.3-p484 2.0.0-p353 2.1.0)),
+]
+
+# Setup compile tasks.  Configuration can be passed via ENV.
+# Example:
+#  rake compile with_libcouchbase_include=/opt/couchbase/include
+#               with_libcouchbase_lib=/opt/couchbase/lib
+#
+# or
+#
+#  rake compile with_libcouchbase_dir=/opt/couchbase
+#
+Rake::ExtensionTask.new("couchbase_ext", gemspec) do |ext|
+  ext.cross_compile = true
+  ext.cross_platform = ENV['TARGET']
+  if ENV['RUBY_CC_VERSION']
+    ext.lib_dir = "lib/couchbase"
+  end
+  ext.cross_compiling do |spec|
+    spec.files.delete("lib/couchbase/couchbase_ext.so")
+    spec.files.push("lib/couchbase_ext.rb", Dir["lib/couchbase/*/couchbase_ext.so"])
+    spec.files.push(Dir["lib/couchbase/*/couchbase_ext.so"])
+    file "#{ext.tmp_dir}/#{ext.cross_platform}/stage/lib/couchbase_ext.rb", &version_router
+  end
+
+  CLEAN.include "#{ext.lib_dir}/*.#{RbConfig::CONFIG['DLEXT']}"
+
+  ENV.each do |key, val|
+    next unless key =~ /\Awith_(\w+)\z/i
+    opt = $1.downcase.tr('_', '-')
+    if File.directory?(path = File.expand_path(val))
+      ext.config_options << "--with-#{opt}=#{path}"
+    else
+      warn "No such directory: #{opt}: #{path}"
+    end
+  end
+end
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_tar = pkg.need_zip = false
+end
+
+require 'mini_portile'
+require 'rake/extensioncompiler'
+
+class MiniPortile
+  alias :cook_without_checkpoint :cook
+  def cook
+    checkpoint = "ports/.#{name}-#{version}-#{host}.installed"
+    unless File.exist?(checkpoint)
+      cook_without_checkpoint
+      FileUtils.touch(checkpoint)
+    end
+  end
+end
+
+file "lib/couchbase_ext.rb", &version_router
+
+desc "Package gem for windows"
+task "package:windows" => ["package", "lib/couchbase_ext.rb"] do
+  vars = [
+    'CC',
+    'CFLAGS',
+    'CPATH',
+    'CPP',
+    'CPPFLAGS',
+    'LDFLAGS',
+    'LIBRARY_PATH',
+    'PATH'
+  ].reduce({}) do |h, v|
+    h[v] = ENV[v]
+    h
+  end
+  ENV['LDFLAGS'] = '-static-libgcc'
+
+  CROSS_PLATFORMS.each do |platform|
+    ENV['TARGET'] = platform.name
+    rm_rf("tmp/ ports/")
+    mkdir_p("ports")
+    recipe = MiniPortile.new("libcouchbase", "2.2.0_30_gc87bec4")
+    recipe.host = platform.host
+    recipe.files << "http://packages.couchbase.com/clients/c/libcouchbase-#{recipe.version}.tar.gz"
+    recipe.configure_options.push("--disable-debug",
+                                  "--disable-dependency-tracking",
+                                  "--disable-couchbasemock",
+                                  "--disable-cxx",
+                                  "--disable-plugins",
+                                  "--disable-examples",
+                                  "--disable-tools")
+    recipe.cook
+    recipe.activate
+    platform.each_version do |long, short|
+      sh("env RUBY_CC_VERSION=#{short} RBENV_VERSION=#{long} rbenv exec rake cross compile")
+    end
+    vars.each do |k, v|
+      ENV[k] = v
+    end
+    sh("env RUBY_CC_VERSION=#{platform.short_versions.join(":")} RBENV_VERSION=#{recent} rbenv exec rake cross native gem")
+  end
+end