makit 0.0.69 → 0.0.71

data/lib/makit/docs/files.rb

@@ -1,83 +1,94 @@
-# frozen_string_literal: true
-
-require "find"
-require "pathname"
-#require "gitignore"
-
-# This module provides classes for the Makit gem.
-module Makit
-  module Docs
-    # This class provide methods for generating documentation
-    # about source files and artifacts.
-    #
-    # docs/Files.md
-    #
-    # Example:
-    #
-    #   Makit::Directory.find_directory_with_pattern("/home/user", "*.rb")
-    #
-    class Files
-      def self.generate
-        filename = "docs/Files.md"
-        if !Dir.exist?("docs")
-          Dir.mkdir("docs")
-        end
-        # overwrite the file if it exists   
-        if File.exist?(filename)
-          File.delete(filename)
-        end
-        File.open(filename, "w") do |file|
-          file.write("# Files\n\n")
-          file.write("A file summary for the project #{Makit::Git::get_remote_url}.\n\n")
-
-          #
-          # Tracked Files
-          #
-          # report on the file tracked by git.
-          tracked_file_infos = Makit::Git::get_file_infos
-          # first display the count and total size of the files tracked by git.
-          file.write("## Tracked Files\n\n")
-          file.write("#{tracked_file_infos.count} files with a total size of #{Makit::Humanize.get_humanized_size(tracked_file_infos.sum(&:size))}.\n\n")
-          # next display a table or the largest 10 files tracked by git.
-          # ordered by latest size first, display the size, name, and last modified date.
-          # leverage the humanize class to display the size in a human readable format.
-          # leverage the humanize class to display the last modified date in a human readable format.
-          file.write("The 10 largest files tracked by git are:\n\n")
-          file.write("| Size | Name | Last Modified Date |\n")
-          file.write("|------|------|------------------|\n")
-          tracked_file_infos.sort_by(&:size).reverse.first(10).each do |file_info|
-            file.write("| #{Makit::Humanize.get_humanized_size(file_info.size)} | #{file_info.name} | #{Makit::Humanize.get_humanized_timestamp(file_info.mtime)} |\n")
-          end
-          file.write("\n")
-
-          # 
-          # Untracked Files
-          #
-          # report on the files that are not tracked by git.
-          untracked_file_infos = Makit::Git::get_untracked_file_infos
-          # display the count and total size of the files that are not tracked by git.
-          file.write("## Untracked Files\n\n")
-          file.write("#{untracked_file_infos.count} files with a total size of #{Makit::Humanize.get_humanized_size(untracked_file_infos.sum(&:size))}.\n\n")
-          # next display a table or the largest 10 files not tracked by git.
-          # ordered by latest size first, display the size, name, and last modified date.
-          # leverage the humanize class to display the size in a human readable format.
-          # leverage the humanize class to display the last modified date in a human readable format.
-          file.write("The 10 largest files not tracked by git are:\n\n")
-          file.write("| Size | Name | Last Modified Date |\n")
-          file.write("|------|------|------------------|\n")
-          untracked_file_infos.sort_by(&:size).reverse.first(10).each do |file_info|
-            file.write("| #{Makit::Humanize.get_humanized_size(file_info.size)} | #{file_info.name} | #{Makit::Humanize.get_humanized_timestamp(file_info.mtime)} |\n")
-          end
-          file.write("\n")
-          
-          # 
-          # Git Repository Size
-          #
-          ## report on the git repository size
-          file.write(Makit::RUNNER.execute("git count-objects -vH").to_markdown)
-          file.write("\n\n")
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "find"
+require "pathname"
+#require "gitignore"
+
+# This module provides classes for the Makit gem.
+module Makit
+  module Docs
+    # This class provide methods for generating documentation
+    # about source files and artifacts.
+    #
+    # docs/Files.md
+    #
+    #
+    class Files
+      def self.generate
+        filename = "docs/Files.md"
+        if !Dir.exist?("docs")
+          Dir.mkdir("docs")
+        end
+        # overwrite the file if it exists
+        if File.exist?(filename)
+          File.delete(filename)
+        end
+        File.open(filename, "w") do |file|
+          file.write("# Files\n\n")
+          file.write("A file summary for the project #{Makit::Git::get_remote_url}.\n\n")
+
+          #
+          # Tracked Files
+          #
+          # report on the file tracked by git.
+          tracked_file_infos = Makit::Git::get_file_infos
+
+          # first display the count and total size of the files tracked by git.
+          file.write("## Tracked Files\n\n")
+          file.write("#{tracked_file_infos.count} files with a total size of #{Makit::Humanize.get_humanized_size(tracked_file_infos.sum(&:size))}.\n\n")
+
+          # next display a table of the 10 tracked files that have been modified recently.
+          # ordered by last modified date, display the size, name, and last modified date.
+          # leverage the humanize class to display the size in a human readable format.
+          # leverage the humanize class to display the last modified date in a human readable format.
+          file.write("The 10 files tracked by git that have been modified recently are:\n\n")
+          file.write("| Size | Name | Last Modified Date |\n")
+          file.write("|------|------|------------------|\n")
+          tracked_file_infos.sort_by(&:mtime).reverse.first(10).each do |file_info|
+            file.write("| #{Makit::Humanize.get_humanized_size(file_info.size)} | #{file_info.name} | #{Makit::Humanize.get_humanized_timestamp(file_info.mtime)} |\n")
+          end
+          file.write("\n")
+
+          # next display a table or the largest 10 files tracked by git.
+          # ordered by latest size first, display the size, name, and last modified date.
+          # leverage the humanize class to display the size in a human readable format.
+          # leverage the humanize class to display the last modified date in a human readable format.
+          file.write("The 10 largest files tracked by git are:\n\n")
+          file.write("| Size | Name | Last Modified Date |\n")
+          file.write("|------|------|------------------|\n")
+          tracked_file_infos.sort_by(&:size).reverse.first(10).each do |file_info|
+            file.write("| #{Makit::Humanize.get_humanized_size(file_info.size)} | #{file_info.name} | #{Makit::Humanize.get_humanized_timestamp(file_info.mtime)} |\n")
+          end
+          file.write("\n")
+
+          #
+          # Untracked Files
+          #
+          # report on the files that are not tracked by git.
+          untracked_file_infos = Makit::Git::get_untracked_file_infos
+          # display the count and total size of the files that are not tracked by git.
+          file.write("## Untracked Files\n\n")
+          file.write("#{untracked_file_infos.count} files with a total size of #{Makit::Humanize.get_humanized_size(untracked_file_infos.sum(&:size))}.\n\n")
+          # next display a table or the largest 10 files not tracked by git.
+          # ordered by latest size first, display the size, name, and last modified date.
+          # leverage the humanize class to display the size in a human readable format.
+          # leverage the humanize class to display the last modified date in a human readable format.
+          file.write("The 10 largest files not tracked by git are:\n\n")
+          file.write("| Size | Name | Last Modified Date |\n")
+          file.write("|------|------|------------------|\n")
+          untracked_file_infos.sort_by(&:size).reverse.first(10).each do |file_info|
+            file.write("| #{Makit::Humanize.get_humanized_size(file_info.size)} | #{file_info.name} | #{Makit::Humanize.get_humanized_timestamp(file_info.mtime)} |\n")
+          end
+          file.write("\n")
+
+          #
+          # Git Repository Size
+          #
+          ## report on the git repository size
+          file.write(Makit::RUNNER.execute("git count-objects -vH").to_markdown)
+          file.write("\n\n")
+        end
+      end
+    end
+  end
+end

data/lib/makit/docs/rake.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "find"
+require "pathname"
+#require "gitignore"
+
+# This module provides classes for the Makit gem.
+module Makit
+  module Docs
+    # This class provide methods for generating documentation
+    # about source files and artifacts.
+    #
+    # docs/Files.md
+    #
+    #
+    class Rake
+      def self.get_top_level_tasks
+        ::Rake.application.top_level_tasks
+      end
+
+      def self.get_top_task_name
+        self.get_top_level_tasks.first
+      end
+
+      def self.duration
+        Time.now - Makit::STARTTIME
+      end
+
+      def self.start_time
+        Makit::STARTTIME
+      end
+
+      # return a hash of name => value for properties of the rake execution
+      def self.properties
+        {
+          "top_level_tasks" => self.get_top_level_tasks,
+          # If global VERSION is defined, then add it to the properties (this is NOT the Makit::VERSION)
+          "version" => (defined?(VERSION) ? VERSION : ""),
+          "branch" => Makit::Git.branch,
+          # add the current user name
+          "user" => ENV["USER"],
+          # add the current machine name
+          "machine" => ENV["COMPUTERNAME"],
+          # add the os name
+          "os" => ENV["OS"],
+          "duration" => Makit::Humanize.get_humanized_duration(self.duration),
+          "start_time" => Makit::Humanize.get_humanized_timestamp(self.start_time),
+          "source_file_count" => Makit::Git.get_file_infos.count,
+          "source_file_size" => Makit::Humanize.get_humanized_size(Makit::Git.get_file_infos.sum(&:size)),
+          "untracked_file_count" => Makit::Git.get_untracked_file_infos.count,
+          "untracked_file_size" => Makit::Humanize.get_humanized_size(Makit::Git.get_untracked_file_infos.sum(&:size)),
+          # express the ratio of untracked file size to tracked file size as a percentage
+          "ratio_untracked_size_to_tracked_size" => ((Makit::Git.get_untracked_file_infos.sum(&:size) / Makit::Git.get_file_infos.sum(&:size)) * 100).to_i,
+        }
+      end
+
+      def self.generate
+
+        # if the top level tasks are of size 1, with the name "default",
+        # then we will continue to generate the documentation.
+        # otherwise, we will display a message and exit.
+        if self.get_top_level_tasks.size != 1 || self.get_top_level_tasks.first != "default"
+          puts "  no top level tasks specified, skipping rake documentation generation".colorize(:yellow)
+          return
+        end
+
+        filename = "docs/Rake.md"
+        if !Dir.exist?("docs")
+          Dir.mkdir("docs")
+        end
+        # overwrite the file if it exists
+        if File.exist?(filename)
+          File.delete(filename)
+        end
+        File.open(filename, "w") do |file|
+
+          # display: "Rake default completed in HUMANIZED_DURATION"
+          file.write("# Rake default\n\n")
+
+          # display a table of the properties
+          file.write("## Properties\n\n")
+          self.properties.each do |key, value|
+            file.write("| #{key} | #{value} |\n")
+          end
+          file.write("\n\n")
+
+          # display the completed tasks
+          file.write("## Completed Tasks\n\n")
+          Makit::TaskInfo.completed_tasks.each do |task_name, task_info|
+            file.write("| #{task_name} | #{Makit::Humanize.get_humanized_duration(task_info[:duration])} |\n")
+          end
+          file.write("\n\n")
+
+          ## report on the available rake tasks
+          file.write(Makit::RUNNER.execute("rake -T").to_markdown)
+          file.write("\n\n")
+        end
+      end
+    end
+  end
+end

data/lib/makit/dotnet.rb

@@ -1,182 +1,182 @@
-module Makit
-  class DotNet
-    def self.is_installed?
-      File.exist?(Makit::Environment.which("dotnet"))
-    end
-
-    def self.version
-      `dotnet --version`
-    end
-
-    def self.project_short_name(project_path)
-      project_name = File.basename(project_path, ".csproj")
-      project_name
-    end
-
-    def self.new_project(template, name, output, args = "")
-      if Dir.exist? output
-        puts "  .csproj ".colorize(:grey) + "#{name}".colorize(:green)
-      else
-        "dotnet new #{template} --name #{name} --output #{output} #{args}".run
-      end
-    end
-
-    def self.set_project_target_framework(project_hint, target_framework)
-      project_path = find_project(project_hint)
-      project_content = File.read(project_path)
-      project_content.gsub!(/<TargetFramework>.*<\/TargetFramework>/, "<TargetFramework>#{target_framework}</TargetFramework>")
-      File.write(project_path, project_content)
-    end
-
-    def self.find_project(project_hint)
-      matches = []
-      Dir.glob("**/*.csproj").each do |project_path|
-        #project_name = File.basename(project_path, ".csproj")
-        if project_path.include?(project_hint)
-          matches << project_path
-        end
-      end
-      if matches.length == 1
-        return matches.first
-      elsif matches.length > 1
-        raise "Multiple projects found matching #{project_hint}".colorize(:red)
-      end
-      raise "No project found matching #{project_hint}".colorize(:red)
-    end
-
-    def self.add_package(project_path, package_name)
-      if (!File.exist?(project_path))
-        actual_project_path = Makit::DotNet::find_project(project_path)
-        if (!File.exist?(actual_project_path))
-          raise "Project #{project_path} does not exist".colorize(:red)
-        else
-          project_path = actual_project_path
-        end
-      end
-      project_content = File.read(project_path)
-      if (!project_content.include?("\"#{package_name}\""))
-        "dotnet add #{project_path} package #{package_name}".run
-      else
-        puts "  package ".colorize(:grey) + "#{package_name}".colorize(:green)
-        #puts "  #{project_short_name(project_path)} has package #{package_name}".colorize(:grey)
-      end
-    end
-
-    def self.add_packages(project_path, packages)
-      packages.each do |package|
-        add_package(project_path, package)
-      end
-    end
-
-    def self.add_reference(project_path, reference_path)
-      if (!File.exist?(project_path))
-        actual_project_path = Makit::DotNet::find_project(project_path)
-        if (!File.exist?(actual_project_path))
-          raise "Project #{project_path} does not exist".colorize(:red)
-        else
-          project_path = actual_project_path
-        end
-      end
-      if (!File.exist?(reference_path))
-        actual_reference_path = Makit::DotNet::find_project(reference_path)
-        if (!File.exist?(actual_reference_path))
-          raise "Project #{reference_path} does not exist".colorize(:red)
-        else
-          reference_path = actual_reference_path
-        end
-      end
-      project_content = File.read(project_path)
-      if (project_content.include?(File.basename(reference_path)))
-        puts "  reference ".colorize(:grey) + "#{reference_path}".colorize(:green)
-        #puts "  #{project_short_name(project_path)} references #{project_short_name(reference_path)}".colorize(:grey)
-        #puts "  reference ".colorize(:grey) + "#{reference_path}".colorize(:yellow) + " is in ".colorize(:grey) + "#{project_path}".colorize(:yellow)
-      else
-        "dotnet add #{project_path} reference #{reference_path}".run
-      end
-    end
-
-    def self.add_references(project_path, references)
-      references.each do |reference|
-        add_reference(project_path, reference)
-      end
-    end
-
-    def self.new_solution(name)
-      if File.exist? "#{name}.sln"
-        #puts "Solution #{name}.sln already exists".colorize(:yellow)
-        #puts "  #{name}.sln".colorize(:green) + " exists".colorize(:grey)
-      else
-        "dotnet new sln --name #{name}".run
-      end
-    end
-
-    def self.build(project_path, configuration = "Release", output = "artifacts")
-      project_dir = File.dirname(project_path)
-      newest_file = Makit::Directory::get_newest_file(project_dir)
-      command_request = Makit::RUNNER::parse_command_request("dotnet build #{project_path} --configuration #{configuration} --output #{output}")
-      if newest_file.nil?
-        newest_file_date = Time.now
-        RUNNER.cache_run(command_request, newest_file_date)
-      else
-        newest_file_date = File.mtime(newest_file)
-        RUNNER.cache_run(command_request, newest_file_date)
-      end
-    end
-
-    def self.publish(project_path, configuration = "Release", output = "artifacts")
-      project_dir = File.dirname(project_path)
-      newest_file = Makit::Directory::get_newest_file(project_dir)
-      command_request = Makit::RUNNER::parse_command_request("dotnet publish #{project_path} --configuration #{configuration} --output #{output}")
-      if newest_file.nil?
-        newest_file_date = Time.now
-        RUNNER.cache_run(command_request, newest_file_date)
-      else
-        newest_file_date = File.mtime(newest_file)
-        RUNNER.cache_run(command_request, newest_file_date)
-      end
-    end
-
-    def self.test(project_path, configuration = "Release", output = "artifacts")
-      project_dir = File.dirname(project_path)
-      newest_file = Makit::Directory::get_newest_file(project_dir)
-      command_request = Makit::RUNNER::parse_command_request("dotnet test #{project_path} --configuration #{configuration} --output #{output}")
-      if newest_file.nil?
-        newest_file_date = Time.now
-        RUNNER.cache_run(command_request, newest_file_date)
-      else
-        newest_file_date = File.mtime(newest_file)
-        RUNNER.cache_run(command_request, newest_file_date)
-      end
-    end
-
-    def self.sln_add_projects(sln_name)
-      if !File.exist? "#{sln_name}.sln"
-        raise "Solution #{sln_name}.sln does not exist"
-      else
-        sln_path = "#{sln_name}.sln"
-        sln_content = File.read(sln_path)
-        Dir.glob("**/*.csproj").each do |project_path|
-          project_name = File.basename(project_path, ".csproj")
-          if (sln_content.include?("\"#{project_name}\""))
-            #puts "  #{project_name}".colorize(:green) + " is in ".colorize(:grey) + "#{sln_path}".colorize(:green)
-            #puts "Project #{project_name} already exists in #{sln_path}".colorize(:yellow)
-          else
-            "dotnet sln #{sln_path} add #{project_path}".run
-          end
-        end
-      end
-    end
-
-    def self.format_project(project_path)
-      project_name = File.basename(project_path, ".csproj")
-      "dotnet tool update --global dotnet-format".run
-      "dotnet format #{project_path}".run
-    end
-
-    def self.upgrade_project(project_path)
-      project_name = File.basename(project_path, ".csproj")
-      "dotnet tool install --global dotnet-outdated-tool".run
-      "dotnet outdated #{project_path} --upgrade:Auto".run
-    end
-  end # class DotNet
-end # module Makit
+module Makit
+  class DotNet
+    def self.is_installed?
+      File.exist?(Makit::Environment.which("dotnet"))
+    end
+
+    def self.version
+      `dotnet --version`
+    end
+
+    def self.project_short_name(project_path)
+      project_name = File.basename(project_path, ".csproj")
+      project_name
+    end
+
+    def self.new_project(template, name, output, args = "")
+      if Dir.exist? output
+        puts "  .csproj ".colorize(:grey) + "#{name}".colorize(:green)
+      else
+        "dotnet new #{template} --name #{name} --output #{output} #{args}".run
+      end
+    end
+
+    def self.set_project_target_framework(project_hint, target_framework)
+      project_path = find_project(project_hint)
+      project_content = File.read(project_path)
+      project_content.gsub!(/<TargetFramework>.*<\/TargetFramework>/, "<TargetFramework>#{target_framework}</TargetFramework>")
+      File.write(project_path, project_content)
+    end
+
+    def self.find_project(project_hint)
+      matches = []
+      Dir.glob("**/*.csproj").each do |project_path|
+        #project_name = File.basename(project_path, ".csproj")
+        if project_path.include?(project_hint)
+          matches << project_path
+        end
+      end
+      if matches.length == 1
+        return matches.first
+      elsif matches.length > 1
+        raise "Multiple projects found matching #{project_hint}".colorize(:red)
+      end
+      raise "No project found matching #{project_hint}".colorize(:red)
+    end
+
+    def self.add_package(project_path, package_name)
+      if (!File.exist?(project_path))
+        actual_project_path = Makit::DotNet::find_project(project_path)
+        if (!File.exist?(actual_project_path))
+          raise "Project #{project_path} does not exist".colorize(:red)
+        else
+          project_path = actual_project_path
+        end
+      end
+      project_content = File.read(project_path)
+      if (!project_content.include?("\"#{package_name}\""))
+        "dotnet add #{project_path} package #{package_name}".run
+      else
+        puts "  package ".colorize(:grey) + "#{package_name}".colorize(:green)
+        #puts "  #{project_short_name(project_path)} has package #{package_name}".colorize(:grey)
+      end
+    end
+
+    def self.add_packages(project_path, packages)
+      packages.each do |package|
+        add_package(project_path, package)
+      end
+    end
+
+    def self.add_reference(project_path, reference_path)
+      if (!File.exist?(project_path))
+        actual_project_path = Makit::DotNet::find_project(project_path)
+        if (!File.exist?(actual_project_path))
+          raise "Project #{project_path} does not exist".colorize(:red)
+        else
+          project_path = actual_project_path
+        end
+      end
+      if (!File.exist?(reference_path))
+        actual_reference_path = Makit::DotNet::find_project(reference_path)
+        if (!File.exist?(actual_reference_path))
+          raise "Project #{reference_path} does not exist".colorize(:red)
+        else
+          reference_path = actual_reference_path
+        end
+      end
+      project_content = File.read(project_path)
+      if (project_content.include?(File.basename(reference_path)))
+        puts "  reference ".colorize(:grey) + "#{reference_path}".colorize(:green)
+        #puts "  #{project_short_name(project_path)} references #{project_short_name(reference_path)}".colorize(:grey)
+        #puts "  reference ".colorize(:grey) + "#{reference_path}".colorize(:yellow) + " is in ".colorize(:grey) + "#{project_path}".colorize(:yellow)
+      else
+        "dotnet add #{project_path} reference #{reference_path}".run
+      end
+    end
+
+    def self.add_references(project_path, references)
+      references.each do |reference|
+        add_reference(project_path, reference)
+      end
+    end
+
+    def self.new_solution(name)
+      if File.exist? "#{name}.sln"
+        #puts "Solution #{name}.sln already exists".colorize(:yellow)
+        #puts "  #{name}.sln".colorize(:green) + " exists".colorize(:grey)
+      else
+        "dotnet new sln --name #{name}".run
+      end
+    end
+
+    def self.build(project_path, configuration = "Release", output = "artifacts")
+      project_dir = File.dirname(project_path)
+      newest_file = Makit::Directory::get_newest_file(project_dir)
+      command_request = Makit::RUNNER::parse_command_request("dotnet build #{project_path} --configuration #{configuration} --output #{output}")
+      if newest_file.nil?
+        newest_file_date = Time.now
+        RUNNER.cache_run(command_request, newest_file_date)
+      else
+        newest_file_date = File.mtime(newest_file)
+        RUNNER.cache_run(command_request, newest_file_date)
+      end
+    end
+
+    def self.publish(project_path, configuration = "Release", output = "artifacts")
+      project_dir = File.dirname(project_path)
+      newest_file = Makit::Directory::get_newest_file(project_dir)
+      command_request = Makit::RUNNER::parse_command_request("dotnet publish #{project_path} --configuration #{configuration} --output #{output}")
+      if newest_file.nil?
+        newest_file_date = Time.now
+        RUNNER.cache_run(command_request, newest_file_date)
+      else
+        newest_file_date = File.mtime(newest_file)
+        RUNNER.cache_run(command_request, newest_file_date)
+      end
+    end
+
+    def self.test(project_path, configuration = "Release", output = "artifacts")
+      project_dir = File.dirname(project_path)
+      newest_file = Makit::Directory::get_newest_file(project_dir)
+      command_request = Makit::RUNNER::parse_command_request("dotnet test #{project_path} --configuration #{configuration} --output #{output}")
+      if newest_file.nil?
+        newest_file_date = Time.now
+        RUNNER.cache_run(command_request, newest_file_date)
+      else
+        newest_file_date = File.mtime(newest_file)
+        RUNNER.cache_run(command_request, newest_file_date)
+      end
+    end
+
+    def self.sln_add_projects(sln_name)
+      if !File.exist? "#{sln_name}.sln"
+        raise "Solution #{sln_name}.sln does not exist"
+      else
+        sln_path = "#{sln_name}.sln"
+        sln_content = File.read(sln_path)
+        Dir.glob("**/*.csproj").each do |project_path|
+          project_name = File.basename(project_path, ".csproj")
+          if (sln_content.include?("\"#{project_name}\""))
+            #puts "  #{project_name}".colorize(:green) + " is in ".colorize(:grey) + "#{sln_path}".colorize(:green)
+            #puts "Project #{project_name} already exists in #{sln_path}".colorize(:yellow)
+          else
+            "dotnet sln #{sln_path} add #{project_path}".run
+          end
+        end
+      end
+    end
+
+    def self.format_project(project_path)
+      project_name = File.basename(project_path, ".csproj")
+      "dotnet tool update --global dotnet-format".run
+      "dotnet format #{project_path}".run
+    end
+
+    def self.upgrade_project(project_path)
+      project_name = File.basename(project_path, ".csproj")
+      "dotnet tool install --global dotnet-outdated-tool".run
+      "dotnet outdated #{project_path} --upgrade:Auto".run
+    end
+  end # class DotNet
+end # module Makit