makit 0.0.99 → 0.0.112

data/lib/makit/symbols.rb

@@ -1,149 +1,170 @@
-# frozen_string_literal: true
-
-require "rainbow"
-
-# https://symbl.cc/en/unicode/table/
-module Makit
-  class Symbols
-    def self.checkmark
-      "\u2713"
-    end
-
-    def self.success
-      "\u2713"
-    end
-
-    def self.error
-      Rainbow("\u0058").red
-    end
-
-    def self.warning
-      Rainbow("\u26A0").yellow
-    end
-
-    def self.debug
-      Rainbow("\u24D8").blue  # Circle with "i"
-    end
-
-    def self.info
-      Rainbow("\u2139").blue  # Information source
-    end
-
-    def self.fatal
-      Rainbow("\u25A0").bright.red # Filled square, indicating stop/critical
-    end
-
-    def self.warn
-      Rainbow("\u26A0").yellow  # Warning sign
-    end
-
-    def self.star
-      Rainbow("\u2605").yellow  # Star
-    end
-
-    def self.coffee
-      Rainbow("\u2615").yellow  # Hot beverage
-    end
-
-    def self.heart
-      Rainbow("\u2764").red # Heavy black heart
-    end
-
-    def self.bug
-      Rainbow("\u1F41E").yellow # Bug
-    end
-
-    def self.gear
-      Rainbow("\u2699").yellow # Gear
-    end
-
-    def self.magnifying_glass
-      Rainbow("\u1F50D").yellow # Left-pointing magnifying glass
-    end
-
-    def self.question
-      Rainbow("\u003F").yellow  # Question mark
-    end
-
-    def self.arrow_right
-      Rainbow("\u27A4").yellow  # Arrow pointing rightwards then curving upwards
-    end
-
-    def self.arrow_left
-      Rainbow("\u2B05").yellow  # Left arrow
-    end
-
-    def self.arrow_up
-      Rainbow("\u2B06").yellow  # Up arrow
-    end
-
-    def self.arrow_down
-      Rainbow("\u2B07").yellow  # Down arrow
-    end
-
-    def self.arrow_up_down
-      Rainbow("\u2195").yellow  # Up/down arrow
-    end
-
-    def self.arrow_left_right
-      Rainbow("\u2194").yellow  # Left/right arrow
-    end
-
-    def self.arrow_upper_right
-      Rainbow("\u2197").yellow  # North east arrow
-    end
-
-    def self.arrow_lower_right
-      Rainbow("\u2198").yellow  # South east arrow
-    end
-
-    def self.arrow_lower_left
-      Rainbow("\u2199").yellow  # South west arrow
-    end
-
-    def self.arrow_upper_left
-      Rainbow("\u2196").yellow  # North west arrow
-    end
-
-    def self.arrow_up_small
-      Rainbow("\u2B06").yellow  # Up arrow
-    end
-
-    def self.arrow_down_small
-      Rainbow("\u2B07").yellow  # Down arrow
-    end
-
-    def self.arrow_right_small
-      Rainbow("\u27A1").yellow  # Black rightwards arrow
-    end
-
-    def self.arrow_left_small
-      Rainbow("\u2B05").yellow  # Left arrow
-    end
-
-    def self.arrow_up_down_small
-      Rainbow("\u2195").yellow  # Up/down arrow
-    end
-
-    def self.music
-      Rainbow("\u266B").yellow  # Beamed eighth notes
-    end
-
-    def self.get_severity_symbol(severity)
-      case severity
-      when "DEBUG"
-        question
-        # when "INFO"
-        #  info
-      when "WARN"
-        warning
-      when "ERROR"
-        error
-      when "FATAL"
-        fatal
-      else
-        " "
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+begin
+  require "rainbow"
+rescue LoadError
+  # rainbow gem not available, define a no-op rainbow method
+  class String
+    def rainbow
+      self
+    end
+  end
+end
+
+# https://symbl.cc/en/unicode/table/
+module Makit
+  # Unicode symbol utilities with colorization
+  #
+  # This class provides a collection of Unicode symbols with appropriate
+  # colors for use in terminal output. Symbols are provided for various
+  # purposes including status indicators, directional arrows, and decorative elements.
+  class Symbols
+    def self.checkmark
+      "\u2713"
+    end
+
+    def self.success
+      "\u2713"
+    end
+
+    def self.error
+      Rainbow("\u0058").red
+    end
+
+    def self.warning
+      Rainbow("\u26A0").yellow
+    end
+
+    def self.debug
+      Rainbow("\u24D8").blue  # Circle with "i"
+    end
+
+    def self.info
+      Rainbow("\u2139").blue  # Information source
+    end
+
+    def self.fatal
+      Rainbow("\u25A0").bright.red # Filled square, indicating stop/critical
+    end
+
+    def self.warn
+      Rainbow("\u26A0").yellow  # Warning sign
+    end
+
+    def self.star
+      Rainbow("\u2605").yellow  # Star
+    end
+
+    def self.coffee
+      Rainbow("\u2615").yellow  # Hot beverage
+    end
+
+    def self.heart
+      Rainbow("\u2764").red # Heavy black heart
+    end
+
+    def self.bug
+      Rainbow("\u1F41E").yellow # Bug
+    end
+
+    def self.gear
+      Rainbow("\u2699").yellow # Gear
+    end
+
+    def self.magnifying_glass
+      Rainbow("\u1F50D").yellow # Left-pointing magnifying glass
+    end
+
+    def self.question
+      Rainbow("\u003F").yellow  # Question mark
+    end
+
+    def self.arrow_right
+      Rainbow("\u27A4").yellow  # Arrow pointing rightwards then curving upwards
+    end
+
+    def self.arrow_left
+      Rainbow("\u2B05").yellow  # Left arrow
+    end
+
+    def self.arrow_up
+      Rainbow("\u2B06").yellow  # Up arrow
+    end
+
+    def self.arrow_down
+      Rainbow("\u2B07").yellow  # Down arrow
+    end
+
+    def self.arrow_up_down
+      Rainbow("\u2195").yellow  # Up/down arrow
+    end
+
+    def self.arrow_left_right
+      Rainbow("\u2194").yellow  # Left/right arrow
+    end
+
+    def self.arrow_upper_right
+      Rainbow("\u2197").yellow  # North east arrow
+    end
+
+    def self.arrow_lower_right
+      Rainbow("\u2198").yellow  # South east arrow
+    end
+
+    def self.arrow_lower_left
+      Rainbow("\u2199").yellow  # South west arrow
+    end
+
+    def self.arrow_upper_left
+      Rainbow("\u2196").yellow  # North west arrow
+    end
+
+    def self.arrow_up_small
+      Rainbow("\u2B06").yellow  # Up arrow
+    end
+
+    def self.arrow_down_small
+      Rainbow("\u2B07").yellow  # Down arrow
+    end
+
+    def self.arrow_right_small
+      Rainbow("\u27A1").yellow  # Black rightwards arrow
+    end
+
+    def self.arrow_left_small
+      Rainbow("\u2B05").yellow  # Left arrow
+    end
+
+    def self.arrow_up_down_small
+      Rainbow("\u2195").yellow  # Up/down arrow
+    end
+
+    def self.music
+      Rainbow("\u266B").yellow  # Beamed eighth notes
+    end
+
+    # Get appropriate symbol for log severity level
+    #
+    # Returns a colored Unicode symbol that matches the given log severity level.
+    # Used primarily in log formatting to provide visual indicators.
+    #
+    # @param severity [String] The severity level (DEBUG, WARN, ERROR, FATAL)
+    # @return [String] Colored Unicode symbol or space for unrecognized levels
+    def self.get_severity_symbol(severity)
+      case severity
+      when "DEBUG"
+        question
+        # when "INFO"
+        #  info
+      when "WARN"
+        warning
+      when "ERROR"
+        error
+      when "FATAL"
+        fatal
+      else
+        " "
+      end
+    end
+  end
+end

data/lib/makit/task_info.rb

@@ -1,86 +1,128 @@
-# lib/task_guard.rb
-module Makit
-  class TaskInfo
-
-    #
-    # completed_tasks is a class variable that is used to store the completed tasks
-    #
-    class << self
-      attr_accessor :completed_tasks
-    end
-    @completed_tasks = {}
-
-    attr_reader :task_name, :start_time, :end_time, :artifacts_dir
-
-    def self.slowest_task_name
-      if @completed_tasks.empty?
-        return "unknown"
-      end
-      @completed_tasks.max_by { |task_name, task_info| task_info[:duration] }[0]
-    end
-
-    #
-    # block-yielding initializer
-    #
-    # usage:
-    #
-    # Makit::TaskInfo.track(:generate) do
-    #   # generate code
-    # end
-    #
-    def self.track(task_name)
-      task = new(task_name)
-      Makit::SHOW.task(task_name)
-      yield(task)
-    ensure
-      task.report_and_store_time_taken if task
-    end
-
-    #
-    # Block-yielding initializer with inferred task name
-    #
-    def self.track_inferred
-      task_name = infer_task_name
-      Makit::SHOW.task(task_name)
-      track(task_name) { |task| yield(task) }
-    end
-
-    def initialize(task_name)
-      @task_name = task_name
-      @artifacts_dir = File.join("artifacts", task_name.to_s.gsub(":", "_"))
-      @start_time = Time.now
-      #at_exit { report_and_store_time_taken }
-    end
-
-    def report_and_store_time_taken
-      @end_time = Time.now
-      duration = @end_time - @start_time
-
-      # leverate the Makit::Humanize.get_humanized_duration method
-      humanized_duration = Makit::Humanize.get_humanized_duration(duration)
-      puts "  #{@task_name} completed in #{humanized_duration}".colorize(:grey)
-      #puts "[TaskGuard] Task '#{@task_name}' completed in #{duration}."
-
-      # Add to class-level storage
-      self.class.completed_tasks[@task_name] = {
-        start_time: @start_time,
-        end_time: @end_time,
-        duration: duration,
-      }
-    end
-
-    #def format_duration(seconds)
-    #   if seconds >= 60
-    #     mins = (seconds / 60).to_i
-    #     secs = (seconds % 60).round(2)
-    #     "#{mins}m #{secs}s"
-    #   else
-    #     "#{seconds.round(2)}s"
-    #      end
-    # end
-
-    def self.infer_task_name
-      #Rake.application.current_scope.join(":") rescue "unknown"
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Task timing and performance tracking utilities
+module Makit
+  # Task execution time tracking and reporting
+  #
+  # This class provides functionality to track the execution time of tasks,
+  # store timing information, and generate performance reports. It's designed
+  # to help identify performance bottlenecks in build processes.
+  class TaskInfo
+    #
+    # Class variable to store completed task information
+    #
+    class << self
+      attr_accessor :completed_tasks
+    end
+    @completed_tasks = {}
+
+    # @return [String] Name of the task being tracked
+    # @return [Time] Time when task execution started
+    # @return [Time] Time when task execution ended
+    # @return [String] Directory path for task artifacts
+    attr_reader :task_name, :start_time, :end_time, :artifacts_dir
+
+    # Get the name of the slowest completed task
+    #
+    # Analyzes all completed tasks and returns the name of the one
+    # with the longest execution duration.
+    #
+    # @return [String] Name of the slowest task, or "unknown" if no tasks completed
+    def self.slowest_task_name
+      return "unknown" if @completed_tasks.empty?
+
+      @completed_tasks.max_by { |_task_name, task_info| task_info[:duration] }[0]
+    end
+
+    # Track execution time of a task with a block
+    #
+    # Creates a new TaskInfo instance, displays the task name,
+    # executes the provided block, and ensures timing is reported
+    # even if an exception occurs.
+    #
+    # @param task_name [String, Symbol] Name of the task to track
+    # @yield [TaskInfo] The task info instance for use within the block
+    # @return [Object] Result of the yielded block
+    #
+    # @example
+    #   Makit::TaskInfo.track(:generate) do
+    #     # generate code
+    #   end
+    def self.track(task_name)
+      task = new(task_name)
+      Makit::SHOW.task(task_name)
+      yield(task)
+    ensure
+      task&.report_and_store_time_taken
+    end
+
+    # Track execution time with inferred task name
+    #
+    # Similar to track() but attempts to infer the task name automatically.
+    # Currently returns nil as task name inference is not implemented.
+    #
+    # @yield [TaskInfo] The task info instance for use within the block
+    # @return [Object] Result of the yielded block
+    def self.track_inferred(&block)
+      task_name = infer_task_name
+      Makit::SHOW.task(task_name)
+      track(task_name, &block)
+    end
+
+    # Initialize a new task tracking instance
+    #
+    # Sets up timing tracking for a named task, creates an artifacts
+    # directory path, and records the start time.
+    #
+    # @param task_name [String, Symbol] Name of the task to track
+    def initialize(task_name)
+      @task_name = task_name
+      @artifacts_dir = File.join("artifacts", task_name.to_s.gsub(":", "_"))
+      @start_time = Time.now
+      # at_exit { report_and_store_time_taken }
+    end
+
+    # Report and store the task execution time
+    #
+    # Calculates the duration, displays a human-readable completion message,
+    # and stores the timing information in the class-level completed_tasks hash.
+    #
+    # @return [nil]
+    def report_and_store_time_taken
+      @end_time = Time.now
+      duration = @end_time - @start_time
+
+      # leverate the Makit::Humanize.get_humanized_duration method
+      humanized_duration = Makit::Humanize.get_humanized_duration(duration)
+      puts "  #{@task_name} completed in #{humanized_duration}".colorize(:grey)
+      # puts "[TaskGuard] Task '#{@task_name}' completed in #{duration}."
+
+      # Add to class-level storage
+      self.class.completed_tasks[@task_name] = {
+        start_time: @start_time,
+        end_time: @end_time,
+        duration: duration,
+      }
+    end
+
+    # def format_duration(seconds)
+    #   if seconds >= 60
+    #     mins = (seconds / 60).to_i
+    #     secs = (seconds % 60).round(2)
+    #     "#{mins}m #{secs}s"
+    #   else
+    #     "#{seconds.round(2)}s"
+    #      end
+    # end
+
+    # Attempt to infer the current task name
+    #
+    # This method would extract the current Rake task name from the
+    # application context, but is currently not implemented.
+    #
+    # @return [String, nil] The inferred task name, or nil if unavailable
+    def self.infer_task_name
+      # Rake.application.current_scope.join(":") rescue "unknown"
+    end
+  end
+end

data/lib/makit/tasks/at_exit.rb

@@ -0,0 +1,13 @@
+require "English"
+
+at_exit do
+  command = "rake #{ARGV.join(" ")}"
+  duration = Time.now - Makit::STARTTIME
+  message = "#{command} (#{Makit::Humanize.get_humanized_duration(duration)})"
+  # detect if the rake execution was successful
+  if $ERROR_INFO.nil?
+    Makit::Logging.default_logger.info(message)
+  else
+    Makit::Logging.default_logger.error(message)
+  end # display the humanized duration of the rake execution
+end

data/lib/makit/tasks/build.rb

@@ -0,0 +1,19 @@
+require_relative "../setup/runner"
+
+desc "Build project artifacts.."
+task :build do
+  # load the default project configuration
+  #puts "loading project configuration"
+  #project = Makit::Configuration::Project.default
+
+  # for each step in the project configuration, run the commands
+  #project.steps.each do |step|
+  #  step.commands.each do |command|
+  #    request = Makit::Commands::Request.from_string(command)
+  #    result = Makit::Commands::Runner.default.execute(request)
+  #  end
+  #end
+
+  # Make sure the build commands are in the project configuration
+
+end

data/lib/makit/tasks/clean.rb

@@ -0,0 +1,11 @@
+require "rake/clean"
+require_relative "../git/repository"
+require_relative "../commands/runner"
+
+CLEAN.include("artifacts/**/*")
+
+task :clean do
+  if Makit::Git::Repository.git_repo?
+    Makit::Commands::Runner.default.execute(Makit::Commands::Request.from_string("git clean -dXf"))
+  end
+end