initials 0.4.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74189037b48b4afad67b1139cb85e50385a64cfcfb4f5fc49aa9cc7d1f71332e
-  data.tar.gz: dbbeacbc6d9a6ea6705aab982a822ff51423271fc3dc0425f00f45298b6416fa
+  metadata.gz: f942a7cc275315fb9857c093f062b3b0540d440c5e8cbd788d04df0866cf6544
+  data.tar.gz: ac219a0e72952d98fd21fa21b7a4bb12626babd7fbfcbc509767edb1b35ac423
 SHA512:
-  metadata.gz: 6f62f412c72180e8430fab32b54ad3dfc9fe13e722e7e076fc4112bb04abdb5987570cf6b07254367b13f8335aea494689cfc05d0f970f3d9fc701d3fa413eaf
-  data.tar.gz: 683b723bb2fac2f305558966614c4e6baf3407c1b441335667b65350e34a8f4fbbc2be22b84b540e85159ed6cd8b9798cf2374b4834404cc7f667827c829e1b2
+  metadata.gz: 5b4291e58c69db4f26b4d4ad007e0f14f0fe7b92722c5929554fc2c2a7e2026fdb9a2d927b1775e2124963e2d8f9731896b37b43222801933d751e41896ab412
+  data.tar.gz: da1900a26429932d5b9186438488920e12d040bbf433a835de7ae4d274216b69e975050c8ce6720ce1566ba90b43b77e2c291ba8449949cc9c287324374df114

data/lib/initials/svg.rb

@@ -5,20 +5,23 @@ module Initials
     attr_reader :name, :colors, :limit, :shape, :size
 
     def initialize(name, colors: 12, limit: 3, shape: :circle, size: 32)
-      @name = name
+      @name = name.to_s.strip
       @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 name
+      @name.empty? ? "?" : @name
+    end
+
     def to_s
       svg = [
-        "<svg width='#{size}' height='#{size}'>",
+        "<svg xmlns='http://www.w3.org/2000/svg' width='#{size}' height='#{size}'>",
           shape == :rect ?
             "<rect width='#{size}' height='#{size}' rx='#{size / 32}' ry='#{size / 32}' fill='#{fill}' />"
           :
@@ -33,6 +36,8 @@ module Initials
     end
 
     def fill
+      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.
@@ -41,7 +46,7 @@ module Initials
 
       # Spin the wheel!
       hue = char_sum % HUE_WHEEL
-      
+
       "hsl(#{hue}, 40%, 40%)"
     end
 

data/lib/initials/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: initials
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Thomas Hutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2022-06-30 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
@@ -93,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Simple SVG avatars

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,16 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# SimpleCov reports
-coverage
-
-Gemfile.lock

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,75 +0,0 @@
-# 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:
-
-```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.
-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
-
-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:
-
-```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
-)
-```
-
-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