glyph.rb in cli-ui-2.0.0

- old
+ new

@@ -1,54 +1,61 @@
+# typed: true
+
 require 'cli/ui'
 
 module CLI
   module UI
     class Glyph
+      extend T::Sig
+
       class InvalidGlyphHandle < ArgumentError
+        extend T::Sig
+
+        sig { params(handle: String).void }
         def initialize(handle)
           super
           @handle = handle
         end
 
+        sig { returns(String) }
         def message
           keys = Glyph.available.join(',')
           "invalid glyph handle: #{@handle} " \
             "-- must be one of CLI::UI::Glyph.available (#{keys})"
         end
       end
 
-      attr_reader :handle, :codepoint, :color, :to_s, :fmt
+      sig { returns(String) }
+      attr_reader :handle, :to_s, :fmt, :char
 
+      sig { returns(T.any(Integer, T::Array[Integer])) }
+      attr_reader :codepoint
+
+      sig { returns(Color) }
+      attr_reader :color
+
       # Creates a new glyph
       #
       # ==== Attributes
       #
       # * +handle+ - The handle in the +MAP+ constant
       # * +codepoint+ - The codepoint used to create the glyph (e.g. +0x2717+ for a ballot X)
       # * +plain+ - A fallback plain string to be used in case glyphs are disabled
       # * +color+ - What color to output the glyph. Check +CLI::UI::Color+ for options.
       #
+      sig { params(handle: String, codepoint: T.any(Integer, T::Array[Integer]), plain: String, color: Color).void }
       def initialize(handle, codepoint, plain, color)
         @handle    = handle
         @codepoint = codepoint
         @color     = color
-        @plain     = plain
-        @char      = Array(codepoint).pack('U*')
-        @to_s      = color.code + char + Color::RESET.code
-        @fmt       = "{{#{color.name}:#{char}}}"
+        @char      = CLI::UI::OS.current.use_emoji? ? Array(codepoint).pack('U*') : plain
+        @to_s      = color.code + @char + Color::RESET.code
+        @fmt       = "{{#{color.name}:#{@char}}}"
 
         MAP[handle] = self
       end
 
-      # Fetches the actual character(s) to be displayed for a glyph, based on the current OS support
-      #
-      # ==== Returns
-      # Returns the glyph string
-      def char
-        CLI::UI::OS.current.supports_emoji? ? @char : @plain
-      end
-
       # Mapping of glyphs to terminal output
       MAP = {}
       STAR      = new('*', 0x2b51,           '*', Color::YELLOW) # YELLOW SMALL STAR (⭑)
       INFO      = new('i', 0x1d4be,          'i', Color::BLUE)   # BLUE MATHEMATICAL SCRIPT SMALL i (𝒾)
       QUESTION  = new('?', 0x003f,           '?', Color::BLUE)   # BLUE QUESTION MARK (?)
@@ -57,28 +64,34 @@
       BUG       = new('b', 0x1f41b,          '!', Color::WHITE)  # Bug emoji (🐛)
       CHEVRON   = new('>', 0xbb,             '»', Color::YELLOW) # RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK (»)
       HOURGLASS = new('H', [0x231b, 0xfe0e], 'H', Color::BLUE)   # HOURGLASS + VARIATION SELECTOR 15 (⌛︎)
       WARNING   = new('!', [0x26a0, 0xfe0f], '!', Color::YELLOW) # WARNING SIGN + VARIATION SELECTOR 16 (⚠️ )
 
-      # Looks up a glyph by name
-      #
-      # ==== Raises
-      # Raises a InvalidGlyphHandle if the glyph is not available
-      # You likely need to create it with +.new+ or you made a typo
-      #
-      # ==== Returns
-      # Returns a terminal output-capable string
-      #
-      def self.lookup(name)
-        MAP.fetch(name.to_s)
-      rescue KeyError
-        raise InvalidGlyphHandle, name
-      end
+      class << self
+        extend T::Sig
 
-      # All available glyphs by name
-      #
-      def self.available
-        MAP.keys
+        # Looks up a glyph by name
+        #
+        # ==== Raises
+        # Raises a InvalidGlyphHandle if the glyph is not available
+        # You likely need to create it with +.new+ or you made a typo
+        #
+        # ==== Returns
+        # Returns a terminal output-capable string
+        #
+        sig { params(name: String).returns(Glyph) }
+        def lookup(name)
+          MAP.fetch(name.to_s)
+        rescue KeyError
+          raise InvalidGlyphHandle, name
+        end
+
+        # All available glyphs by name
+        #
+        sig { returns(T::Array[String]) }
+        def available
+          MAP.keys
+        end
       end
     end
   end
 end