universal_pipe_handler 0.0.10

data/lib/universal_pipe_handler/colours/colourize.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Colourize
+#
+# Usage example:
+#
+#   Colourize.new(ARGV)
+#
+# =========================================================================== #
+# require 'colourize.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+class Colourize # < Base # === Foo::Colourize
+
+require 'universal_pipe_handler/colours/colours.rb'
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @_
+    # ======================================================================= #
+    @_ = ''.dup # This is the main string.
+  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
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === <<
+  # ========================================================================= #
+  def <<(i)
+    @_ << i
+  end
+
+  # ========================================================================= #
+  # === modify_input
+  # ========================================================================= #
+  def modify_input # This part uses the colours.
+    @_.gsub!(/(\d+)/,        GREEN+'\\1'+MAIN_COLOUR)
+    @_.gsub!(/(end)$/,       LIGHTBLUE+'\\1'+MAIN_COLOUR)
+    @_.gsub!(/(def)/,        LIGHTBLUE+'\\1'+MAIN_COLOUR)
+    @_.gsub!(/(class )/,     LIGHTBLUE+'\\1'+MAIN_COLOUR)
+    @_.gsub!(/(initialize)/, MAGENTA+'\\1'+MAIN_COLOUR)
+    @_.gsub!(/</,            RED+'<'+MAIN_COLOUR)
+    @_.gsub!(/(super)/,      CYAN+'\\1'+MAIN_COLOUR)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    modify_input
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::Colourize[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  UniversalPipeHandler::Colourize.new(ARGV)
+end # colourize.rb

data/lib/universal_pipe_handler/colours/colours.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/colours/colours.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'universal_pipe_handler/configuration/configuration.rb'
+
+  require 'colours'
+  include Colours
+
+  # ========================================================================= #
+  # === @dataset[:configuration]
+  #
+  # Determine whether we will use colours or not for the PipeParadise
+  # project. By default we will# use colours.
+  # ========================================================================= #
+  if @dataset
+    @dataset[:configuration][:use_colours] = true
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.use_colours?
+  #
+  # Convenience method to determine whether we will use colours or whether
+  # we will not.
+  # ========================================================================= #
+  def self.use_colours?
+    @dataset[:configuration][:use_colours]
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i)
+    return ::Colours.simp(i) if UniversalPipeHandler.use_colours?.use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i)
+    return ::Colours.sfancy(i) if UniversalPipeHandler.use_colours?.use_colours?
+    return i
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  pp UniversalPipeHandler.use_colours?  
+end

data/lib/universal_pipe_handler/configuration/configuration.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/configuration/configuration.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'universal_pipe_handler/dataset/dataset.rb'
+
+  # ========================================================================= #
+  # === @configuration
+  #
+  # The main configuration Hash. 
+  # ========================================================================= #
+  @dataset[:configuration] = {}
+
+end

data/lib/universal_pipe_handler/constants/constants.rb

@@ -0,0 +1,201 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === UniversalPipeHandler
+# =========================================================================== #
+# require 'universal_pipe_handler/constants/constants.rb'
+# UniversalPipeHandler::PIPE_TOKEN
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'yaml'
+  require 'universal_pipe_handler/project/project.rb'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::PIPE_TOKEN
+  #
+  # The pipe-token to use. Defaults to '|'.
+  # ========================================================================= #
+  PIPE_TOKEN = '|'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::FILE_ALLOWED_ACTIONS
+  # ========================================================================= #
+  FILE_ALLOWED_CMDLETS = yaml_directory?+'allowed_cmdlets.yml'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::ALLOWED_CMDLETS
+  #
+  # The yaml file can be found on my system at:
+  #   cat $RUBY_PIPE/yaml/allowed_actions.yml
+  # ========================================================================= #
+  _ = FILE_ALLOWED_CMDLETS
+  if File.exist? _
+    ALLOWED_CMDLETS = YAML.load_file(_)
+  else
+    e 'Can not continue - no file exists at '+sfile(_)+'.'
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::FILE_PREDEFINED_METHODS
+  # ========================================================================= #
+  FILE_PREDEFINED_METHODS = yaml_directory?+'predefined_methods.yml'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::FILE_PIPE_ALIASES
+  #
+  # This constant will refer to a path such as:
+  #
+  #   /home/x/programming/ruby/src/universal_pipe_handler/lib/universal_pipe_handler/yaml/aliases_to_cmdlets.yml
+  #
+  # ========================================================================= #
+  FILE_PIPE_ALIASES       = yaml_directory?+'aliases_to_cmdlets.yml'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.file_pipe_aliases
+  # ========================================================================= #
+  def self.file_pipe_aliases
+    FILE_PIPE_ALIASES
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler::DEFAULT_PIPE_COMMAND
+  # ========================================================================= #
+  DEFAULT_PIPE_COMMAND = 'ls | nl'
+
+  # ========================================================================= #
+  # === DEFAULT_PIPE
+  # ========================================================================= #
+  DEFAULT_PIPE = "test 'cat :this_file | wrap_at 76"
+
+  # ========================================================================= #
+  # === PREDEFINED_METHODS
+  #
+  # Predefined methods are those such as "enlarge()" for images,
+  # which will enlarge an image. They are compound methods,
+  # which allow us to perform some combined actions.
+  #
+  # The yaml file can be found on my system at:
+  #   cat $RUBY_PIPE/yaml/predefined_methods.yml
+  # ========================================================================= #
+  if File.exist? FILE_PREDEFINED_METHODS
+    PREDEFINED_METHODS = YAML.load_file(FILE_PREDEFINED_METHODS)
+  else
+    PREDEFINED_METHODS = {} # Empty Hash.
+  end
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.predefined_methods?
+  # ========================================================================= #
+  def self.predefined_methods?
+    PREDEFINED_METHODS
+  end; self.instance_eval { alias predefined_methods         predefined_methods? } # === UniversalPipeHandler.predefined_methods
+       self.instance_eval { alias return_predefined_methods? predefined_methods? } # === UniversalPipeHandler.return_predefined_methods?
+
+  # ========================================================================= #
+  # === ARRAY_VIDEO_FILES
+  #
+  # All registered video files should be defined here.
+  # ========================================================================= #
+  ARRAY_VIDEO_FILES = %w(
+    mp4
+    avi
+    flv
+    ogm
+    mpg
+  ); ARRAY_VIDEOFILE_EXTENSION = ARRAY_VIDEO_FILES
+
+  # ========================================================================= #
+  # === ARRAY_AUDIO_FILES
+  #
+  # All registered audio files should be defined here.
+  # ========================================================================= #
+  ARRAY_AUDIO_FILES = %w(
+    mp3
+    mp4
+    ogg
+    wav
+  )
+
+  # ========================================================================= #
+  # === ARRAY_IMAGE_FILE_TYPES
+  #
+  # All registered images. 3 so far - .jpg, .png and .gif
+  # ========================================================================= #
+  ARRAY_IMAGE_FILE_TYPES = %w(
+    jpg
+    png
+    gif
+    tiff
+  )
+
+  # ========================================================================= #
+  # === ARRAY_MULTIMEDIA_FILES
+  #
+  # Conjoint result between the video files and audio files.
+  # ========================================================================= #
+  ARRAY_MULTIMEDIA_FILES = (
+    ARRAY_VIDEO_FILES+
+    ARRAY_AUDIO_FILES
+  ).flatten.uniq
+
+  # ========================================================================= #
+  # === ONE_DAY_HAS_N_SECONDS
+  #
+  # A day has 24 hours, 60 minutes each, and every minute has 60 seconds.
+  # ========================================================================= #
+  ONE_DAY_HAS_N_SECONDS = 24 * 60 * 60
+
+  # ========================================================================= #
+  # === SRC_DIR
+  # ========================================================================= #
+  if ENV['SRC_DIR']  
+    SRC_DIR = ENV['SRC_DIR']+'/'
+  elsif File.directory?('/home/Temp/')
+    SRC_DIR = '/home/Temp/'
+  else
+    SRC_DIR = '/tmp/'
+  end
+
+  # ========================================================================= #
+  # === SAVE_DIR
+  # ========================================================================= #
+  if ENV['MY_TEMP']
+    SAVE_DIR = (
+      ENV['MY_TEMP'].to_s.dup+'/universal_pipe_handler/'
+    ).squeeze('/')
+  else
+    SAVE_DIR = '/home/Temp/universal_pipe_handler/'
+  end
+
+  # ========================================================================= #
+  # === CMDLETS_DIRECTORY
+  #
+  # Where we store all actions of the pipe paradise projects.
+  #
+  # This will be batch-required.
+  # ========================================================================= #
+  CMDLETS_DIRECTORY = PROJECT_BASE_DIRECTORY+'cmdlets/'
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'colours/autoinclude'
+  include UniversalPipeHandler
+  e UniversalPipeHandler::PIPE_TOKEN
+  e FILE_PIPE_ALIASES
+  e 'The cmdlets directory can be found at: '
+  e
+  e '  '+sfile(CMDLETS_DIRECTORY)
+  e
+  e 'The TEMP directory is at:'
+  e
+  e "  #{sfile(SAVE_DIR)}"
+  e
+end

data/lib/universal_pipe_handler/dataset/dataset.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/dataset/dataset.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === @dataset
+  # ========================================================================= #
+  @dataset = {}
+
+end

data/lib/universal_pipe_handler/project/project.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/project/project.rb'
+# pp UniversalPipeHandler.project_base_directory?
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY = 
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.project_base_directory?
+  # ========================================================================= #
+  def self.project_base_directory?
+    PROJECT_BASE_DIRECTORY
+  end; self.instance_eval { alias project_base_dir?  project_base_directory? } # === UniversalPipeHandler.project_base_dir?
+       self.instance_eval { alias project_directory? project_base_directory? } # === UniversalPipeHandler.project_directory?
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.project_yaml_directory?
+  # ========================================================================= #
+  def self.project_yaml_directory?
+    PROJECT_BASE_DIRECTORY+'yaml/'
+  end; self.instance_eval { alias yaml_directory? project_yaml_directory? } # === UniversalPipeHandler.yaml_directory?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e UniversalPipeHandler.project_yaml_directory?
+end

data/lib/universal_pipe_handler/requires/do_require_the_individual_cmdlet_files.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/requires/do_require_the_individual_cmdlet_files.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'universal_pipe_handler/project/project.rb'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.do_require_the_individual_cmdlet_files
+  # ========================================================================= #
+  def self.do_require_the_individual_cmdlet_files
+    Dir["#{PROJECT_BASE_DIRECTORY}/cmdlets/*.rb"].each {|this_cmdlet|
+      require "#{PROJECT_BASE_DIRECTORY}/cmdlets/"+
+              File.basename(this_cmdlet)
+    }
+  end
+
+end

data/lib/universal_pipe_handler/requires/require_the_universal_pipe_handler.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/requires/require_the_universal_pipe_handler.rb'
+# =========================================================================== #
+require 'universal_pipe_handler/project/project.rb'
+require 'universal_pipe_handler/version/version.rb'
+require 'universal_pipe_handler/cmdlet/cmdlet.rb'
+require 'universal_pipe_handler/colours/colours.rb'
+require 'universal_pipe_handler/configuration/configuration.rb'
+require 'universal_pipe_handler/toplevel_methods/token.rb'
+require 'universal_pipe_handler/requires/do_require_the_individual_cmdlet_files.rb'
+UniversalPipeHandler.do_require_the_individual_cmdlet_files