flex_columns 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acb66f010a776e668841ca7f12dc0854cad5b4c9
-  data.tar.gz: 91492dda4eab46d062ae8958c62c5e31da33a339
+  metadata.gz: 2875989d866789ac577e31552738fa6466139eb0
+  data.tar.gz: 0976a94f461db06c5157dce3e0831ff5ce07c1c7
 SHA512:
-  metadata.gz: 4469119cb126a4e5767910b6ce4df02037afa3003d735be05baf0a0158ee45c3871b5c29292181c09823ac416184cb2e692f8ad31c9dfd66cea0187d65b5e3d6
-  data.tar.gz: 6614f83b721f635efa9e80f4f194237436890e66f35a662af0ed100d4d5bc4e90436abe859e89332ecc5f913134903e041bb66332a7d424560e64a5187bf0908
+  metadata.gz: c6605b81107eacb261547aaa2f0f1ebd5110f65b09ff7166c2f15cb104019e2fc696db59dfc72f4e796359b81ed3dca6f62baff7d857d3cfe35535e5fda1b105
+  data.tar.gz: 61c57838d0b1b06a19775e8f00f70edbdecf56d6fc8a4185d5ebed273a40c1cbd91e324e7c797c55fb92b4fa1449dfd2efaf7076a3a3133cee7bc5ea4941830f

data/lib/flex_columns/contents/flex_column_contents_base.rb

@@ -71,6 +71,24 @@ module FlexColumns
         end
       end
 
+      # See the comment above FlexColumns::HasFlexColumns#read_attribute_for_serialization -- this is responsible for
+      # correctly turning a flex-column object into a hash for serializing *the entire enclosing ActiveRecord model*.
+      #
+      # Most importantly, this method has NOTHING to do with our internal 'serialize a column as JSON' mechanisms. It
+      # is ONLY called if you try to serialize the enclosing ActiveRecord instance.
+      def to_hash_for_serialization
+        @column_data.to_hash
+      end
+
+      # Make sure this flex-column object itself is smart enough to turn itself into JSON correctly.
+      #
+      # Most importantly, this method has NOTHING to do with our internal 'serialize a column as JSON' mechanisms. It
+      # is ONLY called if you try to serialize something that in turn points directly to (i.e., not via the enclosing
+      # ActiveRecord object) this flex-column object.
+      def as_json(options = { })
+        to_hash_for_serialization
+      end
+
       # Returns a Hash, appropriate for integration into the payload of an ActiveSupport::Notification call, that
       # describes the model instance we're created from (or raw String, if that's the case). This is used by the
       # calls made to ActiveSupport::Notifications when a flex-column object is serialized or deserialized, and is used

data/lib/flex_columns/has_flex_columns.rb

@@ -66,10 +66,47 @@ module FlexColumns
       out
     end
 
+    # When ActiveRecord serializes an entire ActiveRecord object (for example, if you call #to_json on it), it
+    # reads each column individually using this method -- which, in the default implementation, just calls #send.
+    # (Well, it's actually *aliased* to #send, but it has the same effect.)
+    #
+    # However, if you're serializing an ActiveRecord model that contains a flex column, you almost certainly just
+    # want that to behave as if the flex_column is a Hash, and serialize it that way. So we override it to do just
+    # that right here.
+    def read_attribute_for_serialization(attribute_name)
+      if self.class._has_flex_column_named?(attribute_name)
+        _flex_column_object_for(attribute_name).to_hash_for_serialization
+      else
+        super(attribute_name)
+      end
+    end
+
+    # See above. We're actually overriding *both* methods, because #read_attribute_for_serialization doesn't exist
+    # in ActiveRecord 3.0.x.
+    def as_json(options = { })
+      flex_column_names = self.class._all_flex_column_names
+      out = super(:except => flex_column_names)
+
+      flex_columns_hash = { }
+      flex_column_names.each do |column_name|
+        hash = _flex_column_object_for(column_name).to_hash_for_serialization
+        flex_columns_hash[column_name] = hash unless hash.empty?
+      end
+
+      if include_root_in_json && out.keys.length == 1
+        out[out.keys.first].merge!(flex_columns_hash)
+      else
+        out.merge!(flex_columns_hash)
+      end
+
+      out
+    end
+
     # When you reload a model object, we should reload its flex-column objects, too.
     def reload(*args)
-      super(*args)
+      out = super(*args)
       @_flex_column_objects = { }
+      out
     end
 
     # This little-know ActiveRecord method gets called to produce a string for #inspect for a particular attribute.
@@ -114,6 +151,11 @@ module FlexColumns
         _flex_column_classes.map(&:column_name)
       end
 
+      # Does this model have a flex column with the given name?
+      def _has_flex_column_named?(column_name)
+        _all_flex_column_names.include?(_flex_column_normalize_name(column_name))
+      end
+
       # Normalizes the name of a flex column, so we're consistent when using it for things like hash keys, no matter
       # how the client specifies it to us.
       def _flex_column_normalize_name(flex_column_name)

data/lib/flex_columns/version.rb

@@ -1,4 +1,4 @@
 module FlexColumns
   # The current version of FlexColumns.
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/flex_columns/system/basic_system_spec.rb

@@ -250,6 +250,57 @@ describe "FlexColumns basic operations" do
       output['foo'].should == 47.2
     end
 
+    it "should allow you to call #reload, and return that same record" do
+      user = ::User.new
+      user.name = 'User 1'
+      user.wants_email = [ 1, 2, 3 ]
+      user.save!
+
+      user.name = 'User 2'
+      user.wants_email = 'bonko'
+
+      new_user = user.reload
+      new_user.name.should == 'User 1'
+      new_user.wants_email.should == [ 1, 2, 3 ]
+      new_user.id.should == user.id
+
+      user.name.should == 'User 1'
+      user.wants_email.should == [ 1, 2, 3 ]
+
+      new_user.should be(user)
+    end
+
+    # JSON.dump() simply doesn't work at all with ActiveRecord objects in earlier ActiveRecord versions; see:
+    # http://stackoverflow.com/questions/8406924/json-dump-on-any-activerecord-object-fails
+    if ActiveRecord::VERSION::MAJOR >= 4 ||
+      (ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR >= 1)
+      it "should let you turn an entire ActiveRecord object into JSON properly, treating a flex column as a Hash" do
+        user = ::User.new
+        user.id = 12345
+        user.name = 'User 1'
+        user.wants_email = [ 1, 2, 3 ]
+
+        $stderr.puts "ATTRIBUTES: #{user.attributes.keys.sort.inspect}"
+
+        user_json = JSON.dump(user)
+        parsed = JSON.parse(user_json)
+
+        # ActiveRecord::Base.include_root_in_json may default to different things in different versions of
+        # ActiveRecord; here, we accept JSON in either format.
+        base = parsed
+        base = parsed['user'] if base.keys == %w{user}
+
+        base.keys.sort.should == %w{id name user_attributes more_attributes}.sort
+        base['id'].should == 12345
+        base['name'].should == 'User 1'
+        h = base['user_attributes']
+        h.class.should == Hash
+        h.keys.sort.should == %w{wants_email}
+        h['wants_email'].should == [ 1, 2, 3 ]
+        [ nil, { } ].include?(base['more_attributes']).should be
+      end
+    end
+
     it "should remove keys entirely when they're set to nil, but not if they're set to false" do
       define_model_class(:User, 'flexcols_spec_users') do
         flex_column :user_attributes do

data/spec/flex_columns/unit/contents/flex_column_contents_base_spec.rb

@@ -173,6 +173,17 @@ describe FlexColumns::Contents::FlexColumnContentsBase do
       end
     end
 
+    describe "JSON serialization" do
+      it "should return ColumnData#to_hash_for_serialization for #to_hash_for_serialization and #as_json" do
+        expect_column_data_creation(@json_string)
+        @instance = @klass.new(@model_instance)
+
+        allow(@column_data).to receive(:to_hash).and_return({ :a => :b, :c => :d })
+        @instance.to_hash_for_serialization.should == { :a => :b, :c => :d }
+        @instance.as_json.should == { :a => :b, :c => :d }
+      end
+    end
+
     describe "#before_save!" do
       it "should do nothing if created with a raw string" do
         expect_column_data_creation(@json_string)

data/spec/flex_columns/unit/has_flex_columns_spec.rb

@@ -163,6 +163,57 @@ describe FlexColumns::HasFlexColumns do
       @klass.flex_column(:bar)
     end
 
+    describe "#read_attribute_for_serialization" do
+      it "should call through to the flex-column object for flex columns, and flex columns only" do
+        @superclass.class_eval do
+          def read_attribute_for_serialization(attribute_name)
+            "rafs_#{attribute_name}_rafs"
+          end
+        end
+
+        instance = @klass.new
+
+        fcc_foo_instance = double("fcc_foo_instance")
+        expect(@fcc_foo).to receive(:new).once.with(instance).and_return(fcc_foo_instance)
+        hash_for_serialization = double("hash_for_serialization")
+        expect(fcc_foo_instance).to receive(:to_hash_for_serialization).once.with().and_return(hash_for_serialization)
+
+        instance.read_attribute_for_serialization('foo').should be(hash_for_serialization)
+        instance.read_attribute_for_serialization('baz').should == "rafs_baz_rafs"
+      end
+    end
+
+    describe "#as_json" do
+      it "should call through to the flex-column object for flex columns, and flex columns only" do
+        @superclass.class_eval do
+          def as_json(options)
+            @superclass_as_json_options ||= [ ]
+            @superclass_as_json_options << options
+            { :z => 123, :bbb => 456}
+          end
+        end
+        instance = @klass.new
+
+        fcc_foo_instance = double("fcc_foo_instance")
+        expect(@fcc_foo).to receive(:new).once.with(instance).and_return(fcc_foo_instance)
+        expect(fcc_foo_instance).to receive(:to_hash_for_serialization).once.with().and_return({ :aaa => 111, :bbb => 222 })
+
+        fcc_bar_instance = double("fcc_bar_instance")
+        expect(@fcc_bar).to receive(:new).once.with(instance).and_return(fcc_bar_instance)
+        expect(fcc_bar_instance).to receive(:to_hash_for_serialization).once.with().and_return({ :aaa => 234, :ccc => 'xxx' })
+
+        allow(instance).to receive(:include_root_in_json).with().and_return(false)
+
+        instance.as_json.should == { :z => 123, :bbb => 456,
+          :foo => { :aaa => 111, :bbb => 222 },
+          :bar => { :aaa => 234, :ccc => 'xxx' }
+        }
+        instance.instance_variable_get("@superclass_as_json_options").should == [
+          { :except => [ :foo, :bar ] }
+        ]
+      end
+    end
+
     it "should return the same DynamicMethodsModule every time" do
       @klass._flex_column_dynamic_methods_module.should be(@dmm)
       @klass._flex_column_dynamic_methods_module.should be(@dmm)
@@ -282,11 +333,12 @@ describe FlexColumns::HasFlexColumns do
       instance._flex_column_object_for(' bAr ').should be(fcc_bar_instance)
     end
 
-    it "should re-create flex-column objects on reload, and call super" do
+    it "should re-create flex-column objects on reload, and call super and return its value" do
       @superclass.class_eval do
         def reload
           @reloads ||= 0
           @reloads += 1
+          :reload_return_yo
         end
 
         def reloads
@@ -308,7 +360,7 @@ describe FlexColumns::HasFlexColumns do
       instance._flex_column_object_for(:bar).should be(fcc_bar_instance)
 
       instance.reloads.should == 0
-      instance.reload
+      instance.reload.should == :reload_return_yo
       instance.reloads.should == 1
 
       fcc_foo_instance_2 = double("fcc_foo_instance_2")
@@ -324,6 +376,15 @@ describe FlexColumns::HasFlexColumns do
       @klass._all_flex_column_names.sort_by(&:to_s).should == [ :foo, :bar ].sort_by(&:to_s)
     end
 
+    it "should answer whether a flex-column name has been defined" do
+      @klass._has_flex_column_named?(:foo).should be
+      @klass._has_flex_column_named?('foo').should be
+      @klass._has_flex_column_named?(:bar).should be
+      @klass._has_flex_column_named?('bar').should be
+      @klass._has_flex_column_named?(:baz).should_not be
+      @klass._has_flex_column_named?('baz').should_not be
+    end
+
     it "should normalize column names properly" do
       @klass._flex_column_normalize_name(:baz).should == :baz
       @klass._flex_column_normalize_name(:' bAz ').should == :baz

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flex_columns
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Andrew Geweke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json