makit 0.0.68 → 0.0.70

data/lib/makit/directory.rb

@@ -1,264 +1,264 @@
-# frozen_string_literal: true
-
-require "find"
-require "pathname"
-#require "gitignore"
-
-# This module provides classes for the Makit gem.
-module Makit
-  # This class provide methods for working with Directories/
-  #
-  # Example:
-  #
-  #   Makit::Directory.find_directory_with_pattern("/home/user", "*.rb")
-  #
-  class Directory
-    def self.show_dir_size(dir)
-      total_bytes = Dir.glob(File.join(dir, "**", "*"))
-                       .select { |f| File.file?(f) }
-                       .sum { |f| File.size(f) }
-
-      human_size(total_bytes)
-      puts "  directory " + "#{dir}".colorize(:green) + " size is " + "#{human_size(total_bytes)}".colorize(:green)
-    end
-
-    def self.show_largest_files(dir, limit)
-      puts "  directory " + "#{dir}".colorize(:green) + " #{limit} largest files"
-      files = Dir.glob(File.join(dir, '**', '*'), File::FNM_DOTMATCH)
-                 .select { |f| File.file?(f) }
-    
-      sorted = files.map { |f| [f, File.size(f)] }
-                    .sort_by { |_, size| -size }
-                    .first(limit)
-    
-      sorted.each do |path, size|
-        # right justify human_size to be at least 10 characters wide
-        padded_size = human_size(size).rjust(10)
-        puts "  #{padded_size}" + " #{path}".colorize(:green)
-      end
-    end
-    
-    def human_size(bytes)
-      units = ['B', 'KB', 'MB', 'GB', 'TB']
-      return "0 B" if bytes == 0
-    
-      exp = (Math.log(bytes) / Math.log(1024)).to_i
-      exp = units.size - 1 if exp >= units.size
-    
-      "%.2f %s" % [bytes.to_f / 1024**exp, units[exp]]
-    end
-    
-
-    def self.human_size(bytes)
-      units = ["B", "KB", "MB", "GB", "TB"]
-      return "0 B" if bytes == 0
-
-      exp = (Math.log(bytes) / Math.log(1024)).to_i
-      exp = units.size - 1 if exp >= units.size
-
-      "%.2f %s" % [bytes.to_f / 1024 ** exp, units[exp]]
-    end
-    def self.get_line_count(file)
-      line_count = 0
-      File.foreach(file) { line_count += 1 }
-      line_count
-    end
-
-    def self.find_directory_with_patterns(starting_directory, patterns)
-      patterns.each do |pattern|
-        result = find_directory_with_pattern(starting_directory, pattern)
-        if (Dir.exist?(result))
-          return result
-        end
-      end
-
-      nil
-    end
-
-    def self.find_directory_with_pattern(starting_directory, pattern)
-      current_directory = File.expand_path(starting_directory)
-
-      loop do
-        return current_directory if contains_pattern?(current_directory, pattern)
-
-        parent_directory = File.dirname(current_directory)
-        break if parent_directory == current_directory # Reached the root directory
-
-        current_directory = parent_directory
-      end
-
-      nil
-    end
-
-    def self.contains_pattern?(directory, pattern)
-      Dir.foreach(directory) do |entry|
-        next if [".", ".."].include?(entry)
-        return true if File.fnmatch(pattern, entry)
-      end
-      false
-    end
-
-    def self.get_size(directory)
-      total_size = 0
-
-      Find.find(directory) do |file|
-        total_size += File.size(file) if File.file?(file)
-      end
-
-      total_size
-    end
-
-    def self.get_humanized_size(size_in_bytes, precision = 2)
-    end
-
-    def self.zip_source_files(directory_path, zip_file_name)
-      raise ArgumentError, "Directory path cannot be nil" if directory_path.nil?
-      raise ArgumentError, "Zip file name cannot be nil or empty" if zip_file_name.nil? || zip_file_name.strip.empty?
-
-      unless Dir.exist?(directory_path)
-        raise ArgumentError, "Directory '#{directory_path}' does not exist."
-      end
-
-      tracked_files = get_git_tracked_files(directory_path)
-
-      if tracked_files.empty?
-        raise "No tracked files found in the directory."
-      end
-
-      Zip::File.open(zip_file_name, Zip::File::CREATE) do |zipfile|
-        tracked_files.each do |file|
-          full_path = File.join(directory_path, file)
-          if File.exist?(full_path)
-            zipfile.add(file, full_path)
-          end
-        end
-      end
-    end
-
-    def self.get_git_tracked_files(directory_path)
-      #raise "do not use this method"
-      #output, status = Open3.capture2("git ls-files directory", chdir: directory_path)
-      #raise "Failed to list git-tracked files" unless status.success?
-      #command = "git ls-files #{directory_path}".run
-
-      #command.output.split("\n")
-      `git ls-files #{directory_path}`.split("\n")
-    end
-
-    def self.get_newest_git_file(directory_path)
-      get_git_tracked_files(directory_path).select { |f| File.file?(f) }.max_by { |f| File.mtime(f) }
-    end
-
-    def self.get_newest_git_file_timestamp(directory_path)
-      get_newest_git_file(directory_path).nil? ? Time.now : File.mtime(get_newest_git_file(directory_path))
-    end
-
-    def self.get_newest_file_timestamp(directory_path)
-      newest_file = get_git_tracked_files(directory_path).select { |f| File.file?(f) }.max_by { |f| File.mtime(f) }
-      newest_file.nil? ? Time.now : File.mtime(newest_file)
-    end
-
-    # Normalize the path by removing any leading or trailing slashes
-    # and replacing any backslashes with forward slashes
-    def self.normalize(path)
-      path = path.gsub("\\", "/")
-      #path = path[1..-1] if path.start_with?("/")
-      path = path[0..-2] if path.end_with?("/")
-      path
-    end
-
-    # for a given path, collect all the subdirectories that match a version pattern.
-    # for example 2.57.0, 2.62, or 2.65.0
-    def self.get_version_directories(path)
-      version_directories = []
-      Dir.foreach(path) do |entry|
-        next if [".", ".."].include?(entry)
-        version_directories << entry if entry.match?(/^\d+\.\d+\.\d+$/)
-      end
-      version_directories
-    end
-
-    def self.modified(path)
-      self.get_newest_file(path)
-    end
-    # for a given path, get the most recent file change date for any file in the directory
-    def self.get_latest_file_change_date(path)
-      # loop over all files in the directory
-      latest_date = nil
-      Find.find(path) do |file|
-        if File.file?(file)
-          date = File.mtime(file)
-          latest_date = date if latest_date.nil? || date > latest_date
-        end
-      end
-      latest_date
-    end
-
-    # for a given path, return the filename of the most recently modified file
-    def self.get_newest_file(path)
-      newest_file = nil
-      latest_date = nil
-      if (Dir.exist?(path))
-        Find.find(path) do |file|
-          if File.file?(file)
-            date = File.mtime(file)
-            latest_date = date if latest_date.nil? || date > latest_date
-            newest_file = file if date == latest_date
-          end
-        end
-      end
-      newest_file
-    end
-
-    def self.copy(src_dir, dst_dir, verbose = false)
-      FileUtils.cp_r(src_dir, dst_dir, verbose: verbose)
-    end
-
-    def self.generate_manifest(dir)
-      if File.exist?("#{dir}/manifest.txt")
-        File.delete("#{dir}/manifest.txt")
-      end
-      File.open("#{dir}/manifest.txt", "w") do |f|
-        Dir.glob("#{dir}/**/*").each do |file|
-          next if File.directory?(file)
-          f.puts file.sub("#{dir}/", "")
-        end
-      end
-    end
-
-    def self.remove_empty_directories(dir)
-      Find.find(dir) do |path|
-        if File.directory?(path) && Dir.empty?(path)
-          FileUtils.rm_rf(path)
-        end
-      end
-    end
-
-    def self.remove_empty_directories_recursively(dir)
-      Find.find(dir) do |path|
-        if File.directory?(path) && Dir.empty?(path)
-          FileUtils.rm_rf(path)
-        end
-      end
-    end
-
-    def self.deep_clean(dir)
-      git_dirs = []
-      #Dir.chdir(dir) do
-      # scan all subdirectories for git repositories
-      puts "  scanning #{dir} for git repositories".colorize(:green)
-      Find.find(dir) do |path|
-        if File.directory?(path) && File.exist?("#{path}/.git")
-          git_dirs << path
-        end
-      end
-      #end
-      git_dirs.each do |path|
-        puts "  cleaning #{path} of untracked files".colorize(:green)
-        Dir.chdir(path) do
-          puts `git clean -fdx`
-        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
+  # This class provide methods for working with Directories/
+  #
+  # Example:
+  #
+  #   Makit::Directory.find_directory_with_pattern("/home/user", "*.rb")
+  #
+  class Directory
+    def self.show_dir_size(dir)
+      total_bytes = Dir.glob(File.join(dir, "**", "*"))
+                       .select { |f| File.file?(f) }
+                       .sum { |f| File.size(f) }
+
+      human_size(total_bytes)
+      puts "  directory " + "#{dir}".colorize(:green) + " size is " + "#{human_size(total_bytes)}".colorize(:green)
+    end
+
+    def self.show_largest_files(dir, limit)
+      puts "  directory " + "#{dir}".colorize(:green) + " #{limit} largest files"
+      files = Dir.glob(File.join(dir, "**", "*"), File::FNM_DOTMATCH)
+                 .select { |f| File.file?(f) }
+
+      sorted = files.map { |f| [f, File.size(f)] }
+                    .sort_by { |_, size| -size }
+                    .first(limit)
+
+      sorted.each do |path, size|
+        # right justify human_size to be at least 10 characters wide
+        padded_size = human_size(size).rjust(10)
+        puts "  #{padded_size}" + " #{path}".colorize(:green)
+      end
+    end
+
+    def human_size(bytes)
+      units = ["B", "KB", "MB", "GB", "TB"]
+      return "0 B" if bytes == 0
+
+      exp = (Math.log(bytes) / Math.log(1024)).to_i
+      exp = units.size - 1 if exp >= units.size
+
+      "%.2f %s" % [bytes.to_f / 1024 ** exp, units[exp]]
+    end
+
+    def self.human_size(bytes)
+      units = ["B", "KB", "MB", "GB", "TB"]
+      return "0 B" if bytes == 0
+
+      exp = (Math.log(bytes) / Math.log(1024)).to_i
+      exp = units.size - 1 if exp >= units.size
+
+      "%.2f %s" % [bytes.to_f / 1024 ** exp, units[exp]]
+    end
+    def self.get_line_count(file)
+      line_count = 0
+      File.foreach(file) { line_count += 1 }
+      line_count
+    end
+
+    def self.find_directory_with_patterns(starting_directory, patterns)
+      patterns.each do |pattern|
+        result = find_directory_with_pattern(starting_directory, pattern)
+        if (Dir.exist?(result))
+          return result
+        end
+      end
+
+      nil
+    end
+
+    def self.find_directory_with_pattern(starting_directory, pattern)
+      current_directory = File.expand_path(starting_directory)
+
+      loop do
+        return current_directory if contains_pattern?(current_directory, pattern)
+
+        parent_directory = File.dirname(current_directory)
+        break if parent_directory == current_directory # Reached the root directory
+
+        current_directory = parent_directory
+      end
+
+      nil
+    end
+
+    def self.contains_pattern?(directory, pattern)
+      Dir.foreach(directory) do |entry|
+        next if [".", ".."].include?(entry)
+        return true if File.fnmatch(pattern, entry)
+      end
+      false
+    end
+
+    def self.get_size(directory)
+      total_size = 0
+
+      Find.find(directory) do |file|
+        total_size += File.size(file) if File.file?(file)
+      end
+
+      total_size
+    end
+
+    def self.get_humanized_size(size_in_bytes, precision = 2)
+    end
+
+    def self.zip_source_files(directory_path, zip_file_name)
+      raise ArgumentError, "Directory path cannot be nil" if directory_path.nil?
+      raise ArgumentError, "Zip file name cannot be nil or empty" if zip_file_name.nil? || zip_file_name.strip.empty?
+
+      unless Dir.exist?(directory_path)
+        raise ArgumentError, "Directory '#{directory_path}' does not exist."
+      end
+
+      tracked_files = get_git_tracked_files(directory_path)
+
+      if tracked_files.empty?
+        raise "No tracked files found in the directory."
+      end
+
+      Zip::File.open(zip_file_name, Zip::File::CREATE) do |zipfile|
+        tracked_files.each do |file|
+          full_path = File.join(directory_path, file)
+          if File.exist?(full_path)
+            zipfile.add(file, full_path)
+          end
+        end
+      end
+    end
+
+    def self.get_git_tracked_files(directory_path)
+      #raise "do not use this method"
+      #output, status = Open3.capture2("git ls-files directory", chdir: directory_path)
+      #raise "Failed to list git-tracked files" unless status.success?
+      #command = "git ls-files #{directory_path}".run
+
+      #command.output.split("\n")
+      `git ls-files #{directory_path}`.split("\n")
+    end
+
+    def self.get_newest_git_file(directory_path)
+      get_git_tracked_files(directory_path).select { |f| File.file?(f) }.max_by { |f| File.mtime(f) }
+    end
+
+    def self.get_newest_git_file_timestamp(directory_path)
+      get_newest_git_file(directory_path).nil? ? Time.now : File.mtime(get_newest_git_file(directory_path))
+    end
+
+    def self.get_newest_file_timestamp(directory_path)
+      newest_file = get_git_tracked_files(directory_path).select { |f| File.file?(f) }.max_by { |f| File.mtime(f) }
+      newest_file.nil? ? Time.now : File.mtime(newest_file)
+    end
+
+    # Normalize the path by removing any leading or trailing slashes
+    # and replacing any backslashes with forward slashes
+    def self.normalize(path)
+      path = path.gsub("\\", "/")
+      #path = path[1..-1] if path.start_with?("/")
+      path = path[0..-2] if path.end_with?("/")
+      path
+    end
+
+    # for a given path, collect all the subdirectories that match a version pattern.
+    # for example 2.57.0, 2.62, or 2.65.0
+    def self.get_version_directories(path)
+      version_directories = []
+      Dir.foreach(path) do |entry|
+        next if [".", ".."].include?(entry)
+        version_directories << entry if entry.match?(/^\d+\.\d+\.\d+$/)
+      end
+      version_directories
+    end
+
+    def self.modified(path)
+      self.get_newest_file(path)
+    end
+    # for a given path, get the most recent file change date for any file in the directory
+    def self.get_latest_file_change_date(path)
+      # loop over all files in the directory
+      latest_date = nil
+      Find.find(path) do |file|
+        if File.file?(file)
+          date = File.mtime(file)
+          latest_date = date if latest_date.nil? || date > latest_date
+        end
+      end
+      latest_date
+    end
+
+    # for a given path, return the filename of the most recently modified file
+    def self.get_newest_file(path)
+      newest_file = nil
+      latest_date = nil
+      if (Dir.exist?(path))
+        Find.find(path) do |file|
+          if File.file?(file)
+            date = File.mtime(file)
+            latest_date = date if latest_date.nil? || date > latest_date
+            newest_file = file if date == latest_date
+          end
+        end
+      end
+      newest_file
+    end
+
+    def self.copy(src_dir, dst_dir, verbose = false)
+      FileUtils.cp_r(src_dir, dst_dir, verbose: verbose)
+    end
+
+    def self.generate_manifest(dir)
+      if File.exist?("#{dir}/manifest.txt")
+        File.delete("#{dir}/manifest.txt")
+      end
+      File.open("#{dir}/manifest.txt", "w") do |f|
+        Dir.glob("#{dir}/**/*").each do |file|
+          next if File.directory?(file)
+          f.puts file.sub("#{dir}/", "")
+        end
+      end
+    end
+
+    def self.remove_empty_directories(dir)
+      Find.find(dir) do |path|
+        if File.directory?(path) && Dir.empty?(path)
+          FileUtils.rm_rf(path)
+        end
+      end
+    end
+
+    def self.remove_empty_directories_recursively(dir)
+      Find.find(dir) do |path|
+        if File.directory?(path) && Dir.empty?(path)
+          FileUtils.rm_rf(path)
+        end
+      end
+    end
+
+    # cleans all git repositories found in the given directory
+    def self.deep_clean(dir)
+      git_dirs = []
+      #Dir.chdir(dir) do
+      # scan all subdirectories for git repositories
+      puts "  scanning #{dir} for git repositories".colorize(:green)
+      Find.find(dir) do |path|
+        if File.directory?(path) && File.exist?("#{path}/.git")
+          git_dirs << path
+        end
+      end
+      #end
+      git_dirs.each do |path|
+        puts "  cleaning #{path} of untracked files".colorize(:green)
+        Dir.chdir(path) do
+          puts `git clean -fdx`
+        end
+      end
+    end
+  end
+end

data/lib/makit/docs/files.rb

@@ -0,0 +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
+    #
+    #
+    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