standalone_typograf 2.0.2 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b43853037131f6e6f5688014e63d55263bc1a0f2
+  data.tar.gz: 76b0f8cbc97462ed5added4a66c100ac3297db08
+SHA512:
+  metadata.gz: 90f4013887443a5732e44fce7ee5b967833997f8598064ccfbb058b27b595c2d448dcd645b4a6de4b7e29ed7446dc0b8b8e92c4429807287d146d814731945bb
+  data.tar.gz: 2cd5fd4359a50620cf154a6dc1fbf2465993c62569e866e95093c83dddb0ea5bd89c51b5bfa953b4011e1126f3e2105711ff762d6be370c6ae2df105cefeffe9

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 1.9.3
+  - 2.0.0
+env:
+  - RAILS=3.2.14
+  - RAILS=4.0.0

data/README.md

@@ -1,97 +1,135 @@
-![StandaloneTypograf](https://raw.github.com/shlima/StandaloneTypograf/master/doc/logo.png)
+# StandaloneTypograf
 
-**StandaloneTypograf** — gem для подготовки текста к публикации или типографирования текста на лету (вывод комментариев, например)
+[![Travis CI   ](https://api.travis-ci.org/shlima/standalone_typograf.png)      ](https://travis-ci.org/shlima/standalone_typograf)
+[![Code Climate](https://codeclimate.com/github/shlima/standalone_typograf.png) ](https://codeclimate.com/github/shlima/standalone_typograf)
+[![Gemnasium   ](https://gemnasium.com/shlima/standalone_typograf.png)          ](https://gemnasium.com/shlima/standalone_typograf)
 
-    Пушкин писал Дельвигу: "Жду "Цыганов" и тотчас тисну...", (c) 1827 - А. С. Пушкин
+
+![StandaloneTypograf](https://raw.github.com/shlima/standalone_typograf/master/doc/logo.png)
+
+StandaloneTypograf — gem для подготовки текста к публикации или типографирования текста на лету (вывод комментариев, например)
+
+> Пушкин писал Дельвигу: "Жду "Цыганов" и тотчас тисну...", (c) 1827 - А. С. Пушкин
 
 Превратится в:
-    
-    Пушкин писал Дельвигу: «Жду „Цыганов“ и тотчас тисну…», © 1827 — А. С. Пушкин
-    
+
+> Пушкин писал Дельвигу: «Жду „Цыганов“ и тотчас тисну…», © 1827 — А. С. Пушкин
+
 Пример работы (онлайн типограф): http://typograf.herokuapp.com
-    
-## Возможности
-
-- замена кавычек (поддерживаются внутренние и внешние кавычки);
-- замена знаков (с), (тм), (р) на аналогичные ©, ™, ®. Буква в скобке может быть как латинской, так и кириллической;
-- замена знака ±
-- короткое тире (между числами без отбивки);
-- замена многоточия;
-- подстановка длинного тире (с использованием неразрывного пробела);
-- привязка  одно- и двухбуквенных слов к следующему за ними слову с помощью неразрывного пробела;
-- привязка частиц (>=3) к предыдущему слову с помощью неразрывного пробела;
-- замена всех 19 цельных символов дробей европейского вида, поддерживаемых стандартом Юникод.
-
-## Отличия **StandaloneTypograf**
-
- - автономность (самостоятельная обработка текста не зависящая от сторонних сайтов и сервисов);
- - выполняет прямую функцию (не преобразует в html, работает с plain текстом, UTF-8 символы (© вместо &copy);
- - корректная обработка двойных кавычек (в отличие от gilenson);
- - высокая скорость;
-    
+
+### Отличия StandaloneTypograf
+Отличия от типографа Лебедева и ruby библиотеки Gilenson
+
+* автономность (самостоятельная/standalone обработка текста не зависящая от сторонних сервисов);
+* выполняет прямую функцию (не преобразует в html, работает с plain текстом);
+* корректная обработка вложенных кавычек (в отличие от gilenson);
+
 ## Использование
 
-Пример использования:
+Создайте экземпляр типографа и передайте ему текст как единственный обязательный аргумент:
+
+```ruby
+@text = %Q( "Я "читал" стихи Быкова,- сказал он." (c) )
+typograph = StandaloneTypograph::Typograph.new(@text)
+typograph.prepare #=> «Я „читал“ стихи Быкова,— сказал он.» ©
+```
+
+По умолчанию типограф работает в режиме `utf`, если вам необходма подстановка html-кодов, передайте переметр `mode` со значением `html`
+
+```ruby
+typograph = StandaloneTypograph::Typograph.new(@text, mode: :html)
+typograph.prepare #=> «Я „читал“ стихи Быкова,— сказал он.» ©
+```
+
+Метод `prepare` вызывает все возможные обработчики текста. Вы можете вызвать только некоторые, передав массив с названием необходимых _процессоров_, в метод `processor`
+
+```ruby
+typograph = StandaloneTypograph::Typograph.new(@text)
+typograph.processor(:dashes, :mnemonics)
+```
+
+Вы так же можете использовать метод `prepare` исключив ненужные обработчики. Для этого необходимо передать массив с названием ненужных _процессоров_ с параметром `exclude` при инициализации типографа:
 
-     require 'standalone_typograf'
-     
-     text = StandaloneTypograf::Typograf.new('"StandaloneTypograf" - простой и быстрый, его можно использовать "на лету"')
-     text.dasherize # Преобразует все тире
-     text.signs # Заменит знаки (с) => ©
-     text.quotes # Преобразует кавычки
-     
-     # Эти три метода можно заменить одной командой: prepare
-     text.prepare # => «StandaloneTypograf» — простой и быстрый, его можно использовать «на лету»  
-     
-## Параметры
-### Вызов определенных обработчиков
+```ruby
+typograph = StandaloneTypograph::Typograph.new(@text, exclude: :fractions)
+typograph.prepare # бедут выполнены все преобразования кроме замены дробей
+```
 
-Вы можете вызвать только нужные вам типографы или использовать все одной командой *prepare*. Список поддерживаемых типографов:
 
-- dasherize (тире)
-- signs (символы)
-- quotes (кавычки)
-- dots (многоточие)
-- endash (короткое тире)
-- nbspace (неразрывные пробелы)
-- fractions (дроби)
+## Обработчики
+### Кавычки
+Значение | Тип | Замена Utf | Замена Html
+--- | --- | --- | ---
+" | Внешняя, открывающая | « | \«
+" | Внешняя, закрывающая | » | \»
+" | Внутренняя, открывающая | „ | \„
+" | Внутренняя, закрывающая | “ | \“
 
-Или наоборот, вы можете исключить ненужный вам типограф, передав символьный массив в параметре *except* с ненужными обработчиками:
+```ruby
+StandaloneTypograf::Typograf.new(text).processor(:quotes)
+```
 
-    require 'standalone_typograf'
-    text = StandaloneTypograf::Typograf.new('(c) А. А. Шилов', except: [:fractions])
-    # Выполнит все преобразования кроме замены дробей
-    text.prepare
-    
-### Переопределение или добавление знаков
+### Длинное тире
+Значение | Замена Utf | Замена Html
+--- | --- | ---
+- | — | \—
 
-Чтобы переопределить знаки по-умолчанию или добавить собственные, передайте хеш *signs* или *signs_ru* (для русских заменяемых обозначений) 'заменяемый текст (в формате *regexp*)' => 'знак'. 
+```ruby
+StandaloneTypograf::Typograf.new(text).processor(:dashes)
+```
 
-    text = StandaloneTypograf::Typograf.new('(copy) 2013', signs: {'[(]copy[)]' => '©'})
-    text.signs # => "© 2013"
+### Неразрывные пробелы
+Значение | Замена Utf | Замена Html
+--- | --- | ---
+- |   | \ 
 
-### Переопределение кавычек
+Неразрывные пробелы используются при отбивке длинного тире, одно-двухбуквенных слов и некоторых частиц.
 
-Чтобы переопределить кавычки (outer: внешние, inner: внутренние) передайте хеш quotes с ключем outer/inner и массивом из двух символов (левая и правая кавычки):
-     
-    text = StandaloneTypograf::Typograf.new('"Мерседес"', quotes:  { outer: ['«', '»'] } )
-    text.quotes # => "«Мерседес»'
+```ruby
+StandaloneTypograf::Typograf.new(text).processor(:nbspaces)
+```
 
-## Installation
+### Мнемоники
+Значение | Замена Utf | Замена Html
+--- | --- | ---
+(c) | © | \©
+(tm) | ™ | \™
+(r) | ® | \®
++- | ± | \±
+-> | → | \→
+<- | ← | \&larr;
+~= | ≈ | \&asymp;
 
-Ruby 1.9.3 - 2.0.0; Rails 3-4
+```ruby
+StandaloneTypograf::Typograf.new(text).processor(:mnemonics)
+```
 
-Add this line to your application's Gemfile:
+### Дроби
+Значение | Замена Utf | Замена Html | Html код
+--- | --- | --- | ---
+1/1 | none | <sup>1</sup>&frasl;<sub>1</sub> | `<sup>1</sup>&frasl;<sub>1</sub>`
+1234124/454325 | none | <sup>1234124</sup>&frasl;<sub>454325</sub> | `<sup>1234124</sup>&frasl;<sub>454325</sub>`
 
-    gem 'standalone_typograf'
+Типограф производит замену дробей только в режиме **html**, при этом он генерирует html код используя теги верхнего и нижнего индексов, вследствие чего, количество заменяемых дробей бесконечно.
 
-And then execute:
+```ruby
+StandaloneTypograf::Typograf.new(text).processor(:fractions)
+```
 
-    $ bundle
+Чтобы отключить замену дробей используйте параметр `exclude` при инициализации
 
-Or install it yourself as:
+```ruby
+StandaloneTypograf::Typograf.new(text, :exclude => :fractions)
+```
 
-    $ gem install standalone_typograf
+### Многоточие
+Значение | Замена Utf | Замена Html
+--- | --- | ---
+... | &hellip; | \&hellip;
+
+```ruby
+StandaloneTypograf::Typograf.new(text).processor(:ellipsis)
+```
 
 ## Contributing
 
@@ -100,5 +138,3 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-    
-    

data/Rakefile

@@ -1,9 +1 @@
-require 'rake/testtask'
-Bundler::GemHelper.install_tasks
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc 'Run tests'
-task default: :test
+require "bundler/gem_tasks"

data/doc/fonts.md

@@ -1,4 +1 @@
-Fonts:
-Standalone = Voluptate_demo
-Typograf = Telugu MN
-2 = PT Sans Caption
+Fonts: Standalone = Voluptate_demo Typograf = Telugu MN 2 = PT Sans Caption

data/lib/standalone_typograf/dashes.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module StandaloneTypograf #:nodoc:
+  module Dashes
+    extend ActiveSupport::Concern
+
+    CHAR = {
+      :html => '—',
+      :utf  => '—',
+    }.freeze
+
+    included do
+      register_processor(Processor)
+    end
+
+    module Processor
+      def self.compile(text, mode)
+        text.gsub!(/-(\s)/, CHAR[mode]+'\1')
+        return text
+      end
+    end
+  end
+end

data/lib/standalone_typograf/ellipsis.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module StandaloneTypograf #:nodoc:
+  module Ellipsis
+    extend ActiveSupport::Concern
+
+    CHAR = {
+        :html => '…',
+        :utf  => '…',
+    }.freeze
+
+    included do
+      register_processor(Processor)
+    end
+
+    module Processor
+      def self.compile(text, mode)
+        text.gsub!(/([[:alpha:]])([.][.][.])(\s|$)/, '\1'+CHAR[mode]+'\3')
+        return text
+      end
+    end
+  end
+end

data/lib/standalone_typograf/fractions.rb

@@ -1,35 +1,19 @@
 # encoding: UTF-8
 
-module StandaloneTypograf
+module StandaloneTypograf #:nodoc:
   module Fractions
-    FRACTIONS = {
-        '1/4' => '¼',
-        '1/2' => '½',
-        '3/4' => '¾',
-        '1/7' => '⅐',
-        '1/9' => '⅑',
-        '1/10' => '⅒',
-        '1/3' => '⅓',
-        '2/3' => '⅔',
-        '1/5' => '⅕',
-        '2/5' => '⅖',
-        '3/5' => '⅗',
-        '4/5' => '⅘',
-        '1/6' => '⅙',
-        '5/6' => '⅚',
-        '1/8' => '⅛',
-        '3/8' => '⅜',
-        '5/8' => '⅝',
-        '7/8' => '⅞',
-        '0/3' => '↉'
-    }
+    extend ActiveSupport::Concern
 
-    def fractions
-      FRACTIONS.each_pair do |text, sign|
-        #@text = @text.gsub(/#{text}/i, sign)
-        @text = @text.gsub(/(\D|\A)([#{text[0]}][\/][#{text[2]}])(\D|\z)/i, '\1' + sign + '\3')
-      end
-      @text
+    included do
+      register_processor(Processor)
     end
+
+    module Processor
+      def self.compile(text, mode)
+        return text unless mode == :html
+        text.gsub!(/(\s|^)(\d+)(\/)(\d+)(?:\s|$)/, '\1<sup>\2</sup>&frasl;<sub>\4</sub>')
+        return text
+      end
     end
+  end
 end

data/lib/standalone_typograf/mnemonics.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+module StandaloneTypograf #:nodoc:
+  module Mnemonics
+    extend ActiveSupport::Concern
+
+    # Contains regexps. 
+    # May contain signs in several languages separated by regexp's OR
+    # e.g. eng|рус
+    TEMPLATES = {
+      '\([c|с]\)'   => { html: '©',   utf: '©' },
+      '\((tm|тм)\)' => { html: '™',  utf: '™' },
+      '\([r|р]\)'   => { html: '®',    utf: '®' },
+      '(\+\-)'      => { html: '±', utf: '±' },
+      '(\-\>)'      => { html: '→',   utf: '→' }, 
+      '(\<\-)'      => { html: '&larr;',   utf: '←' },  
+      '(\~\=)'      => { html: '&asymp;',  utf: '≈' },  
+    }.freeze
+
+    included do
+      register_processor(Processor)
+    end
+
+    module Processor
+      def self.compile(text, mode)
+        TEMPLATES.each_pair do |regexp, data|
+          text.gsub!(/#{regexp}/i, data[mode])
+        end
+        return text
+      end
+    end
+  end
+end

data/lib/standalone_typograf/nbspaces.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+module StandaloneTypograf #:nodoc:
+  module Nbspaces
+    extend ActiveSupport::Concern
+
+    CHAR = {
+      :html => ' ',
+      :utf  => ' ',
+    }.freeze
+
+    PARTICLES = %w(
+      разве неужели едва вряд вроде якобы мол дескать даже ведь таки лишь
+      почти только исключительно вон вот именно точь-в-точь приблизительно прямо
+    )
+
+    included do
+      register_processor(Processor)
+    end
+
+    module Processor
+      def self.compile(text, mode)
+        # One or three letter word - nbspace to the right
+        text.gsub!(/(\s|^)([[:alpha:]]{1,2})(\s)/i, '\1\2'+CHAR[mode])
+
+        # nbspace to the right
+        text.gsub!(/(#{PARTICLES.join('|')})(\s)/i, '\1'+CHAR[mode])
+
+        # dash - nbspace to the left
+        text.gsub!(/(\s)(-|#{Dashes::CHAR[:html]}|#{Dashes::CHAR[:utf]})/i, CHAR[mode]+'\2')
+
+        return text
+      end
+    end
+  end
+end

data/lib/standalone_typograf/quotes.rb

@@ -1,94 +1,126 @@
 # encoding: UTF-8
 
-module StandaloneTypograf
+module StandaloneTypograf #:nodoc:
   module Quotes
-    QUOTES = {
-        outer: %w( « » ),
-        inner: %w( „ “ ),
-    }
+    extend ActiveSupport::Concern
+
+    Q = '"' # source quote
+
+    CHARS = {
+        :outer_left  => {html: '«', utf: '«'},
+        :outer_right => {html: '»', utf: '»'},
+        :inner_left  => {html: '„', utf: '„'},
+        :inner_right => {html: '“', utf: '“'},
+    }.freeze
+
+    included do
+      register_processor(Processor)
+    end
 
-    SOURCE = {
-        double: '"'
+    # global locks
+    LOCK = {
+        inside:     false, # inside outer quotes
+        outer_open: false, # outer quote opens but not still closed
+        inner_open: false, # inner quote opens but not still closed
     }
 
-    def quotes
-      arr_text = @text.split('')
-      # [[0, :open], [10, :close]]
-      quotes_tree = build_quotes_tree(arr_text)
-      type_tree = build_type_tree(quotes_tree)
-      # [[5, :open, :inner], [10, :close, :inner]]
-
-      type_tree.each do |e|
-        # ОТКРЫВАЮЩИЕ
-        if e[1] == :open
-          arr_text[e[0]] = (e[2] == :inner) ? @quotes[:inner][0] : @quotes[:outer][0]
-        else
-          # ЗАКРЫВАЮЩИЕ
-          arr_text[e[0]] = (e[2] == :inner) ? @quotes[:inner][1] : @quotes[:outer][1]
-        end
+    class Processor
+      attr_reader :text, :mode, :tarr
+
+      def self.compile(text, mode)
+        compiler = self.new(text, mode)
+        compiler.compile
+        text = compiler.tarr.join()
       end
-      @text = arr_text.join
-    end
 
-    # PRIVATE
-    #
-    private
-
-    # Вернет массив [[0, :open], [10, :close]]
-    # Где цифра - индекс кавычки в тексте,
-    # символ :open или :close - тип кавычки (открывающая или закрывающая)
-    #
-    def build_quotes_tree(arr_text)
-      quotes_tree = []
-      total = arr_text.size
-      arr_text.each_with_index do |char, index|
-        _next_, _prev_ = index + 1, index - 1
-        # Если кавычка - первый символ в строке или за кавычкой примыкает буква,
-        # то эта кавычка - открывающая.
-        if char == SOURCE[:double]
-          if index == 0 || (arr_text[_next_] != ' ' and arr_text[_prev_] == ' ')
-            quotes_tree << [index, :open]
-          # Ситуация с двойными кавычками идущими сразу за одинарными, например:
-          # "Привет, "Медвед"".
-          elsif arr_text[_prev_] == SOURCE[:double] and (arr_text[_next_] != ' ' and index + 1 != total)
-            quotes_tree << [index, :open]
-          else
-            quotes_tree << [index, :close]
-          end
-        end
+      def initialize(text, mode)
+        @text = text
+        @mode = mode
+        # `tarr` means <b>text array</b>
+        # this is because replaced item may contain more than 1 char (like `&laquo;`)
+        # so replaced value will be placed into the one array cell.
+        @tarr = text.split(//)
+      end
+
+      def lock
+        @lock ||= LOCK.deep_dup
       end
-      quotes_tree
-    end
 
-    # Вернет массив [[0, :open, :outer], [10, :close, :outer]]
-    #
-    def build_type_tree(quotes_tree)
-      type_tree = quotes_tree.clone
-      # [[0, :open], [10, :close]]
-      quotes_tree.each_with_index do |e, i|
-        even = (i%2 == 0)? true : false
-        # ОТКРЫВАЮЩИЕ КАВЫЧКИ
-        if e[1] == :open
-          # Каждая кавычка с четным индексом (или индексом == 0)
-          # внешняя.
-          if even || i == 0
-            type_tree[i] << :outer
-          else
-            type_tree[i] << :inner
+      def compile
+        tarr.each_with_index do |symbol, index|
+          next unless symbol == Q
+
+          # == Outer
+          if outside? && open_quote?(index)
+            tarr[index] = CHARS[:outer_left][mode]
+            outer_open_lock!
+            next
+          end
+          if inside? && !lock[:inner_open] && close_quote?(index)
+            tarr[index] = CHARS[:outer_right][mode]
+            outer_open_unlock!
+            next
           end
-        end
 
-        # ЗАКРЫВАЮЩИЕ КАВЫЧКИ
-        if e[1] == :close
-          # Каждая нечётная кавычка (или кавычка с индексом = 1) - внешняя
-          if !even || i == 1
-            type_tree[i] << :outer
-          else
-            type_tree[i] << :inner
+          # == Inner
+          if inside? && !lock[:inner_open] && open_quote?(index)
+            tarr[index] = CHARS[:inner_left][mode]
+            inner_open_lock!
+            next
+          end
+          if inside? && lock[:inner_open] && close_quote?(index)
+            tarr[index] = CHARS[:inner_right][mode]
+            inner_open_unlock!
+            next
           end
         end
-        type_tree
+      end
+
+      private
+
+      # @return [Boolean]
+      # If this quote is open
+      def open_quote?(index)
+        return true if index == 0
+        (text[index-1] =~ /\s|^/) && (text[index+1] =~ /[[:alpha:]]/)
+      end
+
+      # @return [Boolean]
+      # If this quote is close
+      def close_quote?(index)
+        return true if index == (@tarr.length-1)
+        (text[index-1] =~ /[[:alpha:]]|[?!."]/) && (text[index+1] =~ /\s|[,.;!?#{Q}]/)
+      end
+
+      # @return [Boolean]
+      # If we outside of outer quotes
+      def outside?
+        !lock[:outer_open] && !lock[:inside]
+      end
+
+      # @return [Boolean]
+      # If we inside of outer quotes
+      def inside?
+        !outside?
+      end
+
+      def outer_open_lock!
+        lock[:inside]     = true
+        lock[:outer_open] = true
+      end
+
+      def outer_open_unlock!
+        lock[:inside]     = false
+        lock[:outer_open] = false
+      end
+
+      def inner_open_lock!
+        lock[:inner_open] = true
+      end
+
+      def inner_open_unlock!
+        lock[:inner_open] = false
       end
     end
   end
-end
+end

data/lib/standalone_typograf/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module StandaloneTypograf
-  VERSION = '2.0.2'
+  VERSION = '3.0.0'
 end