directory_paradise 1.4.5

data/lib/directory_paradise/base/base.rb

@@ -0,0 +1,228 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === DirectoryParadise::Base
+#
+# Usage example:
+#
+#   DirectoryParadise::Base.new(ARGV)
+#
+# =========================================================================== #
+# require 'directory_paradise/base/base.rb'
+# =========================================================================== #
+require 'directory_paradise/constants/newline.rb'
+
+module DirectoryParadise
+
+class Base
+
+  alias e  puts
+  alias ee print
+
+  require 'directory_paradise/base/colours.rb'
+  require 'directory_paradise/project/project.rb'
+  require 'directory_paradise/to_human_readable/to_human_readable.rb'
+
+  # ========================================================================= #
+  # === is_on_windows?
+  # ========================================================================= #
+  def is_on_windows?
+    if RUBY_PLATFORM.include?('win') or # if on windows.
+       RUBY_PLATFORM.include?('mingw')
+      return true
+    end
+    return false # ← Otherwise we are evidently NOT on windows, if we reach this point here.
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze '/'
+  end
+
+  # ========================================================================= #
+  # === register_sigint
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') { exit }
+  end
+
+  # ========================================================================= #
+  # === return_chmod_value_of_this_file
+  # ========================================================================= #
+  def return_chmod_value_of_this_file(i)
+    if File.exist? i
+      File.stat(i).mode.to_s(8).split('')[-4..-1].join # => "0755"
+    else
+      '0000'
+    end
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments_starting_with_two_hyphens?
+  # ========================================================================= #
+  def commandline_arguments_starting_with_two_hyphens?
+    @commandline_arguments.select {|entry| entry.start_with? '--' }
+  end
+
+  # ========================================================================= #
+  # === return_non_hyphen_entries_from
+  # ========================================================================= #
+  def return_non_hyphen_entries_from(i)
+    if i.is_a? Array
+      i.select {|entry| !entry.start_with?('--') }
+    else
+      nil
+    end
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === return_pwd
+  # ========================================================================= #
+  def return_pwd
+    "#{Dir.pwd}/".squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === eliner
+  # ========================================================================= #
+  def eliner
+    e '―' * 80
+  end
+
+  # ========================================================================= #
+  # === liner
+  # ========================================================================= #
+  def liner # adds a line.
+    if block_given?
+      liner
+      yield
+    end
+    return ('*' * 80)+N
+  end
+
+  # ========================================================================= #
+  # === return_owner
+  #
+  # This method determines the owner of a file or directory.
+  # ========================================================================= #
+  def return_owner(
+      of_this_uid
+    )
+    _ = ''.dup # The _ is the return value.
+    # ======================================================================= #
+    # The next block of code can fail on windows, hence why this is
+    # wrapped carefully.
+    # ======================================================================= #
+    begin
+      if of_this_uid.is_a? String
+        of_this_uid = of_this_uid.to_i
+      end
+      # ===================================================================== #
+      # The next line must be rescued because the filesystem may be faulty.
+      # ===================================================================== #
+      begin
+        result_from_getpwuid = Etc.getpwuid(of_this_uid)
+      rescue TypeError
+        result_from_getpwuid = false
+      end
+      if result_from_getpwuid
+        _ << result_from_getpwuid.name
+      else
+        _ << '(unknown)'
+      end
+    rescue ArgumentError
+      _ << '(unknown)'
+    rescue Errno::ENOENT
+      _ << '(missing)'
+    end
+    _ # Return it here.
+  end; alias owner? return_owner # === owner?
+
+  # ========================================================================= #
+  # === return_assumed_modification_time
+  # ========================================================================= #
+  def return_assumed_modification_time(i)
+    month = Date::MONTHNAMES[i.month][0,3] # => "Jun"
+    "#{month} #{i.day.to_s.rjust(2)}"
+  end
+
+  # ========================================================================= #
+  # === clear_the_internal_hash
+  # ========================================================================= #
+  def clear_the_internal_hash
+    @internal_hash.clear
+  end; alias clear clear_the_internal_hash # === clear
+
+  # ========================================================================= #
+  # === to_human_readable
+  #
+  # The strange thing is, in bash, we seem to round up.
+  #
+  # How many MB (megabyte) are in 1 GB (gigabyte)? 1024.
+  # ========================================================================= #
+  def to_human_readable(i)
+    return DirectoryParadise.to_human_readable(i)
+  end
+
+  # ========================================================================= #
+  # === infer_the_namespace
+  #
+  # This will assume the true namespace from the inspectable name.
+  # ========================================================================= #
+  def infer_the_namespace
+    _ = inspect.to_s.delete('<')
+    if _.include? ' '
+      _ = _.split(' ').first.delete('#')
+      if _.include? ':'
+        _ = _.split(':')[0 .. -2].reject {|entry| entry.empty? }.join('::')
+      end
+    elsif _.include? ':0x'
+      _ = _.split(':0x').first
+    end
+    @namespace = _.delete('#') # And assign it here.
+  end
+
+  # ========================================================================= #
+  # === namespace?
+  # ========================================================================= #
+  def namespace?
+    @namespace
+  end
+
+  # ========================================================================= #
+  # === print_the_namespace
+  # ========================================================================= #
+  def print_the_namespace
+    print namespace?
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  DirectoryParadise::Base.new(ARGV)
+end # base.rb

data/lib/directory_paradise/base/colours.rb

@@ -0,0 +1,196 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/base/colours.rb'
+# =========================================================================== #
+module DirectoryParadise
+
+class Base
+
+  # ========================================================================= #
+  # === do_use_colours
+  # ========================================================================= #
+  def do_use_colours(optional_args = '')
+    @internal_hash[:use_colours] = true # Whether we will use colours or whether we will not.
+  end; alias enable_colours do_use_colours # === enable_colours
+
+  # ========================================================================= #
+  # === use_colours?
+  #
+  # Whether we use colours or whether we don't.
+  # ========================================================================= #
+  def use_colours?(
+      i = @internal_hash[:use_colours]
+    )
+    return i
+  end
+
+  # ========================================================================= #
+  # === disable_colours
+  #
+  # Disable colours through this method.
+  # ========================================================================= #
+  def disable_colours
+    @internal_hash[:use_colours] = false
+  end
+
+  # ========================================================================= #
+  # === slink
+  # ========================================================================= #
+  def slink(i)
+    return Colours.slink(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i)
+    return Colours.simp(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i)
+    return Colours.sfancy(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === bold_yellow
+  # ========================================================================= #
+  def bold_yellow(i)
+    if use_colours?
+      Colours::BOLD_YELLOW+i+rev
+    else
+      i
+    end
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i)
+    return Colours.steelblue(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === springgreen
+  # ========================================================================= #
+  def springgreen(i)
+    return ::Colours.springgreen(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i)
+    return ::Colours.royalblue(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === lightblue
+  # ========================================================================= #
+  def lightblue(i)
+    return ::Colours.lightblue(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === lightgreen
+  # ========================================================================= #
+  def lightgreen(i)
+    return ::Colours.lightgreen(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === yellow
+  # ========================================================================= #
+  def yellow(i)
+    return ::Colours.yellow(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === tomato
+  # ========================================================================= #
+  def tomato(i)
+    return ::Colours.tomato(i) if use_colours?
+  end
+
+  # ========================================================================= #
+  # === skyblue
+  # ========================================================================= #
+  def skyblue(i)
+    return ::Colours.skyblue(i) if use_colours?
+  end
+
+  # ========================================================================= #
+  # === olive
+  # ========================================================================= #
+  def olive(i)
+    return ::Colours.olive(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === ssymlink
+  # ========================================================================= #
+  def ssymlink(i)
+    return ::Colours.ssymlink(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i)
+    i = i.to_s.dup
+    # i << '/' unless i.end_with? '/'
+    # ^^^ Nope, that is bad.
+    i = rds(i) if i.include? '//'
+    i = Colours.sdir(i) if use_colours?
+    return i
+  end; alias colourize_directory sdir # === colourize_directory tag
+
+  # ========================================================================= #
+  # === sfile
+  #
+  # We will invoke this only when we have a file.
+  # ========================================================================= #
+  def sfile(i)
+    if use_colours?
+      splitted = i.split('/')
+      filename = Colours.sfile(splitted.pop) # Must come before dirname, due to .pop().
+      dirname  = Colours.sdir( rds(splitted.join('/')+'/') )
+      unless show_leading_slash?
+        dirname = '' # Reset it in this case.
+      end
+      i = "#{dirname}#{filename}"
+    end
+    return i
+  end; alias colourize_file sfile # === colourize_file()
+
+  # ========================================================================= #
+  # === mediumpurple
+  # ========================================================================= #
+  def mediumpurple(i)
+    return ::Colours.mediumpurple(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    return "\e[0;37m"
+  end
+
+end; end

data/lib/directory_paradise/constants/newline.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_content/constants/newline.rb'
+# =========================================================================== #
+class DirectoryContent
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+end

data/lib/directory_paradise/content/constants.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'directory_paradise/content/constants.rb'
+# =========================================================================== #
+require 'directory_paradise/base/base.rb'
+
+module DirectoryParadise
+
+class Content < Base
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === UNKNOWN
+  # ========================================================================= #
+  UNKNOWN = '(unknown)'
+
+end; end