twemojify 0.4.1

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.idea
+*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'minitest'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Thomas Tuttle
+
+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,147 @@
+Twemojify
+=========
+
+Twemojify is a bare-bones port of the official Twitter [twemoji](https://github.com/twitter/twemoji) javascript library.
+
+
+Installation
+------------
+
+Include the gem in you Gemfile:
+
+```ruby
+gem "twemojify"
+```
+
+Or install directly:
+
+```bash
+gem install twemojify
+```
+
+
+Usage
+-----
+
+### parse
+
+The core functionality of the Twemojify library:
+
+```ruby
+Twemojify.parse("I \u2764 emoji!")
+```
+
+This method takes the string and returns an html string parsed with the default configuration.
+
+```
+I <img class="emoji" draggable="false" alt="❤" src="//twemoji.maxcdn.com/36x36/2764.png"> emoji!
+```
+
+You can also pass in options, like so:
+
+```ruby
+Twemojify.parse("I \u2764 emoji!", :size => '64x64',:ext => '.jpg')
+```
+
+Which returns:
+
+```
+I <img class="emoji" draggable="false" alt="❤" src="//twemoji.maxcdn.com/64x64/2764.jpg"> emoji!
+```
+
+### test
+
+The test method attempts to find the first emoji in a string:
+
+```ruby
+# returns 2
+Twemojify.test("I \u2764 emoji!")
+
+# returns nil
+Twemojify.test("I love emoji!")
+```
+
+### Rails Helper
+
+Twemojify includes a basic rails helper to access the parse method.
+
+```
+<p><%= twemojify(@comment.body) %><p>
+```
+
+
+Configuration
+-------------
+
+Default values from the original Twitter library are used, but can be customized through an initializer.
+
+```ruby
+# config/initializers/twemojify.rb
+Twemojify.configure do |config|
+  config.base = '//twemoji.maxcdn.com/'
+  config.ext = '.png'
+  config.size = '36x36'
+  config.class_name = 'emoji'
+  config.folder = nil
+end
+```
+
+
+Options
+-------
+
+#### base
+
+Indicates the base url to prepend to the emoji img src. You can change the base to point to local assets on your own servers.
+
+#### ext
+
+The file extension used for the emoji.
+
+#### size
+
+Size of the emoji, default sizes follow a ```[width]x[height]``` format, but you can include any kind of custom sizes
+
+#### class_name
+
+The class assigned the img tags created by the parse method.
+
+#### folder
+
+Used to point to svg and other custom resources that don't require sizes. Overrides the size option.
+
+
+Notes
+-----
+
+#### Parsing HTML
+
+Be careful when using the parse method with html string, as it does not sanitize the string nor
+check if the string has already been parsed.
+
+#### Features NOT included from the original Twitter library
+
+- DOM parsing (currently uses a simple regex match)
+- Recognize control characters
+
+
+Twitter Attribution Requirements
+--------------------------------
+
+From the official twitter library [readme](https://github.com/twitter/twemoji/blob/gh-pages/README.md):
+
+> As an open source project, attribution is critical from a legal, practical and motivational perspective in our opinion. The graphics are licensed under the CC-BY 4.0 which has a pretty good guide on [best practices for attribution](https://wiki.creativecommons.org/Best_practices_for_attribution). 
+
+> However, we consider the guide a bit onerous and as a project, will accept a mention in a project README or an 'About' section or footer on a website. In mobile applications, a common place would be in the Settings/About section (for example, see the mobile Twitter application Settings->About->Legal section). We would consider a mention in the HTML/JS source sufficient also.
+
+
+License
+-------
+
+Copyright 2015 Thomas Tuttle
+
+MIT License: [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT)
+
+
+
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r twemojify.rb"
+end

data/lib/twemojify.rb

@@ -0,0 +1,29 @@
+require 'twemojify/configuration'
+require 'twemojify/version'
+require 'twemojify/railtie' if defined?(Rails)
+
+module Twemojify
+  extend Configuration
+
+  MATCH_REG_EX = /\u{a9}|\u{ae}|\u{203c}|\u{2049}|\u{2122}|\u{2139}|[\u{2194}-\u{2199}]|[\u{21a9}-\u{21aa}]|[\u{231a}-\u{231b}]|[\u{23e9}-\u{23ec}]|\u{23f0}|\u{23f3}|\u{24c2}|[\u{25aa}-\u{25ab}]|\u{25b6}|\u{25c0}|[\u{25fb}-\u{25fe}]|[\u{2600}-\u{2601}]|\u{260e}|\u{2611}|[\u{2614}-\u{2615}]|\u{261d}|\u{263a}|[\u{2648}-\u{2653}]|\u{2660}|\u{2663}|[\u{2665}-\u{2666}]|\u{2668}|\u{267b}|\u{267f}|\u{2693}|[\u{26a0}-\u{26a1}]|[\u{26aa}-\u{26ab}]|[\u{26bd}-\u{26be}]|[\u{26c4}-\u{26c5}]|\u{26ce}|\u{26d4}|\u{26ea}|[\u{26f2}-\u{26f3}]|\u{26f5}|\u{26fa}|\u{26fd}|\u{2702}|\u{2705}|[\u{2708}-\u{270c}]|\u{270f}|\u{2712}|\u{2714}|\u{2716}|\u{2728}|[\u{2733}-\u{2734}]|\u{2744}|\u{2747}|\u{274c}|\u{274e}|[\u{2753}-\u{2755}]|\u{2757}|\u{2764}|[\u{2795}-\u{2797}]|\u{27a1}|\u{27b0}|\u{27bf}|[\u{2934}-\u{2935}]|[\u{2b05}-\u{2b07}]|[\u{2b1b}-\u{2b1c}]|\u{2b50}|\u{2b55}|\u{3030}|\u{303d}|\u{3297}|\u{3299}|\u{e50a}|\u{1f004}|\u{1f0cf}|[\u{1f170}-\u{1f171}]|[\u{1f17e}-\u{1f17f}]|\u{1f18e}|[\u{1f191}-\u{1f19a}]|[\u{1f1e6}-\u{1f1ff}]|[\u{1f201}-\u{1f202}]|\u{1f21a}|\u{1f22f}|[\u{1f232}-\u{1f23a}]|[\u{1f250}-\u{1f251}]|[\u{1f300}-\u{1f320}]|[\u{1f330}-\u{1f335}]|[\u{1f337}-\u{1f37c}]|[\u{1f380}-\u{1f393}]|[\u{1f3a0}-\u{1f3c4}]|[\u{1f3c6}-\u{1f3ca}]|[\u{1f3e0}-\u{1f3f0}]|[\u{1f400}-\u{1f43e}]|\u{1f440}|[\u{1f442}-\u{1f4f7}]|[\u{1f4f9}-\u{1f4fc}]|[\u{1f500}-\u{1f53d}]|[\u{1f550}-\u{1f567}]|[\u{1f5fb}-\u{1f640}]|[\u{1f645}-\u{1f64f}]|\u{1f1e8}\u{1f1f3}|\u{1f1e9}\u{1f1ea}|\u{1f1ea}\u{1f1f8}|\u{1f1eb}\u{1f1f7}|\u{1f1ec}\u{1f1e7}|\u{1f1ee}\u{1f1f9}|\u{1f1ef}\u{1f1f5}|\u{1f1f0}\u{1f1f7}|\u{1f1f7}\u{1f1fa}|\u{1f1fa}\u{1f1f8}|\u{23}\u{20e3}|\u{30}\u{20e3}|\u{31}\u{20e3}|\u{32}\u{20e3}|\u{33}\u{20e3}|\u{34}\u{20e3}|\u{35}\u{20e3}|\u{36}\u{20e3}|\u{37}\u{20e3}|\u{38}\u{20e3}|\u{39}\u{20e3}/.freeze
+
+  def self.parse(str, options = {})
+    options = Twemojify.options.merge(options)
+
+    if !str.nil?
+      str.gsub(MATCH_REG_EX) do |match|
+        %Q|<img class="#{options[:class_name]}" draggable="false" alt="#{match}" src="#{options[:base]}#{options[:folder]||options[:size]}/#{get_codepoint(match)}#{options[:ext]}">|
+      end
+    end
+  end
+
+  def self.test(str)
+    str =~ MATCH_REG_EX
+  end
+
+  private
+
+  def self.get_codepoint(match)
+    match.codepoints.map { |a| a.to_s(16) }.join('-')
+  end
+end

data/lib/twemojify/configuration.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../utils', __FILE__)
+
+module Twemojify
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+        :base,
+        :ext,
+        :size,
+        :class_name,
+        :folder
+    ]
+
+    DEFAULT_BASE = '//twemoji.maxcdn.com/'.freeze
+    DEFAULT_EXT = '.png'.freeze
+    DEFAULT_SIZE = '36x36'.freeze
+    DEFAULT_CLASS_NAME = 'emoji'.freeze
+    DEFAULT_FOLDER = nil
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def size=(value)
+      @size = Utils.to_size_squared_asset(value)
+    end
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.base = DEFAULT_BASE
+      self.ext = DEFAULT_EXT
+      self.size = DEFAULT_SIZE
+      self.class_name = DEFAULT_CLASS_NAME
+      self.folder = DEFAULT_FOLDER
+    end
+  end
+end

data/lib/twemojify/railtie.rb

@@ -0,0 +1,9 @@
+require 'twemojify/view_helpers'
+
+module Twemojify
+  class Railtie < Rails::Railtie
+    initializer 'twemojify.view_helpers' do
+      ActiveSupport.on_load( :action_view ){ include Twemojify::ViewHelpers }
+    end
+  end
+end

data/lib/twemojify/utils.rb

@@ -0,0 +1,7 @@
+module Twemojify
+  module Utils
+    def self.to_size_squared_asset(value)
+      value.is_a?(Integer) ? "#{value}x#{value}" : value
+    end
+  end
+end

data/lib/twemojify/version.rb

@@ -0,0 +1,3 @@
+module Twemojify
+  VERSION = '0.4.1'
+end

data/lib/twemojify/view_helpers.rb

@@ -0,0 +1,7 @@
+module Twemojify
+  module ViewHelpers
+    def twemojify(text, options = {})
+      Twemojify.parse(html_escape(text), options).html_safe
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest'
+require 'minitest/autorun'
+require 'twemojify'

data/test/test_twemojify.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class TwemojifyTest < Minitest::Test
+  def setup
+    Twemojify.reset
+  end
+
+  def test_default_parsing
+    assert_equal 'I <img class="emoji" draggable="false" alt="' + "\u2764" + '" src="' + Twemojify.base + '36x36/2764.png"> emoji!',
+                 Twemojify.parse("I \u2764 emoji!")
+  end
+
+  def test_configure_block
+    Twemojify.configure do |config|
+      config.size = '48x48'
+      config.base = '/base/'
+    end
+
+    assert_equal 'I <img class="emoji" draggable="false" alt="' + "\u2764" + '" src="/base/48x48/2764.png"> emoji!',
+                 Twemojify.parse("I \u2764 emoji!")
+  end
+
+  def test_parse_method_options
+    assert_equal 'I <img class="emoji" draggable="false" alt="' + "\u2764" + '" src="' + Twemojify.base + '64x64/2764.jpg"> emoji!',
+                 Twemojify.parse("I \u2764 emoji!", :size => '64x64',:ext => '.jpg')
+  end
+
+  def test_folder_option
+    Twemojify.folder = 'custom'
+    assert_equal 'I <img class="emoji" draggable="false" alt="' + "\u2764" + '" src="' + Twemojify.base + 'custom/2764.png"> emoji!',
+                 Twemojify.parse("I \u2764 emoji!")
+  end
+
+  def test_test_method
+    assert_equal(2, Twemojify.test("I \u2764 emoji!"))
+    assert_equal(nil, Twemojify.test("I emoji!"))
+  end
+end

data/twemojify.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'twemojify/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'twemojify'
+  s.version     = Twemojify::VERSION
+  s.summary     = "Ruby port of the official Twitter twemoji library."
+  s.description = "Ruby port of the official Twitter twemoji library."
+  s.licenses    = ['MIT']
+  s.homepage    = 'http://github.com/postliminary/twemojify'
+
+  s.authors     = ["Thomas Tuttle"]
+  s.email       = 'thomas@postlimiary.com'
+
+  s.require_paths  = ["lib"]
+  s.files          = `git ls-files`.split("\n")
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: twemojify
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Tuttle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies: []
+description: Ruby port of the official Twitter twemoji library.
+email: thomas@postlimiary.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/twemojify.rb
+- lib/twemojify/configuration.rb
+- lib/twemojify/railtie.rb
+- lib/twemojify/utils.rb
+- lib/twemojify/version.rb
+- lib/twemojify/view_helpers.rb
+- test/test_helper.rb
+- test/test_twemojify.rb
+- twemojify.gemspec
+homepage: http://github.com/postliminary/twemojify
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Ruby port of the official Twitter twemoji library.
+test_files:
+- test/test_helper.rb
+- test/test_twemojify.rb