standalone_typograf 1.0.2 → 2.0.0

data/.gitignore

@@ -9,7 +9,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/README.md

@@ -1,52 +1,31 @@
-# StandaloneTypograf
+![StandaloneTypograf](https://raw.github.com/shlima/StandaloneTypograf/master/doc/logo.png)
 
-**StandaloneTypograf** — gem для подготовки текста к публикации (замена кавычек на «ёлочки», тире и знаков ©). 
-Аналог «Типографа» студии Лебедева или сервисов подобных http://typograf.ru
+**StandaloneTypograf** — gem для подготовки текста к публикации или типографирования текста на лету (вывод комментариев, например)
 
-     "Струйка воды толщиной в одну спичку даёт утечку "200 литров в сутки!"", - сказал Афоня (c) 
-     
-     «Струйка воды толщиной в одну спичку даёт утечку „200 литров в сутки!“», — сказал Афоня ©
-
-
-Ключевое отличие **StandaloneTypograf** от прочих типографских гемов: 
-
- - автономность (самостоятельная обработка текста не зависящая от сторонних сайтов и сервисов);
- - выполняет прямую функцию (не преобразует в html, работает с plain текстом, UTF-8 символы (© вместо &#169)
- - высокая скорость
-
-
-## Benchmark
-
-Для теста была взята книга Андрея Кочергина «Как закалялась сталь 2» (954 строки, 32 000 слов, 757 знаков тире [-], 752 кавычки ["])
-
-В тесте принимали участие следующие гемы:
- - **typograf**, **multi_typograf** *(обертка сервиса typograf.ru)*;
- - **als_typograf** *(обертка сервиса artlebedev.ru/tools/typograf/)*;
- - **Gilenson** *(RuTils)*.
-
-Результаты тестирования:
- 1. **StandaloneTypograf, результат: 0,143 секунды** 
- 2. Gilenson, результат: 0.764 секунды (медленее в 5 раз) 
- 3. typograf, multi_typograf, выдали ошибку (макс. размер текста = 50 Kb)
- 3. als_typograf, выдал ошибку (макс. размер текста = 32 Kb)
- 
-## Installation
-
-Ruby 1.9.3 - 2.0.0; Rails 3
+    Пушкин писал Дельвигу: "Жду "Цыганов" и тотчас тисну...", (c) 1827 - А. С. Пушкин
 
-Add this line to your application's Gemfile:
-
-    gem 'standalone_typograf'
-
-And then execute:
+Превратится в:
+    
+    Пушкин писал Дельвигу: «Жду „Цыганов“ и тотчас тисну…», © 1827 — А. С. Пушкин
+    
+## Возможности
 
-    $ bundle
+- замена кавычек (поддерживаются внутренние и внешние кавычки);
+- замена знаков (с), (тм), (р) на аналогичные ©, ™, ®. Буква в скобке может быть как английской, так и русской;
+- замена знака ±
+- короткое тире (между числами без отбивки);
+- подстановка длинного тире (с использованием неразрывного пробела);
+- привязка  одно- и двухбуквенных слов к следующему за ними слову с помощью неразрывного пробела;
+- привязка частиц (>=3) к предыдущему слову с помощью неразрывного пробела;
+- замена всех 19 цельных символов дробей европейского вида, поддерживаемых стандартом Юникод.
 
-Or install it yourself as:
+## Отличия **StandaloneTypograf**
 
-    $ gem install standalone_typograf
+ - автономность (самостоятельная обработка текста не зависящая от сторонних сайтов и сервисов);
+ - выполняет прямую функцию (не преобразует в html, работает с plain текстом, UTF-8 символы (© вместо &copy);
+ - корректная обработка двойных кавычек (в отличие от gilenson);
+ - высокая скорость;
     
-
 ## Использование
 
 Пример использования:
@@ -58,25 +37,59 @@ Or install it yourself as:
      text.signs # Заменит знаки (с) => ©
      text.quotes # Преобразует кавычки
      
-     # Эти три метода можно заменить одной: prepare
-     text.prepare # => «StandaloneTypograf» — простой и быстрый, его можно использовать «на лету»
-
+     # Эти три метода можно заменить одной командой: prepare
+     text.prepare # => «StandaloneTypograf» — простой и быстрый, его можно использовать «на лету»  
+     
 ## Параметры
+### Вызов определенных обработчиков
+
+Вы можете вызвать только нужные вам типографы или использовать все одной командой *prepare*. Список поддерживаемых типографов:
+
+- dasherize (тире)
+- signs (символы)
+- quotes (кавычки)
+- dots (многоточие)
+- endash (короткое тире)
+- nbspace (неразрывные пробелы)
+- fractions (дроби)
+
+Или наоборот, вы можете исключить ненужный вам типограф, передав символьный массив в параметре *except* с ненужными обработчиками:
+
+    require 'standalone_typograf'
+    text = StandaloneTypograf::Typograf.new('(c) А. А. Шилов', except: [:fractions])
+    # Выполнит все преобразования кроме замены дробей
+    text.prepare
+    
 ### Переопределение или добавление знаков
 
-Чтобы переопределить знаки по-умолчанию или добавить собственные, передайте хеш *signs* или *signs_ru* (для русских заменяемых обозначений) 'знак' => 'заменяемый текст'. 
-Текст будет заменён только если он указан в круглых скобочках.
+Чтобы переопределить знаки по-умолчанию или добавить собственные, передайте хеш *signs* или *signs_ru* (для русских заменяемых обозначений) 'заменяемый текст (в формате *regexp*)' => 'знак'. 
 
-    text = StandaloneTypograf::Typograf.new('(copy) 2013', signs: {'©' => 'copy'} )
+    text = StandaloneTypograf::Typograf.new('(copy) 2013', signs: {'[(]copy[)]' => '©'})
     text.signs # => "© 2013"
 
 ### Переопределение кавычек
 
-Чтопы переопределить кавычки (outer: внешние, inner: внутренние) передайте хеш quotes с ключем outer/inner и массивом из двух символов (левая и правая кавычки):
+Чтобы переопределить кавычки (outer: внешние, inner: внутренние) передайте хеш quotes с ключем outer/inner и массивом из двух символов (левая и правая кавычки):
      
     text = StandaloneTypograf::Typograf.new('"Мерседес"', quotes:  { outer: ['«', '»'] } )
     text.quotes # => "«Мерседес»'
 
+## Installation
+
+Ruby 1.9.3 - 2.0.0; Rails 3-4
+
+Add this line to your application's Gemfile:
+
+    gem 'standalone_typograf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install standalone_typograf
+
 ## Contributing
 
 1. Fork it
@@ -84,3 +97,5 @@ 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/doc/fonts.md

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

data/lib/standalone_typograf.rb

@@ -1,10 +1,13 @@
-#encoding: UTF-8
+# encoding: UTF-8
 
 require 'standalone_typograf/version'
 require 'standalone_typograf/dasherize'
 require 'standalone_typograf/signs'
 require 'standalone_typograf/quotes'
 require 'standalone_typograf/dots'
+require 'standalone_typograf/endash'
+require 'standalone_typograf/nbspace'
+require 'standalone_typograf/fractions'
 
 module StandaloneTypograf
   class Typograf
@@ -12,22 +15,44 @@ module StandaloneTypograf
     include StandaloneTypograf::Signs
     include StandaloneTypograf::Quotes
     include StandaloneTypograf::Dots
+    include StandaloneTypograf::Endash
+    include StandaloneTypograf::Nbspace
+    include StandaloneTypograf::Fractions
 
     def initialize(text, options={})
       options[:signs] ||= SIGNS
       options[:signs_ru] ||= SIGNS_RU
       options[:quotes] ||= QUOTES
+      # except - массив с названием методов, которые необходимо исключить при выполнении
+      # *prepare*
+      @except = options[:except]
       @signs, @signs_ru = SIGNS.merge(options[:signs]), SIGNS_RU.merge(options[:signs_ru])
       @quotes = QUOTES.merge(options[:quotes])
       @text = text
     end
 
     def prepare
-      self.dasherize
-      self.signs
-      self.quotes
-      self.dots
+      call_method :dasherize
+      call_method :signs
+      call_method :quotes
+      call_method :dots
+      call_method :endash
+      call_method :nbspace
+      call_method :fractions
       @text
     end
+
+    # PRIVATE
+    #
+    private
+
+    # Выполняет метод только если он не был передан в параметре 'except'
+    # при создании объекта.
+    #
+    def call_method(name)
+      if @except.nil? || !@except.include?(name)
+        self.send(name)
+      end
+    end
   end
 end

data/lib/standalone_typograf/dasherize.rb

@@ -1,9 +1,12 @@
-#encoding: UTF-8
+# encoding: UTF-8
 
 module StandaloneTypograf
   module Dasherize
     def dasherize
+      # В ситуации, когда тире с отбивкой с обоих сторон,
+      # левый пробел - неразрывный.
+      @text = @text.gsub(/\s-\s/i, ' — ')
       @text = @text.gsub(/- /i, '— ')
     end
   end
-end
+end

data/lib/standalone_typograf/dots.rb

@@ -1,4 +1,4 @@
-#encoding: UTF-8
+# encoding: UTF-8
 
 module StandaloneTypograf
   module Dots

data/lib/standalone_typograf/endash.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module StandaloneTypograf
+  module Endash
+    def endash
+      @text = @text.gsub(/(\d+)([-])(\d+)/i, '\1'+'–'+'\3')
+    end
+  end
+end

data/lib/standalone_typograf/fractions.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+
+module StandaloneTypograf
+  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' => '↉'
+    }
+
+    def fractions
+      FRACTIONS.each_pair do |text, sign|
+        #@text = @text.gsub(/#{text}/i, sign)
+        @text = @text.gsub(/(\D)([#{text[0]}][\/][#{text[2]}])(\D)/i, '\1' + sign + '\3')
+      end
+      @text
+    end
+    end
+end

data/lib/standalone_typograf/nbspace.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+
+module StandaloneTypograf
+  module Nbspace
+    PARTICLES = [
+        'разве',
+        'неужели',
+        'едва',
+        'вряд',
+        'вроде',
+        'якобы',
+        'мол',
+        'дескать',
+        'даже',
+        'ведь',
+        'таки',
+        'лишь',
+        'почти',
+        'только',
+        'исключительно',
+        'вон',
+        'вот',
+        'именно',
+        'точь-в-точь',
+        'приблизительно',
+        'прямо',
+    ]
+    # Неразрывный пробел
+    def nbspace
+      # Одна буква - неразрывный пробел справа
+      @text = @text.gsub(/(\s)([a-zа-яА-Я])(\s)/i, '\1'+'\2'+' ')
+
+      # Двухбуквенные слова - наразрывные пробел справа
+      @text = @text.gsub(/(\s)([a-zа-яА-Я][a-zа-яА-Я])(\s)/i, '\1'+'\2'+' ')
+
+      # У частиц неразрывный пробел слева
+      PARTICLES.each { |p| @text = @text.gsub(/(\s)(#{p})/i, ' '+'\2') }
+
+      @text
+    end
+  end
+end

data/lib/standalone_typograf/quotes.rb

@@ -1,4 +1,4 @@
-#encoding: UTF-8
+# encoding: UTF-8
 
 module StandaloneTypograf
   module Quotes

data/lib/standalone_typograf/signs.rb

@@ -1,28 +1,26 @@
-#encoding: UTF-8
+# encoding: UTF-8
 
 module StandaloneTypograf
   module Signs
 
     SIGNS = {
-        '©' => 'c',
-        '™' => 'tm',
-        '®' => 'r',
+        '[(]c[)]' => '©',
+        '[(]tm[)]' => '™',
+        '[(]r[)]' => '®',
+        '[+][-]' => '±',
     }
     SIGNS_RU = {
-        '©' => 'с',
-        '™' => 'тм',
-        '®' => 'р',
+        '[(]с[)]' => '©',
+        '[(]тм[)]' => '™',
+        '[(]р[)]' => '®',
     }
 
     def signs
-      result = @text.clone
-      @signs.each_pair do |sign, text|
-        result.gsub!(/[(]#{text}[)]/i, sign)
+      source = @signs.merge(@signs_ru).merge(SIGNS).merge(SIGNS_RU)
+      source.each_pair do |text, sign|
+        @text = @text.gsub(/#{text}/i, sign)
       end
-      @signs_ru.each_pair do |sign, text|
-        result.gsub!(/[(]#{text}[)]/i, sign)
-      end
-      @text = result
+      @text
     end
   end
 end

data/lib/standalone_typograf/version.rb

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

data/test/test_dash.rb

@@ -12,7 +12,7 @@ class DashTest < Test::Unit::TestCase
 
   def test_dasherize_hyphen
     text = StandaloneTypograf::Typograf.new('Яблоко - это фрукт. То-то и оно.')
-    should = 'Яблоко — это фрукт. То-то и оно.'
+    should = 'Яблоко — это фрукт. То-то и оно.'
     assert_equal text.dasherize, should
   end
 

data/test/test_endash.rb

@@ -0,0 +1,12 @@
+#encoding: UTF-8
+
+require 'test/unit'
+require 'standalone_typograf'
+
+class EndashTest < Test::Unit::TestCase
+  def test_endash
+    text = StandaloneTypograf::Typograf.new('- В 2006-2012 годах я учился в каком-то университете.')
+    should = '- В 2006–2012 годах я учился в каком-то университете.'
+    assert_equal text.endash, should
+  end
+end

data/test/test_fractions.rb

@@ -0,0 +1,13 @@
+#encoding: UTF-8
+
+require 'test/unit'
+require 'standalone_typograf'
+
+class FractionsTest < Test::Unit::TestCase
+  # Дроби
+  def test_fractions
+    text = StandaloneTypograf::Typograf.new('В 1/3 всей воды на планете содержится 2/10 углекислого газа. 102/303')
+    should = 'В ⅓ всей воды на планете содержится 2/10 углекислого газа. 102/303'
+    assert_equal text.fractions, should
+  end
+end

data/test/test_nbspace.rb

@@ -0,0 +1,26 @@
+#encoding: UTF-8
+
+require 'test/unit'
+require 'standalone_typograf'
+
+class NbspaceTest < Test::Unit::TestCase
+  def test_prepare_1word
+    # Неразрывный пробел справа от 'я' и 'в'
+    text = StandaloneTypograf::Typograf.new('Давно я ходил в лес')
+    should = 'Давно я ходил в лес'
+    assert_equal text.nbspace, should
+  end
+  def test_prepare_2words
+    # Неразрывный пробел справа от 'за'
+    text = StandaloneTypograf::Typograf.new('Сходи за пивом')
+    should = 'Сходи за пивом'
+    assert_equal text.nbspace, should
+  end
+
+  def test_particles
+    # У частиц неразрывный пробел слева
+    text = StandaloneTypograf::Typograf.new('Саша якобы принес водку')
+    should = 'Саша якобы принес водку'
+    assert_equal text.nbspace, should
+  end
+end

data/test/test_prepare.rb

@@ -10,28 +10,25 @@ class PrepareTest < Test::Unit::TestCase
     PLAIN
     text = StandaloneTypograf::Typograf.new(source)
     should = <<-PLAIN
-    ® 2013 кто-то, кого нельзя называть. «Артемий лебедев™, — „Взял мяч — хуяч“©»
+    ® 2013 кто-то, кого нельзя называть. «Артемий лебедев™, — „Взял мяч — хуяч“©»
     PLAIN
     assert_equal text.prepare, should
   end
 
-  def test_prepare_blank
-    source = <<-PLAIN
-    р 2013 кто-то, кого нельзя называть. Артемий лебедев тм, Если взял мяч, то хуяч с
-    PLAIN
-    text = StandaloneTypograf::Typograf.new(source)
-    should = source
-    assert_equal text.prepare, should
-  end
-
   def test_prepare_redefinition
     source = <<-PLAIN
     (р) 2013 кто-то, кого нельзя называть. "Артемий лебедев(тм), - "Взял мяч - хуяч"(с)"
     PLAIN
     text = StandaloneTypograf::Typograf.new(source, quotes: {outer: ['&laquo;', '&raquo;']})
     should = <<-PLAIN
-    ® 2013 кто-то, кого нельзя называть. &laquo;Артемий лебедев™, — „Взял мяч — хуяч“©&raquo;
+    ® 2013 кто-то, кого нельзя называть. &laquo;Артемий лебедев™, — „Взял мяч — хуяч“©&raquo;
     PLAIN
     assert_equal text.prepare, should
   end
+
+  def test_except
+    text = StandaloneTypograf::Typograf.new('1/2+1/3', except: [:fractions])
+    should = '1/2+1/3'
+    assert_equal text.prepare, should
+  end
 end

data/test/test_signs.rb

@@ -17,14 +17,20 @@ class SignsTest < Test::Unit::TestCase
   end
 
   def test_signs_option
-    text = StandaloneTypograf::Typograf.new('(copy) 2013', signs: {'©' => 'copy'} )
+    text = StandaloneTypograf::Typograf.new('(copy) 2013', signs: {'[(]copy[)]' => '©'})
     should = '© 2013'
     assert_equal text.signs, should
   end
 
   def test_signs_ru_option
-    text = StandaloneTypograf::Typograf.new('(копи) 2013', signs_ru: {'&COPY;' => 'копи'} )
+    text = StandaloneTypograf::Typograf.new('(копи) 2013', signs_ru: {'[(]копи[)]' => '&COPY;'})
     should = '&COPY; 2013'
     assert_equal text.signs, should
   end
+
+  def test_plus_minus
+    text = StandaloneTypograf::Typograf.new('В шахматной нотации символ +- означает, что после соответствующего хода преимущество имеют белые. Малахов +1.')
+    should = 'В шахматной нотации символ ± означает, что после соответствующего хода преимущество имеют белые. Малахов +1.'
+    assert_equal text.signs, should
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standalone_typograf
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -56,15 +56,24 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/fonts.md
+- doc/logo.png
+- doc/logo.psd
 - lib/standalone_typograf.rb
 - lib/standalone_typograf/dasherize.rb
 - lib/standalone_typograf/dots.rb
+- lib/standalone_typograf/endash.rb
+- lib/standalone_typograf/fractions.rb
+- lib/standalone_typograf/nbspace.rb
 - lib/standalone_typograf/quotes.rb
 - lib/standalone_typograf/signs.rb
 - lib/standalone_typograf/version.rb
 - standalone_typograf.gemspec
 - test/test_dash.rb
 - test/test_dots.rb
+- test/test_endash.rb
+- test/test_fractions.rb
+- test/test_nbspace.rb
 - test/test_prepare.rb
 - test/test_quotes.rb
 - test/test_signs.rb
@@ -83,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3393206938688602568
+      hash: 1046078892496407148
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -92,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3393206938688602568
+      hash: 1046078892496407148
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -102,6 +111,9 @@ summary: Very Fast&Simple Typograf fot the Russian text.
 test_files:
 - test/test_dash.rb
 - test/test_dots.rb
+- test/test_endash.rb
+- test/test_fractions.rb
+- test/test_nbspace.rb
 - test/test_prepare.rb
 - test/test_quotes.rb
 - test/test_signs.rb