initials 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ddb7223bac6b77c96253275a3fcdc39d6de169c445650df95694f9897ad25b
-  data.tar.gz: 33af3be7bf7dbb56b6c2ad947fa2aa157b35f63bf98e515f4b8d852fa69ff514
+  metadata.gz: 74189037b48b4afad67b1139cb85e50385a64cfcfb4f5fc49aa9cc7d1f71332e
+  data.tar.gz: dbbeacbc6d9a6ea6705aab982a822ff51423271fc3dc0425f00f45298b6416fa
 SHA512:
-  metadata.gz: a8f6b21b1f49b69cb49693b3f157f9597542597140e96b1124f8c2c13087326d5e1a4183b353393740fa82e91e3d6e9e789c8eb74eab9688b9069129708f1265
-  data.tar.gz: 3b62b60389a157f0713717bb086ec40a3c4b74edbe139609fef642535cd33df84672a61b50661ffd8ac3332e839409a376a9146dc977356e7b62b1434b8fa0e6
+  metadata.gz: 6f62f412c72180e8430fab32b54ad3dfc9fe13e722e7e076fc4112bb04abdb5987570cf6b07254367b13f8335aea494689cfc05d0f970f3d9fc701d3fa413eaf
+  data.tar.gz: 683b723bb2fac2f305558966614c4e6baf3407c1b441335667b65350e34a8f4fbbc2be22b84b540e85159ed6cd8b9798cf2374b4834404cc7f667827c829e1b2

data/README.md

@@ -50,9 +50,11 @@ Initials automatically marks its created SVG strings as `html_safe`.
 You can pass the following options into `Initials.svg` or your `user_avatar` helper:
 
 ```ruby
-user_avatar(current_user.name, 
-  limit: 1, # sets max length for initials
-  size: 96  # sets SVG height and width in pixel
+user_avatar(current_user.name,
+  colors: 8,    # number of different colors, default: 12
+  limit: 1,     # maximal initials length, default: 3
+  shape: :rect, # background shape, default: :cirlce
+  size: 96      # SVG height and width in pixel, default: 32
 )
 ```
 

data/lib/initials/svg.rb

@@ -1,18 +1,28 @@
 module Initials
   class SVG
-    attr_reader :name, :limit, :size
+    HUE_WHEEL = 360
 
-    def initialize(name, limit: 3, size: 32)
-      raise Initials::Error.new("Name is not a string or empty") unless (name.respond_to?(:to_s) && name.to_s.length > 0)
+    attr_reader :name, :colors, :limit, :shape, :size
+
+    def initialize(name, colors: 12, limit: 3, shape: :circle, size: 32)
       @name = name
+      @colors = colors
       @limit = limit
+      @shape = shape
       @size = size
+
+      raise Initials::Error.new("Name is not a string or empty.") unless (name.respond_to?(:to_s) && name.to_s.length > 0)
+      raise Initials::Error.new("Colors must be a divider of 360 e.g. 24 but not 16.") unless valid_colors?
+      raise Initials::Error.new("Size is not a positive integer.") unless valid_size?
     end
 
     def to_s
       svg = [
         "<svg width='#{size}' height='#{size}'>",
-          "<circle cx='#{size / 2}' cy='#{size / 2}' r='#{size / 2}' fill='#{fill}' />",
+          shape == :rect ?
+            "<rect width='#{size}' height='#{size}' rx='#{size / 32}' ry='#{size / 32}' fill='#{fill}' />"
+          :
+            "<circle cx='#{size / 2}' cy='#{size / 2}' r='#{size / 2}' fill='#{fill}' />",
           "<text x='50%' y='50%' fill='white' fill-opacity='0.75' dominant-baseline='central' text-anchor='middle' style='font-size: #{font_size}px; font-family: -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, Oxygen-Sans, Ubuntu, Cantarell, \"Helvetica Neue\", sans-serif; user-select: none;'>",
             "#{initials}",
           "</text>",
@@ -23,7 +33,15 @@ module Initials
     end
 
     def fill
-      hue = name.split("").sum { |c| c.ord } % 360
+      hue_step = HUE_WHEEL / colors
+      char_sum = name.split("").sum do |c|
+        # Multiplication makes sure neighboring characters (like A and B) are one hue step apart.
+        c.ord * hue_step
+      end
+
+      # Spin the wheel!
+      hue = char_sum % HUE_WHEEL
+      
       "hsl(#{hue}, 40%, 40%)"
     end
 
@@ -34,5 +52,18 @@ module Initials
     def initials
       name.split(' ')[0, limit].map { |s| s[0].capitalize }.join
     end
+
+    private
+
+    def valid_colors?
+      return false unless colors.respond_to?(:to_i)
+      return false unless colors > 0
+      HUE_WHEEL % colors == 0
+    end
+
+    def valid_size?
+      return false unless size.respond_to?(:to_i)
+      size.to_i > 0
+    end
   end
 end

data/lib/initials/version.rb

@@ -1,3 +1,3 @@
 module Initials
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: initials
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Thomas Hutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-19 00:00:00.000000000 Z
+date: 2021-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler