Module: DevSuite::Utils::Emoji

Defined in:
lib/dev_suite/utils/emoji.rb

Constant Summary collapse

STATUS =

Status-related emojis

{
  start: "🚀",
  success: "✅",
  error: "🚨❌",
  retry: "💥",
  warning: "⚠️", # For warnings
  caution: "🟡", # For caution or proceed with care
  pending: "🕒", # For pending or waiting
  paused: "⏸️",  # For paused or halted
  running: "🏃",  # For running or in progress
  done: "🎉",     # For done or completed
  finish: "🏁",   # For finish or end
  stop: "🛑",     # For stopping or halting
  cancel: "🚫",   # For canceling or aborting
  skip: "⏭️",    # For skipping or jumping
  next: "⏩",     # For next or moving forward
  previous: "⏪", # For previous or moving backward
  up: "⬆️",      # For up or moving up
  down: "⬇️",    # For down or moving down
  left: "⬅️",    # For left or moving left
  right: "➡️",   # For right or moving right
  top: "🔝",      # For top or highest
  bottom: "🔚",   # For bottom or lowest
  middle: "🔽", # For middle or center
  full: "🔴",     # For full or maximum
  empty: "⚪",    # For empty or minimum
}.freeze
ACTIONS =

Action-related emojis

{
  update: "🔄",     # For updates or changes
  fix: "🔧",        # For fixes or repairs
  bug: "🐞",        # For bugs or issues
  code: "💻",       # For code or technical content
}.freeze
NOTIFICATIONS =

Notification-related emojis

{
  info: "ℹ️",
  important: "❗",
  note: "📝",       # For notes or annotations
  tip: "💡",        # For tips or helpful hints
}.freeze
RESOURCES =

Resource-related emojis

{
  document: "📄",   # For representing documents or files
  network: "🌐",    # For network-related logs
  database: "💾",   # For database-related logs
  cache: "🗄️",     # For cache-related logs
  file: "📁",       # For file-related logs
  cookie: "🍪",     # For cookie-related logs
  header: "📑",     # For header-related logs
  request: "📤",    # For request-related logs
  response: "📥",   # For response-related logs
}.freeze
DEFAULT_EMOJI = 
"❓"
EMOJIS = 
STATUS.merge(ACTIONS).merge(NOTIFICATIONS).merge(RESOURCES).freeze

Class Method Summary collapse

Class Method Details

.all ⇒ Hash

Returns all emojis categorized by their purpose.

Returns:

  • (Hash) —

    a hash containing all emojis organized by categories.



79
80
81
82
83
84
85
86
 
# File 'lib/dev_suite/utils/emoji.rb', line 79

def all
  {
    status: STATUS,
    actions: ACTIONS,
    notifications: NOTIFICATIONS,
    resources: RESOURCES,
  }
end

.get(key, default: DEFAULT_EMOJI) ⇒ String

Returns the emoji corresponding to the given key.

Parameters:

  • key (Symbol) —

    the key to look up the emoji

  • default (String) (defaults to: DEFAULT_EMOJI) —

    the default emoji if the key is not found

Returns:

  • (String) —

    the corresponding emoji or the default emoji



73
74
75
 
# File 'lib/dev_suite/utils/emoji.rb', line 73

def get(key, default: DEFAULT_EMOJI)
  EMOJIS[key] || default
end