emojidex 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcc13aecee9337bf14e28469269706c2cb3d1591
-  data.tar.gz: e75c72d4d8edd241c833ca7ecb0fb36a9fc350cf
+  metadata.gz: a23e3b7d0fdb86b4577cb31f2f4d507dd2aab718
+  data.tar.gz: c225211888f80285139ce2b5ab6722c7f56a3491
 SHA512:
-  metadata.gz: 3c33ca861d40126c552df6af929454c09d1431a00b28c83f5b387b885f13eefb61aaeaa549b59b79997283a7334c0874ea81855ac00bc23780efdf9bb51d04b3
-  data.tar.gz: a77e1f5cedd7308b28fa0f6a267ce746748ef9ebdcbe1430c19c25d12e4fa4b15cf5a3e1bcf105c4ac1c282c7669b41cbe8c960ab58472a140d4fd4a609695e2
+  metadata.gz: 0fde73983a81cbd08fb429a77a22c655329e16e4cbf8ff1d6bc43bdc8532ce39a85b8310df6d8a455d3845336728ded4147055b1e0059e044661e3b6a1bf117b
+  data.tar.gz: 56b050497be82e6917e5954dea7d269869f5b78b3f6912aebd127f9c22ed29ce89e5ecbb6d0d5bbac3e606867fa77a268c3e9fcf3c86c66c3b24548ddf214361

data/emojidex.gemspec

@@ -1,19 +1,20 @@
 Gem::Specification.new do |s|
   s.name        = 'emojidex'
-  s.version     = '0.1.0'
+  s.version     = '0.2.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.homepage    = 'http://developer.emojidex.com'
 
   s.required_ruby_version = '>= 2.0'
-
-  s.files       = `git ls-files`.split("\n")
+  s.files       = Dir.glob('emoji/**/*') +
+                  Dir.glob('lib/**/*.rb') +
+                  ['emojidex.gemspec']
   s.require_paths = ['lib']
-  s.homepage    = 'http://developer.emojidex.com'
 
-  s.add_dependency 'faraday', '~> 0.9', '~> 0.9.1'
-  s.add_dependency 'faraday_middleware', '~> 0.9', '~> 0.9.1'
+  s.add_dependency 'faraday', '~> 0.9', '~> 0.9.2'
+  s.add_dependency 'faraday_middleware', '~> 0.9', '~> 0.9.2'
 end

data/lib/emojidex.rb

@@ -7,6 +7,14 @@ require_relative 'emojidex/data/categories'
 # Master emojidex module. Contains a few general helper functions.
 module Emojidex
   def self.escape_code(code)
-    code.tr(' ', '_')
+    code.tr(' ', '_').tr(':', '')
+  end
+
+  def self.unescape_code(code)
+    code.tr('_', ' ')
+  end
+
+  def self.encapsulate_code(code)
+    "#{Emojidex::Defaults.encapsulator}#{unescape_code(code)}#{Emojidex::Defaults.encapsulator}"
   end
 end

data/lib/emojidex/client.rb

@@ -0,0 +1,53 @@
+require_relative 'defaults'
+require_relative 'service/user'
+require_relative 'data/collection'
+
+module Emojidex
+  # A consolidated client which handles a user and their collection
+  class Client
+    @@client_cache_path = nil
+    @@user_instance = nil
+    @@collection_instance = nil
+
+    def self.USER
+      return @@user_instance unless @@user_instance.nil?
+      @@user_instance = Emojidex::Service::User.new
+      @@user_instance.load(@cache_path)
+      @@user_instance
+    end
+
+    def user
+      Emojidex::Client.USER
+    end
+
+    def self.COLLECTION
+      return @@collection_instance unless @@collection_instance.nil?
+      @@collection_instance = Emojidex::Data::Collection.new
+      @@collection_instance.load_cache
+      @@collection_instance
+    end
+
+    def collection
+      Emojidex::Client.COLLECTION
+    end
+
+    def self.CACHE_PATH
+      return @@client_cache_path unless @@client_cache_path.nil?
+      @@client_cache_path = Emojidex::Defaults.system_cache_path
+      @@client_cache_path
+    end
+
+    def cache_path
+      Emojidex::Client.CACHE_PATH
+    end
+
+    def initialize(opts = {})
+      if (opts.include? :cache_path)
+        @@client_cache_path = opts[:cache_path]
+        user = collection = nil
+      end
+      user
+      collection
+    end
+  end
+end

data/lib/emojidex/data/categories.rb

@@ -1,54 +1,54 @@
-# encoding: utf-8
-
-module Emojidex::Data
-  # Holds a master list of categories
-  class Categories
-    attr_accessor :categories
-
-    def initialize(categories_json = nil)
-      if categories_json
-        load_categories(categories_json)
-      else
-        load_standard_categories
+module Emojidex
+  module Data
+    # Holds a master list of categories
+    class Categories
+      attr_accessor :categories
+
+      def initialize(categories_json = nil)
+        if categories_json
+          load_categories(categories_json)
+        else
+          load_standard_categories
+        end
       end
-    end
 
-    # each override to map each functionality to the categories hash
-    def each(&block)
-      @categories.values.each(&block)
-    end
+      # each override to map each functionality to the categories hash
+      def each(&block)
+        @categories.values.each(&block)
+      end
 
-    # select override to map select functionality to the categories hash
-    def select(&block)
-      @categories.values.select(&block)
-    end
+      # select override to map select functionality to the categories hash
+      def select(&block)
+        @categories.values.select(&block)
+      end
 
-    # map override to map each functionality to the categories hash
-    def map(&block)
-      @categories.values.map(&block)
-    end
+      # map override to map each functionality to the categories hash
+      def map(&block)
+        @categories.values.map(&block)
+      end
 
-    # collect override to map each functionality to the categories hash
-    def collect(&block)
-      @categories.values.collect(&block)
-    end
+      # collect override to map each functionality to the categories hash
+      def collect(&block)
+        @categories.values.collect(&block)
+      end
 
-    # loads categories from a JSON hash object / JSON text
-    def load_categories(json)
-      raw = JSON.parse(json, symbolize_names: true)
-      raw = raw[:categories]
+      # loads categories from a JSON hash object / JSON text
+      def load_categories(json)
+        raw = JSON.parse(json, symbolize_names: true)
+        raw = raw[:categories]
 
-      @categories ||= {}
-      raw.each do |category_info|
-        category = Emojidex::Data::Category.new category_info
-        @categories[category.code.to_sym] = category
+        @categories ||= {}
+        raw.each do |category_info|
+          category = Emojidex::Data::Category.new category_info
+          @categories[category.code.to_sym] = category
+        end
       end
-    end
 
-    # 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__)))
+      # 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__)))
+      end
     end
   end
 end

data/lib/emojidex/data/category.rb

@@ -1,14 +1,14 @@
-# encoding: utf-8
+module Emojidex
+  module Data
+    # Category information
+    class Category
+      attr_accessor :code, :en, :ja
 
-module Emojidex::Data
-  # Category information
-  class Category
-    attr_accessor :code, :en, :ja
-
-    def initialize(details = {})
-      @code = details[:code].to_sym
-      @en = details[:en]
-      @ja = details[:ja]
+      def initialize(details = {})
+        @code = details[:code].to_sym
+        @en = details[:en]
+        @ja = details[:ja]
+      end
     end
   end
 end

data/lib/emojidex/data/collection.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'json'
+require_relative '../../emojidex'
 require_relative 'emoji'
 require_relative 'categories'
 require_relative 'collection/cache'
@@ -18,11 +19,17 @@ module Emojidex
                     :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)
+      def initialize(opts = {})
         @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?
+        if opts.include? :cache_path
+          setup_cache(opts[:cache_path])
+          opts.delete :cache_path
+        else
+          setup_cache
+        end
+        load_local_collection(opts[:local_load_path]) if opts.include? :local_load_path
+        add_emoji(opts[:emoji]) if opts.include? :emoji
         @emoji
       end
 
@@ -32,6 +39,7 @@ module Emojidex
         json = IO.read(@source_path + '/emoji.json')
         list = JSON.parse(json, symbolize_names: true)
         add_emoji(list)
+        generate_paths
       end
 
       # each override to map each functionality to the emoji hash values
@@ -90,14 +98,14 @@ module Emojidex
       end
 
       def search(criteria = {})
-        Emojidex::Data::Collection.new _sub_search(@emoji.values.dup, criteria)
+        Emojidex::Data::Collection.new(emoji: _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
+        Emojidex::Data::Collection.new(emoji: categorized)
       end
 
       # Check to see if there are emoji in this collection which have the specified categories
@@ -109,14 +117,7 @@ module Emojidex
       # 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
+        _add_list(list)
         categorize
         associate_variants
         condense_moji_code_data
@@ -125,23 +126,40 @@ module Emojidex
 
       alias_method :<<, :add_emoji
 
+      def remove_emoji(code)
+        emoji.delete(code)
+        @emoji
+      end
+
       private
 
+      def _add_list(list)
+        list.each do |moji_info|
+          if moji_info.instance_of? Emojidex::Data::Emoji
+            @emoji[moji_info.code.to_sym] = moji_info.dup
+            @emoji[moji_info.code.to_sym].paths = get_paths(moji_info)
+          else
+            emoji = Emojidex::Data::Emoji.new moji_info
+            emoji.paths = get_paths(emoji)
+            @emoji[Emojidex.escape_code(emoji.code.to_s).to_sym] = emoji
+          end
+        end
+      end
+
       # Makes a list of all categories which contain emoji in this collection
       def categorize
-        @categories = @emoji.values.map { |moji| moji.category }
+        @categories = @emoji.values.map(&: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
+          next unless 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

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

@@ -5,13 +5,15 @@ module Emojidex
   module Data
     # Asset Information for Collections
     module CollectionAssetInformation
-      def generate_checksums(formats = Emojidex::Defaults.formats, sizes = Emojidex::Defaults.sizes)
+      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)
+      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
@@ -29,7 +31,7 @@ module Emojidex
         end
       end
 
-      def get_paths(moji, formats = Emojidex::Defaults.formats, sizes = Emojidex::Defaults.sizes)
+      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
@@ -43,7 +45,21 @@ module Emojidex
         paths
       end
 
+      def get_paths(moji, formats = Emojidex::Defaults.formats,
+                    sizes = Emojidex::Defaults.sizes)
+        paths = {}
+        paths[:svg] = "#{@cache_path}/#{moji.code}.svg"
+        if formats.include? :png
+          paths[:png] = {}
+          sizes.keys.each do |size|
+            paths[:png][size] = "#{@cache_path}/#{size}/#{moji.code}.png"
+          end
+        end
+        paths
+      end
+
       private
+
       def _checksum_for_file(path)
         (File.exist? path) ? Digest::MD5.file(path).hexdigest : nil
       end

data/lib/emojidex/data/collection/cache.rb

@@ -18,15 +18,25 @@ module Emojidex
         # check if cache dir is already set
         return @cache_path if @cache_path && path.nil?
         # setup cache
-        @cache_path = File.expand_path((path || ENV['EMOJI_CACHE'] || "#{ENV['HOME']}/.emojidex/") + '/emoji')
+        @cache_path =
+          File.expand_path((path || Emojidex::Defaults.system_cache_path) + '/emoji')
         # ENV['EMOJI_CACHE'] = @cache_path
         FileUtils.mkdir_p(@cache_path)
         Emojidex::Defaults.sizes.keys.each do |size|
           FileUtils.mkdir_p(@cache_path + "/#{size}")
         end
+        # load will expect emoji.json even if it contains no emoji
+        unless File.exist? "#{cache_path}/emoji.json"
+          File.open("#{@cache_path}/emoji.json", 'w') { |f| f.write '[]' }
+        end
         @cache_path
       end
 
+      def load_cache(path = nil)
+        setup_cache(path)
+        load_local_collection(@cache_path)
+      end
+
       # Caches emoji to local emoji storage cache
       # Options:
       #   cache_path: manually specify cache location
@@ -61,37 +71,42 @@ module Emojidex
       def write_index(destination)
         idx = @emoji.values.to_json
         idx = JSON.parse idx
-        idx.each { |moji| moji.delete_if{ |k, v| v.nil? }}
+        idx.each { |moji| moji.delete_if { |_k, v| v.nil? } }
         File.open("#{destination}/emoji.json", 'w') { |f| f.write idx.to_json }
       end
 
       private
 
       def _svg_check_copy(moji)
-        @download_queue << { moji: moji, formats: :svg, sizes: [] } if @vector_source_path.nil? && @source_path.nil?
+        if @vector_source_path.nil? && @source_path.nil?
+          @download_queue << { moji: moji, formats: :svg, sizes: [] }
+        end
         @vector_source_path = @source_path if @vector_source_path.nil?
         src = "#{@vector_source_path}/#{moji.code}.svg"
         if File.exist? "#{src}"
           unless File.exist?("#{@cache_path}/#{moji.code}") &&
-              FileUtils.compare_file("#{src}", "#{@cache_path}/#{moji.code}.svg")
+                 FileUtils.compare_file("#{src}", "#{@cache_path}/#{moji.code}.svg")
             FileUtils.cp("#{src}", @cache_path)
           end
         else
-          _cache_svg_from_net(moji)
+          @download_queue << { moji: moji, formats: :svg, sizes: [] }
         end
         FileUtils.cp_r src, @cache_path if File.directory? src
       end
 
       def _raster_check_copy(moji, format, sizes)
-        @download_queue << { moji: moji, formats: [format], sizes: sizes } if @raster_source_path.nil? && @source_path.nil?
+        if @raster_source_path.nil? && @source_path.nil?
+          @download_queue << { moji: moji, formats: [format], sizes: sizes }
+        end
         @raster_source_path = @source_path if @raster_source_path.nil?
-        _cache_raster_from_net(moji, format, sizes) if @raster_source_path.nil?
+        moji.cache(format, sizes) if @raster_source_path.nil?
         sizes.each do |size|
+          next if File.exist? "#{@cache_path}/#{size}/#{moji.code}.#{format}" # TODO: check checksums
           src = "#{@raster_source_path}/#{size}/#{moji.code}"
           if FileTest.exist? "#{src}.#{format}"
             FileUtils.cp("#{src}.#{format}", ("#{@cache_path}/#{size}"))
-          else 
-            _cache_raster_from_net(moji, format, sizes)
+          else
+            @download_queue << { moji: moji, formats: [format], sizes: [size] }
           end
           FileUtils.cp_r(src, @cache_path) if File.directory? src
         end
@@ -101,36 +116,16 @@ module Emojidex
         thr = []
         @download_queue.each do |dl|
           thr << Thread.new { _cache_from_net(dl[:moji], dl[:formats], dl[:sizes]) }
-          thr.each { |t| t.join } if thr.length >= @download_threads
+          thr.each(&:join) if thr.length >= @download_threads
         end
       end
 
       def _cache_from_net(moji, formats, sizes)
         formats = *formats unless formats.class == Array
         dls = []
-        dls << Thread.new { _cache_svg_from_net(moji) } if formats.include? :svg
-        dls << Thread.new { _cache_raster_from_net(moji, :png, sizes) } if formats.include? :png
-        dls.each { |t| t.join }
-      end
-
-      def _cache_svg_from_net(moji)
-        target = "#{@cache_path}/#{moji.code}.svg"
-        if File.exist? target # check for an existing copy so we don't double downlaod
-          return if moji.checksum?(:svg).nil? # no updates if we didn't get details
-          # if the checksums are the same there is no reason to update
-          return if moji.checksum?(:svg) == get_checksums(moji, [:svg])[:svg]
-        end
-        response = Emojidex::Service::Transactor.download("#{moji.code}.svg")
-        File.open(target, 'wb') { |fp| 
-          fp.write(response.body) }
-      end
-
-      def _cache_raster_from_net(moji, format, sizes)
-        sizes.each do |size|
-          response = Emojidex::Service::Transactor.download("#{size}/#{moji.code}.#{format.to_s}")
-          File.open("#{@cache_path}/#{size}/#{moji.code}.#{format.to_s}", 'wb') { |fp| 
-            fp.write(response.body) }
-        end
+        dls << Thread.new { moji.cache(:svg) } if formats.include? :svg
+        dls << Thread.new { moji.cache(:png, sizes) } if formats.include? :png
+        dls.each(&:join)
       end
     end
   end