standalone_typograf 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea/
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@standalone_typograf --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in standalone_typograf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 «Shilov Alexander»
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# StandaloneTypograf
+
+**StandaloneTypograf** — gem для подготовки текста к публикации (замена кавычек на «ёлочки», тире и знаков ©). 
+Аналог «Типографа» студии Лебедева или сервисов подобных http://typograf.ru
+
+     "Струйка воды толщиной в одну спичку даёт утечку "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
+
+Add this line to your application's Gemfile:
+
+    gem 'standalone_typograf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install standalone_typograf
+    
+
+## Использование
+
+Пример использования:
+
+     require 'standalone_typograf'
+     
+     text = StandaloneTypograf::Typograf.new('"StandaloneTypograf" - простой и быстрый, его можно использовать "на лету"')
+     text.dasherize # Преобразует все тире
+     text.signs # Заменит знаки (с) => ©
+     text.quotes # Преобразует кавычки
+     
+     # Эти три метода можно заменить одной: prepare
+     text.prepare # => «StandaloneTypograf» — простой и быстрый, его можно использовать «на лету»
+
+## Параметры
+### Переопределение или добавление знаков
+
+Чтобы переопределить знаки по-умолчанию или добавить собственные, передайте хеш *signs* или *signs_ru* (для русских заменяемых обозначений) 'знак' => 'заменяемый текст'. 
+Текст будет заменён только если он указан в круглых скобочках.
+
+    text = StandaloneTypograf::Typograf.new('(copy) 2013', signs: {'©' => 'copy'} )
+    text.signs # => "© 2013"
+
+### Переопределение кавычек
+
+Чтопы переопределить кавычки (outer: внешние, inner: внутренние) передайте хеш quotes с ключем outer/inner и массивом из двух символов (левая и правая кавычки):
+     
+    text = StandaloneTypograf::Typograf.new('"Мерседес"', quotes:  { outer: ['«', '»'] } )
+    text.quotes # => "«Мерседес»'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

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

data/lib/standalone_typograf/dasherize.rb

@@ -0,0 +1,9 @@
+#encoding: UTF-8
+
+module StandaloneTypograf
+  module Dasherize
+    def dasherize
+      @text = @text.gsub(/- /i, '— ')
+    end
+  end
+end

data/lib/standalone_typograf/quotes.rb

@@ -0,0 +1,89 @@
+#encoding: UTF-8
+
+module StandaloneTypograf
+  module Quotes
+    QUOTES = {
+        outer: %w( « » ),
+        inner: %w( „ “ ),
+    }
+
+    SOURCE = {
+        double: '"'
+    }
+
+    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
+      end
+      @text = arr_text.join
+    end
+
+    # PRIVATE
+    #
+    private
+
+    # Вернет массив [[0, :open], [10, :close]]
+    # Где цифра - индекс кавычки в тексте,
+    # символ :open или :close - тип кавычки (открывающая или закрывающая)
+    #
+    def build_quotes_tree(arr_text)
+      quotes_tree = []
+      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]
+          else
+            quotes_tree << [index, :close]
+          end
+        end
+      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
+          end
+        end
+
+        # ЗАКРЫВАЮЩИЕ КАВЫЧКИ
+        if e[1] == :close
+          # Каждая нечётная кавычка (или кавычка с индексом = 1) - внешняя
+          if !even || i == 1
+            type_tree[i] << :outer
+          else
+            type_tree[i] << :inner
+          end
+        end
+        type_tree
+      end
+    end
+  end
+end

data/lib/standalone_typograf/signs.rb

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

data/lib/standalone_typograf/version.rb

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

data/lib/standalone_typograf.rb

@@ -0,0 +1,30 @@
+#encoding: UTF-8
+
+require 'standalone_typograf/version'
+require 'standalone_typograf/dasherize'
+require 'standalone_typograf/signs'
+require 'standalone_typograf/quotes'
+
+module StandaloneTypograf
+  class Typograf
+    include StandaloneTypograf::Dasherize
+    include StandaloneTypograf::Signs
+    include StandaloneTypograf::Quotes
+
+    def initialize(text, options={})
+      options[:signs] ||= SIGNS
+      options[:signs_ru] ||= SIGNS_RU
+      options[:quotes] ||= QUOTES
+      @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
+      @text
+    end
+  end
+end

data/standalone_typograf.gemspec

@@ -0,0 +1,24 @@
+#encoding: UTF-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'standalone_typograf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'standalone_typograf'
+  spec.version       = StandaloneTypograf::VERSION
+  spec.authors       = 'Alex Shilov'
+  spec.email         = 'sashapashamasha@gmail.com'
+  spec.description   = "Standalone (offline) client of the ArtLebedev's Studio Typograf service."
+  spec.summary       = 'Very Fast&Simple Typograf fot the Russian text.'
+  spec.homepage      = 'https://github.com/shlima/StandaloneTypograf'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/test/test_dash.rb

@@ -0,0 +1,24 @@
+#encoding: UTF-8
+
+require 'test/unit'
+require 'standalone_typograf'
+
+class DashTest < Test::Unit::TestCase
+  def test_dasherize_left
+    text = StandaloneTypograf::Typograf.new('Привет,- это длинное тире!')
+    should = 'Привет,— это длинное тире!'
+    assert_equal text.dasherize, should
+  end
+
+  def test_dasherize_hyphen
+    text = StandaloneTypograf::Typograf.new('Яблоко - это фрукт. То-то и оно.')
+    should = 'Яблоко — это фрукт. То-то и оно.'
+    assert_equal text.dasherize, should
+  end
+
+  def test_no_dashes
+    text = StandaloneTypograf::Typograf.new('Яблоко есть фрукт.')
+    should = 'Яблоко есть фрукт.'
+    assert_equal text.dasherize, should
+  end
+end

data/test/test_prepare.rb

@@ -0,0 +1,37 @@
+#encoding: UTF-8
+
+require 'test/unit'
+require 'standalone_typograf'
+
+class PrepareTest < Test::Unit::TestCase
+  def test_prepare
+    source = <<-PLAIN
+    (р) 2013 кто-то, кого нельзя называть. "Артемий лебедев(тм), - "Взял мяч - хуяч"(с)"
+    PLAIN
+    text = StandaloneTypograf::Typograf.new(source)
+    should = <<-PLAIN
+    ® 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;
+    PLAIN
+    assert_equal text.prepare, should
+  end
+end

data/test/test_quotes.rb

@@ -0,0 +1,22 @@
+#encoding: UTF-8
+
+require 'test/unit'
+require 'standalone_typograf'
+
+class QuotesTest < Test::Unit::TestCase
+  def test_quotes_o_i
+    text = StandaloneTypograf::Typograf.new('"Два "вида" "кавычек"" "Жесть"')
+    should = '«Два „вида“ „кавычек“» «Жесть»'
+    assert_equal text.quotes, should
+  end
+  def test_quotes_o
+    text = StandaloneTypograf::Typograf.new('"Один", "Два", "Три"')
+    should = '«Один», «Два», «Три»'
+    assert_equal text.quotes, should
+  end
+  def test_quotes_redefinition
+    text = StandaloneTypograf::Typograf.new('"Один", "Два", "Три"', quotes: {outer: ['**', '**;']})
+    should = '**Один**;, **Два**;, **Три**;'
+    assert_equal text.quotes, should
+  end
+end

data/test/test_signs.rb

@@ -0,0 +1,30 @@
+#encoding: UTF-8
+
+require 'test/unit'
+require 'standalone_typograf'
+
+class SignsTest < Test::Unit::TestCase
+  def test_signs
+    text = StandaloneTypograf::Typograf.new('(р)(Р)(r)(R)(тм)(ТМ)(с)(С)(C)(c)')
+    should = '®®®®™™©©©©'
+    assert_equal text.signs, should
+  end
+
+  def test_no_signs
+    text = StandaloneTypograf::Typograf.new('Это чистый текст (yes)')
+    should = 'Это чистый текст (yes)'
+    assert_equal text.signs, should
+  end
+
+  def test_signs_option
+    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;' => 'копи'} )
+    should = '&COPY; 2013'
+    assert_equal text.signs, should
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: standalone_typograf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Shilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Standalone (offline) client of the ArtLebedev's Studio Typograf service.
+email: sashapashamasha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/standalone_typograf.rb
+- lib/standalone_typograf/dasherize.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_prepare.rb
+- test/test_quotes.rb
+- test/test_signs.rb
+homepage: https://github.com/shlima/StandaloneTypograf
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4316510769190788404
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4316510769190788404
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Very Fast&Simple Typograf fot the Russian text.
+test_files:
+- test/test_dash.rb
+- test/test_prepare.rb
+- test/test_quotes.rb
+- test/test_signs.rb