datastax_rails 2.0.12 → 2.0.15

data/lib/datastax_rails/connection/statement_cache.rb

@@ -1,12 +1,12 @@
 module DatastaxRails
   module StatementCache
     extend ActiveSupport::Concern
-    
+
     included do
       class_attribute :statement_cache
       self.statement_cache = {}
     end
-    
+
     module ClassMethods
       def establish_connection(spec)
         self.statement_cache = {}
@@ -14,4 +14,4 @@ module DatastaxRails
       end
     end
   end
-end
+end

data/lib/datastax_rails/connection.rb

@@ -8,7 +8,7 @@ module DatastaxRails
   # Datastax Exterprise.  This includes both the Cassandra and Solr connections.
   module Connection
     extend ActiveSupport::Concern
-    
+
     included do
       include DatastaxRails::StatementCache
       class_attribute :connection
@@ -17,11 +17,11 @@ module DatastaxRails
 
     module ClassMethods
       DEFAULT_OPTIONS = {
-        :servers => "127.0.0.1:9160",
-        :thrift => {},
-        :cql_version => '3.0.0'
+        servers:     '127.0.0.1:9160',
+        thrift:      {},
+        cql_version: '3.0.0'
       }
-      
+
       # Returns the current server that we are talking to.  This is useful when you are talking to a
       # cluster, and we want to know which server specifically we are connected to.
       #
@@ -31,7 +31,7 @@ module DatastaxRails
       def current_server
         connection.current_connection.instance_variable_get(:@connection).host
       end
-      
+
       # Establish a Cassandra connection to DSE.  datastax.yml will be read and the current environment's
       # settings passed to this method.
       #
@@ -42,7 +42,7 @@ module DatastaxRails
       #   port: 9042
       #   keyspace: "datastax_rails_production"
       #   strategy_class: "org.apache.cassandra.locator.NetworkTopologyStrategy"
-      #   strategy_options: {"DS1": "3", "DS2": "3", "DS3": "3"} 
+      #   strategy_options: {"DS1": "3", "DS2": "3", "DS3": "3"}
       #   connection_options:
       #     timeout: 10
       #   solr:
@@ -58,8 +58,8 @@ module DatastaxRails
       # will automatically connect to all nodes in the cluster or in the datacenter if you are using multiple
       # datacenters.  You can safely just list all nodes in a particular datacenter if you would like.
       #
-      # The port to connect to, this port will be used for all nodes. Because the `system.peers` table does not contain the port that the nodes are 
-      # listening on, the port must be the same for all nodes.
+      # The port to connect to, this port will be used for all nodes. Because the `system.peers` table does not contain
+      # the port that the nodes are listening on, the port must be the same for all nodes.
       #
       # Since we're using the NetworkTopologyStrategy for our locator, it is important that you configure
       # cassandra-topology.properties.  See the DSE documentation at http://www.datastax.com for more
@@ -70,20 +70,27 @@ module DatastaxRails
       #
       # connection_options are the options that are passed to the thrift layer for the connection to
       # cassandra.
-      # * *retries* - Number of times a request will be retried. Should likely be the number of servers - 1. Defaults to 0.
+      # * *retries* - Number of times a request will be retried. Should likely be the number of servers - 1.
+      #   Defaults to 0.
       # * *server_retry_period* - Amount of time to wait before retrying a down server. Defaults to 1.
-      # * *server_max_requests* - Number of requests to make to a server before moving to the next one (helps keep load balanced). Default to nil which means cycling does not take place.
+      # * *server_max_requests* - Number of requests to make to a server before moving to the next one (helps keep load
+      #   balanced). Default to nil which means cycling does not take place.
       # * *retry_overrides* - Overrides retries option for individual exceptions.
       # * *connect_timeout* - The connection timeout on the Thrift socket. Defaults to 0.1.
       # * *timeout* - The timeout for the transport layer. Defaults to 1.
       # * *timeout_overrides* - Overrides the timeout value for specific methods (advanced).
-      # * *exception_classes* - List of exceptions for which Thrift will automatically retry a new server in the cluster (up to retry limit).
+      # * *exception_classes* - List of exceptions for which Thrift will automatically retry a new server in the cluster
+      #   (up to retry limit).
       #   Defaults to [IOError, Thrift::Exception, Thrift::ApplicationException, Thrift::TransportException].
-      # * *exception_class_overrides* - List of exceptions which will never cause a retry. Defaults to [CassandraCQL::Thrift::InvalidRequestException].
-      # * *wrapped_exception_options* - List of exceptions that will be automatically wrapped in an exception provided by client class with the same name (advanced).
+      # * *exception_class_overrides* - List of exceptions which will never cause a retry.
+      #   Defaults to [CassandraCQL::Thrift::InvalidRequestException].
+      # * *wrapped_exception_options* - List of exceptions that will be automatically wrapped in an exception provided
+      #   by client class with the same name (advanced).
       #   Defaults to [Thrift::ApplicationException, Thrift::TransportException].
-      # * *raise* - Whether to raise exceptions or default calls that cause an error (advanced). Defaults to true (raise exceptions).
-      # * *defaults* - When raise is false and an error is encountered, these methods are called to default the return value (advanced). Should be a hash of method names to values.
+      # * *raise* - Whether to raise exceptions or default calls that cause an error (advanced). Defaults to true
+      #   (raise exceptions).
+      # * *defaults* - When raise is false and an error is encountered, these methods are called to default the return
+      #   value (advanced). Should be a hash of method names to values.
       # * *protocol* - The thrift protocol to use (advanced). Defaults to Thrift::BinaryProtocol.
       # * *protocol_extra_params* - Any extra parameters to send to the protocol (advanced).
       # * *transport* - The thrift transport to use (advanced). Defaults to Thrift::Socket.
@@ -93,41 +100,43 @@ module DatastaxRails
       def establish_connection(spec)
         DatastaxRails::Base.config = spec.with_indifferent_access
         spec.reverse_merge!(DEFAULT_OPTIONS)
-        connection_options = spec[:connection_options] || {}
-        self.connection = ::Cql::Client.connect(:hosts => spec[:servers], :keyspace => spec[:keyspace], :connection_timeout => spec[:connection_options][:timeout])
+        self.connection = ::Cql::Client.connect(hosts:              spec[:servers],
+                                                keyspace:           spec[:keyspace],
+                                                connection_timeout: spec[:connection_options][:timeout])
       end
-      
+
       # Returns the base portion of the URL for connecting to SOLR based on the current Cassandra server.
       #
       # @return [String] in the form of 'http://localhost:8983/solr'
       def solr_base_url
-        DatastaxRails::Base.establish_connection unless self.connection
+        DatastaxRails::Base.establish_connection unless connection
         port = DatastaxRails::Base.config[:solr][:port]
         path = DatastaxRails::Base.config[:solr][:path]
-        protocol = DatastaxRails::Base.config[:solr].has_key?(:ssl) && DatastaxRails::Base.config[:solr][:ssl][:use_ssl] ? 'https' : 'http'
-        "#{protocol}://#{self.current_server}:#{port}#{path}"
+        protocol = DatastaxRails::Base.config[:solr].key?(:ssl) && DatastaxRails::Base.config[:solr][:ssl][:use_ssl] ? 'https' : 'http' # rubocop:disable LineLength
+        "#{protocol}://#{current_server}:#{port}#{path}"
       end
-      
+
       # Wraps and caches a solr connection object
       #
       # @params [Boolean] reconnect force a new connection
-      # @return [DatastaxRails::RSolrClientWrapper] a wrapped RSolr connection      
+      # @return [DatastaxRails::RSolrClientWrapper] a wrapped RSolr connection
       def solr_connection(reconnect = false)
-        if(!@rsolr || reconnect)
+        if !@rsolr || reconnect
           @rsolr = DatastaxRails::RSolrClientWrapper.new(establish_solr_connection, self)
         end
         @rsolr
       end
-      
-      # Similar to +establish_connection+, this method creates a connection object for Solr.  Since HTTP is stateless, this doesn't
-      # actually launch the connection, but it gets everything set up so that RSolr can do its work.  It's important to note that
-      # unlike the cassandra connection which is global to all of DSR, each model will have its own solr_connection.
+
+      # Similar to +establish_connection+, this method creates a connection object for Solr. Since HTTP is stateless,
+      # this doesn't actually launch the connection, but it gets everything set up so that RSolr can do its work. It's
+      # important to note that unlike the cassandra connection which is global to all of DSR, each model will have its
+      # own solr_connection.
       #
       # @return [RSolr::Client] RSolr client object
       def establish_solr_connection
-        opts = {:url => "#{solr_base_url}/#{DatastaxRails::Base.connection.keyspace}.#{self.column_family}"}
-        if DatastaxRails::Base.config[:solr].has_key?(:ssl) && 
-            DatastaxRails::Base.config[:solr][:ssl].has_key?(:cert) && 
+        opts = { url: "#{solr_base_url}/#{DatastaxRails::Base.connection.keyspace}.#{column_family}" }
+        if DatastaxRails::Base.config[:solr].key?(:ssl) &&
+            DatastaxRails::Base.config[:solr][:ssl].key?(:cert) &&
             DatastaxRails::Base.config[:solr][:ssl][:use_ssl]
           cert = Pathname.new(DatastaxRails::Base.config[:solr][:ssl][:cert])
           key = Pathname.new(DatastaxRails::Base.config[:solr][:ssl][:key])
@@ -137,7 +146,7 @@ module DatastaxRails
           opts[:ssl_cert_file] = cert.to_s
           opts[:ssl_key_file] = key.to_s
           opts[:ssl_key_pass] = pass if pass
-          
+
           RSolr::ClientCert.connect opts
         else
           RSolr.connect opts

data/lib/datastax_rails/cql/alter_column_family.rb

@@ -1,56 +1,54 @@
-module DatastaxRails#:nodoc:
+module DatastaxRails #:nodoc:
   module Cql #:nodoc:
     class AlterColumnFamily < Base #:nodoc:
       def initialize(cf_name)
         @cf_name = cf_name
         @action = nil
       end
-      
+
       def add(column)
         set_column(column)
-        @action = 'ADD' 
+        @action = 'ADD'
         self
       end
-      
+
       def drop(column)
         set_column(column)
         @action = 'DROP'
-        self 
+        self
       end
-      
+
       def alter(column)
         set_column(column)
         @action = 'ALTER'
-        self 
+        self
       end
-      
-      def rename(col1,col2)
-        set_column([col1,col2])
+
+      def rename(col1, col2)
+        set_column([col1, col2])
         @action = 'RENAME'
         self
       end
 
-      def set_column(column)  
-        if(@action)
-          raise ArgumentError, "Only one operation allowed per CQL call"
-        end
+      def set_column(column) # rubocop:disable Style/AccessorMethodName
+        fail ArgumentError, 'Only one operation allowed per CQL call' if @action
         @column = column
       end
-      
+
       def to_cql
         stmt = "ALTER COLUMNFAMILY #{@cf_name} "
-        if(@action == 'ALTER')
+        if (@action == 'ALTER')
           stmt << "ALTER #{@column.keys.first} TYPE #{@column.values.first}"
-        elsif(@action == 'ADD')
+        elsif (@action == 'ADD')
           stmt << "ADD #{@column.keys.first} #{@column.values.first}"
-        elsif(@action == 'DROP')
+        elsif (@action == 'DROP')
           stmt << "DROP #{@column}"
-        elsif(@action == 'RENAME')
+        elsif (@action == 'RENAME')
           stmt << "RENAME \"#{@column[0]}\" TO \"#{@column[1]}\""
         end
-        
+
         stmt
       end
     end
   end
-end
+end

data/lib/datastax_rails/cql/base.rb

@@ -1,42 +1,39 @@
 module DatastaxRails
   module Cql
+    # Base class for CQL generation
     class Base
       # Base initialize that sets the default consistency.
-      def initialize(klass, *args)
+      def initialize(klass, *_args)
         @consistency = klass.default_consistency.to_s.downcase.to_sym
         @keyspace = DatastaxRails::Base.config[:keyspace]
         @values = []
       end
-      
+
       def using(consistency)
         @consistency = consistency.to_s.downcase.to_sym
         self
       end
-      
-      def key_name
-        @klass.key_factory.key_columns
-      end
 
       # Abstract. Should be overridden by subclasses
       def to_cql
-        raise NotImplementedError
+        fail NotImplementedError
       end
-      
+
       # Generates the CQL and calls Cassandra to execute it.
       # If you are using this outside of Rails, then DatastaxRails::Base.connection must have
       # already been set up (Rails does this for you).
       def execute
-        cql = self.to_cql
+        cql = to_cql
         puts cql if ENV['DEBUG_CQL'] == 'true'
         pp @values if ENV['DEBUG_CQL'] == 'true'
         digest = Digest::MD5.digest cql
         stmt = DatastaxRails::Base.statement_cache[digest] ||= DatastaxRails::Base.connection.prepare(cql)
         if @consistency
-          stmt.execute(*@values, :consistency => @consistency)
+          stmt.execute(*@values, consistency: @consistency)
         else
           stmt.execute(*@values)
         end
       end
     end
   end
-end
+end

data/lib/datastax_rails/cql/column_family.rb

@@ -1,38 +1,39 @@
 module DatastaxRails
   module Cql
+    # Helper class to create CQL-building objects
     class ColumnFamily
       def initialize(klass)
         @klass = klass
       end
-      
+
       def create_column_family
         DatastaxRails::Cql::CreateColumnFamily.new(@klass.column_family)
       end
-      
-      def delete(*keys)
-        DatastaxRails::Cql::Delete.new(@klass, keys.flatten)
+
+      def delete(key)
+        DatastaxRails::Cql::Delete.new(@klass, key)
       end
-      
+
       def insert
         DatastaxRails::Cql::Insert.new(@klass)
       end
-      
+
       def drop_column_family
         DatastaxRails::Cql::DropColumnFamily.new(@klass.column_family)
       end
-      
+
       def select(*columns)
-        columns << "*" if columns.empty?
+        columns << '*' if columns.empty?
         DatastaxRails::Cql::Select.new(@klass, columns.flatten)
       end
 
       def truncate
         DatastaxRails::Cql::Truncate.new(@klass)
       end
-      
+
       def update(key)
         DatastaxRails::Cql::Update.new(@klass, key)
       end
     end
   end
-end
+end

data/lib/datastax_rails/cql/consistency.rb

@@ -7,8 +7,8 @@ module DatastaxRails
       LOCAL_QUORUM = 'LOCAL_QUORUM'
       EACH_QUORUM = 'EACH_QUORUM'
       ALL = 'ALL'
-      
+
       VALID_CONSISTENCY_LEVELS = [ANY, ONE, QUORUM, LOCAL_QUORUM, EACH_QUORUM, ALL]
     end
   end
-end
+end

data/lib/datastax_rails/cql/create_column_family.rb

@@ -1,4 +1,4 @@
-module DatastaxRails#:nodoc:
+module DatastaxRails #:nodoc:
   module Cql #:nodoc:
     class CreateColumnFamily < Base #:nodoc:
       def initialize(cf_name)
@@ -12,43 +12,43 @@ module DatastaxRails#:nodoc:
         @primary_key = pk
         self
       end
-      
+
       def with(with)
         @storage_parameters << with
         self
       end
-      
+
       def columns(columns)
         @columns.merge! columns
         self
       end
-      
+
       # Migration helpers
       def comment=(comment)
-        with("comment" => comment)
+        with('comment' => comment)
       end
-      
+
       def comparator=(comp)
-        with("comparator" => comp)
+        with('comparator' => comp)
       end
-      
+
       def default_validation=(val)
-        with("default_validation" => val)
+        with('default_validation' => val)
       end
-      
+
       def to_cql
         stmt = "CREATE COLUMNFAMILY #{@cf_name} ("
-        @columns.each do |name,type|
+        @columns.each do |name, type|
           stmt << "#{name} #{type}, "
         end
         stmt << "PRIMARY KEY (#{@primary_key}))"
         unless @storage_parameters.empty?
-          stmt << " WITH "
-          stmt << @storage_parameters.flatten.join(" AND ")
+          stmt << ' WITH '
+          stmt << @storage_parameters.flatten.join(' AND ')
         end
-        
+
         stmt
       end
     end
   end
-end
+end

data/lib/datastax_rails/cql/create_index.rb

@@ -1,4 +1,4 @@
-module DatastaxRails#:nodoc:
+module DatastaxRails #:nodoc:
   module Cql #:nodoc:
     class CreateIndex < Base #:nodoc:
       def initialize(index_name = nil)
@@ -6,20 +6,20 @@ module DatastaxRails#:nodoc:
         @column = nil
         @index_name = index_name
       end
-      
+
       def on(cf_name)
         @cf_name = cf_name
         self
       end
-      
+
       def column(column)
         @column = column
         self
       end
-      
+
       def to_cql
         "CREATE INDEX #{@index_name} ON #{@cf_name} (#{@column})"
       end
     end
   end
-end
+end