directory_paradise 1.4.4

data/lib/directory_paradise/report/report.rb

@@ -0,0 +1,527 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === DirectoryParadise::Report
+#
+# The purpose of this class is to show the content of a directory, either
+# in a plain variant without any colours, or in a fancified variant, with
+# colours.
+#
+# The initial reason for creating this class was that I needed a general
+# adaptor for when I would be using ruby on windows, or on another
+# operating system, whenever I would try to use larger projects such
+# as the Roebe::Shell component, which is part of the gem called
+# "roebe".
+#
+# In the past, this was the sole use case that class ShowDirectoryContent
+# had to fulfil, but lateron I thought that I could factor this code out
+# into a standalone class, and make it available for other projects as
+# well - as true standalone project. Thus, the directory_content gem
+# was born. \o/
+#
+# This class here has, at least, the following main features that it
+# has to support:
+#
+#    - The ability to show the modification time.
+#    - The ability to truncate long file names.
+#    - The ability to list hidden files.
+#    - The ability to sort by size, by passing the argument "size" to it.
+#    - The ability to set and define your own colours.
+#    - The ability to show a simplified, shorter result.
+#    - The ability to make the colour output optional.
+#    - The ability to filter on the content, e. g. via '*'.
+#
+# A good general overview for available options for the GNU "ls" command
+# can be found here:
+#
+#   https://ss64.com/bash/ls.html
+#
+# =========================================================================== #
+# require 'directory_paradise/report/report.rb'
+# DirectoryParadise::Report.new(ARGV)
+# =========================================================================== #
+require 'directory_paradise/base/base.rb'
+
+module DirectoryParadise
+
+class Report < Base # === DirectoryParadise::Report
+
+  require 'colours'
+  require 'directory_paradise/project/project.rb'
+  require 'directory_paradise/content/content.rb'
+  require 'directory_paradise/report/constants.rb'
+  require 'directory_paradise/report/initialize.rb'
+  require 'directory_paradise/report/menu.rb'
+  require 'directory_paradise/report/misc.rb'
+  require 'directory_paradise/report/obtain.rb'
+  require 'directory_paradise/report/reset.rb'
+
+  # ========================================================================= #
+  # === HASH_COLOURS_FOR_BYTES_VALUE
+  # ========================================================================= #
+  if File.exist? FILE_COLOURS_FOR_BYTES_VALUES
+    HASH_COLOURS_FOR_BYTES_VALUE = 
+      YAML.load_file(
+        FILE_COLOURS_FOR_BYTES_VALUES
+      )
+  end
+
+  # ========================================================================= #
+  # === try_to_report_the_total_filesize
+  #
+  # Use this method to report the total filesize from a given directory.
+  # ========================================================================= #
+  def try_to_report_the_total_filesize
+    total_file_size = total_file_size?
+    if total_file_size > 0
+      ee "\nTotal file size in directory "
+      if use_colours?
+        e colourize_directory(which_dir?)
+      else
+        e which_dir?
+      end
+      n_KB = (total_file_size / 1024.0)
+      n_MB = (n_KB / 1024.0)
+      e steelblue(
+          "  #{total_file_size} bytes (#{n_KB.round(2)} KB) (#{n_MB.round(2)} MB)"
+        )
+    end
+  end
+
+  # ========================================================================= #
+  # === return_file_permission_of
+  # ========================================================================= #
+  def return_file_permission_of(i)
+    if condensed? and i.size == 10 # Then we assume we have the long format.
+      Roebe::PermissionAsciiFormat[i, :convert_into_decimal_format]
+    else # else we must convert it back.
+      i # Simply return as-is here.
+    end
+  end
+
+  # ========================================================================= #
+  # === set_sort_by
+  # ========================================================================= #
+  def set_sort_by(i)
+    @internal_hash[:sort_by] = i
+  end; alias sort_by= set_sort_by # === sort_by=
+       alias sort_by  set_sort_by # === sort_by
+
+  # ========================================================================= #
+  # === sort_how                                     (sort tag, sort how tag)
+  #
+  # Here we determine how to sort.
+  #
+  # The sort possibilities are:
+  #
+  #   - by datesort_how
+  #   - by size
+  #   - in a reversed manner
+  #
+  # ========================================================================= #
+  def sort_how(
+      how = :size
+    )
+    how = how.to_s.downcase.to_sym # We want a downcased Symbol here.
+    case how # case tag
+    # ======================================================================= #
+    # === :reversed
+    # ======================================================================= #
+    when :reversed,
+         :reverse,
+         :by_reverse,
+         :by_reversed
+      set_sort_by(:reversed)
+    # ======================================================================= #
+    # === :date
+    # ======================================================================= #
+    when :date,
+         :by_date
+      set_sort_by(:date)
+    # ======================================================================= #
+    # === :size
+    # ======================================================================= #
+    when :size,
+         :sized,
+         :by_size # Sort by size.
+      set_sort_by(:size)
+    # ======================================================================= #
+    # === :modification_time
+    # ======================================================================= #
+    when :modification_time,
+         :by_modification_time
+      set_sort_by(:modification_time)
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help_options                                          (help tag)
+  #
+  # To invoke this method, try:
+  #
+  #   sdc --help
+  #
+  # ========================================================================= #
+  def show_help_options # Help tag.
+    e "#{rev}The currently available help options for "\
+      "#{simp('DirectoryContent::Report')} are:"
+    e
+    show_this_help_line :collapse, :short
+    show_this_help_line :toggle
+    show_this_help_line :nocolours
+    show_this_help_line :only_dirs
+    show_this_help_line :show_hidden_files
+    show_this_help_line :sized
+    show_this_help_line :date
+    show_this_help_line :lead
+    show_this_help_line :disable_show_modification_time
+    show_this_help_line :condensed
+    e
+    e 'Additionally, the following options are a bit more '\
+      'extensively documented here:'
+    e
+    Colours.eparse '  --show-only-symlinks # '\
+                   'This will show only symlinks in the target directory'
+    e
+    exit
+  end
+
+  # ========================================================================= #
+  # === do_sort_by_size
+  # ========================================================================= #
+  def do_sort_by_size
+    sort_how :by_size
+  end
+
+  # ========================================================================= #
+  # === consider_sorting
+  # ========================================================================= #
+  def consider_sorting
+    if sort_by?
+       @internal_hash[:directory_content].do_sort(sort_by?)
+    end
+  end
+
+  # ========================================================================= #
+  # === show_content_for
+  # ========================================================================= #
+  def show_content_for(
+      this_path = '/'
+    )
+    @directory_content.obtain_entries(this_path)
+    report
+  end
+
+  # ========================================================================= #
+  # === report                               (report tag, display tag, d tag)
+  # 
+  # This method will always report the main dataset, as determined by
+  # class DirectoryParadise::Content.
+  # ========================================================================= #
+  def report(
+      _ = return_directory_content # This will return a Hash.
+    )
+    @internal_hash[:total_filesize] = 0 # Reset it always here.
+    show_condensed_permissions = show_condensed_permissions?
+    show_the_index             = show_index?
+    show_hidden_files          = show_hidden_files?
+    show_permission_bits       = show_permission_bits?
+    colourize_path             = colourize_path?
+    display_only_directories   = display_only_directories?
+    show_only_symlinks         = show_only_symlinks?
+    show_modification_time     = show_modification_time?
+    if display_only_directories
+      _.select! {|path, inner_hash| inner_hash[:type] == 'directory' }
+    end
+    if show_only_symlinks
+      _.select! {|path, inner_hash| inner_hash[:type] == 'link' }
+    end
+    # ======================================================================= #
+    # === Build up the header                                    (header tag)
+    #
+    # Build up the header first, then display it, but only if the user
+    # allows this to happen:
+    # ======================================================================= #
+    if show_header?
+      if show_statistics?
+        n_files       = n_files?
+        n_directories = n_directories?
+        n_symlinks    = n_symlinks?
+        file_string = ''
+        file_string = 's' if (n_files >= 0) # plural or not.
+        # =================================================================== #
+        # Pluralize the directory-string.
+        # =================================================================== #
+        directory_string = 'y'
+        symlink_string = 's'
+        symlink_string = '' if n_symlinks == 1
+        # =================================================================== #
+        # Last but not least notify the user of the findings.
+        # =================================================================== #
+        e rev+'The directory '+
+          sdir(work_on_which_directory?)+
+          ' contains '+
+          sfile(
+            n_files.to_s+' file'+file_string
+          )+', '+
+          sdir(
+            n_directories.to_s+' director'+directory_string
+          )+' and '+
+          ssymlink(
+            n_symlinks.to_s+' symlink'+symlink_string
+          )+'.'
+      end
+      header = ''.dup
+      header << "#{rev}" if use_colours?
+      # ===================================================================== #
+      # Add the index next onto the header.
+      # ===================================================================== #
+      if show_the_index
+        header << sfancy('Index'.ljust(6))
+      end
+      # ===================================================================== #
+      # Show permission bits
+      # ===================================================================== #
+      if show_permission_bits
+        header << springgreen('Permissions'.ljust(16))
+      end
+      # ===================================================================== #
+      # Next, determine whether we will display the modification-time
+      # or whether we will not:
+      # ===================================================================== #
+      if show_modification_time
+        header << 'ModTime'.ljust(8)
+      end
+      header << 'FileSize'.ljust(9)
+      header << 'Name'.ljust(5)
+      eliner
+      e header
+    end
+    # ======================================================================= #
+    # This may look like so:
+    #
+    #   "/Depot/j/yodel.rb"=>
+    #     {:size=>129,ei leader is lined up against a w
+    #      :type=>"file",
+    #      :is_executable=>false,
+    #      :path=>"/Depot/j/yodel.rb",
+    #      :ascii_representation=>"",
+    #      :last_modified=>2021-05-31 20:55:53.826658499 +0000,
+    #      :gid=>0,
+    #      :inode_number=>93858692,
+    #      :uid=>0,
+    #      :access_mode=>"644"}}}>
+    #
+    # ======================================================================= #
+    index = 0
+    _.each_pair {|path, inner_hash| # each tag
+      if path.end_with?('.') and !show_dots_only_entries? and
+         ( (path.end_with? '.') or (path.end_with? '..') )
+        next
+      end
+      if File.basename(path).start_with?('.') and !show_hidden_files
+        # =================================================================== #
+        # Ignore hidden files if the user specified so.
+        # =================================================================== #
+        next
+      end
+      index += 1
+      # ===================================================================== #
+      # Obtain the file size next, then add it onto the :total_filesize
+      # entry in the Hash.
+      # ===================================================================== #
+      file_size = inner_hash[:size]
+      name_of_owner = inner_hash[:name_of_owner]
+      name_of_owner = '%-10s' % owner?(name_of_owner) # Beautify this.
+      name_of_owner.strip!
+      @internal_hash[:total_filesize] += file_size.to_i # .to_i to avoid pesky nil values.
+      # ===================================================================== #
+      # Make the filesize human readable.
+      # ===================================================================== #
+      file_size = to_human_readable(file_size)
+      last_modified = inner_hash[:last_modified] # Example: 2021-01-11 05:53:35.844402868 +0000,
+      # ===================================================================== #
+      # All the output will be stored onto the variable called "line".
+      # ===================================================================== #
+      line = ''.dup
+      # ===================================================================== #
+      # === Index                                                 (index tag)
+      #
+      # Show the index next, if the user has enabled this.
+      # ===================================================================== #
+      if show_the_index
+        use_this_value_for_ljusting = 6
+        if _.size.to_s.size > 3
+          use_this_value_for_ljusting += (_.size.to_s.size - 3)
+        end
+        index_to_display = ("(#{index})") # Add () here as well.
+        index_to_display = index_to_display.ljust(use_this_value_for_ljusting)
+        if use_colours?
+          index_to_display.gsub!(/\((.+)\)/, '('+sfancy("\\1")+')')
+        end
+        line << index_to_display
+      end
+      # ===================================================================== #
+      # Add the permissions next - either in good old classical number
+      # format, such as 755, or as its ascii_representation.
+      # ===================================================================== #
+      if show_permission_bits
+        # =================================================================== #
+        # We update the inode-entry next to the hash.
+        # =================================================================== #
+        if show_inode?
+          inode = ' Inode: '
+          inode = simp(inode) if use_colours?
+          line << inode+File.stat(path).ino.to_s # Add the Inode here.
+        end
+        # =================================================================== #
+        # Next show the permission bits, if requested to do so.
+        # =================================================================== #
+        line << springgreen("#{return_chmod_value_of_this_file(path).ljust(5)}")
+        unless show_condensed_permissions
+          line << return_file_permission_of(
+            inner_hash[:ascii_representation]
+          ).ljust(11)
+        end
+      end
+      # ===================================================================== #
+      # === Show the modification time
+      #
+      # Add the last-modified part next.
+      #
+      # This could be last_modified.strftime(' %d.%m.%Y %H:%M') instead.
+      # ===================================================================== #
+      if show_modification_time?
+        line << "#{return_assumed_modification_time(last_modified)} "
+      end
+      file_size = file_size.rjust(8)
+      # ===================================================================== #
+      # Insert proper units next.
+      # ===================================================================== #
+      if colourize_kb_and_mb? && use_colours? # use .gsub directly
+        hash = hash_colours_for_bytes_value?
+        if file_size.include?    ' KB'
+          file_size.sub!(/KB/, send(hash['KB'].to_sym, 'KB'))
+        elsif file_size.include? ' MB'
+          file_size.sub!(/MB/, send(hash['MB'].to_sym, 'MB'))
+        elsif file_size.include? 'GB'
+          file_size.sub!(/GB/, send(hash['GB'].to_sym, 'GB'))
+        elsif file_size.include? ' B'
+          file_size.sub!(/ B/, send(hash['B'].to_sym, ' B'))
+        end
+      end
+      # ===================================================================== #
+      # === Show the Owner
+      #
+      # Add the owner. Must be padded, like the group name, in order to
+      # prevent mis-alignments.
+      # ===================================================================== #
+      unless show_simplified?
+        line << " #{name_of_owner.ljust(6)}"
+      end
+      # ===================================================================== #
+      # === Show the Group Information
+      #
+      # Add the group, if we allow that.
+      # ===================================================================== #
+      if show_group_information?
+        if inner_hash and inner_hash[:name_of_group]
+          line << " #{inner_hash[:name_of_group].ljust(7)}"
+        end
+      end
+      # ===================================================================== #
+      # Add the file size next:
+      # ===================================================================== #
+      line << " #{file_size}"
+      # ===================================================================== #
+      # === Truncate long file names
+      #
+      # We have to check whether the filename is too long. If it is then
+      # we will modify a call to .shorten_file_elegantly() but only if
+      # the user has requested this option.
+      #
+      # Directories will be handled in a special manner.
+      # ===================================================================== #
+      if (path.size > FILE_SIZE_THRESHOLD) and truncate_long_file_names?
+        # dirname = File.dirname(path)
+        # basename = File.basename(path)[0 .. FILE_SIZE_THRESHOLD]
+        # path = dirname+'/'+basename
+        path = shorten_file_elegantly(path)
+      end
+      unless show_full_path?
+        path = File.basename(path)
+      end
+      if File.directory?(path) and !path.end_with?('/')
+        path << '/'
+      end
+      line << " #{steelblue(path)}"
+      if colourize_path and path.include?('/')
+        splitted = path.split('/')
+        # =================================================================== #
+        # The last part can be a directory, symlink or file, typically.
+        # =================================================================== #
+        last = splitted.last
+        if File.directory? last
+          last << '/' unless last.end_with?('/')
+        end
+        last = lightblue(last)
+        path = splitted[0..-2].join('/')+'/'+last
+      end
+      if File.symlink?(path)
+        if stop_on_missing_symlink? # add functionality to stop on a missing symlink.
+          if !File.exist?(File.readlink(path))
+            add ' ← FILE DOES NOT EXIST!!! STOPPING NOW!'
+            exit
+          else # ok symlink exists.
+            # e ' IS A SYMLINK '
+          end
+        else
+          line << colourize_symlink(path)
+        end
+      end
+      # ===================================================================== #
+      # Finally display the line to the user.
+      # ===================================================================== #
+      e line
+    }
+    eliner
+    # ======================================================================= #
+    # Only add the filesize if we will report it.
+    # ======================================================================= #
+    try_to_report_the_total_filesize if report_the_total_filesize?
+  end; alias show                report # === show
+       alias display             report # === display
+       alias display_result      report # === display_result
+       alias display_content     report # === display_content
+       alias display_listing     report # === display_listing
+       alias do_report           report # === do_report
+       alias display_main_string report # === display_main_string
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    check_whether_we_use_colours
+    menu
+    report if display_content?
+    do_display_content # Re-toggle it again after run() is used.
+  end
+
+end
+
+# =========================================================================== #
+# === DirectoryParadise.show
+# =========================================================================== #
+def self.show(i = ARGV)
+  DirectoryParadise::Report.new(i)
+end; self.instance_eval { alias []      show } # === DirectoryParadise[]
+     self.instance_eval { alias run     show } # === DirectoryParadise.run
+     self.instance_eval { alias do_show show } # === DirectoryParadise.do_show
+     self.instance_eval { alias report  show } # === DirectoryParadise.report
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  DirectoryParadise::Report.new(ARGV)
+end # rcontent