nameplate 0.1.0

data/lib/nameplate/colors/palettes/google.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module NamePlate
+  module Colors
+    module Palettes
+      class Google < Palette
+        GOOGLE_COLORS = [
+          [226, 95, 81], # A
+          [242, 96, 145], # B
+          [187, 101, 202], # C
+          [149, 114, 207], # D
+          [120, 132, 205], # E
+          [91, 149, 249], # F
+          [72, 194, 249], # G
+          [69, 208, 226], # H
+          [72, 182, 172], # I
+          [82, 188, 137], # J
+          [155, 206, 95], # K
+          [212, 227, 74], # L
+          [254, 218, 16], # M
+          [247, 192, 0], # N
+          [255, 168, 0], # O
+          [255, 138, 96], # P
+          [194, 194, 194], # Q
+          [143, 164, 175], # R
+          [162, 136, 126], # S
+          [163, 163, 163], # T
+          [175, 181, 226], # U
+          [179, 155, 221], # V
+          [194, 194, 194], # W
+          [124, 222, 235], # X
+          [188, 170, 164], # Y
+          [173, 214, 125] # Z
+        ].freeze
+
+        def self.key = :google
+
+        def initialize
+          super(GOOGLE_COLORS)
+        end
+
+        def pick(username)
+          char = username[0].upcase
+          if /[A-Z]/.match?(char)
+            colors[char.ord - 65]
+          elsif /[0-9]/.match?(char)
+            colors[char.to_i]
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nameplate/colors/palettes/iwanthue.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+module NamePlate
+  module Colors
+    module Palettes
+      class Iwanthue < Palette
+        IWANTHUE_COLORS = [
+          [198, 125, 40],
+          [61, 155, 243],
+          [74, 243, 75],
+          [238, 89, 166],
+          [52, 240, 224],
+          [177, 156, 155],
+          [240, 120, 145],
+          [111, 154, 78],
+          [237, 179, 245],
+          [237, 101, 95],
+          [89, 239, 155],
+          [43, 254, 70],
+          [163, 212, 245],
+          [65, 152, 142],
+          [165, 135, 246],
+          [181, 166, 38],
+          [187, 229, 206],
+          [77, 164, 25],
+          [179, 246, 101],
+          [234, 93, 37],
+          [225, 155, 115],
+          [142, 140, 188],
+          [223, 120, 140],
+          [249, 174, 27],
+          [244, 117, 225],
+          [137, 141, 102],
+          [75, 191, 146],
+          [188, 239, 142],
+          [164, 199, 145],
+          [173, 120, 149],
+          [59, 195, 89],
+          [222, 198, 220],
+          [68, 145, 187],
+          [236, 204, 179],
+          [159, 195, 72],
+          [188, 121, 189],
+          [166, 160, 85],
+          [181, 233, 37],
+          [236, 177, 85],
+          [121, 147, 160],
+          [234, 218, 110],
+          [241, 157, 191],
+          [62, 200, 234],
+          [133, 243, 34],
+          [88, 149, 110],
+          [59, 228, 248],
+          [183, 119, 118],
+          [251, 195, 45],
+          [113, 196, 122],
+          [197, 115, 70],
+          [80, 175, 187],
+          [103, 231, 238],
+          [240, 72, 133],
+          [228, 149, 241],
+          [180, 188, 159],
+          [172, 132, 85],
+          [180, 135, 251],
+          [236, 194, 58],
+          [217, 176, 109],
+          [88, 244, 199],
+          [186, 157, 239],
+          [113, 230, 96],
+          [206, 115, 165],
+          [244, 178, 163],
+          [230, 139, 26],
+          [241, 125, 89],
+          [83, 160, 66],
+          [107, 190, 166],
+          [197, 161, 210],
+          [198, 203, 245],
+          [238, 117, 19],
+          [228, 119, 116],
+          [131, 156, 41],
+          [145, 178, 168],
+          [139, 170, 220],
+          [233, 95, 125],
+          [87, 178, 230],
+          [157, 200, 119],
+          [237, 140, 76],
+          [229, 185, 186],
+          [144, 206, 212],
+          [236, 209, 158],
+          [185, 189, 79],
+          [34, 208, 66],
+          [84, 238, 129],
+          [133, 140, 134],
+          [67, 157, 94],
+          [168, 179, 25],
+          [140, 145, 240],
+          [151, 241, 125],
+          [67, 162, 107],
+          [200, 156, 21],
+          [169, 173, 189],
+          [226, 116, 189],
+          [133, 231, 191],
+          [194, 161, 63],
+          [241, 77, 99],
+          [241, 217, 53],
+          [123, 204, 105],
+          [210, 201, 119],
+          [229, 108, 155],
+          [240, 91, 72],
+          [187, 115, 210],
+          [240, 163, 100],
+          [178, 217, 57],
+          [179, 135, 116],
+          [204, 211, 24],
+          [186, 135, 57],
+          [223, 176, 135],
+          [204, 148, 151],
+          [116, 223, 50],
+          [95, 195, 46],
+          [123, 160, 236],
+          [181, 172, 131],
+          [142, 220, 202],
+          [240, 140, 112],
+          [172, 145, 164],
+          [228, 124, 45],
+          [135, 151, 243],
+          [42, 205, 125],
+          [192, 233, 116],
+          [119, 170, 114],
+          [158, 138, 26],
+          [73, 190, 183],
+          [185, 229, 243],
+          [227, 107, 55],
+          [196, 205, 202],
+          [132, 143, 60],
+          [233, 192, 237],
+          [62, 150, 220],
+          [205, 201, 141],
+          [106, 140, 190],
+          [161, 131, 205],
+          [135, 134, 158],
+          [198, 139, 81],
+          [115, 171, 32],
+          [101, 181, 67],
+          [149, 137, 119],
+          [37, 142, 183],
+          [183, 130, 175],
+          [168, 125, 133],
+          [124, 142, 87],
+          [236, 156, 171],
+          [232, 194, 91],
+          [219, 200, 69],
+          [144, 219, 34],
+          [219, 95, 187],
+          [145, 154, 217],
+          [165, 185, 100],
+          [127, 238, 163],
+          [224, 178, 198],
+          [119, 153, 120],
+          [124, 212, 92],
+          [172, 161, 105],
+          [231, 155, 135],
+          [157, 132, 101],
+          [122, 185, 146],
+          [53, 166, 51],
+          [70, 163, 90],
+          [150, 190, 213],
+          [210, 107, 60],
+          [166, 152, 185],
+          [159, 194, 159],
+          [39, 141, 222],
+          [202, 176, 161],
+          [95, 140, 229],
+          [168, 142, 87],
+          [93, 170, 203],
+          [159, 142, 54],
+          [14, 168, 39],
+          [94, 150, 149],
+          [187, 206, 136],
+          [157, 224, 166],
+          [235, 158, 208],
+          [109, 232, 216],
+          [141, 201, 87],
+          [208, 124, 118],
+          [142, 125, 214],
+          [19, 237, 174],
+          [72, 219, 41],
+          [234, 102, 111],
+          [168, 142, 79],
+          [188, 135, 35],
+          [95, 155, 143],
+          [148, 173, 116],
+          [223, 112, 95],
+          [228, 128, 236],
+          [206, 114, 54],
+          [195, 119, 88],
+          [235, 140, 94],
+          [235, 202, 125],
+          [233, 155, 153],
+          [214, 214, 238],
+          [246, 200, 35],
+          [151, 125, 171],
+          [132, 145, 172],
+          [131, 142, 118],
+          [199, 126, 150],
+          [61, 162, 123],
+          [58, 176, 151],
+          [215, 141, 69],
+          [225, 154, 220],
+          [220, 77, 167],
+          [233, 161, 64],
+          [130, 221, 137],
+          [81, 191, 129],
+          [169, 162, 140],
+          [174, 177, 222],
+          [236, 174, 47],
+          [233, 188, 180],
+          [69, 222, 172],
+          [71, 232, 93],
+          [118, 211, 238],
+          [157, 224, 83],
+          [218, 105, 73],
+          [126, 169, 36]
+        ].freeze
+
+        def self.key = :iwanthue
+
+        def initialize
+          super(IWANTHUE_COLORS)
+        end
+      end
+    end
+  end
+end

data/lib/nameplate/colors/palettes/jedi_light.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module NamePlate
+  module Colors
+    module Palettes
+      # A "light side" Jedi-inspired palette
+      class JediLight < Palette
+        COLORS = [
+          [255, 255, 255], # pure white
+          [0, 87, 183],    # Jedi blue
+          [114, 137, 218], # softer blue
+          [0, 204, 255],   # cyan/saber glow
+          [255, 214, 10],  # light yellow/gold
+          [173, 216, 230], # pale blue
+          [192, 192, 192]  # silver
+        ].freeze
+
+        def self.key = :jedi_light
+
+        def initialize
+          super(COLORS)
+        end
+      end
+    end
+  end
+end

data/lib/nameplate/colors/palettes/monokai.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NamePlate
+  module Colors
+    module Palettes
+      # Inspired by Monokai theme
+      class Monokai < Palette
+        COLORS = [
+          [39, 40, 34],    # background
+          [248, 248, 242], # foreground
+          [249, 38, 114],  # pink
+          [166, 226, 46],  # green
+          [253, 151, 31],  # orange
+          [102, 217, 239], # cyan
+          [174, 129, 255], # purple
+          [230, 219, 116]  # yellow
+        ].freeze
+
+        def self.key = :monokai
+
+        def initialize
+          super(COLORS)
+        end
+      end
+    end
+  end
+end

data/lib/nameplate/colors/palettes/pastel.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module NamePlate
+  module Colors
+    module Palettes
+      # A soft pastel theme
+      class Pastel < Palette
+        COLORS = [
+          [255, 179, 186], # light pink
+          [255, 223, 186], # peach
+          [255, 255, 186], # light yellow
+          [186, 255, 201], # mint
+          [186, 225, 255]  # baby blue
+        ].freeze
+
+        def self.key = :pastel
+
+        def initialize
+          super(COLORS)
+        end
+      end
+    end
+  end
+end

data/lib/nameplate/colors.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "colors/palette"
+
+# Auto-require all palette classes
+Dir[File.join(__dir__ || Dir.pwd, "colors", "palettes", "*.rb")].sort.each { |f| require f }
+
+module NamePlate
+  module Colors
+    # Lazily build registry from all subclasses of Palette
+    # @return [Hash{String => NamePlate::Colors::Palette}] The registry of palettes.
+    #  use NamePlate::Colors.registry to access it.
+    def self.registry
+      @registry ||= Palettes.constants.map do |const|
+        klass = Palettes.const_get(const)
+
+        next unless klass.is_a?(Class) && klass < Palette
+        [klass.key, klass.new]
+      end.compact.to_h.freeze
+    end
+
+    def self.for(username)
+      palette = registry.fetch(NamePlate.colors_palette) do
+        raise ArgumentError, "Unknown palette: #{NamePlate.colors_palette}"
+      end
+      palette.pick(username)
+    end
+
+    # Validate a custom palette of colors.
+    #
+    # @param [Array[Integer]] palette The custom palette of colors.
+    # @return [Boolean] Whether the custom palette is valid.
+    def self.valid_custom_palette?(palette)
+      return false if palette.nil?
+      return false unless palette.is_a?(Array)
+      return false unless palette.all? { |c| c.is_a?(String) && c.match?(/\A#(?:[0-9a-fA-F]{3}){1,2}\z/) }
+      return false if palette.size < 2
+      return false if palette.size > 20
+      true
+    end
+  end
+end

data/lib/nameplate/configuration.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module NamePlate
+  # Configuration settings for NamePlate.
+  # These can be set globally via the {NamePlate.configure} block, or
+  # on a per-invocation basis via the options hash.
+  # @example Set global configuration
+  #  NamePlate.configure do |config|
+  #   config.cache_base_path = "public/system/nameplate"  # defaults to "tmp/nameplate" if unset
+  #   config.font = "/path/to/font.ttf"                     # defaults to {Avatar::FONT_FILE} if unset
+  #   config.fill_color = [255, 255, 255]                   # defaults to {Avatar::FILL_COLOR} if unset
+  #   config.colors_palette = :google                       # defaults to :google
+  #   config.custom_palette = [[255, 255, 255], [0, 0, 0]]  # required if colors_palette is :custom
+  #   config.weight = 300                                   # defaults to 300
+  #   config.annotate_position = "-0+5"                     # defaults to "-0+5"
+  #   config.letters_count = 1                              # defaults to 1
+  #   config.pointsize = 140                                # defaults to 140
+  #   end
+  #
+  module Configuration
+    def cache_base_path
+      @cache_base_path
+    end
+
+    def cache_base_path=(v)
+      @cache_base_path = v
+    end
+
+    def font
+      @font || Avatar::FONT_FILE
+    end
+
+    def font=(v)
+      @font = v
+    end
+
+    def fill_color
+      @fill_color || Avatar::FILL_COLOR
+    end
+
+    def fill_color=(v)
+      @fill_color = v
+    end
+
+    def colors_palette
+      @colors_palette ||= :google
+    end
+
+    # Set the color palette to use.
+    #
+    # @param [Symbol, Array<Array<Integer>>] v The color palette to use.
+    # @return [Symbol, Array<Array<Integer>>] The color palette being used.
+    def colors_palette=(v)
+      sym = v.to_sym
+      raise ArgumentError, "Unknown palette: #{v.inspect}" unless Colors.registry.key?(sym)
+      @colors_palette = sym
+    end
+
+    def custom_palette
+      @custom_palette ||= nil
+    end
+
+    # Set a custom palette of colors to use when colors_palette is :custom
+    #
+    # @param [Array[Integer]] v The custom palette of colors.
+    # @return [Array[Integer]] The custom palette of colors.
+    def custom_palette=(v)
+      @custom_palette = v
+      if @custom_palette.nil? && @colors_palette == :custom
+        raise "Missing Custom Palette, please set config.custom_palette if using :custom"
+      end
+      if Colors.valid_custom_palette?(@custom_palette)
+        raise "Invalid Custom Palette, please update config.custom_palette"
+      end
+    end
+
+    def weight
+      @weight ||= 300
+    end
+
+    def weight=(v)
+      @weight = v
+    end
+
+    def annotate_position
+      @annotate_position ||= "-0+5"
+    end
+
+    def annotate_position=(v)
+      @annotate_position = v
+    end
+
+    def letters_count
+      @letters_count ||= 1
+    end
+
+    def letters_count=(v)
+      @letters_count = v
+    end
+
+    def pointsize
+      @pointsize ||= 140
+    end
+
+    def pointsize=(v)
+      @pointsize = v
+    end
+  end
+end

data/lib/nameplate/has_avatar.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module NamePlate
+  # Mixin for models that "have an avatar".
+  #
+  # Example:
+  #   class User
+  #     include NamePlate::HasAvatar
+  #     attr_accessor :name
+  #   end
+  #
+  #   user = User.new.tap { |u| u.name = "Tony" }
+  #   user.avatar_path(128)
+  #   # => "public/system/nameplate/2/T/226_95_81/128.png"
+  #
+  module HasAvatar
+    # Return the filesystem path to the generated avatar
+    #
+    # @param size [Integer] size in px (default 64)
+    # @return [String] path to avatar image
+    def avatar_path(size = 64)
+      NamePlate::Avatar.generate(username, size)
+    end
+
+    # Return the URL path to the generated avatar
+    #
+    # @param size [Integer] size in px (default 64)
+    # @return [String] URL for avatar image
+    def avatar_url(size = 64)
+      NamePlate.path_to_url(avatar_path(size))
+    end
+  end
+end

data/lib/nameplate/image/resize.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "mini_magick"
+
+module NamePlate
+  module Image
+    # Resizes images with MiniMagick.
+    #
+    # Responsibility: take a source image and produce a resized
+    # version that fits the requested WxH, centered, with transparent padding.
+    #
+    # Used by {Avatar::Generator} when a non-fullsize avatar is requested.
+    class Resize
+      # Initializes a new Resize object.
+      #
+      # @param [String] from path to the source image file
+      # @param [String] to path to the destination image file
+      # @param [Integer] width target width in pixels
+      # @param [Integer] height target height in pixels
+      def initialize(from:, to:, width:, height:)
+        @from = from
+        @to = to
+        @width = width
+        @height = height
+      end
+
+      def self.call(from:, to:, width:, height:)
+        new(from:, to:, width:, height:).resize!
+      end
+
+      # Entry point to resize an image.
+      #
+      # @param from [String] path to the source image file
+      # @param to [String] path to the destination image file
+      # @param width [Integer] target width in pixels
+      # @param height [Integer] target height in pixels
+      # @return [NamePlate::Results::SuccessResult, NamePlate::Results::FailureResult]
+      def resize!
+        validate_inputs!
+        process_resize
+      rescue => e
+        failure_result(e, from:, to:, width:, height:)
+      end
+
+      private
+
+      attr_reader :from, :to, :width, :height
+
+      # Validates the input parameters.
+      #
+      # @return [void] if valid
+      # @raise [ArgumentError] if any parameter is invalid
+      def validate_inputs!
+        raise ArgumentError, "Source file not found: #{from}" unless File.exist?(from)
+        raise ArgumentError, "Width must be positive integer" unless width.is_a?(Integer) && width.positive?
+        raise ArgumentError, "Height must be positive integer" unless height.is_a?(Integer) && height.positive?
+        raise ArgumentError, "Destination path cannot be empty" if to.to_s.strip.empty?
+      end
+
+      # Processes the image resizing.
+      #
+      # @return [NamePlate::Results::SuccessResult, NamePlate::Results::FailureResult]
+      def process_resize
+        image = MiniMagick::Image.open(from)
+
+        image.combine_options do |c|
+          c.background "transparent"
+          c.gravity "center"
+          c.thumbnail "#{width}x#{height}^"
+          c.extent "#{width}x#{height}"
+          c.unsharp "2x0.5+0.7+0"
+          c.quality 98
+        end
+
+        image.write(to)
+        success_result(to)
+      end
+
+      # Construct a SuccessResult with the given path.
+      #
+      # @param [String] path the path to the resized image file
+      #
+      # @return [NamePlate::Results::SuccessResult] the success result
+      def success_result(path)
+        NamePlate::Results::SuccessResult.new(value: {path:})
+      end
+
+      # Construct a FailureResult with the given exception and context.
+      #
+      # @param [StandardError] exception the raised exception
+      # @param [String] from path to the source image file
+      # @param [String] to path to the destination image file
+      # @param [Integer] width target width in pixels
+      # @param [Integer] height target height in pixels
+      #
+      # @return [NamePlate::Results::FailureResult] the failure result
+      def failure_result(exception, from:, to:, width:, height:)
+        NamePlate::Results::FailureResult.new(
+          error: {
+            message: "Image resize failed: #{exception.message}",
+            exception: exception,
+            from: from,
+            to: to,
+            width: width,
+            height: height
+          }
+        )
+      end
+    end
+  end
+end

data/lib/nameplate/results/failure_result.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module NamePlate
+  module Results
+    # Represents a failed operation result.
+    #
+    # Provides a consistent API for checking failure
+    # and accessing error details.
+    class FailureResult
+      attr_reader :error
+
+      def initialize(error:)
+        @error = error
+      end
+
+      # @return [Boolean]
+      def success?
+        false
+      end
+
+      # @return [Boolean]
+      def failure(argv, stdout, stderr, status)
+        NamePlate::Results::FailureResult.new(
+          error: {
+            message: "Command failed",
+            argv: argv,
+            stdout: stdout,
+            stderr: stderr,
+            status: status
+          }
+        )
+      end
+    end
+  end
+end