avatarro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f21bca192dbc522b1a059df19dec16799003b24788cb5b8142d7ca041ee09ee5
+  data.tar.gz: 9beacfa4c1b188177e8ae0701bab1c8398b48a3462129980f20883ba074f15cd
+SHA512:
+  metadata.gz: 46d3ed500dd01eb7765c751ce9cdb1ae756d6b0cd6356dc982511004eae31202983c427ab3244c689dfe0fd8b64ae30c93f9c9ae29bd652771d98a0758eebf16
+  data.tar.gz: e477c29bbe3a49b39f0dc6d045e16c8be7c7e7316640c71fefb63fa40f06a3c337bfa6c888366229ec1df148e671eaed903585c83915f2ccc55b95b09c516e62

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Igor Kasyanchuk
+
+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,139 @@
+# Avatarro
+
+Google-style avatar generator for your app. 
+
+This gem generates SVG which can be used inside your HTML or img(src) to display google-style avatar with initials.
+
+Sample:
+
+[<img src="https://github.com/igorkasyanchuk/avatarro/blob/main/docs/avataro.png?raw=true"
+/>](https://github.com/igorkasyanchuk/avatarro/blob/main/docs/avataro.png?raw=true)
+
+## Usage
+
+You can generate avatar using 2 methods, depending how you need to use it. Using `Avatarro.svg` method to embed svg inside HTML or `Avatarro.image` method to generate Base64 image use with image_tag.
+
+```erb
+  <%= image_tag Avatarro.image(current_user.full_name), size: '24x24' %>
+  <%= image_tag Avatarro.image("Igor Kasyanchuk", solid: true), size: '24x24' %>
+  <%= image_tag Avatarro.image("IK"), size: '32x32' %>
+  <%= raw Avatarro.svg("IK") %>
+```
+
+It you need rounded avatars just add CSS to the img.
+
+```erb
+<%= image_tag Avatarro.image("IK"), size: '32x32', style: 'border-radius: 50%' %>
+```
+
+More samples (shown on screenshot above):
+
+```erb
+<div class="card">
+  <h3>Avatar Generator for the<br>APP</h3>
+  <div class="people round">
+    <%= image_tag Avatarro.image("OI"), size: '16x16' %>
+    <%= image_tag Avatarro.image("JS"), size: '16x16' %>
+    <%= image_tag Avatarro.image("MK"), size: '16x16' %>
+    <%= image_tag Avatarro.image("ZP"), size: '16x16' %>
+  </div>
+</div>
+
+<div class="card">
+  <h3>Generates SVG for the html</h3>
+  <div class="people round">
+    <%= image_tag Avatarro.image("OI", solid: true), size: '24x24' %>
+    <%= image_tag Avatarro.image("JS", solid: true), size: '24x24' %>
+    <%= image_tag Avatarro.image("MK", solid: true), size: '24x24' %>
+    <%= image_tag Avatarro.image("ZP", solid: true), size: '24x24' %>
+    <%= image_tag Avatarro.image("😁", solid: true), size: '24x24' %>
+    <%= image_tag Avatarro.image("😂", solid: true), size: '24x24' %>
+  </div>
+</div>
+
+<div class="card">
+  <h3>Or can be used as<br> img src="..."</h3>
+  <div class="people">
+    <%= image_tag Avatarro.image("ZO", random: true), size: '32x32' %>
+    <%= image_tag Avatarro.image("AB", random: true), size: '32x32' %>
+    <%= image_tag Avatarro.image("ФЯ", random: true), size: '32x32' %>
+    <%= image_tag Avatarro.image("DA", random: true), size: '32x32' %>
+  </div>
+</div>
+
+<div class="clear"></div>
+
+<div class="card">
+  <%= raw Avatarro.svg("IK") %>
+  <%= raw Avatarro.svg("WS") %>
+  <%= raw Avatarro.svg("AP") %>
+  <hr>
+  <%= image_tag Avatarro.image("WW") %>
+  <%= image_tag Avatarro.image("OI", random: true) %>
+  <%= image_tag Avatarro.image("ZA"), style: 'border-radius: 50%', size: '32x32' %>
+  <%= image_tag Avatarro.image("OZ", random: true), style: 'border-radius: 50%', size: '16x16' %>
+</div>
+
+
+<div class="card">
+  <%= image_tag Avatarro.image("WA", random: true, width: 300, height: 300) %>
+</div>
+
+<div class="card">
+  <%= image_tag Avatarro.image("⚡", random: true, width: 300, height: 300) %>
+</div>
+```
+
+## Configuration
+
+Example of the possible options (see args hash):
+
+```ruby
+  def Avatarro.template(initials, args = {})
+    data        = args[:random] ? GRADIENTS.sample : GRADIENTS[index(initials) % GRADIENTS.size]
+    start       = args[:start].presence || data[0]
+    finish      = args[:solid] ? data[0] : (args[:finish].presence || data[1])
+    degree      = args[:degree].presence || data[2].presence || 90
+    color       = args[:color].presence || data[3].presence || '#FFF'
+    width       = args[:width].presence || 64
+    height      = args[:height].presence || 64
+```
+
+For example:
+
+```erb
+  <%= image_tag Avatarro.image("WA", random: true, width: 300, height: 300, color: 'red') %>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'avatarro'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install avatarro
+```
+
+## Contributing
+Contribution directions go here.
+
+## TODO
+
+- CI
+- better graphics and more gradients
+- radial gradient
+
+## Credits
+
+The idea of this gem came after reading an article: https://kukicola.io/posts/creating-google-like-letter-avatars-using-erb-generated-svgs/. We actually did something similar with HTML/CSS on our project too, but with SVG solution looks just better.
+
+## 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,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/avatarro.rb

@@ -0,0 +1,94 @@
+require "avatarro/version"
+require "avatarro/railtie"
+require "base64"
+
+module Avatarro
+  GRADIENTS = [
+    ["#ff9a9e", "#fad0c4", 45, '#444'],
+    ["#a18cd1", "#fbc2eb", 90],
+    ["#fad0c4", "#ffd1ff", 90],
+    ["#ffecd2", "#fcb69f", 90],
+    ["#ff8177", "#b12a5b", 90],
+    ["#fbc2eb", "#a6c1ee", 90],
+    ["#fdcbf1", "#e6dee9", 90, '#444'],
+    ["#a1c4fd", "#c2e9fb", 120],
+    ["#d4fc79", "#96e6a1", 120],
+    ["#cfd9df", "#e2ebf0", 90, '#444'],
+    ["#a6c0fe", "#f68084", 120],
+    ["#fccb90", "#d57eeb", 120],
+    ["#e0c3fc", "#8ec5fc", 120],
+    ["#f093fb", "#f5576c", 120],
+    ["#43e97b", "#38f9d7", 120],
+    ["#30cfd0", "#330867", 90],
+    ["#d299c2", "#fef9d7", 120],
+    ["#16d9e3", "#46aef7", 120],
+    ["#b8cbb8", "#cf6cc9", 90],
+    ["#fff1eb", "#ace0f9", 90, '#444'],
+    ["#0ba360", "#3cba92", 90],
+    ["#9795f0", "#fbc8d4", 90],
+    ["#93a5cf", "#e4efe9", 90],
+    ["#ffafbd", "#ffc3a0", 45],
+    ["#cc2b5e", "#753a88", 180],
+    ["#ee9ca7", "#ffdde1", 180],
+    ["#42275a", "#734b6d", 90],
+    ["#bdc3c7", "#2c3e50", 90],
+    ["#06beb6", "#48b1bf", 120],
+    ["#eb3349", "#f45c43", 120],
+    ["#56ab2f", "#a8e063", 90],
+    ["#614385", "#516395", 120],
+    ["#d66d75", "#e29587", 290],
+    ["#000428", "#004e92", 90],
+    ["#ddd6f3", "#faaca8", 90],
+    ["#7b4397", "#dc2430", 190],
+    ["#4568dc", "#b06ab3", 90],
+    ["#4568dc", "#b06ab3", 90],
+  ]
+
+
+  def Avatarro.image(initials, args = {})
+    "data:image/svg+xml;base64,#{Base64.encode64(svg(initials, args))}".html_safe
+  end
+
+  def Avatarro.svg(initials, args = {})
+    template(initials, args)
+  end
+
+  private
+
+  def Avatarro.index(initials)
+    initials.chars.inject(0) {|sum, e| sum+= e.ord; sum}
+  end
+
+  def Avatarro.template(initials, args = {})
+    data        = args[:random] ? GRADIENTS.sample : GRADIENTS[index(initials) % GRADIENTS.size]
+    start       = args[:start].presence || data[0]
+    finish      = args[:solid] ? data[0] : (args[:finish].presence || data[1])
+    degree      = args[:degree].presence || data[2].presence || 90
+    color       = args[:color].presence || data[3].presence || '#FFF'
+    width       = args[:width].presence || 64
+    height      = args[:height].presence || 64
+
+    gradient_id = "gradient_#{Time.now.to_i}_#{rand(1_000_000)}"
+    %{<?xml version="1.0" encoding="UTF-8"?>
+      <svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="#{width}" height="#{height}" viewBox="0 0 #{width} #{height}">
+        <linearGradient id="#{gradient_id}" gradientTransform="rotate(#{degree})">
+          <stop stop-color="#{start}" offset="0%" />
+          <stop stop-color="#{finish}" offset="100%" />
+        </linearGradient>
+        <rect width="100%" height="100%" fill="url(##{gradient_id})" />
+        <text fill="#{color}" font-family="Open Sans,Helvetica,Arial,sans-serif" font-size="#{1 + height / 2}" font-weight="500" x="50%" y="55%" dominant-baseline="middle" text-anchor="middle">
+          #{Avatarro.format_initials initials}
+        </text>
+      </svg>
+    }
+  end
+
+  def Avatarro.format_initials(initials)
+    if initials.size > 2
+      initials.scan(/([[:alpha:]])[[:alpha:]]*/).flatten.join.upcase
+    else
+      initials
+    end
+  end
+
+end

data/lib/avatarro/railtie.rb

@@ -0,0 +1,4 @@
+module Avatarro
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/avatarro/version.rb

@@ -0,0 +1,3 @@
+module Avatarro
+  VERSION = '0.1.0'
+end

data/lib/tasks/avatarro_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :avatarro do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: avatarro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate avatars (gmail-like) in your apps
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/avatarro.rb
+- lib/avatarro/railtie.rb
+- lib/avatarro/version.rb
+- lib/tasks/avatarro_tasks.rake
+homepage: https://github.com/igorkasyanchuk/avatarro
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igorkasyanchuk/avatarro
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Generate avatars (gmail-like) in your apps
+test_files: []