beautiful_url 1.5.90

data/lib/beautiful_url/constants/base_constants.rb

@@ -0,0 +1,249 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/constants/base_constants.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+  # ========================================================================= #
+  # === Constants tag. 
+  #
+  # Use these constants to define the base layout of the host system.
+  #
+  # This evidently defaults to my use case, but I will try to adapt the
+  # project to be more flexible for other users as well, in the long
+  # run.
+  # ========================================================================= #
+
+  # ========================================================================= #
+  # === BASE_DIR
+  # ========================================================================= #
+  BASE_DIR = '/home/x/'
+    HOME_X = BASE_DIR # === HOME_X
+
+  # ========================================================================= #
+  # === DATA_DIR
+  #
+  # Note that the very useful convention for the constants here is to
+  # KEEP a trailing /.
+  #
+  # On my home system this will default to '/home/x/DATA/'.
+  # ========================================================================= #
+  DATA_DIR = "#{BASE_DIR}data/" # Can't use ENV here as ENV is not
+                                # always available.
+  # ========================================================================= #
+  # === MY_DATA
+  # ========================================================================= #
+  MY_DATA = DATA_DIR
+
+  # ========================================================================= #
+  # === DATA_IMAGES_ROEBE
+  # ========================================================================= #
+  DATA_IMAGES_ROEBE = "#{MY_DATA}images/roebe/"
+
+  # ========================================================================= #
+  # === MY_DATA_DIR
+  # ========================================================================= #
+  MY_DATA_DIR = DATA_DIR
+
+  # ========================================================================= #
+  # === DATA_RUBY_SRC
+  # ========================================================================= #
+  DATA_RUBY_SRC = "#{BASE_DIR}programming/ruby/src/"
+
+  # ========================================================================= #
+  # === IMG TAG
+  # ========================================================================= #  
+  IMG = "#{DATA_DIR}images/"
+
+  # ========================================================================= #
+  # === PROGL
+  # ========================================================================= #
+  PROGL                 = "#{BASE_DIR}programming/"
+    # ======================================================================= #
+    # === PROGRAMMING_LANGUAGES
+    # ======================================================================= #
+    PROGRAMMING_LANGUAGES = PROGL # Alias to the ^^^ above.
+    # ======================================================================= #
+    # === PROGRAMMING
+    # ======================================================================= #
+    PROGRAMMING           = PROGRAMMING_LANGUAGES
+
+  # ========================================================================= #
+  # === RUBY
+  #
+  # This constant refers to where I keep my ruby code.
+  # ========================================================================= #
+  RUBY                  = "#{PROGRAMMING_LANGUAGES}ruby/"
+
+  # ========================================================================= #
+  # === RUBY_SRC
+  # ========================================================================= #
+  RUBY_SRC              = "#{RUBY}src/"
+    RSRC                = RUBY_SRC
+
+  # ========================================================================= #
+  # The following constants are all relative to LOCAL_HOST
+  # ========================================================================= #
+
+  # ========================================================================= #
+  # === LHOST
+  # ========================================================================= #
+  LHOST                 = 'http://localhost/data/' # This is the LOCAL_HOST constant.
+    # ======================================================================= #
+    # === DATA
+    # ======================================================================= #
+    DATA = LHOST # An "alias" to the above ^^^.
+
+  # ========================================================================= #
+  # === SRC
+  # ========================================================================= #
+  SRC                   = "#{BASE_DIR}src"
+
+  # ========================================================================= #
+  # === PC
+  # ========================================================================= #
+  PC                    = "#{LHOST}PC/"
+
+  # ========================================================================= #
+  # === HARDWARE
+  # ========================================================================= #
+  HARDWARE              = "#{PC}hardware/"
+
+  # ========================================================================= #
+  # === PC_YAML
+  # ========================================================================= #
+  PC_YAML               = "#{PC}yaml/"
+
+  # ========================================================================= #
+  # === OS
+  # ========================================================================= #
+  OS                    = "#{PC}OS/"
+
+  # ========================================================================= #
+  # === MISC
+  # ========================================================================= #
+  MISC                  = "#{LHOST}misc/"
+
+  # ========================================================================= #
+  # === CSS
+  # ========================================================================= #
+  CSS                   = "#{LHOST}CSS/"
+
+  # ========================================================================= #
+  # === RPG
+  # ========================================================================= #
+  RPG                   = "#{LHOST}rpg/"
+
+  # ========================================================================= #
+  # === MUDS
+  # ========================================================================= #
+  MUDS                  = "#{RPG}MUDS/"
+    MUD                 = MUDS # === MUD
+
+  # ========================================================================= #
+  # === STUDIUM
+  # ========================================================================= #
+  STUDIUM               = "#{BASE_DIR}/studium/"
+
+  # ========================================================================= #
+  # === SCI
+  # ========================================================================= #
+  SCI                   = "#{LHOST}science/"
+  SCIENCE               = SCI   # Alias to the ^^^ above.
+
+  # ========================================================================= #
+  # === GAMES
+  # ========================================================================= #
+  GAMES                 = "#{LHOST}games/"
+
+  # ========================================================================= #
+  # === AUDIO
+  # ========================================================================= #
+  AUDIO                 = "#{LHOST}AUDIO/"
+
+  # ========================================================================= #
+  # === AUDIO_YAML
+  # ========================================================================= #
+  AUDIO_YAML            = "#{AUDIO}yaml/"
+
+  # ========================================================================= #
+  # === VIDEO
+  # ========================================================================= #
+  VIDEO                 = "#{LHOST}video/"
+
+  # ========================================================================= #
+  # === LINUX
+  # ========================================================================= #
+  LINUX                 = "#{PC}OS/LINUX/"
+
+  # ========================================================================= #
+  # === LINUX_YAML
+  # ========================================================================= #
+  LINUX_YAML            = "#{LINUX}yaml/"
+  
+  # ========================================================================= #
+  # === BIOINFORMATIC
+  # ========================================================================= #
+  BIOINFORMATIC         = "#{SCI}BIOINFORMATIK/"
+
+  # ========================================================================= #
+  # === BIOLANG_DIR
+  # ========================================================================= #
+  BIOLANG_DIR           = "#{SCI}BIOLOGY/"
+
+  # ========================================================================= #
+  # === RUBY_DOCUMENTATION
+  # ========================================================================= #
+  RUBY_DOCUMENTATION    = RUBY+'documentation/'
+  COOKBOOK_DIR          = PC+'COOKBOOKS/YAML/' # ALL_COOKBOOKS
+  DATABASES             = PC+'DATABASES/'
+  IRC                   = PC+'IRC/'
+  PHP                   = PROGL+'php/'
+  PERL                  = PROGL+'perl/'
+  
+  # ========================================================================= #
+  # === RUBY_SYS
+  # ========================================================================= #
+  RUBY_SYS              = RUBY_SRC+'sys/'
+  RUBY_WWW              = RUBY_SRC+'www/'
+  RUBY_TOOLS            = RUBY_SRC+'tools/'
+
+  # ========================================================================= #
+  # === RUBY_RBT
+  # ========================================================================= #
+  RUBY_RBT              = RUBY_SRC+'rbt/lib/rbt/'
+    RUBY_BT               = RUBY_RBT
+
+  # ========================================================================= #
+  # === RUBY_DIA
+  # ========================================================================= #
+  RUBY_DIA              = RUBY_SRC+'roebe/lib/roebe/shell/'
+
+  # ========================================================================= #
+  # === BEAUTIFUL_URL
+  # ========================================================================= #
+  BEAUTIFUL_URL         = RUBY_TOOLS+'beautiful_url/lib/beautiful_url/'
+  MASTER_PIPE           = "#{RUBY_SRC}pipe_handler/lib/pipe_handler/"
+
+  # ========================================================================= #
+  # === RUBY_CYBERWEB
+  # ========================================================================= #
+  RUBY_CYBERWEB         = "#{RUBY_SRC}cyberweb/lib/cyberweb/"
+    # ======================================================================= #
+    # === CYBERWEB
+    # ======================================================================= #
+    CYBERWEB              = RUBY_CYBERWEB
+
+  # ========================================================================= #
+  # === IMG_RPG
+  # ========================================================================= #
+  IMG_RPG = "#{IMG}RPG/"
+
+  # ========================================================================= #
+  # === TODO_DIRECTORY
+  # ========================================================================= #
+  TODO_DIRECTORY = "#{MY_DATA}personal/todo/"
+
+end

data/lib/beautiful_url/constants/constants.rb

@@ -0,0 +1,9 @@
+# =========================================================================== #
+# require 'beautiful_url/constants/constants.rb'
+# =========================================================================== #
+require 'beautiful_url/constants/base_constants.rb'
+require 'beautiful_url/constants/encoding.rb'
+require 'beautiful_url/constants/misc.rb'
+require 'beautiful_url/constants/newline.rb'
+require 'beautiful_url/constants/tasks.rb'
+require 'beautiful_url/constants/time.rb'

data/lib/beautiful_url/constants/encoding.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file here ensures a consistent, uniform encoding to be used
+# for the whole BeautifulUrl namespace.
+# =========================================================================== #
+# require 'beautiful_url/constants/encoding.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+  # ========================================================================= #
+  # === ENCODING_UNICODE
+  # ========================================================================= #
+  ENCODING_UNICODE = 'UTF-8'
+
+  # ========================================================================= #
+  # === ENCODING_ISO
+  # ========================================================================= #
+  ENCODING_ISO     = 'ISO-8859-1'
+
+  # ========================================================================= #
+  # === USE_THIS_ENCODING
+  #
+  # This constant specifies the main encoding to be used in the
+  # BeautifulUrl namespace.
+  # ========================================================================= #
+  USE_THIS_ENCODING = ENCODING_UNICODE
+
+  # ========================================================================= #
+  # === BeautifulUrl.ensure_main_encoding
+  #
+  # his method can be used to ensure that the same base-encoding is
+  # used, for a given String.
+  # ========================================================================= #
+  def self.ensure_main_encoding(
+      i, use_this_encoding = USE_THIS_ENCODING
+    )
+    if i.is_a? String
+      unless i.encoding.to_s.include? use_this_encoding
+        i = i.dup if i.frozen?
+        i = i.force_encoding(use_this_encoding)
+      end
+    end
+    i # Return it here anyway.
+  end
+
+end

data/lib/beautiful_url/constants/misc.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/constants/misc.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+  # ========================================================================= #
+  # === HTTP_LOCALHOST_STRING
+  # ========================================================================= #
+  HTTP_LOCALHOST_STRING = 'http://localhost/'
+
+end

data/lib/beautiful_url/constants/newline.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/constants/newline.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+end

data/lib/beautiful_url/constants/tasks.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/constants/tasks.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+  # ========================================================================= #
+  # === BeautifulUrl::YAML_FILE_TASKS
+  #
+  # We will try to load the file called "tasks.yml" but this file may
+  # be missing for various reasons - hence a File.exist? check must
+  # be done.
+  # ========================================================================= #
+  tasks = '/home/x/DATA/todo/yaml/tasks.yml' # cat $MY_DATA/todo/yaml/tasks.yml
+  if File.exist? tasks
+    require 'yaml'
+    begin
+      YAML_FILE_TASKS = YAML.load_file(tasks)
+      YFT = YAML_FILE_TASKS # alias to the above ^^^
+    rescue LoadError # Silent Rescue.
+      # puts 'The file does not exist.'
+    rescue Psych::SyntaxError => error
+      puts 'An error happened (via psych). Showing this error next:'
+      pp error
+    end
+  end
+
+end

data/lib/beautiful_url/constants/time.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/constants/time.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+  # ========================================================================= #
+  # === CURRENT_YEAR
+  # ========================================================================= #
+  CURRENT_YEAR = Time.now.year.to_s
+
+  # ========================================================================= #
+  # === BeautifulUrl.current_year?
+  # ========================================================================= #
+  def self.current_year?
+    CURRENT_YEAR
+  end
+
+end

data/lib/beautiful_url/json_generator/json_generator.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === BeautifulUrl::JsonGenerator
+#
+# The task of this class is to generate all entries in the case/when
+# menu as json.
+# =========================================================================== #
+# require 'beautiful_url/json_generator/json_generator.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+class JsonGenerator # === BeautifulUrl::JsonGenerator
+
+  require 'json'
+
+  begin
+    require 'case_parser' # This gem is required in this file here.
+  rescue LoadError; end
+
+  alias e puts
+
+  # ========================================================================= #
+  # === STORE_WHERE
+  # ========================================================================= #
+  STORE_WHERE = '/Depot/Temp/dataset.json'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @array
+    # ======================================================================= #
+    @array = CaseParser.return_array(:beautiful_menu)
+  end
+
+  # ========================================================================= #
+  # === save_result
+  # ========================================================================= #
+  def save_result
+    report_where_we_will_store
+    File.open(STORE_WHERE, 'w+') {|file| file.print @serialized }
+  end
+
+  # ========================================================================= #
+  # === report_where_we_will_store
+  # ========================================================================= #
+  def report_where_we_will_store
+    e "Next storing at `#{STORE_WHERE}`."
+  end
+
+  # ========================================================================= #
+  # === serialized?
+  # ========================================================================= #
+  def serialized?
+    @serialized
+  end; alias serialized serialized? # === serialized
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    @serialized = @array.to_json
+    save_result
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = BeautifulUrl::JsonGenerator.new
+  pp _.serialized
+  _.report_where_we_will_store
+end # json_generator

data/lib/beautiful_url/project/project.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/project/project.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+  # ========================================================================= #
+  # === BeautifulUrl.project_base_directory?
+  # ========================================================================= #
+  def self.project_base_directory?
+    File.absolute_path("#{__dir__}/..")+'/'
+  end; self.instance_eval { alias project_base_dir? project_base_directory? } # === BeautifulUrl.project_base_dir?
+       self.instance_eval { alias project_dir?      project_base_directory? } # === BeautifulUrl.project_dir?
+       self.instance_eval { alias base_dir?         project_base_directory? } # === BeautifulUrl.base_dir?
+       self.instance_eval { alias base_directory?   project_base_directory? } # === BeautifulUrl.base_directory?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts BeautifulUrl.project_base_dir?
+end

data/lib/beautiful_url/requires/failsafe_require_of_beautiful_url.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/requires/failsafe_require_of_beautiful_url.rb'
+# =========================================================================== #
+begin
+  require 'beautiful_url/requires/require_the_beautiful_url_project.rb'
+rescue LoadError; end

data/lib/beautiful_url/requires/require_the_beautiful_url_project.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/requires/require_the_beautiful_url_project.rb'
+# =========================================================================== #
+require 'beautiful_url/constants/constants.rb'
+require 'beautiful_url/version/version.rb'
+require 'beautiful_url/project/project.rb'
+require 'beautiful_url/json_generator/json_generator.rb'
+require 'beautiful_url/toplevel_methods/local_menu.rb'
+require 'beautiful_url/toplevel_methods/moodle_menu.rb'
+require 'beautiful_url/toplevel_methods/return_location_of_the_menu_file.rb'
+require 'beautiful_url/toplevel_methods/university_menu.rb'
+require 'beautiful_url/class/initialize.rb'

data/lib/beautiful_url/toplevel_methods/current_month.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module BeautifulUrl
+
+  require 'date'
+
+  # ========================================================================= #
+  # === BeautifulUrl.current_month?
+  #
+  # This will return e. g. "5".
+  # ========================================================================= #
+  def self.current_month?(
+      pad_with_zeroes = false
+    )
+    current_month = Date.today.month.to_s
+    case pad_with_zeroes
+    when :pad_with_zeroes
+      pad_with_zeroes = true
+    end
+    if pad_with_zeroes
+      current_month = current_month.rjust(2,'0')
+    end
+    return current_month
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts BeautifulUrl.current_month?
+end