emojidex 0.1.0 → 0.2.0

data/lib/emojidex/data/collection/moji_data.rb

@@ -1,16 +1,18 @@
-module Emojidex::Data
-  # collects and condenses UTF moji codes within a collection
-  module CollectionMojiData
-    attr_reader :moji_code_string, :moji_code_index
+module Emojidex
+  module Data
+    # collects and condenses UTF moji codes within a collection
+    module CollectionMojiData
+      attr_reader :moji_code_string, :moji_code_index
 
-    def condense_moji_code_data
-      @moji_code_string = ""
-      @moji_code_index = {}
+      def condense_moji_code_data
+        @moji_code_string = ''
+        @moji_code_index = {}
 
-      @emoji.values.each do |moji|
-        if moji.moji != nil
-          @moji_code_string << moji.moji
-          @moji_code_index[moji.moji] = moji.code
+        @emoji.values.each do |moji|
+          unless moji.moji.nil?
+            @moji_code_string << moji.moji
+            @moji_code_index[moji.moji] = moji.code
+          end
         end
       end
     end

data/lib/emojidex/data/collection/static_collection.rb

@@ -8,12 +8,12 @@ module Emojidex
       def load_from_server(detailed = true, locale = '??')
         locale = Emojidex::EnvHelper.lang? if locale == '??'
         begin
-          res = Emojidex::Service::Transactor.get(@endpoint, {detailed: detailed, locale: locale})
+          res = Emojidex::Service::Transactor.get(@endpoint, detailed: detailed, locale: locale)
         rescue
-          return false
+          false
         end
         add_emoji(res)
-        return true
+        true
       end
 
       def check_and_load_static(collection)

data/lib/emojidex/data/emoji.rb

@@ -1,48 +1,65 @@
+require_relative '../../emojidex'
 require_relative 'emoji/asset_information'
 
-module Emojidex::Data
-  # emoji base class
-  class Emoji
-    attr_accessor :moji, :category, :code, :code_ja,
-                  :unicode, :tags, :emoticon, :variants, :base
-
-    include Emojidex::Data::EmojiAssetInformation
-
-    def initialize(details = {})
-      init_asset_info(details)
-      @moji = details[:moji]
-      @code, @code_ja = details[:code], details[:code_ja]
-      @unicode, @full_name = details[:unicode], details[:full_name]
-      @emoticon = details[:emoticon]
-      @category = details[:category] ? details[:category].to_sym : :other
-      @tags = details[:tags].map { |tag| tag.to_sym } unless details[:tags].nil?
-      @link = details[:link]
-      @variants, @base = details[:variants] || [], details[:base]
-      @is_wide = details[:is_wide]
-    end
+module Emojidex
+  module Data
+    # emoji base class
+    class Emoji
+      attr_accessor :moji, :category, :code, :code_ja,
+                    :unicode, :tags, :emoticon, :variants, :base
 
-    def to_s
-      @moji || ":#{@code}:"
-    end
+      include Emojidex::Data::EmojiAssetInformation
 
-    def to_json(*args)
-      to_hash.to_json(*args)
-    end
+      def initialize(details = {})
+        _init_identifier_info(details)
+        _init_descriptor_info(details)
+        init_asset_info(details)
+      end
 
-    def to_hash
-      hash = {}
-      instance_variables.each do |key|
-        hash[key.to_s.delete('@')] = instance_variable_get(key)
+      def to_s
+        @moji || Emojidex.encapsulate_code(@code)
       end
-      hash
-    end
 
-    def [](key)
-      instance_variable_get(key.to_s.delete(':').insert(0, '@'))
-    end
+      def to_json(*args)
+        to_hash.to_json(*args)
+      end
+
+      def to_hash
+        hash = {}
+        instance_variables.each do |key|
+          hash[key.to_s.delete('@')] = instance_variable_get(key)
+        end
+        hash
+      end
 
-    def []=(key, val)
-      instance_variable_set(key.to_s.delete(':').insert(0, '@'), val)
+      def [](key)
+        instance_variable_get(key.to_s.delete(':').insert(0, '@'))
+      end
+
+      def []=(key, val)
+        instance_variable_set(key.to_s.delete(':').insert(0, '@'), val)
+      end
+
+      private
+
+      def _init_identifier_info(details)
+        @moji = details[:moji].to_s
+        @code = Emojidex.escape_code(details[:code].to_s)
+        @code_ja = Emojidex.escape_code(details[:code_ja].to_s)
+        @unicode = details[:unicode].to_s
+        @full_name = details[:full_name].to_s
+        @emoticon = details[:emoticon].to_s
+      end
+
+      def _init_descriptor_info(details)
+        @category = details[:category] ? details[:category].to_sym : :other
+        @tags = details[:tags].map(&:to_sym) unless details[:tags].nil?
+        @link = details[:link].to_s
+        @variants = details[:variants] || []
+        @variants.uniq!
+        @base = details[:base]
+        @is_wide = details[:is_wide]
+      end
     end
   end
 end

data/lib/emojidex/data/emoji/asset_information.rb

@@ -1,10 +1,11 @@
+require 'digest/md5'
 require_relative '../../defaults'
 
 module Emojidex
   module Data
     # Asset information for emoji
     module EmojiAssetInformation
-      attr_accessor :checksums, :paths
+      attr_accessor :checksums, :paths, :local_checksums
 
       def init_asset_info(details)
         blank_checksums
@@ -25,6 +26,7 @@ module Emojidex
         Emojidex::Defaults.sizes.keys.each do |size|
           @checksums[:png][size] = nil
         end
+        @local_checksums = @checksums.dup
       end
 
       def fill_checksums(checksums)
@@ -35,10 +37,91 @@ module Emojidex
         end
       end
 
+      def fill_paths(paths)
+        @paths[:svg] = paths[:svg] if paths.include? :svg
+        return unless paths.include? :png
+        Emojidex::Defaults.sizes.keys.each do |size|
+          @paths[:png][size] = paths[:png][size] if paths[:png].include? size
+        end
+      end
+
+      # Acquires path and caches the target file if not found or out of date
+      def path(format, size = nil)
+        fp = path?(format, size)
+        cache(format, [size]) unless !fp.nil? && File.exist?(fp)
+        fp
+      end
+
       # returns asset path
       def path?(format, size = nil)
-        return @paths[format][size] unless size.nil?
-        @paths[format]
+        case format
+        when :svg
+          return @paths[format] if File.exist?(@paths[format])
+        when :png
+          return nil if size.nil?
+          return @paths[format][size] if File.exist?(@paths[format][size])
+        end
+        nil
+      end
+
+      # Caches a file of the specified format in the specified sizes
+      def cache(format, sizes = nil)
+        generate_local_checksums
+        case format
+        when :png
+          _cache_png(sizes) unless sizes.nil?
+        when :svg
+          _cache_svg
+        end
+      end
+
+      # Generates a checksum for each locally cached file
+      def generate_local_checksum(format, size = nil)
+        case format
+        when :png
+          return @local_checksums[:png][size] = _checksum_for_file(@paths[:png][size])
+        when :svg
+          return @local_checksum[:svg] = _checksum_for_file(@paths[:svg])
+        end
+        nil
+      end
+
+      def generate_local_checksums
+        @local_checksums[:svg] = _checksum_for_file(@paths[:svg])
+        @paths[:png].keys.each do |size|
+          @local_checksums[:png][size] = _checksum_for_file(@paths[:png][size])
+        end
+        @local_checksums
+      end
+
+      private
+
+      def _cache_svg
+        @paths[:svg] = Dir.pwd unless (@paths.include? :svg) && !@paths[:svg].nil?
+        return if File.exist?(@paths[:svg]) && !@checksums[:svg].nil? &&
+                  @checksums[:svg] == generate_local_checksum(:svg)
+        response = Emojidex::Service::Transactor.download("#{@code}.svg")
+        File.open(@paths[:svg], 'wb') { |fp| fp.write(response.body) }
+        generate_local_checksum(:svg)
+      end
+
+      def _cache_png(sizes)
+        sizes.each do |size|
+          unless @paths.include?(:png) &&
+                 @paths[:png].include?(size) && @paths[:png][size].nil? == false
+            @paths[:png][size] = "#{Dir.pwd}/#{size}/#{@code}.png"
+          end
+          next if File.exist?(@paths[:png][size]) &&
+                  !@checksums[:png][size].nil? &&
+                  @checksums[:png][size] == generate_local_checksum(:png, size)
+          response = Emojidex::Service::Transactor.download("#{size}/#{@code}.png")
+          File.open(@paths[:png][size], 'wb') { |fp| fp.write(response.body) }
+          generate_local_checksum(:png, size)
+        end
+      end
+
+      def _checksum_for_file(path)
+        (File.exist? path) ? Digest::MD5.file(path).hexdigest : nil
       end
     end
   end

data/lib/emojidex/data/extended.rb

@@ -7,8 +7,8 @@ module Emojidex
     class Extended < Collection
       include Emojidex::Data::StaticCollection
 
-      def initialize
-        super
+      def initialize(opts = {})
+        super(opts)
         @endpoint = 'extended_emoji'
         load_from_server unless check_and_load_static('extended')
         @emoji

data/lib/emojidex/data/utf.rb

@@ -7,8 +7,8 @@ module Emojidex
     class UTF < Collection
       include Emojidex::Data::StaticCollection
 
-      def initialize
-        super
+      def initialize(opts = {})
+        super(opts)
         @endpoint = 'utf_emoji'
         load_from_server unless check_and_load_static('utf')
         @emoji

data/lib/emojidex/defaults.rb

@@ -1,7 +1,7 @@
 module Emojidex
   # Global defines for emojidex
   class Defaults
-    @@selected_sizes = [:mdpi, :px32]
+    @@selected_sizes = [:hdpi, :px32]
     @@selected_formats = [:png]
 
     def self.sizes
@@ -31,5 +31,13 @@ module Emojidex
     def self.lang
       'en'
     end
+
+    def self.encapsulator
+      ':'
+    end
+
+    def self.system_cache_path
+      ENV['EMOJI_CACHE'] || "#{ENV['HOME']}/.emojidex/"
+    end
   end
 end

data/lib/emojidex/env_helper.rb

@@ -1,9 +1,8 @@
 module Emojidex
   # Obtains and parses local environment variables
   module EnvHelper
-
     def self.lang?
-      lang = ENV['LANG'].match('^..')
+      lang = ENV['LANG'].match('^..') if ENV.include? 'LANG'
       lang = 'en' unless lang.to_s == 'ja'
       lang
     end

data/lib/emojidex/service/collection.rb

@@ -6,61 +6,100 @@ module Emojidex
   module Service
     # A modified collection class for collections tied to the emojidex service
     class Collection < Emojidex::Data::Collection
-      attr_reader :endpoint, :page, :limit, :detailed, :auto_cache
+      attr_reader :endpoint, :page, :limit, :detailed, :auto_cache, :status
 
       def initialize(opts = {})
-        @emoji = {}
-        add_emoji(opts[:emoji]) && opts.delete(:emoji) if opts.include? :emoji
+        @opts = opts
 
-        @username = opts[:username] || nil
-        opts.delete(:username)
-        @auth_token = opts[:auth_token] || nil
-        opts.delete(:auth_token)
+        @status = ''
 
-        @endpoint = opts[:endpoint] || 'emoji'
-        opts.delete(:endpoint)
-        @page = opts[:page] || 0
-        opts.delete(:page)
-        @limit = opts[:limit] || Emojidex::Defaults.limit
-        opts.delete(:limit)
-        @detailed = opts[:detailed] || false
-        opts.delete(:detailed)
+        _init_emoji
+        _init_user_info
+        _init_endpoint
+        _init_cache
 
-        @auto_cache = opts[:auto_cache] || true
-        opts.delete(:auto_cache)
+        @auto_cache = @opts[:auto_cache] || true
+        @opts.delete(:auto_cache)
 
-        auto_init = opts[:auto_init] || true
-        opts.delete(:auto_init)
-
-        @opts = opts
+        auto_init = @opts[:auto_init] || true
+        @opts.delete(:auto_init)
 
         more if auto_init
+
         @emoji
       end
 
       # Get the next page worth of emoji and add them to the collection
-      def more()
+      def more
         @page += 1
 
         opts = { page: @page, limit: @limit, detailed: @detailed }
-        opts[:username] = @username unless @username.nil?
-        opts[:auth_token] = @auth_token unless @auth_token.nil?
+        opts[:username] = @username unless @username.nil? || @username == ''
+        opts[:auth_token] = @auth_token unless @auth_token.nil? || @auth_token == ''
         opts.merge! @opts
 
-        page_moji = Emojidex::Service::Transactor.get(@endpoint, opts)
+        begin
+          moji_page = Emojidex::Service::Transactor.get(@endpoint, opts)
+        rescue Error::Unauthorized => e
+          @status = e.message
+          return {}
+        rescue Error::PaymentRequired => e
+          @status = e.message
+          return {}
+        end
+
+        _process_moji_page(moji_page)
+      end
+
+      private
+
+      def _init_emoji
+        @emoji = {}
+        return unless @opts.include? :emoji
+        add_emoji(@opts[:emoji])
+        @opts.delete(:emoji)
+      end
+
+      def _init_user_info
+        @username = @opts[:username] || nil
+        @opts.delete(:username)
+        @auth_token = @opts[:auth_token] || nil
+        @opts.delete(:auth_token)
+      end
+
+      def _init_endpoint
+        @endpoint = @opts[:endpoint] || 'emoji'
+        @opts.delete(:endpoint)
+        @page = @opts[:page] || 0
+        @opts.delete(:page)
+        @limit = @opts[:limit] || Emojidex::Defaults.limit
+        @opts.delete(:limit)
+        @detailed = @opts[:detailed] || false
+        @opts.delete(:detailed)
+      end
 
-        if page_moji.is_a? Hash
-          unless page_moji.key? :emoji
+      def _process_moji_page(moji_page)
+        if moji_page.is_a? Hash
+          unless moji_page.key? :emoji
             @page -= 1 # reset page beacuse we failed
             return {}
           end
 
-          add_emoji(page_moji[:emoji])
-          return page_moji[:emoji]
+          return add_emoji(moji_page[:emoji])
         end
-        add_emoji(page_moji)
+
+        add_emoji(moji_page)
         cache! if @auto_cache
-        page_moji
+        moji_page
+      end
+
+      def _init_cache
+        if @opts.include? :cache_path
+          setup_cache(@opts[:cache_path])
+          @opts.delete :cache_path
+        else
+          setup_cache
+        end
       end
     end
   end