universal_pipe_handler 0.0.10

data/lib/universal_pipe_handler/cmdlets/get_all_images_including_subdirs.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/get_all_images_including_subdirs.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_get_all_images_including_subdirs
+  #
+  # The first argument should be the path to a directory.
+  # ========================================================================= #
+  def self.cmdlet_get_all_images_including_subdirs(
+      optional_target_dir = nil
+    )
+    set_target_directory(optional_target_dir) if optional_target_dir
+    all_the_images = action_get_all_images_including_subdirs(
+      { :from => target_directory? },
+      :include_subdirs
+    ) # true for including all subdirs
+    set_result(all_the_images)
+    return result?
+  end; self.instance_eval { alias get_all_images_including_subdirs cmdlet_get_all_images_including_subdirs } # === UniversalPipeHandler.get_all_images_including_subdirs
+
+end

data/lib/universal_pipe_handler/cmdlets/get_all_video_files.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/get_all_video_files.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_get_all_video_files
+  #
+  # We depend on the action "get all files" for this method here.
+  #
+  # By default we will fetch all audios from the directory /Depot/Audio.
+  # This behaviour may change in the future, and default to Dir.pwd
+  # instead.
+  # ========================================================================= #
+  def self.cmdlet_get_all_video_files(
+      from = Dir.pwd
+    )
+    from << '/' unless from.end_with? '/'
+    _ = action_get_all_files(from)
+    # ======================================================================= #
+    # Next, we apply a filter to get only the audio files:
+    # ======================================================================= #
+    _.reject! {|entry|
+      entry = File.extname(entry).delete('.')
+      ! ARRAY_VIDEO_FILES.include?(entry)
+    }
+    set_result(_) # We use this result.
+    return _
+  end; self.instance_eval { alias get_all_video_files cmdlet_get_all_video_files } # === UniversalPipeHandler.get_all_video_files
+
+end

data/lib/universal_pipe_handler/cmdlets/get_last_characters.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/get_last_characters.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_get_last_characters
+  #
+  # Gets the specified n last characters from a string.
+  # ========================================================================= #
+  def self.cmdlet_get_last_characters(
+      i = 50
+    )
+    i = i.to_i
+    joined = result?.join
+    joined = joined.delete(N) # remove all newlines for now. Or not. Hmmm.
+    set_result joined[-i, i.abs]
+    return result?
+  end; self.instance_eval { alias get_last_characters cmdlet_get_last_characters } # === UniversalPipeHandler.get_last_characters
+
+end

data/lib/universal_pipe_handler/cmdlets/help.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/help.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_help
+  #
+  # List all available action types. In order for this to work, the constant
+  # REGISTERED_ACTIONS must have been set.
+  #
+  # To test this, try this in the pipeshell:
+  #
+  #   help?
+  #
+  # ========================================================================= #
+  def self.cmdlet_help
+    set_result(registered_actions?)
+    if be_verbose?
+      e 'The available actions are:'
+      registered_actions?.each_with_index { |action, index| index += 1
+        left_part = (index.to_s).rjust(3)+') '
+        if Object.const_defined? :Konsole # Add some colours then.
+          left_part = Konsole.darkseagreen(left_part)
+        end
+        e left_part+action
+      }
+    end
+    return result?
+  end; self.instance_eval { alias help  cmdlet_help } # === UniversalPipeHandler.help
+       self.instance_eval { alias help? cmdlet_help } # === UniversalPipeHandler.help?
+
+end

data/lib/universal_pipe_handler/cmdlets/identify.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/identify.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_identify
+  #
+  # This method will attempt to identify a file, in particular
+  # multimedia data (thus, audio and video).
+  #
+  # For this we will tap into the project MultimediaParadise.
+  # ========================================================================= #
+  def self.cmdlet_identify(
+      this_file = result?
+    )
+    this_file = this_file.first if this_file.is_a? Array
+    if is_a_multimedia_file?(this_file)
+      _ = MultimediaParadise::VideoInformation.new(this_file)
+      _.report
+      set_result _.data # This will be an Array.
+    end
+    return result?
+  end; self.instance_eval { alias identify cmdlet_identify } # === UniversalPipeHandler.identify
+
+end

data/lib/universal_pipe_handler/cmdlets/increase_audio.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/increase_audio.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_increase_audio
+  #
+  # This method can be used to increase the audio volume.
+  # ========================================================================= #
+  def self.cmdlet_increase_audio(
+      by_how_much_percent = '5'
+    )
+    this_file = result? # We assume here that a 
+    by_how_much_percent = by_how_much_percent.to_i
+    _ = IncreaseVolume.new(this_file, :do_not_run_yet)
+    _.set_gain by_how_much_percent
+    _.run
+    set_result(_.file?)
+    return result?
+  end; self.instance_eval { alias increase_audio cmdlet_increase_audio } # === UniversalPipeHandler.increase_audio
+
+end

data/lib/universal_pipe_handler/cmdlets/install.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/install.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_install
+  #
+  # This will try to install something via RBT::Installer.new
+  # ========================================================================= #
+  def self.cmdlet_install(
+      i = result?
+    )
+    i = i.first if i.is_a? Array
+    if Object.const_defined? :Easycompile
+      unless File.exist?(i) and ! i.include?('/') # File does not exist here.
+        target = SRC_DIR+i.upcase+'/'+i+'*'
+        entries = Dir[target]
+        i = entries.first unless entries.empty?
+      end
+      _ = Easycompile.compile(i)
+    elsif Object.const_defined? :RBT
+      _ = RBT::Compile.new(i)
+    end
+    set_result(i)
+    return result?
+  end; self.instance_eval { alias install  cmdlet_install } # === UniversalPipeHandler.install
+
+end

data/lib/universal_pipe_handler/cmdlets/match_regex.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/match_regex.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_match_regex
+  #
+  # This method matches to a regex. Or rather, to the line that
+  # includes a particular match.
+  # ========================================================================= #
+  def self.cmdlet_match_regex(i = result?)
+    regex = /#{i}/
+    match = []
+    if result?
+      result?.each { |t| match << t if t =~ regex }
+      set_result(match)
+    end
+  end; self.instance_eval { alias match_regex cmdlet_match_regex } # === UniversalPipeHandler.match_regex
+
+end

data/lib/universal_pipe_handler/cmdlets/n_directories.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/n_directories.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_n_directories
+  #
+  # Tell us how many directories we have.
+  #
+  # We need to keep in mind that a directory may also have 0
+  # subdirectories.
+  # ========================================================================= #
+  def self.cmdlet_n_directories
+    result = get_all_directories
+    size = result.size
+    set_result(size)
+    return result?
+  end; self.instance_eval { alias n_directories  cmdlet_n_directories } # === UniversalPipeHandler.n_directories
+       self.instance_eval { alias n_directories? cmdlet_n_directories } # === UniversalPipeHandler.n_directories?
+
+end

data/lib/universal_pipe_handler/cmdlets/n_files.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/n_files.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_n_files
+  # ========================================================================= #
+  def self.cmdlet_n_files
+    result = Dir.entries(Dir.pwd).reject! {|_| File.directory? _ }
+    result = result.size
+    set_result(result)
+    return result?
+  end; self.instance_eval { alias n_files  cmdlet_n_files } # === UniversalPipeHandler.n_files
+       self.instance_eval { alias n_files? cmdlet_n_files } # === UniversalPipeHandler.n_files?
+
+end

data/lib/universal_pipe_handler/cmdlets/n_words.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/n_words.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_n_words
+  #
+  # This commandlet will simply count how many words are in a given string.
+  # ========================================================================= #
+  def self.cmdlet_n_words(i = result?)
+    if i.is_a? String
+      _ = i.join
+    else
+      _ = i
+    end
+    joined = _.join(N)
+    set_result joined.split(/\s+/).size
+    return result?
+  end; self.instance_eval { alias n_words cmdlet_n_words } # === UniversalPipeHandler.n_words
+
+end

data/lib/universal_pipe_handler/cmdlets/number_lines.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/number_lines.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  require 'universal_pipe_handler/toplevel_methods/e.rb'
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_number_lines                     (nl tag)
+  #
+  # We don't need to use an argument here, as we can directly make
+  # use of the @result variable.
+  # ========================================================================= #
+  def self.cmdlet_number_lines
+    counter = 1
+    _ = []
+    @result = result?.split(N) if result?.is_a? String
+    if result?
+      result?.each {|member|
+        unless counter == (@result.size + 1)
+          _ << ('%5s' % counter.to_s )+'  '+member
+        end
+        counter += 1
+      }
+      set_result(_) #.join
+    else
+      e 'Sorry, we could not find any result.'
+    end
+  end; self.instance_eval { alias number_lines cmdlet_number_lines } # === UniversalPipeHandler.number_lines
+
+end

data/lib/universal_pipe_handler/cmdlets/open_in_browser.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/open_in_browser.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_open_in_browser
+  # ========================================================================= #
+  def self.cmdlet_open_in_browser(i = result?)
+    if i.is_a? Array
+      i.compact! # Get rid of nil values.
+    end
+    if i.empty? && @img_file
+      i = @img_file.to_a
+    elsif i.empty?
+      i = result?
+    end
+    i << @file if i.empty? && ! @file.nil?
+    i = [i] if i.is_a? String
+    # ======================================================================= #
+    # Next, iterate over our Array. (That also means that we expect an
+    # Array here.)
+    # ======================================================================= #
+    if i.is_a? Array # if the input is an array
+      if i.empty?
+        e 'Can not open anything as the input was empty.'
+      else
+        i.each { |entry|
+          @display_the_result = false # Don't show this on the commandline.
+          sys_cmd = 'firefox -new-tab "'+entry+'"'
+          system(sys_cmd)
+        }
+      end
+    end
+  end; self.instance_eval { alias open_in_browser cmdlet_open_in_browser } # === UniversalPipeHandler.open_in_browser
+
+end

data/lib/universal_pipe_handler/cmdlets/pad_left.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/pad_left.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_pad_left
+  # ========================================================================= #
+  def self.cmdlet_pad_left(
+      default_n_pad_to_use = 2
+    )
+    pad = ' ' * default_n_pad_to_use.to_i
+    set_result(result?.map { |_| pad+_ }) # Apply the padding on each element.
+    return result?
+  end; self.instance_eval { alias pad_left cmdlet_pad_left } # === UniversalPipeHandler.pad_left
+
+end

data/lib/universal_pipe_handler/cmdlets/pad_right.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/pad_right.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_pad_right
+  # ========================================================================= #
+  def self.cmdlet_pad_right(
+      default_n_pad_to_use = 2
+    )
+    pad = ' ' * default_n_pad_to_use.to_i
+    set_result(result?.map { |_| _+pad })
+    return result?
+  end; self.instance_eval { alias pad_right cmdlet_pad_right } # === UniversalPipeHandler.pad_right
+
+end

data/lib/universal_pipe_handler/cmdlets/play.rb

@@ -0,0 +1,18 @@
+class Pipe
+
+  # ========================================================================= #
+  # === action_play
+  #
+  # Using set_result() in this method does not seem to make a lot of
+  # sense, so we won't do so.
+  # ========================================================================= #
+  def action_play(this_file = result?)
+    if this_file.is_a? Array
+      this_file.each {|entry| action_play(entry) }
+    else
+      use_this_command_to_play_video_files = 'mplayer -vo x11 -zoom '
+      esystem use_this_command_to_play_video_files+this_file
+    end
+  end
+
+end

data/lib/universal_pipe_handler/cmdlets/position.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/position.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_position
+  #
+  # We smply assign to position in a stream (video or audio), then
+  # return the original result unaltered.
+  # ========================================================================= #
+  def self.cmdlet_position(i)
+    set_position(i)
+    set_result(i)
+    result?
+  end; self.instance_eval { alias position cmdlet_position } # === UniversalPipeHandler.position
+
+end

data/lib/universal_pipe_handler/cmdlets/processes.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/processes.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_processes
+  #
+  # Show the processes on Linux.
+  # ========================================================================= #
+  def self.cmdlet_processes?
+    set_result `ps ax`
+  end; self.instance_eval { alias processes? cmdlet_processes? } # === UniversalPipeHandler.processes?
+
+end

data/lib/universal_pipe_handler/cmdlets/random.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/random.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_random
+  #
+  # Obtain a (one) random entry from @result.
+  #
+  # This is also equivalent to random_line.
+  # ========================================================================= #
+  def self.cmdlet_random(i = result?)
+    set_result(i.sample)
+    return result?
+  end; self.instance_eval { alias random cmdlet_random } # === UniversalPipeHandler.random
+  
+end

data/lib/universal_pipe_handler/cmdlets/random_video.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/random_video.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_random_video
+  #
+  # This method will return a random from the current directory.
+  # ========================================================================= #
+  def self.cmdlet_random_video(
+      from_this_dir = ("#{Dir.pwd}/").squeeze('/')
+    )
+    files = Dir[from_this_dir+'*']
+    files.select! {|entry| is_a_video_file?(entry) }
+    set_result(files.sample)
+    return result?
+  end; self.instance_eval { alias random_video cmdlet_random_video } # === UniversalPipeHandler.random_video
+
+end

data/lib/universal_pipe_handler/cmdlets/read_file.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/read_file.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_read_file
+  #
+  # If we input a number as argument this_file, then we assume that
+  # we want to fetch a file at this position, i.e. if "3" then this 
+  # translates to the third file in the directory.
+  # ========================================================================= #
+  def self.cmdlet_read_file(
+      this_file = result?
+    )
+    this_file = this_file.first if this_file.is_a? Array
+    if this_file =~ /\d+/
+      this_file = Dir['*'].sort[ this_file.to_i - 1 ] # Sort the entries first, then access one of them.
+    end
+    this_file = this_file.to_s
+    if File.exist? this_file
+      if File.directory? this_file # If it is a dir, we read in the words combined  from all files in that dir.
+        _ = this_file
+        _ << '/' unless _.end_with? '/'
+        _ << '*'
+        array_of_files = Dir[_].reject {|x| File.directory?(x)}
+        _ = [] # reassign the throwaway variable.
+        array_of_files.each { |file| _ << File.readlines(file).flatten }
+        set_result _.flatten
+      else
+        set_result File.readlines(this_file)
+      end
+    else # Else the file does not exist.
+      e 'File `'+sfile(this_file)+'` does not exist, '+
+        'thus we can not read its content.'
+      set_result nil
+    end
+    return result?
+  end; self.instance_eval { alias read_file cmdlet_read_file } # === UniversalPipeHandler.read_file
+
+end

data/lib/universal_pipe_handler/cmdlets/read_line.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/read_line.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_read_line
+  #  
+  # This is the cmdlet that will read in a file.
+  # ========================================================================= # 
+  def self.cmdlet_read_line(this_line_number = 1)
+    _ = result?
+    _ = _.join if _.is_a? Array # Work with a copy.
+    if _.empty? # assume a problem here.
+      _ = this_line_number
+      this_line_number = 0
+    elsif this_line_number == 'last' # special keyword. Pass through for now. We handle it later.
+    else # Default.
+      this_line_number = this_line_number.to_i.abs
+    end
+    _ = File.readlines(_)
+    if this_line_number == 'last'
+      this_line_number = _.size
+    end
+    set_result _[this_line_number - 1]
+  end; self.instance_eval { alias read_line cmdlet_read_line } # === UniversalPipeHandler.read_line
+
+end

data/lib/universal_pipe_handler/cmdlets/read_n_lines.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'universal_pipe_handler/cmdlets/read_n_lines.rb'
+# =========================================================================== #
+module UniversalPipeHandler
+
+  # ========================================================================= #
+  # === UniversalPipeHandler.cmdlet_read_n_lines
+  #
+  # To manually test this method, do:
+  #
+  #    File.readlines('/Depot/Information/Confree_Images.html')[0..20]
+  #
+  # ========================================================================= #
+  def self.cmdlet_read_n_lines(
+      n_lines_to_read = 50,
+      optional_file   = nil
+    )
+    if n_lines_to_read.is_a? Array
+      if n_lines_to_read.size > 1
+        optional_file   = n_lines_to_read.pop # Eliminate the last entry.
+        n_lines_to_read = n_lines_to_read.first
+      else
+        n_lines_to_read = n_lines_to_read.first
+      end
+    end
+    n_lines_to_read = n_lines_to_read.to_i.abs
+    if optional_file
+      _ = action_read_file(optional_file)
+    else
+      _ = result? #.split(N)
+    end
+    set_result(_[0 .. (n_lines_to_read-1)])
+  end; self.instance_eval { alias read_n_lines cmdlet_read_n_lines } # === UniversalPipeHandler.read_n_lines
+  
+end