couchbase 1.1.0 → 1.1.1

data/HISTORY.markdown

@@ -1,3 +1,9 @@
+## 1.1.1 / 2012-03-19
+
+* Allow to force format for get operation (thanks to Darian Shimy)
+* Use all arguments if receiver arity is -1 (couchbase_ext.c)
+* Doc fixes
+
 ## 1.1.0 / 2012-03-07
 
 * Timeout support (CCBC-20)

data/README.markdown

@@ -81,26 +81,34 @@ as the endpoint. The client will automatically adjust configuration when
 the cluster will rebalance its nodes when nodes are added or deleted
 therefore this client is "smart".
 
-    c = Couchbase.new
+    c = Couchbase.connect
 
 This is equivalent to following forms:
 
-    c = Couchbase.new("http://localhost:8091/pools/default/buckets/default")
-    c = Couchbase.new("http://localhost:8091/pools/default")
-    c = Couchbase.new("http://localhost:8091")
-    c = Couchbase.new(:host => "localhost")
-    c = Couchbase.new(:host => "localhost", :port => 8091)
-    c = Couchbase.new(:pool => "default", :bucket => "default")
+    c = Couchbase.connect("http://localhost:8091/pools/default/buckets/default")
+    c = Couchbase.connect("http://localhost:8091/pools/default")
+    c = Couchbase.connect("http://localhost:8091")
+    c = Couchbase.connect(:hostname => "localhost")
+    c = Couchbase.connect(:hostname => "localhost", :port => 8091)
+    c = Couchbase.connect(:pool => "default", :bucket => "default")
 
 The hash parameters take precedence on string URL.
 
+There is also handy method `Couchbase.bucket` which uses thread local
+storage to keep the reference to default connection. You can set the
+connection options via `Couchbase.connection_options`:
+
+    Couchbase.connection_options = {:bucket => 'blog'}
+    Couchbase.bucket.name                   #=> "blog"
+    Couchbase.bucket.set("foo", "bar")      #=> 3289400178357895424
+
 The library supports both synchronous and asynchronous mode. In
 asynchronous mode all operations will return control to caller
 without blocking current thread. You can pass the block to method and it
 will be called with result when the operation will be completed. You
 need to run event loop when you scheduled your operations:
 
-    c = Couchbase.new
+    c = Couchbase.connect
     c.run do |conn|
       conn.get("foo") {|ret| puts ret.value}
       conn.set("bar", "baz")
@@ -166,12 +174,12 @@ The library supports three different formats for representing values:
   version will be able to run map/reduce queries on the values in the
   document form (hashes)
 
-* `:marshal` This format avoids any conversions to be applied to your
+* `:plain` This format avoids any conversions to be applied to your
   data, but your data should be passed as String. This is useful for
   building custom algorithms or formats. For example to implement a set:
   http://dustin.github.com/2011/02/17/memcached-set.html
 
-* `:plain` Use this format if you'd like to transparently serialize your
+* `:marshal` Use this format if you'd like to transparently serialize your
   ruby object with standard `Marshal.dump` and `Marshal.load` methods
 
 The couchbase API is the superset of [Memcached binary protocol][5], so

data/ext/couchbase_ext/couchbase_ext.c

@@ -73,6 +73,7 @@ typedef struct
     VALUE proc;
     void *rv;
     VALUE exception;
+    VALUE force_format;
     int quiet;
     int arithm;           /* incr: +1, decr: -1, other: 0 */
 } context_t;
@@ -88,6 +89,7 @@ struct key_traits
     int explicit_ttl;
     int quiet;
     int mgat;
+    VALUE force_format;
 };
 
 static VALUE mCouchbase, mError, mJSON, mURI, mMarshal, cBucket, cResult;
@@ -190,6 +192,9 @@ cb_proc_call(VALUE recv, int argc, ...)
     int ii;
 
     arity = FIX2INT(rb_funcall(recv, id_arity, 0));
+    if (arity < 0) {
+        arity = argc;
+    }
     if (arity > 0) {
         va_init_list(ar, argc);
         argv = ALLOCA_N(VALUE, argc);
@@ -202,7 +207,6 @@ cb_proc_call(VALUE recv, int argc, ...)
         }
         va_end(ar);
     } else {
-        arity = 0;
         argv = NULL;
     }
     return rb_funcall2(recv, id_call, arity, argv);
@@ -367,18 +371,30 @@ do_encode(VALUE *args)
 do_decode(VALUE *args)
 {
     VALUE blob = args[0];
-    uint32_t flags = ((uint32_t)args[1] & FMT_MASK);
+    VALUE force_format = args[2];
 
-    switch (flags) {
-        case FMT_DOCUMENT:
+    if (TYPE(force_format) == T_SYMBOL) {
+        if (force_format == sym_document) {
             return rb_funcall(mJSON, id_load, 1, blob);
-        case FMT_MARSHAL:
+        } else if (force_format == sym_marshal) {
             return rb_funcall(mMarshal, id_load, 1, blob);
-        case FMT_PLAIN:
-            /* fall through */
-        default:
-            /* all other formats treated as plain */
+        } else { /* sym_plain and any other symbol */
             return blob;
+        }
+    } else {
+        uint32_t flags = ((uint32_t)args[1] & FMT_MASK);
+
+        switch (flags) {
+            case FMT_DOCUMENT:
+                return rb_funcall(mJSON, id_load, 1, blob);
+            case FMT_MARSHAL:
+                return rb_funcall(mMarshal, id_load, 1, blob);
+            case FMT_PLAIN:
+                /* fall through */
+            default:
+                /* all other formats treated as plain */
+                return blob;
+        }
     }
 }
 
@@ -404,9 +420,9 @@ encode_value(VALUE val, uint32_t flags)
 }
 
     static VALUE
-decode_value(VALUE blob, uint32_t flags)
+decode_value(VALUE blob, uint32_t flags, VALUE force_format)
 {
-    VALUE val, args[2];
+    VALUE val, args[3];
 
     /* first it must be bytestring */
     if (TYPE(blob) != T_STRING) {
@@ -414,6 +430,7 @@ decode_value(VALUE blob, uint32_t flags)
     }
     args[0] = blob;
     args[1] = (VALUE)flags;
+    args[2] = (VALUE)force_format;
     val = rb_rescue(do_decode, (VALUE)args, coding_failed, 0);
     return val;
 }
@@ -465,6 +482,10 @@ cb_args_scan_keys(long argc, VALUE argv, bucket_t *bucket, struct key_traits *tr
             if (RTEST(rb_funcall(opts, id_has_key_p, 1, sym_quiet))) {
                 traits->quiet = RTEST(rb_hash_aref(opts, sym_quiet));
             }
+            traits->force_format = rb_hash_aref(opts, sym_format);
+            if (traits->force_format != Qnil) {
+                Check_Type(traits->force_format, T_SYMBOL);
+            }
             ext = rb_hash_aref(opts, sym_extended);
             ttl = rb_hash_aref(opts, sym_ttl);
             if (ttl != Qnil) {
@@ -644,9 +665,11 @@ get_callback(libcouchbase_t handle, const void *cookie,
     f = ULONG2NUM(flags);
     c = ULL2NUM(cas);
     if (nbytes != 0) {
-        v = decode_value(rb_str_new((const char*)bytes, nbytes), flags);
+        v = decode_value(rb_str_new((const char*)bytes, nbytes), flags, ctx->force_format);
         if (v == Qundef) {
             ctx->exception = rb_exc_new2(eValueFormatError, "unable to convert value");
+            rb_ivar_set(ctx->exception, id_iv_operation, sym_get);
+            rb_ivar_set(ctx->exception, id_iv_key, k);
             v = Qnil;
         }
     } else {
@@ -2082,6 +2105,9 @@ cb_bucket_decr(int argc, VALUE *argv, VALUE self)
  *     operation won't raise error for missing key, it will return +nil+.
  *     Otherwise it will raise error in synchronous mode. In asynchronous
  *     mode this option ignored.
+ *   @option options [Symbol] :format (nil) Explicitly choose the decoder
+ *     for this key (+:plain+, +:document+, +:marshal+). See
+ *     {Bucket#default_format}.
  *
  *   @yieldparam ret [Result] the result of operation in asynchronous mode
  *     (valid attributes: +error+, +operation+, +key+, +value+, +flags+,
@@ -2184,6 +2210,7 @@ cb_bucket_get(int argc, VALUE *argv, VALUE self)
     ctx->bucket = bucket;
     ctx->extended = traits->extended;
     ctx->quiet = traits->quiet;
+    ctx->force_format = traits->force_format;
     rv = rb_hash_new();
     ctx->rv = &rv;
     ctx->exception = Qnil;

data/lib/couchbase/version.rb

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

data/test/test_get.rb

@@ -308,4 +308,23 @@ class TestGet < MiniTest::Unit::TestCase
     assert_equal nil, connection.get(uniq_id, :quiet => false)
   end
 
+  def test_format_forcing
+    connection = Couchbase.new(:hostname => @mock.host, :port => @mock.port)
+
+    connection.set(uniq_id, '{"foo":"bar"}', :format => :plain)
+    value, flags, _ = connection.get(uniq_id, :extended => true)
+    assert_equal '{"foo":"bar"}', value
+    assert_equal 0x02, flags
+
+    value, flags, _ = connection.get(uniq_id, :extended => true, :format => :document)
+    expected = {"foo" => "bar"}
+    assert_equal expected, value
+    assert_equal 0x02, flags
+
+    connection.prepend(uniq_id, "NOT-A-JSON")
+    assert_raises Couchbase::Error::ValueFormat do
+      connection.get(uniq_id, :format => :document)
+    end
+  end
+
 end

metadata

@@ -1,111 +1,149 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: couchbase
-version: !ruby/object:Gem::Version
-  version: 1.1.0
+version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 1
+  version: 1.1.1
 platform: ruby
-authors:
+authors: 
 - Couchbase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-07 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: &12069760 !ruby/object:Gem::Requirement
+
+date: 2012-03-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
   type: :runtime
+  name: yajl-ruby
+  version_requirements: *id001
   prerelease: false
-  version_requirements: *12069760
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &12068240 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
   type: :development
+  name: rake
+  version_requirements: *id002
   prerelease: false
-  version_requirements: *12068240
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &12067280 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  name: minitest
+  version_requirements: *id003
   prerelease: false
-  version_requirements: *12067280
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
-  requirement: &12056580 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 7
+        - 5
         version: 0.7.5
   type: :development
+  name: rake-compiler
+  version_requirements: *id004
   prerelease: false
-  version_requirements: *12056580
-- !ruby/object:Gem::Dependency
-  name: rdiscount
-  requirement: &12055480 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  name: rdiscount
+  version_requirements: *id005
   prerelease: false
-  version_requirements: *12055480
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &12054260 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  name: yard
+  version_requirements: *id006
   prerelease: false
-  version_requirements: *12054260
-- !ruby/object:Gem::Dependency
-  name: mini_portile
-  requirement: &12053280 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  name: mini_portile
+  version_requirements: *id007
   prerelease: false
-  version_requirements: *12053280
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &12052340 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  name: ruby-debug
+  version_requirements: *id008
   prerelease: false
-  version_requirements: *12052340
 description: The official client library for use with Couchbase Server.
 email: support@couchbase.com
 executables: []
-extensions:
+
+extensions: 
 - ext/couchbase_ext/extconf.rb
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - .yardopts
@@ -144,52 +182,37 @@ files:
 - test/test_touch.rb
 - test/test_version.rb
 homepage: http://couchbase.org
-licenses:
+licenses: 
 - ASL-2
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2404392778258139925
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2404392778258139925
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: Couchbase ruby driver
-test_files:
-- test/profile/.gitignore
-- test/profile/Gemfile
-- test/profile/benchmark.rb
-- test/setup.rb
-- test/test_arithmetic.rb
-- test/test_async.rb
-- test/test_bucket.rb
-- test/test_cas.rb
-- test/test_couchbase.rb
-- test/test_delete.rb
-- test/test_errors.rb
-- test/test_flush.rb
-- test/test_format.rb
-- test/test_get.rb
-- test/test_stats.rb
-- test/test_store.rb
-- test/test_touch.rb
-- test/test_version.rb
+test_files: []
+