evil-front 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df26866b8b19e4d3f42c79c980310ff044a36f93
-  data.tar.gz: 1707febaae47a5ba06ec9a5b55d19c4839859223
+  metadata.gz: 5c642832df3cebbd5ff200d7c90df281731b9db7
+  data.tar.gz: 27841ed12430bba30e6aee3ffe3f15491ab29bab
 SHA512:
-  metadata.gz: 2b2bf25a92aff66e2b38759e21ca0eb6a60f3ef04c1f2120577671dd9636298e59cebc6f39344e720f469bed21ca9710dffda75c223dc4789628959e4d32067d
-  data.tar.gz: a307a12384256e1625d99b8ebf92403c65d608e13217b43ade5bf57a4b963f311b28314f2c809d2463da74c8f4adb7c598868440e151fbb76a64a42bcb78860a
+  metadata.gz: 7e1ce451ab3e68f39af7dcfbc072791d25c0970122b7804f702da59e659d7668e174c7cd0789cb9703cb78eb8ea956ed79e864b6287b6b7d2eb14e593a37b92e
+  data.tar.gz: 8f0ed46f7385518a09bc468e58770f704ae1df55c1eeb249537292c5f50a010b739d69c7a42ac3f35f886aabf05deaa37a535ba4aba5c56351462274c5b79d1a

data/ChangeLog.md

@@ -1,3 +1,10 @@
+## 0.2 “Ptolemaeus Crater”
+
+* Add `english_typograph` helper.
+* Add `typograph_by_locale` helper to use typographer for current I18n locale.
+* Increase `english_typograph` speed.
+* Increase `evil-front/links.js` speed.
+
 ## 0.1 “Hellespontus Montes”
 
 * Initial release.

data/evil-front.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'nokogiri',            '>= 1'
   s.add_dependency 'sprockets',           '>= 1'
   s.add_dependency 'unicode_utils',       '>= 1.4'
+  s.add_dependency 'rubypants-unicode',   '>= 0'
   s.add_dependency 'rails-sass-images',   '>= 0.3'
   s.add_dependency 'standalone_typograf', '>= 3.0.1'
 end

data/lib/assets/javascripts/evil-front/links.js

@@ -3,7 +3,7 @@
 
 evil.doc.ready(function() {
     evil.body.on('click', 'a', function (e) {
-        if ( $(this).attr('href') == '#' ) {
+        if ( this.getAttribute('href') == '#' ) {
             e.preventDefault();
         }
     });

data/lib/evil-front/english.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'rubypants-unicode'
+
+module EvilFront
+  # Helpers to work with English text.
+  module English
+    extend Typograph
+
+    private
+
+    # Replace symbols to right ones, like m-dash, quotes, etc.
+    def self.use_right_symbols(text)
+      RubyPants.new(text).to_html
+    end
+
+    # Small words to insert non-break space before them
+    def self.tiny_words
+      @tiny_words ||= begin
+        tiny  = %w(to is be the a an no if at on of in or and)
+        tiny += tiny.map(&:capitalize)
+        tiny.map { |i| Regexp.new("( | )(#{Regexp.quote i}) ") }
+      end
+    end
+
+    # Apply all typograph methods to text
+    def self.typograph_all(text)
+      typograph(text)
+    end
+  end
+end

data/lib/evil-front/helpers/english_typograph.rb

@@ -0,0 +1,21 @@
+module EvilFront::Helpers
+  # Insert non-break spaces and mark quotes to have nice text.
+  # Work only with English language.
+  #
+  #   = english_typograph user.description
+  #
+  # You can send block:
+  #
+  #   = english_typograph do
+  #     = user.name
+  #     = user.profession
+  def english_typograph(text = nil, &block)
+    text = if block_given?
+      capture(&block)
+    else
+      EvilFront.escape(text)
+    end
+    text = EvilFront::English.typograph_html(text)
+    EvilFront.html_safe(text)
+  end
+end

data/lib/evil-front/helpers/russian_typograph.rb

@@ -1,12 +1,12 @@
 module EvilFront::Helpers
-  # Insert non-break spaces and mark quotes to have nice text. Work only with
-  # Russian language.
+  # Insert non-break spaces and mark quotes to have nice text.
+  # Work only with Russian language.
   #
-  #   = typograph user.description
+  #   = russian_typograph user.description
   #
   # You can send block:
   #
-  #   = typograph do
+  #   = russian_typograph do
   #     = user.name
   #     = user.profession
   def russian_typograph(text = nil, &block)

data/lib/evil-front/helpers/typograph_by_locale.rb

@@ -0,0 +1,16 @@
+module EvilFront::Helpers
+  # Add typograph rules to text by language in current locale.
+  #
+  #   typograph_by_locale(post.body)
+  def typograph_by_locale(text = nil, &block)
+    text = capture(&block) if block_given?
+
+    if I18n.locale == :ru
+      russian_typograph(text)
+    elsif I18n.locale == :en
+      english_typograph(text)
+    else
+      text
+    end
+  end
+end

data/lib/evil-front/russian.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 
 require 'unicode_utils'
-require 'nokogiri'
 require 'standalone_typograf'
 
 module EvilFront
   # Helpers to work with Russian text.
   module Russian
+    extend Typograph
+
     # Capitalize only first letter (like titles in Russian).
     #
     #   = EvilFront::Russian.capitalize_first(title)
@@ -14,44 +15,6 @@ module EvilFront
       UnicodeUtils.upcase(text[0]) + text[1..-1]
     end
 
-    # Insert non-break spaces and mark quotes to have nice text. Work only with
-    # Russian language.
-    #
-    #   EvilFront::Russian.typograph(article)
-    def self.typograph(text)
-      return text if text.nil? or text.empty?
-
-      text = StandaloneTypograf::Typograf.new(text).prepare
-
-      tiny = %w(ни не и но а или да как из-за про по за для
-                на до при меж о у в во с со от ото из без
-                безо к ко об обо под подо над перед передо)
-      tiny += tiny.map { |i| capitalize_first(i) }
-      tiny.each do |word|
-        regexp = Regexp.new(" #{Regexp.quote word} ") # fix JRuby issue
-        text.gsub! regexp, " #{word} " # non-break space
-      end
-
-      text.gsub!(/([^\s" ]+)-([^\s" ]+)/, '\1‑\2')
-
-      text
-    end
-
-    # Like `typograph`, but process only text nodes in HTML.
-    #
-    #   EvilFront::Russian.typograph_html(article.html)
-    def self.typograph_html(html)
-      return html if html.nil? or html.empty?
-
-      if html.include? '<'
-        nodes = Nokogiri::HTML::DocumentFragment.parse(html)
-        typograph_node! nodes
-        nodes.to_html
-      else
-        auto_flying_quotes(typograph(html))
-      end
-    end
-
     # Find quotes in text and make them flying
     def self.auto_flying_quotes(text)
       text.gsub(/\s«[^»]+»/) { |i| flying_quotes i[2..-2], space: i[0] }.
@@ -67,18 +30,25 @@ module EvilFront
 
     private
 
-    # Recursively apply typography to Nokogiri nodes
-    def self.typograph_node!(node)
-      return if node.name == 'code'
-
-      node.children.each do |child|
-        if child.is_a? Nokogiri::XML::Text
-          text = EvilFront.escape(child.content)
-          child.replace( auto_flying_quotes(typograph(text)) )
-        else
-          typograph_node! child
-        end
+    # Small words to insert non-break space before them
+    def self.tiny_words
+      @tiny_words ||= begin
+        tiny  = %w(ни не и но а или да как из-за про по за для
+                   на до при меж о у в во с со от ото из без
+                   безо к ко об обо под подо над перед передо)
+        tiny += tiny.map { |i| capitalize_first(i) }
+        tiny.map { |i| Regexp.new("( | )(#{Regexp.quote i}) ") }
       end
     end
+
+    # Replace symbols to right ones, like m-dash, quotes, etc.
+    def self.use_right_symbols(text)
+      StandaloneTypograf::Typograf.new(text).prepare
+    end
+
+    # Apply all typograph methods to text
+    def self.typograph_all(text)
+      auto_flying_quotes(typograph(text))
+    end
   end
 end

data/lib/evil-front/typograph.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'nokogiri'
+
+module EvilFront
+  # Abstract module to be used in `Russian` and `English` typographs.
+  module Typograph
+    # Like `typograph`, but process only text nodes in HTML.
+    #
+    #   EvilFront::Russian.typograph_html(article.html)
+    def typograph_html(html)
+      return html if html.nil? or html.empty?
+
+      if html.include? '<'
+        nodes = Nokogiri::HTML::DocumentFragment.parse(html)
+        typograph_node! nodes
+        nodes.to_html
+      else
+        typograph_all(html)
+      end
+    end
+
+    # Insert non-break spaces and mark quotes to have nice text.
+    #
+    #   EvilFront::Russian.typograph(article)
+    def typograph(text)
+      return text if text.nil? or text.empty?
+
+      text.gsub! '&quot;', '"'
+      text = use_right_symbols(text)
+      text.gsub!(/([^\s" ]+)-([^\s" ]+)/, '\1‑\2')
+      tiny_words.each { |regexp| text.gsub! regexp, "\\1\\2 " }
+
+      text
+    end
+
+    private
+
+    # Recursively apply typography to Nokogiri nodes
+    def typograph_node!(node)
+      return if %w(pre code kbd script style math).include? node.name
+
+      node.children.each do |child|
+        if child.is_a? Nokogiri::XML::Text
+          text = EvilFront.escape(child.content)
+          child.replace( typograph_all(text) )
+        else
+          typograph_node! child
+        end
+      end
+    end
+  end
+end

data/lib/evil-front/version.rb

@@ -1,3 +1,3 @@
 module EvilFront
-  VERSION = '0.1.0' unless defined? EvilFront::VERSION
+  VERSION = '0.2.0' unless defined? EvilFront::VERSION
 end

data/lib/evil-front.rb

@@ -6,7 +6,9 @@ require 'sprockets'
 require 'rails-sass-images'
 
 module EvilFront
-  autoload :Russian, 'evil-front/russian'
+  autoload :Typograph, 'evil-front/typograph'
+  autoload :Russian,   'evil-front/russian'
+  autoload :English,   'evil-front/english'
 
   if defined?(::Rails)
     # Enable `lib/assets/` and `vendor/assets/` in Rails app.

data/spec/english_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require_relative 'spec_helper'
+
+describe EvilFront::English do
+
+  describe 'typograph' do
+
+    it 'changes quotes' do
+      EvilFront::English.typograph('"a".').should == '“a”.'
+    end
+
+    it 'changes dashes' do
+      EvilFront::English.typograph('a - b').should == 'a - b'
+    end
+
+    it 'changes ellipsis' do
+      EvilFront::English.typograph('a...').should == 'a…'
+    end
+
+    it 'inserts non-break spaces' do
+      EvilFront::English.typograph('he is a hero').should == 'he is a hero'
+    end
+
+  end
+
+end

data/spec/helpers_spec.rb

@@ -47,7 +47,7 @@ describe EvilFront::Helpers do
 
   describe 'russian_typograph' do
 
-    it 'typograps text inside tags' do
+    it 'typographs text inside tags' do
       tag = '<a title="а - б">а - б</a>'.html_safe
       russian_typograph(tag).should == '<a title="а - б">а — б</a>'
     end
@@ -58,6 +58,39 @@ describe EvilFront::Helpers do
 
   end
 
+  describe 'english_typograph' do
+
+    it 'typographs text inside tags' do
+      tag = '<a title="a...">a...</a>'.html_safe
+      english_typograph(tag).should == '<a title="a...">a…</a>'
+    end
+
+    it 'escapes HTML' do
+      english_typograph('<a>').should == '&lt;a&gt;'
+    end
+
+  end
+
+  describe 'typograph_by_locale' do
+    after do
+      I18n.locale = :en
+    end
+
+    it 'typographs by current locale' do
+      I18n.locale = :en
+      typograph_by_locale('"a"').should == '“a”'
+
+      I18n.locale = :ru
+      typograph_by_locale('"a"').should == '<span class="quotes">«a»</span>'
+    end
+
+    it 'returns origin text on unknown locale' do
+      I18n.locale = :fr
+      typograph_by_locale('"a"').should == '"a"'
+    end
+
+  end
+
   describe 'title' do
     after do
       I18n.locale = :en

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evil-front
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Sitnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubypants-unicode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails-sass-images
   requirement: !ruby/object:Gem::Requirement
@@ -164,9 +178,11 @@ files:
 - lib/assets/stylesheets/evil-front/styled-taps.sass
 - lib/assets/stylesheets/evil-front/to-px.sass
 - lib/evil-front.rb
+- lib/evil-front/english.rb
 - lib/evil-front/helpers.rb
 - lib/evil-front/helpers/capitalize_first.rb
 - lib/evil-front/helpers/disable_mobile_zoom.rb
+- lib/evil-front/helpers/english_typograph.rb
 - lib/evil-front/helpers/flying_quote.rb
 - lib/evil-front/helpers/head_content.rb
 - lib/evil-front/helpers/head_tag.rb
@@ -176,9 +192,12 @@ files:
 - lib/evil-front/helpers/tel.rb
 - lib/evil-front/helpers/title.rb
 - lib/evil-front/helpers/title_tag.rb
+- lib/evil-front/helpers/typograph_by_locale.rb
 - lib/evil-front/russian.rb
 - lib/evil-front/slim.rb
+- lib/evil-front/typograph.rb
 - lib/evil-front/version.rb
+- spec/english_spec.rb
 - spec/helpers_spec.rb
 - spec/russian_spec.rb
 - spec/sass/empty.txt