ftp_paradise 1.4.5

data/lib/ftp_paradise.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'ftp_paradise/requires/require_the_ftp_paradise_project.rb'

data/lib/ftp_paradise/base/cliner.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/cliner.rb'
+# =========================================================================== #
+module FtpParadise
+
+module Base
+
+  require 'ftp_paradise/requires/common_external_requires.rb'
+  # =========================================================================== #
+  # === cliner
+  # =========================================================================== #
+  def cliner
+    Cliner.cliner
+    if block_given?
+      yield
+      Cliner.cliner
+    end
+  end
+
+end; end

data/lib/ftp_paradise/base/colours.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/colours.rb'
+# =========================================================================== #
+module FtpParadise
+
+module Base
+
+  require 'ftp_paradise/colours/colours.rb'
+
+  # ========================================================================= #
+  # === swarn
+  # ========================================================================= #
+  def swarn(i = '')
+    return ::FtpParadise.swarn(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    return ::FtpParadise.sfile(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    return ::FtpParadise.sfancy(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i = '')
+    return ::FtpParadise.sdir(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i = '')
+    return ::FtpParadise.simp(i) if use_colours?
+    i
+  end; alias simportant simp # === simportant
+
+  # ========================================================================= #
+  # === orange
+  # ========================================================================= #
+  def orange(i = '')
+    return ::Colours.orange(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sandybrown
+  # ========================================================================= #
+  def sandybrown(i = '')
+    return ::Colours.sandybrown(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i = '')
+    FtpParadise.royalblue(i)
+  end
+
+  # ========================================================================= #
+  # === slateblue
+  # ========================================================================= #
+  def slateblue(i = '')
+    FtpParadise.slateblue(i)
+  end
+
+end; end

data/lib/ftp_paradise/base/prototype.rb

@@ -0,0 +1,171 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/prototype.rb'
+# include ::FtpParadise::Base
+# =========================================================================== #
+require 'ftp_paradise/constants/constants.rb'
+# =========================================================================== #
+# The next .rb file will pull in "cliner":
+# =========================================================================== #
+require 'ftp_paradise/requires/common_external_requires.rb'
+
+module FtpParadise
+
+module Base
+
+  # ========================================================================= #
+  # The various project's toplevel_methods files are required next:
+  # ========================================================================= #
+  require 'ftp_paradise/requires/require_the_toplevel_methods.rb'
+
+  # =========================================================================== #
+  # Colour support comes next:
+  # =========================================================================== #
+  require 'ftp_paradise/base/colours.rb'
+  require 'ftp_paradise/base/cliner.rb'
+  require 'ftp_paradise/base/reset.rb'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    @internal_hash[:use_colours]
+  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
+
+  # ========================================================================= #
+  # === on_roebe?
+  # ========================================================================= #
+  def on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end; alias are_we_on_roebe? on_roebe? # === are_we_on_roebe?
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === return_pwd
+  # ========================================================================= #
+  def return_pwd
+    ::FtpParadise.return_pwd.to_s
+  end; alias return_current_directory return_pwd # === return_current_directory
+
+end; end

data/lib/ftp_paradise/base/reset.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/reset.rb'
+# =========================================================================== #
+module FtpParadise
+
+module Base
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :use_colours
+    # ======================================================================= #
+    @internal_hash[:use_colours] = true
+    # ======================================================================= #
+    # === :be_verbose
+    # ======================================================================= #
+    @internal_hash[:be_verbose]  = true
+  end
+
+end; end

data/lib/ftp_paradise/colours/colours.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# This file will add colour-related methods to the ftp_paradise project.
+# =========================================================================== #
+# require 'ftp_paradise/colours/colours.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/colours/use_colours.rb'
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    return Colours.rev if use_colours?
+    return ''
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.sdir
+  # ========================================================================= #
+  def self.sdir(i)
+    return Colours.sdir(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.swarn
+  # ========================================================================= #
+  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
+  # ========================================================================= #
+  def sfancy(i)
+    FtpParadise.sfancy(i) # We can delegate here, because FtpParadise.sfancy() will take care of colours.
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i) # Link to FtpParadise.simp
+    FtpParadise.simp(i) # We can delegate here, because FtpParadise.sfancy will take care of colours.
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i)
+    FtpParadise.sdir(i)
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i)
+    FtpParadise.sfile(i)
+  end
+
+  # ========================================================================= #
+  # === swarn
+  # ========================================================================= #
+  def swarn(i)
+    FtpParadise.swarn(i)
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.lightyellow
+  # ========================================================================= #
+  def self.lightyellow(i = '')
+    if use_colours?
+      return ::Colours.lightyellow(i)
+    end
+    return "#{Colours.yellow}#{i}#{Colours.rev}"
+  end; self.instance_eval { alias yellow lightyellow } # === FtpParadise.lightyellow
+
+  # ========================================================================= #
+  # === FtpParadise.royalblue
+  # ========================================================================= #
+  def self.royalblue(i = '')
+    if use_colours?
+      return ::Colours.royalblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.slateblue
+  # ========================================================================= #
+  def self.slateblue(i = '')
+    if use_colours?
+      return ::Colours.slateblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.testing_colours          (colour test, testing colours)
+  #
+  # This just is a test whether we use colours or whether we won't.
+  # ========================================================================= #
+  def self.testing_colours
+    e 'We will now test some colours.'
+    e "Will we use colours? #{FtpParadise.use_colours?.to_s}"
+    e 'Testing '+sfancy('sfancy')+' next.'
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts FtpParadise.swarn('Oh noes!')
+end