Le module Enumerable

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

Enumerable est le module qui se trouve derrière les méthodes de collection des tableaux et des tables de hachage. Une classe qui définit each, en produisant ses éléments un par un, et inclut Enumerable obtient map, select, count, sort_by, min_by, sum, include? et des dizaines d'autres méthodes :

class Playlist
  include Enumerable

  def initialize(*songs)
    @songs = songs
  end

  def each
    @songs.each { |song| yield song }
  end
end

list = Playlist.new("Intro", "Dune", "Outro")
puts list.map(&:upcase).join(", ")
puts list.select { |s| s.size > 4 }.inspect
puts list.count
puts list.include?("Dune")

Résultat :

INTRO, DUNE, OUTRO
["Intro", "Outro"]
3
true

yield transmet une valeur au bloc que l’appelant a fourni à each. La classe détermine ce qu’est un élément, par exemple une ligne de texte, une paire de valeurs ou l’un de ses propres objets :

class Inventory
  include Enumerable

  def initialize
    @stock = { "apple" => 3, "pear" => 0, "plum" => 7 }
  end

  def each
    @stock.each { |name, qty| yield name, qty }
  end
end

inv = Inventory.new
p inv.select { |_, qty| qty.positive? }.map(&:first)
p inv.max_by { |_, qty| qty }

Résultat :

["apple", "plum"]
["plum", 7]

Les éléments n’ont pas besoin d’être stockés. each peut les calculer au fur et à mesure, et des méthodes comme first arrêtent la boucle plus tôt :

class Squares
  include Enumerable

  def initialize(limit)
    @limit = limit
  end

  def each
    n = 1
    while n * n <= @limit
      yield n * n
      n += 1
    end
  end
end

p Squares.new(50).to_a
p Squares.new(1000).first(3)
puts Squares.new(100).sum

Résultat :

[1, 4, 9, 16, 25, 36, 49]
[1, 4, 9]
385

Lorsque les éléments définissent <=>, les méthodes de tri de Enumerable, telles que sort, min et max, fonctionnent sans bloc. Sinon, elles en prennent un, comme sort_by et min_by :

class Team
  include Enumerable

  def each(&block)
    @players.each(&block)     # transmettre directement le bloc
  end
end

team.sort_by(&:age)
team.min_by(&:score)

Défi

Facile

Complète la classe Playlist. Elle contient des objets Song (avec title et seconds) ajoutés avec add, inclut Enumerable et définit each, qui produit chaque chanson dans l’ordre où elle a été ajoutée.

Le code fourni ajoute une chanson par ligne d’entrée (title,seconds), puis utilise uniquement les méthodes de Enumerable sur la liste de lecture : il affiche le nombre de chansons, les titres séparés par des virgules, la durée totale au format m:ss, le titre le plus long et les titres des chansons de plus de 3 minutes, triés par ordre alphabétique (ou none).

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

Essayez vous-même

require_relative 'song'
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(Song.new(title, seconds.to_i))
end
total = list.sum(&:seconds)
long = list.select { |s| s.seconds > 180 }.map(&:title).sort
puts "songs: #{list.count}"
puts "titles: #{list.map(&:title).join(", ")}"
puts format("total: %d:%02d", total / 60, total % 60)
puts "longest: #{list.max_by(&:seconds).title}"
puts "over 3 min: #{long.empty? ? "none" : long.join(", ")}"