Rails Ruby on Rails → 3.x

Comments and changes to this ticket

• You flagged this item as spam.
  

  iain December 8th, 2010 @ 08:37 PM

  • Tag changed from “json to_json encode struct” to “as_json, encode_json, json, to_json”

  +1

  It's not really a problem with Structs, but with classes included in native structures.

  A test case:

  class Sub
    def as_json(*)
      { :foo => "bar" }
    end
  end
  
  class Base
    def as_json(*)
      [ Sub.new ]
    end
  end
  
  puts Base.new.to_json
  

  Resulting in the error reported:

  [GEM_HOME]/activesupport-3.0.3/lib/active_support/json/encoding.rb:214:in `encode_json': undefined method `encode_json' for #<Sub:0x102a02a78> (NoMethodError)
    from [GEM_HOME]/activesupport-3.0.3/lib/active_support/json/encoding.rb:214:in `map'
    from [GEM_HOME]/activesupport-3.0.3/lib/active_support/json/encoding.rb:214:in `encode_json'
    from [GEM_HOME]/activesupport-3.0.3/lib/active_support/json/encoding.rb:47:in `encode'
    from [GEM_HOME]/activesupport-3.0.3/lib/active_support/json/encoding.rb:77:in `check_for_circular_references'
    from [GEM_HOME]/activesupport-3.0.3/lib/active_support/json/encoding.rb:45:in `encode'
    from [GEM_HOME]/activesupport-3.0.3/lib/active_support/json/encoding.rb:30:in `encode'
    from [GEM_HOME]/activesupport-3.0.3/lib/active_support/core_ext/object/to_json.rb:15:in `to_json'
    from json_test.rb:15
  

• You flagged this item as spam.
  

  iain December 8th, 2010 @ 08:42 PM

  BTW: this issue was introduced in Rails 3.0.2, the above code works fine in Rails 3.0.1

• You flagged this item as spam.
  

  Mark A. Richman December 8th, 2010 @ 09:00 PM

  Thanks Iain! How do we get this fixed in 3.0.4?

• You flagged this item as spam.
  

  Mark A. Richman December 8th, 2010 @ 09:02 PM

  Would you mind pasting your json_test.rb so I can see what you did?

• You flagged this item as spam.
  

  iain December 8th, 2010 @ 09:33 PM

  json_test.rb is the code I showed (minus a "require 'config/environment'" line to load my Rails app).
  To fix it, we need to dig in activesupport/lib/active_support/json/encoding.rb and see what has been changed.

• You flagged this item as spam.
  

  John Firebaugh December 9th, 2010 @ 12:58 AM

  A custom #as_json definition should usually call Array#as_json or Hash#as_json itself. For example, the correct definition in the example above is:

  class Base
    def as_json(*args)
      [ Sub.new ].as_json(*args)
    end
  end
  

  Object#as_json has a similar bug, which is causing Mark's exception. It should call #as_json on the result of #to_hash or #instance_values:

  class Object
    def as_json(options = nil) #:nodoc:
      if respond_to?(:to_hash)
        to_hash
      else
        instance_values
      end.as_json(options)
    end
  end
  

• You flagged this item as spam.
  

  bgallet December 11th, 2010 @ 09:54 PM

  I cannot reproduce this, however, it is not behaving as expected.

  Struct.new("StructTest", :name, :address)
  puts Struct::StructTest.new("Dave", "value").to_json # => ["Dave","121 Main st."]
  

  I would have expected: { "name": "Dave", "address": "121 Main st." }

• You flagged this item as spam.
  

  jasereja January 11th, 2011 @ 01:49 PM

  I have same problem.
  Use mongoid and try respond_to :json

  In rails 3.0.1 it work nice. higher versions broken.

• You flagged this item as spam.
  

  Alexey Nayden January 13th, 2011 @ 12:18 AM

  Failing test

  • complex_struct_json_encoding_test.diff 1.6 KB

• You flagged this item as spam.
  

  Alexey Nayden January 13th, 2011 @ 12:22 AM

  A patch to fix complex structures #as_json and #to_json

  • complex_struct_json_encoding.diff 2.5 KB

• You flagged this item as spam.
  

  Alexey Nayden January 13th, 2011 @ 12:35 AM

  • Assigned user set to “Jeremy Kemper”
  • Tag changed from “as_json, encode_json, json, to_json” to “as_json, encode_json, json, patch, to_json”
• 

  Neeraj Singh January 13th, 2011 @ 02:46 AM

  • Milestone set to “3.x”
  • State changed from “new” to “open”
  • Importance changed from “” to “Low”

  Here is a patch with test.

  https://github.com/neerajdotname/rails/commit/e9931f1df28eb97c53a92...

• 

  Neeraj Singh January 13th, 2011 @ 02:01 PM

  sorry I did not see there was already a patch for it. Ignore me.

• You flagged this item as spam.
  

  Alexey Nayden January 13th, 2011 @ 08:47 PM

  @Neeraj no problem. So are you going to apply my patch? Or maybe I shall reassign the ticket to someone else?

• 

  Neeraj Singh January 13th, 2011 @ 10:57 PM

  I can't apply your patch. Only core team can do that. I can +1 this ticket.

  +1

• You flagged this item as spam.
  

  Alexey Nayden January 13th, 2011 @ 11:21 PM

  • Assigned user changed from “Jeremy Kemper” to “Santiago Pastorino”

• You flagged this item as spam.
  

  Alexey Nayden January 13th, 2011 @ 11:23 PM

  Santiago, would you please apply my patch? It seems to be useful bugfix.

• 

  Repository January 15th, 2011 @ 02:07 AM

  • State changed from “open” to “committed”

  (from [a9163b547c7cfd4861c814371fa9d1a6bdb31231]) Complex struct encoding fix

  [#6077 state:committed]

  Signed-off-by: Santiago Pastorino santiago@wyeworks.com
  https://github.com/rails/rails/commit/a9163b547c7cfd4861c814371fa9d...

• You flagged this item as spam.
  

  Bryce Kerley January 17th, 2011 @ 04:24 AM

  I'm getting a test failure on this in 1.9.2-p136, due to hash ordering:

  test_struct_encoding(TestJSONEncoding) [test/json/encoding_test.rb:239]:
  <"{\"sub\":{\"name\":\"David\",\"date\":\"2010/01/01\"},\"name\":\"David\"}"> expected but was
  <"{\"name\":\"David\",\"sub\":{\"name\":\"David\",\"date\":\"2010/01/01\"}}">.
  

  Should the expected struct ordering be canonical? If not, I've patched the expected ordering in the test at https://github.com/bkerley/rails/commit/b9d05c3fff974e59b4e06da68d9... .

• You flagged this item as spam.
  

  Mike (at coverallcrew) February 11th, 2011 @ 08:28 PM

  This is still failing for me with Rails 3.0.4

  To replicate, try using Mongoid or MongoMapper with anything higher than Rails 3.0.1

• 

  Santiago Pastorino February 11th, 2011 @ 10:24 PM

  Have you tried this against master?
  I guess we haven't backported to 3-0-stable?