somemoji 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb3b0923dfa3d0f5b047e54028fc235ce6bc475a
-  data.tar.gz: c00021c451b2482a7c1a559b90de99747208c8d4
+  metadata.gz: a5968df8d5cdd9d90f4ed13049765d15d1bc98df
+  data.tar.gz: 3809aa17d978c8a7569d03a3675833d5619b4de4
 SHA512:
-  metadata.gz: 0fb106ddabc5900bc370c61a90a2af8bd37554e380fba0e64fd333ae8069c986d27c1fe0e978e339e73021457c09a4ae60c57b93c9521844dfb0466e0f7a1127
-  data.tar.gz: 8efdff1491f24a93f517464eb058046813d6fb65f1914b07351f34e0e0c0bb2ed28c8fac50b9fdf7c120ad7397c8068038f691d2d0065c608a87a480802a121c
+  metadata.gz: ecf472874f03a6319c174b0e0366bae4e202014198ac0d3bac0f5e9ebbdd80cf8f49481da7dcab5b84519753340f4000a31edd4083d0248a9145009b5e6a52e5
+  data.tar.gz: 0bcd7d90ac15d8e35feb063e5e3b27e51ce8b9165de952f2f251f25bc5744269495b5f7f3157eaafb83db454370a3ee5e23a0e3a17854153b760a39920164c9f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.4.0
+
+- Add `somemoji` executable to extract emoji images
+
 ## v0.3.2
 
 - Fix bug: nil.map raises error on no code_points emoji :bug:

data/README.md

@@ -33,9 +33,25 @@ Or install it yourself as:
 gem install somemoji
 ```
 
-## Documentation
+## Command line tool
 
-See API documentation at http://www.rubydoc.info/github/r7kamura/somemoji.
+`somemoji` executable is bundled to extract images from each emoji provider.
+
+```
+$ somemoji --help
+Usage: somemoji extract [options]
+    -p, --provider     (required) apple, emoji_one, noto, or twemoji
+    -d, --destination  (required) directory path to locate extracted image files
+    -f, --format       png or svg (default: png)
+    -s, --size         Some providers have different size image files
+    -h, --help         Display this help message
+```
+
+To extract emojis from Twemoji to ./images/emoji directory, execute:
+
+```bash
+somemoji extract --provider=twemoji --destination=./images/emoji
+```
 
 ## Use cases
 
@@ -107,3 +123,7 @@ class EmojiFilter < ::HTML::Pipeline::Filter
   end
 end
 ```
+
+## Documentation
+
+See API documentation at http://www.rubydoc.info/github/r7kamura/somemoji.

data/exe/somemoji

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "somemoji"
+
+builder = Somemoji::CommandBuilder.new(ARGV)
+command = builder.build
+command.call

data/lib/somemoji/command_builder.rb

@@ -0,0 +1,24 @@
+module Somemoji
+  class CommandBuilder
+    # @param argv [Array<String>]
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # @return [Somemoji::Commands::BaseCommand]
+    def build
+      if command_line_arguments.valid?
+        ::Somemoji::Commands::ExtractCommand.new(command_line_arguments)
+      else
+        ::Somemoji::Commands::ErrorCommand.new(command_line_arguments)
+      end
+    end
+
+    private
+
+    # @return [Somemoji::CommandLineArguments]
+    def command_line_arguments
+      @command_line_arguments ||= ::Somemoji::CommandLineArguments.new(@argv)
+    end
+  end
+end

data/lib/somemoji/command_line_arguments.rb

@@ -0,0 +1,65 @@
+module Somemoji
+  class CommandLineArguments
+    # @param argv [Array<String>]
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # @return [String]
+    def destination
+      slop_parse_result[:destination]
+    end
+
+    # @return [String]
+    def error_message
+      slop_options.to_s
+    end
+
+    # @return [String, nil]
+    def format
+      slop_parse_result[:format]
+    end
+
+    # @return [String]
+    def provider_name
+      slop_parse_result[:provider]
+    end
+
+    # @return [Integer, nil]
+    def size
+      slop_parse_result[:size]
+    end
+
+    # @return [Boolean]
+    def valid?
+       command_name == "extract" && !slop_parse_result.nil?
+    end
+
+    private
+
+    # @return [String]
+    def command_name
+      @argv[0]
+    end
+
+    # @return [Slop::Options]
+    def slop_options
+      @slop_options ||= begin
+        slop_options = ::Slop::Options.new
+        slop_options.banner = "Usage: somemoji extract [options]"
+        slop_options.string "-p", "--provider", "(required) apple, emoji_one, noto, or twemoji"
+        slop_options.string "-d", "--destination", "(required) directory path to locate extracted image files"
+        slop_options.string "-f", "--format", "png or svg (default: png)"
+        slop_options.integer "-s", "--size", "Some providers have different size image files"
+        slop_options.bool "-h", "--help", "Display this help message"
+        slop_options
+      end
+    end
+
+    # @return [Slop::Result]
+    def slop_parse_result
+      @slop_parse_result ||= ::Slop::Parser.new(slop_options).parse(@argv)
+    rescue ::Slop::UnknownOption
+    end
+  end
+end

data/lib/somemoji/commands/base_command.rb

@@ -0,0 +1,21 @@
+module Somemoji
+  module Commands
+    class BaseCommand
+      # @param command_line_arguments [Somemoji::CommandLineArguments]
+      def initialize(command_line_arguments)
+        @command_line_arguments = command_line_arguments
+      end
+
+      def call
+        raise ::NotImplementedError
+      end
+
+      private
+
+      # @return [Somemoji::CommandLineArguments]
+      def command_line_arguments
+        @command_line_arguments
+      end
+    end
+  end
+end

data/lib/somemoji/commands/error_command.rb

@@ -0,0 +1,9 @@
+module Somemoji
+  module Commands
+    class ErrorCommand < BaseCommand
+      def call
+        abort(command_line_arguments.error_message)
+      end
+    end
+  end
+end

data/lib/somemoji/commands/extract_command.rb

@@ -0,0 +1,33 @@
+module Somemoji
+  module Commands
+    class ExtractCommand < BaseCommand
+      def call
+        if emoji_extractor_class && command_line_arguments.destination
+          emoji_extractor_class.new(
+            destination: command_line_arguments.destination,
+            format: command_line_arguments.format,
+            size: command_line_arguments.size,
+          ).extract
+        else
+          abort(command_line_arguments.error_message)
+        end
+      end
+
+      private
+
+      # @return [Class]
+      def emoji_extractor_class
+        case command_line_arguments.provider_name
+        when "apple"
+          ::Somemoji::EmojiExtractors::AppleEmojiExtractor
+        when "emoji_one"
+          ::Somemoji::EmojiExtractors::EmojiOneEmojiExtractor
+        when "noto"
+          ::Somemoji::EmojiExtractors::NotoEmojiExtractor
+        when "twemoji"
+          ::Somemoji::EmojiExtractors::TwemojiEmojiExtractor
+        end
+      end
+    end
+  end
+end

data/lib/somemoji/emoji_extractors/apple_emoji_extractor.rb

@@ -9,7 +9,7 @@ module Somemoji
 
       # @note Implementation for Somemoji::EmojiExtractors::BaseEmojiExtractor
       def extract
-        ::Emoji::Extractor.new(IMAGE_SIZE, @directory_path).extract!
+        ::Emoji::Extractor.new(IMAGE_SIZE, @destination).extract!
       end
     end
   end

data/lib/somemoji/emoji_extractors/base_emoji_extractor.rb

@@ -3,12 +3,12 @@ require "fileutils"
 module Somemoji
   module EmojiExtractors
     class BaseEmojiExtractor
-      # @param directory_path [String]
+      # @param destination [String]
       # @param format [String]
       # @param silence [Boolean]
       # @param size [Integer, nil]
-      def initialize(format: nil, directory_path:, silence: nil, size: nil)
-        @directory_path = directory_path
+      def initialize(format: nil, destination:, silence: nil, size: nil)
+        @destination = destination
         @format = format || "png"
         @silence = silence || false
         @size = size
@@ -21,7 +21,7 @@ module Somemoji
       private
 
       def make_directory
-        ::FileUtils.mkdir_p(@directory_path)
+        ::FileUtils.mkdir_p(@destination)
       end
 
       def silence?

data/lib/somemoji/emoji_extractors/downloadable_emoji_extractor.rb

@@ -23,8 +23,8 @@ module Somemoji
         http.use_ssl = true
         response = http.get(find_remote_emoji_path(emoji))
         if response.code == "200"
-          ::FileUtils.mkdir_p("#{@directory_path}/unicode")
-          ::File.write("#{@directory_path}/#{emoji.base_path}.#{extension}", response.body)
+          ::FileUtils.mkdir_p("#{@destination}/unicode")
+          ::File.write("#{@destination}/#{emoji.base_path}.#{extension}", response.body)
           true
         else
           false

data/lib/somemoji/version.rb

@@ -1,3 +1,3 @@
 module Somemoji
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/somemoji.rb

@@ -1,4 +1,10 @@
 require "json"
+require "slop"
+require "somemoji/command_builder"
+require "somemoji/command_line_arguments"
+require "somemoji/commands/base_command"
+require "somemoji/commands/error_command"
+require "somemoji/commands/extract_command"
 require "somemoji/emoji_collection"
 require "somemoji/emoji"
 require "somemoji/emoji_extractors/base_emoji_extractor"

data/somemoji.gemspec

@@ -15,12 +15,16 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.required_ruby_version = ">= 2.1.0"
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}).map{ |f| File.basename(f) }
 
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.1.0"
+
   spec.add_dependency "gemoji", "3.0.0.rc1"
   spec.add_dependency "json"
+  spec.add_dependency "slop", ">= 4.0.0"
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "gemojione", "3.2.0"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: somemoji
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +139,8 @@ dependencies:
 description: 
 email:
 - r7kamura@gmail.com
-executables: []
+executables:
+- somemoji
 extensions: []
 extra_rdoc_files: []
 files:
@@ -1933,7 +1948,13 @@ files:
 - data/emoji_definitions/zzz.json
 - data/noto_supported_characters.json
 - data/twemoji_supported_characters.json
+- exe/somemoji
 - lib/somemoji.rb
+- lib/somemoji/command_builder.rb
+- lib/somemoji/command_line_arguments.rb
+- lib/somemoji/commands/base_command.rb
+- lib/somemoji/commands/error_command.rb
+- lib/somemoji/commands/extract_command.rb
 - lib/somemoji/emoji.rb
 - lib/somemoji/emoji_collection.rb
 - lib/somemoji/emoji_extractors/apple_emoji_extractor.rb