From: "mame (Yusuke Endoh)" <mame@...>
Date: 2012-04-02T21:25:35+09:00
Subject: [ruby-core:44066] [ruby-trunk - Bug #4453] Overriding #to_s changes #inspect


Issue #4453 has been updated by mame (Yusuke Endoh).

Assignee changed from matz (Yukihiro Matsumoto) to mame (Yusuke Endoh)

A feature ticket #6130 duplicates this ticket.
And matz accepted #6130.  So this will be "fixed" in 2.0

To prevent a discussion log from being scattered, please
don't reply to this ticket any more.

-- 
Yusuke Endoh <mame@tsg.ne.jp>
----------------------------------------
Bug #4453: Overriding #to_s changes #inspect
https://bugs.ruby-lang.org/issues/4453#change-25596

Author: yimutang (Joey Zhou)
Status: Assigned
Priority: Normal
Assignee: mame (Yusuke Endoh)
Category: 
Target version: 
ruby -v: ruby 1.9.2p180 (2011-02-18) [i386-mingw32]


# My Ruby is: ruby 1.9.2p180 (2011-02-18) [i386-mingw32]

# sample codes 1:
class Foo # subclass of Object, inherits #inspect and #to_s
  def initialize(bar,baz)
    @bar, @baz = bar, baz
  end
end

obj = Foo.new(:cat, :dog)

puts "\n== #inspect ====="
p obj                 #<Foo:0xb44398 @bar=:cat, @baz=:dog>
puts obj.inspect      #<Foo:0xb44398 @bar=:cat, @baz=:dog>
printf "%p", obj      #<Foo:0xb44398 @bar=:cat, @baz=:dog>

puts "\n== #to_s ========"
puts obj.to_s         #<Foo:0xb44398>
printf "%s", obj      #<Foo:0xb44398>

# Yes, #inspect and #to_s are not synonyms, they return different strings.

# sample codes 2, add 'def to_s':
class Foo
  def initialize(bar,baz)
    @bar, @baz = bar, baz
  end
  def to_s # override #to_s method
    "has @bar = #{@bar}, @baz = #{@baz}."
  end
end

obj = Foo.new(:cat, :dog)

puts "\n== #inspect ====="
p obj                 # has @bar = cat, @baz = dog.
puts obj.inspect      # has @bar = cat, @baz = dog.
printf "%p", obj      # has @bar = cat, @baz = dog.

puts "\n== #to_s ========"
puts obj.to_s         # has @bar = cat, @baz = dog.
printf "%s", obj      # has @bar = cat, @baz = dog.

# However, overriding #to_s makes #inspect do the identical thing. I don't think it's perfect.

# In fact, the problem was reported in 2009. http://redmine.ruby-lang.org/issues/1786
# At the bottom of the page, Matz said:
# "Redefining #to_s should not affect inspect, if they are totally different."
# I agree with Matz. #to_s and #inspcet should not be synonyms:
# #to_s maybe for the user of the application, they want a readable message;
# but #inspect maybe for the programmer, they want a debug information.

# So, if this is a bug, maybe it should be fixed. If it's a feature in 1.9.2, I think it's not a good one,
# because I lose a quick and convenient debug method to know an object's class the its instance variables.
# I may want to show something readable to user of my app, as well as something usable for myself.
# The feature (or bug) doesn't satisfy both.



-- 
http://bugs.ruby-lang.org/