typographer 0.3.2

data/Changelog

@@ -0,0 +1,6 @@
+==v.0.0.1
+
+Replace quotes
+Replace dash between words to —
+Add non-brace space after small words
+Insert <span class="nobr"></span> around small words separated by dash

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.rdoc

@@ -0,0 +1,31 @@
+==Typographer
+
+Simple plugin to make text more readable by applying some typographic rules to string. It is intended to use for russian texts, but some english typography rules are also supported.
+
+==Example
+
+You can use <tt>ty</tt> helper in your views:
+
+	ty 'This is a page title'
+	# => 'This is&nbsp;a&nbsp;page title'
+
+You can define custom formats for typography rules:
+
+  TypographerHelper.register(:article, [TypographerHelper::Parsers::SimpleFormat, TypographerHelper::Parsers::Basic])
+
+And use it:
+
+	ty 'This is article text with custom typography', :article
+
+Plugin also replaces h and simple_format helpers to apply typography to their results.
+
+==Installation
+
+In your <tt>Gemfile</tt> add
+
+	gem 'typographer'
+
+and run <tt>bundle install</tt>.
+
+Copyright (c) 2008 Igor Gladkoborodov, released under the MIT license
+Modified by Antony Versal

data/Rakefile

@@ -0,0 +1,6 @@
+require "rspec/core/rake_task"
+
+desc "Test typography plugin."
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/init.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+require 'typographer'
+
+ActionView::Base.send :include, TypographerHelper
+

data/lib/typographer/helper.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'action_view'
+
+module ActionView::Helpers::TextHelper
+  def ty(text, type = :default)
+    TypographerHelper.parse text.to_s, type
+  end
+end

data/lib/typographer/parsers/basic.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+module TypographerHelper
+  module Parsers
+    class Basic
+      def initialize(options = {})
+        @options = options.merge({})
+      end
+
+      def parse(string)
+        #apostrophe
+        # Here comes 1.9 compatibility.
+        # My eyes bleed !!
+
+        string= string.gsub(/“/,'„')
+        string.gsub!(/”/,'“')
+
+        if Regexp.instance_methods.include?(:encoding)
+          string.gsub!(/(\p{Word})'(\p{Word})/, '\1’\2')
+
+          #russian quotes
+          string = replace_quotes string, '«', '»', '„', '“', 'а-яА-Я'
+
+          #english quotes
+          string = replace_quotes string
+
+          #mdash
+          string.gsub!(/--/, '—')
+          string.gsub!(/(\p{Word}|;|,)\s+(—|–|-)\s*(\p{Word})/, '\1 — \3')
+          string.gsub!(/\s+—/, ' —')
+
+          #nobr
+          #around dash-separated words (что-то)
+          string.gsub!(/(^|\s)((\p{Word}|0-9){1,3})-((\p{Word}|0-9){1,3})($|\s)/, '\1<span class="nobr">\2-\4</span>\6')
+          #1980-x почему-то
+          string.gsub!(/(^|\s)((\p{Word}|0-9)+)-((\p{Word}|0-9){1,3})($|\s)/, '\1<span class="nobr">\2-\4</span>\6')
+
+          #non brake space
+          string.gsub!(/(^|\s|\()(\p{Word}{1,2})\s+([^\s])/i, '\1\2&nbsp;\3')
+          string.gsub!(/(^|\s|\()&([A-Za-z0-9]{2,8}|#[\d]*);(\p{Word}{1,2})\s+([^\s])/i, '\1&\2;\3&nbsp;\4') #entities
+          string.gsub!(/(&nbsp;|&#161;)(\p{Word}{1,2})\s+([^\s])/i, '\1\2&nbsp;\3\4')
+        else
+          string.gsub!(/(\w)'(\w)/, '\1&#146;\2')
+
+          #russian quotes
+          string = replace_quotes string, '&laquo;', '&raquo;', '&#132;', '&#147;', 'а-яА-Я'
+
+          #english quotes
+          string = replace_quotes string
+
+          #mdash
+          string.gsub!(/--/, '&mdash;')
+          string.gsub!(/(\w|;|,)\s+(—|–|-)\s*(\w)/, '\1&nbsp;&mdash; \3')
+          string.gsub!(/\s+&mdash;/, '&nbsp;&mdash;')
+
+          #nobr
+          #around dash-separated words (что-то)
+          string.gsub!(/(^|\s)((\w|0-9){1,3})-((\w|0-9){1,3})($|\s)/, '\1<span class="nobr">\2-\4</span>\6')
+          #1980-x почему-то
+          string.gsub!(/(^|\s)((\w|0-9)+)-((\w|0-9){1,3})($|\s)/, '\1<span class="nobr">\2-\4</span>\6')
+
+          #non brake space
+          string.gsub!(/(^|\s|\()(\w{1,2})\s+([^\s])/i, '\1\2&nbsp;\3')
+          string.gsub!(/(^|\s|\()&([A-Za-z0-9]{2,8}|#[\d]*);(\w{1,2})\s+([^\s])/i, '\1&\2;\3&nbsp;\4') #entities
+          string.gsub!(/(&nbsp;|&#161;)(\w{1,2})\s+([^\s])/i, '\1\2&nbsp;\3\4')
+        end
+
+        string
+      end
+
+      def replace_quotes(string, left1 = '&#147;', right1 = '&#148;', left2 = '&#145;', right2 = '&#146;', letters = 'a-zA-Z')
+        str = string.dup
+
+        replace_quotes = lambda do
+          old_str = str.dup
+          str.gsub!(Regexp.new("(\"|\'|&quot;)((\s*<[^>]+>\s*)?[#{letters}]((<[^>]+>)|.)*?[^\\s])\\1", Regexp::MULTILINE | Regexp::IGNORECASE)) do |match|
+            inside, before, after = $2, $`, $'
+            if after.match(/^([^<]+>|>)/) || before.match(/<[^>]+$/) #inside tag
+              match
+            else
+              "#{left1}#{inside}#{right1}"
+            end
+          end
+          old_str != str
+        end
+        while replace_quotes.call do end
+
+        # second level
+        str.gsub!('&', "\0&")
+        replace_second_level_quotes = lambda do
+          str.gsub! Regexp.new("#{left1}([^\0`]*)\0#{left1}([^\0]*)\0#{right1}", Regexp::MULTILINE | Regexp::IGNORECASE) do
+            "#{left1}#{$1}#{left2}#{$2}#{right2}"
+          end
+        end
+        while replace_second_level_quotes.call do end
+        str.gsub!("\0", '')
+
+        str
+      end
+    end
+  end
+end

data/lib/typographer/parsers/simple_format.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'action_view'
+
+module TypographerHelper
+  module Parsers
+    class SimpleFormat
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::TagHelper
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def parse(string)
+        self.simple_format string, @options
+      end
+    end
+  end
+end

data/lib/typographer/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+module TypographerHelper
+  GEM_NAME = "typographer"
+  VERSION = "0.3.2"
+end

data/lib/typographer.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require "typographer/helper"
+
+module TypographerHelper
+  mattr_reader :registry
+
+  def self.register(name, elements)
+    @@registry ||= {}
+    @@registry[name.to_sym] = get_parsers elements
+  end
+
+  def self.parse(string, type = :default)
+    @@registry[type].each do |parser|
+      string = parser.parse string
+    end
+
+    string
+  end
+
+  module Parsers
+  end
+
+  private
+  #It can get as parameter:
+  # => Class
+  # => Symbol
+  # => Object
+  def self.get_parsers(elements)
+    result = []
+
+    elements.each do |element|
+      if (element.is_a? Class)
+        element = element.new
+      elsif (element.is_a? String)
+        cls = TypographerHelper::Parsers.name + '::' + element.to_s.split("::").last
+        #Fails here of class doesn`t exist
+        cls = cls.constantize
+        element = cls.new
+      end
+
+      result.push element
+    end
+
+    result
+  end
+end
+
+require "typographer/parsers/basic"
+require "typographer/parsers/simple_format"
+
+TypographerHelper.register(:default, [TypographerHelper::Parsers::Basic])
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+$KCODE = 'u'
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :development)

data/spec/typography_spec.rb

@@ -0,0 +1,182 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe TypographerHelper, 'with typographer' do
+  include ActionView::Helpers::TextHelper
+  include ActionView::Helpers::TagHelper
+
+  it "should have t helper" do
+    ty('typographer me please').should == 'typographer me please'
+  end
+
+  it "should typographer output of h helper" do
+    h('Typographer & &').should == 'Typographer & &'
+  end
+
+  it "should work with custom-added formats" do
+    TypographerHelper.register(:simple, [TypographerHelper::Parsers::SimpleFormat, TypographerHelper::Parsers::Basic])
+    ty("I'm first\n\nAnd I&nbsp;am&nbsp;second", :simple).should == "<p>I&#146;m first</p>\n\n<p>And I&nbsp;am&nbsp;second</p>"
+  end
+
+  it "should return '<p></p>' (simple_format of empty string) on simple_format(nil)" do
+    simple_format(nil).should == "<p></p>"
+  end
+
+  it "should make russian quotes for quotes with first russian letter" do
+    ty('"текст"').should == '&laquo;текст&raquo;'
+    ty('Text "текст" text').should == 'Text &laquo;текст&raquo; text'
+    ty('Text "текст" text "Другой текст" ').should == 'Text &laquo;текст&raquo; text &laquo;Другой текст&raquo; '
+  end
+
+  it "should make russian quotes for quotes with first russian letter, beginning with html tag" do
+    ty('"<a href="#link">те</a>кст"').should == '&laquo;<a href="#link">те</a>кст&raquo;'
+    ty('Text "<b>те</b>кст" text').should == 'Text &laquo;<b>те</b>кст&raquo; text'
+  end
+
+  it "should make russian quotes for quotes with html tag" do
+    ty('Текст "Начало текста <a href="#link">те</a>кст"').should == 'Текст &laquo;Начало текста <a href="#link">те</a>кст&raquo;'
+  end
+
+  it "should do the same with single quotes" do
+    ty('\'текст\'').should == '&laquo;текст&raquo;'
+    ty('Text \'текст\' text').should == 'Text &laquo;текст&raquo; text'
+    ty('Text \'текст\' text \'Другой текст\' ').should == 'Text &laquo;текст&raquo; text &laquo;Другой текст&raquo; '
+  end
+
+  it "should create second-level russian quotes" do
+   ty('Текст "в кавычках "второго уровня""').should == 'Текст &laquo;в&nbsp;кавычках &#132;второго уровня&#147;&raquo;'
+  end
+
+  it "should make english quotes for quotes with first non-russian letter" do
+    ty('"text"').should == '&#147;text&#148;'
+    ty('Text "text" text').should == 'Text &#147;text&#148; text'
+    ty('Text "text" text "Another text" ').should == 'Text &#147;text&#148; text &#147;Another text&#148; '
+  end
+
+  it "should do the same with single quotes" do
+    ty('\'text\'').should == '&#147;text&#148;'
+    ty('Text \'text\' text').should == 'Text &#147;text&#148; text'
+    ty('Text \'text\' text \'Another text\' ').should == 'Text &#147;text&#148; text &#147;Another text&#148; '
+  end
+
+  it "should create second-level english quotes" do
+    ty('Text "in quotes "second level""').should == 'Text &#147;in&nbsp;quotes &#145;second level&#146;&#148;'
+  end
+
+
+  it "should not replace quotes inside html tags" do
+    ty('<a href="ссылка">ссылка</a>').should == '<a href="ссылка">ссылка</a>'
+    ty('<a href=\'ссылка\'>"ссылка"</a>').should == '<a href=\'ссылка\'>&laquo;ссылка&raquo;</a>'
+
+    ty('<a href=\'link\'>link</a>').should == '<a href=\'link\'>link</a>'
+    ty('<a href="link">"link"</a>').should == '<a href="link">&#147;link&#148;</a>'
+
+    ty(' one">One</a> <a href="two"></a> <a href="three" ').should == ' one">One</a> <a href="two"></a> <a href="three" '
+  end
+
+  it "should make english and russian quotes in the same string" do
+    ty('"Кавычки" and "Quotes"').should == '&laquo;Кавычки&raquo; and &#147;Quotes&#148;'
+    ty('"Quotes" и "Кавычки"').should == '&#147;Quotes&#148; и&nbsp;&laquo;Кавычки&raquo;'
+
+    ty('"Кавычки "второго уровня"" and "Quotes "second level""').should == '&laquo;Кавычки &#132;второго уровня&#147;&raquo; and &#147;Quotes &#145;second level&#146;&#148;'
+    ty('"Quotes "second level"" и "Кавычки "второго уровня""').should == '&#147;Quotes &#145;second level&#146;&#148; и&nbsp;&laquo;Кавычки &#132;второго уровня&#147;&raquo;'
+  end
+
+  it "should make (“”) quotes in the same string" do
+    ty('“Кавычки” and “Quotes”').should == '&#132;Кавычки&#147; and &#132;Quotes&#147;'
+  end
+
+  it "should replace -- to &mdash;" do
+    ty('Replace -- to mdash please').should == 'Replace&nbsp;&mdash; to&nbsp;mdash please'
+  end
+
+  it "should replace \"word - word\" to \"word&nbsp;&mdash; word\"" do
+    ty('word - word').should == 'word&nbsp;&mdash; word'
+  end
+
+  it "should insert &nbsp; before each &mdash; if it has empty space before" do
+    ty('Before &mdash; after').should == 'Before&nbsp;&mdash; after'
+    ty('Before	 &mdash; after').should == 'Before&nbsp;&mdash; after'
+    ty('Before&mdash;after').should == 'Before&mdash;after'
+  end
+
+
+  it "should insert &nbsp; after small words" do
+    ty('an apple').should == 'an&nbsp;apple'
+  end
+
+  it "should insert &nbsp; after small words" do
+    ty('I want to be a scientist').should == 'I&nbsp;want to&nbsp;be&nbsp;a&nbsp;scientist'
+  end
+
+  it "should insert &nbsp; after small words with ( or dash before it" do
+    ty('Apple (an orange)').should == 'Apple (an&nbsp;orange)'
+  end
+
+  it "should not insert &nbsp; after small words if it has not space after" do
+    ty('Хорошо бы.').should == 'Хорошо бы.'
+    ty('Хорошо бы').should == 'Хорошо бы'
+    ty('Хорошо бы. Иногда').should == 'Хорошо бы. Иногда'
+  end
+
+  it "should insert <span class=\"nobr\"></span> around small words separated by dash" do
+    ty('Мне фигово что-то').should == 'Мне фигово <span class="nobr">что-то</span>'
+    ty('Как-то мне плохо').should == '<span class="nobr">Как-то</span> мне плохо'
+    ty('хуе-мое').should == '<span class="nobr">хуе-мое</span>'
+  end
+
+  it "should not insert <span class=\"nobr\"></span> around words separated by dash if both of them are bigger than 3 letters" do
+    ty('мальчик-девочка').should == 'мальчик-девочка'
+  end
+
+  it "should replace single quote between letters to apostrophe" do
+    ty('I\'m here').should == 'I&#146;m here'
+  end
+
+
+  it "should typographer real world examples" do
+    ty('"Читаешь -- "Прокопьев любил солянку" -- и долго не можешь понять, почему солянка написана с маленькой буквы, ведь "Солянка" -- известный московский клуб."').should == '&laquo;Читаешь&nbsp;&mdash; &#132;Прокопьев любил солянку&#147;&nbsp;&mdash; и&nbsp;долго не&nbsp;можешь понять, почему солянка написана с&nbsp;маленькой буквы, ведь &#132;Солянка&#147;&nbsp;&mdash; известный московский клуб.&raquo;'
+  end
+
+  it "should typographer real world examples" do
+    ty('"Заебалоооооо" противостояние образует сет, в частности, "тюремные психозы", индуцируемые при различных психопатологических типологиях.').should == '&laquo;Заебалоооооо&raquo; противостояние образует сет, в&nbsp;частности, &laquo;тюремные психозы&raquo;, индуцируемые при различных психопатологических типологиях.'
+  end
+
+  it "should typographer real world examples" do
+    ty('"They are the most likely habitat that we\'re going to get to in the foreseeable future," said NASA Ames Research Center\'s Aaron Zent, the lead scientist for the probe being used to look for unfrozen water.').should == '&#147;They are the most likely habitat that we&#146;re going to&nbsp;get to&nbsp;in&nbsp;the foreseeable future,&#148; said NASA Ames Research Center&#146;s Aaron Zent, the lead scientist for the probe being used to&nbsp;look for unfrozen water.'
+  end
+
+  it "should typographer real wordl examples" do
+    ty('Фирменный стиль: от полиграфии к интернет-решениям (в рамках выставки «Дизайн и Реклама 2009»)').should == 'Фирменный стиль: от&nbsp;полиграфии к&nbsp;интернет-решениям (в&nbsp;рамках выставки «Дизайн и&nbsp;Реклама 2009»)'
+  end
+
+  it "should typographer real world examples" do
+    ty('решениям (в рамках выставки').should == 'решениям (в&nbsp;рамках выставки'
+  end
+
+  it "should typographer real world examples" do
+    ty('Реанимация живописи: «новые дикие» и «трансавангард» в ситуации арт-рынка 1980-х').should == 'Реанимация живописи: «новые дикие» и&nbsp;«трансавангард» в&nbsp;ситуации арт-рынка <span class="nobr">1980-х</span>'
+  end
+
+  it "should typographer real world examples" do
+    ty('«Искусство после философии&raquo; – концептуальные стратегии Джозефа Кошута и Харальда Зеемана').should == '«Искусство после философии&raquo;&nbsp;&mdash; концептуальные стратегии Джозефа Кошута и&nbsp;Харальда Зеемана'
+  end
+
+  it "should typographer real world examples" do
+    ty('Испанцы говорят, что целовать мужчину без усов, - всё равно что есть яйцо без соли').should == 'Испанцы говорят, что целовать мужчину без усов,&nbsp;&mdash; всё равно что есть яйцо без соли'
+  end
+
+  it "should typographer nested quotes properly" do
+    text = %{<p>&quot;Кто-то прибежал&quot; Кто-то прибежал Кто-то прибежал Кто-то прибежал Кто-то прибежал Кто-то прибежал Кто-то прибежал Кто-то прибежал Кто-то прибежал</p><p>&quot;Кто-то прибежал Кто-то прибежал&quot; &nbsp;Кто-то прибежал &laquo;Кто-то прибежал К&raquo;</p>}
+    expected_text = %{<p>&laquo;Кто-то прибежал&raquo; <span class=\"nobr\">Кто-то</span> прибежал <span class=\"nobr\">Кто-то</span> прибежал <span class=\"nobr\">Кто-то</span> прибежал <span class=\"nobr\">Кто-то</span> прибежал <span class=\"nobr\">Кто-то</span> прибежал <span class=\"nobr\">Кто-то</span> прибежал <span class=\"nobr\">Кто-то</span> прибежал <span class=\"nobr\">Кто-то</span> прибежал</p><p>&laquo;Кто-то прибежал <span class=\"nobr\">Кто-то</span> прибежал&raquo; &nbsp;Кто-то прибежал &laquo;Кто-то прибежал К&raquo;</p>}
+    ty(text).should == expected_text
+  end
+
+  it "should typographer nested quotes properly on real-world examples" do
+    text = %{<p>Об очередном ляпе &laquo;налоговой библии&raquo; пишет в своей статье для &laquo;ЗН в Украине&raquo; пишет кандидат юридических наук, доцент кандидат юридических наук, доцент Данил Гетманцев.</p><p>&laquo;Даже при последующем выполнении плательщиком требований налоговой службы его счета будут находиться под арестом&raquo;</p>}
+    expected_text = %{<p>Об очередном ляпе &laquo;налоговой библии&raquo; пишет в&nbsp;своей статье для &laquo;ЗН&nbsp;в&nbsp;Украине&raquo; пишет кандидат юридических наук, доцент кандидат юридических наук, доцент Данил Гетманцев.</p><p>&laquo;Даже при последующем выполнении плательщиком требований налоговой службы его счета будут находиться под арестом&raquo;</p>}
+    ty(text).should == expected_text
+  end
+
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: typographer
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+  prerelease: 
+platform: ruby
+authors:
+- Dmitry Shaposhnik
+- Anton Versal
+- Igor Gladkoborodov
+- Pravosud Pavel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-18 00:00:00.000000000 +03:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &77801750 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77801750
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &77801490 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *77801490
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &77801280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77801280
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &77801030 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77801030
+description: ! 'This gem makes text more readable by applying some typographic rules
+  to string.
+
+  This is a fork of original typography gem.'
+email:
+- dmitry@shaposhnik.name
+- ant.ver@gmail.com
+- igor@workisfun.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/typographer.rb
+- lib/typographer/parsers/basic.rb
+- lib/typographer/parsers/simple_format.rb
+- lib/typographer/helper.rb
+- lib/typographer/version.rb
+- spec/spec_helper.rb
+- spec/typography_spec.rb
+- README.rdoc
+- Rakefile
+- Changelog
+- Gemfile
+- init.rb
+has_rdoc: true
+homepage: https://github.com/Slotos/typographer
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ''
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: typographer-0.3.2
+test_files:
+- spec/spec_helper.rb
+- spec/typography_spec.rb