rutils 0.1.2 → 0.1.3

data/CHANGELOG

@@ -1,3 +1,48 @@
+Версия 0.1.3 - 14.11.2005
+* Gilenson - замена троеточий на ellipsis (julik)
+* Gilenson - теперь пробел, идущий перед одной или двумя буквами на конце слова
+  меняется на glyph[:nbsp]. Сделано через регексп-костыль в #process_wordglue:
+  text.gsub!(/(\s+)([a-zа-яА-Я]{1,2}[\)\]\!\?,\.;]{0,3}\s$)/ui, self.glyph[:nbsp]+'\2') (mash)
+* Gilenson - починен баг из-за которого не типографилась закрывающая кавычка после вопросительного
+  и восклицательного знака (julik)
+* По умолчанию используется новый Gilenson (Gilenson::Formatter). Старый доступен как Gilenson::Obsolete и через
+  String#o_gilensize и грузится только в случае необходимости. Если у вас были тесты провеяющие gilensize
+  скорее всего они "полетели" (julik)
+* Gilenson - дополнительная фича, не связанная с типографикой: замена амперсанда в следующих атрибутах
+  тагов: href, src, data. Пример: <a href="?x=1&y=2&#38;z=3"> => <a href="?x=1&#38;y=2&#38;z=3"> (mash)
+* Gilenson - изменён метод process_ampersands (стало process_escape_html), меняющий &,<,> на глифы :amp,:lt,:gt
+  при запрете HTML (@settings[:html]=>false). По-умолчанию Гиленсон разрешает использование HTML.
+  В иерархии метод выставлен первым для корректной обработки случаев вида
+  %{Используйте &#38; вместо &amp;}.gilensize(:html=>false) (mash)
+* Gilenson - добавлены :skip_attr=>false и :skip_code=>true для управления обработкой типографики атрибутов тегов title, alt и содержимого <code/>, <tt/>, <![CDATA[...]]> (mash)
+* Gilenson - добавлен :raw_output=>true для вывода обычных UTF-8 chars вместо entities (julik)
+* Смена структуры модулей Gilenson (julik)
+    RuTils::Gilenson::Obsolete - старый класс форматтера
+    RuTils::Gilenson::Formatter - новый класс форматтера
+    При вызове RuTils::Gilenson.new возвращается новый Formatter
+* Gilenson - документация (julik)
+* Gilenson - основные группы настроек "по-умолчанию" выносятся в константы (julik)
+* Gilenson - фильтры выносятся в методы типа process_фильтр и их можно применять по отдельности через Formatter#apply (julik)
+* Gilenson - добавлены &para; и &numero; (последний - не стандарт, но нужен для преобразований символа "номер") (mash)
+* Gilenson - добавлен хэш @glyph_copy_paste для подмены юникодных типографских символов на entities
+  (опционально, через @settings[:copypaste]=>true) (mash)
+* Gilenson - добавлена "склейка" инициалов полукруглой шпацией (thin space)
+* Gilenson - добавлен Formatter#process чтобы обрабатывать строки поточно, и сделан удобный доступ к настройкам
+  через "хвост" метода (julik)
+* Во всех внутренних строковых подстановках Gilenson используются указатели на глифы с двоеточием в начале (julik)
+* Gilenson - введен DOUBLE PRIME (&#8243;) для знаков дюйма (julik) 
+    http://en.wikipedia.org/wiki/Prime_%28mark%29
+    Согласно изощренным правилам скошенный prime правильней чем "
+* Новый Гиленсон lib/gilenson/gilenson.rb (mash)
+    RuTils::GilensonNew::Typografica.new('какой-то текст')
+    %q{"какой-то текст"}.n_gilensize
+* Код приведён к "2 spaces - no tabs", частично полетели дифы (mash)
+* Изменены константы дат, используемые в lib/integration/rails_date_helper_override.rb:
+    Было: RuTils::DateTime::ABBR_MONTHNAMES, RuTils::DateTime::INFLECTED_MONTHNAMES
+    Стало: Date::RU_ABBR_MONTHNAMES, Date::RU_INFLECTED_MONTHNAMES (mash)
+* Добавлена функциия Numeric#rublej (julik)
+* Добавлена русская версия Time#ru_strftime и Date#ru_strftime (mash)
+
 Версия 0.1.2 - 01.11.2005
 * Добавлен BiDi-транслит c тестами (mash)
 

data/README

@@ -7,7 +7,7 @@ RuTils - простой обработчик русского текста на
 Весь функционал RuTils поддерживает только UTF-8 (настройка $KCODE / KanjiCode 'u'). Стандартно работа RuTils проверяется
 как на стандартной версии Ruby, так и на парсере регулярных выражений Oniguruma (правда имейте в виду, что с ним
 Gilenson работает медленнее).
-	
+
 Пожалуйста упоминайте версию при сообщении ошибок. Версию RUTILS всегда можно узнать в константе
 
   RuTils::VERSION
@@ -15,7 +15,7 @@ Gilenson работает медленнее).
 Удостоверьтесь, что ваш скрипт правильно обрабатывает Unicode - то есть:
 
 * Переменная $KCODE включена в режим 'u'
-* В скрипт загружена библиотека jcode
+* Все строки которые вы собираетесь обрабатывать уже в кодировке UTF-8
 
 Если вы используете RuTils для сайта под mod_ruby воспользуйтесь директивой RubyKanjiCode в своем httpd.conf.
 
@@ -28,15 +28,19 @@ Gilenson работает медленнее).
 
 RuTils реализует сумму прописью для целых и дробных чисел, с дополнительным учетом рода. Например:
 
-	4.propisju	=> "четыре"
-	345.propisju => "триста сорок пять"
-	231.propisju(2) => "двести тридцать одна"
-	341.propisju_items(1, "чемодан", "чемодана", "чемоданов") => "триста сорок один чемодан"
-	(212.40).propisju_items(2, "сволочь", "сволочи", "сволочей") => "двести двенадцать целых четыре десятых сволочи"
-	
+  4.propisju => "четыре"
+  345.propisju => "триста сорок пять"
+  231.propisju(2) => "двести тридцать одна"
+  341.propisju_items(1, "чемодан", "чемодана", "чемоданов") => "триста сорок один чемодан"
+  (212.40).propisju_items(2, "сволочь", "сволочи", "сволочей") => "двести двенадцать целых четыре десятых сволочи"
+
 Также реализуется выбор варианта числительного в зависимости от числа
 
-	15.items("кодер", "кодера", "кодеров") => "кодеров"
+  15.items("кодер", "кодера", "кодеров") => "кодеров"
+
+и вывод "суммы прописью" для денежных сумм
+
+  (413.2).rublej => "четыреста тринадцать рублей двадцать копеек"
 
 == Транслит
 
@@ -44,10 +48,10 @@ RuTils на данный момент реализует простейший т
 
 Простейший транслит "в одну сторону".
 
- 	"Вот такое вот дело".translify => "Vot takoye vot delo"
-	"Несомненный прогресс по сравнению с PHP".dirify => "nesomnennyi-progress-po-sravneniu-s-php"
-	
-== BiDi-транслит.
+  "Вот такое вот дело".translify => "Vot takoye vot delo"
+  "Несомненный прогресс по сравнению с PHP".dirify => "nesomnennyi-progress-po-sravneniu-s-php"
+
+== BiDi-транслит
 
 Порт BiDiTranslit[http://pixel-apes.com/translit/article#h256-10] от Pixel Apes.
 Реализует транслитерацию "в обе стороны", предоставляя возможность получить валидный URL
@@ -59,48 +63,80 @@ RuTils на данный момент реализует простейший т
 * Уничтожение всех слешей, которые встретятся во входной строке. В этом случае методы вызываются с передачей в них false. Например, "Web/Скрипты".bidi_translify(false)
 * Пропуск слэшей (используется по умолчанию). Например, "Web/+Skripty".bidi_detranslify
 
-	"WebРазработка/Скрипты".bidi_translify     => "Web+Razrabotka+/+Skripty"
-	"+Ustanovka__+mod_perl".bidi_detranslify   => "Установка mod_perl"
-	"WebРазработка/Мимо".bidi_translify(false) => "Web+RazrabotkaMimo"
-	"+PKHP+/Scripts".bidi_translify(false)     => "ПХПScripts"
+  "WebРазработка/Скрипты".bidi_translify     => "Web+Razrabotka+/+Skripty"
+  "+Ustanovka__+mod_perl".bidi_detranslify   => "Установка mod_perl"
+  "WebРазработка/Мимо".bidi_translify(false) => "Web+RazrabotkaMimo"
+  "+PKHP+/Scripts".bidi_detranslify(false)     => "ПХПScripts"
 
 == Обработка русской типографики в HTML
 
 Gilenson - порт Typografica[http://pixel-apes.com/typografica] от
 Pixel Apes. Тыпографица - механизм автоматической расстановки подстановок в тексте
 перед его выводом в HTML, оформляющий неразрывные пробелы, типографские кавычки
-и реализующая элементарные макроподстановки.
+и тому подобные "украшательства".
+
+Gilenson расставит в тексте "умные" правильные кавычки (русские - для кириллицы, английские - для латиницы),
+заменит "хитрые" пунктуационные символы на entities и отформатирует знаки типа (c), (tm), телефоны и адреса.
+
+  %q{"И это называется языком?", -- таков был его вопрос}.gilensize => 
+    "«И это называется языком?», — таков был его вопрос"
 
-Имейте в виду, что на баги в Gilenson жаловаться разработчикам Typografica не стоит -
-они вас не поймут и будут правы. Поддержку Gilenson PixelApes не осуществляют.
+Более подробная документация по Gilenson доступна в документах к RuTils::Gilenson::Formatter
 
 В комплекте также есть скрипт gilensize, которым можно поточно обрабатывать Unicode-тексты в среде UNIX
 пользуясь стандартным выводом
 
-	$ cat myfile.txt | gilensize > myfile.html
+  $ cat myfile.txt | gilensize > myfile.html
+
+== Даты
+
+В класс Date введены следующие константы:
+  * RU_MONTHNAMES (Январь Февраль Март...)
+  * RU_DAYNAMES (Воскресенье Понедельник...)
+  * RU_ABBR_MONTHNAMES (Янв Фев Мар...)
+  * RU_ABBR_DAYNAMES (Вск Пн Вт Ср...)
+  * RU_INFLECTED_MONTHNAMES (Января Февраля Марта...)
+  * RU_DAYNAMES_E (первое второе третье...)
+
+Пример использования:
+
+  require 'date'
+  date = Date.new(2005, 11, 9)
+  puts "#{Date::RU_ABBR_MONTHNAMES[date.mon]}"   => Ноя
+  puts "#{Date::RU_MONTHNAMES[date.mon]}"        => Ноябрь
+  puts "#{Date::RU_ABBR_DAYNAMES[date.wday]}"    => Ср
+  puts "#{Date::RU_DAYNAMES[date.wday]}"         => Среда
+
+При включенной перезагрузке функций (RuTils::overrides_enabled) осуществляется "покрытие" стандартной
+функции Time#strftime ("родную" #strftime можно продолжать использовать через alias-метод #strftime_norutils):
+
+  Time.local(2005,"dec",31).strftime("%a, %A, %b, %B")          => "Сб, Суббота, Дек, Декабрь"
+  Time.local(2005,"dec",31).strftime_norutils("%a, %A, %b, %B") => "Sat, Saturday, Dec, December"
 
 == Интеграция с Rails, RedCloth и BlueCloth
 
 RuTils в первую очередь задумывался как максимально "прозрачный" механизм обработки русского текста
-в контексте Rails-приложения. Если вы используете RuTils в одном приложении с RedCloth или BlueCloth,
+в контексте Rails-приложения. В связи с этим RuTils "вторгается" в работу других Ruby-модулей
+и изменяет механизм их работы. 
+
+Если вы используете RuTils в одном приложении с RedCloth или BlueCloth,
 RuTils автоматически будет обрабатывать типографику во всех текстах, пропускаемых через них. Имейте в виду, что для
-корректной работы этой функции RuTils надо загружать после модулей RedCloth и BlueCloth.
+корректной работы этой функции RuTils надо загружать *после* модулей RedCloth и BlueCloth.
 
+Помимо этого RuTils заставляет следующие функции Rails говорить по-русски:
 
-В принципе если вы пользуетесь RedCloth или BlueCloth все что ими обрабатывается будет автоматически
-обрабатываться и Gilenson'ом тоже. В случае с RedCloth Glienson автоматически заменяет стандартные для
-Textile английские кавычки и типографские знаки на свои - русские. В случае BlueCloth Gilenson используется
-как "декоратор" Markdown.
+* Меню выбора даты (+date_select+ и +datetime_select+) будут выводиться с русскими именами месяцев
+* +distance_of_time_in_words+ будет выводить русские описания длительности ("более 2 часов")
 
-Перегрузку всех функций (RedCloth, BlueCloth и компоненты Rails) можно включать и отключать в любое время
-с помощью метода overrides= модуля RuTils. Когда перегрузка выключена, все сторонние библиотеки будут работать
+Перегрузку всех функций других модулей можно включать и отключать в любое время
+с помощью метода RuTils::overrides=. Когда перегрузка выключена, все сторонние библиотеки будут работать
 в стандартном режиме (например, RedCloth будет расставлять английские типографские кавычки). Это нужно
 когда вам нужно переключиться на английский (или любой другой язык) без перезапуска приложения.
 
-Если вы хотите использовать rutils как дополенние к Rails в одном конкретном приложении, скопируйте
+Если вы хотите использовать rutils как дополнение к Rails в одном конкретном приложении, скопируйте
 директорию rutils в папку vendor/plugins вашего приложения. Вы можете воспользоваться командой
 rutilize чтобы сделать это автоматически. После этого вы сможете использовать RuTils без
-необходимости установки gem'а на вашем сервере.
+необходимости установки gem'а на вашем сервере (не забудьте перезапустить приложение чтобы вгрузить в него RuTils).
 
   $ rutilize /Sites/my_app1 /Sites/my_app2 /Sites/my_another_app
   
@@ -116,16 +152,41 @@ rutilize чтобы сделать это автоматически. После
 
 Просто включите rutils в свою программу как gem
 
-	require_gem 'rutils'
-	
+  require_gem 'rutils'
+
 или как библиотеку
 
-	require 'rutils'
-	
+  require 'rutils'
+
 == Где получить помощь
 
 На странице проекта на RubyForge[http://rubyforge.org/projects/rutils]
 
 == Работает ли это с текстом  в кодировке Windows-1251
 
-Нет и никогда не будет. 
+Нет и никогда не будет.
+
+== Реальные проекты
+
+В настоящее время RuTils используется на следующих сайтах:
+
+* http://artonica.ru
+* http://radar.cinemac.ru
+
+Если вы используете RuTils в своей работе пожалуйста сообщайте нам об этом чтобы мы могли включить ваши приложения и сайты в список.
+
+== Как ускорить реализацию новых функций
+
+Воспользуйтесь трекером на RubyForge. Опишите нужный вам функционал и приложите (по возможности) тесты, которым этот функционал должен удовлетворять. Схему организации тестов вы можете скопировать из собственных тестов RuTils.
+
+Если вы пишете исходный код, который войдет в RuTils или в тестовые наборы, пожалуйста следуйте следующим правилам оформления кода:
+
+* Unix line breaks (LF)
+* Кодировка файлов - строго UTF-8 без BOM (Byte Order Mark)
+* Отступы в 2 пробела, без табуляций.
+* Однострочные блоки с фигурными скобками, многострочные - с +do ... end+
+* Все другие конвенции нормального написания Ruby-кода (http://www.rubygarden.org/ruby/ruby?RubyStyleGuide)
+
+Мы используем пробелы поскольку табулятор означает автозаполнение в IRB (Interactive Ruby Shell)
+
+Если вы хотите участвовать в разработке RuTils пользуйтесь CVS проекта.

data/TODO

@@ -2,25 +2,10 @@
 
 ==Gilenson
 
-* Заменить все entities в Гиленсоне на UTF-эквиваленты (в том числе и в тестах)
-	(пока генерируемый им код содержит, например, raquo и nbsp - неприменимо для  XML)
-* Выяснить, стоит ли отрабатывать типографику в атрибутах тегов
-* Полностью рефакторнуть (вынести каждую трансформацию в метод)
-	* чтобы тестить трансформации по одной
-	* чтобы применять трансформации по одной буде на то нужда
-
 ==Pluralization
 
 * Истинная плюрализация без передачи рода и вариантов (как в Rails)
 
-==Даты
-
-* В принципе нужно обеспечить полноценное покрытие stfmt
-
 ==Rails
 
-* distance_of_time_in_words и тому подобные
-
-==Транслит
-
-* bidi-транслит (Данил)
+* закончить меню выбора стран и начинать помогать делать Multilingual Rails

data/bin/gilensize

@@ -14,5 +14,5 @@ require File.dirname(__FILE__) + '/../lib/rutils'
 #   Julik <me@julik.nl>
 
 while st = gets do
-	puts RuTils::Gilenson::Formatter.new(st).to_html
+  puts RuTils::Gilenson.new(st).to_html
 end