initials 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2dce220e10036fd5284e737264c5ed0a4f0f4e47211d4fec4812207e28dd3cf
-  data.tar.gz: 3eeebc342465b151e48ebd94d01e98d2f6a1bd0194851c5a2fc50d41103553af
+  metadata.gz: b1ddb7223bac6b77c96253275a3fcdc39d6de169c445650df95694f9897ad25b
+  data.tar.gz: 33af3be7bf7dbb56b6c2ad947fa2aa157b35f63bf98e515f4b8d852fa69ff514
 SHA512:
-  metadata.gz: 660d98bbbb542bf6a706614ab725c63f5d2e991236ff23ddaf443ec35ef2e0709677b51f4e3d94ffc9bea81f647d8135cf206513e07617710820cba2b71b7253
-  data.tar.gz: ddeb25f094cae8ffd4d8d7b01dc022b71898a45df031a231051d2f18bfce8a1b5392b9ed4e3ae41dba4398087ab7856a3f2f0f21c74dabed382cb5151c93998d
+  metadata.gz: a8f6b21b1f49b69cb49693b3f157f9597542597140e96b1124f8c2c13087326d5e1a4183b353393740fa82e91e3d6e9e789c8eb74eab9688b9069129708f1265
+  data.tar.gz: 3b62b60389a157f0713717bb086ec40a3c4b74edbe139609fef642535cd33df84672a61b50661ffd8ac3332e839409a376a9146dc977356e7b62b1434b8fa0e6

data/.gitignore

@@ -12,3 +12,5 @@
 
 # SimpleCov reports
 coverage
+
+Gemfile.lock

data/README.md

@@ -1,9 +1,11 @@
-# ![demo](demo.png) Initials [![Maintainability](https://api.codeclimate.com/v1/badges/fb865ec4adcd0671dc48/maintainability)](https://codeclimate.com/github/thutterer/initials/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/fb865ec4adcd0671dc48/test_coverage)](https://codeclimate.com/github/thutterer/initials/test_coverage)
+# Initials [![Maintainability](https://api.codeclimate.com/v1/badges/fb865ec4adcd0671dc48/maintainability)](https://codeclimate.com/github/thutterer/initials/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/fb865ec4adcd0671dc48/test_coverage)](https://codeclimate.com/github/thutterer/initials/test_coverage)
 
 Don't want to implement user avatar uploads but still have basic avatars to distinguish users and brigthen up your app?
 
 Use colorful SVGs as user avatars in any Ruby and Rails application.
 
+![demo](demo.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,6 +25,7 @@ Or install it yourself as:
 ## Usage
 
 Call `Initials.svg("Morty Smith")` anywhere to get a colorful initials avatar SVG as string.
+The avatar's background color is based on the provided name and the font-size is adjusted to fit between one and three character initials.
 
 ### Rails
 
@@ -46,11 +49,14 @@ Initials automatically marks its created SVG strings as `html_safe`.
 
 You can pass the following options into `Initials.svg` or your `user_avatar` helper:
 
-```rb
-user_avatar(current_user.name, size: 96)
+```ruby
+user_avatar(current_user.name, 
+  limit: 1, # sets max length for initials
+  size: 96  # sets SVG height and width in pixel
+)
 ```
 
-This sets `width` and `height` to `96px` in the SVG. Of course, you can also use CSS to make the SVG have different sizes in different places of your HTML.
+Of course, you can also use CSS to make the SVG have different sizes in different places of your HTML.
 
 ## Development
 

data/lib/initials/svg.rb

@@ -1,10 +1,11 @@
 module Initials
   class SVG
-    attr_reader :name, :size
+    attr_reader :name, :limit, :size
 
-    def initialize(name, size: 32)
+    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)
       @name = name
+      @limit = limit
       @size = size
     end
 
@@ -12,7 +13,7 @@ module Initials
       svg = [
         "<svg width='#{size}' height='#{size}'>",
           "<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: bold #{font_size}px sans-serif; user-select: none;'>",
+          "<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>",
         "</svg>"
@@ -31,7 +32,7 @@ module Initials
     end
 
     def initials
-      name.split(' ')[0, 3].map { |s| s[0].capitalize }.join
+      name.split(' ')[0, limit].map { |s| s[0].capitalize }.join
     end
   end
 end

data/lib/initials/version.rb

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

metadata

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