directory_paradise 1.4.4

data/lib/directory_paradise/report/reset.rb

@@ -0,0 +1,174 @@
+#!/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

data/lib/directory_paradise/requires/require_class_content.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/requires/require_class_content.rb'
+# =========================================================================== #
+require 'directory_paradise/content/content.rb'

data/lib/directory_paradise/requires/require_class_report.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/requires/require_class_report.rb'
+# =========================================================================== #
+require 'directory_paradise/report/report.rb'

data/lib/directory_paradise/requires/require_the_directory_paradise_project.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/requires/require_the_directory_paradise_project.rb'
+# =========================================================================== #
+require 'directory_paradise/requires/require_class_content.rb'
+require 'directory_paradise/requires/require_class_report.rb'
+require 'directory_paradise/to_human_readable/to_human_readable.rb'
+require 'directory_paradise/sdc.rb'

data/lib/directory_paradise/sdc.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file adds a single method, the sdc() method, to your project,
+# and an alias to said method.
+#
+# To use it in your project, do this:
+#
+#   require 'directory_paradise/sdc'
+#
+# =========================================================================== #
+require 'directory_paradise/report/report.rb'
+
+# =========================================================================== #
+# === sdc
+#
+# The first argument is the directory that should be displayed.
+# =========================================================================== #
+def sdc(
+    i = Dir.pwd
+  )
+  DirectoryParadise::Report.new(i)
+end; alias show_directory_content sdc # === show_directory

data/lib/directory_paradise/to_human_readable/to_human_readable.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/to_human_readable/to_human_readable.rb'
+# DirectoryParadise.to_human_readable(123)
+# =========================================================================== #
+module DirectoryParadise
+
+class ToHumanReadable
+
+  alias e puts
+
+  # ========================================================================= #
+  # === ARRAY_BYTE_UNITS
+  # ========================================================================= #
+  ARRAY_BYTE_UNITS = ['B','KB','MB','GB','TB'] # Should be two chars, for better alignment.
+
+  # ========================================================================= #
+  # === DIVIDE_BY
+  # ========================================================================= #
+  DIVIDE_BY = 1024.0
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      n_bytes = ARGV
+    )
+    reset
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      @may_we_report = false if yielded == :do_not_report
+    end
+    if n_bytes.is_a? Array
+      n_bytes = n_bytes.first
+    end
+    n_bytes = n_bytes.to_i
+    hierarchy = 0
+    if n_bytes > DIVIDE_BY
+      loop {
+        n_bytes = n_bytes / DIVIDE_BY
+        hierarchy += 1
+        break if n_bytes < DIVIDE_BY
+      }
+    end
+    @result = ''.dup
+    @result << "#{n_bytes.to_f.round(1)} "
+    @result << "#{ARRAY_BYTE_UNITS[hierarchy].rjust(2)}"
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    @may_we_report = true
+  end
+
+  # ========================================================================= #
+  # === result?
+  # ========================================================================= #
+  def result?
+    @result
+  end
+
+  # ========================================================================= #
+  # === report
+  # ========================================================================= #
+  def report
+    e @result if @may_we_report
+  end
+
+end
+
+# =========================================================================== #
+# === DirectoryParadise.to_human_readable
+#
+# This variant will simply return the correct string that we want to
+# have. This was the whole point of creating this class in the first
+# place, anyway.
+#
+# Usage example:
+#
+#   DirectoryParadise.to_human_readable(2_555_666)
+#
+# =========================================================================== #
+def self.to_human_readable(i = ARGV)
+  return DirectoryParadise::ToHumanReadable.new(i) { :do_not_report }.result?
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  DirectoryParadise::ToHumanReadable.new(ARGV).report
+end # rb to_human_readable 100

data/lib/directory_paradise/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/version/version.rb'
+# =========================================================================== #
+class DirectoryParadise
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.4.4'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '15.05.2022'
+
+end

data/lib/directory_paradise/yaml/colours_for_bytes_values.yml

@@ -0,0 +1,14 @@
+# =========================================================================== #
+# === colours_for_bytes_values.yml
+#
+# The user can customise the colours via this .yml file. The colour in
+# use must be registered in the Colours namespace, which is part of
+# the colours-gem.
+# =========================================================================== #
+# x = YAML.load_file('colours_for_bytes_values.yml')
+# =========================================================================== #
+
+KB: :lightgreen
+MB: :yellow
+GB: :mediumpurple
+B:  :olive

data/lib/directory_paradise.rb

@@ -0,0 +1 @@
+require 'directory_paradise/requires/require_the_directory_paradise_project.rb'

data/test/testing_class_content.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/colours_e_autoinclude.rb'
+require 'directory_paradise'
+require 'cliner'
+cliner
+e 'We will return the entries at '+sdir('/Depot/')+' next:'
+pp DirectoryParadise::Content.new '/Depot/'
+cliner
+e Colours.steelblue('Next, we will show the hash that describes '\
+  'the content of the directory at /Depot/:') 
+entries = DirectoryParadise::Content.new('/Depot/').entries?
+e 'This directory has '+entries.size.to_s+' entries.'
+cliner

data/test/testing_class_report.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/colours_e_autoinclude.rb'
+require 'directory_paradise'
+require 'cliner'
+
+# =========================================================================== #
+# First, we set up some files and directories, a few which will be broken.
+# =========================================================================== #
+BASE_DIR = '/Depot/j/'
+e 'The base directory is at '+sdir(BASE_DIR)+'.'
+_ = DirectoryParadise::Report.new(BASE_DIR, :dont_run_yet)
+_.menu 'no_full_path'
+_.run
+_.display
+# =========================================================================== #
+#
+# =========================================================================== #
+BASE_DIR = '/dev/'
+e 'We will change directory into '+Colours.slateblue(BASE_DIR)+' soon:'
+_ = DirectoryParadise::Report.new(BASE_DIR, :dont_run_yet)
+Dir.chdir(BASE_DIR)
+e "We are now in the directory #{Colours.slateblue(BASE_DIR)}."
+_.apply_filter '*sr*' if _.respond_to? :apply_filter
+_.display
+e 'Next testing the difference between con and uncon'
+_.menu 'con'
+_.display
+_.menu 'uncon'
+_.display # test_sdc
+e 'Next, we disable colours:'
+_.disable_colours
+_.show_content_for '/Depot/Temp'
+e 'Next, we enable colours:'
+_.enable_colours
+_.show_content_for '/Depot/Temp'
+e 'Next, we will test ShowDirectoryContent.do_show:'
+DirectoryContent::ShowDirectoryContent.do_show

data/test/testing_toplevel_methods.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/autoinclude'
+require 'directory_paradise'
+
+e
+e 'Next testing DirectoryParadise-related toplevel methods:'
+e
+
+DirectoryParadise.report
+DirectoryParadise.show('/home/x/songs/')
+DirectoryParadise.show(from: '/home/x/songs/')

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: directory_paradise
+version: !ruby/object:Gem::Version
+  version: 1.4.4
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\nThis class will display the content of a directory. It\ncan also give
+  back a data-object that describes the \ncontent of a directory, e. g. all files
+  or directories\nfound in that directory.\n\nThe class aims to function somewhat
+  similar to the\nUNIX/coreutils program called \"ls\".\n\nThe latest version now
+  comes with a test/ directory.\n\nThe method apply_filter() was added, so now we
+  can\nfilter almost like \"ls *foo*\" could filter.\n\nAs of version 1.0.3, showing
+  the Index is optional.\n\n"
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/show_directory_content
+- directory_paradise.gemspec
+- doc/README.gen
+- doc/todo/todo.md
+- lib/directory_paradise.rb
+- lib/directory_paradise/base/base.rb
+- lib/directory_paradise/base/colours.rb
+- lib/directory_paradise/constants/newline.rb
+- lib/directory_paradise/content/constants.rb
+- lib/directory_paradise/content/content.rb
+- lib/directory_paradise/project/project.rb
+- lib/directory_paradise/report/constants.rb
+- lib/directory_paradise/report/initialize.rb
+- lib/directory_paradise/report/menu.rb
+- lib/directory_paradise/report/misc.rb
+- lib/directory_paradise/report/obtain.rb
+- lib/directory_paradise/report/report.rb
+- lib/directory_paradise/report/reset.rb
+- lib/directory_paradise/requires/require_class_content.rb
+- lib/directory_paradise/requires/require_class_report.rb
+- lib/directory_paradise/requires/require_the_directory_paradise_project.rb
+- lib/directory_paradise/sdc.rb
+- lib/directory_paradise/to_human_readable/to_human_readable.rb
+- lib/directory_paradise/version/version.rb
+- lib/directory_paradise/yaml/colours_for_bytes_values.yml
+- test/testing_class_content.rb
+- test/testing_class_report.rb
+- test/testing_toplevel_methods.rb
+homepage: https://rubygems.org/gems/directory_paradise
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.13
+requirements: []
+rubygems_version: 3.3.13
+signing_key:
+specification_version: 4
+summary: This class will display the content of a directory. It can also give back
+  a data-object that describes the  content of a directory, e. g. all files or directories
+  found in that directory.  The class aims to function somewhat similar to the UNIX/coreutils
+  program called "ls".  The latest version now comes with a test/ directory.  The
+  method apply_filter() was added, so now we can filter almost like "ls *foo*" could
+  filter.  As of version 1.0.3, showing the Index is optional.
+test_files: []