Посетитель на Ruby

Паттерны проектирования / Поведенческие паттерны

# ConcreteElement
class Engine
    def accept(v)
        v.visit_engine(self)
    end
end

# ConcreteElement
class Wheel
    attr_reader :number

    def initialize(number)
        @number = number
    end

    def accept(v)
        v.visit_wheel(self)
    end
end

# ConcreteElement
class Car
    def initialize()
        @items = [
            Engine.new,
            Wheel.new(1), Wheel.new(2),
            Wheel.new(3), Wheel.new(4)]
    end

    def accept(v)
        @items.each{ |e| e.accept(v) }
        v.visit_car(self)
    end
end

# ConcreteVisitor
class TestCarVisitor
    def visit_engine(engine)
        puts "test engine"
    end

    def visit_wheel(wheel)
        puts "test wheel #" +
              wheel.number.to_s
    end

    def visit_car(car)
        puts "test car"
    end
end

# ConcreteVisitor
class RepairCarVisitor
    def visit_engine(engine)
        puts "repair engine"
    end

    def visit_wheel(wheel)
        puts "repair wheel #" +
              wheel.number.to_s
    end

    def visit_car(car)
        puts "repair car"
    end
end

# Client
car = Car.new
v1 = TestCarVisitor.new
v2 = RepairCarVisitor.new

car.accept(v1)
car.accept(v2)

Представляет операцию, которую надо выполнить над элементами объекта. Позволяет определить новую операцию, не меняя классы элементов, к которым он применяется.

Задача. Документ состоит из абзацев, картинок и таблиц. Программа должна выгружать его, считать в нём слова и проверять орфографию. Если каждую операцию добавлять методом в каждый вид части, классы частей растут с каждой новой операцией. К тому же код одной операции расползается по многим классам.

Идея. Каждая операция становится отдельным объектом - посетителем. У посетителя по методу на каждый вид элемента. У каждого элемента есть один метод, который принимает посетителя и вызывает его метод для своего вида. Так для каждой пары «элемент и операция» выполняется нужный код, без проверок типа. Чтобы добавить новую операцию, пишут нового посетителя, а классы элементов не меняются.

Как читать пример. Элементы бывают нескольких видов. Каждый конкретный посетитель - одна операция, с отдельным методом на каждый вид элемента. Клиентский код отдаёт посетителя элементам, и каждый элемент направляет его в метод для своего вида. В большинстве примеров один элемент содержит остальные и отдаёт посетителя каждой своей части. Затем два посетителя проходят по одним и тем же частям, каждый со своей операцией. В некоторых языках элементы - обычные данные с меткой типа, а посетитель - одна функция с вариантом для каждого вида.

Когда применять. Посетитель нужен, когда набор классов элементов устойчив, а новые операции над ними появляются часто. Если часто добавляются новые виды элементов, он не годится: каждый новый вид требует нового метода в каждом посетителе.

Частая ошибка. Проверять тип элемента условиями внутри одного общего метода посетителя. Тогда новый вид элемента пропускается без всякого предупреждения. У каждого вида должен быть свой метод.