face-no-more 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 124bf237d91787cc4cfd04d77c117f0aff8069eeae6382707d1669566d4e25a7
+  data.tar.gz: 3c0b4aa07cf08603f80ef380b113a9e8ac6ee7c297dbe6ac84ed87a4df778091
+SHA512:
+  metadata.gz: bd9bd3f7bb2f9818c2524f39268516645abc6830a86d83ff6ae94b6a5d9303c8933f941b08b0ed6259e80f6fb91c342ebdeffeed156d227e53379c1d6348d019
+  data.tar.gz: 2bf2b7276b1489d924aaf1fb2d09d79a74bc2b9ee9db87a7548420942099b5f8a2038d1daf4e7b7b4a150bd3942a3f80ed77812e1bb1229ba3f6726d43258663

data/README.md

@@ -0,0 +1,37 @@
+Description
+===========
+
+Allow generating avatar pictures from ruby.
+
+The supported avatar type are: `cat`, `bird`, `abstract`, `mobilizon`,
+`8bit-female` and `8bit-male`.
+
+
+Examples
+========
+
+~~~ruby
+require 'face-no-more'
+
+# Number of possible avatars
+count = FaceNoMore.possibilities(:mobilizon)
+
+# Generate avatar picture
+jpg = FaceNoMore.generate(:cat, "foo@example.com", format: :jpg, size: 256)
+png = FaceNoMore.generate(:bird, 12345678910)
+~~~
+
+
+
+Artworks
+========
+* `cat`, `bird`, `abstract` and `mobilizon` are from [David Revoy][2]
+  licensed under [CC-By 4.0][4]
+* `8bit-female` and `8bit-male` are from [matveyco][3]
+
+
+
+[2]: http://www.peppercarrot.com
+[3]: https://github.com/matveyco/8biticon
+[4]: http://creativecommons.org/licenses/by/4.0/
+

data/face-no-more.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require_relative 'lib/face-no-more/version'
+
+Gem::Specification.new do |s|
+    s.name        = 'face-no-more'
+    s.version     = FaceNoMore::VERSION
+    s.summary     = "Generate avatars"
+    s.description =  <<~EOF
+      Generate avatars from artwork assets.
+      Included 5 different types of artwork: cat, bird, abstract, mobilizon, and 8bit.
+      EOF
+
+    s.homepage    = 'https://gitlab.com/sdalu/face-no-more'
+    s.license     = 'MIT'
+
+    s.authors     = [ "Stéphane D'Alu" ]
+    s.email       = [ 'stephane.dalu@insa-lyon.fr' ]
+
+    s.files       = %w[ README.md face-no-more.gemspec ] +
+                    Dir['lib/**/*.rb'] + Dir['data/**']
+
+    s.add_dependency 'rmagick'
+    s.add_development_dependency 'yard', '~>0'
+    s.add_development_dependency 'rake', '~>13'
+end

data/lib/face-no-more/version.rb

@@ -0,0 +1,4 @@
+module FaceNoMore
+    # Version string
+    VERSION = '0.1.1'
+end

data/lib/face-no-more.rb

@@ -0,0 +1,168 @@
+# coding: utf-8
+require 'securerandom'
+require 'digest'
+require 'rmagick'
+
+
+# Generate avatar
+#
+# ~~~ruby
+# require 'face-no-more'
+# 
+# FaceNoMore.generate(:cat, "foo@example.com", format: :jpg, size: 256)
+# FaceNoMore.generate(:bird, 12345678910)
+# ~~~
+
+
+module FaceNoMore
+    # @!visibility private
+    IMAGES_DIR   = File.join(__dir__, '..', 'data', 'images')
+
+    # @!visibility private
+    # NOTE: - Limited to 16 parts
+    #       - Keep sizes sorted from small to big
+    DESCRIPTIONS = {
+        :cat => {
+            :author     => 'David Revoy',
+            :license    => 'CC-BY',
+            :src        => 'https://www.peppercarrot.com/extras/html/2016_cat-generator/',
+            :sizes      => [ 256 ],
+            :partname   => "%<part>s_%<id>d.png",
+            :parts      => { :body        => 1..15,
+                             :fur         => 1..10,
+                             :eyes        => 1..15,
+                             :mouth       => 1..10,
+                             :accessorie  => 1..20 },
+            
+        },
+        :bird => {
+            :author     => 'David Revoy',
+            :license    => 'CC-BY',
+            :src        => 'https://www.peppercarrot.com/extras/html/2019_bird-generator/',
+            :sizes      => [ 256 ],
+            :partname   => "%<part>s_%<id>d.png",
+            :parts      => { :tail        => 1..9,
+                             :hoop        => 1..10,
+                             :body        => 1..9,
+                             :wing        => 1..9,
+                             :eyes        => 1..9,
+                             :bec         => 1..9,
+                             :accessorie  => 1..20, },
+        },
+        :abstract => {
+            :author     => 'David Revoy',
+            :license    => 'CC-BY',
+            :src        => 'https://www.peppercarrot.com/extras/html/2017_abstract-generator/',
+            :sizes      => [ 256 ],
+            :partname   => "%<part>s_%<id>d.png",
+            :parts      => { :body        => 1..15,
+                             :fur         => 1..10,
+                             :eyes        => 1..15,
+                             :mouth       => 1..10, },
+        },
+        :mobilizon => {
+            :author     => 'David Revoy',
+            :license    => 'CC-BY',
+            :src        => 'https://www.peppercarrot.com/extras/html/2020_mobilizon-generator/',
+            :sizes      => [ 256, 1024 ],
+            :partname   => "%<part>s_%<id>02d.png",
+            :parts      => { :body        => 1..25,
+                             :nose        => 1..10,
+                             :tail        => 1..5,
+                             :eyes        => 1..10,
+                             :mouth       => 1..10,
+                             :accessories => 1..20,
+                             :misc        => 1..20,
+                             :hat         => 1..20, },
+        },
+        :'8bit-female' => {
+            :author     => 'matveyco',
+            :src        => 'https://github.com/matveyco/8biticon',
+            :path       => '8bit/female',
+            :sizes      => [ 400 ],
+            :partname   => "%<part>s%<id>d.png",
+            :parts      => { :face        => 1..4,
+                             :clothes     => 1..59,
+                             :mouth       => 1..17,
+                             :head        => 1..33,
+                             :eye         => 1..53, },
+        },
+        :'8bit-male' => {
+            :author     => 'matveyco',
+            :src        => 'https://github.com/matveyco/8biticon',
+            :path       => '8bit/male',
+            :sizes      => [ 400 ],
+            :partname   => "%<part>s%<id>d.png",
+            :parts      => { :face        => 1..4,
+                             :clothes     => 1..65,
+                             :mouth       => 1..26,
+                             :hair        => 1..36,
+                             :eye         => 1..32, },
+        },
+    }
+
+
+    # List of supported avatar types
+    TYPES = DESCRIPTIONS.keys.freeze
+
+    
+    # Return the number of different avatar possible
+    #
+    # @param type type of avatar
+    #
+    # @return [Integer]
+    #
+    def self.possibilities(type)
+        DESCRIPTIONS.fetch(type) {
+            raise ArgumentError, "unsupported type (#{type})"
+        }[:parts].map {|part, range| range.last - range.first }
+                 .reduce(:*)
+    end
+
+    
+    # Generate an avatar
+    #
+    # @param type    [Symbol]  type of avatar
+    # @param seed    [String,Array<Integer>,Integer,nil] seed
+    # @param format  [:Symbol] picture format (as defined in ImageMagick)
+    # @param quality [Integer] picture quality (1..100)
+    # @param size    [Integer] picture size
+    #
+    # @return [String]
+    #
+    def self.generate(type, seed = nil, format: :png, quality: 90, size: 256)
+        desc      = DESCRIPTIONS.fetch(type) {
+                        raise ArgumentError, "unsupported type (#{type})" }
+        parts     = desc[:parts]
+        sizes     = desc[:sizes]
+        path      = File.join(IMAGES_DIR, desc[:path] || type.to_s)
+        partsize  = sizes.find {|s| size > s } || sizes.last
+        seedbytes = case seed
+                    when nil     then SecureRandom.random_bytes(16).bytes
+                    when String  then Digest::MD5.digest(seed).bytes
+                    when Array   then seed
+                    when Integer then parts.map {|_, r|
+                                          count     = r.end - r.begin + 1
+                                          seed, val = seed.divmod(count)
+                                          val }
+                    end
+
+        if parts.size > seedbytes.size
+            raise ArgumentError, "seed doesn't hold enough elements"
+        end
+
+
+        files = parts.each_with_index.map {|(part, range), index|
+                    mod = (range.end - range.begin) + 1
+                    id  = range.first + seedbytes[index] % mod
+                    File.join(path, partsize.to_s,
+                              desc[:partname] % { :part => part, :id   => id })
+                }
+        
+        Magick::ImageList.new(*files).flatten_images
+            .change_geometry!("#{size}x#{size}") { |cols, rows, me|
+                me.thumbnail!(cols, rows)
+            }.to_blob {|me| me.format  = format.to_s
+                            me.quality = quality }
+    end    
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: face-no-more
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Stéphane D'Alu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+description: |
+  Generate avatars from artwork assets.
+  Included 5 different types of artwork: cat, bird, abstract, mobilizon, and 8bit.
+email:
+- stephane.dalu@insa-lyon.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- face-no-more.gemspec
+- lib/face-no-more.rb
+- lib/face-no-more/version.rb
+homepage: https://gitlab.com/sdalu/face-no-more
+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.8
+signing_key:
+specification_version: 4
+summary: Generate avatars
+test_files: []