makit 0.0.99 → 0.0.112

data/lib/makit/services/validator.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Makit
+  module Services
+    # Service class responsible for validating all input parameters
+    # Used by various Makit operations to ensure data integrity
+    class Validator
+      # Git-related validation constants
+      COMMIT_HASH_LENGTH = 40
+      COMMIT_LATEST = "latest"
+      MAX_PAGINATION_LIMIT = 1000
+      MAX_DIRECTORY_PATH_LENGTH = 255
+
+      class << self
+        # Validate directory parameter for initialization operations
+        #
+        # @param directory [String] the directory path to validate
+        # @raise [ArgumentError] if directory parameter is invalid
+        def validate_directory_parameter(directory)
+          raise ArgumentError, "directory parameter cannot be nil" if directory.nil?
+          raise ArgumentError, "directory parameter cannot be empty" if directory.to_s.strip.empty?
+          raise ArgumentError, "directory path contains invalid characters" if directory.to_s.include?("\0")
+          raise ArgumentError, "directory path is too long" if directory.to_s.length > MAX_DIRECTORY_PATH_LENGTH
+        end
+
+        # Validate URL parameter for git repository operations
+        #
+        # @param url [String] the repository URL to validate
+        # @raise [ArgumentError] if URL parameter is invalid
+        def validate_url_parameter(url)
+          raise ArgumentError, "URL parameter cannot be nil" if url.nil?
+          raise ArgumentError, "URL parameter cannot be empty" if url.to_s.strip.empty?
+
+          url_str = url.to_s.strip
+          # Basic URL format validation - accept git@, https://, http://, and simple names like "user/repo"
+          valid_patterns = [
+            %r{\Agit@[\w.-]+:[\w._/-]+\.git\z}, # SSH format: git@github.com:user/repo.git
+            %r{\Ahttps?://[\w.-]+/[\w._/-]+(\.git)?\z}, # HTTPS format: https://github.com/user/repo
+            %r{\A[\w.-]+/[\w._-]+\z}, # Simple format: user/repo
+          ]
+
+          return if valid_patterns.any? { |pattern| url_str.match?(pattern) }
+
+          raise ArgumentError, "Invalid URL format: #{url_str}"
+        end
+
+        # Validate commit parameter for git operations
+        #
+        # @param commit [String] the commit hash or "latest" to validate
+        # @raise [ArgumentError] if commit parameter is invalid
+        def validate_commit_parameter(commit)
+          raise ArgumentError, "commit parameter cannot be nil" if commit.nil?
+
+          commit_str = commit.to_s.strip
+          raise ArgumentError, "commit parameter cannot be empty" if commit_str.empty?
+
+          # Allow "latest" or valid commit hash formats
+          return if commit_str == COMMIT_LATEST
+          return if commit_str.match?(/\A[0-9a-f]{7,#{COMMIT_HASH_LENGTH}}\z/i)
+
+          raise ArgumentError, "Invalid commit format: #{commit_str}. Must be 'latest' or a valid git commit hash."
+        end
+
+        # Validate pagination parameters for log operations
+        #
+        # @param limit [Integer] maximum number of items to retrieve
+        # @param skip [Integer] number of items to skip
+        # @raise [ArgumentError] if pagination parameters are invalid
+        def validate_pagination_parameters(limit, skip)
+          unless limit.is_a?(Integer) && limit.positive?
+            raise ArgumentError,
+                  "limit parameter must be a positive integer"
+          end
+          raise ArgumentError, "skip parameter must be a non-negative integer" unless skip.is_a?(Integer) && skip >= 0
+          raise ArgumentError, "limit parameter is too large" if limit > MAX_PAGINATION_LIMIT
+        end
+
+        # Validate that a directory exists and is accessible
+        #
+        # @param directory [String] the directory path to check
+        # @param description [String] human-readable description for error messages
+        # @raise [Makit::DirectoryError] if directory doesn't exist or isn't accessible
+        def validate_directory_exists(directory, description = "directory")
+          return if Dir.exist?(directory)
+
+          raise Makit::DirectoryError, "#{description} does not exist: #{directory}"
+        end
+
+        # Validate boolean parameters
+        #
+        # @param value [Object] the value to check
+        # @param parameter_name [String] the parameter name for error messages
+        # @raise [ArgumentError] if value is not boolean
+        def validate_boolean_parameter(value, parameter_name)
+          return if [true, false].include?(value)
+
+          raise ArgumentError, "#{parameter_name} must be true or false, got #{value.class}"
+        end
+
+        # Validate string parameters that cannot be empty
+        #
+        # @param value [String] the string value to validate
+        # @param parameter_name [String] the parameter name for error messages
+        # @raise [ArgumentError] if string is nil or empty
+        def validate_required_string(value, parameter_name)
+          raise ArgumentError, "#{parameter_name} cannot be nil" if value.nil?
+          raise ArgumentError, "#{parameter_name} cannot be empty" if value.to_s.strip.empty?
+        end
+      end
+    end
+  end
+end

data/lib/makit/setup/classlib.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+require_relative "../configuration/project"
+
+module Makit
+  module Setup
+    class ClassLib
+      def self.run
+        #puts "Setting up Nuget project..."
+        project = Makit::Configuration::Project.default
+        Makit::DotNet::Project.new_project("classlib", project.name, "source/#{project.name}", "--framework net8.0")
+        Makit::DotNet::Project.new_project("TUnit", "#{project.name}.Tests", "tests/#{project.name}")
+        Makit::DotNet::Project.add_reference("tests/#{project.name}/#{project.name}.Tests.csproj", "source/#{project.name}/#{project.name}.csproj")
+        update_build_step(project)
+        update_test_step(project)
+
+        project.save
+        Makit::Logging.default_logger.info("Project setup completed")
+      end
+
+      def self.update_build_step(project)
+        build_commands = Array.new
+        build_commands << "dotnet build source/#{project.name}/#{project.name}.csproj --configuration Release"
+        steps = project.steps
+        if steps.any? { |step| step.name == "build" }
+          build_step = steps.find { |step| step.name == "build" }
+          build_step.commands = build_commands
+        else
+          build_step = Makit::Configuration::Step.new(name: "build", description: "Build the project artifacts", commands: build_commands)
+          build_step.commands = build_commands
+          project.add_step(build_step)
+        end
+        build_step.commands = build_commands
+
+        project.save
+      end
+
+      def self.update_test_step(project)
+        test_commands = Array.new
+        test_commands << "dotnet test tests/#{project.name}/#{project.name}.Tests.csproj"
+        steps = project.steps
+        if steps.any? { |step| step.name == "test" }
+          test_step = steps.find { |step| step.name == "test" }
+          test_step.commands = test_commands
+        else
+          test_step = Makit::Configuration::Step.new(name: "test", description: "Run the project tests", commands: test_commands)
+          test_step.commands = test_commands
+          project.add_step(test_step)
+        end
+        project.save
+      end
+    end
+  end
+end

data/lib/makit/setup/gem.rb

@@ -0,0 +1,263 @@
+# frozen_string_literal: true
+require_relative "../configuration/project"
+
+module Makit
+  module Setup
+    class Gem
+      def self.run
+        project = Makit::Configuration::Project.default
+        Makit::Logging.default_logger.info("Setting up Ruby gem project: #{project.name}")
+
+        # Create basic gem structure
+        create_gem_structure(project)
+
+        # Update build and test steps
+        update_build_step(project)
+        update_test_step(project)
+
+        project.save
+        Makit::Logging.default_logger.info("Ruby gem project setup completed")
+      end
+
+      private
+
+      def self.create_gem_structure(project)
+        # Create directories
+        FileUtils.mkdir_p("lib/#{project.name}")
+        FileUtils.mkdir_p("test")
+        FileUtils.mkdir_p("exe")
+
+        # Create basic gem files
+        create_gemspec(project)
+        create_gemfile(project)
+        create_main_lib(project)
+        create_version_file(project)
+        create_rakefile(project)
+        create_test_helper(project)
+        create_test_file(project)
+        create_readme(project)
+      end
+
+      def self.create_gemspec(project)
+        gemspec_content = <<~GEMSPEC
+          # frozen_string_literal: true
+
+          require_relative "lib/#{project.name}/version"
+
+          Gem::Specification.new do |spec|
+            spec.name = "#{project.name}"
+            spec.version = #{project.name.capitalize}::VERSION
+            spec.authors = ["Your Name"]
+            spec.email = ["your.email@example.com"]
+
+            spec.summary = "A Ruby gem"
+            spec.description = "A Ruby gem description"
+            spec.homepage = "https://github.com/yourusername/#{project.name}"
+            spec.license = "MIT"
+
+            spec.files = Dir["lib/**/*.rb", "exe/**/*", "README.md", "LICENSE.txt"]
+            spec.bindir = "exe"
+            spec.executables = []
+            spec.require_paths = ["lib"]
+
+            spec.add_development_dependency "bundler", "~> 2.0"
+            spec.add_development_dependency "rake", "~> 13.0"
+            spec.add_development_dependency "minitest", "~> 5.0"
+          end
+        GEMSPEC
+
+        gemspec_path = "#{project.name}.gemspec"
+        return if File.exist?(gemspec_path)
+        File.write(gemspec_path, gemspec_content)
+      end
+
+      def self.create_gemfile(project)
+        gemfile_content = <<~GEMFILE
+          # frozen_string_literal: true
+
+          source "https://rubygems.org"
+
+          # Specify your gem's dependencies in #{project.name}.gemspec
+          gemspec
+        GEMFILE
+
+        return if File.exist?("Gemfile")
+        File.write("Gemfile", gemfile_content)
+      end
+
+      def self.create_main_lib(project)
+        main_lib_path = "lib/#{project.name}.rb"
+        return if File.exist?(main_lib_path)
+        
+        main_lib_content = <<~MAIN_LIB
+          # frozen_string_literal: true
+
+          require_relative "#{project.name}/version"
+
+          module #{project.name.capitalize}
+            class Error < StandardError; end
+            # Your code goes here...
+          end
+        MAIN_LIB
+
+        File.write(main_lib_path, main_lib_content)
+      end
+
+      def self.create_version_file(project)
+        version_path = "lib/#{project.name}/version.rb"
+        return if File.exist?(version_path)
+        
+        version_content = <<~VERSION
+          # frozen_string_literal: true
+
+          module #{project.name.capitalize}
+            VERSION = "#{project.version}"
+          end
+        VERSION
+
+        File.write(version_path, version_content)
+      end
+
+      def self.create_rakefile(project)
+        return if File.exist?("Rakefile")
+
+        rakefile_content = <<~RAKEFILE
+          # frozen_string_literal: true
+
+          require "bundler/gem_tasks"
+          require "minitest/test_task"
+          require "makit"
+
+          Minitest::TestTask.create
+
+          task :default => [:build, :install] do
+          end
+        RAKEFILE
+
+        File.write("Rakefile", rakefile_content)
+      end
+
+      def self.create_test_helper(project)
+        return if File.exist?("test/test_helper.rb")
+        
+        test_helper_content = <<~TEST_HELPER
+          # frozen_string_literal: true
+
+          require "minitest/autorun"
+          require_relative "../lib/#{project.name}"
+        TEST_HELPER
+
+        File.write("test/test_helper.rb", test_helper_content)
+      end
+
+      def self.create_test_file(project)
+        test_content = <<~TEST
+          # frozen_string_literal: true
+
+          require "test_helper"
+
+          class #{project.name.capitalize}Test < Minitest::Test
+            def test_that_it_has_a_version_number
+              refute_nil ::#{project.name.capitalize}::VERSION
+            end
+
+            def test_it_does_something_useful
+              assert false
+            end
+          end
+        TEST
+
+        File.write("test/#{project.name}_test.rb", test_content)
+      end
+
+      def self.create_readme(project)
+        readme_content = <<~README
+          # #{project.name.capitalize}
+
+          Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/#{project.name}`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+          TODO: Delete this and the text above, and describe your gem
+
+          ## Installation
+
+          Add this line to your application's Gemfile:
+
+          ```ruby
+          gem "#{project.name}"
+          ```
+
+          And then execute:
+
+              $ bundle
+
+          Or install it yourself as:
+
+              $ gem install #{project.name}
+
+          ## Usage
+
+          ```ruby
+          require "#{project.name}"
+
+          # TODO: Write usage instructions here
+          ```
+
+          ## Development
+
+          After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+          ## Contributing
+
+          Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/#{project.name}.
+
+          ## License
+
+          The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+        README
+
+        File.write("README.md", readme_content)
+      end
+
+      def self.update_build_step(project)
+        build_commands = [
+          "bundle exec rake build",
+        ]
+
+        steps = project.steps
+        if steps.any? { |step| step.name == "build" }
+          build_step = steps.find { |step| step.name == "build" }
+          build_step.commands = build_commands
+        else
+          build_step = Makit::Configuration::Step.new(
+            name: "build",
+            description: "Build the gem",
+            commands: build_commands,
+          )
+          project.add_step(build_step)
+        end
+        build_step.commands = build_commands
+        project.save
+      end
+
+      def self.update_test_step(project)
+        test_commands = [
+          "bundle exec rake test",
+        ]
+
+        steps = project.steps
+        if steps.any? { |step| step.name == "test" }
+          test_step = steps.find { |step| step.name == "test" }
+          test_step.commands = test_commands
+        else
+          test_step = Makit::Configuration::Step.new(
+            name: "test",
+            description: "Run the tests",
+            commands: test_commands,
+          )
+          project.add_step(test_step)
+        end
+        project.save
+      end
+    end
+  end
+end

data/lib/makit/setup/runner.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require_relative "classlib"
+require_relative "gem"
+
+module Makit
+  module Setup
+    class Runner
+      def self.run
+
+        # open .makit.json and get project type, to determine which setup to run
+        if File.exist?(".makit.json")
+          begin
+            project = Makit::Serializer.open(".makit.json", Makit::Configuration::Project)
+
+            # Update version to match VERSION constant if it exists
+            if defined?(Makit::VERSION)
+              project.version = Makit::VERSION
+            end
+
+            # Check if the file contains compact JSON and resave as pretty JSON
+            current_content = File.read(".makit.json")
+            pretty_content = project.to_json_pretty
+
+            # Only rewrite if the content is different (i.e., if it was compact or version changed)
+            if current_content.strip != pretty_content.strip
+              File.write(".makit.json", pretty_content)
+            end
+          rescue
+            raise "Error opening .makit.json"
+          end
+          project_type = project.project_type
+          case project_type
+          when "classlib"
+            Makit::Setup::ClassLib.run
+          when "gem"
+            Makit::Setup::Gem.run
+          else
+            Makit::Logging.default_logger.warn("Unsupported project type: #{project_type}")
+            #puts "Unsupported project type: #{project_type}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/makit/setup.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "setup/runner"
+require_relative "setup/classlib"
+require_relative "setup/gem"