rcfiles 1.1.1137

data/lib/rcfiles/toplevel_methods/change_directory.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/change_directory.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.change_directory
+  # ========================================================================= #
+  def self.change_directory(i)
+    Dir.chdir(i) if File.directory? i
+  end; self.instance_eval { alias cd change_directory } # === Rcfiles.cd
+
+end

data/lib/rcfiles/toplevel_methods/convert.rb

@@ -0,0 +1,118 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file contains code that can convert a .yml file into a bash
+# rcfile, either using "alias" or "export" statements.
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/convert.rb'
+# Rcfiles.convert_this_hash_to_export_file
+# =========================================================================== #
+require 'rcfiles/toplevel_methods/remove_newlines.rb'
+require 'rcfiles/toplevel_methods/use_quotes.rb'
+require 'rcfiles/constants/encodings.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.convert_this_hash_to_alias_file
+  #
+  # This method expects a Hash as input.
+  # ========================================================================= #
+  def self.convert_this_hash_to_alias_file(
+      hash
+    )
+    _ = ''.dup # <- Our return String.
+    hash.each_pair {|key, value|
+      value = remove_newlines(value.to_s.strip)
+      if @use_quotes 
+        _ << "alias '#{key}'=\"#{value}\"#{N}"
+      else
+        _ << "alias #{key}=#{value}#{N}"
+      end
+    } if hash
+    return _
+  end; self.instance_eval { alias convert_hash_to_alias_file convert_this_hash_to_alias_file } # === Rcfiles.convert_hash_to_alias_file
+
+  # ========================================================================= #
+  # === Rcfiles.convert_this_array_to_export_file
+  #
+  # This method expects an Array as input.
+  #
+  # Arrays are handled a bit differently, though - they will be aggregated
+  # into one input value for "export".
+  # ========================================================================= #
+  def self.convert_this_array_to_export_file(
+      array,
+      optional_second_input_as_name_of_the_export_variable = 'PKG_CONFIG_PATH'
+    )
+    if array and array.is_a?(Array)
+      _ = ''.dup # <- Our return String.
+      joined = array.join(':').strip
+      _ << "export #{optional_second_input_as_name_of_the_export_variable}=\"#{joined}\"#{N}"
+      return _
+    else
+      array
+    end
+  end; self.instance_eval { alias convert_array_to_export_file convert_this_array_to_export_file } # === Rcfiles.convert_array_to_export_file
+
+  # ========================================================================= #
+  # === Rcfiles.convert_this_input_to_export_file
+  # ========================================================================= #
+  def self.convert_this_input_to_export_file(
+      i, optional_second_input_as_name_of_the_export_variable = nil
+    )
+    case i
+    when Hash
+      # ===================================================================== #
+      # Hashes will ignore the optional second argument to this method, even
+      # if it has been provided. The reason is primarily because we expect
+      # a key -> value entry of a Hash already, so the kew is known; whereas
+      # for an Array, we actually need the user to supply the name of the
+      # key at hand.
+      # ===================================================================== #
+      convert_this_hash_to_export_file(i)
+    when Array
+      convert_this_array_to_export_file(i, optional_second_input_as_name_of_the_export_variable)
+    when String
+      convert_this_array_to_export_file([i], optional_second_input_as_name_of_the_export_variable)
+    else
+      e "Unregistered input-class (#{i.class})"
+    end
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.convert_this_hash_to_export_file
+  #
+  # This method expects a Hash as input. If you need a bit more flexibility
+  # then you are encouraged to use the other method, called
+  # Rcfiles.convert_this_input_to_export_file() instead.
+  # ========================================================================= #
+  def self.convert_this_hash_to_export_file(
+      hash,
+      ensure_proper_encoding = false
+    )
+    case ensure_proper_encoding
+    when :ensure_proper_encoding
+      ensure_proper_encoding = true
+    end
+    _ = ''.dup # <- Our return String.
+    hash.each_pair {|key, value|
+      value = value.to_s.strip
+      if ensure_proper_encoding
+        value = ensure_proper_encoding_for(value)
+        key   = ensure_proper_encoding_for(value)
+      end
+      value = value.tr("\n", ' ').squeeze(' ')
+      _ << "export #{key}=\"#{value}\"#{N}"
+    } if hash
+    return _
+  end; self.instance_eval { alias convert_hash_to_export_file convert_this_hash_to_export_file } # === Rcfiles.convert_hash_to_export_file
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.convert_this_hash_to_export_file(
+    { cat: :tom, mouse: :jerry }
+  )
+end

data/lib/rcfiles/toplevel_methods/create_windows_cd_aliases_bat_file.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/create_windows_cd_aliases_bat_file.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/files/file_cd_aliases.rb'
+  require 'rcfiles/toplevel_methods/e.rb'
+  require 'rcfiles/toplevel_methods/save_file.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.create_windows_cd_aliases_bat_file
+  # ========================================================================= #
+  def self.create_windows_cd_aliases_bat_file
+    _ = ::Rcfiles.file_cd_aliases?
+    if File.exist? _
+      require 'yaml'
+      dataset = YAML.load_file(_)
+      _ = ''.dup
+      begin
+        require 'convert_global_env'
+      rescue LoadError; end
+      dataset.each_pair {|key, value|
+        # =================================================================== #
+        # value may contain a $, such as in $MAIN_WORK.
+        # If this is the case then we will as ConvertGlobalEnv[]
+        # to translate this for us.
+        # =================================================================== #
+        if value.include? '$'
+          value = ConvertGlobalEnv[value]
+        end
+        _ << 'function '+key.to_s+' { set-location "'+value.to_s+'" }'+N
+      }
+      # ===================================================================== #
+      # Now we can simply store this String into a file.
+      # ===================================================================== #
+      into = 'cd_aliases.bat'
+      e 'Storing into the file '+into+' next.'
+      write_what_into(_, into)
+    else
+      e 'No file exists at '+_+'.'
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.create_windows_cd_aliases_bat_file  
+end # rb create_windows_cd_aliases_bat_file.rb

data/lib/rcfiles/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/e.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/rcfiles/toplevel_methods/esystem.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/esystem.rb'
+# =========================================================================== #
+require 'rcfiles/toplevel_methods/e.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.esystem
+  # ========================================================================= #
+  def self.esystem(i)
+    e i
+    system i
+  end
+
+end

data/lib/rcfiles/toplevel_methods/generate_yaml_files.rb

@@ -0,0 +1,148 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Rcfiles.generate_yaml_files
+#
+# This file will generate .yml files that will conform to UTF8 by default.
+#
+# Usage example:
+#
+#   Rcfiles.generate_yaml_files
+#
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/generate_yaml_files.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'fileutils'
+  require 'rcfiles/files/file_cd_aliases.rb'
+  require 'rcfiles/files/file_aliases.rb'
+  require 'rcfiles/files/file_programs_aliases.rb'
+  require 'rcfiles/constants/encodings.rb'
+  require 'rcfiles/toplevel_methods/e.rb'
+  require 'rcfiles/toplevel_methods/esystem.rb'
+  require 'rcfiles/toplevel_methods/save_file.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.generate_yaml_files
+  #
+  # The main idea behind this method is to be able to work with UTF8
+  # encoded files.
+  # ========================================================================= #
+  def self.generate_yaml_files(
+      use_this_encoding = :utf8
+    )
+    require 'yaml'
+    # ======================================================================= #
+    # === Handle the file 'cd_aliases.yml' next
+    # ======================================================================= #
+    _ = file_cd_aliases?
+    if File.exist? _
+      string = ''.dup
+      begin
+        dataset_hash = YAML.load_file(_)
+        dataset_hash.each_pair {|key, value|
+          key   = ensure_main_encoding(key.to_s,   use_this_encoding)
+          value = ensure_main_encoding(value.to_s, use_this_encoding)
+          unless key.start_with? '"'
+            key = "\"#{key}\""
+          end
+          unless value.start_with? '"'
+            value = "\"#{value}\""
+          end
+          key   = ensure_main_encoding(key.to_s,   use_this_encoding)
+          value = ensure_main_encoding(value.to_s, use_this_encoding)
+          string << "#{key}: #{value}\n"
+        }
+        what = string
+        target_file = '/Depot/'+File.basename(_)
+        new_target_file = '/Depot/'+File.basename(_).sub(/\.#{File.extname(_)}$/,'')+'2.yml'
+        e 'Will store into the file `'+target_file+'`.'  
+        write_what_into(what, target_file)
+        system 'iconv -f ISO-8859-1 -t UTF-8 '+target_file+' >> '+new_target_file
+        File.delete(target_file)
+        FileUtils.mv(new_target_file, target_file)
+      rescue ArgumentError => error
+        pp error
+      end
+    else
+      e 'No file could be found at `'+_+'`.'
+    end
+    # ======================================================================= #
+    # === Handle the file 'aliases.yml' next
+    # ======================================================================= #
+    _ = file_aliases?
+    if File.exist? _
+      string = ''.dup
+      begin
+        dataset_hash = YAML.load_file(_)
+        dataset_hash.each_pair {|key, value|
+          key   = ensure_main_encoding(key.to_s,   use_this_encoding)
+          value = ensure_main_encoding(value.to_s, use_this_encoding)
+          unless key.start_with? '"'
+            key = "\"#{key}\""
+          end
+          unless value.start_with? '"'
+            value = "\"#{value}\""
+          end
+          key   = ensure_main_encoding(key.to_s,   use_this_encoding)
+          value = ensure_main_encoding(value.to_s, use_this_encoding)
+          string << "#{key}: #{value}\n"
+        }
+        what = string
+        target_file = "/Depot/#{File.basename(_)}"
+        new_target_file = '/Depot/'+File.basename(_).sub(/\.#{File.extname(_)}$/,'')+'2.yml'
+        e 'Will store into the file `'+target_file+'`.'  
+        write_what_into(what, target_file)
+        system 'iconv -f ISO-8859-1 -t UTF-8 '+target_file+' >> '+new_target_file
+        File.delete(target_file)
+        FileUtils.mv(new_target_file, target_file)
+      rescue ArgumentError => error
+        pp error
+      end
+    else
+      e 'No file could be found at `'+_+'`.'
+    end
+    # ======================================================================= #
+    # === Handle the file 'programs_aliases.yml' next
+    # ======================================================================= #
+    _ = file_programs_aliases?
+    if File.exist? _
+      string = ''.dup
+      begin
+        dataset_hash = YAML.load_file(_)
+        dataset_hash.each_pair {|key, value|
+          key   = ensure_main_encoding(key.to_s,   use_this_encoding)
+          value = ensure_main_encoding(value.to_s, use_this_encoding)
+          unless key.start_with? '"'
+            key = "\"#{key}\""
+          end
+          unless value.start_with? '"'
+            value = "\"#{value}\""
+          end
+          key   = ensure_main_encoding(key.to_s,   use_this_encoding)
+          value = ensure_main_encoding(value.to_s, use_this_encoding)
+          string << "#{key}: #{value}\n"
+        }
+        what = string
+        target_file = '/Depot/'+File.basename(_)
+        new_target_file = '/Depot/'+File.basename(_).sub(/\.#{File.extname(_)}$/,'')+'2.yml'
+        e 'Will store into the file `'+target_file+'`.'  
+        write_what_into(what, target_file)
+        system 'iconv -f ISO-8859-1 -t UTF-8 '+target_file+' >> '+new_target_file
+        File.delete(target_file)
+        FileUtils.mv(new_target_file, target_file)
+      rescue ArgumentError => error
+        pp error
+      end
+    else
+      e "No file could be found at `#{_}`."
+    end
+  end; self.instance_eval { alias syck_generate generate_yaml_files } # === Rcfiles.syck_generate
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.generate_yaml_files  
+end

data/lib/rcfiles/toplevel_methods/infer.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/infer.rb'
+# =========================================================================== #
+require 'rcfiles/toplevel_methods/e.rb'
+require 'rcfiles/toplevel_methods/main_directory.rb'
+require 'rcfiles/files/file_aliases.rb'
+require 'rcfiles/files/file_cd_aliases.rb'
+require 'rcfiles/files/file_programs_aliases.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.infer
+  #
+  # This method can be used to automatically infer, based on the input,
+  # what we may wish to do - in particular setting the path to one
+  # of the three major alias-groups of the Rcfiles project.
+  #
+  # For example, take the following API:
+  #
+  #   Rcfiles.infer 'programs_aliases.yml'
+  #
+  # which will be translated into the following, longer variant:
+  #
+  #   Rcfiles.set_programs_aliases(File.absolute_path('programs_aliases.yml'))
+  #
+  # As you can see, the first variant is significantly shorter to use. The
+  # trailing '.yml' part can be omitted as well, so the following is
+  # also possible:
+  #
+  #   Rcfiles.infer 'programs_aliases.yml'
+  #
+  # Generic usage examples:
+  #
+  #   Rcfiles.infer 'aliases.yml'          # => "/Depot/j/aliases.yml"
+  #   Rcfiles.infer 'cd_aliases.yml'       # => "/Depot/j/cd_aliases.yml"
+  #   Rcfiles.infer 'programs_aliases.yml' # => "/Depot/j/programs_aliases.yml"
+  #   Rcfiles.infer 'system_settings.yml'  # => "/Depot/j/system_settings.yml"
+  #
+  # ========================================================================= #
+  def self.infer(
+      i = 'programs_aliases'
+    )
+    if i.is_a? String
+      i = i.dup if i.frozen?
+      i << '.yml' unless i.end_with? '.yml' # Append the '.yml' substring in this case.
+    end
+    case i
+    # ======================================================================= #
+    # === system_settings.yml
+    # ======================================================================= #
+    when /system_?settings\.yml$/
+      set_file_aliases(
+        File.absolute_path(i)
+      )
+    # ======================================================================= #
+    # === aliases.yml
+    # ======================================================================= #
+    when /aliases\.yml$/
+      set_file_aliases(
+        File.absolute_path(i)
+      )
+    # ======================================================================= #
+    # === cd_aliases.yml
+    # ======================================================================= #
+    when /cd_?aliases\.yml$/
+      set_cd_aliases(
+        File.absolute_path(i)
+      )
+    # ======================================================================= #
+    # === programs_aliases.yml
+    # ======================================================================= #
+    when /programs_?aliases\.yml$/
+      set_programs_aliases(
+        File.absolute_path(i)
+      )
+    end
+  end
+
+end