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

data/lib/cassandra/udt.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,7 +38,7 @@ module Cassandra
         assign = !field.chomp!('=').nil?
 
         return super if assign && args.empty?
-        return super unless @name_to_type.has_key?(field)
+        return super unless @name_to_type.key?(field)
 
         if assign
           value = args.first
@@ -58,7 +58,7 @@ module Cassandra
         field = method.to_s
         field.chomp!('=')
 
-        return true if @name_to_type.has_key?(field)
+        return true if @name_to_type.key?(field)
         super
       end
 
@@ -94,15 +94,15 @@ module Cassandra
         when ::Integer
           if field < 0 || field >= @fields.size
             raise ::IndexError,
-              "field index #{field} is not present in UDT: " \
-              "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}" 
+                  "field index #{field} is not present in UDT: " \
+                  "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}"
           end
           @values[@fields[field][0]]
         when ::String
-          unless @name_to_type.has_key?(field)
+          unless @name_to_type.key?(field)
             raise ::KeyError,
-              "field #{field} is not defined in UDT: " \
-              "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}" 
+                  "field #{field} is not defined in UDT: " \
+                  "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}"
           end
           @values[field]
         else
@@ -127,16 +127,16 @@ module Cassandra
         when ::Integer
           if field < 0 || field >= @fields.size
             raise ::IndexError,
-              "field index #{field} is not present in UDT: " \
-              "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}" 
+                  "field index #{field} is not present in UDT: " \
+                  "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}"
           end
           Util.assert_type(@fields[field][1], value)
           @values[@fields[field][0]] = value
         when ::String
-          unless @name_to_type.has_key?(field)
+          unless @name_to_type.key?(field)
             raise ::KeyError,
-              "field #{field} is not defined in UDT: " \
-              "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}" 
+                  "field #{field} is not defined in UDT: " \
+                  "#{Util.escape_name(@keyspace)}.#{Util.escape_name(@name)}"
           end
           Util.assert_type(@name_to_type[field], value)
           @values[field] = value
@@ -165,14 +165,14 @@ module Cassandra
       end
 
       def inspect
-        "#<Cassandra::UDT:0x#{self.object_id.to_s(16)} #{to_s}>"
+        "#<Cassandra::UDT:0x#{object_id.to_s(16)} #{self}>"
       end
 
       def eql?(other)
         (other.is_a?(Strict) && @values.all? {|n, v| v == other[n]}) ||
-        (other.is_a?(UDT) && other == self)
+          (other.is_a?(UDT) && other == self)
       end
-      alias :== :eql?
+      alias == eql?
     end
 
     include Enumerable
@@ -181,43 +181,67 @@ module Cassandra
     # @param values [Hash<String, Object>, Array<Array<String, Object>>,
     #                 *Object, *Array<String, Object>] - UDT field values
     # @example Various ways of creating the same UDT instance
-    #   Cassandra::UDT.new({'street' => '123 Main St.', 'city' => 'Whatever', 'state' => 'XZ', 'zip' => '10020'})
+    #   Cassandra::UDT.new({'street' => '123 Main St.',
+    #                       'city' => 'Whatever',
+    #                       'state' => 'XZ',
+    #                       'zip' => '10020'})
     #
-    #   Cassandra::UDT.new(street: '123 Main St.', city: 'Whatever', state: 'XZ', zip: '10020')
+    #   Cassandra::UDT.new(street: '123 Main St.',
+    #                      city: 'Whatever',
+    #                      state: 'XZ',
+    #                      zip: '10020')
     #
-    #   Cassandra::UDT.new('street', '123 Main St.', 'city', 'Whatever', 'state', 'XZ', 'zip', '10020')
+    #   Cassandra::UDT.new('street', '123 Main St.',
+    #                      'city', 'Whatever',
+    #                      'state', 'XZ',
+    #                      'zip', '10020')
     #
-    #   Cassandra::UDT.new(:street, '123 Main St.', :city, 'Whatever', :state, 'XZ', :zip, '10020')
+    #   Cassandra::UDT.new(:street, '123 Main St.',
+    #                      :city, 'Whatever',
+    #                      :state, 'XZ',
+    #                      :zip, '10020')
     #
-    #   Cassandra::UDT.new(['street', '123 Main St.'], ['city', 'Whatever'], ['state', 'XZ'], ['zip', '10020'])
+    #   Cassandra::UDT.new(['street', '123 Main St.'],
+    #                      ['city', 'Whatever'],
+    #                      ['state', 'XZ'],
+    #                      ['zip', '10020'])
     #
-    #   Cassandra::UDT.new([:street, '123 Main St.'], [:city, 'Whatever'], [:state, 'XZ'], [:zip, '10020'])
+    #   Cassandra::UDT.new([:street, '123 Main St.'],
+    #                      [:city, 'Whatever'],
+    #                      [:state, 'XZ'],
+    #                      [:zip, '10020'])
     #
-    #   Cassandra::UDT.new([['street', '123 Main St.'], ['city', 'Whatever'], ['state', 'XZ'], ['zip', '10020']])
+    #   Cassandra::UDT.new([['street', '123 Main St.'],
+    #                       ['city', 'Whatever'],
+    #                       ['state', 'XZ'],
+    #                       ['zip', '10020']])
     #
-    #   Cassandra::UDT.new([[:street, '123 Main St.'], [:city, 'Whatever'], [:state, 'XZ'], [:zip, '10020']])
+    #   Cassandra::UDT.new([[:street, '123 Main St.'],
+    #                       [:city, 'Whatever'],
+    #                       [:state, 'XZ'],
+    #                       [:zip, '10020']])
     def initialize(*values)
       values = Array(values.first) if values.one?
 
       Util.assert_not_empty(values,
-        "user-defined type must contain at least one value"
-      )
+                            'user-defined type must contain at least one value'
+                           )
 
       if values.first.is_a?(::Array)
         @values = values.map do |pair|
           Util.assert(pair.size == 2,
-            "values of a user-defined type must be an Array of name and " \
-            "value pairs, #{pair.inspect} given"
-          )
+                      'values of a user-defined type must be an Array of name and ' \
+                      "value pairs, #{pair.inspect} given"
+                     )
           name, value = pair
 
           [String(name), value]
         end
       else
-        Util.assert((values.size % 2) == 0,
-          "values of a user-defined type must be an Array of alternating " \
-          "names and values pairs, #{values.inspect} given"
-        )
+        Util.assert(values.size.even?,
+                    'values of a user-defined type must be an Array of alternating ' \
+                    "names and values pairs, #{values.inspect} given"
+                   )
         @values = values.each_slice(2).map do |(name, value)|
           [String(name), value]
         end
@@ -313,17 +337,13 @@ module Cassandra
     def fetch(field)
       case field
       when ::Integer
-        if field >= 0 && field < @values.size
-          raise ::IndexError, "Field index #{field.inspect} is not present"
-        end
+        raise ::IndexError, "Field index #{field.inspect} is not present" if field >= 0 && field < @values.size
 
         @values[field][1]
       when ::String
         index = @values.index {|(n, _)| field == n}
 
-        unless index
-          raise ::KeyError, "Unsupported field #{field.inspect}"
-        end
+        raise ::KeyError, "Unsupported field #{field.inspect}" unless index
 
         @values[index][1]
       else
@@ -348,7 +368,7 @@ module Cassandra
       true
     end
 
-    alias :include? :has_field?
+    alias include? has_field?
 
     # Sets value of the field.
     #
@@ -363,17 +383,13 @@ module Cassandra
     def []=(field, value)
       case field
       when ::Integer
-        if field < 0 || field >= @values.size
-          raise ::IndexError, "Field index #{field.inspect} is not present"
-        end
+        raise ::IndexError, "Field index #{field.inspect} is not present" if field < 0 || field >= @values.size
 
         @values[field][1] = value
       when ::String
         index = @values.index {|(n, _)| field == n}
 
-        unless index
-          raise ::KeyError, "Unsupported field #{field.inspect}"
-        end
+        raise ::KeyError, "Unsupported field #{field.inspect}" unless index
 
         @values[index][1] = value
       else
@@ -410,21 +426,21 @@ module Cassandra
 
     # @private
     def inspect
-      "#<Cassandra::UDT:0x#{self.object_id.to_s(16)} #{to_s}>"
+      "#<Cassandra::UDT:0x#{object_id.to_s(16)} #{self}>"
     end
 
     # @private
     def eql?(other)
       other.is_a?(UDT) && @values.all? {|(n, v)| v == other[n]}
     end
-    alias :== :eql?
+    alias == eql?
 
     # @private
     def hash
       @values.inject(17) do |h, (n, v)|
         h = 31 * h + n.hash
-        h = 31 * h + v.hash
+        31 * h + v.hash
       end
     end
   end
-end
+end

data/lib/cassandra/util.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.
@@ -18,7 +18,9 @@
 
 module Cassandra
   # @private
-  module Util extend self
+  module Util
+    module_function
+
     def encode_hash(hash, io = StringIO.new)
       first = true
 
@@ -111,7 +113,7 @@ module Cassandra
 
       io.string
     end
-    alias :encode :encode_object
+    alias encode encode_object
 
     def encode_time(time, io = StringIO.new)
       encode_string(time.to_s, io)
@@ -160,8 +162,13 @@ module Cassandra
     end
 
     def escape_name(name)
-      return name if name[LOWERCASE_REGEXP] == name
-      DBL_QUOT + name + DBL_QUOT
+      # If name only contains lower-case chars and it's not a reserved word, return it
+      # as-is. Otherwise, quote.
+      return name if name[LOWERCASE_REGEXP] == name && !RESERVED_WORDS.include?(name)
+
+      # Replace double-quotes within name with two double-quotes (if any) and surround the whole
+      # thing with double-quotes
+      DBL_QUOT + name.gsub('"', '""') + DBL_QUOT
     end
 
     def guess_type(object)
@@ -190,7 +197,8 @@ module Cassandra
       when UDT
         Types.udt('unknown', 'unknown', object.map {|k, v| [k, guess_type(v)]})
       else
-        raise ::ArgumentError, "Unable to guess the type of the argument: #{object.inspect}"
+        raise ::ArgumentError,
+              "Unable to guess the type of the argument: #{object.inspect}"
       end
     end
 
@@ -212,7 +220,8 @@ module Cassandra
     def assert_instance_of_one_of(kinds, value, message = nil, &block)
       unless kinds.any? {|kind| value.is_a?(kind)}
         message   = yield if block_given?
-        message ||= "value must be an instance of one of #{kinds.inspect}, #{value.inspect} given"
+        message ||= "value must be an instance of one of #{kinds.inspect}, " \
+            "#{value.inspect} given"
 
         raise ::ArgumentError, message
       end
@@ -221,7 +230,8 @@ module Cassandra
     def assert_responds_to(method, value, message = nil, &block)
       unless value.respond_to?(method)
         message   = yield if block_given?
-        message ||= "value #{value.inspect} must respond to #{method.inspect}, but doesn't"
+        message ||= "value #{value.inspect} must respond to #{method.inspect}, " \
+            "but doesn't"
 
         raise ::ArgumentError, message
       end
@@ -230,7 +240,8 @@ module Cassandra
     def assert_responds_to_all(methods, value, message = nil, &block)
       unless methods.all? {|method| value.respond_to?(method)}
         message   = yield if block_given?
-        message ||= "value #{value.inspect} must respond to all methods #{methods.inspect}, but doesn't"
+        message ||= "value #{value.inspect} must respond to all methods " \
+            "#{methods.inspect}, but doesn't"
 
         raise ::ArgumentError, message
       end
@@ -239,14 +250,14 @@ module Cassandra
     def assert_not_empty(value, message = nil, &block)
       if value.empty?
         message   = yield if block_given?
-        message ||= "value cannot be empty"
+        message ||= 'value cannot be empty'
 
         raise ::ArgumentError, message
       end
     end
 
     def assert_file_exists(path, message = nil, &block)
-      unless ::File.exists?(path)
+      unless ::File.exist?(path)
         message   = yield if block_given?
         message ||= "expected file at #{path.inspect} to exist, but it doesn't"
 
@@ -266,7 +277,8 @@ module Cassandra
     def assert_size(size, value, message = nil, &block)
       unless value.size == size
         message   = yield if block_given?
-        message ||= "value #{value.inspect} must have size equal to #{size.inspect}, but doesn't"
+        message ||= "value #{value.inspect} must have size equal to " \
+            "#{size.inspect}, but doesn't"
 
         raise ::ArgumentError, message
       end
@@ -275,7 +287,7 @@ module Cassandra
     def assert(condition, message = nil, &block)
       unless condition
         message   = yield if block_given?
-        message ||= "assertion failed"
+        message ||= 'assertion failed'
 
         raise ::ArgumentError, message
       end
@@ -311,14 +323,142 @@ module Cassandra
     # @private
     COLON = ': '.freeze
     # @private
-    QUOT = ?'.freeze
+    QUOT = "'".freeze
     # @private
     ESC_QUOT = "''".freeze
     # @private
-    DBL_QUOT = ?".freeze
+    DBL_QUOT = '"'.freeze
     # @private
     PRN_OPN = '('.freeze
     # @private
     PRN_CLS = ')'.freeze
+    RESERVED_WORDS = Set.new(%w(
+                               add
+                               aggregate
+                               all
+                               allow
+                               alter
+                               and
+                               apply
+                               as
+                               asc
+                               ascii
+                               authorize
+                               batch
+                               begin
+                               bigint
+                               blob
+                               boolean
+                               by
+                               called
+                               clustering
+                               columnfamily
+                               compact
+                               contains
+                               count
+                               counter
+                               create
+                               custom
+                               date
+                               decimal
+                               delete
+                               desc
+                               describe
+                               distinct
+                               double
+                               drop
+                               entries
+                               execute
+                               exists
+                               filtering
+                               finalfunc
+                               float
+                               from
+                               frozen
+                               full
+                               function
+                               functions
+                               grant
+                               if
+                               in
+                               index
+                               inet
+                               infinity
+                               initcond
+                               input
+                               insert
+                               int
+                               into
+                               is
+                               json
+                               key
+                               keys
+                               keyspace
+                               keyspaces
+                               language
+                               limit
+                               list
+                               login
+                               map
+                               materialized
+                               modify
+                               nan
+                               nologin
+                               norecursive
+                               nosuperuser
+                               not
+                               null
+                               of
+                               on
+                               options
+                               or
+                               order
+                               password
+                               permission
+                               permissions
+                               primary
+                               rename
+                               replace
+                               returns
+                               revoke
+                               role
+                               roles
+                               schema
+                               select
+                               set
+                               sfunc
+                               smallint
+                               static
+                               storage
+                               stype
+                               superuser
+                               table
+                               text
+                               time
+                               timestamp
+                               timeuuid
+                               tinyint
+                               to
+                               token
+                               trigger
+                               truncate
+                               ttl
+                               tuple
+                               type
+                               unlogged
+                               update
+                               use
+                               user
+                               users
+                               using
+                               uuid
+                               values
+                               varchar
+                               varint
+                               view
+                               where
+                               with
+                               writetime
+                             )).freeze
   end
 end