Oops... your message was not sent

Your message has been successfully sent

тематические истории, основанные на опыте компании JetRuby
Rails, Ruby

PureDocx — как мы создали свой Ruby гем

Короткая предыстория: мы работали над проектом для компании, занимающейся автострахованием. Ее клиенты были заинтересованы в возможности моментальной отправки фотографий с места ДТП (а точнее — в генерации отчетов из фотографий с их описанием). Вопрос: в каком формате генерировать отчет? PDF? Но его нельзя редактировать. А если фотография нуждается, например, в текстовых комментариях? В итоге мы решили запилить свой Ruby гем, который бы полностью удовлетворял условиям поставленной задачи.

Для чего нужен этот гем? Для создания docx-файла с динамическим добавлением текста, картинок и таблиц. Изначально мы рассмотрели готовые решения — gem docx и gem sablon. Однако в каждом из них были выявлены существенные недостатки.

Есть ли альтернатива?

Гем docx предоставляет довольно гибкий функционал для работы с docx файлами. В частности, с точки зрения редактирования текста и таблиц. В чем же подводные камни? В громоздких методах добавления текста и (самое главное) — невозможности размещения картинок.

Гем Sablon формирует контент документа согласно созданному шаблону. Все просто: сначала осуществляется разметка (в Microsoft Word или в LibreOffice). А далее по указанным меткам размещается текст и/или таблицы. Гем прекрасно подходит для создания однотипных примитивных документов, в которых динамически меняются данные, но не разметка. Он также содержит самодельные конструкции итераторов (each) и разветвления (if). Однако вместо них гораздо проще и практичнее использовать методы Ruby. И самое главное (опять-таки) гем Sablon не поддерживает размещение картинок.

Казалось бы, нашу проблему мог решить один pull request на GitHub. В нем была реализована поддержка изображений. Но она оказалась довольно сырой. Проблема в следующем: при вставке картинки в документ, ее размеры фиксируются. Поэтому, если мы хотим поменять изображение, новый образец других размеров неизменно растягивается. Или сжимается. По высоте или ширине. В общем, это нам не пойдет.

Решение

И решили мы избавиться от всех проблем одним махом. То есть написать свою библиотеку. Изначально планировался предельно простой функционал: вставка неотформатированного текста и добавление картинок с возможностью масштабирования.

Но аппетит приходит во время еды. Постепенно мы расширили возможности гема. Он научился выравнивать и форматировать текст, а также создавать таблицы. Кроме того, мы добавили функционал размещения картинок и новых таблиц в ячейках главной таблицы.

Наконец, нам удалось совместить структуру документов, созданных с помощью PureDocx gem, с Microsoft Office 2016. Это потребовало определенных усилий, но оно того стоило. Ruby гем состоялся.

Вот как это выглядит

puredocx

Пример сформированного документа.

Документация по проекту на нашей ветке GitHub.

Пользуйтесь на здоровье!

department
Статью подготовил
Отдел веб-разработки
Профессиональная разработка сайтов и приложений на стороне сервера и клиента. Проектирование дизайна, верстка страниц и техническое обслуживание реализованных проектов.
New Articles