directory_paradise 1.4.4 → 1.4.5

data/lib/directory_paradise/report/obtain.rb

@@ -1,357 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'directory_paradise/report/obtain.rb'
-# =========================================================================== #
-require 'directory_paradise/base/base.rb'
-
-module DirectoryParadise
-
-class Report < Base # === DirectoryParadise::Report
-
-  # ========================================================================= #
-  # === n_directories?
-  #
-  # This will exclude directories with a trailing '.'
-  # ========================================================================= #
-  def n_directories?
-    directories = directories?.reject {|entry| entry.end_with? '/.' }
-    return directories.size
-  end
-
-  # ========================================================================= #
-  # === hash_colours_for_bytes_value?
-  # ========================================================================= #
-  def hash_colours_for_bytes_value?
-    @internal_hash[:hash_colours_for_bytes_value]
-  end
-
-  # ========================================================================= #
-  # === report_filesize?
-  # ========================================================================= #
-  def report_filesize?
-    @internal_hash[:report_filesize]
-  end; alias report_the_total_filesize? report_filesize? # === report_the_total_filesize?
-
-  # ========================================================================= #
-  # === total_filesize?
-  # ========================================================================= #
-  def total_filesize?
-    @internal_hash[:total_filesize]
-  end; alias total_file_size? total_filesize? # === total_file_size?
-
-  # ========================================================================= #
-  # === work_on_which_directory?
-  # ========================================================================= #
-  def work_on_which_directory?
-    @internal_hash[:work_on_this_directory]
-  end; alias from_which_directory? work_on_which_directory? # === from_which_directory?
-       alias base_directory?       work_on_which_directory? # === base_directory?
-       alias input?                work_on_which_directory? # === input?
-       alias which_directory?      work_on_which_directory? # === which_directory?
-       alias which_dir?            work_on_which_directory? # === which_dir?
-       alias base_dir?             work_on_which_directory? # === base_dir?
-       alias dir?                  work_on_which_directory? # === dir?
-
-  # ========================================================================= #
-  # === symlinks?
-  # ========================================================================= #
-  def symlinks?
-    @internal_hash[:directory_content].symlinks?
-  end
-
-  # ========================================================================= #
-  # === n_symlinks?
-  # ========================================================================= #
-  def n_symlinks?
-    symlinks?.size
-  end
-
-  # ========================================================================= #
-  # === directories?
-  # ========================================================================= #
-  def directories? # Feedback all available directories here.
-    @internal_hash[:directory_content].directories?
-  end
-
-  # ========================================================================= #
-  # === files?
-  #
-  # Query for all available files, by delegating towards class
-  # DirectoryContent.
-  # ========================================================================= #
-  def files?
-    @internal_hash[:directory_content].files?
-  end
-
-  # ========================================================================= #
-  # === n_files?
-  # ========================================================================= #
-  def n_files?
-    files?.size
-  end
-
-  # ========================================================================= #
-  # === show_statistics?
-  # ========================================================================= #
-  def show_statistics?
-    @internal_hash[:show_statistics]
-  end
-
-  # ========================================================================= #
-  # === return_directory_content
-  # ========================================================================= #
-  def return_directory_content(
-      i = @internal_hash[:work_on_this_directory]
-    )
-    obtain_from_directory_content(i)
-    consider_sorting
-    _ = @internal_hash[:directory_content].entries?
-    return _
-  end; alias gather_content           return_directory_content # === gather_content
-       alias gather                   return_directory_content # === gather
-       alias run_main_loop            return_directory_content # === run_main_loop
-       alias obtain_directory_listing return_directory_content # === obtain_directory_listing
-       alias obtain_entries           return_directory_content # === obtain_entries
-
-  # ========================================================================= #
-  # === display_content?
-  # ========================================================================= #
-  def display_content?
-    @internal_hash[:display_content]
-  end
-
-  # ========================================================================= #
-  # === directory_content?
-  # ========================================================================= #
-  def directory_content?
-    @internal_hash[:directory_content]
-  end
-
-  # ========================================================================= #
-  # === obtain_from_directory_content
-  # ========================================================================= #
-  def obtain_from_directory_content(i)
-    @internal_hash[:directory_content].obtain_from(i)
-  end
-
-  # ========================================================================= #
-  # === show_permissionsbits?
-  # ========================================================================= #
-  def show_permission_bits?
-    @internal_hash[:show_permission_bits]
-  end; alias show_permissions? show_permission_bits? # === show_permissions?
-
-  # ========================================================================= #
-  # === display_only_directories?
-  # ========================================================================= #
-  def display_only_directories?
-    @internal_hash[:display_only_directories]
-  end
-
-  # ========================================================================= #
-  # === show_hidden_files?
-  # ========================================================================= #
-  def show_hidden_files?
-    @internal_hash[:show_hidden_files]
-  end
-
-  # ========================================================================= #
-  # === show_index?
-  # ========================================================================= #
-  def show_index?
-    @internal_hash[:show_index]
-  end; alias use_index? show_index? # === use_index?
-
-  # ========================================================================= #
-  # === entries?
-  # ========================================================================= #
-  def entries?
-    @internal_hash[:directory_content].entries
-  end; alias _ entries? # === _
-
-  # ========================================================================= #
-  # === sort_by?
-  # ========================================================================= #
-  def sort_by?
-    @internal_hash[:sort_by]
-  end
-
-  # ========================================================================= #
-  # === show_dots_only_entries?
-  # ========================================================================= #
-  def show_dots_only_entries?
-    @internal_hash[:show_dots_only_entries]
-  end
-
-  # ========================================================================= #
-  # === show_only_symlinks?
-  # ========================================================================= #
-  def show_only_symlinks?
-    @internal_hash[:show_only_symlinks]
-  end
-
-  # ========================================================================= #
-  # === ignore_backups?
-  # ========================================================================= #
-  def ignore_backups?
-    @internal_hash[:ignore_backups]
-  end
-
-  # ========================================================================= #
-  # === collapse?
-  #
-  # The revers of whether we will show the full path or not.
-  # ========================================================================= #
-  def collapse?
-    !show_full_path?
-  end
-
-  # ========================================================================= #
-  # === content?
-  # ========================================================================= #
-  def content?
-    @internal_hash[:directory_content].content?
-  end; alias content content? # === content?
-
-  # ========================================================================= #
-  # === show_inode?
-  # ========================================================================= #
-  def show_inode?
-    @internal_hash[:show_inode]
-  end
-
-  # ========================================================================= #
-  # === show_full_path?
-  # ========================================================================= #
-  def show_full_path?
-    @internal_hash[:show_full_path]
-  end; alias show_full_path show_full_path? # === show_full_path
-
-  # ========================================================================= #
-  # === show_group_information?
-  # ========================================================================= #
-  def show_group_information?
-    @internal_hash[:show_group_information]
-  end
-
-  # ========================================================================= #
-  # === show_size?
-  # ========================================================================= #
-  def show_size?
-    @internal_hash[:show_size]
-  end
-
-  # ========================================================================= #
-  # === colourize_path?
-  # ========================================================================= #
-  def colourize_path?
-    @internal_hash[:colourize_path]
-  end
-
-  # ========================================================================= #
-  # === show_permission_bits?
-  # ========================================================================= #
-  def show_permission_bits?
-    @internal_hash[:show_permission_bits]
-  end
-
-  # ========================================================================= #
-  # === show_header?
-  #
-  # Whether we will show the header or whether we will not. That header
-  # is not typical for the normal GNU "ls" command, hence why we need
-  # to have such an option.
-  # ========================================================================= #
-  def show_header?
-    @internal_hash[:show_header]
-  end
-
-  # ========================================================================= #
-  # === colourize_kb_and_mb?
-  # ========================================================================= #
-  def colourize_kb_and_mb?
-    @internal_hash[:colourize_kb_and_mb]
-  end
-
-  # ========================================================================= #
-  # === stop_on_missing_symlink?
-  # ========================================================================= #
-  def stop_on_missing_symlink?
-    @internal_hash[:stop_on_missing_symlink]
-  end
-
-  # ========================================================================= #
-  # === result?
-  #
-  # This will show the string that can be displayed.
-  # ========================================================================= #
-  def result?
-    @internal_hash[:result]
-  end
-
-  # ========================================================================= #
-  # === show_condensed_permissions?
-  # ========================================================================= #
-  def show_condensed_permissions?
-    @internal_hash[:show_condensed_permissions]
-  end; alias condensed? show_condensed_permissions? # === condensed?
-
-  # ========================================================================= #
-  # === owner?
-  # ========================================================================= #
-  def owner?(i)
-    @internal_hash[:directory_content].owner?(i)
-  end
-
-  # ========================================================================= #
-  # === truncate_long_file_names?
-  # ========================================================================= #
-  def truncate_long_file_names?
-    @internal_hash[:truncate_long_file_names]
-  end
-
-  # ========================================================================= #
-  # === show_simplified?
-  # ========================================================================= #
-  def show_simplified?
-    @internal_hash[:show_simplified]
-  end
-
-  # ========================================================================= #
-  # === show_modification_time?
-  # ========================================================================= #
-  def show_modification_time?
-    @internal_hash[:show_modification_time]
-  end
-
-  # ========================================================================= #
-  # === show_leading_slash?
-  # ========================================================================= #
-  def show_leading_slash?
-    @internal_hash[:show_leading_slash]
-  end
-
-  # ========================================================================= #
-  # === colour_for_files?
-  # ========================================================================= #
-  def colour_for_files?
-    @internal_hash[:colour_for_files]
-  end
-
-  # ========================================================================= #
-  # === colour_for_symlinks?
-  # ========================================================================= #
-  def colour_for_symlinks?
-    @internal_hash[:colour_for_symlinks]
-  end
-
-  # ========================================================================= #
-  # === colour_for_directories?
-  # ========================================================================= #
-  def colour_for_directories?
-    @internal_hash[:colour_for_directories]
-  end
-
-end; end

data/lib/directory_paradise/report/reset.rb

@@ -1,174 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'directory_paradise/report/reset.rb'
-# =========================================================================== #
-require 'directory_paradise/base/base.rb'
-
-module DirectoryParadise
-
-class Report < Base # === DirectoryParadise::Report
-
-  # ========================================================================= #
-  # === reset                                                     (reset tag)
-  # ========================================================================= #
-  def reset
-    # ======================================================================= #
-    # === @internal_hash
-    # ======================================================================= #
-    @internal_hash = {}
-    # ======================================================================= #
-    # === :work_on_this_directory
-    # ======================================================================= #
-    @internal_hash[:work_on_this_directory] = return_pwd
-    # ======================================================================= #
-    # === :collapse
-    #
-    # Whether to collapse or not.
-    # ======================================================================= #
-    @internal_hash[:collapse] = false
-    # ======================================================================= #
-    # === :total_filesize
-    # ======================================================================= #
-    @internal_hash[:total_filesize] = 0 # Keep the total file size.
-    # ======================================================================= #
-    # === :report_filesize
-    #
-    # Tell the user the total filesize of the listing.
-    # ======================================================================= #
-    @internal_hash[:report_filesize] = true
-    # ======================================================================= #
-    # === :default_colour
-    # ======================================================================= #
-    @internal_hash[:default_colour] = :steelblue
-    # ======================================================================= #
-    # === :colourize_kb_and_mb
-    # ======================================================================= #
-    @internal_hash[:colourize_kb_and_mb] = COLOURIZE_KB_AND_MB
-    # ======================================================================= #
-    # === :threshold_for_file_size
-    #
-    # Only honoured if @truncate_long_file_names is true.
-    # ======================================================================= #
-    @internal_hash[:threshold_for_file_size] = FILE_SIZE_THRESHOLD
-    # ======================================================================= #
-    # === :show_group_information
-    # ======================================================================= #
-    @internal_hash[:show_group_information] = true
-    # ======================================================================= #
-    # === :show_modification_time
-    #
-    # if true then we show the modification time of the inode in question.
-    # ======================================================================= #
-    @internal_hash[:show_modification_time] = true
-    # ======================================================================= #
-    # === :use_colours
-    # ======================================================================= #
-    @internal_hash[:use_colours] = true
-    # ======================================================================= #
-    # === :show_leading_slash
-    #
-    # Show the leading slash in / directory.
-    # ======================================================================= #
-    @internal_hash[:show_leading_slash] = false
-    # ======================================================================= #
-    # === :sort_by
-    #
-    # This value must be nil initially, so that we will not do any
-    # sorting at all whatsoever.
-    # ======================================================================= #
-    @internal_hash[:sort_by] = nil
-    # ======================================================================= #
-    # === :show_only_symlinks
-    # ======================================================================= #
-    @internal_hash[:show_only_symlinks] = false
-    # ======================================================================= #
-    # === truncate_long_file_names
-    #
-    # If true, we truncate too-long file names.
-    # ======================================================================= #
-    @internal_hash[:truncate_long_file_names] = false
-    # ======================================================================= #
-    # === :show_simplified
-    #
-    # The following variable tells this class to keep a simplified directory
-    # layout.
-    #
-    # If it is true, then we only display a short variant of the file
-    # content.
-    # ======================================================================= #
-    @internal_hash[:show_simplified] = true
-    # ======================================================================= #
-    # === :colour_for_symlinks
-    # ======================================================================= #
-    @internal_hash[:colour_for_symlinks] = Colours.colour_for_symlinks
-    # ======================================================================= #
-    # === :show_size
-    #
-    # Whether to show the size of the entry at hand.
-    # ======================================================================= #
-    @internal_hash[:show_size] = true
-    # ======================================================================= #
-    # === :colourize_kb_and_mb
-    # ======================================================================= #
-    @internal_hash[:colourize_kb_and_mb] = true
-    # ======================================================================= #
-    # === :show_header
-    # ======================================================================= #
-    @internal_hash[:show_header] = true
-    # ======================================================================= #
-    # === :show_index
-    #
-    # Whether to show a leading index or not. I like this, so it is on
-    # by default.
-    # ======================================================================= #
-    @internal_hash[:show_index] = true
-    # ======================================================================= #
-    # === :colourize_path
-    #
-    # If the next variable is set to true then the path, such as
-    # /foo/bar.md will be colourized when .report() is called.
-    # ======================================================================= #
-    @internal_hash[:colourize_path] = true
-    # ======================================================================= #
-    # === :show_permission_bits
-    #
-    # If the following variable is set to true then the entry at hand
-    # will show inclusive "drwxr-xr-x".
-    # ======================================================================= #
-    @internal_hash[:show_permission_bits] = true
-    # ======================================================================= #
-    # === :show_dots_only_entries
-    #
-    # This setting filters away '.' and '..' from the result.
-    # ======================================================================= #
-    @internal_hash[:show_dots_only_entries] = false
-    # ======================================================================= #
-    # === :show_statistics
-    # ======================================================================= #
-    @internal_hash[:show_statistics] = true
-    # ======================================================================= #
-    # === :directory_content
-    #
-    # This variable will keep a reference to class
-    # DirectoryParadise::Content.
-    # ======================================================================= #
-    @internal_hash[:directory_content] = DirectoryParadise::Content.new
-    # ======================================================================= #
-    # === :hash_colours_for_bytes_value
-    #
-    # We need to capture this here because we may try to want to sanitize
-    # the given values, such as when the user types an incorrect colour,
-    # like "mediumpurples" rather than "mediumpurple".
-    # ======================================================================= #
-    @internal_hash[:hash_colours_for_bytes_value] = HASH_COLOURS_FOR_BYTES_VALUE
-    do_not_show_hidden_files # Do not show hidden files by default.
-    do_show_header
-    do_show_index
-    do_show_modification_time
-    do_show_the_content
-    do_not_stop_on_missing_symlink
-  end
-
-end; end