initials 0.2.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2dce220e10036fd5284e737264c5ed0a4f0f4e47211d4fec4812207e28dd3cf
-  data.tar.gz: 3eeebc342465b151e48ebd94d01e98d2f6a1bd0194851c5a2fc50d41103553af
+  metadata.gz: e9e93b9af7fecf572fbcf123770f1c94d35cfd7206de6498ba0b9820186f91ad
+  data.tar.gz: f2435541f81450b5e7fd458527579fb9c8fcf36b6bd3571c802531412daf1393
 SHA512:
-  metadata.gz: 660d98bbbb542bf6a706614ab725c63f5d2e991236ff23ddaf443ec35ef2e0709677b51f4e3d94ffc9bea81f647d8135cf206513e07617710820cba2b71b7253
-  data.tar.gz: ddeb25f094cae8ffd4d8d7b01dc022b71898a45df031a231051d2f18bfce8a1b5392b9ed4e3ae41dba4398087ab7856a3f2f0f21c74dabed382cb5151c93998d
+  metadata.gz: acf34c95dc2200b59f83835dbe885b45a694fbe8cd22dfe6fea46b5776839f5b236a7e0537c6177a6e1e76206ca73d32fefefeb4e5a6845bff6aeafb6bb7c0ed
+  data.tar.gz: 0a0aafb85bb929a5dcb785064693d4329eb5f127c8b8668f466d332c5424dae7f58ddac2bd8674656e79a1683ca7a71348ebc05ce71f813907bd9a77f3d520fe

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; user-select: none;'>",
+          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.2"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: initials
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.2
 platform: ruby
 authors:
 - Thomas Hutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2022-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,18 +59,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
-- demo.png
-- initials.gemspec
 - lib/initials.rb
 - lib/initials/svg.rb
 - lib/initials/version.rb

data/.github/workflows/ruby.yml

@@ -1,39 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - 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

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# SimpleCov reports
-coverage

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-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/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Thomas Hutterer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/README.md

@@ -1,67 +0,0 @@
-# ![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)
-
-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.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'initials'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install initials
-
-## Usage
-
-Call `Initials.svg("Morty Smith")` anywhere to get a colorful initials avatar SVG as string.
-
-### Rails
-
-No special configuration is required to work with Ruby on Rails, but for your convinience, you can add this to your `app/helpers/application_helper.rb`:
-
-```ruby
-def user_avatar(name, **options)
-  Initials.svg(name, **options)
-end
-```
-
-Now you can create SVGs in all views:
-
-```erb
-<%= user_avatar(current_user.name) %>
-```
-
-Initials automatically marks its created SVG strings as `html_safe`.
-
-### Options
-
-You can pass the following options into `Initials.svg` or your `user_avatar` helper:
-
-```rb
-user_avatar(current_user.name, size: 96)
-```
-
-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.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/thutterer/initials.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "initials"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/initials.gemspec

@@ -1,29 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "initials/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "initials"
-  spec.version       = Initials::VERSION
-  spec.authors       = ["Thomas Hutterer"]
-  spec.email         = ["tohu@tuta.io"]
-
-  spec.summary       = "Simple SVG avatars"
-  spec.description   = "Use colorful SVGs as user avatars in any Ruby and Rails application."
-  spec.homepage      = "https://github.com/thutterer/initials"
-  spec.license       = "MIT"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end