initials 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 041b1ba551adcc8ecb64879d33eacccb3d5b2fb3d4d0d2c7acf8e36a9a82495c
+  data.tar.gz: 38722e485352b13bb2b4ba716d33084a9719a2ff0b9d45cbd5f4042b3b8c8e84
+SHA512:
+  metadata.gz: 63bb8752ed94b30a0a9cdf5b616d41db11fb506071efec29acc66a15bd578334ad35df6a1309bf548d557d7dff6106022ec602549c8e2d983c631d9a4307d100
+  data.tar.gz: b94314469bae6842900c17156898493bf28a189c7f0c263c0a7f8eed371e42d83480cc61536970dcf615863caec67defd91b831f8ef9db8571cba89598cd03e2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in initials.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,67 @@
+# Initials
+
+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

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

@@ -0,0 +1,29 @@
+
+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", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/initials.rb

@@ -0,0 +1,10 @@
+require "initials/svg"
+require "initials/version"
+
+module Initials
+  class Error < StandardError; end
+
+  def self.svg(name, **options)
+    SVG.new(name, options).to_s
+  end
+end

data/lib/initials/svg.rb

@@ -0,0 +1,37 @@
+module Initials
+  class SVG
+    attr_reader :name, :size
+
+    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
+      @size = size
+    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;'>",
+            "#{initials}",
+          "</text>",
+        "</svg>"
+      ].join
+
+      svg.html_safe rescue svg
+    end
+
+    def fill
+      hue = name.split("").sum { |c| c.ord } % 360
+      "hsl(#{hue}, 40%, 40%)"
+    end
+
+    def font_size
+      size/2 + size/16 - (initials.length * size/16)
+    end
+
+    def initials
+      name.split(' ')[0, 3].map { |s| s[0].capitalize }.join
+    end
+  end
+end

data/lib/initials/version.rb

@@ -0,0 +1,3 @@
+module Initials
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: initials
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Thomas Hutterer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Use colorful SVGs as user avatars in any Ruby and Rails application.
+email:
+- tohu@tuta.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- initials.gemspec
+- lib/initials.rb
+- lib/initials/svg.rb
+- lib/initials/version.rb
+homepage: https://github.com/thutterer/initials
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Simple SVG avatars
+test_files: []