makit 0.0.164 → 0.0.166

data/lib/makit/docs/files.rb

@@ -1,89 +1,89 @@
-# frozen_string_literal: true
-
-require "find"
-require "pathname"
-
-# 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"
-        FileUtils.mkdir_p("docs")
-        # overwrite the file if it exists
-        FileUtils.rm_f(filename)
-        File.open(filename, "w") do |file|
-          file.write("# Files\n\n")
-          file.write("A file summary for the project #{Makit::Git::Repository.get_remote_url}.\n\n")
-
-          #
-          # Tracked Files
-          #
-          # report on the file tracked by git.
-          tracked_file_infos = Makit::Git::Repository.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::Repository.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::Commands::Runner.default.execute("git count-objects -vH").to_markdown)
-          file.write("\n\n")
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "find"
+require "pathname"
+
+# 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"
+        FileUtils.mkdir_p("docs")
+        # overwrite the file if it exists
+        FileUtils.rm_f(filename)
+        File.open(filename, "w") do |file|
+          file.write("# Files\n\n")
+          file.write("A file summary for the project #{Makit::Git::Repository.get_remote_url}.\n\n")
+
+          #
+          # Tracked Files
+          #
+          # report on the file tracked by git.
+          tracked_file_infos = Makit::Git::Repository.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::Repository.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::Commands::Runner.default.execute("git count-objects -vH").to_markdown)
+          file.write("\n\n")
+        end
+      end
+    end
+  end
+end

data/lib/makit/docs/rake.rb

@@ -1,102 +1,102 @@
-# frozen_string_literal: true
-
-require "find"
-require "pathname"
-
-# 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
-        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" => 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::Repository.branch,
-          # add the current user name
-          "user" => ENV.fetch("USER", nil),
-          # add the current machine name
-          "machine" => ENV.fetch("COMPUTERNAME", nil),
-          # add the os name
-          "os" => ENV.fetch("OS", nil),
-          "duration" => Makit::Humanize.get_humanized_duration(duration),
-          "start_time" => Makit::Humanize.get_humanized_timestamp(start_time),
-          "source_file_count" => Makit::Git::Repository.get_file_infos.count,
-          "source_file_size" => Makit::Humanize.get_humanized_size(Makit::Git::Repository.get_file_infos.sum(&:size)),
-          "untracked_file_count" => Makit::Git::Repository.get_untracked_file_infos.count,
-          "untracked_file_size" => Makit::Humanize.get_humanized_size(Makit::Git::Repository.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::Repository.get_untracked_file_infos.sum(&:size) / Makit::Git::Repository.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 get_top_level_tasks.size != 1 || get_top_level_tasks.first != "default"
-          puts "  no top level tasks specified, skipping rake documentation generation".colorize(:yellow)
-          return
-        end
-
-        content = ""
-        # display: "Rake default completed in HUMANIZED_DURATION"
-        content += "# Rake default\n\n"
-
-        # display a table of the properties
-        content += "## Properties\n\n"
-        properties.each do |key, value|
-          content += "| #{key} | #{value} |\n"
-        end
-        content += "\n\n"
-
-        # display the completed tasks
-        content += "## Completed Tasks\n\n"
-        Makit::TaskInfo.completed_tasks.each do |task_name, task_info|
-          content += "| #{task_name} | #{Makit::Humanize.get_humanized_duration(task_info[:duration])} |\n"
-        end
-        content += "\n\n"
-
-        ## report on the available rake tasks
-        content += Makit::Commands::Runner.default.execute("rake -T").to_markdown
-        content += "\n\n"
-
-        filename = "docs/Rake.md"
-        FileUtils.mkdir_p("docs")
-        # overwrite the file if it exists
-        if File.exist?(filename)
-          existing_content = File.read(filename)
-          if existing_content != content
-            File.delete(filename)
-            File.write(filename, content)
-          end
-        else
-          File.write(filename, content)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "find"
+require "pathname"
+
+# 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
+        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" => 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::Repository.branch,
+          # add the current user name
+          "user" => ENV.fetch("USER", nil),
+          # add the current machine name
+          "machine" => ENV.fetch("COMPUTERNAME", nil),
+          # add the os name
+          "os" => ENV.fetch("OS", nil),
+          "duration" => Makit::Humanize.get_humanized_duration(duration),
+          "start_time" => Makit::Humanize.get_humanized_timestamp(start_time),
+          "source_file_count" => Makit::Git::Repository.get_file_infos.count,
+          "source_file_size" => Makit::Humanize.get_humanized_size(Makit::Git::Repository.get_file_infos.sum(&:size)),
+          "untracked_file_count" => Makit::Git::Repository.get_untracked_file_infos.count,
+          "untracked_file_size" => Makit::Humanize.get_humanized_size(Makit::Git::Repository.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::Repository.get_untracked_file_infos.sum(&:size) / Makit::Git::Repository.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 get_top_level_tasks.size != 1 || get_top_level_tasks.first != "default"
+          puts "  no top level tasks specified, skipping rake documentation generation".colorize(:yellow)
+          return
+        end
+
+        content = ""
+        # display: "Rake default completed in HUMANIZED_DURATION"
+        content += "# Rake default\n\n"
+
+        # display a table of the properties
+        content += "## Properties\n\n"
+        properties.each do |key, value|
+          content += "| #{key} | #{value} |\n"
+        end
+        content += "\n\n"
+
+        # display the completed tasks
+        content += "## Completed Tasks\n\n"
+        Makit::TaskInfo.completed_tasks.each do |task_name, task_info|
+          content += "| #{task_name} | #{Makit::Humanize.get_humanized_duration(task_info[:duration])} |\n"
+        end
+        content += "\n\n"
+
+        ## report on the available rake tasks
+        content += Makit::Commands::Runner.default.execute("rake -T").to_markdown
+        content += "\n\n"
+
+        filename = "docs/Rake.md"
+        FileUtils.mkdir_p("docs")
+        # overwrite the file if it exists
+        if File.exist?(filename)
+          existing_content = File.read(filename)
+          if existing_content != content
+            File.delete(filename)
+            File.write(filename, content)
+          end
+        else
+          File.write(filename, content)
+        end
+      end
+    end
+  end
+end