rcfiles 1.1.1137

data/lib/rcfiles/toplevel_methods/no_file_exists_at.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/no_file_exists_at.rb'
+# =========================================================================== #
+require 'rcfiles/colours/colours.rb'
+require 'rcfiles/toplevel_methods/e.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.no_file_exists_at
+  # ========================================================================= #
+  def self.no_file_exists_at(i)
+    e "No file exists at `#{sfile(i)}`."
+  end
+
+end

data/lib/rcfiles/toplevel_methods/notifications.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The purpose of this file is to bundle code that can be used to notify
+# the user, for example, when a file is generated. Before this file was
+# created there was a lot of redundancy in different files; now we have
+# unified this under this new .rb file here (November 2019:
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/notifications.rb'
+# =========================================================================== #
+require 'yaml'
+require 'rcfiles/colours/colours.rb'
+require 'rcfiles/toplevel_methods/main_directory.rb'
+require 'rcfiles/toplevel_methods/no_file_exists_at.rb'
+require 'rcfiles/toplevel_methods/return_standard_header.rb'
+
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.notify_the_user_that_this_file_will_be_generated_from_that_existing_file
+  #
+  # This method only notifies the user. It does not generate any file on
+  # its own.
+  # ========================================================================= #
+  def self.notify_the_user_that_this_file_will_be_generated_from_that_existing_file(
+      this_file, that_existing_file
+    )
+    e "#{rev}Now generating `#{sfile(this_file)}`, from "
+    e "#{sfile(that_existing_file)}."
+  end
+
+end

data/lib/rcfiles/toplevel_methods/rds.rb

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

data/lib/rcfiles/toplevel_methods/remove_newlines.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/remove_newlines.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.remove_newlines
+  #
+  # This method will remove all newlines of the given input. The given
+  # input is the first argument to this method.
+  #
+  # The optional second input to this method can be used to also ensure
+  # that a proper encoding is used.
+  # ========================================================================= #
+  def self.remove_newlines(
+      i,
+      ensure_this_encoding = nil # 'ISO-8859-1' # <- or nil.
+    )
+    if ensure_this_encoding
+      i = i.force_encoding(ensure_this_encoding)
+    end
+    i.delete!("\n") if i.include?("\n")
+    return i
+  end
+
+end

data/lib/rcfiles/toplevel_methods/report.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/report.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/toplevel_methods/e.rb'
+  require 'rcfiles/toplevel_methods/main_directory.rb'
+  require 'rcfiles/toplevel_methods/misc.rb'
+  require 'rcfiles/colours/colours.rb'
+  require 'rcfiles/files/file_aliases.rb'
+  require 'rcfiles/files/file_cd_aliases.rb'
+  require 'rcfiles/files/file_programs_aliases.rb'
+
+  # ========================================================================= #
+  # === Rcfiles.report
+  #
+  # This method will report some information about where the Rcfiles
+  # will collect information.
+  # ========================================================================= #
+  def self.report
+    e 'The main directory is at:'
+    e
+    e "  #{sdir(main_directory?)}"
+    unless File.directory? main_directory?
+      e 'This directory could, however had, NOT be found.'
+    end
+    e
+    e 'The three main .yml aliases paths are:'
+    e
+    e '  file aliases:          '+sfile(file_aliases?)
+    unless File.exist? file_aliases?
+      e 'This file could not be found.'
+    end
+    e '  file cd aliases:       '+sfile(file_cd_aliases?)
+    unless File.exist? file_cd_aliases?
+      e 'This file could not be found.'
+    end
+    e '  file programs aliases: '+sfile(file_programs_aliases?)
+    unless File.exist? file_programs_aliases?
+      e 'This file could not be found.'
+    end
+    e
+  end
+
+end
+
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.report  
+end

data/lib/rcfiles/toplevel_methods/return_standard_header.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/return_standard_header.rb'
+# Rcfiles.return_standard_header('cd_aliases_rc')
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================== #
+  # === Rcfiles.return_standard_header
+  #
+  # This adds a standard header to our RC-File in question.
+  #
+  # The first input argument to this method should be the name of the
+  # rc-file at hand.
+  # ========================================================================== #
+  def self.return_standard_header(
+      which_file   = '',
+      current_date = Time.now.strftime('%d.%m.%Y') 
+    )
+    _ = <<-EOF
+# =========================================================================== #
+# This file was automatically generated at: #{current_date}
+#
+# The filename is:
+#
+#   #{which_file}
+#
+# =========================================================================== #
+EOF
+    return _
+  end; self.instance_eval { alias add_header       return_standard_header } # === Rcfiles.add_header
+       self.instance_eval { alias standard_header? return_standard_header } # === Rcfiles.standard_header?
+
+end

data/lib/rcfiles/toplevel_methods/run_it.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# The method in this file here is mostly a convenience-method.
+#
+# It will leverage the old setup.rb file to install a project written in
+# ruby. Of course "gem" is the more modern way to go about this, but
+# sometimes, due to various reasons, you may want to use setup.rb
+# instead, which explains why this file here has been created.
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/run_it.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === Rcfiles.run_it
+  # ========================================================================= #
+  def self.run_it(
+      optional_arguments = ARGV
+    )
+    require 'rcfiles/requires/require_the_rcfiles_project.rb'
+    require 'convert_global_env'
+    Dir.chdir(ConvertGlobalEnv['$RSRC/rcfiles/']) # cd to it.
+    begin
+      require 'roebe/toplevel_methods/setup.rb'
+      Roebe.copy_setup_file_to_pwd
+    rescue LoadError
+      puts 'Could not load the file roebe/toplevel_methods/setup.rb'
+    end
+    if File.exist? 'setup.rb'
+      system 'ruby setup.rb --quiet config'
+      system 'ruby setup.rb --quiet setup'
+      system 'ruby setup.rb --quiet install'
+      File.delete('setup.rb')       if File.exist? 'setup.rb'
+      File.delete('InstalledFiles') if File.exist? 'InstalledFiles'
+      File.delete('.config')        if File.exist? '.config'
+      ::Rcfiles[] { yield if block_given? }
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Rcfiles.run_it(ARGV)
+end # rcfile_run_it

data/lib/rcfiles/toplevel_methods/save_file.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/save_file.rb'
+# Rcfiles.write_what_into
+# =========================================================================== #
+module Rcfiles
+
+  require 'fileutils'
+
+  # ========================================================================= #
+  # === Rcfiles.write_what_into
+  #
+  # This method can be used to save data into a file.
+  # ========================================================================= #
+  def self.write_what_into(
+      what = '',
+      into = ''
+    )
+    unless File.directory? File.dirname(into)
+      FileUtils.mkdir_p(File.dirname(into))
+    end
+    File.open(into, 'w') { |file| file.write(what) }
+  end
+
+end

data/lib/rcfiles/toplevel_methods/use_psych_or_syck.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/use_psych_or_syck.rb'
+# =========================================================================== #
+module Rcfiles
+
+  require 'rcfiles/project/project.rb'
+
+  # ========================================================================= #
+  # === @use_psych_or_syck
+  # ========================================================================= #
+  @use_psych_or_syck = nil
+
+  _ = "#{project_base_directory?}yaml/use_psych_or_syck.yml"
+  if File.exist? _
+    content = File.read(_).strip.delete(':')
+    # ======================================================================= #
+    # We must check whether a ' #' is included or not. If so then we
+    # will chop it away.
+    # ======================================================================= #
+    if content.include? ' #'
+      content = content[0 .. content.index(' #')].strip
+    end
+    @use_psych_or_syck = content.to_sym
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.use_psych_or_syck?
+  # ========================================================================= #
+  def self.use_psych_or_syck?
+    @use_psych_or_syck
+  end; self.instance_eval { alias engine? use_psych_or_syck? } # === Rcfiles.engine?
+
+  # ========================================================================= #
+  # === Rcfiles.use_psych_or_syck=
+  # ========================================================================= #
+  def self.use_psych_or_syck=(i = :psych)
+    @use_psych_or_syck = i.to_sym
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.do_use_syck
+  # ========================================================================= #
+  def self.do_use_syck
+    @use_psych_or_syck = :syck
+  end
+
+end

data/lib/rcfiles/toplevel_methods/use_quotes.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/toplevel_methods/use_quotes.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === @use_quotes
+  #
+  # If the module-level instance variable @use_quotes is true then
+  # we will use double-quotes ("") when generating rc-files.
+  #
+  # By default this is set to true.
+  #
+  # Some programs, such as cmder, may get confused if quotes are used
+  # in a traditional key-value setup, such as for bash - which is
+  # precisely the reason why this .rb file here has been created. I
+  # needed to use these aliases in cmder as well.
+  # ========================================================================= #
+  @use_quotes = true
+
+  # ========================================================================= #
+  # === Rcfiles.use_quotes?
+  # ========================================================================= #
+  def self.use_quotes?
+    @use_quotes
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.use_quotes=
+  # ========================================================================= #
+  def self.use_quotes=(i)
+    @use_quotes = i
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.toggle_quotes
+  #
+  # This method can be used to toggle the use-quotes behaviour of the
+  # rcfiles project. 
+  # ========================================================================= #
+  def self.toggle_quotes
+    if @use_quotes == true
+      @use_quotes = false
+    else
+      @use_quotes = true
+    end
+  end; self.instance_eval { alias toggle toggle_quotes } # === Rcfiles.toggle
+
+  # ========================================================================= #
+  # === Rcfiles.disable_quotes
+  # ========================================================================= #
+  def self.disable_quotes
+    @use_quotes = false
+  end
+
+  # ========================================================================= #
+  # === Rcfiles.disable_quotes_then_generate_the_files
+  # ========================================================================= #
+  def self.disable_quotes_then_generate_the_files
+    disable_quotes
+    require 'rcfiles/toplevel_methods/misc.rb'
+    generate_files
+  end
+
+end

data/lib/rcfiles/toplevel_methods/verbosity.rb

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

data/lib/rcfiles/version/version.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'rcfiles/version/version.rb'
+# =========================================================================== #
+module Rcfiles
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.1.1137'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '18.01.2021'
+
+  # ========================================================================= #
+  # === Rcfiles.version?
+  # ========================================================================= #
+  def self.version?
+    VERSION
+  end
+
+end