emojidex 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 276dff0ca7ffb746ffc6c75d0138d6f6f63b2516
-  data.tar.gz: 62c8c3b0386fb62407bc2b847003ed0d542ce61c
+  metadata.gz: 4630fa81f0b4c20f7934cc0f5266e413ca7112a1
+  data.tar.gz: bfc71b18f0cfcc880d68bdefc3a7a27af1fa9592
 SHA512:
-  metadata.gz: 56ec17e506c7e7c3d418e25cad759610d973e403db41465ddc86c153678dd3cda6e72b7e5f87c303caced3f91123a5768a816ab14bfb68b335510975896029f6
-  data.tar.gz: 0a7d1020b60277df33755bd83b09a76fbbf7603823ab00910c315cafdb66b7b00f9e88529904638f665eff191f2ed184c8e1b755944efc6f07a828fc41008eba
+  metadata.gz: 2edf4d9472f06706872132dfdbc5b2c1abf41fb2bd5f79f6ee7bcc0daf1887f5ef150bbb70828e8d6e46b71d9a23566808e736b36b8afe4389c97482b5d8d499
+  data.tar.gz: a5e307c155ef9a1e78e1d89d812a147d2cd0a485d064fb585ad7a4204ddd0f1d28ea59fbfcd534329d66cda2fcf71bc109bda69865511b47be76d345eef993c7

data/.travis.yml

@@ -5,7 +5,6 @@ rvm:
   - 2.0.0
   - 2.1.2
   - jruby-19mode
-  - rbx-2
 
 bundler_args: -j4 --without development
 

data/Gemfile

@@ -9,7 +9,6 @@ group :development do
   gem 'guard-rspec'
   gem 'rubocop'
   gem 'guard-rubocop'
-  #gem 'emojidex-vectors', path: '../emojidex-vectors'
 end
 
 group :test do
@@ -17,4 +16,5 @@ group :test do
   gem 'rspec'
   gem 'webmock'
   gem 'emojidex-vectors', github: 'emojidex/emojidex-vectors'
+  gem 'emojidex-rasters', github: 'emojidex/emojidex-rasters'
 end

data/Guardfile

@@ -1,12 +1,37 @@
+# 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]) }
 end
 
-guard :rspec do
+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/emojidex.gemspec

@@ -1,9 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'emojidex'
-  s.version     = '0.0.10'
+  s.version     = '0.0.11'
   s.license     = 'GPL-3, AGPL-3'
   s.summary     = 'emojidex Ruby tools'
-  s.description = 'emojidex emoji handling, search and lookup, listing and caching functionality and user info (favorites/etc).'
+  s.description = 'emojidex emoji handling, search and lookup, listing and caching functionality' \
+                  ' and user info (favorites/etc).'
   s.authors     = ['Rei Kagetsuki', 'Jun Tohyama', 'Vassil Kalkov', 'Rika Yoshida']
   s.email       = 'info@emojidex.com'
   s.files       = `git ls-files`.split("\n")

data/lib/emojidex.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'emojidex/emoji'
+require 'emojidex/collection_checker'
 require 'emojidex/collection'
 require 'emojidex/utf'
 require 'emojidex/extended'

data/lib/emojidex/cache.rb

@@ -5,28 +5,29 @@ require 'fileutils'
 module Emojidex
   # local caching functionality for collections
   module Cache
-    attr_reader :cache_dir
+    attr_reader :cache_path
 
     def setup_cache(path = nil)
       # check if cache dir is already set
-      return @cache_dir if @cache_dir && path.nil?
+      return @cache_path if @cache_path && path.nil?
       # setup cache
-      @cache_dir = File.expand_path(path || ENV['EMOJI_CACHE'] || "#{ENV['HOME']}/.emojidex/cache")
-      FileUtils.mkdir_p(@cache_dir)
+      @cache_path = File.expand_path(path || ENV['EMOJI_CACHE'] || "#{ENV['HOME']}/.emojidex/cache")
+      ENV['EMOJI_CACHE'] = @cache_path
+      FileUtils.mkdir_p(@cache_path)
       Emojidex::Defaults.sizes.keys.each do |size|
-        FileUtils.mkdir_p(@cache_dir + "/#{size}")
+        FileUtils.mkdir_p(@cache_path + "/#{size}")
       end
-      @cache_dir
+      @cache_path
     end
 
     # Caches emoji to local emoji storage cache
     # Options:
-    #   cache_dir: manually specify cache location
+    #   cache_path: manually specify cache location
     #     (default is ENV['EMOJI_CACHE'] or '$HOME/.emoji_cache')
     #   formats: formats to cache (default is SVG only)
     #   sizes: sizes to cache (default is px32, but this is irrelivant for SVG)
     def cache!(options = {})
-      setup_cache options[:cache_dir]
+      setup_cache options[:cache_path]
       formats = options[:formats] || [:svg, :png]
       sizes = options[:sizes] || [:px32]
       @emoji.values.each do |moji|
@@ -37,7 +38,7 @@ module Emojidex
     end
 
     def cache_index(destination = nil)
-      destination = destination || @cache_dir
+      destination ||= @cache_path
       idx = Emojidex::Collection.new
       idx.load_local_collection(destination) if FileTest.exist? "#{destination}/emoji.json"
       idx.add_emoji @emoji.values
@@ -51,19 +52,19 @@ module Emojidex
     def _svg_check_copy(moji)
       src = @source_path + "/#{moji.code}"
       if File.exist? "#{src}.svg"
-        unless File.exist?("#{@cache_dir}/#{moji.code}.svg") &&
-          FileUtils.compare_file("#{src}.svg", "#{@cache_dir}/#{moji.code}.svg")
-          FileUtils.cp("#{src}.svg", @cache_dir)
+        unless File.exist?("#{@cache_path}/#{moji.code}.svg") &&
+          FileUtils.compare_file("#{src}.svg", "#{@cache_path}/#{moji.code}.svg")
+          FileUtils.cp("#{src}.svg", @cache_path)
         end
       end
-      FileUtils.cp_r src, @cache_dir if File.directory? src
+      FileUtils.cp_r src, @cache_path if File.directory? src
     end
 
     def _raster_check_copy(moji, format, sizes)
       sizes.each do |size|
         src = @source_path + "/#{size}/#{moji.code}"
-        FileUtils.cp "src.#{format}", (@cache_dir + "/#{size}") if FileTest.exist? "src.#{format}"
-        FileUtils.cp_r src, @cache_dir if File.directory? src
+        FileUtils.cp "#{src}.#{format}", (@cache_path + "/#{size}") if FileTest.exist? "#{src}.#{format}"
+        FileUtils.cp_r src, @cache_path if File.directory? src
       end
     end
   end

data/lib/emojidex/client.rb

@@ -54,7 +54,7 @@ module Emojidex
       response = connection.send(method.to_sym, path, params)
       response.env
     rescue Faraday::Error::ClientError, JSON::ParserError
-     raise Emojidex::Error
+      raise Emojidex::Error
     end
   end
 end

data/lib/emojidex/collection_checker.rb

@@ -0,0 +1,91 @@
+
+require 'find'
+require_relative 'defaults.rb'
+
+module Emojidex
+  # Check collections for presence of image assets and discrepencies in emoji indexes.
+  class CollectionChecker
+    attr_reader :index_only, :asset_only
+
+    def initialize(collections, options = {})
+      collections = *collections
+      @index_only = {}
+      @asset_only = {}
+      asset_path = options[:asset_path] || collections.first.source_path
+      sizes = options[:sizes] || Defaults.sizes.keys
+      formats = options[:formats] || Defaults.formats
+
+      asset_files = create_asset_file_list(asset_path, sizes, formats)
+      check_for_index_only(collections, asset_files, sizes, formats)
+      check_for_asset_only(collections, asset_files)
+    end
+
+    private
+
+    def create_asset_file_list(dir, sizes, formats)
+      result = {}
+      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
+      end
+      result
+    end
+
+    def create_file_list(dir, ext, prefix)
+      result = {}
+      Dir.foreach(dir) do |file|
+        result["#{prefix}#{File.basename(file, '.*')}".to_sym] =
+          "#{prefix}#{file}" if File.extname(file) == ext
+      end
+      result
+    end
+
+    def check_for_index_only(collections, asset_files, sizes, formats)
+      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')
+          @index_only[emoji.code.to_sym] = tmp unless tmp.empty?
+        end
+      end
+    end
+
+    def create_svg_array(emoji, asset_files)
+      result = []
+      result << emoji.code if asset_files[emoji.code.to_sym].nil?
+      result
+    end
+
+    def create_png_array(emoji, asset_files, sizes)
+      result = []
+      sizes.each do |size|
+        name = "#{size}/#{emoji.code}"
+        result << name if asset_files[name.to_sym].nil?
+      end
+      result
+    end
+
+    def check_for_asset_only(collections, asset_files)
+      asset_files.each do |_key, value|
+        code = File.basename(value, '.*')
+
+        next if find_emoji_from_collections(collections, code)
+
+        symbol = code.to_sym
+        @asset_only[symbol] = [] if @asset_only[symbol].nil?
+        @asset_only[symbol] << value
+      end
+    end
+
+    def find_emoji_from_collections(collections, code)
+      symbol = code.to_sym
+      collections.each do |collection|
+        return true unless collection.emoji[symbol].nil?
+      end
+      false
+    end
+  end # class CollectionChecker
+end # module Emojidex

data/lib/emojidex/extended.rb

@@ -8,7 +8,7 @@ module Emojidex
       if defined? Emojidex::Vectors
         load_local_collection Emojidex::Vectors.path + '/extended'
       else
-        # TODO load from service
+        # TODO: load from service
       end
     end
   end

data/lib/emojidex/service.rb

@@ -13,12 +13,12 @@ module Emojidex
     # sends an API search, adding results with add_emoji
     # returns a collection, and adds results to the @emoji array
     def search(criteria = {})
-      # TODO *NOTE try and replicate regex search functionality by passing regex to server
+      # TODO: *NOTE try and replicate regex search functionality by passing regex to server
     end
 
     # directly retrieves the emoji with the given code
     def find_by_code(code)
-      # TODO
+      # TODO: perform a query on emojidex API
     end
 
     # emoji on the emojidex service make no language distinctions
@@ -27,6 +27,6 @@ module Emojidex
       find_by_code(code)
     end
 
-    # TODO override or add caching functionality to retrieve sized png or svg from service
+    # TODO: override or add caching functionality to retrieve sized png or svg from service
   end
 end

data/lib/emojidex/utf.rb

@@ -4,11 +4,11 @@ module Emojidex
   # listing and search of standard UTF emoji
   class UTF < Collection
     def initialize
-      super 
+      super
       if defined? Emojidex::Vectors
         load_local_collection Emojidex::Vectors.path + '/utf'
       else
-        # TODO load from service
+        # TODO: load from service
       end
     end
   end

data/spec/collection_checker_spec.rb

@@ -0,0 +1,67 @@
+
+require 'spec_helper'
+
+describe Emojidex::CollectionChecker do
+
+  before(:all) do
+   @sizes = [:px32]
+  end
+
+
+
+
+  let(:col_good) do
+    sample_collection 'good'
+  end
+
+  let(:col_missing_assets) do
+    sample_collection 'missing_assets'
+  end
+
+  let(:col_missing_index) do # just missing entries in index, not missing the actual index
+    sample_collection 'missing_index'
+  end
+
+  describe 'Spec Collections' do
+    it 'load cleanly' do
+      expect(col_good).to be_an_instance_of(Emojidex::Collection)
+      expect(col_missing_assets).to be_an_instance_of(Emojidex::Collection)
+      expect(col_missing_index).to be_an_instance_of(Emojidex::Collection)
+    end
+  end
+
+  describe '.new' do
+    it 'creates a valid CollectionChecker instance and checks a valid collection' do
+      checker = Emojidex::CollectionChecker.new(col_good, {sizes: @sizes})
+
+      expect(checker).to be_an_instance_of(Emojidex::CollectionChecker)
+      expect(checker.index_only).to be_empty
+      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"]})
+    end
+
+    it 'checks for and identifies missing index entries' do
+      checker = Emojidex::CollectionChecker.new(col_missing_index, {sizes: @sizes})
+
+      expect(checker.index_only).to be_empty
+      expect(checker.asset_only.size).to eq(1)
+      expect(checker.asset_only).to eq(
+        {purple_heart: ["purple_heart.svg", "px32/purple_heart.png"]})
+    end
+    it 'checks collections against a specified asset directory' do
+      checker = Emojidex::CollectionChecker.new([col_missing_index, col_missing_assets],
+                                                {sizes: @sizes, asset_path: col_good.source_path})
+
+      expect(checker.index_only).to be_empty
+      expect(checker.asset_only).to be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -62,3 +62,9 @@ end
 def fixture(file)
   File.new(fixture_path + '/' + file)
 end
+
+def sample_collection(name)
+  e =Emojidex::Collection.new
+  e.load_local_collection(File.expand_path("../support/sample_collections/#{name}", __FILE__))
+  e
+end

data/spec/support/sample_collections/good/emoji.json

@@ -0,0 +1,30 @@
+[
+  {
+    "moji": "👄",
+    "code": "mouth",
+    "code_ja": "口",
+    "category": "people",
+    "unicode": "1f444"
+  },
+  {
+    "moji": "🔩",
+    "code": "nut_and_bolt",
+    "code_ja": "ボルト＆ナット",
+    "category": "tools",
+    "unicode": "1f529"
+  },
+  {
+    "moji": "💜",
+    "code": "purple_heart",
+    "code_ja": "ハート(紫)",
+    "category": "abstract",
+    "unicode": "1f49c"
+  },
+  {
+    "moji": "👯",
+    "code": "woman_with_bunny_ears",
+    "code_ja": "バニーガール",
+    "category": "people",
+    "unicode": "1f46f"
+  }
+]

data/spec/support/sample_collections/good/mouth.svg

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 15.0.2, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="レイヤー_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px"
+	 y="0px" width="64px" height="64px" viewBox="0 0 64 64" enable-background="new 0 0 64 64" xml:space="preserve">
+<polygon fill="#661222" points="9.333,35.667 8.167,29.833 18.667,19.167 46,22.581 55.167,31.666 46.333,38 "/>
+<linearGradient id="SVGID_1_" gradientUnits="userSpaceOnUse" x1="17.8975" y1="24.9985" x2="52.2147" y2="26.0599">
+	<stop  offset="0" style="stop-color:#9C9C9C"/>
+	<stop  offset="0.0142" style="stop-color:#A9A9A9"/>
+	<stop  offset="0.0497" style="stop-color:#C4C4C4"/>
+	<stop  offset="0.0905" style="stop-color:#DADADA"/>
+	<stop  offset="0.1381" style="stop-color:#EBEBEB"/>
+	<stop  offset="0.197" style="stop-color:#F6F6F6"/>
+	<stop  offset="0.2797" style="stop-color:#FDFDFD"/>
+	<stop  offset="0.5091" style="stop-color:#FFFFFF"/>
+	<stop  offset="0.6532" style="stop-color:#FDFDFD"/>
+	<stop  offset="0.7265" style="stop-color:#F5F5F5"/>
+	<stop  offset="0.7838" style="stop-color:#E8E8E8"/>
+	<stop  offset="0.8329" style="stop-color:#D5D5D5"/>
+	<stop  offset="0.8766" style="stop-color:#BCBCBC"/>
+	<stop  offset="0.9166" style="stop-color:#9E9E9E"/>
+	<stop  offset="0.9537" style="stop-color:#7A7A7A"/>
+	<stop  offset="0.9876" style="stop-color:#525252"/>
+	<stop  offset="1" style="stop-color:#414141"/>
+</linearGradient>
+<path fill="url(#SVGID_1_)" d="M12.833,24.991c0,0,11.146,4.919,19.284,4.919s21.407-3.876,21.407-3.876l-10.438-4.55l-20.345-0.818
+	L12.833,24.991z"/>
+<linearGradient id="SVGID_2_" gradientUnits="userSpaceOnUse" x1="28.4619" y1="12.6665" x2="32.6284" y2="33.6665">
+	<stop  offset="0" style="stop-color:#FF9FB0"/>
+	<stop  offset="0.2186" style="stop-color:#FF7D94"/>
+	<stop  offset="0.5773" style="stop-color:#FF4A6A"/>
+	<stop  offset="0.849" style="stop-color:#FF2B51"/>
+	<stop  offset="1" style="stop-color:#FF1F47"/>
+</linearGradient>
+<path fill="url(#SVGID_2_)" stroke="#BC001B" stroke-miterlimit="10" d="M3.426,29.167c1.833-4.219,8.689-12.639,16.023-16.472
+	s9.811,3.021,12.811,3.021c3,0,7.528-7.002,13.668-2.384c6.28,4.723,15.503,15.396,15.003,16.896s-3.035,5.341-8.701,2.007
+	s-7.124-7.073-10.946-6.852C38.5,25.544,38,27.667,32,27.667c-6.5,0-7.711-3.631-11.878-2.606S8.679,34.47,5.913,33.563
+	C3.881,32.897,2.297,31.763,3.426,29.167z"/>
+<linearGradient id="SVGID_3_" gradientUnits="userSpaceOnUse" x1="32.0557" y1="35.5488" x2="34.3892" y2="57.8818">
+	<stop  offset="0" style="stop-color:#FF9FB0"/>
+	<stop  offset="0.2186" style="stop-color:#FF7D94"/>
+	<stop  offset="0.5773" style="stop-color:#FF4A6A"/>
+	<stop  offset="0.849" style="stop-color:#FF2B51"/>
+	<stop  offset="1" style="stop-color:#FF1F47"/>
+</linearGradient>
+<path fill="url(#SVGID_3_)" stroke="#BC001B" stroke-miterlimit="10" d="M5.885,32.888c10.333-3.5,16.333,1.668,27,1.334
+	s14.833-4.167,25.167-1.751c3.644,0.852,1.747,5.584-1.834,9.047c-2.797,2.705-14.5,7.87-23.333,7.87
+	c-8.833,0-22.333-5-25.833-8.666C4.679,38.236,2.14,34.156,5.885,32.888z"/>
+</svg>