emojidex 0.0.23 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1f1c37ec62d2ad3daa5af377d01369009f4d734
-  data.tar.gz: aa303bb871cb90133a0607a5fe2c50ff7af35162
+  metadata.gz: fcc13aecee9337bf14e28469269706c2cb3d1591
+  data.tar.gz: e75c72d4d8edd241c833ca7ecb0fb36a9fc350cf
 SHA512:
-  metadata.gz: 96ad63027965d46efa54858616f1b5409b8e7cab814ee9d6114ae8273351b993584ca914baccd906dc1d5e0351852eb08f639ca00c5f90e9ddfb6717639c6838
-  data.tar.gz: 32bc08ccfe71137b7cc2c900870cbf8e66d5b58e696e0f82e2f969ead86b1514f3baa41ab7a852aca32ab7271d241283e00ae7b0ac669153e2be94bab77c9c0f
+  metadata.gz: 3c33ca861d40126c552df6af929454c09d1431a00b28c83f5b387b885f13eefb61aaeaa549b59b79997283a7334c0874ea81855ac00bc23780efdf9bb51d04b3
+  data.tar.gz: a77e1f5cedd7308b28fa0f6a267ce746748ef9ebdcbe1430c19c25d12e4fa4b15cf5a3e1bcf105c4ac1c282c7669b41cbe8c960ab58472a140d4fd4a609695e2

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.rubocop.yml

@@ -7,6 +7,9 @@ AsciiComments:
 AccessorMethodName:
   Enabled: false
 
+Style/DefWithParentheses:
+  Enabled: false
+
 LineLength:
   Max: 99
 

data/.travis.yml

@@ -1,17 +1,18 @@
 language: ruby
 
+sudo: false
+
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.5
-  - 2.2.0
+  - 2.1
+  - 2.2.3
+  - ruby-head
   - rbx
-
-bundler_args: -j4 --without development
+  - jruby-head
 
 script:
   - bundle exec rspec
 
 addons:
   code_climate:
-    repo_token: 4f9c56a5c9a2e99acd8e8f06491940f9174c6fd1e22236539bb2cbc2fefd0e30
+    repo_token: 1b416949c15b406b4606ead9dc3b29821f3700555aa869e359820a23b95c32a8

data/Gemfile

@@ -12,9 +12,7 @@ group :development do
 end
 
 group :test do
-  gem 'coveralls', require: false
   gem 'rspec'
-  gem 'webmock'
   gem 'emojidex-vectors', github: 'emojidex/emojidex-vectors'
   gem 'emojidex-rasters', github: 'emojidex/emojidex-rasters'
 end

data/Guardfile

@@ -1,10 +1,19 @@
-guard :rubocop do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-end
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
 
-guard :rspec, cmd: 'bundle exec rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
 end
+
+#guard :rubocop do
+#  watch(%r{.+\.rb$})
+#  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+#end

data/README.md

@@ -1,34 +1,71 @@
 [![Gem Version](https://badge.fury.io/rb/emojidex.png)](http://badge.fury.io/rb/emojidex)
 [![Build Status](https://travis-ci.org/emojidex/emojidex.png)](https://travis-ci.org/emojidex/emojidex)
 [![Code Climate](https://codeclimate.com/github/emojidex/emojidex.png)](https://codeclimate.com/github/emojidex/emojidex)
+[![Coverage Status](https://coveralls.io/repos/emojidex/emojidex/badge.svg?service=github)](https://coveralls.io/github/emojidex/emojidex)
 [![Inline docs](http://inch-ci.org/github/emojidex/emojidex.png?branch=master)](http://inch-ci.org/github/emojidex/emojidex)
 [![Gitter chat](https://badges.gitter.im/emojidex/emojidex.png)](https://gitter.im/emojidex/emojidex)
 emojidex
 ========
 emojidex core tools and scripts in Ruby. Provides a set of tools to utilize emojidex emoji right away in Ruby. Available as the "emojidex" gem.
 
+Usage
+=====
+The emojidex gem can be used either on-line or off-line. Offline components require you to bundle 
+the assets you want to use by including either the emojidex-vectors gem for SVG assets or 
+emojidex-rasters gem for PNG assets. Simply including "emojidex-vectors" or "emojidex-rasters" in 
+your Gemfile or having the gem installed will enable this. Without one or both of these gems 
+installed the off-line components will fall back to connecting to the emojidex service and, if 
+they are unable to connect, will attempt to find the assets in the emojidex cache (usually found 
+in $HOME/.emojidex).
+
+Off-line
+--------
+To use emojidex off-line you simply need to make an instance of one or more of the named 
+collections in the 'emojidex/data' directory:  
+  
+For UTF (Unicode Standard) emoji:
+```
+require 'emojidex/data/utf'
+
+emoji = Emojidex::Data::UTF.new
+```
+
+For Extended (emojidex Original) emoji:
+```
+require 'emojidex/data/extended'
+
+emoji = Emojidex::Data::Extended.new
+```
+
+For all emoji in the cache (will include UTF and Extended if they have been cached):
+```
+require 'emojidex/data/collection'
+
+emoji = Emojidex::Data::Collection.new
+```
+
+For a combined set of UTF, Extended and Cached emoji:
+```
+require 'emojidex/data/collection'
+require 'emojidex/data/utf'
+require 'emojidex/data/extended'
+
+emoji = Emojidex::Data::Collection.new
+emoji << Emojidex::Data::UTF.new
+emoji << Emojidex::Data::Extended.new
+```
+
+
+On-line
+-------
+WIP
+
+
 Assets
 ======
 You can find Vectors here: [emojidex-vectors](https://github.com/emojidex/emojidex-vectors)  
 You can find Rasters here: [emojidex-rasters](https://github.com/emojidex/emojidex-rasters)
 
-Notes / Caution
-===============
-
-Pre 1.8 or non 1.9+ compliant Ruby
-----------------------------------
-emojidex uses a variety of tricks and extensively utilizes UTF8/Unicode in ways most other code does not. As such, we do not recommend attempting 
-to run emojidex on non 1.9+ compliant Ruby variants, and instead recommend the latest official Ruby. If you are/must use a non 1.9+ official Ruby 
-and find an issue that can be remedied without imparing functionality or significantly impacting performance please notify us with an issue or 
-submit a pull request with a patch.
-
-jRuby
------
-From 1.9 on Ruby is an m17n compliant Code Set Independent languge. jRuby, however, does not fulfill this requirement and has a variety of issues 
-dealing with UTF8 code -and- content. It should be noted that this is NOT so much a fault of jRuby as it is the JRE/JVM, which simply imposes a 
-code set (which in many/most cases is NOT UTF8) on jRuby. Due to this, caution must be excercised when using jRuby. You must make absolutely sure 
-that the Java environment you are using is being run with UTF8 as the code set.
-
 License
 =======
 emojidex and emojidex tools are licensed under the [emojidex Open License](https://www.emojidex.com/emojidex/emojidex_open_license).

data/emojidex.gemspec

@@ -1,12 +1,15 @@
 Gem::Specification.new do |s|
   s.name        = 'emojidex'
-  s.version     = '0.0.23'
+  s.version     = '0.1.0'
   s.license     = 'emojiOL'
   s.summary     = 'emojidex Ruby tools'
   s.description = 'emojidex emoji handling, search and lookup, listing and caching functionality' \
                   ' and user info (favorites/etc).'
   s.authors     = ['Rei Kagetsuki']
   s.email       = 'info@emojidex.com'
+
+  s.required_ruby_version = '>= 2.0'
+
   s.files       = `git ls-files`.split("\n")
   s.require_paths = ['lib']
   s.homepage    = 'http://developer.emojidex.com'

data/lib/emojidex.rb

@@ -1,10 +1,12 @@
-require 'json'
-require 'emojidex/emoji'
-require 'emojidex/collection_checker'
-require 'emojidex/collection'
-require 'emojidex/utf'
-require 'emojidex/extended'
-require 'emojidex/category'
-require 'emojidex/categories'
-require 'emojidex/client'
-require 'emojidex/error'
+require_relative 'emojidex/defaults'
+require_relative 'emojidex/data/emoji'
+require_relative 'emojidex/data/collection'
+require_relative 'emojidex/data/category'
+require_relative 'emojidex/data/categories'
+
+# Master emojidex module. Contains a few general helper functions.
+module Emojidex
+  def self.escape_code(code)
+    code.tr(' ', '_')
+  end
+end

data/lib/emojidex/{categories.rb → data/categories.rb}

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module Emojidex
+module Emojidex::Data
   # Holds a master list of categories
   class Categories
     attr_accessor :categories
@@ -40,7 +40,7 @@ module Emojidex
 
       @categories ||= {}
       raw.each do |category_info|
-        category = Emojidex::Category.new category_info
+        category = Emojidex::Data::Category.new category_info
         @categories[category.code.to_sym] = category
       end
     end
@@ -48,8 +48,7 @@ module Emojidex
     # loads standard categories local to the emojidex package
     # *automatically called on initialize if no options are passed
     def load_standard_categories
-      load_categories(IO.read(
-          File.expand_path('../../../emoji/categories.json', __FILE__)))
+      load_categories(IO.read(File.expand_path('../../../../emoji/categories.json', __FILE__)))
     end
   end
 end

data/lib/emojidex/{category.rb → data/category.rb}

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module Emojidex
+module Emojidex::Data
   # Category information
   class Category
     attr_accessor :code, :en, :ja

data/lib/emojidex/data/collection.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+
+require 'json'
+require_relative 'emoji'
+require_relative 'categories'
+require_relative 'collection/cache'
+require_relative 'collection/asset_information'
+require_relative 'collection/moji_data'
+
+module Emojidex
+  module Data
+    # listing and search of standard UTF emoji
+    class Collection
+      include Emojidex::Data::CollectionCache
+      include Emojidex::Data::CollectionAssetInformation
+      include Emojidex::Data::CollectionMojiData
+      attr_accessor :emoji, :categories,
+                    :source_path, :vector_source_path, :raster_source_path
+
+      # Initialize Collection. You can pass a list of emoji to seed the collection
+      def initialize(emoji_list = nil, local_load_path = nil)
+        @emoji = {}
+        @raster_source_path = @vector_source_path = @source_path = nil
+        load_local_collection(local_load_path) unless local_load_path.nil?
+        add_emoji(emoji_list) unless emoji_list.nil?
+        @emoji
+      end
+
+      # Loads an emoji collection on local storage
+      def load_local_collection(path)
+        @source_path = @vector_source_path = @raster_source_path = File.expand_path(path)
+        json = IO.read(@source_path + '/emoji.json')
+        list = JSON.parse(json, symbolize_names: true)
+        add_emoji(list)
+      end
+
+      # each override to map each functionality to the emoji hash values
+      def each(&block)
+        @emoji.values.each(&block)
+      end
+
+      # select override to map select functionality to the emoji hash values
+      def select(&block)
+        @emoji.values.select(&block)
+      end
+
+      def map(&block)
+        @emoji.values.map(&block)
+      end
+
+      def collect(&block)
+        @emoji.values.collect(&block)
+      end
+
+      # Retreives an Emoji object by the actual moji code/character code
+      # Will likely only return moji from UTF collection
+      def find_by_moji(moji)
+        each do |m|
+          return m if m[:moji] == moji
+        end
+        nil
+      end
+
+      alias_method :文字検索, :find_by_moji
+
+      # Gets the emoji with the specified code
+      # Returns the Emoji object or nil if no emoji with that code is found
+      def find_by_code(code)
+        @emoji[code.gsub(/\s/, '_').to_sym]
+      end
+
+      # Locates emoji by Japanese code (original Japanese emoji name [絵文字名])
+      # Only applies to collections that contain JA codes, this function is mapped to
+      # find_by_code for all other implementations (such as client)
+      def find_by_code_ja(code_ja)
+        each do |m|
+          return m if m[:code_ja] == code_ja
+        end
+        nil
+      end
+
+      alias_method :コード検索, :find_by_code_ja
+
+      def find_by_unicode(unicode)
+        unicode = unicode.downcase
+        each do |m|
+          return m if m[:unicode] == unicode
+        end
+        nil
+      end
+
+      def search(criteria = {})
+        Emojidex::Data::Collection.new _sub_search(@emoji.values.dup, criteria)
+      end
+
+      # Get all emoji from this collection that are part of the specified category
+      # Returns a new collection of only emoji in the specified category
+      def category(category_code)
+        categorized = @emoji.values.select { |moji| moji.category == category_code }
+        Emojidex::Data::Collection.new categorized
+      end
+
+      # Check to see if there are emoji in this collection which have the specified categories
+      # Returns true if there are emoji for all secified categories within this collection
+      def category?(*category_codes)
+        (category_codes.uniq - @categories).empty?
+      end
+
+      # Adds emojis to the collection
+      # After add categories are updated
+      def add_emoji(list)
+        list.each do |moji_info|
+          if moji_info.instance_of? Emojidex::Data::Emoji
+            @emoji[moji_info.code.to_sym] = moji_info.dup
+          else
+            emoji = Emojidex::Data::Emoji.new moji_info
+            @emoji[emoji.code.to_sym] = emoji
+          end
+        end
+        categorize
+        associate_variants
+        condense_moji_code_data
+        @emoji
+      end
+
+      alias_method :<<, :add_emoji
+
+      private
+
+      # Makes a list of all categories which contain emoji in this collection
+      def categorize
+        @categories = @emoji.values.map { |moji| moji.category }
+        @categories.uniq!
+      end
+
+      def associate_variants
+        @emoji.values.each do |emoji_obj|
+          if emoji_obj.code.match(/\(.*\)$/) # this emoji is a variant
+            # check for base
+            base_code = emoji_obj.code.sub(/\(.*\)$/, '').to_sym
+            if @emoji.key? base_code
+              @emoji[base_code].variants << emoji_obj.code.to_sym
+              emoji_obj.base = base_code
+            end
+          end
+        end
+      end
+
+      def _sub_search(list, criteria = {})
+        cr = criteria.shift
+        return list if cr.nil?
+
+        list = list.select { |moji| moji if moji[cr[0]] =~ /#{cr[1]}/ }
+        _sub_search(list, criteria)
+      end
+    end
+  end
+end

data/lib/emojidex/data/collection/asset_information.rb

@@ -0,0 +1,52 @@
+require 'digest/md5'
+require_relative '../../defaults'
+
+module Emojidex
+  module Data
+    # Asset Information for Collections
+    module CollectionAssetInformation
+      def generate_checksums(formats = Emojidex::Defaults.formats, sizes = Emojidex::Defaults.sizes)
+        @emoji.values.each do |moji|
+          moji.checksums = get_checksums(moji, formats, sizes)
+        end
+      end
+
+      def get_checksums(moji, formats = Emojidex::Defaults.formats, sizes = Emojidex::Defaults.sizes)
+        sums = {}
+        sums[:svg] = _checksum_for_file("#{@cache_path}/#{moji.code}.svg") if formats.include? :svg
+        if formats.include? :png
+          sums[:png] = {}
+          sizes.keys.each do |size|
+            sums[:png][size] = _checksum_for_file("#{@cache_path}/#{size}/#{moji.code}.png")
+          end
+        end
+        sums
+      end
+
+      def generate_paths(formats = Emojidex::Defaults.formats, sizes = Emojidex::Defaults.sizes)
+        @emoji.values.each do |moji|
+          moji.paths = get_paths(moji, formats, sizes)
+        end
+      end
+
+      def get_paths(moji, formats = Emojidex::Defaults.formats, sizes = Emojidex::Defaults.sizes)
+        paths = {}
+        path = "#{@cache_path}/#{moji.code}.svg"
+        paths[:svg] = path if File.exist? path
+        if formats.include? :png
+          paths[:png] = {}
+          sizes.keys.each do |size|
+            path = "#{@cache_path}/#{size}/#{moji.code}.png"
+            paths[:png][size] = path if File.exist? path
+          end
+        end
+        paths
+      end
+
+      private
+      def _checksum_for_file(path)
+        (File.exist? path) ? Digest::MD5.file(path).hexdigest : nil
+      end
+    end
+  end
+end