typefactory 0.0.12 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2fe21cb2ab6aa014e67f167bfe81b267ef4c40c
-  data.tar.gz: d73ee014c70f97d1c22c2a15fb1a19308e524241
+  metadata.gz: 4bbbc519a8a1162821d6ee306243f79ad558cdcd
+  data.tar.gz: 061fbe8213e937c9cfa5f563ee776a360bc9646b
 SHA512:
-  metadata.gz: 6a003ce61ed456fcc81d4d7c9fc25f0c91429995c01e37975c3af3545be14f8a047060107ea0480deb14616716afe60e6924889fe1e7f09d8c0c1dbc96e25a6a
-  data.tar.gz: f419813e8aca8619caae749a68c93fd2c531963ecd5294e2234d1bd07a38ae6455b9cdb2847c848d56b2803425775f261d6c98766faff691e21740ef64640c02
+  metadata.gz: 3bf1298abf0f8959a104d8f600ea21cae28ffdf14617a28f565195de68ddd2d4b3ad4653a23434f1156cd005763f17fe62808921d0c5676c855a36d57f66d5bf
+  data.tar.gz: 102865abd53e6586222dbfceadfa8c30617ca20d0dc40077f5cbca0650e9cf910bbe7d5546ee3db6d872dd135188023456126c6f63b2a221464dd7e112500b79

data/README.md

@@ -1,40 +1,44 @@
-# Typefactory
+# Тайпфектори
 
-This simple plugin helps you to prepare your texts for publishing on the web. Typefactory was created for Russian grammar and punctuation but can be used in other languages (such as English or German).
+Этот небольшой плагин поможет вам подготовить тексты к публикации в вебе. Тайпфектор разрабатывался для русского языка, но может быть легко адаптирован для других языков (к примеру, для англо-германской группы).
 
-_This is my first gem and I'll be glad to hear from you any advices about Ruby/Rails as well as about my English :-)_
+_Тайпфектори — мой первый гем и я буду благодарен за любую критику_
 
-## Abilities
+## Возможности
 
-Current beta version has only methods for processing three levels of quote marks. All used glyphs can be customized.
+Текущая версия расставляет:
+* правильные многоуровневые кавычки;
+* неразрывные проблелы после коротких слов;
+* длинные тире.
 
-## Install
 
-### Ruby on Rails
+## Установка
 
-	$ gem "typefactory", "~> 0.0.10"
+### Ruby on rails
+
+	$ gem "typefactory", "~> 0.0.20"
 	$ bundle install
 	
 
-### Extension for `String`
+### Метод в классе String
 
-Typefactory adds method `prepare` for standard Ruby class `String`. You can use this feature as well as default way.
+Тайпфектори добавляет метод `prepare` в стандартный класс `String`, который вы также можете использовать:
 
-	'Some text here'.prepare
+	'Правильно "оформленный" в вебе текст'.prepare
 	<%= @description.prepare %>
 
 
-## Customize
+## Настройка
 
-Need customization? Please use generator:
+Сгенерируйте шаблон файла настроек:
 
 	$ rails generate typefactory config
 	
-Now you can modify `config/initializers/typefactory.rb`
+Отредактируте параметры в файле `config/initializers/typefactory.rb` по своему усмотрению
 
-## Help to improve
+## Помогите улучшить
 
-If you have text where parsing algorithm makes mistakes, send it to me (eboyko@eboyko.ru), please.
+Если вы нашли ошибку в работе алгоритма, пришлите исходный текст по электронной почте: eboyko@eboyko.ru
 
 ## Contribute
 

data/lib/generators/typefactory/templates/initializer.rb

@@ -1,9 +1,33 @@
 Typefactory.setup do |config|
 
-  config.quote_marks = [
-    { :left => '«', :right => '»' },
-    { :left => '„', :right => '“' },
-    { :left => '‘', :right => '’' }
-  ]
+  config.mode = :entity
+
+  config.locale = :ru
+
+  config.settings = [:clean, :quotes, :dashes, :glue_widows]
+
+  config.glyphs = {
+    nbsp:  { mark: ' ', symbol: ' ', entity: ' ', decimal: ' ' },
+    quot:  { mark: '"', symbol: '"', entity: '"', decimal: '"' },
+    mdash: { mark: '-', symbol: '—', entity: '—', decimal: '—' },
+    copy:  { mark: '(c)', symbol: '©', entity: '©', decimal: '©' }
+  }
+
+  config.quotes = {
+    ru: [
+          {
+            left:  { mark: '"', symbol: '«', entity: '«', decimal: '«' },
+            right: { mark: '"', symbol: '»', entity: '»', decimal: '»' }
+          },
+          {
+            left:  { mark: '"', symbol: '„', entity: '„', decimal: '„' },
+            right: { mark: '"', symbol: '“', entity: '“', decimal: '“' }
+          },
+          {
+            left:  { mark: '"', symbol: '‘', entity: '‘', decimal: '‘' },
+            right: { mark: '"', symbol: '’', entity: '’', decimal: '’' }
+          }
+        ]
+  }
 
 end

data/lib/typefactory.rb

@@ -1,15 +1,21 @@
 require 'typefactory/core_ext'
-require 'active_support/dependencies'
 
 module Typefactory
 
   autoload :Processor, 'typefactory/processor'
 
-  MODE = :entity
+  @mode = :symbol
 
-  LOCALE = :ru
+  @locale = :ru
 
-  QUOTES = {
+  @settings = [
+    :clean,
+    :quotes,
+    :dashes,
+    :glue_widows
+  ]
+
+  @quotes = {
     ru: [
           {
             left:  { mark: '"', symbol: '«', entity: '«', decimal: '«' },
@@ -36,15 +42,89 @@ module Typefactory
         ]
   }
 
-  GLYPHS = {
+  @glyphs = {
     nbsp:  { mark: ' ', symbol: ' ', entity: ' ', decimal: ' ' },
     quot:  { mark: '"', symbol: '"', entity: '"', decimal: '"' },
     mdash: { mark: '-', symbol: '—', entity: '—', decimal: '—' },
     copy:  { mark: '(c)', symbol: '©', entity: '©', decimal: '©' }
   }
 
-  def self.prepare(text)
-    Processor.new(text).prepare
+
+  # @param mode [Symbol] возможные значения `:symbol`, `:entity` или `:decimal`
+  def self.mode=(mode)
+    @mode = mode
+  end
+
+  # @return [Symbol]
+  def self.mode
+    @mode
+  end
+
+  # @param locale [Symbol]
+  def self.locale=(locale)
+    @locale = locale
+  end
+
+  # Локаль, определяющая используемые глифы; по умолчанию `:ru`
+  # @return [Symbol]
+  def self.locale
+    @locale
+  end
+
+  # @param settings [Array<Symbol>]
+  def self.settings=(settings)
+    @settings = settings
+  end
+
+  # @return [Array<Symbol>]
+  def self.settings
+    @settings
+  end
+
+  # @param glyphs [Hash{Symbol => Hash}]
+  def self.glyphs=(glyphs)
+    @glyphs = glyphs
+  end
+
+  # @todo по-человечески описать формат возвращаемых данных
+  # @return [Hash{Symbol => Hash}]
+  def self.glyphs
+    @glyphs
+  end
+
+  # @param quotes [Hash]
+  def self.quotes=(quotes)
+    @quotes = quotes
+  end
+
+  # @todo по-человечески описать формат возвращаемых данных
+  # @return [Hash]
+  def self.quotes
+    @quotes
+  end
+
+  # Возвращает знак кавычки для выбранных уровня глубины и стороны
+  # @param depth [Integer]
+  # @param side [Symbol] `:left` or `:right`
+  def self.quote(depth = 0, side = :left)
+    depth = 0 if depth < 0
+    count = @quotes[@locale].length - 1
+    depth = count if depth > count
+    @quotes[@locale][depth][side][@mode]
+  end
+
+  # Метод настройки модуля с помощью файла инициализации (по аналогии с Devise)
+  # @yield [Typefactory]
+  def self.setup
+    yield self
+  end
+
+  # Обрабатывает текст с учетом заданных параметров
+  # @param text [String]
+  # @param [Array<Symbol>] settings
+  # @return [String]
+  def self.prepare(text, *settings)
+    Processor.new(text).prepare(settings)
   end
 
 end

data/lib/typefactory/core_ext.rb

@@ -1,7 +1,5 @@
 String.class_eval do
-
-  def prepare
-    Typefactory::prepare(self)
+  def prepare(*settings)
+    Typefactory::prepare(self, *settings)
   end
-
 end

data/lib/typefactory/processor.rb

@@ -2,122 +2,196 @@ module Typefactory
 
   class Processor
 
-    @buffer = nil
-
+    # @param original [String]
     def initialize(original)
       @buffer = original
     end
 
-    def prepare
-      cleanup
+    # @param settings [Array]
+    # @return [String]
+    def prepare(settings = nil)
+
+      @settings = settings.nil? ? Typefactory::settings : Typefactory::settings | settings
+
+      cleanup if @settings.include?(:clean) and !@settings.include?(:no_clean)
+
       preserve_html
-      process_quotes
+
+      process_quotes if @settings.include?(:quotes) and !@settings.include?(:no_quotes)
+
       revive_html
-      process_emdaches
-      process_short_words
+
+      process_dashes if @settings.include?(:dashes) and !@settings.include?(:no_dashes)
+
+      process_widows if @settings.include?(:glue_widows) and !@settings.include?(:no_glue_widows)
 
       @buffer
+
     end
 
     private
 
+    # Очищает текст от уже расставленных глифов
     def cleanup
-      GLYPHS.each do |key, glyph|
+      Typefactory::glyphs.each do |key, glyph|
         @buffer.gsub!(/#{glyph[:entity]}|#{glyph[:decimal]}|#{glyph[:symbol]}/) do
           glyph[:mark]
         end
       end
 
       expression = ''
-      QUOTES.each_pair do |locale, quotes|
+      Typefactory::quotes.each_pair do |locale, quotes|
         quotes.each do |level|
           level.each do |side, glyph|
             expression += "#{glyph[:symbol]}|#{glyph[:entity]}|#{glyph[:decimal]}|"
           end
         end
       end
-      @buffer.gsub!(/#{expression[0..-2]}/, GLYPHS[:quot][:mark])
+      @buffer.gsub!(/#{expression[0..-2]}/, Typefactory::glyphs[:quot][:mark])
     end
 
+    # Экранирует параметры тегов HTML
     def preserve_html
       @buffer.gsub!(/<([^\/].*?)>/) do |tag|
         tag.gsub(/"/, '\'')
       end
     end
 
+    # Снимает экранирование с тегов HTML
     def revive_html
       @buffer.gsub!(/<([^\/].*?)>/) do |tag|
         tag.gsub(/'/, '"')
       end
     end
 
+    # Расставляет правильные многоуровневые кавычки
     def process_quotes
-      result = String.new
-      level  = -1
-      @buffer.split('').each_with_index do |character, index|
-        if character == '"'
-          side = quote_mark_side(index)
+      result = ''
+      depth  = -1
+      @buffer.split('').each_with_index do |char, index|
+        if char == '"'
+          side = quote_mark_side index
           if side == :left
-            level  += 1
-            level  = QUOTES[LOCALE].length - 1 if level > QUOTES[LOCALE].length - 1
-            result += QUOTES[LOCALE][level][side][MODE]
+            depth  += 1
+            result += Typefactory::quote(depth, side)
           else
-            result += QUOTES[LOCALE][level][side][MODE]
-            level  -= 1
-            level  = -1 if level < -1
+            result += Typefactory::quote(depth, side)
+            depth  -= 1
           end
         else
-          result += character
+          result += char
         end
       end
+
       @buffer.replace result
     end
 
+    # Определяет сторону кавычки на указаной позиции
+    # @param index [Integer] позиция кавычки в строке
     def quote_mark_side(index)
-      before = space_before_position(index)
-      after  = space_after_position(index)
+      before = space_before_position index
+      after  = space_after_position index
+
       if !before.nil? and !after.nil?
-        (before < after) ? :left : :right
+        if before == after
+
+          if index == 0
+            :left
+          elsif index == @buffer.length-1
+            :right
+          else
+
+            if @buffer[index+1..index+1].scan(/[A-Za-zА-Яа-я0-9]/).any?
+              :left
+            else
+              :right
+            end
+
+          end
+
+        elsif before < after
+          :left
+        else
+          :right
+        end
       elsif !before.nil? and after.nil?
         :left
-      elsif before.nil? and !after.nil?
-        :right
-      else
+      elsif !after.nil? and before.nil?
         :right
       end
     end
 
+    # @param index [Integer] контрольная позиция селектора
+    # @param length [Integer] количество возвращаемых символов перед контрольной позицией
+    # @return [String]
+    def characters_before(index, length)
+      start_position = (index-length > 0) ? index-length : 0
+      end_position   = (index-1 > 0) ? index-1 : 0
+      @buffer[start_position..end_position]
+    end
+
+    # @param index [Integer] контрольная позиция селектора
+    # @param length [Integer] количество возвращаемых символов после контрольной позиции
+    # @return [String]
+    def characters_after(index, length)
+      start_position = index+1 < @buffer.length ? index+1 : @buffer.length-1
+      end_position   = index+length < @buffer.length ? index+length : @buffer.length-1
+      @buffer[start_position..end_position]
+    end
+
+    # Расстояние до ближайшего пробельного символа слева от текущей позиции
+    # @param index [Integer]
+    # @param length [Integer]
+    # @return [Integer, Nil]
     def space_before_position(index, length = 4)
-      to       = (index-1 < 0) ? 0 : index-1
-      from     = (index-length < 0) ? 0 : index-length
-      position = @buffer[from..to].rindex(/\s|\-|>/)
-      if position.nil?
-        index < length ? 0 : nil
+      expression = /\s|\-|>|\(/
+      space_at   = characters_before(index, length).rindex(expression)
+      if space_at.nil?
+        if index < length
+          0
+        else
+          nil
+        end
       else
-        length - position
+        if index < length
+          space_at + 1
+        else
+          length - space_at
+        end
       end
+
     end
 
+    # Расстояние до ближайшего пробельного символа справа от текущей позиции
+    # @param index [Integer]
+    # @param length [Integer]
+    # @return [Integer, Nil]
     def space_after_position(index, length = 4)
-      to       = (index+length > @buffer.length) ? @buffer.length : index+length
-      from     = (index+1 > @buffer.length) ? @buffer.length : index+1
-      position = @buffer[from..to].index(/\s|\-|<|,/)
-      if position.nil?
-        length if index > @buffer.length - length
+      expression = /\s|\-|<|\.|,|!|\?|:|;|\)/
+      space_at   = characters_after(index, length).index(expression)
+      if space_at.nil?
+        if index > @buffer.length-length-1
+          0
+        else
+          nil
+        end
       else
-        position
+        space_at + 1
       end
+
     end
 
-    def process_short_words
+    # Расставляет неразрывные пробелы после слов длиной до трех символов
+    def process_widows
       @buffer.gsub!(/(\s)([a-z,A-Z,а-я,А-Я]{1,2})\s(\S)/) do
-        "#{$1}#{$2}#{GLYPHS[:nbsp][MODE]}#{$3}"
+        "#{$1}#{$2}#{Typefactory::glyphs[:nbsp][Typefactory::mode]}#{$3}"
       end
     end
 
-    def process_emdaches
+    # Расставляет длинные тире
+    def process_dashes
       @buffer.gsub!(/\s\-\s/) do
-        "#{GLYPHS[:nbsp][MODE]}#{GLYPHS[:mdash][MODE]} "
+        "#{Typefactory::glyphs[:nbsp][Typefactory::mode]}#{Typefactory::glyphs[:mdash][Typefactory::mode]} "
       end
     end
 

data/lib/typefactory/version.rb

@@ -1,3 +1,3 @@
 module Typefactory
-  VERSION = '0.0.12'
+  VERSION = '0.0.20'
 end

data/spec/typefactory_spec.rb

@@ -1,47 +1,80 @@
 require 'spec_helper'
 
-RSpec.describe 'Typefactory' do
+RSpec.describe 'Тайпфектори' do
 
-  describe 'Core' do
-    it 'Parameters can be updated successfully' do
+  describe 'В принципе' do
+    it 'Нормально конфигурируется' do
       Typefactory.setup do |config|
-        config.locale      = :ru
-        # config.quote_marks = [
-        #   { :left => '«', :right => '»' },
-        #   { :left => '„', :right => '“' },
-        #   { :left => '‘', :right => '’' }
-        # ]
-        expect(config.quote_marks.class).to eq(Array)
-        expect(config.quote_marks[2][:right]).to eq('’')
+        config.mode     = :symbol
+        config.locale   = :ru
+        config.settings = [:clean, :quotes, :dashes, :glue_widows]
+        config.glyphs   = {
+          nbsp:  { mark: ' ', symbol: ' ', entity: ' ', decimal: ' ' },
+          quot:  { mark: '"', symbol: '"', entity: '"', decimal: '"' },
+          mdash: { mark: '-', symbol: '—', entity: '—', decimal: '—' },
+          copy:  { mark: '(c)', symbol: '©', entity: '©', decimal: '©' }
+        }
+        config.quotes   = {
+          ru: [
+                {
+                  left:  { mark: '"', symbol: '«', entity: '«', decimal: '«' },
+                  right: { mark: '"', symbol: '»', entity: '»', decimal: '»' }
+                },
+                {
+                  left:  { mark: '"', symbol: '„', entity: '„', decimal: '„' },
+                  right: { mark: '"', symbol: '“', entity: '“', decimal: '“' }
+                },
+                {
+                  left:  { mark: '"', symbol: '‘', entity: '‘', decimal: '‘' },
+                  right: { mark: '"', symbol: '’', entity: '’', decimal: '’' }
+                }
+              ],
+          en: [
+                {
+                  left:  { mark: '"', symbol: '“', entity: '“', decimal: '“' },
+                  right: { mark: '"', symbol: '”', entity: '”', decimal: '”' }
+                },
+                {
+                  left:  { mark: '"', symbol: '‘', entity: '‘', decimal: '‘' },
+                  right: { mark: '"', symbol: '’', entity: '’', decimal: '’' }
+                }
+              ]
+        }
+        expect(config.locale).to eq(:ru)
+        expect(config.mode).to eq(:symbol)
+        expect(config.settings.class).to eq(Array)
+        expect(config.glyphs.class).to eq(Hash)
+        expect(config.quotes[config.locale].class).to eq(Array)
       end
     end
+    it 'Не ломает HTML' do
+      example = '<p>Некоторые а используют на типограф <a href="http://artlebedev.ru" class="external" target="_blank">Лебедева</a></p>'
+      expect(example.prepare(:no_glue_widows)).to eq('<p>Некоторые а используют на типограф <a href="http://artlebedev.ru" class="external" target="_blank">Лебедева</a></p>')
+    end
   end
 
-  describe 'Quotation (basic examples)' do
-    it 'Processing first level' do
-      example = 'Типовой "текст" в кавычках'
-      expect(example.prepare).to eq('Типовой «текст» в кавычках')
+  describe 'Кавычки' do
+    it 'Одноуровневые без содержимого' do
+      expect('""'.prepare).to eq('«»')
+      expect(' "" '.prepare).to eq(' «» ')
     end
 
-    it 'Processing second level' do
-      example = '"Различные "ученые" от пикап-индустрии"'
-      expect(example.prepare).to eq('«Различные „ученые“ от пикап-индустрии»')
+    it 'Одноуровневые в стандартном предложении' do
+      example = 'Типовой "текст" в кавычках'
+      expect(example.prepare(:no_glue_widows)).to eq('Типовой «текст» в кавычках')
     end
 
-    it 'Processing third level' do
-      example = '"Быть может, когда-нибудь "все мы будем жить в "лучшем" мире""'
-      expect(example.prepare).to eq('«Быть может, когда-нибудь „все мы будем жить в ‘лучшем’ мире“»')
+    it 'Двухуровневые в стандартном предложении' do
+      example = '"Различные "ученые" от пикап-индустрии"'
+      expect(example.prepare(:no_glue_widows)).to eq('«Различные „ученые“ от пикап-индустрии»')
     end
-  end
-
 
-  describe 'Quotation (complicated exampled)' do
-    it 'processing marks in start/end positions' do
-      example = '"""Никакой" другой" типограф"'
-      expect(example.prepare).to eq('«„‘Никакой’ другой“ типограф»')
+    it 'Трехуровневые в стандартном предложении' do
+      example = '"Быть может, когда-нибудь "все мы будем жить в "лучшем" мире""'
+      expect(example.prepare(:no_glue_widows)).to eq('«Быть может, когда-нибудь „все мы будем жить в ‘лучшем’ мире“»')
     end
 
-    it 'Корректно распознает один уровень кавычек в составных словах с дефисом' do
+    it 'Одноуровневые в дефисных словосочетаниях' do
       example = 'Кавычки-"елочки"'
       expect(example.prepare).to eq('Кавычки-«елочки»')
 
@@ -49,24 +82,18 @@ RSpec.describe 'Typefactory' do
       expect(example.prepare).to eq('«Елочки»-сосны')
     end
 
-    it 'Расставляет неразрывные пробелы' do
+  end
+
+  describe 'Глифы' do
+    it 'Неразрывные пробелы после коротких слов' do
       example = 'Едет Санта на оленях'
       expect(example.prepare).to eq('Едет Санта на оленях')
     end
-
-    it 'Processing demo paragraph' do
-      example = <<eot
-<p>&laquo;Можем "Демо" однозначно констатировать, что, по&nbsp;данным Системы контроля космического пространства Российской Федерации, в&nbsp;период с&nbsp;10:00 до&nbsp;13:00 мск (09:00 до&nbsp;12:00 укр) 12, 16, 17, и&nbsp;18 июля украинские спутники &bdquo;Сич-1&ldquo; и&nbsp;&bdquo;Сич-2&ldquo; над указанными территориями не&nbsp;пролетали. В&nbsp;обозначенное на&nbsp;снимках время над зоной катастрофы находился американский спутник оптико-электронной разведки типа &bdquo;Кихоул&ldquo; (KeyHole). Таким образом, источник получения фотоосновы для дальнейшей обработки СБУ не&nbsp;должен вызывать ни&nbsp;у кого сомнений&raquo;,&nbsp;&mdash; замечает Минобороны.</p>
-eot
-      puts example.prepare
-    end
-  end
-
-  describe 'Glyphs' do
-    it 'Process long dashes' do
+    it 'Длинные тире' do
       example = 'Писец - не только ценный мех'
-      expect(example.prepare).to eq('Писец — не только ценный мех')
+      expect(example.prepare(:no_glue_widows)).to eq('Писец — не только ценный мех')
     end
   end
 
+
 end

data/typefactory.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rails', '~> 4.1', '>= 4.1.0'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.1', '>= 10.1.0'
   spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typefactory
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.20
 platform: ruby
 authors:
 - Evgeny Boyko
@@ -9,28 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-02 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement