emojimmy 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c98273697d88126f8b5e4c7eab080ffe7da2d4b6
-  data.tar.gz: dd302c23d485e6f963f19d5f1d0114a044a6e404
+  metadata.gz: ddff8b1900275b1b84108e6c5618684c1b83960a
+  data.tar.gz: bb3395a5113d4da945df785e92d4ddcb0d5cedb6
 SHA512:
-  metadata.gz: df29c9cda1078629248d5f72b1cf1367c0215d47a0dc52decddf69c480e451a51351f57a4cbf45cc7439d49f7946916728c20952124ef7e3ebe02dbe01731c5f
-  data.tar.gz: 9cafb78e4d067bcd4d19caa4b8dc8e657d2523411fc325884264782d6d6da1bfef2a201e6ecd397d5551103fecc7466f35c584e05464d9e0fdec4761dafbb85f
+  metadata.gz: 3a64f89dfcc71793fab9043b9d9832580762ee7516ccb8389f160af966279efcac2637ddc3f6b63a2e97ec239657b380e9e47e0bce972b69ad427d1e030f15ee
+  data.tar.gz: d3731889f19f1a9d9bea442bbaa0c7e56b2590977d1e681cf15be144ef7cb29b40b9b14c4b9e6718ca3ddd892dea712e2af17cedebef9828b0fe2f95b6687342

data/.rspec

@@ -0,0 +1 @@
+--colour

data/emojimmy.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activerecord', '>= 3.0.0'
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'sqlite3'
 end

data/lib/emojimmy/mixin.rb

@@ -0,0 +1,19 @@
+module Emojimmy
+  module Mixin
+    def self.inject_methods(model, attributes)
+      attributes.each do |attribute|
+        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})
+          end
+
+          # When calling the attribute name, convert its value
+          def #{attribute}
+            Emojimmy.text_to_emoji(read_attribute(#{attribute.inspect}))
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/emojimmy/version.rb

@@ -1,3 +1,3 @@
 module Emojimmy
-  VERSION = '0.1'
+  VERSION = '0.1.1'
 end

data/lib/emojimmy.rb

@@ -1,5 +1,11 @@
 require 'emojimmy/version'
 
+# Dependencies
+require 'active_record'
+
+# Modules
+require 'emojimmy/mixin'
+
 module Emojimmy
   # Load emoji data from config/emoji.txt and build the `text_to_emoji`
   # and `emoji_to_text` hash tables
@@ -35,3 +41,12 @@ module Emojimmy
     end
   end
 end
+
+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/spec/emojimmy/mixin_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Emojimmy::Mixin do
+  describe :inject_methods do
+    before do
+      run_migration do
+        create_table(:comments, force: true) do |t|
+          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, \xF0\x9F\x98\x81 world!" }
+        it { should be_persisted }
+        its(:body) { should eql body }
+      end
+
+      context 'with multiple emoji' do
+        let(:body) { "Hello, \xF0\x9F\x98\x81\xF0\x9F\x98\x81 \xF0\x9F\x98\x8D world!" }
+        it { should be_persisted }
+        its(:body) { should eql body }
+      end
+
+      context 'without any emoji' do
+        let(:body) { "Hello, boring world!" }
+        it { should be_persisted }
+        its(:body) { should eql body }
+      end
+    end
+
+    describe :Callback do
+      subject { Comment.create(body: body) }
+      let(:persisted_body) { subject.read_attribute(:body) }
+
+      context 'with a single emoji' do
+        let(:body) { "Hello, \xF0\x9F\x98\x81 world!" }
+        it { should be_persisted }
+        it { expect(persisted_body).to eql "Hello, {U+1F601} world!" }
+      end
+
+      context 'with multiple emoji' do
+        let(:body) { "Hello, \xF0\x9F\x98\x81\xF0\x9F\x98\x81 \xF0\x9F\x98\x8D 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/spec_helper.rb

@@ -4,10 +4,23 @@ require 'coveralls'
 Coveralls.wear!
 
 require 'rspec'
+require 'sqlite3'
 require 'emojimmy'
 
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/**/*.rb', __FILE__)].map(&method(:require))
+
 RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+  config.include ModelMacros
+
   config.before :suite do
     Emojimmy.initialize!
   end
+
+  config.before :each do
+    adapter = ENV['DB_ADAPTER'] || 'sqlite3'
+    setup_database(adapter: adapter, database: 'emojimmy_test')
+  end
 end

data/spec/support/macros/database/database_adapter.rb

@@ -0,0 +1,9 @@
+class DatabaseAdapter
+  def initialize(opts = {})
+    @database = opts[:database]
+  end
+
+  def establish_connection!
+    ActiveRecord::Base.establish_connection(database_configuration)
+  end
+end

data/spec/support/macros/database/sqlite3_adapter.rb

@@ -0,0 +1,14 @@
+require_relative 'database_adapter'
+
+class Sqlite3Adapter < DatabaseAdapter
+  def database_configuration
+    {
+      adapter: 'sqlite3',
+      database: ':memory:'
+    }
+  end
+
+  def reset_database!
+    ActiveRecord::Base.connection.execute("select 'drop table ' || name || ';' from sqlite_master where type = 'table';")
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,22 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { self.instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+
+  def setup_database(opts = {})
+    adapter = "#{opts[:adapter].capitalize}Adapter".constantize.new(database: opts[:database])
+    adapter.establish_connection!
+    adapter.reset_database!
+
+    # Silence everything
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,18 @@
+module ModelMacros
+  # Create a new Emojimmy-powered model
+  def spawn_emojimmy_model(klass_name, options = {}, &block)
+    spawn_model klass_name do
+      stores_emoji_characters options
+      instance_exec(&block) if block
+    end
+  end
+
+  protected
+
+  # Create a new model class
+  def spawn_model(klass_name, parent_klass = ActiveRecord::Base, &block)
+    Object.instance_eval { remove_const klass_name } if Object.const_defined?(klass_name)
+    Object.const_set(klass_name, Class.new(parent_klass))
+    Object.const_get(klass_name).class_eval(&block) if block_given?
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emojimmy
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Rémi Prévost
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2013-10-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Emojimmy makes it possible to store emoji characters in datastore that
   don’t support 4-Byte UTF-8 Unicode encoding.
 email:
@@ -75,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE.md
@@ -85,9 +114,15 @@ files:
 - gemfiles/Gemfile.activerecord-3.2.x
 - gemfiles/Gemfile.activerecord-4.0
 - lib/emojimmy.rb
+- lib/emojimmy/mixin.rb
 - lib/emojimmy/version.rb
+- spec/emojimmy/mixin_spec.rb
 - spec/emojimmy_spec.rb
 - spec/spec_helper.rb
+- spec/support/macros/database/database_adapter.rb
+- spec/support/macros/database/sqlite3_adapter.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
 homepage: http://open.mirego.com/emojimmy
 licenses:
 - BSD 3-Clause
@@ -114,5 +149,10 @@ specification_version: 4
 summary: Emojimmy makes it possible to store emoji characters in datastore that don’t
   support 4-Byte UTF-8 Unicode encoding.
 test_files:
+- spec/emojimmy/mixin_spec.rb
 - spec/emojimmy_spec.rb
 - spec/spec_helper.rb
+- spec/support/macros/database/database_adapter.rb
+- spec/support/macros/database/sqlite3_adapter.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb