avataaars 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60f039285cc32f5d8f61332fed8ac81c0781d85ffcfe59c7edc6b7865ee2e8fe
+  data.tar.gz: 7d157732e340a421768bf61f944933ffc087af5e7095478cb3facd7e58f8e1ae
+SHA512:
+  metadata.gz: 0a6456a02ff4752045f1888a6909df104152302957c5bc2103ffc4af36e2786fe9d134eda272be444ecb40f4ee8a7b7243f6a12a8c5e8fc7810292cdc87a5628
+  data.tar.gz: faf7e0f2d982558eece42d6023cacb8c871fc98d866a91c8bfc34b6ba4bd270e81ef0c556b80da90913a79d7cf32aad964a4304669dfe57721525eb40c79bf86

data/lib/avataaars.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'avataaars/version'
+
+require 'avataaars/errors'
+require 'avataaars/processor'
+require 'avataaars/utils'
+
+#
+# Avataaars interface for creating avatar SVGs from feature traits
+#
+class Avataaars
+  #
+  # @param [Hash] options Optional parameters to pass to avatar processor
+  #   see https://github.com/fangpenlin/avataaars
+  #
+  def initialize(options = {})
+    @root_path = options.delete :root_path
+    @options = options
+  end
+
+  #
+  # Call to avatar creation processor and return rendered SVG
+  #
+  # @return [String] The resulting SVG data
+  #
+  def create_avatar
+    normalised_options = Utils.normalize_object(@options)
+    processor.create_avatar normalised_options
+  end
+
+  private
+
+  def root_path
+    @root_path ||= Dir.pwd
+  end
+
+  def processor
+    Processor.new(root_path)
+  end
+end

data/lib/avataaars/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Avataaars
+  #
+  # Error classes for calling out to Avataaars NodeJS library
+  #
+  # Heavily based on the Schmooze library https://github.com/Shopify/schmooze
+  #
+  Error = Class.new(StandardError)
+  DependencyError = Class.new(Error)
+  module JavaScript # rubocop:disable Style/Documentation
+    Error = Class.new(::Avataaars::Error)
+    UnknownError = Class.new(Error)
+    def self.const_missing(name)
+      const_set name, Class.new(Error)
+    end
+  end
+end

data/lib/avataaars/js/processor.js

@@ -0,0 +1,48 @@
+// Setup imports
+try {
+  const Module = require('module');
+  // resolve libraries from the CWD instead of where this script is located
+  const libraryPaths = Module._nodeModulePaths(process.cwd());
+  var React = require(require.resolve('react', { paths: libraryPaths }));
+  var ReactDOMServer = require(require.resolve('react-dom/server', { paths: libraryPaths }));
+  var Avatar = require(require.resolve('avataaars', { paths: libraryPaths })).default;
+} catch (e) {
+  process.stdout.write(JSON.stringify(['err', e.toString()]));
+  process.stdout.write("\n");
+  process.exit(1);
+}
+process.stdout.write("[\"ok\"]\n");
+
+const _createAvatar = (async (options) => {
+  return ReactDOMServer.renderToString(
+    React.createElement(Avatar, options)
+  );
+});
+
+function _handleError(error) {
+  if (error instanceof Error) {
+    process.stdout.write(
+      JSON.stringify(['err', error.toString().replace(new RegExp('^' + error.name + ': '), ''), error.name])
+    );
+  } else {
+    process.stdout.write(JSON.stringify(['err', error.toString()]));
+  }
+  process.stdout.write("\n");
+}
+
+// Interface for communicating between Ruby processor and Node processor
+require('readline').createInterface({
+  input: process.stdin,
+  terminal: false,
+}).on('line', function(line) {
+  try {
+    Promise.resolve(_createAvatar.apply(null, JSON.parse(line)))
+      .then(function (result) {
+        process.stdout.write(JSON.stringify(['ok', result]));
+        process.stdout.write("\n");
+      })
+      .catch(_handleError);
+  } catch(error) {
+    _handleError(error);
+  }
+});

data/lib/avataaars/processor.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'open3'
+
+class Avataaars
+  #
+  # Processor helper class for calling out to Avataaars NodeJS library
+  #
+  # Heavily based on the Schmooze library https://github.com/Shopify/schmooze
+  #
+  class Processor
+    def initialize(app_root)
+      @app_root = app_root
+    end
+
+    def create_avatar(options)
+      puts "O: #{options}"
+
+      spawn_process
+      ensure_packages_are_initiated
+      call_js_method options
+    ensure
+      cleanup_process if stdin
+    end
+
+    private
+
+    attr_reader :app_root, :stdin, :stdout, :stderr, :wait_thr
+
+    def spawn_process
+      @stdin, @stdout, @stderr, @wait_thr = Open3.popen3(
+        'node',
+        File.expand_path(File.join(__dir__, 'js/processor.js')),
+        chdir: app_root
+      )
+    end
+
+    def ensure_packages_are_initiated
+      input = stdout.gets
+      raise Avataaars::Error, "Failed to instantiate worker process:\n#{stderr.read}" if input.nil?
+
+      result = JSON.parse(input)
+      return if result[0] == 'ok'
+
+      cleanup_process
+      parse_package_error result[1]
+    end
+
+    def parse_package_error(error_message) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      package_name = error_message[/^Error: Cannot find module '(.*)'$/, 1]
+      raise Avataaars::Error, error_message unless package_name
+
+      begin
+        %w[dependencies devDependencies].each do |key|
+          next unless package_json.key?(key) && package_json[key].key?(package_name)
+
+          raise Avataaars::DependencyError, Utils.squish(<<~ERROR)
+            Cannot find module '#{package_name}'.
+            The module was found in '#{package_json_path}' however, please run 'npm install' from '#{app_root}'
+          ERROR
+        end
+      rescue Errno::ENOENT # rubocop:disable Lint/SuppressedException
+      end
+      raise Avataaars::DependencyError, Utils.squish(<<~ERROR)
+        Cannot find module '#{package_name}'. You need to add it to '#{package_json_path}' and run 'npm install'
+      ERROR
+    end
+
+    def package_json_path
+      @package_json_path ||= File.join(app_root, 'package.json')
+    end
+
+    def package_json
+      @package_json ||= JSON.parse(File.read(package_json_path))
+    end
+
+    def call_js_method(options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      stdin.puts JSON.dump([options])
+      input = stdout.gets
+      raise Errno::EPIPE, "Can't read from worker" if input.nil?
+
+      status, message, error_class = JSON.parse(input)
+
+      if status == 'ok'
+        message
+      elsif error_class.nil?
+        raise Avataaars::JavaScript::UnknownError, message
+      else
+        raise Avataaars::JavaScript.const_get(error_class, false), message
+      end
+    rescue Errno::EPIPE, IOError
+      raise Avataaars::Error, "Worker process failed:\n#{stderr.read}"
+    end
+
+    def cleanup_process
+      stdin.close
+      stdout.close
+      stderr.close
+      wait_thr.join
+    end
+  end
+end

data/lib/avataaars/utils.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class Avataaars
+  #
+  # Utility class for Avataaars helper methods
+  #
+  class Utils
+    #
+    # Deep transform the keys in an object (Hash/Array)
+    #
+    # Copied from active support
+    # @see active_support/core_ext/hash/keys.rb
+    #
+    def self.deep_transform_keys_in_object(object, &block)
+      case object
+      when Hash
+        object.each_with_object({}) do |(key, value), result|
+          result[yield(key)] = deep_transform_keys_in_object(value, &block)
+        end
+      when Array
+        object.map { |e| deep_transform_keys_in_object(e, &block) }
+      else
+        object
+      end
+    end
+
+    #
+    # Recursively normalizes hash objects with camelized string keys
+    #
+    def self.normalize_object(object)
+      deep_transform_keys_in_object(object) { |k| normalize_key(k) }
+    end
+
+    #
+    # Normalizes hash keys into camelized strings
+    #
+    # Regex sourced from ActiveSupport camelize
+    #
+    def self.normalize_key(key)
+      key.to_s.downcase.gsub(%r{(?:_|(/))([a-z\d]*)}) do
+        "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+      end
+    end
+    private_class_method :normalize_key
+  end
+end

data/lib/avataaars/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Avataaars
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: avataaars
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Bromwich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+description: Ruby wrapper library to call to avataaars React component using NodeJS
+email:
+- abromwich@studiosity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/avataaars.rb
+- lib/avataaars/errors.rb
+- lib/avataaars/js/processor.js
+- lib/avataaars/processor.rb
+- lib/avataaars/utils.rb
+- lib/avataaars/version.rb
+homepage: https://github.com/Studiosity/avataaars-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to transform attributes into avatar SVGs using the React avataaars
+  library through NodeJS
+test_files: []