beautiful_url 1.5.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44dcb3982ce315f2fddfe6043cd9cf665efe3fefe311f0f0023031b6cc18d8d0
+  data.tar.gz: fc0bd1b1518e88fc36e9adff77f369cc1d15a21bc30158ceb7456b0fdf132c40
+SHA512:
+  metadata.gz: '008342e0e387b8bc57ea56dcc2b1f0a1b45612144aa19d745e9c3c831370dfaac7bd319791198332d5e429df1fc0816e245045bd9549cfd1ed6bce93e45d6df7'
+  data.tar.gz: 0c53f71952538b20465fc953bb68b662b06d5cbaa423def10c912158d30f7320c7621416074ddf15cd3881fd07ab8be3735b501deddc55dd9e043e462d81a9c0

data/README.md

@@ -0,0 +1,52 @@
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/beautiful_url.svg)](https://badge.fury.io/rb/beautiful_url)
+
+## Introducing the BeautifulUrl project
+
+This project has been created to primarily cover my needs to map a
+given input (typically a symbol, such as :ruby_homepage), to
+a specific String - a remote URL, in this case
+**https://www.ruby-lang.org/en/**.
+
+In fact this is the primary scenario for this project: it provides
+a simple mapper between symbols, and remote URLs.
+
+At a later time I also added symbols as shortcuts to local files,
+so the whole project is a quick way for me to navigate different
+resources (including **RESTful APIs**).
+
+I may at a later point add the ability to arbitrarily add new
+entries via a yaml file, so that other people can extend this
+project at their own leisure - but for now, the original use
+case will be kept as-is. Extending the project may happen at
+a later time.
+
+## General usage examples:
+
+    BeautifulUrl::BeautifulUrl.new('palemoon', :replace_localhost)
+    BeautifulUrl::BeautifulUrl.new('palemoon' {{ replace_localhost: true }}
+    BeautifulUrl['palemoon'] # ← This is recommended, as it is simpler.
+
+## Sinatra-Interface
+
+The BeautifulUrl project has a minimalistic **sinatra interface**.
+
+You can start it in this way:
+
+    require 'beautiful_url/www/app.rb'
+
+    BeautifulUrl::App.start_sinatra_interface
+
+Note that this depends on an external gem (the **web_object** project);
+at the least a subclass defined in that cyberweb project, mostly as
+that makes it easier for me to handle the same or similar code
+across many different projects.
+
+The main purpose of this App is to map given string input into the 
+corresponding URL. It's mostly added for demonstration-purposes,
+to show how this could be used in a web-interface.
+
+One day I may also want to add a small widget to a browser to 
+allow for this, but I don't like javascript, and don't know
+how to do this via ruby only either.

data/beautiful_url.gemspec

@@ -0,0 +1,60 @@
+# =========================================================================== #
+# Gemspec for Beautiful URL.
+# =========================================================================== #
+require 'beautiful_url'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'beautiful_url'
+  s.version = BeautifulUrl.version?
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This is a medium-sized gem which attempts to handle "matching" a String
+or a Symbol against (remote) URLs. The project was created in order to
+use short identifiers that can pinpoint to remote URLs, a bit similar
+to how shorturl is working.
+
+The gem is, however had, tailored to my use cases, so it will most
+likely be utterly useless to other people by default. Most downloads
+of this gem happen by scripts and bots, so do not think that the 
+download numbers imply anything about "real" usage - the gem is 
+way too much tailored to my own use case.
+
+In the long run, though, the project may be extended to allow the
+custom loading of yaml files, for a later release - but for now,
+I do not think that this project will be useful to anyone else. 
+
+More documentation can be found at:
+
+  https://www.rubydoc.info/gems/beautiful_url/
+    
+EOF
+
+  # ========================================================================= #                                                                                                              
+  # Show this when a user installs this gem.                                                                                                                                         
+  # ========================================================================= #                                                                                                              
+  s.post_install_message = <<-EOF                                                                                                                                                            
+
+  You should be able to invoke bin/beautiful_url via:
+
+      beautiful_url
+
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+                   
+  s.authors     = ["Robert A. Heiler"]
+  s.email       = Roebe.email?
+  s.files       = Dir["**/*"]
+  s.licenses    = 'MIT'
+  s.homepage    = 'https://rubygems.org/gems/beautiful_url'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+}

data/bin/beautiful_url

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'beautiful_url'
+
+result = BeautifulUrl.fetch_value(ARGV.first)
+
+puts result

data/doc/README.gen

@@ -0,0 +1,50 @@
+ADD_RUBY_BADGE
+
+## Introducing the BeautifulUrl project
+
+This project has been created to primarily cover my needs to map a
+given input (typically a symbol, such as :ruby_homepage), to
+a specific String - a remote URL, in this case
+**https://www.ruby-lang.org/en/**.
+
+In fact this is the primary scenario for this project: it provides
+a simple mapper between symbols, and remote URLs.
+
+At a later time I also added symbols as shortcuts to local files,
+so the whole project is a quick way for me to navigate different
+resources (including **RESTful APIs**).
+
+I may at a later point add the ability to arbitrarily add new
+entries via a yaml file, so that other people can extend this
+project at their own leisure - but for now, the original use
+case will be kept as-is. Extending the project may happen at
+a later time.
+
+## General usage examples:
+
+    BeautifulUrl::BeautifulUrl.new('palemoon', :replace_localhost)
+    BeautifulUrl::BeautifulUrl.new('palemoon' {{ replace_localhost: true }}
+    BeautifulUrl['palemoon'] # ← This is recommended, as it is simpler.
+
+## Sinatra-Interface
+
+The BeautifulUrl project has a minimalistic **sinatra interface**.
+
+You can start it in this way:
+
+    require 'beautiful_url/www/app.rb'
+
+    BeautifulUrl::App.start_sinatra_interface
+
+Note that this depends on an external gem (the **web_object** project);
+at the least a subclass defined in that cyberweb project, mostly as
+that makes it easier for me to handle the same or similar code
+across many different projects.
+
+The main purpose of this App is to map given string input into the 
+corresponding URL. It's mostly added for demonstration-purposes,
+to show how this could be used in a web-interface.
+
+One day I may also want to add a small widget to a browser to 
+allow for this, but I don't like javascript, and don't know
+how to do this via ruby only either.

data/lib/beautiful_url.rb

@@ -0,0 +1 @@
+require 'beautiful_url/requires/require_the_beautiful_url_project.rb'

data/lib/beautiful_url/class/constants.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/class/constants.rb'
+# =========================================================================== #
+require 'beautiful_url/constants/constants.rb'
+
+module BeautifulUrl
+
+class BeautifulUrl # === BeautifulUrl::BeautifulUrl
+
+  # ========================================================================= #
+  # === RUN_ALREADY
+  # ========================================================================= #
+  RUN_ALREADY = true
+
+  # ========================================================================= #
+  # === DEFAULT_URL
+  # ========================================================================= #
+  DEFAULT_URL = 'http://localhost/DATA/PROGRAMMING_LANGUAGES/R/R.cgi'
+
+end; end

data/lib/beautiful_url/class/generate_tab_completion_for_bash_shell.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/class/generate_tab_completion_for_bash_shell.rb'
+# =========================================================================== #
+module BeautifulUrl
+
+class BeautifulUrl # It is part of the class.
+
+  begin
+    require 'save_file'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === generate_tab_completion_for_bash_shell
+  #
+  # This entry point will generate the tab-completion for the BASH shell.
+  #
+  # Invocation examples:
+  #
+  #   purl GENERATE
+  #   purl --generate
+  #
+  # ========================================================================= #
+  def generate_tab_completion_for_bash_shell
+    begin
+      require 'collect_first_word_of_case_menu'
+    rescue LoadError; end
+    begin
+      require 'opn'
+    rescue LoadError; end
+    opn; e 'Now generating tab completion for the bash shell.'
+    _ = ''.dup # This is the string to store.
+    _ << 'completion_for_purl()
+{
+  local cur complete_these_words
+  
+  COMPREPLY=() # Array variable storing the possible completions.
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  complete_these_words="'
+    beautiful_menu = ::BeautifulUrl[:beautiful_menu]
+    if beautiful_menu.is_a? Array
+      beautiful_menu = beautiful_menu.first
+    end
+    results = CollectFirstWordOfCaseMenu.new(beautiful_menu).result
+    results.sort.each {|entry|
+      _ << entry+"\n"
+    }
+    _ << ' "
+
+  if [[ ${cur} == * ]] ; then
+    COMPREPLY=( $(compgen -W "${complete_these_words}" -- ${cur}) )
+    return 0
+  fi
+}
+# Next, available auto-completion for the commands "purl" and "url".
+complete -F completion_for_purl url
+complete -F completion_for_purl purl
+'
+    store_where =
+      "#{BASE_DIR}DATA/PC/OS/LINUX/SHELL/SCRIPTS/completion_for_purl.sh"
+    opn; e 'We will store at `'+store_where+'`.'
+    SaveFile.write_what_into(_, store_where)
+  end; alias generate_tab_completion generate_tab_completion_for_bash_shell # === generate_tab_completion
+
+end; end # bmenu

data/lib/beautiful_url/class/initialize.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === BeautifulUrl::BeautifulUrl
+#
+# The class BeautifulUrl wants to make it easier to open local pages -
+# but it can also make use of shortcuts for remote files.
+#
+# It additionally supports the usage of intralinks, e.g. if you wish
+# to append something like '#foo' to a html page, it is possible
+# through this project.
+#
+# See below for some specific usage examples.
+#
+# In the event that a substitute for the given input can not be found,
+# we will return the original input unmodified.
+#
+# Specific usage examples for class BeautifulUrl in ruby code:
+#
+#   require 'beautiful_url'
+#   url = BeautifulUrl.new('science_news')
+#   url.input?; url.url?; url.remote?
+#   url.do_replace_localhost
+#   url.replace_data
+#   x = BeautifulUrl.new 'geastask'
+#   BeautifulUrl.new('slogans').url?
+#   BeautifulUrl.new('geastask').url_was_found
+#   BeautifulUrl.new('cmd#chroot') # => "http://localhost/DATA/PC/OS/LINUX/LINUX_COMMANDS.cgi#chroot"
+#
+# =========================================================================== #
+# require 'beautiful_url/class/initialize.rb'
+# =========================================================================== #
+require 'beautiful_url/class/constants.rb'
+require 'beautiful_url/class/misc.rb'
+require 'beautiful_url/class/reset.rb'
+require 'beautiful_url/class/run.rb'
+
+module BeautifulUrl
+
+class BeautifulUrl # === BeautifulUrl::BeautifulUrl
+
+  alias e puts
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # Usage examples:
+  #
+  #   x = BeautifulUrl::BeautifulUrl.new('palemoon', :replace_localhost)
+  #   x = BeautifulUrl::BeautifulUrl.new('palemoon' {{ replace_localhost: true }}
+  #
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = RUN_ALREADY,
+      &block
+    )
+    reset # Must come first.
+    case commandline_arguments # case tag
+    # ======================================================================= #
+    # === :dont_run_yet
+    # ======================================================================= #
+    when :dont_run_yet,
+         :do_not_run_yet
+      commandline_arguments = DEFAULT_URL
+      run_already = false
+    end
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    case run_already
+    # ======================================================================= #
+    # === :replace_localhost
+    # ======================================================================= #
+    when :replace_localhost,
+         :replace,
+         :replace_localhost_with_data,
+         :do_replace_localhost
+      @replace_localhost_with_data = true # Default, as this is more important.
+      run_already = RUN_ALREADY
+    else
+      if run_already.is_a? Hash # Must come after reset().
+        # =================================================================== #
+        # === :replace_localhost
+        # =================================================================== #
+        if run_already.has_key? :replace_localhost
+          @replace_localhost_with_data = run_already[:replace_localhost]
+          run_already = RUN_ALREADY # Restore the default again. 
+        # =================================================================== #
+        # === :replace
+        # =================================================================== #
+        elsif run_already.has_key? :replace
+          @replace_localhost_with_data = run_already[:replace]
+          run_already = RUN_ALREADY # Restore the default again.
+        end
+      end
+    end
+    # ======================================================================= #
+    # === Handle blocks given to us
+    #
+    # This has to occur before run() is called.
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :do_not_replace_the_localhost
+      # ===================================================================== #
+      when :do_not_replace_the_localhost
+        # In this case do nothing.
+      # ===================================================================== #
+      # ===:replace_localhost
+      # ===================================================================== #
+      when :replace_localhost
+        @replace_localhost_with_data = true
+      end
+    end
+    run if run_already
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = BeautifulUrl::BeautifulUrl.new(ARGV)
+  pp _
+  puts _.return_corresponding_entry
+  _.get_rid_of_localhost
+  puts _.return_corresponding_entry
+end # rb initialize.rb rubyreddit
+    # rb initialize.rb palemoon
+    # Testing this class next:
+    #   purl diepasst
+    #   purl pc 
+    #   purl anmeldung
+    #   purl pc replace
+    #   purl GENERATE
+    #   purl science_news
+    #   burl ruby#windows
+    #   burl std#amino_acids
+    #   burl cmd cat
+    #   burl scinews
+    #   burl gobodist_homepage
+    #   sani geastask
+    #   purl GENERATE
+    #   burl gobodist
+    #   burl gobodist#Compile
+    #   burl local_php#test
+    #   burl stdk#Periodensystem

data/lib/beautiful_url/class/misc.rb

@@ -0,0 +1,475 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'beautiful_url/class/misc.rb'
+# =========================================================================== #
+require 'beautiful_url/constants/misc.rb'
+require 'beautiful_url/toplevel_methods/current_month.rb'
+require 'beautiful_url/toplevel_methods/menu.rb'
+require 'beautiful_url/toplevel_methods/moodle_menu.rb'
+require 'beautiful_url/toplevel_methods/roebe.rb'
+require 'beautiful_url/class/generate_tab_completion_for_bash_shell.rb'
+
+module BeautifulUrl
+
+class BeautifulUrl # === BeautifulUrl::BeautifulUrl
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === map_the_input_arguments_to_their_corresponding_values
+  #
+  # This method will map the given input to its corresponding value,
+  # if possible.
+  #
+  # Take note that this method will also change @is_registered if the
+  # entry was found.
+  # ========================================================================= #
+  def map_the_input_arguments_to_their_corresponding_values(
+      i = @commandline_arguments
+    )
+    i.map! {|entry|
+      if entry.is_a? Symbol
+        entry = entry.to_s.dup
+      end
+      entry = entry.dup if entry.frozen?
+      # ===================================================================== #
+      # Neither ':' or ',' seem to be useful at the end, so we will chop
+      # them away next (since as of October 2011). Trailing whitespace
+      # will also be removed in the line afterwards.
+      # ===================================================================== #
+      if entry and (entry.end_with?(':') or entry.end_with?(','))
+        entry.chop!
+      end
+      if entry
+        entry.rstrip!
+        # =================================================================== #
+        # Nor is a leading ':' useful here either.
+        # =================================================================== #
+        entry[0,1] = '' if entry.start_with? ':'
+      end
+      # ===================================================================== #
+      # Handle intralink entries when they contain a '#' character.
+      # ===================================================================== #
+      if entry and entry.include?('#')
+        splitted = entry.split('#')
+        set_intralink(splitted.last)
+        entry = splitted.first
+      end
+      old_value = entry.to_s.dup # Use a reference copy here.
+      new_value = ::BeautifulUrl.menu(entry)
+      new_value.flatten! if new_value.is_a? Array
+      if new_value == old_value
+        # =================================================================== #
+        # In this case we did not find anything, so we don't do anything.
+        # =================================================================== #
+      else
+        @is_registered = true
+        entry = new_value
+      end
+      if @intralink and !@intralink.empty?
+        entry = entry.dup if entry.frozen?
+        entry << @intralink # Append in this case.
+      end
+      entry
+    }
+    i.flatten!
+  end; alias check_input_against_menu map_the_input_arguments_to_their_corresponding_values # === check_input_against_menu
+       alias sanitize_input           map_the_input_arguments_to_their_corresponding_values # === sanitize_input
+
+  # ========================================================================= #
+  # === is_a_remote_url?
+  #
+  # This method will return true if the URL is remote, false if it is
+  # local, and nil if it was not found at all.
+  #
+  # The variable @url_was_found will tell us whether the url was
+  # found or whether it was not.
+  # ========================================================================= #
+  def is_a_remote_url?
+    if @is_registered
+      _ = @commandline_arguments.all? {|entry|
+        entry.include? 'http'
+      }
+    else
+      _ = nil
+    end
+    _ # Our return value.
+  end; alias remote?           is_a_remote_url? # === remote?
+       alias is_a_remote_file? is_a_remote_url? # === is_a_remote_file?
+
+  # ========================================================================= #
+  # === set_shall_we_replace_localhost
+  #
+  # This method simply sets @replace_localhost_with_data to the
+  # passed value, which is true by default.
+  #
+  # If true, we will replace the "localhost" string with the
+  # DATA constant.
+  #
+  # Parameters can be like this:
+  #
+  #   :replace => true     # Yes, replace localhost with data. 
+  #   :replace => false    # No, do not replace localhost with data.
+  #   :replace => :reverse # Replace data with localhost, which is the reverse.
+  #
+  # ========================================================================= #
+  def set_shall_we_replace_localhost(
+      i = true
+    )
+    @replace_localhost_with_data = i
+  end; alias set_replace_localhost       set_shall_we_replace_localhost # === set_replace_localhost
+       alias shall_we_replace_localhost= set_shall_we_replace_localhost # === shall_we_replace_localhost=
+
+  # ========================================================================= #
+  # === search_for_this_url
+  #
+  # This will return a string.
+  # ========================================================================= #
+  def search_for_this_url(i)
+    set_commandline_arguments(i)
+    map_the_input_arguments_to_their_corresponding_values
+    handle_additional_actions_after_the_input_arguments_were_already_mapped
+    return string?
+  end
+
+  # ========================================================================= #
+  # === consider_replacing_data_with_localhost
+  # ========================================================================= #
+  def consider_replacing_data_with_localhost
+    if @replace_data_with_localhost
+      do_replace_data_with_localhost
+    end
+  end
+
+  # ========================================================================= #
+  # === consider_replacing_localhost_with_data
+  # ========================================================================= #
+  def consider_replacing_localhost_with_data
+    if @replace_localhost_with_data
+      do_replace_localhost_with_data_entry
+    end
+  end; alias replace_localhost consider_replacing_localhost_with_data # ===replace_localhost
+
+  # ========================================================================= #
+  # === handle_additional_actions_after_the_input_arguments_were_already_mapped
+  # ========================================================================= #
+  def handle_additional_actions_after_the_input_arguments_were_already_mapped
+    consider_replacing_localhost_with_data
+    consider_replacing_data_with_localhost
+  end; alias consider_replacing_everything handle_additional_actions_after_the_input_arguments_were_already_mapped # === consider_replacing_everything
+       alias consider_replacing_anything   handle_additional_actions_after_the_input_arguments_were_already_mapped # === consider_replacing_anything
+
+  # ========================================================================= #
+  # === do_replace_data_entry_with_localhost
+  # ========================================================================= #
+  def do_replace_data_entry_with_localhost
+    @commandline_arguments.map! {|entry|
+      entry = entry.dup if entry.frozen?
+      if entry.include? @data_dir
+        regexp_quoted = Regexp.quote(@data_dir)
+        entry.sub!(regexp_quoted, HTTP_LOCALHOST_STRING)
+      end
+      entry
+    }
+  end; alias do_replace_data_with_localhost         do_replace_data_entry_with_localhost # === do_replace_data_with_localhost
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @commandline_arguments
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === rf --show_help
+      # ===================================================================== #
+      when /^-?-?show(_|-)?help$/i,
+           /^-?-?help$/i
+        show_help
+      # ===================================================================== #
+      # === rf --generate-tab
+      # or
+      # === purl GENERATE
+      # ===================================================================== #
+      when 'AUTOGENERATED','GENERATE',
+           '--generate',
+           '--autogenerate',
+           /^-?-?generate?(-|_)?completion$/,
+           'generate_shell',
+           /^GENE/,
+           '--tab',
+           '--generate-tab' # Could also be 'GENERATE','GENE'
+        generate_tab_completion_for_bash_shell # This here is in another file.
+        exit
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === is_registered?
+  # ========================================================================= #
+  def is_registered?
+    @is_registered
+  end; alias url_was_found? is_registered? # === url_was_found?
+       alias url_was_found  is_registered? # === url_was_found
+       alias is_included?   is_registered? # === is_included?
+
+  # ========================================================================= #
+  # === do_replace_localhost_with_data_entry
+  #
+  # This method will replace the leading localhost-string with
+  # the corresponding data-dir value.
+  #
+  # For example, the :
+  #
+  #   http://localhost/DATA/PC/palemoon/palemoon.cgi
+  #
+  # Would become:
+  #
+  #   /home/x/DATA/PC/palemoon/palemoon.cgi
+  #
+  # ========================================================================= #
+  def do_replace_localhost_with_data_entry
+    @commandline_arguments.map! {|entry|
+      entry = entry.dup if entry.frozen?
+      if entry.include? HTTP_LOCALHOST_STRING
+        regexp_quoted = Regexp.quote(HTTP_LOCALHOST_STRING)
+        entry.sub!(regexp_quoted, home_dir_of_user_x?)
+      end
+      entry
+    }
+  end; alias get_rid_of_localhost           do_replace_localhost_with_data_entry # === get_rid_of_localhost
+       alias do_replace_localhost_with_data do_replace_localhost_with_data_entry # === do_replace_localhost_with_data
+       alias do_replace_localhost           do_replace_localhost_with_data_entry # === do_replace_localhost
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = :default)
+    case i
+    when nil
+      i = DEFAULT_URL
+    end
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === replace_localhost_with_data?
+  # ========================================================================= #
+  def replace_localhost_with_data?
+    @replace_localhost_with_data
+  end; alias replace_localhost_with_data replace_localhost_with_data? # === replace_localhost_with_data
+
+  # ========================================================================= #
+  # === set_intralink
+  #
+  # This method sets the @intralink variable. It is the only allowed
+  # way to modify this variable. The @intralink variable can be a
+  # pointer to a local or to a remote page.
+  #
+  # As of August 2014, we will only set @intralink if we provide input.
+  # ========================================================================= #
+  def set_intralink(
+      i = nil, use_this_token = '#'
+    )
+    case i
+    when :default
+      i = nil
+    end
+    if i
+      i[0,0] = use_this_token unless i.empty?
+    end
+    @intralink = i # Must always be set, even to nil.
+  end
+
+  # ========================================================================= #
+  # === set_data_dir
+  #
+  # We need this method so that the user can define another data-dir
+  # that is to be used.
+  # ========================================================================= #
+  def set_data_dir(
+      i = :default
+    )
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default,
+         nil
+      i = DATA_DIR
+    end
+    @data_dir = i
+  end
+
+  # ========================================================================= #
+  # === return_corresponding_entries
+  # ========================================================================= #
+  def return_corresponding_entries
+    @commandline_arguments
+  end; alias input? return_corresponding_entries # === input?
+       alias data   return_corresponding_entries # === data
+       alias array  return_corresponding_entries # === array
+       alias array? return_corresponding_entries # === array?
+
+  # ========================================================================= #
+  # === return_corresponding_entry
+  # ========================================================================= #
+  def return_corresponding_entry
+    @commandline_arguments.first
+  end; alias url? return_corresponding_entry # === url?
+
+  # ========================================================================= #
+  # === show_result
+  # ========================================================================= #
+  def show_result
+    e return_corresponding_entry
+  end
+
+  # ========================================================================= #
+  # === home_dir_of_user_x?
+  # ========================================================================= #
+  def home_dir_of_user_x?
+    BASE_DIR
+  end
+
+  # ========================================================================= #
+  # === do_ignore_help
+  # ========================================================================= #
+  def do_ignore_help
+    @ignore_help = true
+  end
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help(
+      shall_we_exit = :then_exit
+    )
+    unless @ignore_help
+      opn
+      e 'To issue the various instructions, use AUTOGENERATED or GENERATED.'
+      e
+      e 'Alternative, it works as a downcased variant as well, with -- as in:'
+      e
+      e '  --autogenerate'
+      e '  --generate'
+      e
+      exit if shall_we_exit == :then_exit
+    end
+  end
+
+  # ========================================================================= #
+  # === url_as_string
+  #
+  # Return the @input in string variant, always. This can be used as
+  # content that can be displayed in other programs.
+  #
+  # Take note that in the past result? returned an Array, from 02.08.2015
+  # up until 04.01.2020. Past that point it will return a String instead.
+  # ========================================================================= #
+  def url_as_string
+    return_corresponding_entry.to_s
+  end; alias url?             url_as_string # === url?
+       alias location?        url_as_string # === location?
+       alias string           url_as_string # === string
+       alias string?          url_as_string # === string?
+       alias result?          url_as_string # === result?
+       alias result           url_as_string # === result
+       alias return_as_string url_as_string # === return_as_string
+       alias []               url_as_string # === []
+
+  # ========================================================================= #
+  # === BeautifulUrl::BeautifulUrl['palemoon']
+  # ========================================================================= #
+  def self.[](
+      i = 'palemoon', &block
+    )
+    new(i, &block).return_as_string
+  end
+
+end
+
+# =========================================================================== #
+# === BeautifulUrl.fetch_value
+#
+# This method simply allows you to return the URL on the commandline. It
+# will also set the xorg-buffer, if available, so it is ideally used
+# for commandline-applications, e. g. if the xorg-server is not available.
+#
+# Usage example would be:
+#
+#   BeautifulUrl.fetch_value 'php' # => "/home/x/DATA/PROGRAMMING_LANGUAGES/php/PHP_TUTORIAL.php"
+#
+# =========================================================================== #
+def self.fetch_value(
+    i
+  )
+  result = ::BeautifulUrl::BeautifulUrl.new(i).result?
+  if Object.const_defined? :XorgBuffer
+    XorgBuffer[result]
+  end
+  return result
+end
+
+# ========================================================================= #
+# === BeautifulUrl.is_included?
+#
+# Use this method to find out whether an entry is registered or whether
+# it is not.
+#
+# Usage example:
+#
+#   x = BeautifulUrl.is_included? 'htop'
+#
+# ========================================================================= #
+def self.is_included?(i)
+  # ======================================================================= #
+  # The next check was added in September 2015. It was disabled again
+  # in 2020.
+  # ======================================================================= #
+  # i = i.to_sym unless i.is_a? Symbol
+  _ = ::BeautifulUrl::BeautifulUrl.new(i)
+  _.is_included? # Work on the class-level there.
+end; self.instance_eval { alias include?        is_included? } # === BeautifulUrl.include?
+     self.instance_eval { alias has_this_entry? is_included? } # === BeautifulUrl.has_this_entry?
+     self.instance_eval { alias does_include?   is_included? } # === BeautifulUrl.does_include?
+
+# ========================================================================= #
+# === BeautifulUrl.replace_localhost
+# ========================================================================= #
+def self.replace_localhost(i)
+  ::BeautifulUrl::BeautifulUrl.new(i) { :replace_localhost }
+end
+
+# =========================================================================== #
+# === BeautifulUrl.map
+#
+# Usage examples:
+#
+#   BeautifulUrl.map('palemoon')   # => "http://localhost/DATA/PC/palemoon/palemoon.cgi"
+#   BeautifulUrl.parse('palemoon') # => "http://localhost/DATA/PC/palemoon/palemoon.cgi"
+#   BeautifulUrl.parse(:remote_bioroebe) # => "https://rubygems.org/gems/bioroebe"
+#
+# =========================================================================== #
+def self.map(
+    i, &block
+  )
+  ::BeautifulUrl::BeautifulUrl.new(i, &block).return_as_string
+end; self.instance_eval { alias []               map } # === BeautifulUrl[]
+     self.instance_eval { alias convert          map } # === BeautifulUrl.convert
+     self.instance_eval { alias new              map } # === BeautifulUrl.new
+     self.instance_eval { alias return_url_from  map } # === BeautifulUrl.return_url_from
+     self.instance_eval { alias return_as_string map } # === BeautifulUrl.return_as_string
+     self.instance_eval { alias parse            map } # === BeautifulUrl.parse
+     self.instance_eval { alias symbol_to_url    map } # === BeautifulUrl.symbol_to_url
+
+end