cassandra-driver 3.0.0.beta.1 → 3.0.0.rc.1

data/lib/cassandra/execution/options.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,11 +38,11 @@ module Cassandra
       # @return [String] paging state
       #
       # @note Although this feature exists to allow web applications to store
-      #   paging state in an [HTTP cookie](http://en.wikipedia.org/wiki/HTTP_cookie), **it is not safe to
-      #   expose without encrypting or otherwise securing it**. Paging state
-      #   contains information internal to the Apache Cassandra cluster, such as
-      #   partition key and data. Additionally, if a paging state is sent with CQL
-      #   statement, different from the original, the behavior of Cassandra is
+      #   paging state in an [HTTP cookie](http://en.wikipedia.org/wiki/HTTP_cookie),
+      #   **it is not safe to expose without encrypting or otherwise securing it**.
+      #   Paging state contains information internal to the Apache Cassandra cluster,
+      #   such as partition key and data. Additionally, if a paging state is sent with
+      #   CQL statement, different from the original, the behavior of Cassandra is
       #   undefined and will likely cause a server process of the coordinator of
       #   such request to abort.
       #
@@ -53,7 +53,7 @@ module Cassandra
       # string and byte buffers.
       #
       # @see https://github.com/apache/cassandra/blob/33f1edcce97779c971d4f78712a9a8bf014ffbbc/doc/native_protocol_v4.spec#L127-L133 Description of custom payload in Cassandra native protocol v4.
-      # @see https://datastax.github.io/java-driver/features/custom_payloads/#enabling-custom-payloads-on-c-nodes Enabling custom payloads on Cassandra nodes.
+      # @see https://datastax.github.io/java-driver/manual/custom_payloads/#enabling-custom-payloads-on-c-nodes Enabling custom payloads on Cassandra nodes.
       #
       # @example Sending a custom payload
       #   result = session.execute(payload: {
@@ -63,7 +63,10 @@ module Cassandra
       attr_reader :payload
 
       # @private
-      def initialize(options)
+      # @param options [Hash] execution options to validate and encapsulate
+      # @param trusted_options [Options] (optional) base Execution::Options from which
+      #        to create this new Options object.
+      def initialize(options, trusted_options = nil)
         consistency        = options[:consistency]
         page_size          = options[:page_size]
         trace              = options[:trace]
@@ -75,61 +78,114 @@ module Cassandra
         idempotent         = options[:idempotent]
         payload            = options[:payload]
 
-        Util.assert_one_of(CONSISTENCIES, consistency) { ":consistency must be one of #{CONSISTENCIES.inspect}, #{consistency.inspect} given" }
+        # consistency is a required attribute of an Options object. If we are creating
+        # an Options object from scratch (e.g. no trusted_options as base) validate the
+        # given consistency value (even if nil). Otherwise we're overlaying and only
+        # validate the consistency option if given.
+        if trusted_options.nil? || !consistency.nil?
+          Util.assert_one_of(CONSISTENCIES, consistency) do
+            ":consistency must be one of #{CONSISTENCIES.inspect}, " \
+                "#{consistency.inspect} given"
+          end
+        end
 
         unless serial_consistency.nil?
-          Util.assert_one_of(SERIAL_CONSISTENCIES, serial_consistency) { ":serial_consistency must be one of #{SERIAL_CONSISTENCIES.inspect}, #{serial_consistency.inspect} given" }
+          Util.assert_one_of(SERIAL_CONSISTENCIES, serial_consistency) do
+            ":serial_consistency must be one of #{SERIAL_CONSISTENCIES.inspect}, " \
+                "#{serial_consistency.inspect} given"
+          end
         end
 
         unless page_size.nil?
           page_size = Integer(page_size)
-          Util.assert(page_size > 0) { ":page_size must be a positive integer, #{page_size.inspect} given" }
+          Util.assert(page_size > 0) do
+            ":page_size must be a positive integer, #{page_size.inspect} given"
+          end
         end
 
         unless timeout.nil?
-          Util.assert_instance_of(::Numeric, timeout) { ":timeout must be a number of seconds, #{timeout} given" }
+          Util.assert_instance_of(::Numeric, timeout) do
+            ":timeout must be a number of seconds, #{timeout} given"
+          end
           Util.assert(timeout > 0) { ":timeout must be greater than 0, #{timeout} given" }
         end
 
         unless paging_state.nil?
           paging_state = String(paging_state)
-          Util.assert_not_empty(paging_state) { ":paging_state must not be empty" }
-          Util.assert(!page_size.nil?) { ":page_size is required when :paging_state is given" }
+          Util.assert_not_empty(paging_state) { ':paging_state must not be empty' }
+
+          # We require page_size in either the new options or trusted options.
+          Util.assert(!page_size.nil? ||
+                          !(trusted_options.nil? || trusted_options.page_size.nil?)) do
+            ':page_size is required when :paging_state is given'
+          end
         end
 
-        if arguments.nil?
+        # :arguments defaults to empty-list, but we want to delegate to trusted_options
+        # if it's set. So the logic is as follows:
+        # If an arguments option was given, validate and use it regardless of anything
+        # else.
+        # Otherwise, if we have trusted_options, leave arguments nil for now so as not
+        # to override trusted_options. Finally, if we don't have an arguments option
+        # nor do we have trusted_options, fall back to the default empty-list.
+        #
+        # :type_hints works exactly the same way.
+        if !arguments.nil?
+          Util.assert_instance_of_one_of([::Array, ::Hash], arguments) do
+            ":arguments must be an Array or a Hash, #{arguments.inspect} given"
+          end
+        elsif trusted_options.nil?
           arguments = EMPTY_LIST
-        else
-          Util.assert_instance_of_one_of([::Array, ::Hash], arguments) { ":arguments must be an Array or a Hash, #{arguments.inspect} given" }
         end
 
-        if type_hints.nil?
+        if !type_hints.nil?
+          Util.assert_instance_of_one_of([::Array, ::Hash], type_hints) do
+            ":type_hints must be an Array or a Hash, #{type_hints.inspect} given"
+          end
+        elsif trusted_options.nil?
           type_hints = EMPTY_LIST
-        else
-          Util.assert_instance_of_one_of([::Array, ::Hash], type_hints) { ":type_hints must be an Array or a Hash, #{type_hints.inspect} given" }
         end
 
         unless payload.nil?
-          Util.assert_instance_of(::Hash, payload) { ":payload must be a Hash" }
-          Util.assert_not_empty(payload) { ":payload must not be empty" }
-          Util.assert(payload.size <= 65535) { ":payload cannot contain more than 65535 key/value pairs" }
-
-          payload = payload.each_with_object(::Hash.new) do |(key, value), payload|
-                      payload[String(key)] = String(value)
-                    end
+          Util.assert_instance_of(::Hash, payload) { ':payload must be a Hash' }
+          Util.assert_not_empty(payload) { ':payload must not be empty' }
+          Util.assert(payload.size <= 65535) do
+            ':payload cannot contain more than 65535 key/value pairs'
+          end
+
+          payload = payload.each_with_object(::Hash.new) do |(key, value), p|
+            p[String(key)] = String(value)
+          end
           payload.freeze
         end
 
-        @consistency        = consistency
-        @page_size          = page_size
-        @trace              = !!trace
-        @timeout            = timeout
-        @serial_consistency = serial_consistency
-        @paging_state       = paging_state
-        @arguments          = arguments
-        @type_hints         = type_hints
-        @idempotent         = !!idempotent
-        @payload            = payload
+        # Ok, validation is done. Time to save off all our values in our instance vars,
+        # merging in values from trusted_options if it's set. To keep things readable,
+        # we just put this into two branches of an if-else.
+
+        if trusted_options.nil?
+          @consistency = consistency
+          @page_size = page_size
+          @trace = !!trace
+          @timeout = timeout
+          @serial_consistency = serial_consistency
+          @arguments = arguments
+          @type_hints = type_hints
+        else
+          @consistency = consistency || trusted_options.consistency
+          @page_size = page_size || trusted_options.page_size
+          @trace = trace.nil? ? trusted_options.trace? : !!trace
+          @timeout = timeout || trusted_options.timeout
+          @serial_consistency = serial_consistency || trusted_options.serial_consistency
+          @arguments = arguments || trusted_options.arguments
+          @type_hints = type_hints || trusted_options.type_hints
+        end
+
+        # The following fields are *not* inherited from trusted_options, so we always
+        # rely on the options we were given.
+        @paging_state = paging_state
+        @idempotent = !!idempotent
+        @payload = payload
       end
 
       # @return [Boolean] whether request tracing was enabled
@@ -154,30 +210,19 @@ module Cassandra
           other.arguments == @arguments &&
           other.type_hints == @type_hints
       end
-      alias :== :eql?
+      alias == eql?
 
       # @private
       def override(*options)
-        merged = options.unshift(to_h).inject do |base, opts|
+        merged = options.unshift({}).inject do |base, opts|
           next base unless opts
-          Util.assert_instance_of(::Hash, opts) { "options must be a Hash, #{options.inspect} given" }
+          Util.assert_instance_of(::Hash, opts) do
+            "options must be a Hash, #{options.inspect} given"
+          end
           base.merge!(opts)
         end
 
-        Options.new(merged)
-      end
-
-      # @private
-      def to_h
-        {
-          :consistency        => @consistency,
-          :page_size          => @page_size,
-          :trace              => @trace,
-          :timeout            => @timeout,
-          :serial_consistency => @serial_consistency,
-          :arguments          => @arguments || EMPTY_LIST,
-          :type_hints         => @type_hints || EMPTY_LIST
-        }
+        Options.new(merged, self)
       end
     end
   end

data/lib/cassandra/execution/trace.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -44,7 +44,7 @@ module Cassandra
           other == @id
         end
 
-        alias :eql? :==
+        alias eql? ==
       end
 
       include MonitorMixin
@@ -124,15 +124,15 @@ module Cassandra
 
       # @private
       def inspect
-        "#<#{self.class.name}:0x#{self.object_id.to_s(16)} @id=#{@id.inspect}>"
+        "#<#{self.class.name}:0x#{object_id.to_s(16)} @id=#{@id.inspect}>"
       end
 
       private
 
       # @private
-      SELECT_SESSION = "SELECT * FROM system_traces.sessions WHERE session_id = %s"
+      SELECT_SESSION = 'SELECT * FROM system_traces.sessions WHERE session_id = %s'.freeze
       # @private
-      SELECT_EVENTS  = "SELECT * FROM system_traces.events WHERE session_id = %s"
+      SELECT_EVENTS  = 'SELECT * FROM system_traces.events WHERE session_id = %s'.freeze
 
       # @private
       def load
@@ -140,11 +140,13 @@ module Cassandra
           return if @loaded
 
           attempt = 1
-          data    = @client.query(Statements::Simple.new(SELECT_SESSION % @id), VOID_OPTIONS).get.first
+          data    = @client.query(Statements::Simple.new(SELECT_SESSION % @id),
+                                  VOID_OPTIONS).get.first
 
           while data.nil? && attempt <= 5
             sleep(attempt * 0.4)
-            data = @client.query(Statements::Simple.new(SELECT_SESSION % @id), VOID_OPTIONS).get.first
+            data = @client.query(Statements::Simple.new(SELECT_SESSION % @id),
+                                 VOID_OPTIONS).get.first
             break if data
             attempt += 1
           end
@@ -170,8 +172,13 @@ module Cassandra
 
           @events = []
 
-          @client.query(Statements::Simple.new(SELECT_EVENTS % @id), VOID_OPTIONS).get.each do |row|
-            @events << Event.new(row['event_id'], row['activity'], row['source'], row['source_elapsed'], row['thread'])
+          @client.query(Statements::Simple.new(SELECT_EVENTS % @id),
+                        VOID_OPTIONS).get.each do |row|
+            @events << Event.new(row['event_id'],
+                                 row['activity'],
+                                 row['source'],
+                                 row['source_elapsed'],
+                                 row['thread'])
           end
 
           @events.freeze

data/lib/cassandra/executors.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/cassandra/function.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 #--
-# Copyright 2013-2015 DataStax, Inc.
+# Copyright 2013-2016 DataStax, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -57,7 +57,7 @@ module Cassandra
     # @param name [String] argument name
     # @return [Boolean] whether this function has a given argument
     def has_argument?(name)
-      @arguments_hash.has_key?(name)
+      @arguments_hash.key?(name)
     end
 
     # @param name [String] argument name
@@ -82,12 +82,12 @@ module Cassandra
         @arguments.dup
       end
     end
-    alias :arguments :each_argument
+    alias arguments each_argument
 
     # Get the list of argument types for this function.
     # @return [Array<Cassandra::Type>] a list of argument types.
     def argument_types
-      @arguments.map { |argument| argument.type }
+      @arguments.map(&:type)
     end
 
     # @private
@@ -101,7 +101,7 @@ module Cassandra
         @body == other.body && \
         @called_on_null == other.called_on_null?
     end
-    alias :== :eql?
+    alias == eql?
 
     # @private
     def hash
@@ -120,7 +120,13 @@ module Cassandra
 
     # @private
     def inspect
-      "#<Cassandra::Function:0x#{self.object_id.to_s(16)} @keyspace=#{@keyspace.inspect}, @name=#{@name.inspect}, @language=#{@language.inspect}, @type=#{@type.inspect}, @arguments=#{@arguments.inspect} @body=#{@body.inspect}>"
+      "#<Cassandra::Function:0x#{object_id.to_s(16)} " \
+          "@keyspace=#{@keyspace.inspect}, " \
+          "@name=#{@name.inspect}, " \
+          "@language=#{@language.inspect}, " \
+          "@type=#{@type.inspect}, " \
+          "@arguments=#{@arguments.inspect} " \
+          "@body=#{@body.inspect}>"
     end
 
     # @return [String] a cql representation of this function
@@ -135,16 +141,16 @@ module Cassandra
         end
         cql << "#{argument.name} #{argument.type}"
       end
-      cql << ")"
-      if @called_on_null
-        cql << "\n  CALLED ON NULL INPUT"
-      else
-        cql << "\n  RETURNS NULL ON NULL INPUT"
-      end
+      cql << ')'
+      cql << if @called_on_null
+               "\n  CALLED ON NULL INPUT"
+             else
+               "\n  RETURNS NULL ON NULL INPUT"
+             end
       cql << "\n  RETURNS #{@type}"
       cql << "\n  LANGUAGE #{@language}"
       cql << "\n  AS $$#{@body}$$"
-      cql << ";"
+      cql << ';'
     end
   end
 end

data/lib/cassandra/function_collection.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2016 DataStax, Inc.
+#
+# 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 Cassandra
+  # @private
+  # This class encapsulates a collection of functions or aggregates.
+  # Really used internally, so it should not be documented.
+  class FunctionCollection
+    def initialize
+      @function_hash = {}
+    end
+
+    # Get the Function or Aggregate with the given name and argument-types.
+    # @param name [String] the name of the function/aggregate.
+    # @param argument_types [Array<Cassandra::Type>] list of argument-types.
+    # @return [Cassandra::Function] or [Cassandra::Aggregate] if found;
+    #     nil otherwise.
+    def get(name, argument_types)
+      @function_hash[[name, argument_types]]
+    end
+
+    def add_or_update(function)
+      @function_hash[[function.name, function.argument_types]] = function
+    end
+
+    def delete(name, argument_types)
+      @function_hash.delete([name, argument_types])
+    end
+
+    # @return [Boolean] whether this FunctionCollection is equal to the other
+    def eql?(other)
+      other.is_a?(FunctionCollection) &&
+        @function_hash == other.raw_functions
+    end
+    alias == eql?
+
+    def hash
+      @function_hash.hash
+    end
+
+    # Yield or enumerate each function defined in this collection
+    # @overload each_function
+    #   @yieldparam function [Cassandra::Function or Cassandra::Aggregate]
+    #         current function or aggregate
+    #   @return [Cassandra::FunctionCollection] self
+    # @overload each_function
+    #   @return [Array<Cassandra::Function> or Array<Cassandra::Aggregate>]
+    #       a list of functions or aggregates.
+    def each_function(&block)
+      if block_given?
+        @function_hash.each_value(&block)
+        self
+      else
+        @function_hash.values
+      end
+    end
+    alias functions each_function
+
+    def inspect
+      "#<Cassandra::FunctionCollection:0x#{object_id.to_s(16)} " \
+          "@function_hash=#{@function_hash.inspect}>"
+    end
+
+    protected
+
+    def raw_functions
+      @function_hash
+    end
+  end
+end