initials 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cf0672cb32ca9c0578082938d688e501b860f82f11f5fc5f9da391f600d7b67
-  data.tar.gz: cd64e5021b2d8546a1e83875139be27a266d776ec01f825fffd14e66122f0bc1
+  metadata.gz: 2967ee83aead20c8869af14e57d6a573298453f296187a64b8f2480e626e1d6c
+  data.tar.gz: 16577212cb755c24cd7d824c9dd1dd2f4be699173ffdf0d09edbc2c97228a070
 SHA512:
-  metadata.gz: 715df7ec0c73a894d9cb88e00be05c90d479dc489bb7dd72f2940d0d92543e02c9acba5e70e4ae3e569a099efeaad85368ee3e74d1e1a65bbbee7d6452fe4f3a
-  data.tar.gz: 7fe165889d701dc17d80b32b03744aa6a299b23eac88b901aea1c754f4af7d2f5143ce989ca7ae1992ff9a8d513c373cc29f01e2eb7f27bcbfb7e22cb155118a
+  metadata.gz: 894c0090dd2b77e3da58894a8350a4309d49bb2c88ef6d57ebb95b140e2bacd2b5a39887b600edc1bfeac967994b9ef34b5575e9d9273efc20a05d0a343b48a0
+  data.tar.gz: ed742e7bc42d1edc4528e28cc553b4c8afa0399ec0dc84d521eca0fc15a0423e9f9cd31fa206b4bc5a6ad2a4b52606b4ed4317141eafffd47f1871b42bd4bd7f

data/.github/workflows/ruby.yml

@@ -31,5 +31,9 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake
+    - name: Run tests and publish code coverage
+      uses: paambaati/codeclimate-action@v2.7.5
+      env:
+        CC_TEST_REPORTER_ID: 9c690ab71ab481ac45785c4010ff30f93a45774e5ad6f03ec448b6e2b5bc39b4
+      with:
+        coverageCommand: bundle exec rake

data/.gitignore

@@ -9,3 +9,8 @@
 
 # rspec failure tracking
 .rspec_status
+
+# SimpleCov reports
+coverage
+
+Gemfile.lock

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in initials.gemspec
 gemspec
+
+gem 'simplecov', require: false, group: :test

data/README.md

@@ -1,9 +1,11 @@
-# Initials
+# 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
 
@@ -30,7 +33,7 @@ No special configuration is required to work with Ruby on Rails, but for your co
 
 ```ruby
 def user_avatar(name, **options)
-  Initials.svg(name, options)
+  Initials.svg(name, **options)
 end
 ```
 
@@ -46,11 +49,16 @@ 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,
+  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
+)
 ```
 
-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,18 +1,32 @@
 module Initials
   class SVG
-    attr_reader :name, :size
+    HUE_WHEEL = 360
 
-    def initialize(name, 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
+    attr_reader :name, :colors, :limit, :shape, :size
+
+    def initialize(name, colors: 12, limit: 3, shape: :circle, size: 32)
+      @name = name.to_s.strip
+      @colors = colors
+      @limit = limit
+      @shape = shape
       @size = size
+
+      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 name
+      @name.empty? ? "?" : @name
     end
 
     def to_s
       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;'>",
+          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>",
         "</svg>"
@@ -22,7 +36,17 @@ module Initials
     end
 
     def fill
-      hue = name.split("").sum { |c| c.ord } % 360
+      return "hsl(0, 0%, 67%)" if @name.empty?
+
+      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
 
@@ -31,7 +55,20 @@ 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
+
+    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.2.1"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: initials
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Thomas Hutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-12 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- demo.png
 - initials.gemspec
 - lib/initials.rb
 - lib/initials/svg.rb