emojidex 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4630fa81f0b4c20f7934cc0f5266e413ca7112a1
-  data.tar.gz: bfc71b18f0cfcc880d68bdefc3a7a27af1fa9592
+  metadata.gz: bfe7f958b3d9cddc8a46b7fd69a53f4d2033aa19
+  data.tar.gz: 21a64c3586491ad787530f25c5b83f1a159955f8
 SHA512:
-  metadata.gz: 2edf4d9472f06706872132dfdbc5b2c1abf41fb2bd5f79f6ee7bcc0daf1887f5ef150bbb70828e8d6e46b71d9a23566808e736b36b8afe4389c97482b5d8d499
-  data.tar.gz: a5e307c155ef9a1e78e1d89d812a147d2cd0a485d064fb585ad7a4204ddd0f1d28ea59fbfcd534329d66cda2fcf71bc109bda69865511b47be76d345eef993c7
+  metadata.gz: 103138ff174c2e96d99e46d70c3beb0c171a13f0a07b25de739403ae2b7a94ddbe7836d94788367bbb15895462471b22e3158bb6d8b6529e8e8c93461d724dc4
+  data.tar.gz: c871f112771225a548f95c79d4571b8c0cdf8e283172084d8804bbebb434b4b8ba6ff7706de372e9d33272f70d455a27236e97de249b01d6c76011b45ba0dd7d

data/.rubocop.yml

@@ -9,3 +9,7 @@ AccessorMethodName:
 
 LineLength:
   Max: 99
+
+AllCops:
+  Excludes:
+    - 'Guardfile'

data/Guardfile

@@ -1,14 +1,3 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rsspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separetly)
-#  * 'just' rspec: 'rspec'
 guard :rubocop do
   watch(%r{.+\.rb$})
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
@@ -18,20 +7,4 @@ 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" }
-
-  # Rails example
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-  watch('spec/rails_helper.rb')                       { "spec" }
-
-  # Capybara features specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
-
-  # Turnip features and steps
-  watch(%r{^spec/acceptance/(.+)\.feature$})
-  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
 end

data/README.md

@@ -1,6 +1,7 @@
 [![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)
+[![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.

data/emojidex.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'emojidex'
-  s.version     = '0.0.11'
+  s.version     = '0.0.12'
   s.license     = 'GPL-3, AGPL-3'
   s.summary     = 'emojidex Ruby tools'
   s.description = 'emojidex emoji handling, search and lookup, listing and caching functionality' \

data/lib/emojidex/collection.rb

@@ -3,38 +3,49 @@
 require 'json'
 require_relative 'emoji'
 require_relative 'categories'
-require_relative 'cache'
+require_relative 'collection/cache'
+require_relative 'collection/asset_information'
 
 module Emojidex
   # listing and search of standard UTF emoji
   class Collection
-    include Emojidex::Cache
+    include Emojidex::CollectionCache
+    include Emojidex::CollectionAssetInformation
     attr_accessor :emoji, :categories
-    attr_reader :source_path
+    attr_reader :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)
+    def initialize(emoji_list = nil, local_load_path = nil)
       @emoji = {}
+      load_local_collection(local_load_path) unless local_load_path.nil?
       add_emoji(emoji_list) unless emoji_list.nil?
     end
 
     # Loads an emoji collection on local storage
     def load_local_collection(path)
       @source_path = File.expand_path(path)
+      @vector_path = @source_path if @vector_path.nil?
+      @raster_path = @raster_path if @raster_path.nil?
       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
-      return @emoji.values.each unless block_given?
-      @emoji.values.each { |emoji| yield emoji }
+    def each(&block)
+      @emoji.values.each(&block)
     end
 
     # select override to map select functionality to the emoji hash values
-    def select
-      return @emoji.values.select unless block_given?
-      @emoji.values.select { |emoji| yield emoji }
+    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

data/lib/emojidex/collection/asset_information.rb

@@ -0,0 +1,49 @@
+require 'digest/md5'
+
+module Emojidex
+  # 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, sizes)
+      sums = {}
+      sums[:svg] = _checksum_for_file("#{@vector_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("#{@vector_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, sizes)
+      paths = {}
+      path = "#{@vector_path}/#{moji.code}.svg"
+      paths[:svg] = path if File.exist? path
+      if formats.include? :png
+        paths[:png] = {}
+        sizes.keys.each do |size|
+          path = "#{@vector_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

data/lib/emojidex/{cache.rb → collection/cache.rb}

@@ -1,10 +1,10 @@
 require 'json'
-require_relative 'defaults'
 require 'fileutils'
+require_relative '../defaults'
 
 module Emojidex
   # local caching functionality for collections
-  module Cache
+  module CollectionCache
     attr_reader :cache_path
 
     def setup_cache(path = nil)

data/lib/emojidex/collection_checker.rb

@@ -24,8 +24,8 @@ module Emojidex
 
     def create_asset_file_list(dir, sizes, formats)
       result = {}
-      result.merge!(create_file_list(dir, '.svg', '')) if formats.include?(':svg')
-      if formats.include?(':png')
+      result.merge!(create_file_list(dir, '.svg', '')) if formats.include?(:svg)
+      if formats.include?(:png)
         sizes.each do |size|
           result.merge!(create_file_list("#{dir}/#{size}", '.png', "#{size}/"))
         end
@@ -35,6 +35,7 @@ module Emojidex
 
     def create_file_list(dir, ext, prefix)
       result = {}
+      return result unless Dir.exists?(dir)
       Dir.foreach(dir) do |file|
         result["#{prefix}#{File.basename(file, '.*')}".to_sym] =
           "#{prefix}#{file}" if File.extname(file) == ext
@@ -46,8 +47,8 @@ module Emojidex
       collections.each do |collection|
         collection.emoji.values.each do |emoji|
           tmp = []
-          tmp += create_svg_array(emoji, asset_files) if formats.include?(':svg')
-          tmp += create_png_array(emoji, asset_files, sizes) if formats.include?(':png')
+          tmp += create_svg_array(emoji, asset_files) if formats.include?(:svg)
+          tmp += create_png_array(emoji, asset_files, sizes) if formats.include?(:png)
           @index_only[emoji.code.to_sym] = tmp unless tmp.empty?
         end
       end
@@ -55,7 +56,8 @@ module Emojidex
 
     def create_svg_array(emoji, asset_files)
       result = []
-      result << emoji.code if asset_files[emoji.code.to_sym].nil?
+      asset_file = asset_files[emoji.code.to_sym]
+      result << "#{emoji.code}.svg" if asset_files[emoji.code.to_sym].nil?
       result
     end
 
@@ -63,7 +65,7 @@ module Emojidex
       result = []
       sizes.each do |size|
         name = "#{size}/#{emoji.code}"
-        result << name if asset_files[name.to_sym].nil?
+        result << "#{name}.png" if asset_files[name.to_sym].nil?
       end
       result
     end

data/lib/emojidex/defaults.rb

@@ -7,7 +7,7 @@ module Emojidex
     end
 
     def self.formats
-      [':svg', ':png']
+      [:svg, :png]
     end
   end
 end

data/lib/emojidex/emoji.rb

@@ -1,27 +1,26 @@
-#
-# Emojidex::Emoji
-#
+require_relative 'emoji/asset_information'
+
 module Emojidex
   # emoji base class
   class Emoji
     attr_accessor :moji, :category, :code, :unicode,
-                  :tags, :frames, :delays
+                  :tags, :emoticon
+
+    include Emojidex::EmojiAssetInformation
 
     def initialize(details = {})
       @moji = details[:moji]
       @code, @code_ja = details[:code], details[:code_ja]
       @unicode = details[:unicode]
+      @emoticon = details[:emoticon]
       @category = details[:category] ? details[:category].to_sym : :other
       @tags = details[:tags].map { |tag| tag.to_sym } unless details[:tags].nil?
-      @frames = details[:frames] || [@code]
-      @delays = details[:delays] || [100]
-      @loops = details[:loops]
       @link = details[:link]
       @is_wide = details[:is_wide]
     end
 
     def to_s
-      @moji || ':' + @code + ':'
+      @moji || ":#{@code}:"
     end
 
     def to_json(*args)
@@ -43,32 +42,5 @@ module Emojidex
     def []=(key, val)
       instance_variable_set(key.to_s.delete(':').insert(0, '@'), val)
     end
-
-    def set_animation_data(params)
-      set_frames(params)
-      set_delays(params)
-    end
-
-    def set_frames(params)
-      return if params[:frames].nil?
-
-      @frames = params[:frames].clone
-      params[:frames].each_with_index do |frame, i|
-        @frames[i] = frame.keys.first.to_s if frame.is_a? Hash
-      end
-    end
-
-    def set_delays(params)
-      default_delay = params[:default_delay] || 100
-
-      @delays = params[:delays] unless params[:delays].nil?
-      if @delays.length < @frames.length
-        @delays << default_delay until @delays.length == @frames.length
-      end
-    end
-
-    def animated?
-      @frames.count > 1
-    end
   end
 end

data/lib/emojidex/emoji/asset_information.rb

@@ -0,0 +1,20 @@
+
+module Emojidex
+  # Asset information for emoji
+  module EmojiAssetInformation
+    attr_accessor :checksums, :paths
+
+    # returns asset checksum
+    def checksum?(format, variant = nil)
+      puts @checksums
+      return @checksums[format][variant] unless variant.nil?
+      @checksums[format]
+    end
+
+    # returns asset path
+    def path?(format, variant = nil)
+      return @paths[format][variant] unless variant.nil?
+      @paths[format]
+    end
+  end
+end

data/lib/emojidex/extended.rb

@@ -6,10 +6,14 @@ module Emojidex
     def initialize
       super
       if defined? Emojidex::Vectors
-        load_local_collection Emojidex::Vectors.path + '/extended'
-      else
-        # TODO: load from service
+        @vector_source_path = Emojidex::Vectors.path + '/extended/'
+        load_local_collection @vector_source_path
       end
+      if defined? Emojidex::Rasters
+        @raster_source_path = Emojidex::Rasters.path + '/extended/'
+        load_local_collection @raster_source_path
+      end
+      # TODO: load from service
     end
   end
 end

data/lib/emojidex/utf.rb

@@ -6,10 +6,14 @@ module Emojidex
     def initialize
       super
       if defined? Emojidex::Vectors
-        load_local_collection Emojidex::Vectors.path + '/utf'
-      else
-        # TODO: load from service
+        @vector_source_path = Emojidex::Vectors.path + '/utf/'
+        load_local_collection @vector_source_path
       end
+      if defined? Emojidex::Rasters
+        @raster_source_path = Emojidex::Rasters.path + '/utf/'
+        load_local_collection @raster_source_path
+      end
+      # TODO: load from service
     end
   end
 end

data/spec/collection_checker_spec.rb

@@ -39,13 +39,21 @@ describe Emojidex::CollectionChecker do
       expect(checker.asset_only).to be_empty
     end
 
+    it 'checks to see if a size of an asset exists' do
+      checker = Emojidex::CollectionChecker.new(col_good, {sizes: [:px64]})
+
+      expect(checker).to be_an_instance_of(Emojidex::CollectionChecker)
+      expect(checker.index_only.size).to eq(4)
+      expect(checker.asset_only).to be_empty
+    end
+
     it 'checks for and identifies missing assets' do
       checker = Emojidex::CollectionChecker.new(col_missing_assets, {sizes: @sizes})
 
       expect(checker.asset_only).to be_empty
       expect(checker.index_only.size).to eq(2)
       expect(checker.index_only).to eq(
-        {:nut_and_bolt=>["nut_and_bolt"], :purple_heart=>["px32/purple_heart"]})
+        {nut_and_bolt: ["nut_and_bolt.svg"], purple_heart: ["px32/purple_heart.png"]})
     end
 
     it 'checks for and identifies missing index entries' do

data/spec/collection_spec.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Emojidex::Collection do
+  let(:collection) { Emojidex::Collection.new(nil, './spec/support/sample_collections/good') }
+
+  describe '.load_local_collection' do
+    it 'loads a local collection' do
+      expect(collection).to be_an_instance_of(Emojidex::Collection)
+    end
+  end
+
+  describe '.each' do
+    it 'provides each emoji' do
+      collection.each do |emoji|
+        expect(emoji).to be_an_instance_of(Emojidex::Emoji)
+      end
+    end
+  end
+
+  describe '.find_by_moji' do
+    it 'finds and returns an emoji object by UTF moji code' do
+      expect(collection.find_by_moji('👯')).to be_an_instance_of(Emojidex::Emoji)
+    end
+
+    it 'returns nil when the moji code does not exist' do
+      expect(collection.find_by_moji('XX')).to be_nil
+    end
+  end
+
+  describe '.文字検索' do
+    it 'find_by_moji_codeをaliasして文字コードで検索する' do
+      expect(collection.文字検索('👯')).to be_an_instance_of(Emojidex::Emoji)
+    end
+  end
+
+  describe '.find_by_code' do
+    it 'finds and returns an emoji by code' do
+      ss = collection.find_by_code('nut_and_bolt')
+      expect(ss).to be_an_instance_of(Emojidex::Emoji)
+    end
+
+    it 'returns nil when a code does not exist' do
+      expect(collection.find_by_code('super_fantastic')).to be_nil
+    end
+  end
+
+  describe '.find_by_code_ja' do
+    it 'finds and returns an emoji by Japanese code' do
+      expect(collection.find_by_code_ja('ハート(紫)')).to be_an_instance_of(Emojidex::Emoji)
+    end
+  end
+
+  describe '.コード検索' do
+    it 'find_by_code_jaをaliasして日本語の絵文字コードで検索する' do
+      expect(collection.コード検索('ハート(紫)')).to be_an_instance_of(Emojidex::Emoji)
+    end
+  end
+
+  describe '.cache!' do
+    it 'caches emoji to local storage cache' do
+      tmp_cache_path = File.expand_path('../support/tmpcache', __FILE__)
+      collection.cache!(cache_path: tmp_cache_path)
+      expect(ENV['EMOJI_CACHE']).to eq(collection.cache_path)
+      expect(File.exist? tmp_cache_path).to be_truthy
+      expect(File.exist? tmp_cache_path + '/mouth.svg').to be_truthy
+      expect(File.exist? tmp_cache_path + '/emoji.json').to be_truthy
+
+      FileUtils.rm_rf tmp_cache_path # cleanup
+    end
+  end
+
+  describe '.cache_index' do
+    it 'caches the  index to the specified location' do
+      tmp_cache_path = File.expand_path('../support/tmpcache', __FILE__)
+      FileUtils.mkdir_p(tmp_cache_path)
+      collection.cache_index tmp_cache_path
+      expect(File.exist? tmp_cache_path + '/emoji.json').to be_truthy
+
+      FileUtils.rm_rf tmp_cache_path
+    end
+  end
+
+  describe '.generate_checksums' do
+    it 'generates checksums for assets' do
+      expect(collection.generate_checksums).to be_an_instance_of(Array)
+      expect(collection.emoji.values.first.checksums[:svg]).to be_truthy
+      expect(collection.emoji.values.first.checksum?(:svg)).to be_truthy
+      expect(collection.emoji.values.first.checksums[:png][:px32]).to be_truthy
+      expect(collection.emoji.values.first.checksum?(:png, :px32)).to be_truthy
+      expect(collection.emoji.values.first.checksums[:png][:px64]).to be_nil
+      expect(collection.emoji.values.first.checksum?(:png, :px64)).to be_nil
+    end
+  end
+
+  describe '.generate_paths' do
+    it 'generates file paths for each emoji' do
+      expect(collection.generate_paths).to be_an_instance_of(Array)
+      expect(collection.emoji.values.first.paths[:svg]).to be_truthy
+      expect(collection.emoji.values.first.path?(:svg)).to be_truthy
+      expect(collection.emoji.values.first.paths[:png][:px32]).to be_truthy
+      expect(collection.emoji.values.first.path?(:png, :px32)).to be_truthy
+      expect(collection.emoji.values.first.paths[:png][:px64]).to be_nil
+      expect(collection.emoji.values.first.path?(:png, :px64)).to be_nil
+    end
+  end
+end

data/spec/emoji_spec.rb

@@ -44,20 +44,4 @@ describe Emojidex::Emoji do
       expect(JSON.parse(emoji.to_json)).to be_an_instance_of(Hash)
     end
   end
-
-  describe '.frames' do
-    it 'holds an array of source frames' do
-      expect(emoji.frames).to be_an_instance_of(Array)
-    end
-  end
-
-  describe '.delays' do
-    it 'holds an array of delays between frames' do
-      expect(emoji.delays).to be_an_instance_of(Array)
-    end
-
-    it 'defaults to 100ms when nothing is specified' do
-      expect(emoji.delays[0]).to eq(100)
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@
 require 'rspec'
 require 'webmock/rspec'
 require 'emojidex'
+require 'emojidex/collection'
 require 'emojidex/vectors'
 
 WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emojidex
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Rei Kagetsuki
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,14 +61,16 @@ files:
 - lib/emojidex/api/categories.rb
 - lib/emojidex/api/emoji.rb
 - lib/emojidex/api/search/emoji.rb
-- lib/emojidex/cache.rb
 - lib/emojidex/categories.rb
 - lib/emojidex/category.rb
 - lib/emojidex/client.rb
 - lib/emojidex/collection.rb
+- lib/emojidex/collection/asset_information.rb
+- lib/emojidex/collection/cache.rb
 - lib/emojidex/collection_checker.rb
 - lib/emojidex/defaults.rb
 - lib/emojidex/emoji.rb
+- lib/emojidex/emoji/asset_information.rb
 - lib/emojidex/error.rb
 - lib/emojidex/extended.rb
 - lib/emojidex/service.rb
@@ -79,6 +81,7 @@ files:
 - spec/categories_spec.rb
 - spec/client_spec.rb
 - spec/collection_checker_spec.rb
+- spec/collection_spec.rb
 - spec/emoji_spec.rb
 - spec/extended_spec.rb
 - spec/spec_helper.rb