Délégation avec Forwardable

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

La délégation signifie qu’un objet confie une partie de son travail à un objet qu’il détient, au lieu d’en hériter. Une playlist qui contient un tableau de chansons est plus sûre qu’une playlist qui est un tableau, car le code externe n’a accès qu’aux méthodes que tu choisis de transmettre :

class Playlist
  def initialize
    @songs = []
  end

  def add(song)
    @songs << song
    self
  end

  def size
    @songs.size
  end

  def first
    @songs.first
  end
end

list = Playlist.new.add("Intro").add("Dune")
puts list.size
puts list.first

Résultat :

2
Intro

Écrire à la main chaque méthode de délégation est répétitif. La bibliothèque standard s’en charge avec Forwardable : extend Forwardable, puis def_delegators :@songs, :size, :first délègue ces appels à l’objet dans @songs :

require 'forwardable'

class Playlist
  extend Forwardable
  def_delegators :@songs, :size, :first, :last, :empty?, :include?

  def initialize
    @songs = []
  end

  def add(song)
    @songs << song
    self
  end
end

list = Playlist.new.add("Intro").add("Dune")
puts "#{list.size} #{list.first} #{list.last}"
puts list.include?("Dune")
puts list.empty?

Résultat :

2 Intro Dune
true
false

def_delegator :@songs, :push, :add transfère une méthode sous un nouveau nom. L’objet garde le contrôle total de tout ce qu’il ne transfère pas, par exemple delete ou clear :

require 'forwardable'

class Queue2
  extend Forwardable
  def_delegator :@jobs, :push, :enqueue
  def_delegator :@jobs, :shift, :next_job
  def_delegators :@jobs, :size

  def initialize
    @jobs = []
  end
end

q = Queue2.new
q.enqueue("a")
q.enqueue("b")
puts q.next_job
puts q.size
puts q.respond_to?(:clear)

Sortie :

a
1
false

Préfère la délégation (« en possède un ») lorsqu’une classe n’a besoin que d’une partie du comportement d’une autre classe. Hériter de Array exposerait des dizaines de méthodes, comme clear et delete_at, qui pourraient enfreindre les règles de la playlist :

class Playlist < Array      # toutes les méthodes de Array sont publiques, y compris clear
end

class Playlist              # seules les méthodes que vous déléguez sont publiques
  extend Forwardable
  def_delegators :@songs, :size, :each
end

Défi

Facile

Complète la classe Playlist avec Forwardable. Elle contient des chansons, chacune étant une paire [title, seconds], dans @songs. Délègue size, empty? et first avec def_delegators, et délègue push sous le nom add avec def_delegator. Sa propre méthode duration renvoie la durée totale au format m:ss, et titles renvoie les titres réunis par , .

Le code fourni ajoute une chanson pour chaque ligne d’entrée (title,seconds) avec add, puis affiche la taille, le premier titre, les titres, la durée et indique si la playlist répond à clear.

Ton code va dans playlist.rb. main.rb contient le code d’entrée/sortie fourni et ne peut pas être modifié.

Essayez vous-même

require_relative 'playlist'

# Code d'entrée/sortie fourni : conservez-le tel quel
input = []
while (line = gets)
  input << line.chomp
end
list = Playlist.new
input.each do |line|
  title, seconds = line.split(",")
  list.add([title, seconds.to_i])
end
puts "songs: #{list.size}"
puts "first: #{list.empty? ? "none" : list.first[0]}"
puts "titles: #{list.titles}"
puts "duration: #{list.duration}"
puts "can clear: #{list.respond_to?(:clear)}"