Patron Décorateur

Fait partie de la section Programmation orientée objet du Journey Ruby de Coddy. Leçon 47 sur 57.

Le modèle décorateur enveloppe un objet dans un autre objet doté de la même interface, qui ajoute quelque chose avant ou après avoir transmis l’appel. Les décorateurs peuvent être empilés dans n’importe quel ordre :

class Coffee
  def cost
    2.0
  end

  def description
    "coffee"
  end
end

class Milk
  def initialize(drink)
    @drink = drink
  end

  def cost
    @drink.cost + 0.5
  end

  def description
    "#{@drink.description}, milk"
  end
end

order = Milk.new(Milk.new(Coffee.new))
puts format("%s: %.2f", order.description, order.cost)

Résultat :

coffee, milk, milk: 3.00

Chaque décorateur stocke l’objet enveloppé et lui délègue les appels. Une classe de base commune peut donc prendre en charge cette partie. Chaque décorateur concret ne redéfinit ensuite que ce qu’il modifie :

class Coffee
  def cost
    2.0
  end

  def description
    "coffee"
  end
end

class Extra
  def initialize(drink)
    @drink = drink
  end

  def cost
    @drink.cost
  end

  def description
    @drink.description
  end
end

class Sugar < Extra
  def cost
    super + 0.2
  end

  def description
    super + ", sugar"
  end
end

order = Sugar.new(Coffee.new)
puts format("%s: %.2f", order.description, order.cost)

Résultat :

coffee, sugar: 2.20

La bibliothèque standard SimpleDelegator (require 'delegate') transmet à l’objet enveloppé chaque méthode qu’elle ne définit pas, ce qui permet de garder les décorateurs courts lorsque l’interface est vaste :

require 'delegate'

class Loud < SimpleDelegator
  def to_s
    super.upcase + "!"
  end
end

text = Loud.new("hello")
puts text
puts text.size
puts text.start_with?("he")

Sortie :

HELLO!
5
true

Les décorateurs ajoutent un comportement à des objets individuels à l’exécution et peuvent être combinés librement. Avec des sous-classes, chaque combinaison, comme MilkSugarCoffee, nécessiterait sa propre classe :

Sugar.new(Milk.new(Coffee.new))      # toute combinaison, dans n'importe quel ordre
Whip.new(Sugar.new(Coffee.new))

# avec des sous-classes : MilkCoffee, SugarCoffee, MilkSugarCoffee, ...

Défi

Facile

Complétez les décorateurs de café. Coffee coûte 2.00 et est décrit comme coffee. Milk ajoute 0.50 et , milk, Sugar ajoute 0.20 et , sugar, et Whip ajoute 0.70 et , whip. Les trois décorateurs partagent la classe de base Extra, qui stocke la boisson enveloppée et transmet cost et description ; chaque sous-classe utilise super.

Chaque ligne d’entrée est une commande, comme milk sugar. Le code fourni enveloppe un nouvel objet Coffee avec les décorateurs dans cet ordre et affiche coffee, milk, sugar: 2.70.

Votre code va dans coffee.rb, extra.rb, milk.rb, sugar.rb et whip.rb. main.rb contient le code d’entrée/sortie fourni et ne peut pas être modifié.

Essayez vous-même

require_relative 'coffee'
require_relative 'extra'
require_relative 'milk'
require_relative 'sugar'
require_relative 'whip'

# Code d'entrée/sortie fourni : conservez-le tel quel
input = []
while (line = gets)
  input << line.chomp
end
extras = { "milk" => Milk, "sugar" => Sugar, "whip" => Whip }
input.each do |line|
  drink = line.split.reduce(Coffee.new) { |d, name| extras[name].new(d) }
  puts format("%s: %.2f", drink.description, drink.cost)
end