libcouchbase 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c7026a453499153eecaf17905759b204cec170c
-  data.tar.gz: b46e74fd72718803d075fb1afa7ea348fe7b7079
+  metadata.gz: fbbca533b435a70a968e4db6b7105061cf6a5c4c
+  data.tar.gz: 8da2a213ffe1262897d76e77d267468272262839
 SHA512:
-  metadata.gz: 37a4e81b2fae232db4e7e74e4d0966cbce04a695f7e7f0966f067331b882f8e022b60c1742c7289ee1f371a368daab93a36c48ff3cbeb0de5872e6fda88e1b1c
-  data.tar.gz: 5d4f5a2e4e8f24ff3a0a025b94a3a016831cb2717d57c13bb4ebf7b36f043bb139282722172b4927b94c4237e5fdcc77c433d4f6df8056f09b7c41afd1490979
+  metadata.gz: 27673bc5a39dbc17238f941a4124e70f43ab3823258d23258ac2fe2c3dcad221b3d28c6c040cd32aee00b70e772f2b08f9747aeb1abb4f6a4f3f5309bbe7f20b
+  data.tar.gz: a74d898f35f5907c42e1ef62055b010100496614c72405bb2873755e79739f6f242ddf0d8bfa80f634d1e62ea5b0175d03ccc15389dc86ac9dd54fd697fd7bef

data/lib/libcouchbase/bucket.rb

@@ -48,8 +48,6 @@ module Libcouchbase
         # @option options [true, false] :quiet (self.quiet) If set to +true+, the
         #  operation won't raise error for missing key, it will return +nil+.
         #  Otherwise it will raise a not found error.
-        # @option options [Symbol] :format the value should be stored as.
-        #   Defaults to :document
         # @option options [true, false] :assemble_hash (false) Assemble Hash for
         #   results.
         #
@@ -182,7 +180,6 @@ module Libcouchbase
         # @option options [Integer] :expire_in Expiry time for key in seconds
         # @option options [Integer, Time] :expire_at Unix epoc or time at which a key
         #   should expire
-        # @option options [Symbol] :format the value should be stored as.
         # @option options [Integer] :cas The CAS value for an object. This value is
         #   created on the server and is guaranteed to be unique for each value of
         #   a given key. This value is used to provide simple optimistic
@@ -205,10 +202,7 @@ module Libcouchbase
         # @example Store the key which will be expired in 2 seconds using absolute TTL.
         #   c.add(:foo, :bar, expire_at: Time.now.to_i + 2)
         #
-        # @example Force JSON document format for value
-        #   c.add("foo", {"bar" => "baz"}, format: :document)
-        #
-        # @example Set application specific flags (note that it will be OR-ed with format flags)
+        # @example Set application specific flags
         #   c.add("foo", "bar", flags: 0x1000)
         #
         # @example Ensure that the key will be persisted at least on the one node
@@ -227,7 +221,6 @@ module Libcouchbase
         # @option options [Integer] :expire_in Expiry time for key in seconds
         # @option options [Integer, Time] :expire_at Unix epoc or time at which a key
         #   should expire
-        # @option options [Symbol] :format the value should be stored as.
         # @option options [Integer] :cas The CAS value for an object. This value is
         #   created on the server and is guaranteed to be unique for each value of
         #   a given key. This value is used to provide simple optimistic
@@ -251,13 +244,10 @@ module Libcouchbase
         # @example Store the key which will be expired in 2 seconds using absolute TTL.
         #   c.set(:foo, :bar, expire_at: Time.now.to_i + 2)
         #
-        # @example Force JSON document format for value
-        #   c.set("foo", {"bar" => "baz"}, format: :document)
-        #
         # @example Use hash-like syntax to store the value
         #   c[:foo] = {bar: :baz}
         #
-        # @example Set application specific flags (note that it will be OR-ed with format flags)
+        # @example Set application specific flags
         #   c.set("foo", "bar", flags: 0x1000)
         #
         # @example Perform optimistic locking by specifying last known CAS version
@@ -280,7 +270,6 @@ module Libcouchbase
         # @option options [Integer] :expire_in Expiry time for key in seconds
         # @option options [Integer, Time] :expire_at Unix epoc or time at which a key
         #   should expire
-        # @option options [Symbol] :format the value should be stored as.
         # @option options [Integer] :cas The CAS value for an object. This value is
         #   created on the server and is guaranteed to be unique for each value of
         #   a given key. This value is used to provide simple optimistic
@@ -305,10 +294,7 @@ module Libcouchbase
         # @example Store the key which will be expired in 2 seconds using absolute TTL.
         #   c.replace(:foo, :bar, expire_at: Time.now.to_i + 2)
         #
-        # @example Force JSON document format for value
-        #   c.replace("foo", {"bar" => "baz"}, format: :document)
-        #
-        # @example Set application specific flags (note that it will be OR-ed with format flags)
+        # @example Set application specific flags
         #   c.replace("foo", "bar", flags: 0x1000)
         #
         # @example Ensure that the key will be persisted at least on the one node
@@ -320,12 +306,6 @@ module Libcouchbase
 
         # Append this object to the existing object
         #
-        # @note This operation is kind of data-aware from server point of view.
-        #   This mean that the server treats value as binary stream and just
-        #   perform concatenation, therefore it won't work with +:marshal+ and
-        #   +:document+ formats, because of lack of knowledge how to merge values
-        #   in these formats.
-        #
         # @param key [String, Symbol] Key used to reference the value.
         # @param value [Object] Value to be appended
         # @param options [Hash] Options for operation.
@@ -348,12 +328,12 @@ module Libcouchbase
         # @raise [Libcouchbase::Error::KeyNotFound] if the key doesn't exists
         #
         # @example Simple append
-        #   c.set(:foo, "aaa", format: :plain)
+        #   c.set(:foo, "aaa")
         #   c.append(:foo, "bbb")
         #   c.get("foo")           #=> "aaabbb"
         #
         # @example Using optimistic locking. The operation will fail on CAS mismatch
-        #   resp = c.set("foo", "aaa", format: :plain)
+        #   resp = c.set("foo", "aaa")
         #   c.append("foo", "bbb", cas: resp.cas)
         #
         # @example Ensure that the key will be persisted at least on the one node
@@ -365,12 +345,6 @@ module Libcouchbase
 
         # Prepend this object to the existing object
         #
-        # @note This operation is kind of data-aware from server point of view.
-        #   This mean that the server treats value as binary stream and just
-        #   perform concatenation, therefore it won't work with +:marshal+ and
-        #   +:document+ formats, because of lack of knowledge how to merge values
-        #   in these formats.
-        #
         # @param key [String, Symbol] Key used to reference the value.
         # @param value [Object] Value to be appended
         # @param options [Hash] Options for operation.
@@ -393,12 +367,12 @@ module Libcouchbase
         # @raise [Libcouchbase::Error::KeyNotFound] if the key doesn't exists
         #
         # @example Simple prepend
-        #   c.set(:foo, "aaa", format: :plain)
+        #   c.set(:foo, "aaa")
         #   c.prepend(:foo, "bbb")
         #   c.get("foo")           #=> "bbbaaa"
         #
         # @example Using optimistic locking. The operation will fail on CAS mismatch
-        #   resp = c.set("foo", "aaa", format: :plain)
+        #   resp = c.set("foo", "aaa")
         #   c.prepend("foo", "bbb", cas: resp.cas)
         #
         # @example Ensure that the key will be persisted at least on the one node
@@ -506,7 +480,7 @@ module Libcouchbase
         #   c.delete("foo", quiet: false)   #=> will raise Libcouchbase::Error::KeyNotFound
         #
         # @example Delete the key with version check
-        #   res = c.set("foo", "bar")       #=> #<struct Libcouchbase::Response callback=:callback_set, key="foo", cas=1975457268957184, value="bar", metadata={:format=>:document, :flags=>0}>
+        #   res = c.set("foo", "bar")       #=> #<struct Libcouchbase::Response callback=:callback_set, key="foo", cas=1975457268957184, value="bar", metadata={:flags=>0}>
         #   c.delete("foo", cas: 123456)    #=> will raise Libcouchbase::Error::KeyExists
         #   c.delete("foo", cas: res.cas)   #=> true
         def delete(key, async: false, quiet: true, **opts)

data/lib/libcouchbase/connection.rb

@@ -259,19 +259,8 @@ module Libcouchbase
 
         NonJsonValue = [:append, :prepend].freeze
 
-        # These are client specific
-        FormatFlags = {
-            document: 0,
-            marshal: 1,
-            plain: 2
-        }
-        SupportedFormats = FormatFlags.keys.freeze
-        FormatFlags.merge!(FormatFlags.invert)
-        FormatFlags.freeze
-
         # http://docs.couchbase.com/sdk-api/couchbase-c-client-2.6.2/group__lcb-store.html
         # http://docs.couchbase.com/sdk-api/couchbase-c-client-2.6.2/group__lcb-durability.html
-        # NOTE:: first 2 bits of the flags are reserved for document format
         def store(key, value, 
                 defer: nil,
                 operation: :set,
@@ -280,12 +269,10 @@ module Libcouchbase
                 ttl: nil,
                 persist_to: 0,
                 replicate_to: 0,
-                format: :document,
                 cas: nil,
                 flags: 0,
         **opts)
             raise 'not connected' unless @handle
-            raise 'format not supported' unless SupportedFormats.include?(:document)
             defer ||= @reactor.defer
 
             # Check if this should be a durable operation
@@ -298,26 +285,16 @@ module Libcouchbase
                 cmd = Ext::CMDSTORE.new
             end
             cmd[:operation] = operation
+            cmd[:flags] = flags
 
-            # Check if we are storing a string or partial value
-            if NonJsonValue.include?(operation)
-                format = :plain
-            else
-                # Preserve any application specific flags and set the format flags
-                flag_mask = flags & 3
-                flags = flags ^ flag_mask
-                cmd[:flags] = flags | FormatFlags[format]
-            end
-
-            # Move the data into the correct format for storage
-            if format == :marshal
-                str_value = Marshal.dump(value)
-            elsif format == :plain
-                # Use coercion as it was intended
-                str_value = value.respond_to?(:to_str) ? value.to_str : value.to_s
+            if value.is_a?(String)
+                str_value = value
             else
-                # This will raise an error if we're not storing valid json
-                str_value = JSON.generate([value])[1..-2]
+                str_value = begin
+                    JSON.generate([value])[1..-2]
+                rescue
+                    value.respond_to?(:to_str) ? value.to_str : value.to_s
+                end
             end
 
             req = Request.new(cmd, defer)
@@ -339,13 +316,12 @@ module Libcouchbase
         end
 
         # http://docs.couchbase.com/sdk-api/couchbase-c-client-2.6.2/group__lcb-get.html
-        def get(key, defer: nil, lock: false, cas: nil, format: nil, **opts)
+        def get(key, defer: nil, lock: false, cas: nil, **opts)
             raise 'not connected' unless @handle
             defer ||= @reactor.defer
 
             cmd = Ext::CMDGET.new
             req = Request.new(cmd, defer)
-            req.value = format
             key = cmd_set_key(req, cmd, key)
             cmd[:cas] = cas if cas
 
@@ -584,24 +560,13 @@ module Libcouchbase
             QueryN1QL.new(self, @reactor, n1ql, **opts)
         end
 
-        def parse_document(raw_string, flags: 0, hint: nil)
-            flag_mask = flags & 3
-            format = hint || FormatFlags[flag_mask] # Defaults to document
+        def parse_document(raw_string)
             val = begin
-                case format
-                when :marshal
-                    Marshal.load(raw_string)
-                when :document
-                    JSON.parse("[#{raw_string}]", DECODE_OPTIONS)[0]
-                else
-                    format = :plain
-                    raw_string
-                end
-            rescue => e
-                format = :plain
+                JSON.parse("[#{raw_string}]", DECODE_OPTIONS)[0]
+            rescue
                 raw_string
             end
-            [val, format]
+            val
         end
 
 
@@ -689,8 +654,8 @@ module Libcouchbase
             resp = Ext::RESPGET.new response
             resp_callback_common(resp, :callback_get) do |req, cb|
                 raw_string = resp[:value].read_string(resp[:nvalue])
-                val, format = parse_document(raw_string, flags: resp[:itmflags], hint: req.value)
-                Response.new(cb, req.key, resp[:cas], val, {format: format, flags: resp[:itmflags]})
+                val = parse_document(raw_string)
+                Response.new(cb, req.key, resp[:cas], val, {flags: resp[:itmflags]})
             end
         end
 

data/lib/libcouchbase/query_view.rb

@@ -96,7 +96,7 @@ module Libcouchbase
             if @include_docs && row[:docresp]
                 doc = row[:docresp]
                 raw_string = doc[:value].null? ? '' : doc[:value].read_string(doc[:nvalue])
-                resp.value, meta[:format] = @connection.parse_document(raw_string, flags: doc[:itmflags])
+                resp.value = @connection.parse_document(raw_string)
                 meta[:flags] = doc[:itmflags]
             end
 

data/lib/libcouchbase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true, encoding: ASCII-8BIT
 
 module Libcouchbase
-    VERSION = '1.1.1'
+    VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libcouchbase
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Stephen von Takach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi