columns_on_demand 4.3.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ea8794dded2d78daf705ceaab6df85b8a150fcb
-  data.tar.gz: 0549493f7b65d99480413e6a24d5016d76984251
+  metadata.gz: c49cd47105f630d84e2f6ad368006311ee60c3c3
+  data.tar.gz: c239c30034961fd54de59f856c101c027d21bb36
 SHA512:
-  metadata.gz: 7f984d613b9eeccb2d14fab83e1dd6948a970d3b482876e6095a6605674bf80b8878afd4ec19b8206a4c830341e3b05ac52a7fb30d40f08ff7edfb8198e630da
-  data.tar.gz: ae1a56951d46b3703d3156d2275a099a0de958139c6b978c5805064ce28f7b2ddb361458b6462388346cf580de233bfbc95d9f1228694bd5989e40095a80f70f
+  metadata.gz: 3408bb8a756cd559c996ca3afdb7b7994a9137bc94ae19e97b365f12c845da1d154353e6b1900b28e631cee76d8cb73289bffe09f46bd71300d560a5be94ff17
+  data.tar.gz: 3ffd5d76e1fc8f8ce5a260927faa6dd022c6d151bea1c72e0fea4e7c8804f81443f265e6b89960747d38d4d7d4690e5d101a635fc5deb16e399c91b312adafa3

data/README.md

@@ -21,10 +21,9 @@ Compatibility
 
 Supports mysql, mysql2, postgresql, and sqlite3.
 
-Currently tested against Rails 4.2.3, 4.1.12, 4.0.13, 3.2.18, on Ruby 2.1.5.
+Currently tested against Rails 5.1 (up to 5.1.0beta1), 5.0 (up to 5.0.2), and 4.2 (up to 4.2.7), on Ruby 2.3.4.
 
-Was also previously tested compatible with 2.3.14, 3.0.17, and 3.1.8 on Ruby 2.0.0
-or 1.8.7 as appropriate, and may still work for them.
+For earlier versions of Rails, use an older version of the gem.
 
 
 Example

data/columns_on_demand.gemspec

@@ -45,4 +45,5 @@ EOF
   gem.add_development_dependency "mysql2"
   gem.add_development_dependency "pg"
   gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "byebug"
 end

data/lib/columns_on_demand.rb

@@ -5,30 +5,11 @@ module ColumnsOnDemand
       self.columns_to_load_on_demand = columns_to_load_on_demand.empty? ? blob_and_text_columns : columns_to_load_on_demand.collect(&:to_s)
 
       extend ClassMethods
-      include InstanceMethods
+      prepend InstanceMethods
 
       class <<self
-        unless ActiveRecord::VERSION::MAJOR > 3 ||
-              (ActiveRecord.const_defined?(:AttributeMethods) &&
-               ActiveRecord::AttributeMethods::const_defined?(:Serialization) &&
-               ActiveRecord::AttributeMethods::Serialization::const_defined?(:Attribute))
-          alias_method_chain :define_read_method_for_serialized_attribute, :columns_on_demand
-        end
-        alias_method_chain :reset_column_information,        :columns_on_demand
-      end
-      alias_method_chain   :attributes,                      :columns_on_demand
-      alias_method_chain   :attribute_names,                 :columns_on_demand
-      alias_method_chain   :read_attribute,                  :columns_on_demand
-      alias_method_chain   :read_attribute_before_type_cast, :columns_on_demand
-      if ActiveRecord::AttributeMethods::Read.instance_methods.include?(:_read_attribute)
-        alias_method_chain :_read_attribute,                 :columns_on_demand
-      end
-      alias_method_chain   :missing_attribute,               :columns_on_demand
-      alias_method_chain   :reload,                          :columns_on_demand
-      if ActiveRecord::AttributeMethods::Dirty.instance_methods.include?(:attribute_changed_in_place?)
-        alias_method_chain :attribute_changed_in_place?,     :columns_on_demand
-      elsif ActiveRecord::AttributeMethods::Dirty.instance_methods.include?(:changed_attributes)
-        alias_method_chain :changed_in_place?,               :columns_on_demand
+        alias reset_column_information_without_columns_on_demand reset_column_information
+        alias reset_column_information reset_column_information_with_columns_on_demand
       end
     end
     
@@ -36,12 +17,6 @@ module ColumnsOnDemand
       @columns_to_select = nil
       reset_column_information_without_columns_on_demand
     end
-    
-    def define_read_method_for_serialized_attribute_with_columns_on_demand(attr_name)
-      define_read_method_for_serialized_attribute_without_columns_on_demand(attr_name)
-      scope = method_defined?(:generated_attribute_methods) ? generated_attribute_methods : self
-      scope.module_eval("def #{attr_name}_with_columns_on_demand; ensure_loaded('#{attr_name}'); #{attr_name}_without_columns_on_demand; end; alias_method_chain :#{attr_name}, :columns_on_demand", __FILE__, __LINE__)      
-    end
 
     def blob_and_text_columns
       columns.inject([]) do |blob_and_text_columns, column|
@@ -72,13 +47,13 @@ module ColumnsOnDemand
       !columns_to_load_on_demand.include?(attr_name) || @attributes.key?(attr_name) || new_record? || columns_loaded.include?(attr_name)
     end
 
-    def attributes_with_columns_on_demand
+    def attributes
       load_attributes(*columns_to_load_on_demand.reject {|attr_name| column_loaded?(attr_name)})
-      attributes_without_columns_on_demand
+      super
     end
 
-    def attribute_names_with_columns_on_demand
-      (attribute_names_without_columns_on_demand + columns_to_load_on_demand).uniq.sort
+    def attribute_names
+      (super + columns_to_load_on_demand).uniq.sort
     end
     
     def load_attributes(*attr_names)
@@ -87,42 +62,15 @@ module ColumnsOnDemand
       values = self.class.connection.select_rows(
         "SELECT #{attr_names.collect {|attr_name| self.class.connection.quote_column_name(attr_name)}.join(", ")}" +
         "  FROM #{self.class.quoted_table_name}" +
-        " WHERE #{self.class.connection.quote_column_name(self.class.primary_key)} = #{self.class.quote_value(id, self.class.columns_hash[self.class.primary_key])}")
+        " WHERE #{self.class.connection.quote_column_name(self.class.primary_key)} = #{self.class.connection.quote(id)}")
       row = values.first || raise(ActiveRecord::RecordNotFound, "Couldn't find #{self.class.name} with ID=#{id}")
 
       attr_names.each_with_index do |attr_name, i|
         columns_loaded << attr_name
         value = row[i]
 
-        if @attributes.respond_to?(:write_from_database)
-          # activerecord 4.2 or later, which make it easy to replicate the normal typecasting and deserialization logic
-          @attributes.write_from_database(attr_name, value)
-
-        elsif coder = self.class.serialized_attributes[attr_name]
-          # activerecord 4.1 or earlier, with a serialized column
-          # for some database adapters, @column_types_override gets populated with type data from query used to load the record originally.
-          # this is fine, but unfortunately some special-case "decorate_columns" code in ActiveRecord will wrap those types in serialization
-          # objects, and it does this for each column listed in @serialized_column_names *even if they are not present in the query results*.
-          # as a result it unfortunately overrides the normal @column_type with a @column_type_override with a nil @column, which explodes
-          # when it tries to run the typecast.  make it use the normal @column_type value, since we know that we've loading the regular column.
-          @column_types_override.delete(attr_name) if @column_types_override
-
-          if ActiveRecord.const_defined?(:AttributeMethods) &&
-             ActiveRecord::AttributeMethods::const_defined?(:Serialization) &&
-             ActiveRecord::AttributeMethods::Serialization::const_defined?(:Attribute)
-            # in 3.2 @attributes has a special Attribute struct to help cache both serialized and unserialized forms
-            @attributes[attr_name] = ActiveRecord::AttributeMethods::Serialization::Attribute.new(coder, value, :serialized)
-          elsif ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 1
-            # from 3.1 it has the deserialized form
-            @attributes[attr_name] = coder.load value
-          else
-            # in 2.3 an 3.0, @attributes has the serialized form
-            @attributes[attr_name] = value
-          end
-        else
-          # activerecord 4.1 or earlier, with a regular unserialized column
-          @attributes[attr_name] = value
-        end
+        # activerecord 4.2 or later, which make it easy to replicate the normal typecasting and deserialization logic
+        @attributes.write_from_database(attr_name, value)
       end
     end
 
@@ -130,39 +78,39 @@ module ColumnsOnDemand
       load_attributes(attr_name.to_s) unless column_loaded?(attr_name.to_s)
     end
 
-    def changed_in_place_with_columns_on_demand?(attr_name)
-      column_loaded?(attr_name) && changed_in_place_without_columns_on_demand?(attr_name)
+    def changed_in_place?(attr_name)
+      column_loaded?(attr_name) && super(attr_name)
     end
 
-    def attribute_changed_in_place_with_columns_on_demand?(attr_name)
-      column_loaded?(attr_name) && attribute_changed_in_place_without_columns_on_demand?(attr_name)
+    def attribute_changed_in_place?(attr_name)
+      column_loaded?(attr_name) && super(attr_name)
     end
 
-    def read_attribute_with_columns_on_demand(attr_name, &block)
+    def read_attribute(attr_name, &block)
       ensure_loaded(attr_name)
-      read_attribute_without_columns_on_demand(attr_name, &block)
+      super(attr_name, &block)
     end
 
-    def read_attribute_before_type_cast_with_columns_on_demand(attr_name)
+    def read_attribute_before_type_cast(attr_name)
       ensure_loaded(attr_name)
-      read_attribute_before_type_cast_without_columns_on_demand(attr_name)
+      super(attr_name)
     end
 
-    def _read_attribute_with_columns_on_demand(attr_name, &block)
+    def _read_attribute(attr_name, &block)
       ensure_loaded(attr_name)
-      _read_attribute_without_columns_on_demand(attr_name, &block)
+      super(attr_name, &block)
     end
 
-    def missing_attribute_with_columns_on_demand(attr_name, *args)
+    def missing_attribute(attr_name, *args)
       if columns_to_load_on_demand.include?(attr_name)
         load_attributes(attr_name)
       else
-        missing_attribute_without_columns_on_demand(attr_name, *args)
+        super(attr_name, *args)
       end
     end
 
-    def reload_with_columns_on_demand(*args)
-      reload_without_columns_on_demand(*args).tap do
+    def reload(*args)
+      super(*args).tap do
         columns_loaded.clear
         columns_to_load_on_demand.each do |attr_name|
           if @attributes.respond_to?(:reset)
@@ -177,37 +125,16 @@ module ColumnsOnDemand
     end
   end
 
-  module RelationMethodsArity2
-    def build_select_with_columns_on_demand(arel, selects)
-      if (selects.empty? || selects == [table[Arel.star]] || selects == ['*']) && klass < ColumnsOnDemand::InstanceMethods
-        build_select_without_columns_on_demand(arel, [default_select(true)])
-      else
-        build_select_without_columns_on_demand(arel, selects)
-      end
-    end
-  end
-
-  module RelationMethodsArity1
-    def build_select_with_columns_on_demand(arel)
+  module RelationMethods
+    def build_select(arel)
       if (select_values.empty? || select_values == [table[Arel.star]] || select_values == ['*']) && klass < ColumnsOnDemand::InstanceMethods
         arel.project(*arel_columns([default_select(true)]))
       else
-        build_select_without_columns_on_demand(arel)        
+        super(arel)
       end
     end
   end
 end
 
 ActiveRecord::Base.send(:extend, ColumnsOnDemand::BaseMethods)
-
-if ActiveRecord.const_defined?(:Relation)
-  if ActiveRecord::Relation.instance_method(:build_select).arity == 1
-    # 4.2.1 and above
-    ActiveRecord::Relation.send(:include, ColumnsOnDemand::RelationMethodsArity1)
-  else
-    # 4.2.0 and below
-    ActiveRecord::Relation.send(:include, ColumnsOnDemand::RelationMethodsArity2)
-  end
-
-  ActiveRecord::Relation.alias_method_chain :build_select, :columns_on_demand
-end
+ActiveRecord::Relation.send(:prepend, ColumnsOnDemand::RelationMethods)

data/lib/columns_on_demand/version.rb

@@ -1,3 +1,3 @@
 module ColumnsOnDemand
-  VERSION = '4.3.0'
+  VERSION = '5.1.0'
 end

data/test/columns_on_demand_test.rb

@@ -43,7 +43,11 @@ class ColumnsOnDemandTest < ActiveSupport::TestCase
   end
 
   fixtures :all
-  self.use_transactional_fixtures = true
+  if respond_to?(:use_transactional_tests=)
+    self.use_transactional_tests = true
+  else
+    self.use_transactional_fixtures = true
+  end
   
   test "it lists explicitly given columns for loading on demand" do
     assert_equal ["file_data", "processing_log", "original_filename"], Explicit.columns_to_load_on_demand
@@ -54,11 +58,11 @@ class ColumnsOnDemandTest < ActiveSupport::TestCase
   end
   
   test "it selects all the other columns for loading eagerly" do
-    assert_match /\W*id\W*, \W*results\W*, \W*processed_at\W*/, Explicit.default_select(false)
-    assert_match /\W*explicits\W*.results/, Explicit.default_select(true)
+    assert_match(/\W*id\W*, \W*results\W*, \W*processed_at\W*/, Explicit.default_select(false))
+    assert_match(/\W*explicits\W*.results/, Explicit.default_select(true))
     
-    assert_match /\W*id\W*, \W*original_filename\W*, \W*processed_at\W*/, Implicit.default_select(false)
-    assert_match /\W*implicits\W*.original_filename/, Implicit.default_select(true)
+    assert_match(/\W*id\W*, \W*original_filename\W*, \W*processed_at\W*/, Implicit.default_select(false))
+    assert_match(/\W*implicits\W*.original_filename/, Implicit.default_select(true))
   end
   
   test "it doesn't load the columns_to_load_on_demand straight away when finding the records" do
@@ -92,10 +96,10 @@ class ColumnsOnDemandTest < ActiveSupport::TestCase
 
     record = Implicit.first
     assert_not_loaded record, "file_data"
-    assert_equal nil, record.file_data
+    assert_nil record.file_data
     assert_loaded record, "file_data"
     assert_no_queries do
-      assert_equal nil, record.file_data
+      assert_nil record.file_data
     end
   end
   
@@ -156,6 +160,7 @@ class ColumnsOnDemandTest < ActiveSupport::TestCase
 
     assert_not_loaded record, "file_data"
     assert_equal "New file data", record.file_data
+    assert_not_equal old_object_id, record.file_data.object_id
   end
   
   test "it doesn't override custom select() finds" do
@@ -194,42 +199,7 @@ class ColumnsOnDemandTest < ActiveSupport::TestCase
     assert_equal "This is the file data!", record.file_data # check it doesn't raise
   end
   
-  test "it updates the select strings when columns are changed and the column information is reset" do
-    ActiveRecord::Schema.define(:version => 1) do
-      create_table :dummies, :force => true do |t|
-        t.string   :some_field
-        t.binary   :big_field
-      end
-    end
-
-    class Dummy < ActiveRecord::Base
-      columns_on_demand
-    end
-
-    assert_match /\W*id\W*, \W*some_field\W*/, Dummy.default_select(false)
-
-    ActiveRecord::Schema.define(:version => 2) do
-      create_table :dummies, :force => true do |t|
-        t.string   :some_field
-        t.binary   :big_field
-        t.string   :another_field
-      end
-    end
-
-    assert_match /\W*id\W*, \W*some_field\W*/, Dummy.default_select(false)
-    Dummy.reset_column_information
-    assert_match /\W*id\W*, \W*some_field\W*, \W*another_field\W*/, Dummy.default_select(false)
-  end
-  
   test "it handles STI models" do
-    ActiveRecord::Schema.define(:version => 1) do
-      create_table :stis, :force => true do |t|
-        t.string   :type
-        t.string   :some_field
-        t.binary   :big_field
-      end
-    end
-
     class Sti < ActiveRecord::Base
       columns_on_demand
     end
@@ -238,8 +208,8 @@ class ColumnsOnDemandTest < ActiveSupport::TestCase
       columns_on_demand :some_field
     end
 
-    assert_match /\W*id\W*, \W*type\W*, \W*some_field\W*/, Sti.default_select(false)
-    assert_match /\W*id\W*, \W*type\W*, \W*big_field\W*/,  StiChild.default_select(false)
+    assert_match(/\W*id\W*, \W*type\W*, \W*some_field\W*/, Sti.default_select(false))
+    assert_match(/\W*id\W*, \W*type\W*, \W*big_field\W*/,  StiChild.default_select(false))
   end
   
   test "it works on child records loaded from associations" do
@@ -322,3 +292,38 @@ class ColumnsOnDemandTest < ActiveSupport::TestCase
     assert_equal select_sql, reference_sql
   end
 end
+
+class ColumnsOnDemandSchemaTest < ActiveSupport::TestCase
+  if respond_to?(:use_transactional_tests=)
+    self.use_transactional_tests = false
+  else
+    self.use_transactional_fixtures = false
+  end
+
+  test "it updates the select strings when columns are changed and the column information is reset" do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :dummies, :force => true do |t|
+        t.string   :some_field
+        t.binary   :big_field
+      end
+    end
+
+    class Dummy < ActiveRecord::Base
+      columns_on_demand
+    end
+
+    assert_match(/\W*id\W*, \W*some_field\W*/, Dummy.default_select(false))
+
+    ActiveRecord::Schema.define(:version => 2) do
+      create_table :dummies, :force => true do |t|
+        t.string   :some_field
+        t.binary   :big_field
+        t.string   :another_field
+      end
+    end
+
+    assert_match(/\W*id\W*, \W*some_field\W*/, Dummy.default_select(false))
+    Dummy.reset_column_information
+    assert_match(/\W*id\W*, \W*some_field\W*, \W*another_field\W*/, Dummy.default_select(false))
+  end
+end

data/test/schema.rb

@@ -27,4 +27,10 @@ ActiveRecord::Schema.define(:version => 0) do
   create_table :serializings, :force => true do |t|
     t.binary   :data
   end
+
+  create_table :stis, :force => true do |t|
+    t.string   :type
+    t.string   :some_field
+    t.binary   :big_field
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: columns_on_demand
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Will Bryant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Lazily loads large columns on demand.
 
@@ -158,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Lazily loads large columns on demand.