Как распланировать классы для приложения а-ля pastebin.org?

Question

[brammator]

Хочу сделать аналог пастебина с такой логикой:

1 Юзер пастит текст
2 Машина определяет один из типов
3 В зависимости от типа выдаётся краткий бриф

Я пишу так (код питоновский, но, думаю, понятен любому программисту):

class Paste(object):
    def save():
        # сериализация и сброс в базу
    def guesstype():
        # угадать тип пасты
    def list():
        # список недавних
    def __str__():
        # показать бриф пасты
class PythonCode(Paste):
    def brief():
        # найти на гитхабе используемые модули, вывести активность коммитов по ним
    def wrapsnippet():
        # ...
class MayakovskyPoetry(Paste):
    def brief():
        # подсчитать слоги в чётных строках
    def printhardcoverbook():
        # ...

Прав ли я? Кое-кто советует "написать всеохватывающую логику с маркерами и в будущем расширять через конфиг, так как код нельзя трогать потому что нельзя и всё тут", но мне кажется, переписать guesstype() базового класса и добавить класс-наследник для нового типа будет проще, логичнее и очевиднее.

Логика деления на типы весьма нетривиальная, с кучей "но если, то" и плохо ложится на "универсальный анализатор"

Answer 1

[Алексей Павлов]

Можно попробовать отдельный класс ресолвер с единственным (?) методом - определить тип текста. Он же может быть и Фабрикой для создания нужного класса. (я использую псевдокод в стиле c#, думаю, также любому программисту будет понятно)

class Paste {
  string Brief() {}
  // other methods
}

class PythonCode : Paste {
  string Brief() {}
}
class MayakovskyPoetry : Paste {
  string Brief() {}
}

class Resolver {
  Paste Guess(string text) {}
}

И использование:

Paste text = Resolver.Guess(userText);
string brief = text.Brief();

Comments

[brammator]

Да, решение с отдельным классом-резольвером интересное, но тогда либо наследовать его от базового (и в чём тогда смысл?), либо не пользоваться стандартными методами базового класса в резольвере. А чем так плоха резольвер-фабрика в базовом классе?

[Алексей Павлов]

принцип одной ответственности - слышали про такой паттерн? Не стоит смешивать две различные функциональности в один класс. Класс Paste отвечает за вывод инфы о тексте пользователя. Класс Resolver - за угадывание типа текста.
И не стоит Resolver наследовать от Paste. Если нужно использовать методы класса Paste, то создавайте объект и используйте его методы. А все нужные методы для распознавания добавьте в сам резольвер. Или эти методы нужны и для распознавания, и для работы самого класса Paste?

[brammator]

Про несмешение понял, спасибо. Методы да, нужны в обоих случаях.

[Алексей Павлов]

думаю, вы понимаете, что дублирование кода недопустимо. Что делать - зависит от того кода, который нужен в обоих случаях.
1) использовать в резольвере созданный объект и его методы. Но в начале непонятно, создавать объект какого именно класса.
2) завести специальный класс именно для использования в резольвере, а потом, после определения типа, создавать объект нужного типа и передавать в него текст. Тот же класс можно будет использовать и в самих классах текста
3) сделать нужные методы статическими, у резольвера или у базового Paste.
4) Резольвер может передавать в созданный нужный объект не только исходный текст, но и распарсенные данные, которые полученный объект может использовать без повторного получения.
Если нужна дальнейшая помощь, приведите методы, которые нужны и при определении типа, и при получении данных о тексте. Возможно, потребуется пересмотр архитектуры.

Answer 2

[Сергей Протько]

guesstype вообще не должно быть в базовом классе, ибо это не логично. Можно сделать в базовом классе абстрактный метод isMatches (просто пустой метод который выкидывает исключение) и в потомках перегружать его. Этот метод будет определять, подходит ли данный кусок кода под выбранный язык. Хотя еще лучше было бы в отдельный компонент эту логику запихнуть.

Comments

[brammator]

То есть писать нечто вроде "if PythonCode.isMatches(newPaste) ... elif MayakovskyPoetry.isMatches(newPaste) ..."? Но в логике guesstype есть этап предобработки с циклом по всем строкам текста, я бы не хотел этот цикл проходить много раз.