beautiful_url 1.5.90

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91e778f20ea7bb24bd59aa2dbeeeeb069f26170dd5b607b1464a2e560a6785d5
+  data.tar.gz: 88ef93f10af9e6be7be161c1d2e75bf547841aa6fc7e9a871259a887696d7e5a
+SHA512:
+  metadata.gz: c128c36d2ba899a919d62618bfa3ecddaaae9883079fa4f146b99f51dbf3935ceae6963faa583822a29bbe9fb52d2ad71a886e83e935ccecc1155b00092c0485
+  data.tar.gz: 8e2026d22860a443cee4e6ab77c0ad41d92b0b93f15d189b4b62211364c3f0b09245785323c71ed29ef8dd0ba781ab9bb512e69cb8dd4404d4b2db8b39e63c05

data/README.md

@@ -0,0 +1,112 @@
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](https://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)
+
+This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">15.04.2024</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">10:55:12</span> o'clock.
+
+## Introducing the BeautifulUrl project
+
+<img src="https://i.imgur.com/w9Ws8CP.png" style="margin:1em; border: 3px solid black;">
+
+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.
+
+## Creating a .json file
+
+It is possible to create a local .json file containing all the
+remote URLs that are registered. The method to do so is
+called <b>BeautifulUrl.create_json_file()</b>. Note that
+this functionality depends on the <b>case_parser</b> gem;
+that gem does not work 100% accurately, so do not be surprised
+if you do not get a complete .json file but only one with
+the first entry matched. In the future this may be changed,
+but for now this is the way it is.
+
+## 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 **cyberweb** project).
+The reason why that dependency exists is because it makes it easier
+for me to handle the same or similar code across many different
+ruby-based projects.
+
+The main purpose of this Application 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.
+
+
+## Contact information and mandatory 2FA (no longer) coming up in 2022 / 2023
+
+If your creative mind has ideas and specific suggestions to make this gem
+more useful in general, feel free to drop me an email at any time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail, for various reasons. In order to limit the
+explanation here, allow me to just briefly state that I do not feel as if I
+want to promote any Google service anymore when the user becomes the end
+product (such as via data collection by upstream services, including other
+proxy-services). My feeling is that this is a hugely flawed business model
+to begin with, and I no longer wish to support this in any way, even if
+only indirectly so, such as by using services of companies that try to
+promote this flawed model.
+
+In regards to responding to emails: please keep in mind that responding 
+may take some time, depending on the amount of work I may have at that
+moment. So it is not that emails are ignored; it is more that I have not
+(yet) found the time to read and reply. This means there may be a delay
+of days, weeks and in some instances also months. There is, unfortunately,
+not much I can do when I need to prioritise my time investment, but I try
+to consider <b>all</b> feedback as an opportunity to improve my projects
+nonetheless.
+
+In <b>2022</b> rubygems.org decided to make 2FA mandatory for every
+gem owner eventually:
+
+see
+https://blog.rubygems.org/2022/06/13/making-packages-more-secure.html
+
+However had, that has been reverted again, so I decided to shorten
+this paragraph. Mandatory 2FA may exclude users who do not have a 
+smartphone device or other means to 'identify'. I do not feel it is
+a fair assumption by others to be made that non-identified people may
+not contribute code, which is why I reject it. Mandatory 2FA would mean
+an end to all my projects on rubygems.org, so let's hope it will never
+happen. (Keep in mind that I refer to mandatory 2FA; I have no qualms
+for people who use 2FA on their own, but this carrot-and-stick strategy
+by those who control the rubygems infrastructure is a very bad one to
+pursue.
+

data/beautiful_url.gemspec

@@ -0,0 +1,60 @@
+# =========================================================================== #
+# Gemspec for Beautiful URL.
+# =========================================================================== #
+require 'beautiful_url'
+require 'roebe/toplevel_methods/misc.rb'
+
+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,65 @@
+DEFAULT_HEADER
+
+## Introducing the BeautifulUrl project
+
+<img src="https://i.imgur.com/w9Ws8CP.png" style="margin:1em; border: 3px solid black;">
+
+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.
+
+## Creating a .json file
+
+It is possible to create a local .json file containing all the
+remote URLs that are registered. The method to do so is
+called <b>BeautifulUrl.create_json_file()</b>. Note that
+this functionality depends on the <b>case_parser</b> gem;
+that gem does not work 100% accurately, so do not be surprised
+if you do not get a complete .json file but only one with
+the first entry matched. In the future this may be changed,
+but for now this is the way it is.
+
+## 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 **cyberweb** project).
+The reason why that dependency exists is because it makes it easier
+for me to handle the same or similar code across many different
+ruby-based projects.
+
+The main purpose of this Application 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.
+
+ADD_CONTACT_INFORMATION

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