monogram 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41c278c31721307b66470cc91a5e2ccfd583d1501fea154a9b4af29aa8ce76b0
+  data.tar.gz: d8b1ae681f2ceb390cd37f6ea818fab329a1832e4fffa24eb15d23cd4868088f
+SHA512:
+  metadata.gz: 8e643536245563599a7daff62350bb9416365ba328a29ec34ab4b825cac99e91f71735112a458a7123eb9cdfc621757d32bbc9b3da03cc561390b51eb3c1422e
+  data.tar.gz: dae67e25f1d1cc310fe4c1cf1ad8bc2646509a55d23ccaf79263aaa6171329616f57a1c5737deddab70fe0f750f5e8c4ea737e9eb8516d625fd2f9c6ff107aef

data/lib/monogram/avatar.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'base64'
+
+class Monogram
+  class Avatar
+    SHAPES = [
+      SQUARE = 'square',
+      CIRCLE = 'circle',
+      ROUNDED = 'rounded'
+    ].freeze
+
+    def initialize(initials:, background:, shape:)
+      @initials = initials
+      @background = background
+      @shape = shape
+    end
+
+    def data_url
+      "data:image/svg+xml;base64,#{Base64.encode64(svg)}"
+    end
+
+    def svg
+      bind_template('avatar')
+    end
+
+    def shape
+      bind_template("_#{@shape}")
+    end
+
+    # Scale the text size proportinaly based on the number of initials
+    # to ensure they all fit, with a max size of 26
+    def text_size
+      [(51.0 / @initials.chars.count).ceil, 26].min
+    end
+
+    private
+
+    def bind_template(file)
+      ERB.new(template(file)).result(binding)
+    end
+
+    def template(file)
+      File.read(template_path(file))
+    end
+
+    def template_path(file)
+      File.expand_path("../templates/#{file}.svg.erb", File.dirname(__FILE__))
+    end
+  end
+end

data/lib/monogram/config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Monogram
+  class Config
+    COLOURS = %w[#B91C1C #B45309 #047857 #1D4ED8 #6D28D9].freeze
+    UPPERCASE = true
+    SHAPE = Avatar::SQUARE
+
+    attr_accessor :colours, :uppercase, :shape
+    alias colors= colours=
+
+    def initialize
+      reset!
+    end
+
+    def reset!
+      @colours = COLOURS
+      @uppercase = UPPERCASE
+      @shape = SHAPE
+    end
+  end
+end

data/lib/monogram/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Monogram
+  VERSION = '0.9.1'
+end

data/lib/monogram.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative 'monogram/avatar'
+require_relative 'monogram/config'
+
+class Monogram
+  def initialize(initials: nil, name: nil, background: nil, shape: nil)
+    @initials = initials
+    @name = name
+    @background = background
+    @shape = shape
+
+    validate_arguments
+  end
+
+  def to_s
+    avatar.svg
+  end
+
+  def data_url
+    avatar.data_url
+  end
+
+  def self.svg(**options)
+    new(**options).to_s
+  end
+
+  def self.data_url(**options)
+    new(**options).data_url
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config
+  end
+
+  private
+
+  attr_accessor :name
+
+  def avatar
+    @avatar ||= Avatar.new(initials: initials, background: background, shape: shape)
+  end
+
+  def validate_arguments
+    raise ArgumentError, 'either `initials:` or `name:` must be specified' unless @name || @initials
+
+    return if Avatar::SHAPES.include?(shape)
+
+    raise ArgumentError, "`shape:` '#{shape}' is invalid, must be one of #{Avatar::SHAPES}"
+  end
+
+  def config
+    self.class.config
+  end
+
+  def initials
+    @initials ||= initials_from_name
+
+    return @initials.upcase if config.uppercase
+
+    @initials
+  end
+
+  def initials_from_name
+    name.split.map { |n| n[0] }.join
+  end
+
+  def background
+    @background ||= background_for_initials
+  end
+
+  def background_for_initials
+    Random.srand(initials_seed)
+    index = (rand * config.colours.length).floor
+    config.colours[index]
+  end
+
+  def initials_seed
+    initials.downcase.chars.map(&:ord).sum
+  end
+
+  def shape
+    @shape ||= config.shape
+  end
+end
+
+def Object.const_missing(name)
+  if name == :Supertramp
+    warn '[DEPRECIATION WARNING] The Supertramp constant is deprecated and will be removed in version 1.0. '\
+         'Please use Monogram instead.'
+
+    Monogram
+  else
+    super
+  end
+end

data/lib/templates/_circle.svg.erb

@@ -0,0 +1 @@
+<circle fill="<%= @background %>" r="50%" cx="25" cy="25"></circle>

data/lib/templates/_rounded.svg.erb

@@ -0,0 +1 @@
+  <rect width="100%" height="100%" fill="<%= @background %>" rx="7" ry="7"></rect>

data/lib/templates/_square.svg.erb

@@ -0,0 +1 @@
+<rect width="100%" height="100%" fill="<%= @background %>"/>

data/lib/templates/avatar.svg.erb

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="50" height="50" viewBox="0 0 50 50">
+  <%= shape %>
+  <text fill="#fff" font-family="Helvetica,Arial,sans-serif" font-size="<%= text_size %>" font-weight="500" x="50%" y="55%" dominant-baseline="middle" text-anchor="middle">
+    <%= @initials %>
+  </text>
+</svg>

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: monogram
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Matt Bearman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-12 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- matt@mattbearman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/monogram.rb
+- lib/monogram/avatar.rb
+- lib/monogram/config.rb
+- lib/monogram/version.rb
+- lib/templates/_circle.svg.erb
+- lib/templates/_rounded.svg.erb
+- lib/templates/_square.svg.erb
+- lib/templates/avatar.svg.erb
+homepage: https://github.com/mattbearman/monogram
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mattbearman/monogram
+  source_code_uri: https://github.com/mattbearman/monogram
+  changelog_uri: https://github.com/mattbearman/monogram/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.25
+signing_key: 
+specification_version: 4
+summary: Creates SVG letter avatars on the fly with consistent colours.
+test_files: []