rcfiles 1.2.46

data/lib/rcfiles/class/initialize.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/class/initialize.rb'
+# =========================================================================== #
+module Rcfiles
+
+class Rcfiles # === Rcfiles::Rcfiles
+
+  # ========================================================================== #
+  # === initialize
+  # ========================================================================== #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    register_sigint
+    reset
+    set_commandline_arguments(i)
+    if i
+      set_generate_this(i)
+    end
+    # ======================================================================= #
+    # === Handle blocks next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Hash
+        if yielded.has_key? :be_verbose
+          @be_verbose = yielded.delete(:be_verbose)
+        end
+        if yielded.has_key? :use_colours
+          use_colours = yielded.delete(:use_colours)
+          if use_colours == false
+            disable_colours
+          end
+        end
+      else # else it is not a Hash
+        case yielded
+        # =================================================================== #
+        # === :initialize_main_hash
+        # =================================================================== #
+        when :initialize_main_hash
+          initialize_main_hash
+        # =================================================================== #
+        # === :disable_colours
+        #
+        # The block-argument :disable_colours will disable
+        # colours for the current run.
+        # =================================================================== #
+        when :disable_colours,
+             :no_colours,
+             :toggle,
+             :c
+          disable_colours
+        # === :be_quiet
+        when :be_quiet
+          @be_verbose = false
+        end
+      end
+    end
+    run if run_already
+  end
+
+end; end

data/lib/rcfiles/class/misc.rb

@@ -0,0 +1,300 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/class/misc.rb'
+# =========================================================================== #
+require 'rcfiles/constants/constants.rb'
+require 'rcfiles/class/initialize.rb'
+require 'rcfiles/class/colours.rb'
+require 'rcfiles/class/reset.rb'
+require 'rcfiles/class/run.rb'
+require 'rcfiles/version/version.rb'
+
+module Rcfiles
+
+class Rcfiles # === Rcfiles::Rcfiles
+
+  require 'rcfiles/toplevel_methods/e.rb'
+  require 'rcfiles/toplevel_methods/misc.rb'
+  require 'rcfiles/toplevel_methods/save_file.rb'
+  require 'rcfiles/toplevel_methods/return_standard_header.rb'
+  require 'rcfiles/toplevel_methods/remove_newlines.rb'
+  require 'rcfiles/toplevel_methods/use_quotes.rb'
+
+  # ========================================================================= #
+  # === do_not_use_quotes
+  # ========================================================================= #
+  def do_not_use_quotes
+    ::Rcfiles.use_quotes = false
+  end; alias disable_quotes do_not_use_quotes # === disable_quotes
+
+  # ========================================================================= #
+  # === use_quotes?
+  # ========================================================================= #
+  def use_quotes?
+    ::Rcfiles.use_quotes?
+  end
+
+  # ========================================================================== #
+  # === set_commandline_arguments
+  # ========================================================================== #
+  def set_commandline_arguments(i)
+    @commandline_arguments = [i].flatten.compact
+  end
+
+  # ========================================================================== #
+  # === register_sigint
+  # ========================================================================== #
+  def register_sigint
+    Signal.trap('SIGINT') { exit }
+  end
+
+  # ========================================================================= #
+  # === mkdir
+  # ========================================================================= #
+  def mkdir(i)
+    FileUtils.mkdir(i)
+  end; alias create_directory mkdir # === create_directory
+
+  # ========================================================================= #
+  # === remove_newlines
+  # ========================================================================= #
+  def remove_newlines(i)
+    ::Rcfiles.remove_newlines(i)
+  end
+
+  # ========================================================================= #
+  # === remove_file
+  # ========================================================================= #
+  def remove_file(i) # rm tag, remove tag.
+    FileUtils.rm(i) if File.exist?(i)
+  end
+
+  # ========================================================================= #
+  # === create_file
+  # ========================================================================= #
+  def create_file(i) # This will create a file.
+    opnn; e "Now creating the file `#{sfile(i)}`."
+    FileUtils.touch(i)
+  end
+
+  # ========================================================================== #
+  # === set_current_date
+  # ========================================================================== #
+  def set_current_date
+    @current_date = Time.now.strftime '%d.%m.%Y'
+  end
+
+  # ========================================================================= #
+  # === get_files_from
+  # ========================================================================= #
+  def get_files_from(i = Dir.pwd)
+    return Dir["#{i}*.yml"]
+  end; alias get_files get_files_from # === get_files
+
+  # ========================================================================== #
+  # === return_standard_header
+  #
+  # This adds a standard header to our RC-File in question.
+  #
+  # The input argument should be the name of the rc-file at hand.
+  # ========================================================================== #
+  def return_standard_header(which_file = '')
+    ::Rcfiles.return_standard_header(which_file)
+  end; alias add_header return_standard_header # === add_header
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === do_be_silent
+  # ========================================================================= #
+  def do_be_silent
+    @be_verbose = false
+  end
+
+  # ========================================================================= #
+  # === check_whether_rcfiles_directory_exists
+  #
+  # This method will check whether the rcfiles-directory exists. If it
+  # does not, then we will create these directories.
+  # ========================================================================= #
+  def check_whether_rcfiles_directory_exists(
+      i = @create_rcfiles_where
+    )
+    unless File.directory? i
+      mkdir(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === e                                                             (e tag)
+  # ========================================================================= #
+  def e(i = '')
+    ::Rcfiles.e(i)
+  end
+
+  # ========================================================================= #
+  # === set_generate_this
+  #
+  # The default setting is to generate all the various rc-files.
+  # ========================================================================= #
+  def set_generate_this(i = :default)
+    if i.is_a? Array
+      i = i.first
+    elsif i.is_a? Hash
+      if i.has_key? :store_at
+        set_create_rcfiles_where(i.delete(:store_at))
+        i = :default 
+      end
+    end
+    case i
+    # ======================================================================= #
+    # === cd_aliases
+    # ======================================================================= #
+    when 'cd_aliases',
+         :cd_aliases
+      set_dataset(
+        ::Rcfiles.cd_aliases?
+      )
+    when :default # :default is an alias towards :all
+      i = :all # This is the default.
+    else
+      # if File.exist? i.to_s
+      # pass through for now
+      # end
+    end
+    @generate_this = i
+  end
+
+  # ========================================================================= #
+  # === determine_rc_file  
+  # ========================================================================= #
+  def determine_rc_file(i) 
+    "#{@create_rcfiles_where}#{File.basename(i).sub(/\.yml$/,'')}_rc".dup
+  end
+
+  # ========================================================================= #
+  # === set_dataset
+  #
+  # Determine the dataset, that is, the yaml files to be used, here.
+  # ========================================================================= #
+  def set_dataset(
+      i = nil
+    )
+    if i
+      if i.is_a? Array
+        i.flatten!
+        i.uniq!
+      end
+    end
+    @dataset = i
+  end
+
+  # ========================================================================= #
+  # === replace_newlines
+  # ========================================================================= #
+  def replace_newlines(
+      i, replace_with_this_character = ':'
+    )
+    if replace_with_this_character.is_a? Hash
+      if replace_with_this_character.has_key? :with
+        replace_with_this_character = replace_with_this_character[:with]
+      end
+    end
+    return i.gsub(/ /, replace_with_this_character).
+             gsub(/\n/, replace_with_this_character).
+             gsub(/#{replace_with_this_character}#{replace_with_this_character}/,
+               replace_with_this_character
+             )
+  end
+
+  # ========================================================================= #
+  # === generate_ps1_rcfile
+  # ========================================================================= #
+  def generate_ps1_rcfile
+    ::Rcfiles.generate_ps1_rcfile
+  end
+
+  # ========================================================================= #
+  # === generate_ls_colours_rcfile
+  # ========================================================================= #
+  def generate_ls_colours_rcfile
+    ::Rcfiles.generate_ls_colours_rcfile
+  end
+
+  # ========================================================================= #
+  # === generate_custom_roebe_rcfiles
+  # ========================================================================= #
+  def generate_custom_roebe_rcfiles
+    ::Rcfiles.generate_custom_roebe_rcfiles
+  end
+
+  # ========================================================================= #
+  # === clear_dataset
+  # ========================================================================= #
+  def clear_dataset # Use this method to clear our main dataset.
+    @dataset = [] # Our main Array - it will contain entries such as "lang.yml".
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(
+      i = NAMESPACE
+    )
+    if i.is_a? String
+      i = { namespace: i }
+    end
+    Opn.opn(i) {{ use_colours: use_colours? }}
+  end
+
+  # ========================================================================= #
+  # === generate_the_most_important_rcfiles
+  # ========================================================================= #
+  def generate_the_most_important_rcfiles
+    ::Rcfiles.generate_the_most_important_rcfiles
+  end
+
+  # ========================================================================= #
+  # === set_create_rcfiles_where
+  #
+  # Where to store the rc-files. Usually this will be at /AUTOGENERATED
+  # but we need a way to also specify other target-directories, so this
+  # method has to exist.
+  #
+  # Invoke this like so:
+  #
+  #   _.create_here :my_home_directory
+  #
+  # ========================================================================= #
+  def set_create_rcfiles_where(
+      i = CREATE_RCFILES_WHERE
+    )
+    case i
+    when :my_home_directory,
+         :home
+      i = AUTOGENERATED_RC_FILES
+    end
+    i << '/' unless i.end_with? '/' # Ensure trailing '/' token.
+    @create_rcfiles_where = i
+  end; alias create_here set_create_rcfiles_where # === create_here
+
+  # ========================================================================= #
+  # === store_what_into
+  # ========================================================================= #
+  def store_what_into(
+      store_this_data, where
+    )
+    if @be_verbose
+      opnn; e "Storing into -> #{sfile(where)}."
+    end
+    write_what_into_file(store_this_data.chomp, where)
+  end
+
+end; end

data/lib/rcfiles/class/rcfiles.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Rcfiles::Rcfiles
+#
+# This class is able to generate the various rc-files that can also be
+# generated via the toplevel-module code as-is.
+#
+# rc-files in this context refers to files that can be used by shells,
+# such as bash or zsh.
+#
+# The format of these rc-files can differ from one another:
+#
+#   - some variables can be exported, such as in:
+#
+#       export CLFAGS="-Werror"
+#
+#   - some other variables are held in a "foo:bla:ble" schemata,
+#     for instance the $PATH variable.
+#
+# Usage examples:
+#   Rcfiles::Rcfiles.new
+# =========================================================================== #
+# require 'rcfiles/class/rcfiles.rb'
+# =========================================================================== #
+require 'rcfiles/class/misc.rb'
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles::Rcfiles.new(ARGV)
+end

data/lib/rcfiles/class/reset.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/class/reset.rb'
+# =========================================================================== #
+module Rcfiles
+
+class Rcfiles
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # By default this class will be verbose, aka it will "output its
+    # findings to the end user".
+    # ======================================================================= #
+    @be_verbose = true
+    set_create_rcfiles_where # Define where to store the rc-files.
+    set_current_date
+    clear_dataset
+    set_dataset
+  end
+
+end; end

data/lib/rcfiles/class/run.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Rcfiles
+
+class Rcfiles
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    check_whether_rcfiles_directory_exists
+    generate_the_most_important_rcfiles
+  end
+
+end; end

data/lib/rcfiles/colours/colours.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/colours/colours.rb'
+# =========================================================================== #
+module Rcfiles
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === @use_colours
+  #
+  # Note that this will only TRY to use colours; the actual USING of
+  # colours depends on the availability of the gem called "colours".
+  # ========================================================================= #
+  @use_colours = true
+
+  # ========================================================================= #
+  # === Rcfiles.rev
+  # ========================================================================= #
+  def self.rev
+    if @use_colours
+      return ::Colours.rev
+    else
+      return ''
+    end
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.use_colours?
+  # ========================================================================= #
+  def self.use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.enable_colours
+  # ========================================================================= #
+  def self.enable_colours
+    @use_colours = true
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.disable_colours
+  # ========================================================================= #
+  def self.disable_colours
+    @use_colours = false
+  end; self.instance_eval { alias no_colours disable_colours } # === Rcfiles.no_colours 
+
+  # ========================================================================= #
+  # === Rcfiles.sdir
+  # ========================================================================= #
+  def self.sdir(
+      i = '', use_colours = @use_colours
+    )
+    if use_colours and Object.const_defined?(:Colours)
+      return ::Colours.sdir(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.sfancy
+  # ========================================================================= #
+  def self.sfancy(i = '')
+    if @use_colours and Object.const_defined?(:Colours)
+      return ::Colours.sfancy(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.simp
+  # ========================================================================= #
+  def self.simp(
+      i = '', use_colours = @use_colours
+    )
+    if use_colours and Object.const_defined?(:Colours)
+      return ::Colours.simp(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.teal
+  # ========================================================================= #
+  def self.teal(i = '')
+    if @use_colours and Object.const_defined?(:Colours) and
+       Colours.respond_to?(:teal)
+      return ::Colours.teal(i)
+    else
+      i
+    end
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.sfile
+  # ========================================================================= #
+  def self.sfile(i = '')
+    if @use_colours and Object.const_defined?(:Colours) and
+       Colours.respond_to?(:sfile)
+      return ::Colours.sfile(i)
+    else
+      i
+    end
+  end
+
+end