Защита состояния

Часть раздела Объектно-ориентированное программирование путешествия по Ruby на Coddy. Урок 20 из 57.

Объект должен отклонять запросы, которые нарушили бы его состояние. raise останавливает метод до того, как что-либо изменится. Имя собственного класса ошибки точно обозначает проблему; < StandardError делает класс разновидностью ошибки (наследование, глава 5):

class InsufficientFunds < StandardError
end

class Account
  attr_reader :balance

  def initialize(balance)
    @balance = balance
  end

  def withdraw(amount)
    raise InsufficientFunds, "only #{balance} available" if amount > balance

    @balance -= amount
  end
end

account = Account.new(50)
begin
  account.withdraw(80)
rescue InsufficientFunds => e
  puts "#{e.class}: #{e.message}"
end
puts account.balance

Вывод:

InsufficientFunds: only 50 available
50

Отдельные классы ошибок позволяют вызывающему коду по-разному реагировать на каждую проблему, используя один блок rescue для каждого класса. Объявляйте классы ошибок до классов, которые их вызывают:

class InvalidAmount < StandardError
end

class LimitReached < StandardError
end

class Card
  def charge(amount)
    raise InvalidAmount, "amount must be positive" unless amount.positive?
    raise LimitReached, "limit is 100" if amount > 100

    "charged #{amount}"
  end
end

[40, -5, 500].each do |amount|
  puts Card.new.charge(amount)
rescue InvalidAmount => e
  puts "fix the input: #{e.message}"
rescue LimitReached => e
  puts "try later: #{e.message}"
end

Вывод:

charged 40
fix the input: amount must be positive
try later: limit is 100

freeze делает объект доступным только для чтения: после этого любое изменение его переменных экземпляра вызывает FrozenError, а чтение по-прежнему работает. frozen? сообщает, заморожен ли объект:

class Point
  attr_accessor :x

  def initialize(x)
    @x = x
  end
end

pt = Point.new(1).freeze
puts pt.frozen?
begin
  pt.x = 2
rescue FrozenError => e
  puts e.class
end
puts pt.x

Вывод:

true
FrozenError
1

Геттер, который возвращает внутренний массив, отдаёт сам массив, поэтому внешний код может его изменить. Чтобы объект сохранял контроль над собственными данными, возвращайте замороженную копию с помощью @items.dup.freeze или @items.dup:

class Playlist
  def initialize
    @songs = []
  end

  def add(song)
    @songs << song
  end

  def songs
    @songs.dup.freeze
  end
end

list = Playlist.new
list.add("Intro")
begin
  list.songs << "Hack"
rescue FrozenError
  puts "songs are read-only"
end
p list.songs

Вывод:

songs are read-only
["Intro"]

Задание

Легко

Объяви классы ошибок InvalidAmount и InsufficientFunds, оба — подклассы StandardError, и дополни Account. Методы deposit(amount) и withdraw(amount) вызывают исключение InvalidAmount с сообщением amount must be positive для сумм меньше 1. Метод withdraw вызывает исключение InsufficientFunds с сообщением balance is only 20, если сумма превышает баланс. При возникновении ошибки ничего не меняется.

Предоставленный код считывает команды dep n или wd n и после каждой выводит balance 70, для InvalidAmount — invalid: amount must be positive, а для InsufficientFunds — refused: balance is only 20.

Твой код нужно поместить в файлы invalid_amount.rb, insufficient_funds.rb и account.rb. В main.rb находится предоставленный код ввода/вывода, его нельзя редактировать.

Попробуйте сами

require_relative 'invalid_amount'
require_relative 'insufficient_funds'
require_relative 'account'

# Предоставленный код ввода-вывода: оставьте его без изменений
input = []
while (line = gets)
  input << line.chomp
end
account = Account.new
input.each do |line|
  action, amount = line.split
  begin
    action == "dep" ? account.deposit(amount.to_i) : account.withdraw(amount.to_i)
    puts "balance #{account.balance}"
  rescue InvalidAmount => e
    puts "invalid: #{e.message}"
  rescue InsufficientFunds => e
    puts "refused: #{e.message}"
  end
end