Продолжение, начало в Части 1

Я не встречал хорошего описания паттерна Dependency Injection применительно к PHP.

Недавно ребята из Symfony выпустили свой контейнер DI, снабдив его подробной и хорошей книжкой о том как работать с этим паттерном.

Я вспомнил еще об одной библиотеке для DI, Phemto. Ее автор, — Маркус Бэйкер, создатель SimpleTest. К сожалению на сайте содержится краткая и невнятная справка. тем не менее, проект развиавется, а внутри дистрибутива лежит статья с крайне хорошим объяснением про DI, ну и руководством конечно. Phemto, — очень миниатюрный проект, состоящий из трех не очень больших файлов.

Мне показалось, полезным перевести статью на русский язык и выложить сюда. Статья не очень большая, но содержательная. Ссылку на оригинал дать не могу, оригинал внутри дистрибутива :)

Новый компонент от Symfony касается крайне важного паттерна проектирования — Dependency Injection. Честно говоря, я много про него читал, но на практике не очень видел как применить, и теория была для меня довольно абстрактной. Симфонисты и здесь выдержали фирменный стиль. К компоненту приложена книжка, которая начинается с главы «что такое Dependency Injection»? И шаг за шагом некоторый учебный класс рефакторится в элегантное решение. Чтобы показать, что компонент может использоваться не только с Симфони, в качестве примеров используются и классы из Zend-фреймворка. Жалко только, что книжку нельзя скачать.

Вот еще один пример использования этого компонента с Zend-фреймворком.

Проект дозрел до 1.0 :)

Нововведений почти нет, только фиксы.

Единственное нововведение — картинки обложек на книжной полке

Написал английский перевод на всякий случай, однако прошли те времена, когда можно было рассказать про свою программу на sitepoint. Теперь такое удаляют за self promotion.

О программе: BullDoc — это система для создания документации. Представляет собой комплекс на php, который можно использовать без веб-сервера через командную строку, или в виде сайта под управлением apache. Исходники документации хранятся в текстовых файлах и могут быть помещены в svn. Документация экспортируется в полностью статический html(один файл на одну страницу или один монолитный файл), для размещения на сайте и для скачивания. Имеется экспорт в файл справки chm.

Стандартные реквизиты:
www.bulldoc.ru
Статья на хабре про программу
FAQ
Пример шаг-за-шагом
Документация
Скачать

Ну вот. Хабр висел сутки, и именно в тот день когда, я проанонсировал обновление к своей программе для разработки документации, Bulldoc.

Хотелось бы все-таки, чтобы топик увидели, а повторять его в блоге «я пиарюсь» как-то не здорово. Сошлюсь просто на него тут, в персональном разделе.

habrahabr.ru/blogs/i_am_advertising/56534

Моему проекту по документации программных продуктов исполнился год :)

Выпускаю юбилейную версию 0.4

В общем-то я причесал проект до некоторого достаточного вида и буду двигаться в сторону версии 1.0, исправляя баги, добавляя темы оформления и движки для подсветки кода.

В этом релизе:

Упрощена до примитива конфигурация проекта.

добавлена пара формочек в веб-интерфейс и теперь можно создавать новую книгу оттуда.

добавлена поддержка файл стиля css для оформления книги — его можно класть рядом с исходниками. Это сделано для всякого рода таблиц, списков и прочей типографики, которую не хочется выносить в тему оформления.

существенно упрощена конфигурация книжной полки и вместо разных тем с одним и тем же оформлением для вывода chm, монолитного html-файла, и обычного статического сайта используется одна ита же тема, но с разными параметрами.

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

Ссылки:
www.bulldoc.ru
Статья на хабре про программу
Скачать!

Давайте знакомиться

Каждая разработка, если она хоть немного поэтичней, чем печать «hello world», требует документации. И как-то так получалось, что я начинал писать документацию и все время наталкивался на то, что мне это неудобно:


Документация в MS Word (Open Office) не имеет подсветки кода, держит все в одном длинном документе, его не положишь в систему контроля версий для отслеживания изменений. Такой документ невозможно без лишних трудностей сохранить в html-коде, который будет размещён на сайте.


Microsoft HTML Help Compiler позволяет все хранить в тексте, но не имеет подсветки синтаксиса, документ нельзя собрать в связанные html-страницы для выкладывания на сайт без active-x компонента

Формат Docbook тоже близок к желаемому, но XSLT трансформации сложны, подсветка синтаксиса — хоть и решаемая, но проблема.

PHPDocumentator нацелен на написание документации в виде комментариев к коду. Да, он поддерживает подключение нескольких страниц чистой документации к тому, что получилось (кажется это называется там термином тюториал). BullDoc направлен на написание документации в чистом виде — в виде книжки. Опрятной нормальной книжки с главами, разделами, оглавлением и индексом. То, что получается на выходе из PHPDoc это рабочий инструмент, никак не документация для конечного юзера.

В результате появился небольшой скрипт для документации, который был причесан, задокументирован и предложен обществу.

Сделан экспорт в монолитный html-файл и добавлена поддержка кодировки utf-8 для русского языка.

О программе: BullDoc — это система для создания документации. Представляет собой комплекс на php, который можно использовать без веб-сервера через командную строку, или в виде сайта под управлением apache. Исходники документации хранятся в текстовых файлах и могут быть помещены в svn. Документация экспортируется в полностью статический html(один файл на одну страницу или один монолитный файл), для размещения на сайте и для скачивания. Имеется экспорт в файл справки chm.

Выпущена очередная версия моей системы для создания он-лайн документации.

Система представляет собой комплекс на php, который можно использовать без веб-сервера через командную строку, или в виде сайта под управлением apache. Исходники документации хранятся в текстовых файлах и могут быть помещены в svn. Документация экспортируется в полностью статический html, для размещения на сайте и для скачивания. Имеется экспорт в файл справки chm

Выпустил 0.2 релиз своей Бульки. Прислушался к замечаниям, спасибо друзья. Переделал сайт, все-таки должен быть сайт, а не одиноко лежащая документация.
Изменения в этом релизе:

• Проект приобрел svn репозиторий
• В документацию добавлены разделы: Быстрый старт и Авторы. Внесены изменения в разделы конфигурации книжной полки, работы с оглавлением, работы с текстом и др.
• Конфиг книжной полки переведен в YAML, и значительно упрощен
• Упрощен формат файла оглавления: простые страницы задаются просто парой файл-заголовок
• Сделана подсветка синтаксиса на основе GeSHi

Подробнее можно прочитать на странице релиза.