makit 0.0.99 → 0.0.112

data/lib/makit/services/builder.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require_relative "validator"
+require_relative "repository_manager"
+
+module Makit
+  module Services
+    # Service class responsible for build operations and make processes
+    # Handles the complex build workflow including repository setup and execution
+    class Builder
+      class << self
+        # Build a repository at a specific commit
+        #
+        # @param url [String] the git repository URL
+        # @param commit [String] the commit hash or "latest" for the most recent commit
+        # @param force [Boolean] whether to force rebuild even if cached result exists
+        # @return [Makit::V1::MakeResult] the build result with all command outputs
+        def make_repository(url, commit, force: false)
+          Validator.validate_url_parameter(url)
+          Validator.validate_commit_parameter(commit)
+
+          log_filename = get_log_filename(url, commit)
+
+          return load_existing_result(log_filename) if should_load_existing_result?(log_filename, force, commit)
+
+          execute_make_process(url, commit, log_filename)
+        end
+
+        # Ensure .gitignore exists in the current directory
+        def ensure_gitignore
+          return if File.exist?(".gitignore")
+
+          Makit::LOGGER.info("added .gitignore file")
+          File.open(".gitignore", "w") do |file|
+            file.puts Makit::Content::GITIGNORE
+          end
+        end
+
+        private
+
+        # Get the log filename for storing build results
+        def get_log_filename(url, commit)
+          File.join(
+            Directories.get_log_directory(url),
+            commit,
+            "#{Makit::RUNTIME_IDENTIFIER}.#{Makit::DEVICE}.json"
+          )
+        end
+
+        # Check if we should load an existing cached result
+        def should_load_existing_result?(log_filename, force, commit)
+          File.exist?(log_filename) && !force && commit != Validator::COMMIT_LATEST
+        end
+
+        # Load existing build result from cache
+        def load_existing_result(log_filename)
+          Makit::V1::MakeResult.decode_json(File.read(log_filename))
+        rescue StandardError
+          FileUtils.rm(log_filename)
+          nil
+        end
+
+        # Execute the complete make process
+        def execute_make_process(url, commit, log_filename)
+          commands = []
+          begin
+            commands = setup_repository_for_build(url, commit, log_filename)
+            make_result = build_make_result(url, commit, commands)
+            save_make_result(make_result, log_filename)
+            make_result
+          rescue StandardError => e
+            handle_make_error(e, url, commit, commands)
+          end
+        end
+
+        # Set up repository for build process
+        def setup_repository_for_build(url, commit, log_filename)
+          commands = initialize_repository_commands(url)
+
+          clone_dir = RepositoryManager.validate_clone_directory(url)
+          resolved_commit = resolve_commit_reference(commit, clone_dir, commands, log_filename, url)
+          prepare_make_directory(url, resolved_commit, clone_dir, commands)
+
+          commands
+        end
+
+        # Initialize repository commands (clone or pull)
+        def initialize_repository_commands(url)
+          RepositoryManager.clone_or_pull_repository(url).flatten
+        end
+
+        # Resolve commit reference (handle "latest" commit)
+        def resolve_commit_reference(commit, clone_dir, commands, log_filename, url)
+          return commit unless commit == Validator::COMMIT_LATEST
+
+          latest_commit = RepositoryManager.get_latest_commit(clone_dir, commands)
+          # Update log filename with resolved commit hash
+          log_filename.replace(
+            File.join(
+              Directories.get_log_directory(url),
+              latest_commit,
+              "#{Makit::RUNTIME_IDENTIFIER}.#{Makit::DEVICE}.json"
+            )
+          )
+          latest_commit
+        end
+
+        # Prepare make directory with repository clone
+        def prepare_make_directory(url, commit, clone_dir, commands)
+          make_dir = Directories.get_make_commit_directory(url, commit)
+          FileUtils.rm_rf(make_dir)
+
+          clone_command = Makit::Commands::Runner.default.execute("git clone #{clone_dir} #{make_dir}")
+          commands << clone_command
+
+          return if Dir.exist?(make_dir)
+
+          raise Makit::CloneError, "failed to clone repository: #{url} to #{make_dir}"
+        end
+
+        # Build the make result by executing all build steps
+        def build_make_result(url, commit, commands)
+          Dir.chdir(Directories.get_make_commit_directory(url, commit)) do
+            execute_git_commands(commit, commands)
+            execute_build_commands(commands)
+
+            make_result = create_make_result_object(url, commit)
+            commands.flatten.each { |command| make_result.commands << command }
+            make_result
+          end
+        end
+
+        # Execute git-specific commands for the build
+        def execute_git_commands(commit, commands)
+          commands << Makit::Commands::Runner.default.execute("git reset --hard #{commit}")
+          commands << Makit::Commands::Runner.default.execute("git log -n 1")
+        end
+
+        # Execute build commands (bundle, rake, etc.)
+        def execute_build_commands(commands)
+          commands << Makit::Commands::Runner.default.execute("bundle install") if File.exist?("Gemfile")
+
+          return unless File.exist?("Rakefile") || File.exist?("rakefile.rb")
+
+          commands << Makit::Commands::Runner.default.execute("rake default")
+        end
+
+        # Create the make result object
+        def create_make_result_object(url, commit)
+          Makit::V1::MakeResult.new(
+            repository: url,
+            commit: commit,
+            branch: "?",
+            tag: "?",
+            device: Makit::DEVICE,
+            runtime_identifier: Makit::RUNTIME_IDENTIFIER,
+          )
+        end
+
+        # Save make result to file
+        def save_make_result(make_result, log_filename)
+          FileUtils.mkdir_p(File.dirname(log_filename))
+          File.write(log_filename, make_result.to_json)
+        end
+
+        # Handle make process errors
+        def handle_make_error(error, url, commit, commands)
+          message_parts = [
+            "error raised attempting to make repository: #{url} commit: #{commit}",
+            "",
+            error.message,
+            error.backtrace.join("\\n"),
+            "",
+            "commands:",
+          ]
+
+          commands.flatten.each do |command|
+            message_parts << Makit::Humanize.get_command_details(command)
+          end
+
+          raise Makit::BuildError, message_parts.join("\\n")
+        end
+      end
+    end
+  end
+end

data/lib/makit/services/error_handler.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module Makit
+  module Services
+    # Service class responsible for handling and formatting errors
+    # Provides user-friendly error messages and recovery suggestions
+    class ErrorHandler
+      # Error message templates with suggestions
+      ERROR_MESSAGES = {
+        invalid_url: {
+          message: "The repository URL '%<url>s' is not valid.",
+          suggestions: [
+            "Use HTTPS format: https://github.com/user/repo.git",
+            "Use SSH format: git@github.com:user/repo.git",
+            "Use simple format: user/repo",
+            "Ensure the URL points to a git repository",
+          ],
+        },
+        invalid_directory: {
+          message: "The directory path '%<directory>s' is not valid.",
+          suggestions: [
+            "Use absolute paths like /path/to/directory",
+            "Use relative paths like ./relative/path",
+            "Ensure the path doesn't contain null characters",
+            "Keep directory paths under 255 characters",
+          ],
+        },
+        invalid_commit: {
+          message: "The commit '%<commit>s' is not valid.",
+          suggestions: [
+            "Use 'latest' for the most recent commit",
+            "Use a full 40-character commit hash",
+            "Use a short 7+ character commit hash",
+            "Verify the commit exists in the repository",
+          ],
+        },
+        directory_not_found: {
+          message: "The directory '%<directory>s' does not exist or is not accessible.",
+          suggestions: [
+            "Check that the directory path is correct",
+            "Verify you have read permissions for the directory",
+            "Create the directory first if it doesn't exist",
+            "Use 'makit init' to create a new project directory",
+          ],
+        },
+        git_command_failed: {
+          message: "Git command failed: %<command>s",
+          suggestions: [
+            "Check that git is installed and available in PATH",
+            "Verify you have network connectivity for remote operations",
+            "Ensure you have proper permissions for the repository",
+            "Check that the remote repository URL is accessible",
+          ],
+        },
+        clone_failed: {
+          message: "Failed to clone repository '%<url>s'.",
+          suggestions: [
+            "Check that the repository URL is correct and accessible",
+            "Verify your network connectivity",
+            "Ensure you have proper authentication (SSH keys, tokens)",
+            "Check that you have write permissions to the destination directory",
+          ],
+        },
+        pull_failed: {
+          message: "Failed to pull changes from repository.",
+          suggestions: [
+            "Check that you have network connectivity",
+            "Verify the remote repository is accessible",
+            "Ensure your local repository is in a clean state",
+            "Try 'git status' to check for conflicts",
+          ],
+        },
+        build_failed: {
+          message: "Build process failed for repository '%<url>s' at commit '%<commit>s'.",
+          suggestions: [
+            "Check the build logs for specific error messages",
+            "Verify all dependencies are installed",
+            "Ensure the commit hash is valid and exists",
+            "Try building manually to isolate the issue",
+          ],
+        },
+      }.freeze
+
+      class << self
+        # Format an error with user-friendly message and suggestions
+        #
+        # @param error_type [Symbol] the type of error from ERROR_MESSAGES
+        # @param details [Hash] details to interpolate into the message
+        # @param original_error [Exception] the original exception (optional)
+        # @return [String] formatted error message with suggestions
+        def format_error(error_type, details = {}, original_error = nil)
+          error_config = ERROR_MESSAGES[error_type]
+          return "Unknown error type: #{error_type}" unless error_config
+
+          message = error_config[:message] % details
+          suggestions = error_config[:suggestions]
+
+          formatted_message = ["❌ Error: #{message}"]
+
+          if suggestions && !suggestions.empty?
+            formatted_message << ""
+            formatted_message << "💡 Suggestions:"
+            suggestions.each_with_index do |suggestion, index|
+              formatted_message << "  #{index + 1}. #{suggestion}"
+            end
+          end
+
+          if original_error && !original_error.message.empty?
+            formatted_message << ""
+            formatted_message << "🔍 Technical details:"
+            formatted_message << "  #{original_error.class}: #{original_error.message}"
+          end
+
+          formatted_message.join("\n")
+        end
+
+        # Handle ArgumentError exceptions with user-friendly formatting
+        #
+        # @param error [ArgumentError] the argument error to format
+        # @param context [Hash] additional context about where the error occurred
+        # @return [String] formatted error message
+        def handle_argument_error(error, context = {})
+          case error.message
+          when /URL parameter cannot be nil|URL parameter cannot be empty|Invalid URL format/
+            format_error(:invalid_url, { url: context[:url] || "unknown" }, error)
+          when /directory parameter cannot be nil|directory parameter cannot be empty|directory path/
+            format_error(:invalid_directory, { directory: context[:directory] || "unknown" }, error)
+          when /commit parameter cannot be nil|commit parameter cannot be empty|Invalid commit format/
+            format_error(:invalid_commit, { commit: context[:commit] || "unknown" }, error)
+          else
+            "❌ Error: #{error.message}\n💡 Please check your input parameters and try again."
+          end
+        end
+
+        # Handle Makit-specific exceptions with user-friendly formatting
+        #
+        # @param error [Makit::Error] the Makit error to format
+        # @param context [Hash] additional context about where the error occurred
+        # @return [String] formatted error message
+        def handle_makit_error(error, context = {})
+          case error
+          when Makit::DirectoryError
+            format_error(:directory_not_found, { directory: context[:directory] || "unknown" }, error)
+          when Makit::CloneError
+            format_error(:clone_failed, { url: context[:url] || "unknown" }, error)
+          when Makit::PullError
+            format_error(:pull_failed, {}, error)
+          when Makit::BuildError
+            format_error(:build_failed, { url: context[:url] || "unknown", commit: context[:commit] || "unknown" },
+                         error)
+          when Makit::GitError
+            format_error(:git_command_failed, { command: context[:command] || "unknown" }, error)
+          else
+            "❌ Error: #{error.message}\n💡 Please refer to the documentation or run with --verbose for more details."
+          end
+        end
+
+        # Log error with context for debugging
+        #
+        # @param error [Exception] the error to log
+        # @param context [Hash] additional context information
+        def log_error(error, context = {})
+          return unless defined?(Makit::LOGGER) && Makit::LOGGER
+
+          Makit::LOGGER.error "Error occurred: #{error.class} - #{error.message}"
+          Makit::LOGGER.error "Context: #{context.inspect}" unless context.empty?
+          Makit::LOGGER.debug "Backtrace: #{error.backtrace&.join("\n")}" if error.backtrace
+        end
+
+        # Wrap a block with comprehensive error handling
+        #
+        # @param context [Hash] context information for error messages
+        # @yield block to execute with error handling
+        # @return [Object] the result of the block
+        def with_error_handling(context = {})
+          yield
+        rescue ArgumentError => e
+          log_error(e, context)
+          formatted_message = handle_argument_error(e, context)
+          raise Makit::ValidationError, formatted_message
+        rescue Makit::Error => e
+          log_error(e, context)
+          formatted_message = handle_makit_error(e, context)
+          raise e.class, formatted_message
+        rescue StandardError => e
+          log_error(e, context)
+          formatted_message = "❌ An unexpected error occurred: #{e.message}\n💡 Please check the logs or run with --verbose for more details."
+          raise Makit::Error, formatted_message
+        end
+
+        # Validate input and provide helpful error messages
+        #
+        # @param validations [Array<Hash>] array of validation rules
+        # @example
+        #   validate_inputs([
+        #     { value: url, validator: :url, name: 'repository URL' },
+        #     { value: commit, validator: :commit, name: 'commit hash' }
+        #   ])
+        def validate_inputs(validations)
+          validations.each do |validation|
+            value = validation[:value]
+            validator = validation[:validator]
+            name = validation[:name] || "parameter"
+
+            case validator
+            when :url
+              Validator.validate_url_parameter(value)
+            when :directory
+              Validator.validate_directory_parameter(value)
+            when :commit
+              Validator.validate_commit_parameter(value)
+            when :required_string
+              Validator.validate_required_string(value, name)
+            when :boolean
+              Validator.validate_boolean_parameter(value, name)
+            end
+          rescue ArgumentError => e
+            context = { validator => value }
+            formatted_message = handle_argument_error(e, context)
+            raise Makit::ValidationError, formatted_message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/makit/services/repository_manager.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+require_relative "validator"
+
+module Makit
+  module Services
+    # Service class responsible for git repository management operations
+    # Handles cloning, pulling, logging, and working directory setup
+    class RepositoryManager
+      class << self
+        # Initialize a new git repository in the specified directory
+        #
+        # @param directory [String] the directory path to initialize
+        # @return [Makit::V1::Command] the git init command result
+        # @raise [Makit::DirectoryError] if the directory cannot be created
+        # @raise [Makit::GitError] if git initialization fails
+        def initialize_repository(directory)
+          Validator.validate_directory_parameter(directory)
+          FileUtils.mkdir_p(directory)
+
+          raise Makit::DirectoryError, "directory does not exist: #{directory}" unless Dir.exist?(directory)
+
+          Dir.chdir(directory) do
+            File.write(".gitignore", Makit::Content::GITIGNORE) unless File.exist?(".gitignore")
+            init_command = Makit::Commands::Runner.default.execute("git init")
+
+            if init_command.exit_code != 0
+              raise Makit::GitError, "failed to initialize local repository: #{directory}\\n#{Makit::Humanize.get_command_summary(init_command)}"
+            end
+
+            init_command
+          end
+        end
+
+        # Clone a git repository to a local directory
+        #
+        # @param git_repository [String] the git repository URL
+        # @return [Array<Makit::V1::Command>] array of command results
+        def clone_repository(git_repository)
+          Validator.validate_url_parameter(git_repository)
+          commands = []
+
+          clone_dir = Directories.get_clone_directory(git_repository)
+          commands << Makit::Commands::Runner.default.execute("git clone #{git_repository} #{clone_dir}") unless Dir.exist?(clone_dir)
+
+          commands
+        end
+
+        # Pull the latest changes from the remote repository
+        #
+        # @param git_repository [String] the git repository URL
+        # @return [Makit::V1::Command] the git pull command result
+        def pull_repository(git_repository)
+          Validator.validate_url_parameter(git_repository)
+          clone_dir = Directories.get_clone_directory(git_repository)
+
+          Validator.validate_directory_exists(clone_dir, "clone directory")
+
+          Dir.chdir(clone_dir) do
+            execute_git_pull(clone_dir)
+          end
+        end
+
+        # Clone repository if it doesn't exist, otherwise pull latest changes
+        #
+        # @param git_repository [String] the git repository URL
+        # @return [Array<Makit::V1::Command>] array of command results
+        def clone_or_pull_repository(git_repository)
+          commands = []
+          clone_dir = Directories.get_clone_directory(git_repository)
+
+          commands << if Dir.exist?(clone_dir)
+            pull_repository(git_repository)
+          else
+            clone_repository(git_repository)
+          end
+          commands
+        end
+
+        # Get git log information for a repository
+        #
+        # @param git_repository [String] the git repository URL
+        # @param limit [Integer] maximum number of commits to retrieve
+        # @param skip [Integer] number of commits to skip
+        # @return [Array<Makit::V1::GitLogEntry>] array of log entries
+        def get_repository_log(git_repository, limit, skip)
+          Validator.validate_url_parameter(git_repository)
+          Validator.validate_pagination_parameters(limit, skip)
+
+          clone_dir = Directories.get_clone_directory(git_repository)
+          Validator.validate_directory_exists(clone_dir, "clone directory")
+
+          Dir.chdir(clone_dir) do
+            log_command = Makit::Commands::Runner.default.execute("git log -n #{limit} --skip #{skip} --date=iso")
+            parse_git_log_output(log_command)
+          end
+        end
+
+        # Set up a work directory for a repository
+        #
+        # @param repository [String] the git repository URL
+        # @return [nil] always returns nil
+        def setup_work_directory(repository)
+          Validator.validate_url_parameter(repository)
+          clone_or_pull_repository(repository)
+          create_work_directory(repository)
+          nil
+        end
+
+        # Get the latest commit hash from a repository
+        #
+        # @param clone_dir [String] the local clone directory
+        # @param commands [Array] array to append command results to
+        # @return [String] the latest commit hash
+        def get_latest_commit(clone_dir, commands)
+          Dir.chdir(clone_dir) do
+            git_log = Makit::Commands::Runner.default.execute("git log -n 1 --date=iso")
+            commands << git_log
+
+            commit = git_log.output.match(/^commit ([0-9a-f]{#{Validator::COMMIT_HASH_LENGTH}})$/i)&.captures&.first
+
+            if commit.nil? || commit.empty? || !commit.match?(/\\A[0-9a-f]{#{Validator::COMMIT_HASH_LENGTH}}\\z/i)
+              raise Makit::InvalidCommitError, "invalid commit: #{commit}"
+            end
+
+            commit
+          end
+        end
+
+        # Validate that a clone directory exists for the given repository
+        #
+        # @param url [String] the git repository URL
+        # @return [String] the clone directory path
+        def validate_clone_directory(url)
+          clone_dir = Directories.get_clone_directory(url)
+          Validator.validate_directory_exists(clone_dir, "clone directory")
+          clone_dir
+        end
+
+        private
+
+        # Execute git pull command with proper error handling
+        def execute_git_pull(clone_dir)
+          request = Makit::V1::CommandRequest.new(
+            name: "git",
+            arguments: ["pull"],
+            directory: clone_dir,
+          )
+          pull_command = Makit::Commands::Runner.default.execute(request)
+
+          raise Makit::PullError, Makit::Humanize.get_command_details(pull_command) if pull_command.exit_code != 0
+
+          pull_command
+        end
+
+        # Create work directory for development
+        def create_work_directory(repository)
+          work_dir = Makit::Directories.get_work_directory(repository)
+          clone_dir = Makit::Directories.get_clone_directory(repository)
+
+          unless Dir.exist?(work_dir)
+            FileUtils.mkdir_p(File.dirname(work_dir))
+            Makit::Commands::Runner.default.execute("git clone #{clone_dir} #{work_dir}")
+          end
+
+          Dir.chdir(work_dir) do
+            File.write(".gitignore", Makit::Content::GITIGNORE) unless File.exist?(".gitignore")
+          end
+        end
+
+        # Parse git log output into structured log entries
+        def parse_git_log_output(log_command)
+          entries = []
+          return entries if log_command.exit_code != 0
+
+          lines = log_command.output.split("\\n")
+          current_entry = nil
+
+          lines.each do |line|
+            current_entry = process_git_log_line(line, current_entry, entries)
+          end
+
+          entries
+        end
+
+        # Process a single line from git log output
+        def process_git_log_line(line, current_entry, entries)
+          case line
+          when /^commit/
+            create_new_log_entry(line, entries)
+          when /^Author:/
+            current_entry ? update_entry_author(line, current_entry) : current_entry
+          when /^Date:/
+            current_entry ? update_entry_date(line, current_entry) : current_entry
+          when /^    /
+            current_entry ? update_entry_message(line, current_entry) : current_entry
+          else
+            current_entry
+          end
+        end
+
+        # Create new git log entry from commit line
+        def create_new_log_entry(line, entries)
+          current_entry = GitLogEntry.new(line.split[1])
+          entries << current_entry
+          current_entry
+        end
+
+        # Update log entry with author information
+        def update_entry_author(line, current_entry)
+          current_entry.author = line.split[1..].join(" ")
+          current_entry
+        end
+
+        # Update log entry with date information
+        def update_entry_date(line, current_entry)
+          current_entry.date = line.split[1..].join(" ")
+          current_entry
+        end
+
+        # Update log entry with commit message
+        def update_entry_message(line, current_entry)
+          current_entry.message += line[4..]
+          current_entry
+        end
+      end
+    end
+  end
+end