emojimmy 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537d4a671f8d4f03de4905c27435d57b53d9b72b
-  data.tar.gz: 262e130bc35f71d5d0a33d38094a7b9aa3ed92ee
+  metadata.gz: 6685f81445ccf98ccc717eca34550679da23de6c
+  data.tar.gz: cd0149baa61ea77ac10f98938fb596528a9f9645
 SHA512:
-  metadata.gz: 13be2c19665b325c30b618df13053418294c8cafb0f91afde16252e3ac15bf45e9a3616b28b08cdd4d477371831a7666ac32ed32c6ffa160d7b9036ceea31030
-  data.tar.gz: 210b4ecd796feb3b7cdd1b4c02450502c9131d358c7161a11e5708d6e02fe87faecb92980e58088b072b8ef4f02ce11a7bc64ca4f5b1e6fe86c42c02a0db4935
+  metadata.gz: e6e3939944d4120e6953db4c5c29d38f8cfa77bcf0d3a2a7e751167fce287ab3fe47c22367851a8be470b96899207999431969b133cef90ca96b179d235e36f5
+  data.tar.gz: 3dbe38216a0779620e3ed6aec197e16e62d646e8d88353549b3c50daeeaa253549c6b77c54ecbaa30b4711463b3c7f0e5fad1c9dc75c13039df173384ff19ca0

data/README.md

@@ -2,6 +2,14 @@
 
 Emojimmy makes it possible to store emoji characters in ActiveRecord datastores that don’t support *4-Byte UTF-8 Unicode* (`utf8mb4`) encoding.
 
+You probably should be using a database that supports `utf8mb4` though (and not this gem), like PostgreSQL or MySQL (5.5+). We built this gem because stock [Heroku](http://heroku.com) machines cannot compile the `mysql2` gem to use the `utf8mb4` encoding (because they ship with an old version of `libmysqlclient`).
+
+<a href="https://rubygems.org/gems/emojimmy"><img src="https://badge.fury.io/rb/emojimmy.png" /></a>
+<a href="https://codeclimate.com/github/mirego/emojimmy"><img src="https://codeclimate.com/github/mirego/emojimmy.png" /></a>
+<a href='https://coveralls.io/r/mirego/emojimmy?branch=master'><img src='https://coveralls.io/repos/mirego/emojimmy/badge.png?branch=master' /></a>
+<a href='https://gemnasium.com/mirego/emojimmy'><img src="https://gemnasium.com/mirego/emojimmy.png" /></a>
+<a href="https://travis-ci.org/mirego/emojimmy"><img src="https://travis-ci.org/mirego/emojimmy.png?branch=master" /></a>
+
 ---
 
 ## Installation
@@ -21,6 +29,8 @@ First, you must enable Emojimmy in an initializer (when your application boots):
 Emojimmy.initialize!
 ```
 
+#### ActiveRecord
+
 Then, you can edit your models to specify which fields will be storing emoji characters:
 
 ```ruby
@@ -46,6 +56,18 @@ Your model will now be able to store emoji characters in its `body` column.
 @comment.read_attribute(:body) # => "Hello! {U+1F601}"
 ```
 
+#### Custom
+
+If you only want to use Emojimmy’s conversion methods, you can use two methods, `token_to_emoji` and `emoji_to_token`:
+
+```ruby
+Emojimmy.emoji_to_token("Hello! \xF0\x9F\x98\x81")
+# => "Hello! {U+1F601}"
+
+Emojimmy.token_to_emoji("Hello! {U+1F601}")
+# => "Hello! \xF0\x9F\x98\x81"
+```
+
 ## License
 
 `Emojimmy` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/emojimmy/blob/master/LICENSE.md) file.

data/lib/emojimmy/extensions.rb

@@ -0,0 +1,8 @@
+class ActiveRecord::Base
+  def self.stores_emoji_characters(options = {})
+    return unless table_exists?
+
+    options[:in] ||= []
+    Emojimmy::Mixin.inject_methods(self, options[:in])
+  end
+end

data/lib/emojimmy/mixin.rb

@@ -5,12 +5,16 @@ module Emojimmy
         model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           # Before saving the record, convert the attribute value
           before_save do
-            self.#{attribute} = Emojimmy.emoji_to_text(self.#{attribute})
+            unless respond_to?("#{attribute}=")
+              raise ArgumentError.new('#{model} must respond to #{attribute}= in order for Emojimmy to store emoji characters in it.')
+            end
+
+            self.#{attribute} = Emojimmy.emoji_to_token(self.#{attribute})
           end
 
           # When calling the attribute name, convert its value
           def #{attribute}
-            Emojimmy.text_to_emoji(read_attribute(#{attribute.inspect}))
+            Emojimmy.token_to_emoji(read_attribute(#{attribute.inspect}))
           end
         RUBY
       end

data/lib/emojimmy/version.rb

@@ -1,3 +1,3 @@
 module Emojimmy
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/emojimmy.rb

@@ -6,58 +6,56 @@ require 'active_record'
 
 # Modules
 require 'emojimmy/mixin'
+require 'emojimmy/extensions'
 
 module Emojimmy
   DATA_FILE = File.expand_path('../../data/emoji.txt', __FILE__)
+  TOKEN_REGEXP = /({U\+[^}]+})/
 
-  # Load emoji data from config/emoji.txt and build the `text_to_emoji`
-  # and `emoji_to_text` hash tables
+  # Load emoji data from config/emoji.txt and build the `token_to_emoji`
+  # and `emoji_to_token` hash tables
   def self.initialize!
     content = File.read(DATA_FILE).each_line.to_a
     build_hash_tables(content)
   end
 
   # Loop through all emoji and replace them with
-  # their matching text equivalent
-  def self.emoji_to_text(content)
-    @emoji_to_text.each_pair do |emoji, text|
-      content = content.gsub(emoji, text)
+  # their matching token
+  def self.emoji_to_token(content)
+    return content unless content.present?
+
+    content.dup.tap do |content|
+      @emoji_to_token.each_pair do |emoji, token|
+        content.gsub!(emoji, token)
+      end
     end
-
-    content
   end
 
-  # Loop through each {U+...} part in the string and
+  # Loop through each {U+...} token in the string and
   # convert it to the matching emoji
-  def self.text_to_emoji(content)
-    content.gsub /({U\+[^}]+})/ do |data|
-      @text_to_emoji[data]
-    end
+  def self.token_to_emoji(content)
+    return content unless content.present?
+
+    content.gsub(TOKEN_REGEXP) { |data| @token_to_emoji[data] }
   end
 
 private
 
-  # Build or `emoji_to_text` and `text_to_emoji` hash tables
+  # Build or `emoji_to_token` and `token_to_emoji` hash tables
   def self.build_hash_tables(content)
-    @emoji_to_text = {}
-    @text_to_emoji = {}
+    @emoji_to_token = {}
+    @token_to_emoji = {}
 
     content.each do |line|
-      line = line.chomp.split("\t")
-      emoji = eval('"' + line[1] + '"')
-      text = "{#{line[0]}}"
-
-      @emoji_to_text[emoji] = text
-      @text_to_emoji[text] = emoji
-    end
-  end
-end
+      token, emoji = line.chomp.split("\t")
+      token = "{#{token}}"
 
-class ActiveRecord::Base
-  def self.stores_emoji_characters(options = {})
-    return unless table_exists?
+      # We use `eval` here to convert
+      # "\\xF0\\x9F\\x98\\x81" into "\xF0\x9F\x98\x81"
+      emoji = eval('"' + emoji + '"')
 
-    options[:in] ||= []
-    Emojimmy::Mixin.inject_methods(self, options[:in])
+      @emoji_to_token[emoji] = token
+      @token_to_emoji[token] = emoji
+    end
   end
 end

data/spec/emojimmy/mixin_spec.rb

@@ -9,52 +9,74 @@ describe Emojimmy::Mixin do
           t.text :body
         end
       end
-
-      spawn_emojimmy_model 'Comment', in: [:body]
     end
 
-    describe :InstanceMethod do
-      subject { Comment.create(body: body) }
-
-      context 'with a single emoji' do
-        let(:body) { "Hello, 😁😁 world!" }
-        it { should be_persisted }
-        its(:body) { should eql body }
+    context 'with invalid options for `in`' do
+      before do
+        spawn_emojimmy_model 'Comment', in: [:foo]
       end
 
-      context 'with multiple emoji' do
-        let(:body) { "Hello, 😁😁😁 😍 world!" }
-        it { should be_persisted }
-        its(:body) { should eql body }
+      specify do
+        expect {
+          Comment.create(body: 'Hello.')
+        }.to raise_error(ArgumentError, 'Comment must respond to foo= in order for Emojimmy to store emoji characters in it.')
       end
+    end
 
-      context 'without any emoji' do
-        let(:body) { "Hello, boring world!" }
-        it { should be_persisted }
-        its(:body) { should eql body }
+    context 'with valid options for `in`' do
+      before do
+        spawn_emojimmy_model 'Comment', in: [:body]
       end
-    end
 
-    describe :Callback do
-      subject { Comment.create(body: body) }
-      let(:persisted_body) { subject.read_attribute(:body) }
+      describe :InstanceMethod do
+        subject { Comment.create(body: body) }
 
-      context 'with a single emoji' do
-        let(:body) { "Hello, 😁 world!" }
-        it { should be_persisted }
-        it { expect(persisted_body).to eql "Hello, {U+1F601} world!" }
-      end
+        context 'with a single emoji' do
+          let(:body) { "Hello, 😁😁 world!" }
+          it { should be_persisted }
+          its(:body) { should eql body }
+        end
+
+        context 'with multiple emoji' do
+          let(:body) { "Hello, 😁😁😁 😍 world!" }
+          it { should be_persisted }
+          its(:body) { should eql body }
+        end
 
-      context 'with multiple emoji' do
-        let(:body) { "Hello, 😁😁 😍 world!" }
-        it { should be_persisted }
-        it { expect(persisted_body).to eql "Hello, {U+1F601}{U+1F601} {U+1F60D} world!" }
+        context 'without any emoji' do
+          let(:body) { "Hello, boring world!" }
+          it { should be_persisted }
+          its(:body) { should eql body }
+        end
+
+        context 'with a nil value' do
+          let(:body) { nil }
+          it { should be_persisted }
+          its(:body) { should eql body }
+        end
       end
 
-      context 'without any emoji' do
-        let(:body) { "Hello, boring world!" }
-        it { should be_persisted }
-        it { expect(persisted_body).to eql "Hello, boring world!" }
+      describe :Callback do
+        subject { Comment.create(body: body) }
+        let(:persisted_body) { subject.read_attribute(:body) }
+
+        context 'with a single emoji' do
+          let(:body) { "Hello, 😁 world!" }
+          it { should be_persisted }
+          it { expect(persisted_body).to eql "Hello, {U+1F601} world!" }
+        end
+
+        context 'with multiple emoji' do
+          let(:body) { "Hello, 😁😁 😍 world!" }
+          it { should be_persisted }
+          it { expect(persisted_body).to eql "Hello, {U+1F601}{U+1F601} {U+1F60D} world!" }
+        end
+
+        context 'without any emoji' do
+          let(:body) { "Hello, boring world!" }
+          it { should be_persisted }
+          it { expect(persisted_body).to eql "Hello, boring world!" }
+        end
       end
     end
   end

data/spec/emojimmy_spec.rb

@@ -2,21 +2,21 @@
 require 'spec_helper'
 
 describe Emojimmy do
-  describe :text_to_emoji do
-    let(:stored_comment) { 'Hello {U+1F601}{U+1F601} you {U+1F608} {U+1F438}!' }
-    let(:returned_comment) { 'Hello 😁😁 you 😈 🐸!' }
+  describe :token_to_emoji do
+    let(:stored_text) { 'Hello {U+1F601}{U+1F601} you {U+1F608} {U+1F438}!' }
+    let(:returned_text) { 'Hello 😁😁 you 😈 🐸!' }
 
     specify do
-      expect(Emojimmy.text_to_emoji(stored_comment)).to eql returned_comment
+      expect(Emojimmy.token_to_emoji(stored_text)).to eql returned_text
     end
   end
 
-  describe :emoji_to_text do
-    let(:received_comment) { 'Hello 😁😁 you 😈 🐸!' }
-    let(:stored_comment) { 'Hello {U+1F601}{U+1F601} you {U+1F608} {U+1F438}!' }
+  describe :emoji_to_token do
+    let(:received_text) { 'Hello 😁😁 you 😈 🐸!' }
+    let(:stored_text) { 'Hello {U+1F601}{U+1F601} you {U+1F608} {U+1F438}!' }
 
     specify do
-      expect(Emojimmy.emoji_to_text(received_comment)).to eql stored_comment
+      expect(Emojimmy.emoji_to_token(received_text)).to eql stored_text
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emojimmy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Rémi Prévost
@@ -114,6 +114,7 @@ files:
 - gemfiles/Gemfile.activerecord-3.2.x
 - gemfiles/Gemfile.activerecord-4.0
 - lib/emojimmy.rb
+- lib/emojimmy/extensions.rb
 - lib/emojimmy/mixin.rb
 - lib/emojimmy/version.rb
 - spec/emojimmy/mixin_spec.rb