simple_format 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14148770aeb5474cb5315dd69011e28a95de2564
-  data.tar.gz: b0ca531bda9dada1a046c25daaebcb73e12cd467
+  metadata.gz: 34c845c32712d925c46d8130899832a6d3cf0a6f
+  data.tar.gz: c6b23b1066f559f1c6a0644055d052818bd5e6ff
 SHA512:
-  metadata.gz: 5769ec213b0bcae9571ae4c048128831f970236260cacb53cdbc75f2ee5887e38f6b5f91ad7469fd3a880400c7281140cba3f5e8cd920c37ce2ca8c440b45324
-  data.tar.gz: 383ee893bbfc414dabc2eca5ca98190d1e3d51ffff7334e11422be2b3b4957f1bc3a4f523ddb4ab562cfef054fb2ddfe6713c1f67293715dde25c9d4a50d7f96
+  metadata.gz: 80a82f9016c92d09ade050bb8bcf1a139820ea0f996b3a1334bbef6324ac84f1d98e5929c73f31c4205de48bcebe7bfc49906eaa1fbc4263a6554f68b95250d6
+  data.tar.gz: 0f30d1cab8e76c3e49ebceee2a917053d3776a823d4d00a16a4db66ae91ef3ac8a27afd5fd2d13b9eccd772b56df822dfe390c343dd7aac05f2aadb3825e6734

data/README.md

@@ -5,6 +5,8 @@ simple_format
 * Auto Link url and email.
 * Clean HTML elements and attributes.
 
+[![Gem Version](https://badge.fury.io/rb/simple_format.png)](http://badge.fury.io/rb/simple_format)  [![Dependency Status](https://gemnasium.com/mimosa/simple_format.png?travis)](https://gemnasium.com/mimosa/rails-cache_control) [![Code Climate](https://codeclimate.com/github/mimosa/simple_format.png)](https://codeclimate.com/github/mimosa/simple_format)
+
 
 Installation
 ------------
@@ -20,35 +22,36 @@ Usage
 
 ``` ruby
 require 'simple_format'
-string = "This is a <span src='error'>:ruby:</span> <script type='text/javascript'>alert('Formater');</script>.\n\n Test Auto Link www.ruby-china.com\n\nmail@domain.com\n\nTest Emoji tag <a href=':cat:'>🍀</a>:ruby-china:."
-SimpleFormat.h(string) # Emoji, Auto Link, Sanitize.clean
+c = SimpleFormat::Converter.new
+string = "This is a <span src='error'>:ruby:</span> <script type='text/javascript'>alert('Formater');</script>.\n\n Test Auto Link www.ruby-china.com\n\nmail@domain.com\n\nTest Emoji tag <a href=':cat:'>🍀</a>:ruby-china:." # 测试文本
+```
+------
+``` ruby
+c.rich_with(string) # 富文本转换（Emoji, nl2br, Auto Link, Sanitize.clean）
 ```
-* return
-
 ``` html
-This is a <span src=\"error\">:ruby:</span> alert('Formater');.<br><br> Test Auto Link <a href=\"http://www.ruby-china.com\" target=\"_blank\">www.ruby-china.com</a><br><br><a href=\"mailto:mail@domain.com\">mail@domain.com</a><br><br>Test Emoji tag <a href=\"&lt;img%20class=%22emoji%22%20src=%22//l.ruby-china.org/assets/emojis/cat.png%22%20width=%2264%22%20height=%2264%22%20/&gt;\"><img class=\"emoji\" src=\"//l.ruby-china.org/assets/emojis/four_leaf_clover.png\" width=\"64\" height=\"64\"></a>:ruby-china:.
+=> "This is a <span src=\"error\">:ruby:</span> alert('Formater');.<br><br> Test Auto Link <a href=\"http://www.ruby-china.com\" target=\"_blank\">www.ruby-china.com</a><br><br><a href=\"mailto:mail@domain.com\">mail@domain.com</a><br><br>Test Emoji tag <a href=\"&lt;img%20class=%22emoji%22%20src=%22//l.ruby-china.org/assets/emojis/cat.png%22%20width=%2264%22%20height=%2264%22%20/&gt;\"><img class=\"emoji\" src=\"//l.ruby-china.org/assets/emojis/four_leaf_clover.png\"></a>:ruby-china:."
 ```
+----
 
 ``` ruby
-SimpleFormat.auto_link(string)
+c.auto_link('www.ruby-china.org') # 自动链接
 ```
-* return 
-
 ``` html
-This is a <span src='error'>:ruby:</span> <script type='text/javascript'>alert('Formater');</script>.<br /><br /> Test Auto Link <a href='http://www.ruby-china.com' target='_blank'>www.ruby-china.com</a><br /><br /><a href='mailto:mail@domain.com'>mail@domain.com</a><br /><br />Test Emoji tag <a href=':cat:'>🍀</a>:ruby-china:.
+=> "<a href='//www.ruby-china.org' target='_blank'>www.ruby-china.org</a>"
 ```
+----
 
 ``` ruby
-SimpleFormat.replace_emoji_with_images(string, 24) # Default img size is 64
+c.emoji_with('🍀') # 表情符
 ```
-* return
-
 ``` html
-This is a <span src='error'>:ruby:</span> <script type='text/javascript'>alert('Formater');</script>.\n\n Test Auto Link www.ruby-china.com\n\nmail@domain.com\n\nTest Emoji tag <a href='<img class=\"emoji\" src=\"//l.ruby-china.org/assets/emojis/cat.png\" width=\"24\" height=\"24\" />'><img class=\"emoji\" src=\"//l.ruby-china.org/assets/emojis/four_leaf_clover.png\" width=\"24\" height=\"24\" /></a>:ruby-china:.
+=> "<img class=\"emoji\" src=\"//l.ruby-china.org/assets/emojis/four_leaf_clover.png\" />"
 ```
+----
 
 ``` ruby
-SimpleFormat.clean(string, {elements: [], attributes: { all: [] }})
+c.text_with(string) # 清除 HTML
 => "This is a :ruby: alert('Formater');.\n\n Test Auto Link www.ruby-china.com\n\nmail@domain.com\n\nTest Emoji tag 🍀:ruby-china:."
 
 ```

data/lib/simple_format.rb

@@ -5,36 +5,57 @@ require 'simple_format/auto_link'
 require 'sanitize' unless defined?(::Sanitize)
 
 module SimpleFormat
-  extend self
+  class Converter
+    def initialize(emoji=nil)
+      @emoji = emoji if emoji.is_a?(SimpleFormat::Emoji)
+    end
+
+    def rich_with(string) # 转 富文本
+      return string unless string
+      string = emoji_with(string)
+      string = nl2br(string).to_str
+      string = auto_link(string)
+      string = html_with(string)
+      return string
+    end
+
+    def emoji_with(string) # 表情符 转 <img>
+      emoji.replace_emoji_with_images(string)
+    end
+
+    def html_with(html, options = {})
+      options = { elements: sanitized_allowed_tags, attributes: { all: sanitized_allowed_attributes } } if options.empty?
+      Sanitize.clean(html, options)
+    end
+
+    def text_with(string) # 清除 html
+      Sanitize.clean(string, {elements: [], attributes: { all: [] }})
+    end
+
+    def nl2br(string) # 回车 转 <br />
+      if string
+        string.gsub("\n\r","<br />").gsub("\r", "").gsub("\n", "<br />")
+      end
+    end
+
+    def auto_link(string) # 链接转换
+      @auto_link ||= AutoLink.new
+      @auto_link.all(string) 
+    end
+
+    private
+
+    def emoji
+      @emoji || Emoji.new
+    end
+
+    def sanitized_allowed_tags
+      ['a', 'p', 'br', 'img', 'abbr', 'mark', 'm', 'fieldset', 'legend', 'label', 'summary', 'details', 'address', 'map', 'area', 'td', 'tr', 'th', 'thead', 'tbody', 'tfoot', 'caption', 'table', 'h4', 'h5', 'h6', 'hr', 'span', 'em', 'dl', 'dt', 'dd', 'b', 'del', 'ins', 'small', 'pre', 'blockquote', 'strong', 'audio', 'video', 'source', 'ul', 'ol', 'li', 'i', 'embed', 'sub', 'sup']
+    end
+
+    def sanitized_allowed_attributes
+      ['shape', 'coords', 'target', 'href', 'muted', 'volume', 'name', 'class', 'title', 'border', 'poster', 'loop', 'autoplay', 'allowfullscreen', 'fullscreen', 'align' , 'quality', 'allowscriptaccess', 'wmode', 'flashvars', 'webkit-playsinline', 'x-webkit-airplay', 'data-original', 'src', 'controls', 'preload', 'type', 'width', 'height', 'size', 'alt']
+    end
 
-  def h(string, size=64)
-    return string unless string
-    string = emoji.replace_emoji_with_images(string, size)
-    string = auto_link(string)
-    string = clean(string)
   end
-
-  def replace_emoji_with_images(string, size=64)
-    emoji.replace_emoji_with_images(string, size)
-  end
-
-  def clean(html, options = {})
-    options = { elements: sanitized_allowed_tags, attributes: { all: sanitized_allowed_attributes } } if options.empty?
-    Sanitize.clean(html, options)
-  end
-
-  def emoji
-    @emoji ||= Emoji.new
-  end
-
-  private
-
-  def sanitized_allowed_tags
-    ['a', 'p', 'br', 'img', 'abbr', 'mark', 'm', 'fieldset', 'legend', 'label', 'summary', 'details', 'address', 'map', 'area', 'td', 'tr', 'th', 'thead', 'tbody', 'tfoot', 'caption', 'table', 'h4', 'h5', 'h6', 'hr', 'span', 'em', 'dl', 'dt', 'dd', 'b', 'del', 'ins', 'small', 'pre', 'blockquote', 'strong', 'audio', 'video', 'source', 'ul', 'ol', 'li', 'i', 'embed', 'sub', 'sup']
-  end
-
-  def sanitized_allowed_attributes
-    ['shape', 'coords', 'target', 'href', 'muted', 'volume', 'name', 'class', 'title', 'border', 'poster', 'loop', 'autoplay', 'allowfullscreen', 'fullscreen', 'align' , 'quality', 'allowscriptaccess', 'wmode', 'flashvars', 'webkit-playsinline', 'x-webkit-airplay', 'data-original', 'src', 'controls', 'preload', 'type', 'width', 'height', 'size', 'alt']
-  end
-
 end

data/lib/simple_format/auto_link.rb

@@ -1,94 +1,72 @@
 # -*- encoding: utf-8 -*-
 
 module SimpleFormat
-  extend self
+  class AutoLink
 
-  def auto_link(text, *args, &block) #link = :all, html = {}, &block)
-    return text unless text
-
-    options = {}
-    unless args.empty?
-      options[:link] = args[0] || :all
-    end
-    options.merge!(:link => :all)
-    # 转换回行
-    text = nl2br(text).to_str
-    # 根据类型生成链接
-    case options[:link].to_sym
-      when :all             then auto_link_email_addresses(auto_link_urls(text, &block), &block)
-      when :email_addresses then auto_link_email_addresses(text, &block)
-      when :urls            then auto_link_urls(text, &block)
+    def initialize()
+      @regex = {
+            protocol: %r{(?: ((?:ed2k|ftp|http|https|irc|mailto|news|gopher|nntp|telnet|webcal|xmpp|callto|feed|svn|urn|aim|rsync|tag|ssh|sftp|rtsp|afs|file):)// | www\. )[^\s<]+}x,
+                href: [/<[^>]+$/, /^[^>]*>/, /<a\b.*?>/i, /<\/a>/i],
+                mail: /[\w.!#\$%+-]+@[\w-]+(?:\.[\w-]+)+/,
+            brackets: { ']' => '[', ')' => '(', '}' => '{' },
+        word_pattern: RUBY_VERSION < '1.9' ? '\w' : '\p{Word}'
+      }
     end
-  end
 
-  private
-  
-  def nl2br(string)
-    if string
-      string.gsub("\n\r","<br />").gsub("\r", "").gsub("\n", "<br />")
+    def all(text)
+      return text unless text
+      email_addresses( urls(text) )
     end
-  end
-
-  AUTO_LINK_RE = %r{
-    (?: ((?:ed2k|ftp|http|https|irc|mailto|news|gopher|nntp|telnet|webcal|xmpp|callto|feed|svn|urn|aim|rsync|tag|ssh|sftp|rtsp|afs|file):)// | www\. )
-    [^\s<]+
-  }x
-
-  # regexps for determining context, used high-volume
-  AUTO_LINK_CRE = [/<[^>]+$/, /^[^>]*>/, /<a\b.*?>/i, /<\/a>/i]
-
-  AUTO_EMAIL_RE = /[\w.!#\$%+-]+@[\w-]+(?:\.[\w-]+)+/
-
-  BRACKETS = { ']' => '[', ')' => '(', '}' => '{' }
 
-  WORD_PATTERN = RUBY_VERSION < '1.9' ? '\w' : '\p{Word}'
+    # Turns all urls into clickable links.  If a block is given, each url
+    # is yielded and the result is used as the link text.
+    def urls(text)
+      
+      text.gsub(@regex[:protocol]) do
+        scheme, href = $1, $&
+        punctuation = []
 
-  # Turns all urls into clickable links.  If a block is given, each url
-  # is yielded and the result is used as the link text.
-  def auto_link_urls(text)
-    
-    text.gsub(AUTO_LINK_RE) do
-      scheme, href = $1, $&
-      punctuation = []
-
-      if auto_linked?($`, $')
-        # do not change string; URL is already linked
-        href
-      else
-        # don't include trailing punctuation character as part of the URL
-        while href.sub!(/[^#{WORD_PATTERN}\/-]$/, '')
-          punctuation.push $&
-          if opening = BRACKETS[punctuation.last] and href.scan(opening).size > href.scan(punctuation.last).size
-            href << punctuation.pop
-            break
+        if auto_linked?($`, $')
+          # do not change string; URL is already linked
+          href
+        else
+          # don't include trailing punctuation character as part of the URL
+          while href.sub!(/[^#{@regex[:word_pattern]}\/-]$/, '')
+            punctuation.push $&
+            if opening = @regex[:brackets][punctuation.last] and href.scan(opening).size > href.scan(punctuation.last).size
+              href << punctuation.pop
+              break
+            end
           end
-        end
 
-        link_text = block_given?? yield(href) : href
-        href = 'http://' + href unless scheme
+          link_text = block_given?? yield(href) : href
+          href = '//' + href unless scheme
 
-        "<a href='#{href}' target='_blank'>#{link_text}</a>" + punctuation.reverse.join('')
+          "<a href='#{href}' target='_blank'>#{link_text}</a>" + punctuation.reverse.join('')
+        end
       end
     end
-  end
 
-  # Turns all email addresses into clickable links.  If a block is given,
-  # each email is yielded and the result is used as the link text.
-  def auto_link_email_addresses(text)
-    text.gsub(AUTO_EMAIL_RE) do
-      text = $&
-      if auto_linked?($`, $')
-        text
-      else
-        display_text = (block_given?) ? yield(text) : text
-        # mail_to text, display_text
-        "<a href='mailto:#{text}'>#{display_text}</a>"
+    # Turns all email addresses into clickable links.  If a block is given,
+    # each email is yielded and the result is used as the link text.
+    def email_addresses(text)
+      text.gsub(@regex[:mail]) do
+        text = $&
+        if auto_linked?($`, $')
+          text
+        else
+          display_text = (block_given?) ? yield(text) : text
+          # mail_to text, display_text
+          "<a href='mailto:#{text}'>#{display_text}</a>"
+        end
       end
     end
-  end
 
-  # Detects already linked context or position in the middle of a tag
-  def auto_linked?(left, right)
-    (left =~ AUTO_LINK_CRE[0] and right =~ AUTO_LINK_CRE[1]) or (left.rindex(AUTO_LINK_CRE[2]) and $' !~ AUTO_LINK_CRE[3])
+    private
+
+    # Detects already linked context or position in the middle of a tag
+    def auto_linked?(left, right)
+      (left =~ @regex[:href][0] and right =~ @regex[:href][1]) or (left.rindex(@regex[:href][2]) and $' !~ @regex[:href][3])
+    end
   end
 end

data/lib/simple_format/emoji.rb

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
 require 'multi_json' unless defined?(::MultiJson)
+require 'active_support/core_ext/string' unless ::String.respond_to?(:present?)
+require 'active_support/core_ext/object/inclusion' unless ::String.respond_to?(:in?)
 
 module SimpleFormat
   class Emoji
@@ -23,9 +25,10 @@ module SimpleFormat
       @emoji_name_regex = /:([a-z0-9\+\-_]+):/
       @emoji_unicode_regex = /#{@emoji_by_unicode.keys.join('|')}/
     end
+
     # 主机地址
     def asset_host
-      @asset_host || '//l.ruby-china.org'
+      @asset_host || 'emoji.qiniudn.com'
     end
     # 设置主机地址
     def asset_host=(host)
@@ -33,51 +36,69 @@ module SimpleFormat
     end
     # 资源路径 
     def asset_path
-      @asset_path || '/assets/emojis/'
+      @asset_path || '/'
     end
     # 设置路径
     def asset_path=(path)
       @asset_path = path
     end
+    # 图标尺寸
+    def asset_size
+      @asset_size || ''
+    end
+    # 设置图标尺寸
+    def asset_size=(size)
+      @asset_size = size
+    end
+    # 分隔符
+    def asset_delimiter
+      @asset_delimiter || '_'
+    end
+    def asset_delimiter=(delimiter)
+      @asset_delimiter = delimiter
+    end
     # 通过（名称、字符）替换表情 
-    def replace_emoji_with_images(string, size='64')
+    def replace_emoji_with_images(string)
       return string unless string
-
       html ||= string.dup
-      html = replace_name_with_images(html, size)
-      html = replace_unicode_with_images(html.to_str, size)
-      puts html
-      puts '_'*88 + 'replace_unicode_with_images'
+      html = replace_name_with_images(html)
+      html = replace_unicode_with_images(html.to_str)
       return html
     end
     # 通过（名称）替换表情 
-    def replace_name_with_images(string, size='64')
+    def replace_name_with_images(string)
       unless string && string.match(names_regex)
         return string
       end
 
       string.to_str.gsub(names_regex) do |match|
         if names.include?($1)
-          %Q{<img class="emoji" src="#{ image_url_for_name($1) }" width="#{size}" height="#{size}" />}
+          %Q{<img class="emoji" src="//#{ image_url_for_name($1) }" />}
         else
           match
         end
       end
     end
     # 通过（字符）替换表情 
-    def replace_unicode_with_images(string, size='64')
+    def replace_unicode_with_images(string)
       unless string && string.match(unicodes_regex)
         return string
       end
 
       html ||= string.dup
       html.gsub!(unicodes_regex) do |unicode|
-        %Q{<img class="emoji" src="#{ image_url_for_unicode(unicode) }" width="#{size}" height="#{size}" />}
+        %Q{<img class="emoji" src="//#{ image_url_for_unicode(unicode) }" />}
       end
     end
     # 通过（名称）合成图片地址
     def image_url_for_name(name)
-      "#{asset_host}#{ File.join(asset_path, name) }.png"
+      image_url = "#{asset_host}#{ File.join(asset_path, name) }.png"
+      if image_url.present?
+        if asset_size.present? && asset_size.in?(sizes)
+          image_url = [image_url, asset_size].join(asset_delimiter)
+        end
+      end
+      return image_url
     end
     # 通过（字符）合成图片地址
     def image_url_for_unicode(unicode)
@@ -108,5 +129,12 @@ module SimpleFormat
     def unicodes_regex
       @emoji_unicode_regex
     end
+    
+    private
+
+    # 尺寸
+    def sizes
+      %W(16x16 24x24 32x32 48x48 56x56)
+    end
   end
 end

data/lib/simple_format/version.rb

@@ -1,3 +1,3 @@
 module SimpleFormat
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,79 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: simple_format
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Howl王
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: sanitize
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+  prerelease: false
+  type: :development
+description:
 email:
 - howl.wong@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -88,24 +88,24 @@ homepage: https://github.com/mimosa/simple_format/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
 specification_version: 4
 summary: Returns text transformed into HTML using simple formatting rules.
 test_files: []