emojidex-converter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eca96b398c96a4bea4792951d367c36f9f1c8852
-  data.tar.gz: dae9f088cb49370d089f11a2e69d601d0ea5997f
+  metadata.gz: 24e45dc6b3dec2a38ceacbe368d2c3eafc7702e8
+  data.tar.gz: b58b995ecb7af840dc954a7a0910a78b134a378c
 SHA512:
-  metadata.gz: 8e7b1f51c202e1cb931e68a13b92705175c29c9ec6280bc32e8a7ec7912e90c5af38808af192e600e328762c8f03fe45b788d7df07172b0a83a71786a6facf80
-  data.tar.gz: 9e760bdf75c0a2074cdcaa0ab51acfe3f1935c810e8db719e2b00ac422699ad68d3ae52a1c4274f56444c1f1f98611be614df7cefb7b93dd3ad8d8e5ebb48665
+  metadata.gz: ae6186035b3952c32df12fb3d6ffdd5702e25e7666ca3219759cc4bf11e6c75d274b072b6ac72e277aec0f486ec5ae6cf2e83ce8bbb27042b02401544364ea90
+  data.tar.gz: 587bac316614d110a8686ef6b86e70426595b38e464ab59be98c909b306c834f7d6d0af7c3ef6136ffca62868d5478c6355bc460dfeb6a4d4583bc54b4f916ee

data/README.md

@@ -1,5 +1,49 @@
 [![Build Status](https://travis-ci.org/Genshin/emojidex-converter.svg)](https://travis-ci.org/Genshin/emojidex-converter)
 Emojidex Converter 
-------------------
+==================
+A set of tools for converting emoji arrays to and from vectors [SVG] and rasters [PNG].
 
-WIP
+Requirements
+------------
+Uses Phantom SVG, which in turn uses rapngasm.  
+rapngasm requires libapngasm to build, see instructions [here](https://github.com/apngasm/rapngasm).
+
+Usage
+-----
+**Instantiation:** 
+The default destination will be your local emojidex cache (set with environment variable $EMOJI_CACHE, defaults to $HOME/.emojidex/cache) or the current directory if $EMOJI_CACHE is not set.  
+- You can specify the destination manually with an options hash key of :destination.  
+- You can sepcify your own sizes using a :sizes hash. The keys to the hash become the directory names.
+```ruby
+converter = Emojidex::Converter.new(destination: "/output/destination/file/path", sizes: {super_huge: 2000, px12: 12})
+
+# sizes and output destination can be changed after initialization as well
+converter.destination = '/new/destination'
+converter.sizes = {superTiny: 3, '720p': 720}
+```
+
+**Pre-process SVG frames into animated SVGs:** 
+Used to compile folders with SVG frames and animation.json files into single key-framed SVG files. The pre-processor should be run on every collection directory with sub-directories containing SVG animation sources before rasterization.
+```ruby
+converter.preprocess('/path/to/collection')
+```
+
+**Convert an array of emoji with vector sources to rasters:**
+The emoji array is an array of Emojidex::Emoji objects.
+```ruby
+converter.rasterize(emoji_array, '/directory/with/SVG/sources')
+```
+
+**Convert an Emojidex::Collection:** 
+Emojidex::Collection objects contain references to their source directories so you only need to pass the collection object.
+```ruby
+converer.convert_collection(collection)
+```
+
+Contributing
+------------
+Fork, edit, commit, push, pull request!  
+emojidex-converter is a very primitivate, fairly single-purpose tool. If you can think of any features that could extend its functionality we'd love to see it!
+
+----
+exmojidex-toolkit©2014 emojidex™/Genshin Souzou K.K. [Phantom Creation Inc.]

data/emojidex-converter.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'emojidex-converter'
-  s.version       = '0.0.1'
+  s.version       = '0.0.2'
   s.license       = 'Equivilent to emojidex-toolkit'
   s.summary       = 'Image conversion modules for emojidex'
   s.description   = 'Adds the convert method to Emojidex::Collection and Emojidex::Emoji, which\

data/lib/emojidex/converter.rb

@@ -9,10 +9,10 @@ module Emojidex
         px16: 16, px32: 32, px64: 64, px128: 128, px256: 256 }
     end
 
-    attr_accessor :sizes, :formats, :location
+    attr_accessor :sizes, :destination
     def initialize(override = {})
       @sizes = override[:sizes] || Converter.default_sizes
-      @path = File.expand_path(override[:destination] || ENV['EMOJI_CACHE'] || './')
+      @destination = File.expand_path(override[:destination] || ENV['EMOJI_CACHE'] || './')
     end
 
     def rasterize(emoji, source_dir)
@@ -20,7 +20,7 @@ module Emojidex
         phantom_svg = Phantom::SVG::Base.new("#{source_dir}/#{moji.code}.svg")
         @sizes.each do |key, val|
           # Create out directory.
-          out_dir = "#{@path}/#{key}"
+          out_dir = "#{@destination}/#{key}"
           FileUtils.mkdir_p(out_dir)
 
           # Set size.
@@ -32,9 +32,13 @@ module Emojidex
       end
     end
 
-    def preprocess(source_dir)
+    def rasterize_collection(collection)
+      rasterize(collection.emoji.values, collection.source_path)
+    end
+
+    def preprocess(path)
       preprocessor = Emojidex::Preprocessor.new
-      preprocessor.compile_svg_animations(source_dir)
+      preprocessor.compile_svg_animations(path)
     end
   end
 end

data/spec/converter_spec.rb

@@ -51,4 +51,21 @@ describe Emojidex::Converter do
       expect(File.exist?("#{@destination}/px256/kiss.png")).to be_truthy
     end
   end
+
+  describe '.rasterize_collection' do
+    it 'converts an emojidex collection' do
+      setup_working_collection
+      converter.preprocess("#{@support_dir}/tmp/collection")
+      collection = Emojidex::Collection.new
+      collection.load_local_collection("#{@support_dir}/tmp/collection")
+      converter.rasterize_collection(collection)
+
+      expect(File.exist?("#{@destination}/ldpi/kiss.png")).to be_truthy
+    end
+  end
+
+  describe '.write_index' do
+    it 'writes an emojidex index (emoji.joson) at the destination' do
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emojidex-converter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rei Kagetsuki
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsvg2