datastax_rails 2.0.12 → 2.0.15

data/lib/datastax_rails/timestamps.rb

@@ -20,14 +20,14 @@ module DatastaxRails
       super
     end
 
-  private
+    private
 
     def _create_record(*args)
-      if self.record_timestamps
+      if record_timestamps
         current_time = current_time_from_proper_timezone
 
         all_timestamp_attributes.each do |column|
-          if respond_to?(column) && respond_to?("#{column}=") && self.send(column).nil?
+          if respond_to?(column) && respond_to?("#{column}=") && send(column).nil?
             write_attribute(column.to_s, current_time)
           end
         end
@@ -50,7 +50,7 @@ module DatastaxRails
     end
 
     def should_record_timestamps?
-      self.record_timestamps && (changed? || (attributes.keys & self.class.serialized_attributes.keys).present?)
+      record_timestamps && (changed? || (attributes.keys & self.class.serialized_attributes.keys).present?)
     end
 
     def timestamp_attributes_for_create_in_model

data/lib/datastax_rails/types/dirty_collection.rb

@@ -1,88 +1,88 @@
-# An extension to normal arrays and hashes that allow for tracking of dirty values.  This is
-# used by ActiveModel's change tracking framework.
 module DatastaxRails
   module Types
+    # An extension to normal arrays and hashes that allow for tracking of dirty values.  This is
+    # used by ActiveModel's change tracking framework.
     module DirtyCollection
       extend ActiveSupport::Concern
-      
+      mattr_accessor :dsr_ignore_modifications
+
       included do
         attr_accessor :record, :name
-        
-        methods = [:<<, :delete, :[]=, :add, :subtract, :store, :push, :pop, :unshift, :shift, :insert, :clear] +
-                   ActiveSupport::HashWithIndifferentAccess.instance_methods(true).select{|m| m.to_s.ends_with?('!')} +
-                   Array.instance_methods(true).select{|m| m.to_s.ends_with?('!')} +
-                   Set.instance_methods(true).select{|m| m.to_s.ends_with?('!')}
-                
-        methods.each do |m|
-          if self.instance_methods.include?(m)
-            alias_method "___#{m}", m
-            original_method = self.instance_method(m)
-            define_method(m) do |*args, &block|
-              modifying do
-                original_method.bind(self).call(*args, &block)
-              end
+
+        ms = [:<<, :delete, :[]=, :add, :subtract, :store, :push, :pop, :unshift, :shift, :insert, :clear] +
+             ActiveSupport::HashWithIndifferentAccess.instance_methods(true).select { |m| m.to_s.ends_with?('!') } +
+             Array.instance_methods(true).select { |m| m.to_s.ends_with?('!') } +
+             Set.instance_methods(true).select { |m| m.to_s.ends_with?('!') }
+
+        ms.each do |m|
+          next unless instance_methods.include?(m)
+          alias_method "___#{m}", m
+          original_method = instance_method(m)
+          define_method(m) do |*args, &block|
+            modifying do
+              original_method.bind(self).call(*args, &block)
             end
           end
         end
       end
-      
+
       def initialize(record, name, collection)
         @record   = record
         @name     = name.to_s
-        
+
         super(collection)
         organize_collection
       end
-      
+
       def delete(obj)
         modifying do
           super
         end
       end
-      
+
+      # FIXME: How do we make this thread-safe?
       def self.ignore_modifications
-        original = $dsr_ignore_modifications
-        $dsr_ignore_modifications = true
+        original = dsr_ignore_modifications
+        self.dsr_ignore_modifications = true
         result = yield
-        $dsr_ignore_modifications = original
+        self.dsr_ignore_modifications = original
         result
       end
-      
+
       private
-        def modifying
-          # So there's a problem with overriding the map! method on Array.
-          # When we do the update to record.attributes, HashWithIndifferentAccess
-          # calls .map! on our Array.  This causes infinite recursion which
-          # I find is generally not a desired behavior.  We use a variable
-          # to tell if we've already hijacked the call.
-          if $dsr_ignore_modifications
-            yield
-          else
-            DirtyCollection.ignore_modifications do
-              unless record.changed_attributes.key?(name)
-                original = dup
-              end
-    
-              result = yield
-              
-              organize_collection
-    
-              if !record.changed_attributes.key?(name) && original != self
-                record.changed_attributes[name] = original
-              end
-              
-              record.attributes[name] = self
-              
-              result
+
+      def modifying
+        # So there's a problem with overriding the map! method on Array.
+        # When we do the update to record.attributes, HashWithIndifferentAccess
+        # calls .map! on our Array.  This causes infinite recursion which
+        # I find is generally not a desired behavior.  We use a variable
+        # to tell if we've already hijacked the call.
+        if dsr_ignore_modifications
+          yield
+        else
+          DirtyCollection.ignore_modifications do
+            original = dup unless record.changed_attributes.key?(name)
+
+            result = yield
+
+            organize_collection
+
+            if !record.changed_attributes.key?(name) && original != self
+              record.changed_attributes[name] = original
             end
+
+            record.attributes[name] = self
+
+            result
           end
         end
-        
-        # A hook to allow implementing classes to muck with the collection
-        # before we check it for equality.
-        def organize_collection
-          # No-op
-        end
+      end
+
+      # A hook to allow implementing classes to muck with the collection
+      # before we check it for equality.
+      def organize_collection
+        # No-op
+      end
     end
   end
-end
+end

data/lib/datastax_rails/types/dynamic_list.rb

@@ -11,4 +11,4 @@ module DatastaxRails
       end
     end
   end
-end
+end

data/lib/datastax_rails/types/dynamic_map.rb

@@ -9,23 +9,21 @@ module DatastaxRails
     # between them and dynamic fields.
     class DynamicMap < ActiveSupport::HashWithIndifferentAccess
       include DirtyCollection
-            
+
       def dup
         self.class.new(record, name, self).tap do |new_hash|
           new_hash.default = default
         end
       end
-      
+
       def [](key)
         super(convert_key(key))
       end
-      
+
       def convert_key(key)
-        unless key.to_s.starts_with?(name)
-          key = name + key.to_s
-        end
+        key = name + key.to_s unless key.to_s.starts_with?(name)
         super(key)
       end
     end
   end
-end
+end

data/lib/datastax_rails/types/dynamic_set.rb

@@ -1,10 +1,10 @@
 module DatastaxRails
   module Types
     # A collection type that allows you to store an un-ordered, unique
-    # set of entries. Changes are tracked by hooking into ActiveModel's 
+    # set of entries. Changes are tracked by hooking into ActiveModel's
     # built-in change tracking.
     class DynamicSet < Set
       include DirtyCollection
     end
   end
-end
+end

data/lib/datastax_rails/util/solr_repair.rb

@@ -2,12 +2,12 @@ module DatastaxRails
   module SolrRepair
     def repair_solr
       encoded = {}
-      self.attributes.keys.each do |column_name|
-        value = self.read_attribute(column_name)
+      attributes.keys.each do |column_name|
+        value = read_attribute(column_name)
         encoded[column_name.to_s] = self.class.column_for_attribute(column_name).type_cast_for_solr(value)
       end
       xml_doc = RSolr::Xml::Generator.new.add(encoded)
-      self.class.solr_connection.update(:data => xml_doc, :params => {:replacefields => false})
+      self.class.solr_connection.update(data: xml_doc, params: { replacefields: false })
     end
   end
 end

data/lib/datastax_rails/validations/associated.rb

@@ -2,8 +2,8 @@ module DatastaxRails
   module Validations
     class AssociatedValidator < ActiveModel::EachValidator
       def validate_each(record, attribute, value)
-        if Array.wrap(value).reject {|r| r.destroyed? || r.valid?}.any?
-          record.errors.add(attribute, :invalid, options.merge(:value => value))
+        if Array.wrap(value).reject { |r| r.destroyed? || r.valid? }.any?
+          record.errors.add(attribute, :invalid, options.merge(value: value))
         end
       end
     end
@@ -18,7 +18,8 @@ module DatastaxRails
       #     validates_associated :pages, :library
       #   end
       #
-      # WARNING: This validation must not be used on both ends of an association. Doing so will lead to a circular dependency and cause infinite recursion.
+      # WARNING: This validation must not be used on both ends of an association.
+      # Doing so will lead to a circular dependency and cause infinite recursion.
       #
       # NOTE: This validation will not fail if the association hasn't been assigned. If you want to
       # ensure that the association is both present and guaranteed to be valid, you also need to
@@ -30,10 +31,11 @@ module DatastaxRails
       #   validation contexts by default (+nil+), other options are <tt>:create</tt>
       #   and <tt>:update</tt>.
       # * <tt>:if</tt> - Specifies a method, proc or string to call to determine if the validation should
-      #   occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>). The
-      #   method, proc or string should return or evaluate to a true or false value.
+      #   occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>).
+      #   The method, proc or string should return or evaluate to a true or false value.
       # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine if the validation should
-      #   not occur (e.g. <tt>:unless => :skip_validation</tt>, or <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>). The
+      #   not occur (e.g. <tt>:unless => :skip_validation</tt>, or
+      #   <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>). The
       #   method, proc or string should return or evaluate to a true or false value.
       def validates_associated(*attr_names)
         validates_with AssociatedValidator, _merge_attributes(attr_names)

data/lib/datastax_rails/validations/uniqueness.rb

@@ -6,29 +6,29 @@ module DatastaxRails
       def initialize(options)
         super
       end
-      
+
       def validate_each(record, attribute, value)
         return true if options[:allow_blank] && value.blank?
         # XXX: The following will break if/when abstract base classes
         #      are implemented in datastax_rails (such as STI)
         finder_class = record.class
-        
+
         scope = finder_class.where(attribute => value)
-        scope = scope.where_not(:id => record.id) if record.persisted?
-        
+        scope = scope.where_not(id: record.id) if record.persisted?
+
         Array.wrap(options[:scope]).each do |scope_item|
           scope_value = record.send(scope_item)
           scope_value = nil if scope_value.blank?
           scope = scope.where(scope_item => scope_value)
         end
 
-        if scope.exists?
+        if scope.exists? # rubocop:disable Style/GuardClause
           message = options[:message] || 'has already been taken'
-          record.errors.add(attribute, message, options.except(:case_sensitive, :scope).merge(:value => value))
+          record.errors.add(attribute, message, options.except(:case_sensitive, :scope).merge(value: value))
         end
       end
     end
-    
+
     module ClassMethods
       # Validates whether the value of the specified attributes are unique across the system.
       # Useful for making sure that only one user can be named "davidhh".
@@ -112,4 +112,4 @@ module DatastaxRails
       end
     end
   end
-end
+end

data/lib/datastax_rails/validations.rb

@@ -6,11 +6,10 @@ module DatastaxRails
       super("Invalid record: #{@record.errors.full_messages.to_sentence}")
     end
   end
-  
+
   module Validations
     extend ActiveSupport::Concern
-    include ActiveModel::Validations
-    
+
     module ClassMethods
       def create!(attributes = {})
         new(attributes).tap do |object|
@@ -20,7 +19,6 @@ module DatastaxRails
       end
     end
 
-
     # Runs all the validations within the specified context. Returns true if no errors are found,
     # false otherwise.
     #
@@ -35,18 +33,19 @@ module DatastaxRails
       errors.empty? && output
     end
 
-    def save(options={})
+    def save(options = {})
       perform_validations(options) ?  super : false
     end
-    
+
     def save!
-      save || raise(RecordInvalid.new(self))
+      save || fail(RecordInvalid.new(self))
     end
 
     protected
-      def perform_validations(options={})
-        options[:validate] == false || valid?(options[:context])
-      end
+
+    def perform_validations(options = {})
+      options[:validate] == false || valid?(options[:context])
+    end
   end
 end
 

data/lib/datastax_rails/version.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/Documentation
 module DatastaxRails
-  VERSION = "2.0.12"
+  VERSION = '2.0.15'
 end

data/lib/datastax_rails/wide_storage_model.rb

@@ -1,13 +1,13 @@
 module DatastaxRails
   # A special model that is designed to efficiently store very wide data.
   # This model type assumes that you have a unique ID that you want to
-  # store a lot of data about.  The data is stored as a single, very 
+  # store a lot of data about.  The data is stored as a single, very
   # wide row; however you can safely treat it as if there were multiple rows.
   # A common example of this is a logs table
   #
   # You can also apply secondary indexes onto the other columns.
   #
-  # CAVEATS: 
+  # CAVEATS:
   # * Once the cluster attribute is set, it cannot be changed as it becomes the column header in Cassandra
   #
   #   class AuditLog < DatastaxRails::WideStorageModel
@@ -15,7 +15,7 @@ module DatastaxRails
   #     self.primary_key = :uuid
   #     self.cluster_by = :created_at
   #     # If you don't want the default ascending sort order
-  #     self.create_options = 'CLUSTERING ORDER BY (created_at DESC)' 
+  #     self.create_options = 'CLUSTERING ORDER BY (created_at DESC)'
   #
   #     string :uuid
   #     string :message
@@ -24,10 +24,10 @@ module DatastaxRails
   #   end
   class WideStorageModel < DatastaxRails::Base
     self.abstract_class = true
-    
+
     # Returns a primary key hash for updates that includes the cluster key
     def id_for_update
-      {self.class.primary_key.to_s => self.id, self.class.cluster_by.to_s => self.read_attribute(self.class.cluster_by.to_s)}
+      { self.class.primary_key.to_s => id, self.class.cluster_by.to_s => read_attribute(self.class.cluster_by.to_s) }
     end
   end
-end
+end

data/lib/datastax_rails.rb

@@ -5,7 +5,7 @@ require 'schema_migration'
 # Welcome to DatastaxRails.  DatastaxRails::Base is probably a good place to start.
 module DatastaxRails
   extend ActiveSupport::Autoload
-  
+
   autoload :Associations
   autoload :AttributeAssignment
   autoload :AttributeMethods
@@ -16,11 +16,11 @@ module DatastaxRails
   autoload :Column
   autoload :Collection
   autoload :Connection
-  
+
   autoload_under 'connection' do
     autoload :StatementCache
   end
-  
+
   autoload :Cql
   autoload :DynamicModel
   autoload :GroupedCollection
@@ -30,7 +30,7 @@ module DatastaxRails
   autoload :Persistence
   autoload :Reflection
   autoload :Relation
-  
+
   autoload_under 'relation' do
     autoload :FinderMethods
     autoload :ModificationMethods
@@ -40,7 +40,7 @@ module DatastaxRails
     autoload :Batches
     autoload :FacetMethods
   end
-  
+
   autoload :RSolrClientWrapper, 'datastax_rails/rsolr_client_wrapper'
   autoload :Schema
   autoload :Scoping
@@ -52,7 +52,8 @@ module DatastaxRails
   autoload :Validations
   autoload :Version
   autoload :WideStorageModel
-  
+
+  # Module to hold attribute method related functionality
   module AttributeMethods
     extend ActiveSupport::Autoload
 
@@ -64,7 +65,8 @@ module DatastaxRails
       autoload :Write
     end
   end
-  
+
+  # Module to hold scoping related functionality
   module Scoping
     extend ActiveSupport::Autoload
 
@@ -74,15 +76,17 @@ module DatastaxRails
     end
   end
 
+  # Module to hold Rake task related functionality
   module Tasks
     extend ActiveSupport::Autoload
     autoload :Keyspace
     autoload :ColumnFamily
   end
-  
+
+  # Module to hold type related functionality
   module Types
     extend ActiveSupport::Autoload
-    
+
     eager_autoload do
       autoload :DirtyCollection
       autoload :DynamicList