couchbase 1.0.0 → 1.1.0

data/ext/couchbase_ext/extconf.rb

@@ -20,62 +20,70 @@ ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
 
 require 'mkmf'
 
-LIBDIR = Config::CONFIG['libdir']
-INCLUDEDIR = Config::CONFIG['includedir']
-
-HEADER_DIRS = [
-  # First search /opt/local for macports
-  '/opt/local/include',
-  # Then search /usr/local for people that installed from source
-  '/usr/local/include',
-  # Check the ruby install locations
-  INCLUDEDIR,
-  # Finally fall back to /usr
-  '/usr/include'
-]
+def define(macro, value = nil)
+  $defs.push("-D #{[macro.upcase, value].compact.join('=')}")
+end
 
-LIB_DIRS = [
-  # First search /opt/local for macports
-  '/opt/local/lib',
-  # Then search /usr/local for people that installed from source
-  '/usr/local/lib',
-  # Check the ruby install locations
-  LIBDIR,
-  # Finally fall back to /usr
-  '/usr/lib'
-]
+$CFLAGS  << " #{ENV["CFLAGS"]}"
+$LDFLAGS << " #{ENV["LDFLAGS"]}"
+$LIBS    << " #{ENV["LIBS"]}"
 
-# For people using homebrew
-brew_prefix = `brew --prefix libevent 2> /dev/null`.chomp
-unless brew_prefix.empty?
-  LIB_DIRS.unshift File.join(brew_prefix, 'lib')
-  HEADER_DIRS.unshift File.join(brew_prefix, 'include')
+$CFLAGS << ' -std=c99 -Wall -Wextra '
+if ENV['DEBUG']
+  $CFLAGS << ' -O0 -ggdb3 -pedantic '
 end
 
-HEADER_DIRS.delete_if{|d| !File.exists?(d)}
-LIB_DIRS.delete_if{|d| !File.exists?(d)}
+if RbConfig::CONFIG['target_os'] =~ /mingw32/
+  dir_config("libcouchbase")
+else
+  LIBDIR = RbConfig::CONFIG['libdir']
+  INCLUDEDIR = RbConfig::CONFIG['includedir']
 
-def define(macro, value = nil)
-  $defs.push("-D #{[macro.upcase, value].compact.join('=')}")
-end
+  HEADER_DIRS = [
+    # First search /opt/local for macports
+    '/opt/local/include',
+    # Then search /usr/local for people that installed from source
+    '/usr/local/include',
+    # Check the ruby install locations
+    INCLUDEDIR,
+    # Finally fall back to /usr
+    '/usr/include'
+  ]
 
-# it will find the libcouchbase likely. you can specify its path otherwise
-#
-#   ruby extconf.rb [--with-libcouchbase-include=<dir>] [--with-libcouchbase-lib=<dir>]
-#
-# or
-#
-#   ruby extconf.rb [--with-libcouchbase-dir=<dir>]
-#
-dir_config("libcouchbase", HEADER_DIRS, LIB_DIRS)
+  LIB_DIRS = [
+    # First search /opt/local for macports
+    '/opt/local/lib',
+    # Then search /usr/local for people that installed from source
+    '/usr/local/lib',
+    # Check the ruby install locations
+    LIBDIR,
+    # Finally fall back to /usr
+    '/usr/lib'
+  ]
 
-if COMMON_HEADERS !~ /"ruby\.h"/
-  COMMON_HEADERS << %(#include "ruby.h"\n)
+  # For people using homebrew
+  brew_prefix = `brew --prefix libevent 2> /dev/null`.chomp
+  unless brew_prefix.empty?
+    LIB_DIRS.unshift File.join(brew_prefix, 'lib')
+    HEADER_DIRS.unshift File.join(brew_prefix, 'include')
+  end
+
+  HEADER_DIRS.delete_if{|d| !File.exists?(d)}
+  LIB_DIRS.delete_if{|d| !File.exists?(d)}
+
+  # it will find the libcouchbase likely. you can specify its path otherwise
+  #
+  #   ruby extconf.rb [--with-libcouchbase-include=<dir>] [--with-libcouchbase-lib=<dir>]
+  #
+  # or
+  #
+  #   ruby extconf.rb [--with-libcouchbase-dir=<dir>]
+  #
+  dir_config("libcouchbase", HEADER_DIRS, LIB_DIRS)
 end
 
-$CFLAGS << ' -std=c99 -Wall -Wextra '
-if ENV['DEBUG']
-  $CFLAGS << ' -O0 -ggdb3 -pedantic'
+if COMMON_HEADERS !~ /"ruby\.h"/
+  COMMON_HEADERS << %(\n#include "ruby.h"\n)
 end
 
 if try_compile(<<-SRC)
@@ -96,7 +104,10 @@ if try_compile(<<-SRC)
   define("HAVE_STDARG_PROTOTYPES")
 end
 
-have_library("event", "event_init", "event.h") || abort
-have_library("couchbase", "libcouchbase_create", "libcouchbase/couchbase.h") || abort
+
+if RbConfig::CONFIG['target_os'] =~ /mingw32/
+  have_library("vbucket", "vbucket_config_create", "libvbucket/vbucket.h") or abort "You should install libvbucket >= 1.8.0.2"
+end
+have_library("couchbase", "libcouchbase_server_versions", "libcouchbase/couchbase.h") or abort "You should install libcouchbase >= 1.0.2"
 create_header("couchbase_config.h")
 create_makefile("couchbase_ext")

data/lib/couchbase.rb

@@ -17,6 +17,7 @@
 
 require 'couchbase/version'
 require 'yajl/json_gem'
+require 'uri'
 require 'couchbase_ext'
 require 'couchbase/bucket'
 
@@ -24,24 +25,57 @@ require 'couchbase/bucket'
 module Couchbase
 
   class << self
-    # The method +new+ initializes new Bucket instance with all arguments passed.
+    # The method +connect+ initializes new Bucket instance with all arguments passed.
     #
     # @example Use default values for all options
-    #   Couchbase.new
+    #   Couchbase.connect
     #
     # @example Establish connection with couchbase default pool and default bucket
-    #   Couchbase.new("http://localhost:8091/pools/default")
+    #   Couchbase.connect("http://localhost:8091/pools/default")
     #
     # @example Select custom bucket
-    #   Couchbase.new("http://localhost:8091/pools/default", :bucket => 'blog')
+    #   Couchbase.connect("http://localhost:8091/pools/default", :bucket => 'blog')
     #
     # @example Specify bucket credentials
-    #   Couchbase.new("http://localhost:8091/pools/default", :bucket => 'blog', :username => 'bucket', :password => 'secret')
+    #   Couchbase.connect("http://localhost:8091/pools/default", :bucket => 'blog', :username => 'bucket', :password => 'secret')
     #
     # @return [Bucket] connection instance
-    def new(*args)
-      Bucket.new(*args)
+    def connect(*options)
+      Bucket.new(*options)
     end
+    alias :new :connect
+
+    # Default connection options
+    #
+    # @example Using {Couchbase#connection_options} to change the bucket
+    #   Couchbase.connection_options = {:bucket => 'blog'}
+    #   Couchbase.bucket.name     #=> "blog"
+    #
+    # @return [Hash, String]
+    attr_accessor :connection_options
+
+    # @private the thread local storage
+    def thread_storage
+      Thread.current[:couchbase] ||= {}
+    end
+
+    # The connection instance for current thread
+    #
+    # @example
+    #   Couchbase.bucket.set("foo", "bar")
+    #
+    # @return [Bucket]
+    def bucket
+      thread_storage[:bucket] ||= connect(*connection_options)
+    end
+
+    # Set a connection instance for current thread
+    #
+    # @return [Bucket]
+    def bucket=(connection)
+      thread_storage[:bucket] = connection
+    end
+
   end
 
 end

data/lib/couchbase/bucket.rb

@@ -16,17 +16,18 @@
 #
 
 module Couchbase
+
   class Bucket
 
     # Reads a key's value from the server and yields it to a block. Replaces
     # the key's value with the result of the block as long as the key hasn't
     # been updated in the meantime, otherwise raises
-    # Couchbase::Error::KeyExists. CAS stands for "compare and swap", and
+    # {Couchbase::Error::KeyExists}. CAS stands for "compare and swap", and
     # avoids the need for manual key mutexing. Read more info here:
     #
     #   http://docs.couchbase.org/memcached-api/memcached-api-protocol-text_cas.html
     #
-    # @param [String] key
+    # @param [String, Symbol] key
     #
     # @param [Hash] options the options for operation
     # @option options [String] :ttl (self.default_ttl) the time to live of this key
@@ -37,7 +38,7 @@ module Couchbase
     #   +Result+ object in asynchronous mode.
     # @yieldreturn [Object] new value.
     #
-    # @raise [Couchbase::Errors:KeyExists] if the key was updated before the the
+    # @raise [Couchbase::Error::KeyExists] if the key was updated before the the
     #   code in block has been completed (the CAS value has been changed).
     #
     # @example Implement append to JSON encoded value
@@ -67,4 +68,5 @@ module Couchbase
     alias :compare_and_swap :cas
 
   end
+
 end

data/lib/couchbase/version.rb

@@ -17,5 +17,5 @@
 
 # Couchbase ruby client
 module Couchbase
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/tasks/compile.rake

@@ -32,6 +32,16 @@ end
 #  rake compile with_libcouchbase_dir=/opt/couchbase
 #
 Rake::ExtensionTask.new("couchbase_ext", gemspec) do |ext|
+  ext.cross_compile = true
+  ext.cross_platform = [ENV['HOST'] || "i386-mingw32"]
+  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/1.{8,9}/couchbase_ext.so"])
+  end
+
   CLEAN.include "#{ext.lib_dir}/*.#{RbConfig::CONFIG['DLEXT']}"
 
   ENV.each do |key, val|
@@ -50,3 +60,65 @@ Gem::PackageTask.new(gemspec) do |pkg|
   pkg.need_zip = true
   pkg.need_tar = true
 end
+
+require 'mini_portile'
+require 'rake/extensioncompiler'
+
+class MiniPortile
+  alias :initialize_with_default_host :initialize
+  def initialize(name, version)
+    initialize_with_default_host(name, version)
+    @host = ENV['HOST'] || Rake::ExtensionCompiler.mingw_host
+  end
+
+  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
+
+namespace :ports do
+  directory "ports"
+
+  task :libvbucket => ["ports"] do
+    recipe = MiniPortile.new "libvbucket", "1.8.0.3"
+    recipe.files << "http://packages.couchbase.com/clients/c/#{recipe.name}-#{recipe.version}.tar.gz"
+    recipe.configure_options.push("--disable-debug",
+                                  "--without-docs",
+                                  "--disable-dependency-tracking")
+    recipe.cook
+    recipe.activate
+  end
+
+  task :libcouchbase => [:libvbucket] do
+    recipe = MiniPortile.new "libcouchbase", "1.0.2"
+    recipe.files << "http://packages.couchbase.com/clients/c/#{recipe.name}-#{recipe.version}.tar.gz"
+    recipe.configure_options.push("--disable-debug",
+                                  "--disable-dependency-tracking",
+                                  "--disable-couchbasemock",
+                                  "--disable-tools")
+    recipe.cook
+    recipe.activate
+  end
+end
+
+file "lib/couchbase_ext.rb" do
+  File.open("lib/couchbase_ext.rb", 'wb') do |f|
+    f.write <<-RUBY
+      require "couchbase/\#{RUBY_VERSION.sub(/\\.\\d+$/, '')}/couchbase_ext"
+    RUBY
+  end
+end
+
+task :cross => ["lib/couchbase_ext.rb", "ports:libcouchbase"]
+
+desc "Package gem for windows"
+task "package:windows" => :package do
+  sh("env RUBY_CC_VERSION=1.8.7 rvm 1.8.7 do bundle exec rake cross compile")
+  sh("env RUBY_CC_VERSION=1.9.2 rvm 1.9.2 do bundle exec rake cross compile")
+  sh("env RUBY_CC_VERSION=1.8.7:1.9.2 rvm 1.9.2 do bundle exec rake cross native gem")
+end

data/tasks/test.rake

@@ -19,8 +19,8 @@ require 'rake/testtask'
 require 'rake/clean'
 
 rule 'test/CouchbaseMock.jar' do |task|
-  download_uri = "http://files.couchbase.com/maven2/org/couchbase/mock/CouchbaseMock/0.5-SNAPSHOT/CouchbaseMock-0.5-20120103.162550-11.jar"
-  sh %{wget -q -O test/CouchbaseMock.jar #{download_uri}}
+  jar_path = "0.5-SNAPSHOT/CouchbaseMock-0.5-20120222.060643-15.jar"
+  sh %{wget -q -O test/CouchbaseMock.jar http://files.couchbase.com/maven2/org/couchbase/mock/CouchbaseMock/#{jar_path}}
 end
 
 CLOBBER << 'test/CouchbaseMock.jar'

data/test/setup.rb

@@ -19,12 +19,52 @@ require 'minitest/autorun'
 require 'couchbase'
 
 require 'socket'
+require 'open-uri'
+
+class CouchbaseServer
+  attr_accessor :host, :port, :num_nodes, :buckets_spec
+
+  def real?
+    true
+  end
+
+  def initialize(params = {})
+    @host, @port = ENV['COUCHBASE_SERVER'].split(':')
+    @port = @port.to_i
+
+    if @host.nil? || @host.empty? || @port == 0
+      raise ArgumentError, "Check COUCHBASE_SERVER variable. It should be hostname:port"
+    end
+
+    @config = Yajl::Parser.parse(open("http://#{@host}:#{@port}/pools/default"))
+    @num_nodes = @config["nodes"].size
+    @buckets_spec = params[:buckets_spec] || "default:"  # "default:,protected:secret,cache::memcache"
+  end
+
+  def start
+    # flush all buckets
+    @buckets_spec.split(',') do |bucket|
+      name, password, _ = bucket.split(':')
+      connection = Couchbase.new(:hostname => @host,
+                                 :port => @port,
+                                 :username => name,
+                                 :bucket => name,
+                                 :password => password)
+      connection.flush
+    end
+  end
+  def stop; end
+end
 
 class CouchbaseMock
   Monitor = Struct.new(:pid, :client, :socket, :port)
 
   attr_accessor :host, :port, :buckets_spec, :num_nodes, :num_vbuckets
 
+  def real?
+    false
+  end
+
   def initialize(params = {})
     @host = "127.0.0.1"
     @port = 0
@@ -91,7 +131,17 @@ end
 class MiniTest::Unit::TestCase
 
   def start_mock(params = {})
-    mock = CouchbaseMock.new(params)
+    mock = nil
+    if ENV['COUCHBASE_SERVER']
+      mock = CouchbaseServer.new(params)
+      if (params[:port] && mock.port != params[:port]) ||
+        (params[:host] && mock.host != params[:host]) ||
+        mock.buckets_spec != "default:"
+        skip("Unable to configure real cluster. Requested config is: #{params.inspect}")
+      end
+    else
+      mock = CouchbaseMock.new(params)
+    end
     mock.start
     mock
   end
@@ -111,7 +161,7 @@ class MiniTest::Unit::TestCase
     stop_mock(mock) if mock
   end
 
-  def test_id(*suffixes)
+  def uniq_id(*suffixes)
     [caller.first[/.*[` ](.*)'/, 1], suffixes].join("_")
   end
 end

data/test/test_arithmetic.rb

@@ -28,70 +28,81 @@ class TestArithmetic < MiniTest::Unit::TestCase
   end
 
   def test_trivial_incr_decr
-    connection = Couchbase.new(:port => @mock.port)
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
 
-    connection.set(test_id, 1)
-    val = connection.incr(test_id)
+    connection.set(uniq_id, 1)
+    val = connection.incr(uniq_id)
     assert_equal 2, val
-    val = connection.get(test_id)
+    val = connection.get(uniq_id)
     assert_equal 2, val
 
-    connection.set(test_id, 7)
-    val = connection.decr(test_id)
+    connection.set(uniq_id, 7)
+    val = connection.decr(uniq_id)
     assert_equal 6, val
-    val = connection.get(test_id)
+    val = connection.get(uniq_id)
     assert_equal 6, val
   end
 
   def test_it_fails_to_incr_decr_missing_key
-    connection = Couchbase.new(:port => @mock.port)
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
 
     assert_raises(Couchbase::Error::NotFound) do
-      connection.incr(test_id(:missing))
+      connection.incr(uniq_id(:missing))
     end
     assert_raises(Couchbase::Error::NotFound) do
-      connection.decr(test_id(:missing))
+      connection.decr(uniq_id(:missing))
     end
   end
 
   def test_it_creates_missing_key_when_initial_value_specified
-    connection = Couchbase.new(:port => @mock.port)
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
 
-    val = connection.incr(test_id(:missing), :initial => 5)
+    val = connection.incr(uniq_id(:missing), :initial => 5)
     assert_equal 5, val
-    val = connection.incr(test_id(:missing), :initial => 5)
+    val = connection.incr(uniq_id(:missing), :initial => 5)
     assert_equal 6, val
-    val = connection.get(test_id(:missing))
+    val = connection.get(uniq_id(:missing))
     assert_equal 6, val
   end
 
   def test_it_uses_zero_as_default_value_for_missing_keys
-    connection = Couchbase.new(:port => @mock.port)
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
 
-    val = connection.incr(test_id(:missing), :create => true)
+    val = connection.incr(uniq_id(:missing), :create => true)
     assert_equal 0, val
-    val = connection.incr(test_id(:missing), :create => true)
+    val = connection.incr(uniq_id(:missing), :create => true)
     assert_equal 1, val
-    val = connection.get(test_id(:missing))
+    val = connection.get(uniq_id(:missing))
     assert_equal 1, val
   end
 
   def test_it_allows_custom_ttl
-    connection = Couchbase.new(:port => @mock.port)
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
 
-    val = connection.incr(test_id(:missing), :create => true, :ttl => 1)
+    val = connection.incr(uniq_id(:missing), :create => true, :ttl => 1)
     assert_equal 0, val
-    val = connection.incr(test_id(:missing), :create => true)
+    val = connection.incr(uniq_id(:missing), :create => true)
     assert_equal 1, val
-    sleep(1)
-    refute connection.get(test_id(:missing))
+    sleep(2)
+    refute connection.get(uniq_id(:missing))
+  end
+
+  def test_decrement_with_absolute_ttl
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
+    # absolute TTL: one second from now
+    exp = Time.now.to_i + 1
+    val = connection.decr(uniq_id, 12, :initial => 0, :ttl => exp)
+    assert_equal 0, val
+    assert_equal 0, connection.get(uniq_id)
+    sleep(2)
+    refute connection.get(uniq_id)
   end
 
   def test_it_allows_custom_delta
-    connection = Couchbase.new(:port => @mock.port)
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
 
-    connection.set(test_id, 12)
-    val = connection.incr(test_id, 10)
+    connection.set(uniq_id, 12)
+    val = connection.incr(uniq_id, 10)
     assert_equal 22, val
   end