boring_avatars 0.1.0

data/lib/boring_avatars/variants.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "svg/element"
+require_relative "svg/value"
+
+module BoringAvatars
+  VariantResult = Data.define(:size, :content, :defs, :mask_attributes) do
+    def initialize(size:, content:, defs: [], mask_attributes: {})
+      super(
+        size: size,
+        content: content.freeze,
+        defs: defs.freeze,
+        mask_attributes: mask_attributes.freeze
+      )
+    end
+  end
+  private_constant :VariantResult
+
+  module VariantHelpers
+    private
+
+    def element(name, attributes = {}, children = [])
+      Svg::Element.new(name: name, attributes: attributes, children: children)
+    end
+
+    def number(value)
+      Svg::Value.number(value)
+    end
+  end
+  private_constant :VariantHelpers
+end
+

data/lib/boring_avatars/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BoringAvatars
+  VERSION = '0.1.0'
+end

data/lib/boring_avatars.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "boring_avatars/version"
+require_relative "boring_avatars/input"
+require_relative "boring_avatars/renderer"
+
+module BoringAvatars
+  class << self
+    def generate(
+      name,
+      variant: :marble,
+      colors: DEFAULT_COLORS,
+      size: "40px",
+      square: false,
+      title: false,
+      id_prefix: nil,
+      attributes: {}
+    )
+      input = Input.new(
+        name: name,
+        variant: variant,
+        colors: colors,
+        size: size,
+        square: square,
+        title: title,
+        id_prefix: id_prefix,
+        attributes: attributes
+      )
+      Renderer.call(input)
+    end
+  end
+
+  private_constant :Identifier, :NameHash, :Svg, :Utilities, :Variants
+end

data/rbi/boring_avatars.rbi

@@ -0,0 +1,70 @@
+# typed: true
+
+module BoringAvatars
+  Variant = T.type_alias { T.any(String, Symbol) }
+  Size = T.type_alias { T.any(Integer, Float, String) }
+  AttributeKey = T.type_alias { T.any(String, Symbol) }
+  AttributeValue = T.type_alias { T.any(String, Numeric, T::Boolean, NilClass) }
+  RailsAttributeValue = T.type_alias do
+    T.any(
+      AttributeValue,
+      T::Array[String],
+      T::Hash[AttributeKey, AttributeValue]
+    )
+  end
+
+  VERSION = T.let(T.unsafe(nil), String)
+
+  sig do
+    params(
+      name: String,
+      variant: Variant,
+      colors: T::Array[String],
+      size: Size,
+      square: T::Boolean,
+      title: T::Boolean,
+      id_prefix: T.nilable(String),
+      attributes: T::Hash[AttributeKey, AttributeValue]
+    ).returns(String)
+  end
+  def self.generate(
+    name,
+    variant: T.unsafe(nil),
+    colors: T.unsafe(nil),
+    size: T.unsafe(nil),
+    square: T.unsafe(nil),
+    title: T.unsafe(nil),
+    id_prefix: T.unsafe(nil),
+    attributes: T.unsafe(nil)
+  ); end
+
+  module Bindings
+    module Rails
+      module ViewHelper
+        sig do
+          params(
+            name: String,
+            variant: Variant,
+            colors: T::Array[String],
+            size: Size,
+            square: T::Boolean,
+            title: T::Boolean,
+            id_prefix: T.nilable(String),
+            svg_attributes: RailsAttributeValue
+          ).returns(String)
+        end
+        def boring_avatar(
+          name,
+          variant: T.unsafe(nil),
+          colors: T.unsafe(nil),
+          size: T.unsafe(nil),
+          square: T.unsafe(nil),
+          title: T.unsafe(nil),
+          id_prefix: T.unsafe(nil),
+          **svg_attributes
+        ); end
+      end
+    end
+  end
+end
+

data/sig/boring_avatars.rbs

@@ -0,0 +1,44 @@
+module BoringAvatars
+  type variant =
+    :marble | :beam | :pixel | :sunset | :ring | :bauhaus |
+    "marble" | "beam" | "pixel" | "sunset" | "ring" | "bauhaus"
+
+  type size = Integer | Float | String
+  type attribute_key = String | Symbol
+  type attribute_value = String | Numeric | bool | nil
+  type rails_attribute_value =
+    attribute_value |
+    Array[String] |
+    Hash[attribute_key, attribute_value]
+
+  VERSION: String
+
+  def self.generate: (
+    String name,
+    ?variant: variant,
+    ?colors: Array[String],
+    ?size: size,
+    ?square: bool,
+    ?title: bool,
+    ?id_prefix: String?,
+    ?attributes: Hash[attribute_key, attribute_value]
+  ) -> String
+
+  module Bindings
+    module Rails
+      module ViewHelper
+        def boring_avatar: (
+          String name,
+          ?variant: variant,
+          ?colors: Array[String],
+          ?size: size,
+          ?square: bool,
+          ?title: bool,
+          ?id_prefix: String?,
+          **rails_attribute_value svg_attributes
+        ) -> String
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: boring_avatars
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- boring_avatars contributors
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: A Ruby port of Boring Avatars with a framework-independent SVG core and
+  an opt-in Rails View Helper.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- THIRD_PARTY_NOTICES.md
+- docs/architecture.md
+- docs/core-library.md
+- docs/rails-binding.md
+- docs/testing-and-compatibility.md
+- lib/boring_avatars.rb
+- lib/boring_avatars/bindings/rails.rb
+- lib/boring_avatars/bindings/rails/view_helper.rb
+- lib/boring_avatars/identifier.rb
+- lib/boring_avatars/input.rb
+- lib/boring_avatars/name_hash.rb
+- lib/boring_avatars/renderer.rb
+- lib/boring_avatars/svg/element.rb
+- lib/boring_avatars/svg/serializer.rb
+- lib/boring_avatars/svg/value.rb
+- lib/boring_avatars/utilities.rb
+- lib/boring_avatars/variants.rb
+- lib/boring_avatars/variants/bauhaus.rb
+- lib/boring_avatars/variants/beam.rb
+- lib/boring_avatars/variants/marble.rb
+- lib/boring_avatars/variants/pixel.rb
+- lib/boring_avatars/variants/ring.rb
+- lib/boring_avatars/variants/sunset.rb
+- lib/boring_avatars/version.rb
+- rbi/boring_avatars.rbi
+- sig/boring_avatars.rbs
+homepage: https://github.com/supermomonga/boring-avatars-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/supermomonga/boring-avatars-ruby/issues
+  changelog_uri: https://github.com/supermomonga/boring-avatars-ruby/releases
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/supermomonga/boring-avatars-ruby
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Generate deterministic Boring Avatars SVGs in Ruby
+test_files: []