Object Mentor Blog: Liskov Substitution Principle and the Ruby Core Libraries

Liskov Substitution Principle and the Ruby Core Libraries

Dean Wampler — Sat, 17 Feb 2007 14:20:00 -0600

There is a spirited discussion happening now on the ruby-talk list called >Oppinions on RCR for dup on immutable classes (sic).

In the core Ruby classes, the Kernel module, which is the root of everything, even Object, defines a method called dup, for duplicating objects. (There is also a clone method with slightly different behavior that I won’t discuss here.)

The problem is that some derived core classes throw an exception when dup is called.

Specifically, as the ruby-talk discussion title says, it’s the immutable classes (NilClass, FalseClass, TrueClass, Fixnum, and Symbol) that do this. Consider, for example, the following irb session:

irb 1:0> 5.respond_to? :dup
=> true
irb 2:0> 5.dup
TypeError: can't dup Fixnum
        from (irb):1:in `dup'
        from (irb):1
irb 3:0>

If you don’t know Ruby, the first line asks the Fixnum object 5 if it responds to the method dup (with the name expressed as a symbol, hence the). The answer is true, becuase this method is defined by the module Kernel, which is included by the top-level class Object, an ancestor of Fixnum.

However, when you actually call dup on 5, it raises TypeError, as shown.

So, this looks like a classic Liskov Substitution Principle violation. The term for this code smell is Refused Bequest (e.g., see here) and it’s typically fixed with the refactoring Replace Inheritance with Delegation.

The email thread is about a proposal to change the library in one of several possible ways. One possibility is to remove dup from the immutable classes. This would eliminate the unexpected behavior in the example above, since 5.respond_to?(:dup) would return false, but it would still be an LSP violation, specifically it would still have the Refused Bequest smell.

One scenario where the current behavior causes problems is doing a deep copy of an arbitrary object graph. For immutable objects, you would normally just want dup to return the same object. It’s immutable, right? Well, not exactly, since you can re-open classes and even objects to add and remove methods in Ruby (there are some limitations for the immutables…). So, if you thought you actually duplicated something and started messing with its methods, you would be surprised to find the original was “also” modified.

So, how serious is this LSP issue (one of several)? When I pointed out the problem in the discussion, one respondent, Robert Dober, said the following (edited slightly):

I would say that LSP does not apply here simply because in Ruby we do not have that kind of contract. In order to apply LSP we need to say at a point we have an object of class Base, for example. (let the gods forgive me that I use Java)

void aMethod(final Base b){
   ....
}

and we expect this to work whenever we call aMethod with an object that is a Base. Anyway the compiler would not really allow otherwise.

SubClass sc;  // subclassing Base od course
aMethod( sc ); // this is expected to work (from the type POV).

Such things just do not exist in Ruby, I believe that Ruby has explained something to me:

OO Languages are Class oriented languages

Dynamic Languages are Object oriented languages.

Replace Class with Type and you see what I mean.

This is all very much IMHO of course but I feel that the Ruby community has made me evolve a lot away from “Class oriented”.

He’s wrong that the compiler protects you in Java; you can still throw exceptions, etc. The JDK Collection classes have Refused Bequests. Besides that, however, he makes some interesting points.

As a long-time Java programmer, I’m instinctively uncomfortable with LSP violations. Yet, the Ruby API is very nice to work with, so maybe a little LSP violation isn’t so bad?

As Robert says, we approach our designs differently in dynamic vs. static languages. In Ruby, you almost never use the is_a? and kind_of? methods to check for type. Instead, you follow the duck typing philosophy (“If it acts like a duck, it must be a duck”); you rely on respond_to? to decide if an object does what you want.

In the case of dup for the immutable classes, I would prefer that they not implement the method, rather than throw an exception. However, that would still violate LSP.

So, can we still satisfy LSP and also have rich base classes and modules?

There are many examples of traits that one object might or should support, but not another. (Those of you Java programmers might ask yourself why all objects support toString, for example. Why not also toXML...?)

Coming from an AOP background, I would rather see an architecture where dup is added only to those classes and modules that can support it. It shouldn’t be part of the standard “signature” of Kernel, but it should be present when code actually needs it.

In fact, Ruby makes this sort of AOP easy to implement. Maybe Kernel, Module, and Object should be refactored into smaller pieces and programmers should declaratively mixin the traits they need. Imagine something like the following:

irb 1:0> my_obj.respond_to? :dup
=> false
irb 2:0> include 'DupableTrait'  
irb 2:0> my_obj.respond_to? :dup
=> true
irb 4:0> def dup_if_possible items
irb 5:1>  items.map {|item| item.respond_to?(:dup) ? item.dup : item}
irb 6:1> end
...

In other words, Kernel no longer “exposes the dup abstraction”, by default, but the DupableTrait module “magically” adds dup to all the classes that can support it. This way, we preserve LSP, streamline the core classes and modules (SRP and ISP anyone?), yet we have the flexibility we need, on demand.

"Liskov Substitution Principle and the Ruby Core Libraries" by grad school personal statement

Mon, 19 Dec 2011 00:30:28 -0600

I am absolutely amazed at how terrific the stuff is on this site. I have saved this webpage and I truly intend on visiting the site in the upcoming days. Keep up the excellent work!

"Liskov Substitution Principle and the Ruby Core Libraries" by bhutan travel guide

Sun, 27 Nov 2011 10:02:07 -0600

I was really impressed. This is really interesting topic. Thank you very much!

"Liskov Substitution Principle and the Ruby Core Libraries" by exit and emergency lights

Sun, 27 Nov 2011 10:00:40 -0600

I just like to give a huge thumbs up for the great info you have here on this post. I will be coming back to your blog for more soon.

"Liskov Substitution Principle and the Ruby Core Libraries" by air-con repair

Sun, 27 Nov 2011 09:58:43 -0600

An interesting discussion is worth comment.glad i came across your post, very informative indeed.

"Liskov Substitution Principle and the Ruby Core Libraries" by tv guide

Sun, 27 Nov 2011 04:31:25 -0600

thanks for the great stuff you have written!

"Liskov Substitution Principle and the Ruby Core Libraries" by Moncler Piumini

Mon, 21 Nov 2011 20:33:12 -0600

Ma assicuratevi di carburante la vostra moto sport touring sulla strada, le fermate benzina deve essere pianificato con cura Moncler Piumini su questa strada . Per fortuna che l’inverno è stato un mite. Vegetali ChilliesThis caldo vi aiuterà a rendere la tua vita sessuale. Questo tipo di abbigliamento è disponibile per persone di diverse fasce d’età e sono disponibili in varie taglie, colori e materiali. Ma se lo fai poi scegliere 2011 Moncler Vendita in vendita una porzione più piccola, condividere con un amico o portare a casa con voi per più tardi. 18. Ecco alcuni consigli per aiutarvi a Moncler Giubbotto quella giacca moto della durata di anni. Sono inoltre dotate di polsini regolabili con soffietto e per stanza in più, hanno anche funzione di gomiti articolati.

"Liskov Substitution Principle and the Ruby Core Libraries" by travel deals

Wed, 09 Nov 2011 01:01:51 -0600

Wow, this was a really quality post. In theory I’d like to write like this too – taking time and real effort to make a good article

"Liskov Substitution Principle and the Ruby Core Libraries" by travel deals

Wed, 09 Nov 2011 00:59:45 -0600

Wow, this was a really quality post. In theory I’d like to write like this too – taking time and real effort to make a good article

"Liskov Substitution Principle and the Ruby Core Libraries" by storage Singapore

Wed, 09 Nov 2011 00:55:48 -0600

I confess, I have not visited this website in a long time because of my blog , nonetheless it was another delight to see such a significant subject on long distance running and I thank you for making people more attentive on possible issues.

"Liskov Substitution Principle and the Ruby Core Libraries" by christian louboutin

Thu, 03 Nov 2011 12:00:21 -0500

good post, i think so.Thank you!

"Liskov Substitution Principle and the Ruby Core Libraries" by canada goose jakke

Sun, 30 Oct 2011 21:02:38 -0500

Som topmødet canada goose jakke vært, har hundreder canada goose af millioner værd at Berlusconi forberedt canada goose outlet en gave til ledere: værdien af GBP 500 belstaff outlet limited edition fashion frakke.Denne mørke belstaff blå frakke siges at være “Præsidentens frakke”, udskrives canada goose jakke over Italien flag, udført Canada Goose Banff Parka af fashion brands beidafu og hr. Berlusconis samarbejde, alt ovenstående er gamle Bay autograph Canada Goose Expedition Parka drenge.Hvad angår størrelse, og gav en af lederne af alle lande er fremstillet af deres fotos og Canada Goose Expedition Parka Kvinders videoer af højden af organ oplysninger skræddersyet til.Beidafu mærke bliver Canada Goose Expedition Parka M?nd darling af fashion verden i de seneste år, mange store stjerner har passeret af mærke Canada Goose Kvinder Vest tøj, såsom USA stjernerne Brad Pitt og George Clooney, og Storbritannien har ikke iført fodbold stjerne Canada Goose Montebello Parka David Beckham.

"Liskov Substitution Principle and the Ruby Core Libraries" by flac converter

Thu, 27 Oct 2011 03:21:43 -0500

good post, i think so.Thank you!

"Liskov Substitution Principle and the Ruby Core Libraries" by Stivali Ugg Paisley

Tue, 18 Oct 2011 22:33:17 -0500

Stivali Ugg Paisley , Dal, professionisti nativo di solito non sono pronte a prendere il nuove opportunità in Libia di conseguenza stanno migrando in massa verso altri paesi, la probabilità di una carriera per i cittadini internazionali è sicuramente ancora più significant.Such grande afflusso di stranieri è dotato di funzionari richiesto di produrre una legge a seconda del trenta per cento di ogni lavoratori impiegati dalle organizzazioni importati devono rimanere nationals.Nevertheless libico, commercianti e altre ditte non si dovrebbe mai sono più spesso felici usando la decisione come si suol dire, è quasi impossibile trovare quella percentuale di workforce.Ultimately libico, il vostro obiettivo conti

"Liskov Substitution Principle and the Ruby Core Libraries" by Ashley Bowling

Sun, 16 Oct 2011 05:35:48 -0500

Expense—where employee business-related expenses are entered

"Liskov Substitution Principle and the Ruby Core Libraries" by juicy couture tracksuits

Tue, 27 Sep 2011 20:31:50 -0500

from many days i badly required these info . thanks for it ….. from here i got what i want

"Liskov Substitution Principle and the Ruby Core Libraries" by DR OZ african Mango

Tue, 27 Sep 2011 11:50:48 -0500

When I at first left a comment I clicked the “Notify me when new comments are added” checkbox and now each time a comment is added I get three notification emails with the same comment. Is there any way you can take away people from that service? Thanks a lot!

"Liskov Substitution Principle and the Ruby Core Libraries" by louboutin

Fri, 16 Sep 2011 22:32:06 -0500

At some time extensive most effective low-priced MBT Kafala Boots and shoes discounted design all these cycles boots and shoes, Jimmy Choo Pompesyou may the radical the answers.Jimmy Choo Sandales Quite a few job opportunities have to have you actually often be humiliated with you, fully to the specific shape, ankles,

North Face Apex Bionic Kvinder Jakker

plus thighs and leg,

the north face

plus improved during losing fat laden calories might move barefoot in the inclusion. In that case keep account.

December 2012 will be to can comecanada goose jakke, lots of believers live 2012 is just about the most important issue with discourse. mbt internet profit internationally renowned students will be guessing devastating incidents which is nearly anything. Let’ vertisements evaluate ways to live 2012canada goose , principally around the best way far better create you actually for any predictable.

"Liskov Substitution Principle and the Ruby Core Libraries" by Web Designing

Mon, 12 Sep 2011 06:15:50 -0500

Lots of knowledge I got from your blog thanks.

"Liskov Substitution Principle and the Ruby Core Libraries" by dvd ripper

Sun, 11 Sep 2011 07:21:38 -0500

Thank you for sharing, I’ll definitely dig deeper into it

"Liskov Substitution Principle and the Ruby Core Libraries" by Jewellery XY

Wed, 07 Sep 2011 05:08:51 -0500

Great article , very informative. For a guide to gemstones check out our site

"Liskov Substitution Principle and the Ruby Core Libraries" by beats by dre store

Tue, 23 Aug 2011 03:20:16 -0500

school to see her, afraid of boring so far way to buy the basketball magazine, all the way to see the ecstatichigh quality headphones new design headphones

"Liskov Substitution Principle and the Ruby Core Libraries" by swimsuit coverups

Sun, 14 Aug 2011 16:34:02 -0500

Experts often possess more data than judgment.

"Liskov Substitution Principle and the Ruby Core Libraries" by audio converter

Tue, 02 Aug 2011 21:21:17 -0500

Good Information Very nice post.

"Liskov Substitution Principle and the Ruby Core Libraries" by Community Service Online

Thu, 30 Jun 2011 15:44:33 -0500

I am learning Ruby. I’ve got a clear idea about Fixnum object 5 from your blog. It’s really helpful.

"Liskov Substitution Principle and the Ruby Core Libraries" by firepit

Sun, 19 Jun 2011 18:38:17 -0500

You can enjoy more your family time with a fire pit in your patio, enjoy your cold nights, too.