ftp_paradise 1.4.5 → 1.5.3

data/lib/ftp_paradise/base/base.rb

@@ -0,0 +1,375 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/base.rb'
+# include FtpParadise::Base
+# =========================================================================== #
+module FtpParadise
+
+module Base
+
+  require 'fileutils'
+  require 'tmpdir'
+
+  require 'ftp_paradise/colours/colours.rb'
+  require 'ftp_paradise/constants/constants.rb'
+  require 'ftp_paradise/project/project.rb'
+  # ========================================================================= #
+  # The next .rb file will pull in "cliner":
+  # ========================================================================= #
+  require 'ftp_paradise/requires/common_external_requires.rb'
+
+  # ========================================================================= #
+  # The various project's toplevel_methods files are required next:
+  # ========================================================================= #
+  require 'ftp_paradise/requires/require_the_toplevel_methods.rb'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :use_colours
+    # ======================================================================= #
+    @internal_hash[:use_colours] = true
+    # ======================================================================= #
+    # === :be_verbose
+    # ======================================================================= #
+    @internal_hash[:be_verbose]  = true
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i = '')
+    return ::FtpParadise.sdir(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i = '')
+    return ::FtpParadise.simp(i) if use_colours?
+    return i
+  end; alias simportant simp # === simportant
+
+  # ========================================================================= #
+  # === orange
+  # ========================================================================= #
+  def orange(i = '')
+    return ::Colours.orange(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === tomato
+  # ========================================================================= #
+  def tomato(i = '')
+    return ::Colours.tomato(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sandybrown
+  # ========================================================================= #
+  def sandybrown(i = '')
+    return ::Colours.sandybrown(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i = '')
+    return ::Colours.steelblue(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i = '')
+    FtpParadise.royalblue(i)
+  end
+
+  # ========================================================================= #
+  # === slateblue
+  # ========================================================================= #
+  def slateblue(i = '')
+    FtpParadise.slateblue(i)
+  end
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @internal_hash[:be_verbose]
+  end
+
+  # ========================================================================= #
+  # === be_quiet
+  # ========================================================================= #
+  def be_quiet
+    @internal_hash[:be_verbose] = false
+  end; alias be_silent be_quiet # === be_silent
+
+  # ========================================================================= #
+  # === set_be_verbose
+  #
+  # Set the verbosity mode.
+  # ========================================================================= #
+  def set_be_verbose(i = true)
+    @internal_hash[:be_verbose] = i
+  end; alias be_verbose= set_be_verbose # === be_verbose=
+       alias be_verbose  set_be_verbose # === be_verbose
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(i = NAMESPACE)
+    if i.is_a? String
+      i = { namespace: i }
+    end
+    FtpParadise.opnn(i)
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i = '')
+    FtpParadise.rds(i)
+  end
+
+  # ========================================================================= #
+  # === touch
+  # ========================================================================= #
+  def touch(i = '')
+    FtpParadise.touch(i)
+  end
+
+  # ========================================================================= #
+  # === get_files
+  # ========================================================================= #
+  def get_files(i = '')
+    FtpParadise.get_files(i)
+  end
+
+  # ========================================================================= #
+  # === return_all_local_entries
+  #
+  # This will return an array.
+  # ========================================================================= #
+  def return_all_local_entries(
+      from_where = Dir.pwd
+    )
+    Dir["#{from_where}/**/**"]
+  end; alias return_directory_content return_all_local_entries # === return_directory_content
+
+  # ========================================================================= #
+  # === e
+  # ========================================================================= #
+  def e(i = '')
+    FtpParadise.e(i)
+  end
+
+  # ========================================================================= #
+  # === parens                                                   (parens tag)
+  # ========================================================================= #
+  def parens(i)
+    padding_to_use = ' ' *  5
+    return sfancy("#{padding_to_use}(#{i}) ")
+  end
+
+  # ========================================================================= #
+  # === pound_token
+  #
+  # Simply return a colourized pound token next, but only if we use colours.
+  # ========================================================================= #
+  def pound_token
+    _ = '# '
+    if use_colours?
+      return "#{Colours::CYAN}#{_}#{Colours::WHITE}"
+    end
+    _
+  end
+
+  # ========================================================================= #
+  # === return_time
+  # ========================================================================= #
+  def return_time
+    FtpParadise.return_time
+  end
+
+  # ========================================================================= #
+  # === do_use_colours
+  # ========================================================================= #
+  def do_use_colours
+    @internal_hash[:use_colours] = true
+  end
+
+  # ========================================================================= #
+  # === cd
+  # ========================================================================= #
+  def cd(i)
+    Dir.chdir(i) if File.directory? i
+  end; alias change_local_directory cd # === change_local_directory
+
+  # ========================================================================= #
+  # === register_sigint
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') {
+      e 'Please use "q" to quit.'
+    }
+  end
+
+  # ========================================================================= #
+  # === try_to_create_a_temporary_log_directory_and_cd_into_it_or_the_temp_directory
+  #
+  # We need a temp directory (a log directory) for this project. The method
+  # here tries to ensure that.
+  # ========================================================================= #
+  def try_to_create_a_temporary_log_directory_and_cd_into_it_or_the_temp_directory
+    _ = '/tmp/' # This will be our tmp directory, as primary default.
+    tmpdir = Dir.tmpdir
+    if tmpdir and File.directory? tmpdir
+      _ = tmpdir
+    end
+    unless is_on_roebe? and return_pwd.include?('/home/x/')
+      if File.directory? _
+        Dir.chdir(_)
+        FileUtils.mkdir_p('ftp_paradise/') unless File.directory? 'ftp_paradise/'
+        Dir.chdir('ftp_paradise/')
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === verbose_truth
+  # ========================================================================= #
+  def verbose_truth(i = '')
+    VerboseTruth[i]
+  end
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def esystem(i)
+    e i
+    system i
+  end
+
+  # ========================================================================= #
+  # === return_pwd
+  # ========================================================================= #
+  def return_pwd
+    ::FtpParadise.return_pwd.to_s
+  end; alias return_current_directory return_pwd # === return_current_directory
+
+  # ========================================================================= #
+  # === on_roebe?
+  # ========================================================================= #
+  def on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end; alias are_we_on_roebe? on_roebe? # === are_we_on_roebe?
+       alias is_on_roebe?     on_roebe? # === is_on_roebe?
+
+  # =========================================================================== #
+  # === cliner
+  # =========================================================================== #
+  def cliner(
+      use_this_colour = nil
+    )
+    if Object.const_defined? :Cliner
+      if use_this_colour
+        use_this_colour = use_this_colour.to_s.to_sym
+        Cliner.cliner(use_colour: use_this_colour)
+      else
+        Cliner.cliner
+      end
+      if block_given?
+        yield
+        if use_this_colour
+          Cliner.cliner(use_colour: use_this_colour)
+        else
+          Cliner.cliner
+        end
+      end
+    end
+  end
+
+  # =========================================================================== #
+  # === cliner_seagreen
+  # =========================================================================== #
+  def cliner_seagreen
+    cliner(:seagreen)
+  end
+
+  # =========================================================================== #
+  # === cliner_violet
+  # =========================================================================== #
+  def cliner_violet
+    cliner(:violet)
+  end
+
+  # ========================================================================= #
+  # === swarn
+  # ========================================================================= #
+  def swarn(i = '')
+    return ::FtpParadise.swarn(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::FtpParadise.sfile(i, use_colours)
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(
+      i           = '',
+      use_colours = use_colours?
+    )
+    return ::FtpParadise.sfancy(i, use_colours)
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    return @internal_hash[:use_colours]
+  end
+
+  # ========================================================================= #
+  # === datafile?
+  # ========================================================================= #
+  def datafile?
+    '/home/x/data/personal/yaml/ftp/roebe_ftp.yml'
+  end
+
+  # ========================================================================= #
+  # === be_verbose=
+  # ========================================================================= #
+  def be_verbose=(i)
+    @be_verbose = i
+  end
+
+end; end

data/lib/ftp_paradise/colours/colours.rb

@@ -21,43 +21,19 @@ module FtpParadise
   # ========================================================================= #
   # === FtpParadise.sdir
   # ========================================================================= #
-  def self.sdir(i)
+  def self.sdir(i = '')
     return Colours.sdir(i) if use_colours?
-    i
+    return i
   end
 
   # ========================================================================= #
   # === FtpParadise.swarn
   # ========================================================================= #
-  def self.swarn(i)
+  def self.swarn(i = '')
     return Colours.swarn(i) if use_colours?
     return i
   end
 
-  # ========================================================================= #
-  # === FtpParadise.sfile
-  # ========================================================================= #
-  def self.sfile(i)
-    return Colours.sfile(i) if use_colours?
-    return i
-  end
-
-  # ========================================================================= #
-  # === FtpParadise.sfancy
-  # ========================================================================= #
-  def self.sfancy(i)
-    return Colours.sfancy(i) if use_colours? # Else we won't modify this at all.
-    return i
-  end
-
-  # ========================================================================= #
-  # === FtpParadise.simp
-  # ========================================================================= #
-  def self.simp(i)
-    return Colours.simp(i) if use_colours? # Else we won't modify this.
-    return i
-  end
-
   # ========================================================================= #
   # === sfancy
   # ========================================================================= #
@@ -134,6 +110,30 @@ module FtpParadise
     e 'Testing '+sfancy('sfancy')+' next.'
   end
 
+  # ========================================================================= #
+  # === FtpParadise.sfancy
+  # ========================================================================= #
+  def self.sfancy(i, use_colours = use_colours?)
+    return Colours.sfancy(i) if use_colours # Else we won't modify this at all.
+    return i
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.simp
+  # ========================================================================= #
+  def self.simp(i, use_colours = use_colours?)
+    return Colours.simp(i) if use_colours # Else we won't modify this.
+    return i
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.sfile
+  # ========================================================================= #
+  def self.sfile(i, use_colours = use_colours?)
+    return Colours.sfile(i,) if use_colours
+    return i
+  end
+
 end
 
 if __FILE__ == $PROGRAM_NAME

data/lib/ftp_paradise/colours/use_colours.rb

@@ -6,7 +6,12 @@
 # =========================================================================== #
 module FtpParadise
 
-  require 'ftp_paradise/configuration/configuration.rb'
+  begin
+    require 'ftp_paradise/configuration/configuration.rb'
+  rescue LoadError => error
+    puts 'ftp_paradise/configuration/configuration.rb is not available.'
+    pp error
+  end
 
   begin
     require 'colours'

data/lib/ftp_paradise/configuration/configuration.rb

@@ -9,8 +9,10 @@ module FtpParadise
   require 'ftp_paradise/project/project.rb'
 
   begin # Try to make use of Roebe::Configuration next.
-    require 'roebe/configuration/configuration.rb'
-  rescue LoadError; end
+    require 'roebe/configuration/class/configuration.rb'
+  rescue LoadError => error
+    pp error
+  end
 
   # ========================================================================= #
   # === @configuration
@@ -28,7 +30,8 @@ module FtpParadise
       # ===================================================================== #
       # Load up all .yml files from the path to the yaml directory:
       # ===================================================================== #
-      @configuration = ::Roebe::Configuration::Configuration.new(FtpParadise.yaml_directory?)
+      use_this_directory = FtpParadise.yaml_directory?
+      @configuration = ::Roebe::Configuration.new(use_this_directory)
     end
   end; self.instance_eval { alias initialize_configuration initialize } # === FtpParadise.initialize_configuration
 
@@ -44,6 +47,6 @@ module FtpParadise
   # ========================================================================= #
   def self.config?
     @configuration
-  end; self.class { alias configuration? config? } # === FtpParadise.configuration?
+  end; self.instance_eval { alias configuration? config? } # === FtpParadise.configuration?
 
 end