letter_avatar 0.3.5 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f648e3d3e303081858371e1bbe2e164b76b68085
-  data.tar.gz: 5b55acfe7f9f5df46eea21b8d0b3867485950102
+SHA256:
+  metadata.gz: b6dacffd37b1ed6ffe0bd73e45b53e78633bad53c59ab6efd0aa130e468fde8c
+  data.tar.gz: 73a8007813254f22ab63d4c4146fd4ee864f7f3d391fc6d3b268112ad3f521b9
 SHA512:
-  metadata.gz: c3d835fedd766bda7395275f8e936703ffa323f2a6f0dc3c5050e1a6c24304cdd718c827df43af2ef0afdfbfa6d45d49bf0ba61d9e963d12ea173fcccf8bfaba
-  data.tar.gz: 4db45918f3221758b818cecc57e008c299d1de98ce0ea766c1a67341e0f265baab4f1950d462c9dc4c4db9b7bdf04d129c45767f68a2624f5fbb1a7044ead5a9
+  metadata.gz: 06a5a887dfcba06b5e1832127ca346ab8f95ff425dca8cb366c1dcab7bab967d3d47112c46f3ddc8c8915ea037a33d8bf96b80fd1163b2f4b69317d9e4c769b4
+  data.tar.gz: 4152a78ea6534e2391434a3923932e6548b59228ecf515e131220e1ea390ce20691122654310a634018a58f99d15b699321f8de900dcf25e651272753258f082

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+0.3.8
+-----
+
+- added `LetterAvatar.font` config option.
+
+0.3.7
+-----
+
+- added `LetterAvatar.custom_palette` config option.
+- bumped `FULLSIZE` to 600.
+
+0.3.6
+-----
+
+- added `LetterAvatar.letters_count` config option.
+- added `LetterAvatar.pointsize` config option.
+
 0.3.5
 -----
 

data/README.md

@@ -4,6 +4,7 @@ Gem for creating letter avatar from user's name (or any other strong / character
 
 Code extracted from [discourse](https://www.discourse.org/) source (thanks guys!) - I needed this functionality in three projects, so here's the gem! :-)
 
+[![Gem Version](https://badge.fury.io/rb/letter_avatar.svg)](https://badge.fury.io/rb/letter_avatar)
 [![Code Climate](https://codeclimate.com/github/ksz2k/letter_avatar/badges/gpa.svg)](https://codeclimate.com/github/ksz2k/letter_avatar)
 
 ## Examples
@@ -53,17 +54,40 @@ LetterAvatar.setup do |config|
   config.colors_palette    = :iwanthue                # default is :google
   config.weight            = 500                      # default is 300
   config.annotate_position = '-0+10'                  # default is -0+5
+  config.letters_count     = 2                        # default is 1
+  config.pointsize         = 70                       # default is 140
 end
 ```
 
 #### Color palette
 
-We have two color palettes implemented: `iwanthue` and `google`.
+We have three color palettes implemented: `iwanthue`, `google` and `custom`.
 
 Each of them have different colors, but the `iwanthue` also differently calculates the color for specified username.
 
 The `google` selected will generate the same avatar for both, "Krzysiek" and "ksz2k" usernames given (both of them starts with letter "k"), but `iwanthue` will calculate it's md5 and then selects color, so there's huge chance that these usernames get different colors.
 
+##### Custom palette definition
+
+You can define your own `custom` palette:
+
+```ruby
+LetterAvatar.setup do |config|
+  config.colors_palette = :custom
+  config.custom_palette = [[120, 132, 205], [91, 149, 249], [72, 194, 249], [69, 208, 226]]
+end
+```
+
+##### Custom font definition
+
+You can define your own `custom` palette:
+
+```ruby
+LetterAvatar.setup do |config|
+  config.font = File.join(File.expand_path('../../', File.dirname(__FILE__)), 'app/assets/fonts', 'font_name.ext')
+end
+```
+
 ## Usage
 
 ```ruby
@@ -99,6 +123,8 @@ There's also helper for this. To use it, you need:
 Say, you have a model `User` (which must have attribute or method `name`)
 
 ```ruby
+require 'letter_avatar/has_avatar'
+
 class User
   include LetterAvatar::HasAvatar
   ...

data/lib/letter_avatar/avatar.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module LetterAvatar
   class Avatar
     # BUMP UP if avatar algorithm changes
@@ -5,7 +7,7 @@ module LetterAvatar
 
     # Largest avatar generated, one day when pixel ratio hit 3
     # we will need to change this
-    FULLSIZE = 240
+    FULLSIZE = 600
 
     FILL_COLOR = 'rgba(255, 255, 255, 0.65)'.freeze
 
@@ -18,7 +20,8 @@ module LetterAvatar
         def self.from_username(username)
           identity = new
           identity.color = LetterAvatar::Colors.for(username)
-          identity.letter = username[0].upcase
+          letters = username.split(/\s+/).map {|word| word[0]}.join('')[0..LetterAvatar.letters_count - 1]
+          identity.letter = letters.upcase
 
           identity
         end
@@ -40,9 +43,11 @@ module LetterAvatar
         return filename if cache && File.exist?(filename)
 
         fullsize = fullsize_path(identity)
-        generate_fullsize(identity) if !cache || !File.exist?(fullsize)
+        if !cache || !File.exist?(fullsize)
+          generate_fullsize(identity) 
+        end 
+        LetterAvatar.resize(fullsize, filename, size, size) if size != FULLSIZE
 
-        LetterAvatar.resize(fullsize, filename, size, size)
         filename
       end
 
@@ -65,8 +70,8 @@ module LetterAvatar
             convert
             -size #{FULLSIZE}x#{FULLSIZE}
             xc:#{to_rgb(identity.color)}
-            -pointsize 140
-            -font #{FONT_FILENAME}
+            -pointsize #{LetterAvatar.pointsize}
+            -font #{LetterAvatar.font}
             -weight #{LetterAvatar.weight}
             -fill '#{LetterAvatar.fill_color}'
             -gravity Center

data/lib/letter_avatar/colors.rb

@@ -1,6 +1,8 @@
+require 'digest' 
+
 module LetterAvatar
   module Colors
-    PALETTES = [:google, :iwanthue]
+    PALETTES = [:google, :iwanthue, :custom]
 
     GOOGLE_COLORS = [
       [226, 95, 81], # A
@@ -256,7 +258,7 @@ module LetterAvatar
 
     def self.with_iwanthue(username)
       iwanthue[
-        Digest::MD5.hexdigest(username)[0...15].to_i(16) % iwanthue.length
+        ::Digest::MD5.hexdigest(username)[0...15].to_i(16) % iwanthue.length
       ]
     end
 
@@ -270,10 +272,23 @@ module LetterAvatar
       elsif /[\d]/ =~ char
         google[char.to_i]
       else
-        google[Digest::MD5.hexdigest(username)[0...15].to_i(16) % google.length]
+        google[::Digest::MD5.hexdigest(username)[0...15].to_i(16) % google.length]
       end
     end
 
+		def self.with_custom(username)
+			custom_palette = LetterAvatar.custom_palette
+			custom_palette[::Digest::MD5.hexdigest(username)[0...15].to_i(16) % custom_palette.length]
+		end
+		
+		def self.valid_custom_palette?(palette)
+			return false unless palette.is_a?(Array)
+			return palette.all? do |color| 
+				false unless color.is_a?(Array)
+				color.all? { |i| i.is_a?(Integer) }
+			end
+		end
+
     # Colors form Google Inbox
     # https://inbox.google.com
     def self.google

data/lib/letter_avatar/configuration.rb

@@ -8,6 +8,14 @@ module LetterAvatar
       @cache_base_path = v
     end
 
+    def font
+      @font || Avatar::FONT_FILENAME
+    end
+
+    def font=(v)
+      @font = v
+    end
+
     def fill_color
       @fill_color || Avatar::FILL_COLOR
     end
@@ -21,9 +29,19 @@ module LetterAvatar
     end
 
     def colors_palette=(v)
-      @colors_palette = v if v.in?(Colors::PALETTES)
+      @colors_palette = v if Colors::PALETTES.include?(v)
     end
 
+		def custom_palette
+      @custom_palette ||= nil
+		end
+
+		def custom_palette=(v)
+      @custom_palette = v
+      raise "Missing Custom Palette, please set config.custom_palette if using :custom" if @custom_palette.nil? && @colors_palette == :custom
+			raise "Invalid Custom Palette, please update config.custom_palette" unless Colors::valid_custom_palette?(@custom_palette)
+		end
+
     def weight
       @weight ||= 300
     end
@@ -39,5 +57,21 @@ module LetterAvatar
     def annotate_position=(v)
       @annotate_position = v
     end
+    
+    def letters_count
+      @letters_count ||= 1
+    end
+
+    def letters_count=(v)
+      @letters_count = v
+    end
+
+    def pointsize
+      @pointsize ||= 140
+    end
+
+    def pointsize=(v)
+      @pointsize = v
+    end
   end
 end

data/lib/letter_avatar/version.rb

@@ -1,3 +1,3 @@
 module LetterAvatar
-  VERSION = '0.3.5'
+  VERSION = '0.3.9'
 end

data/lib/letter_avatar.rb

@@ -31,7 +31,7 @@ module LetterAvatar
       ).join(' ')
     )
     true
-  rescue
+  rescue => e
     false
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letter_avatar
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.9
 platform: ruby
 authors:
 - Discourse Developers
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies: []
 description: Gem for creating letter avatar from user's name
 email:
@@ -49,8 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Create nice initals avatars from your users usernames