convert_global_env 1.0.23 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac7e018f41eaa7c3885cd5cfd4ba985855b605b9f55b9fcb317b506f1f1455df
-  data.tar.gz: da72334315082fc1c08170cd1d54c79084765788f98b53956ed9c4f3dd9268cf
+  metadata.gz: e12c6410d7213a21f33a500e1cf55d487c2d5c7154518cd757611b1a12f38590
+  data.tar.gz: ca8fdc0ff0e32ecffe6597d17440a7cb11620a753741fd928c3bcfe8f6abeaf3
 SHA512:
-  metadata.gz: dfe29d3a7d97dfd915aa60d6cf580e08aeb1a1f21a8b44618714503338ec70759bc767729c3de4ccef6fb03ae59205669bd64734d815c104c9ba1275baf860f2
-  data.tar.gz: 46ef439da618cc6f5292db01dc3e842eebb65026756985b9d94c96e6ea37865a7fb10a69c72a239495620a7829a58ac9d3ff36bd9c2eb5bfc955aea517611a6e
+  metadata.gz: dbb0af91e1430cef7282c0a9ce574aa0c084a42e1539caadc7aeb405d4ced5b1163eb9863211a26324ad7fad06392fb77e3ef2c809940461b742749164e4bec8
+  data.tar.gz: 0d70ea11eb9cfbc789f10b9913d27eca700aadf78a4fca809ee6a8114195a883665014b51f0712306f2fce8a45cfeed3d1fd8155bafb289053e6ee87a9b88a8a

data/README.md

@@ -0,0 +1,92 @@
+[![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/convert_global_env.svg)](https://badge.fury.io/rb/convert_global_env)
+
+<img src="https://i.imgur.com/64icv2h.png" style="margin: 1em; margin-left: 5em">
+
+## About the convert_global_env project
+
+This project can convert string entries such as $FOO to
+their corresponding ENV['FOO'] counterpart. This will
+happen on a whole string, so multiple entries of $FOO
+can be replaced in one go.
+
+The project was created so that I can batch-generate hardcoded shell
+variables or query the value of ENV variables from .cgi files and
+elsewhere.
+
+In **May 2022** when this project was rewritten, support for 
+hashes other than the one stored in ENV was added too. This
+will allow us to properly work on windows as well, should ENV **not**
+contain any such values (if the **rcfiles** gem is available).
+
+## Structure of the convert_global_env gem
+
+This subsection contains just a few noteworthy comments pertaining to the
+structure of this gem.
+
+## How to use the convert_global_env gem in your project
+
+There are several different ways how this gem can be used, but let's
+describe the simplest variant.
+
+First, require it via:
+
+    require 'convert_global_env'
+
+Then, if your input-string contains a '$' character, convert it like
+so:
+
+    ConvertGlobalEnv.convert '$MY_SRC/ruby' # => "/home/x/src/ruby"
+
+Note that this **only** works if your ENV (environment) contains such
+a value. So if the value $MY_SRC is not defined then the above logically
+will not work.
+
+This can be a problem for some situations, such as in a .cgi file where
+no ENV variables exist, or on windows typically. For these reasons an
+alternative exists, if the **rcfile** gem is installed and available.
+
+## The method load_values_from_the_rcfiles_gem()
+
+The method load_values_from_the_rcfiles_gem() is normally not used,
+but you can use it specifically to load ENV-like variables if the
+**rcfiles** gem is installed.
+
+See the .cgi page in the test/ subdirectory at:
+ 
+    convert_global_env/test/testing_cgi_environment.cgi
+
+## Licence
+
+In **January** of **2022** the licence of this gem was changed to MIT. The
+primary reason for this is because this gem is used by several other gems
+which are mostly MIT-based. So it seemed simpler to have the same licence
+for this gem as well.
+
+
+## Contact information
+
+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 part this is because
+the UI annoys me (on non-chrome browser loading takes too long), but also
+because of Google's attempt to establish mass surveillance via its
+federated cohorts sniffing (FLoC). I do not know what happened at Google,
+but enough is enough - there is only so much you can take while supporting
+greed. When it comes to data mining done by private groups, ultimately
+the user became the product.
+
+Do keep in mind that responding to emails may take some time,
+depending on the amount of work I may have at that moment, due
+to reallife time constraints. I will, however had, read feedback
+eventually. Patches and code changes are welcome too, of course,
+as long as they are in the spirit of the project at hand, e. g.
+fitting to the general theme. For this I may make use of github
+as a discussion site, but this has a low priority right now.
+

data/bin/convert_global_env

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'convert_global_env'
+
+puts ConvertGlobalEnv[ARGV]

data/convert_global_env.gemspec

@@ -2,38 +2,29 @@
 # Gemspec for Project ConvertGlobalEnv.
 # =========================================================================== #
 require 'convert_global_env/version/version.rb'
-require 'roebe'
+require 'roebe/toplevel_methods/misc.rb'
 
 Gem::Specification.new { |s|
 
-  s.name        = 'convert_global_env'
-  s.version     = ConvertGlobalEnv::VERSION
-  s.date        = Time.now.strftime('%Y-%m-%d')
-  
-  s.summary = <<-EOF
+  s.name    = 'convert_global_env'
+  s.version = ConvertGlobalEnv::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
 
-    This module translates a string like $FOO/bar into the corresponding
-    ENV variable, i.e. ENV['FOO']+'/bar'.
-    It has no external dependencies.
+DESCRIPTION = <<-EOF
 
-  EOF
-  
-  s.description = <<-EOF
+This module translates a string like $FOO/bar into the corresponding
+ENV variable, i.e. ENV['FOO']+'/bar'. This gem has no external
+dependencies.
 
-    This module translates a string like $FOO/bar into the corresponding
-    ENV variable, i.e. ENV['FOO']+'/bar'.
-    It has no external dependencies.
+EOF
 
-  EOF
-
-  s.extra_rdoc_files = %w(
-    USAGE.md
-  )
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
 
   s.authors  = ['Robert A. Heiler']
   s.email    = Roebe.email?
   s.files    = Dir['**/*']
-  s.licenses = 'GPL-2.0'
+  s.licenses = 'MIT'
   s.homepage = 'https://rubygems.org/gems/convert_global_env'
 
   s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby

data/doc/README.gen

@@ -0,0 +1,65 @@
+ADD_RUBY_HEADER
+
+<img src="https://i.imgur.com/64icv2h.png" style="margin: 1em; margin-left: 5em">
+
+## About the convert_global_env project
+
+This project can convert string entries such as $FOO to
+their corresponding ENV['FOO'] counterpart. This will
+happen on a whole string, so multiple entries of $FOO
+can be replaced in one go.
+
+The project was created so that I can batch-generate hardcoded shell
+variables or query the value of ENV variables from .cgi files and
+elsewhere.
+
+In **May 2022** when this project was rewritten, support for 
+hashes other than the one stored in ENV was added too. This
+will allow us to properly work on windows as well, should ENV **not**
+contain any such values (if the **rcfiles** gem is available).
+
+## Structure of the convert_global_env gem
+
+This subsection contains just a few noteworthy comments pertaining to the
+structure of this gem.
+
+## How to use the convert_global_env gem in your project
+
+There are several different ways how this gem can be used, but let's
+describe the simplest variant.
+
+First, require it via:
+
+    require 'convert_global_env'
+
+Then, if your input-string contains a '$' character, convert it like
+so:
+
+    ConvertGlobalEnv.convert '$MY_SRC/ruby' # => "/home/x/src/ruby"
+
+Note that this **only** works if your ENV (environment) contains such
+a value. So if the value $MY_SRC is not defined then the above logically
+will not work.
+
+This can be a problem for some situations, such as in a .cgi file where
+no ENV variables exist, or on windows typically. For these reasons an
+alternative exists, if the **rcfile** gem is installed and available.
+
+## The method load_values_from_the_rcfiles_gem()
+
+The method load_values_from_the_rcfiles_gem() is normally not used,
+but you can use it specifically to load ENV-like variables if the
+**rcfiles** gem is installed.
+
+See the .cgi page in the test/ subdirectory at:
+ 
+    convert_global_env/test/testing_cgi_environment.cgi
+
+## Licence
+
+In **January** of **2022** the licence of this gem was changed to MIT. The
+primary reason for this is because this gem is used by several other gems
+which are mostly MIT-based. So it seemed simpler to have the same licence
+for this gem as well.
+
+ADD_CONTACT_INFORMATION

data/lib/convert_global_env/autoinclude.rb

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'convert_global_env/convert_global_env.rb'
+require 'convert_global_env/class/convert_global_env.rb'
 
-include ConvertGlobalEnv
+include ConvertGlobalEnv # Include the toplevel module namespace here.

data/lib/convert_global_env/class/convert_global_env.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ConvertGlobalEnv::ConvertGlobalEnv
+#
+# Usage example:
+#
+#   ConvertGlobalEnv::ConvertGlobalEnv.new(ARGV)
+#
+# =========================================================================== #
+# require 'convert_global_env/class/convert_global_env.rb'
+# =========================================================================== #
+module ConvertGlobalEnv
+
+class ConvertGlobalEnv # === ConvertGlobalEnv::ConvertGlobalEnv
+
+  alias e puts
+
+  require 'convert_global_env/constants/constants.rb'
+  require 'convert_global_env/version/version.rb'
+  require 'convert_global_env/toplevel_methods/toplevel_methods.rb'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_input_string(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @translated_string
+    # ======================================================================= #
+    @translated_string = ''.dup
+    # ======================================================================= #
+    # === @hash_containing_the_environment_values
+    #
+    # This Hash can also be different, but by default it will refer to
+    # the ENV variable.
+    # ======================================================================= #
+    @hash_containing_the_environment_values = ENV
+  end
+
+  # ========================================================================= #
+  # === hash_containing_the_environment_values?
+  # ========================================================================= #
+  def hash_containing_the_environment_values?
+    @hash_containing_the_environment_values
+  end; alias hash? hash_containing_the_environment_values? # === hash?
+
+  # ========================================================================= #
+  # === load_values_from_the_rcfiles_gem
+  #
+  # Only call this method if the rcfiles gem is installed, and if you really
+  # want to use the values from the .yml file that is contained in the
+  # rcfiles gem.
+  # ========================================================================= #
+  def load_values_from_the_rcfiles_gem
+    require 'rcfiles'
+    @hash_containing_the_environment_values = YAML.load_file(Rcfiles.file_global_variables)
+  end; alias load_custom_file load_values_from_the_rcfiles_gem # === load_custom_file
+
+  # ========================================================================= #
+  # === set_input_string
+  # ========================================================================= #
+  def set_input_string(i = '')
+    i = [i].flatten.compact.join(' ').strip
+    unless i.encoding.to_s == ::ConvertGlobalEnv.encoding?
+      i = i.dup if i.frozen?
+      i = i.force_encoding(::ConvertGlobalEnv.encoding?)
+    end
+    @input_string = i
+  end
+
+  # ========================================================================= #
+  # === input_string?
+  # ========================================================================= #
+  def input_string?
+    @input_string
+  end; alias input? input_string? # === input?
+
+  # ========================================================================= #
+  # === regex_to_use?
+  #
+  # Refer to the main regex for this project.
+  # ========================================================================= #
+  def regex_to_use?
+    REGEX_TO_CHECK_FOR_GLOBAL_ENV
+  end; alias main_regex? regex_to_use? # === main_regex?
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    do_the_conversion
+  end
+
+  # ========================================================================= #
+  # === do_the_conversion
+  #
+  # This is the method that does the actual conversion.
+  # ========================================================================= #
+  def do_the_conversion(
+      input = input_string?
+    )
+    regex = regex_to_use?
+    @translated_string = input.dup # Keep a reference copy here.
+    if input.include? '$'
+      input =~ regex
+      this_env_was_found = $1.to_s.dup
+      # ===================================================================== #
+      # Next check whether our main hash contains these environment
+      # values or not.
+      # ===================================================================== #
+      if @hash_containing_the_environment_values.include? this_env_was_found
+        @translated_string = input.gsub(
+          /#{this_env_was_found}/,
+          @hash_containing_the_environment_values[this_env_was_found]
+        ).delete('$')
+      end
+    end
+    return @translated_string
+  end; alias convert do_the_conversion # === convert
+
+  # ========================================================================= #
+  # === translated_string?
+  # ========================================================================= #
+  def translated_string?
+    @translated_string
+  end; alias result? translated_string? # === result?
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv::ConvertGlobalEnv[]
+  #
+  # Usage example:
+  #
+  #   x = ConvertGlobalEnv::ConvertGlobalEnv['umount $USB3']
+  #
+  # ========================================================================= #
+  def self.[](i = '')
+    new(i)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  ConvertGlobalEnv::ConvertGlobalEnv.new(ARGV)
+end # rawconvertglobalenv umount $USB3

data/lib/convert_global_env/{constants.rb → constants/constants.rb}

@@ -2,6 +2,8 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
+# require 'convert_global_env/constants/constants.rb'
+# =========================================================================== #
 module ConvertGlobalEnv
 
   # ========================================================================= #
@@ -16,6 +18,9 @@ module ConvertGlobalEnv
 
   # ========================================================================= #
   # === ConvertGlobalEnv::USE_THIS_ENCODING
+  #
+  # This constant denotes the default encoding that is used for the
+  # ConvertGlobalEnv namespace.
   # ========================================================================= #
   USE_THIS_ENCODING = ENCODING_UTF
 
@@ -26,10 +31,11 @@ module ConvertGlobalEnv
   #
   # See:
   #
-  #   https://rubular.com/r/tTX6lVBpSa
+  #   https://rubular.com/r/6oyCjKnaOZd8rz
   #
   # ========================================================================= #
   REGEX_TO_CHECK_FOR_GLOBAL_ENV =
-    /\$([A-Za-z_]+)+/
+    /\$\{?([A-Za-z_0-9]+)\}?/
+    # The old regex was: /\$\{?([A-Za-z_]+)\}?/
 
 end

data/lib/convert_global_env/toplevel_methods/toplevel_methods.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'convert_global_env/toplevel_methods/toplevel_methods.rb'
+# =========================================================================== #
+module ConvertGlobalEnv
+
+  # ========================================================================= #
+  # === @use_this_target_encoding
+  #
+  # This denotes the encoding in use. If we use the wrong encoding
+  # then failures may happen.
+  #
+  # Since as of 28.08.2020 we will default to UTF as encoding.
+  # ========================================================================= #
+  @use_this_target_encoding = USE_THIS_ENCODING
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv.encoding?
+  # ========================================================================= #
+  def self.encoding?
+    @use_this_target_encoding
+  end
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv.filename?
+  # ========================================================================= #
+  def self.filename?
+    _ = 'convert_global_env.rb'
+    _ = sfancy(_) if Object.const_defined? :Colours
+    return _ # This is the result.
+  end
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv[]
+  #
+  # This variant must always return the result, as-is.
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    ::ConvertGlobalEnv::ConvertGlobalEnv[i].result?
+  end; self.instance_eval { alias convert [] } # === ConvertGlobalEnv.convert
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv.new
+  #
+  # This is different in that it must always return a new instance of the
+  # ConvertGlobalEnv class itself.
+  # ========================================================================= #
+  def self.new(i = ARGV)
+    ::ConvertGlobalEnv::ConvertGlobalEnv.new(i)
+  end
+
+end

data/lib/convert_global_env/version/version.rb

@@ -2,11 +2,13 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
+# require 'convert_global_env/version/version.rb'
+# =========================================================================== #
 module ConvertGlobalEnv
 
   # ========================================================================= #
   # === ConvertGlobalEnv::VERSION
   # ========================================================================= #
-  VERSION = '1.0.23'
+  VERSION = '1.1.4'
 
 end

data/lib/convert_global_env.rb

@@ -2,4 +2,4 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'convert_global_env/convert_global_env.rb'
+require 'convert_global_env/class/convert_global_env.rb'

data/test/testing_cgi_environment.cgi

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/programming/ruby/src/convert_global_env/test/testing_cgi_environment.cgi
+# =========================================================================== #
+require 'cgi'
+require 'convert_global_env'
+
+alias e puts
+
+cgi = CGI.new 'html4' # Create a cgi object, with HTML 4 generation methods.
+e cgi.header
+
+e '<html><body>This is a simple test for the ENV variable.<br><br>
+First, we show how many variables are contained in ENV:'
+
+e ENV.keys.size.to_s+' entries <br><br>'
+e 'Evidently this does not contain the ENV I normally use.<br>
+For instance, $PROGRAMMING is not defined, so this
+will not yield anything: '+ConvertGlobalEnv['$PROGRAMMING'].to_s
+e '<br><br><hr>But now we will load support for my custom ENV:'
+_ = ConvertGlobalEnv.new
+_.load_custom_file
+e '<br><hr>And now, magically, $PROGRAMMING is defined \o/: '+
+  _.convert('$PROGRAMMING').to_s
+e '</body></html>'

data/test/testing_convert_global_env.rb

@@ -2,31 +2,61 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'colours/colours_e_autoinclude.rb'
-require 'convert_global_env/autoinclude'
+require 'colours/autoinclude'
+require 'convert_global_env'
 
-input = '$BIORUBY/bioshell/bio_shell.rb'
+# =========================================================================== #
+# === cliner
+# =========================================================================== #
+def cliner
+  e '='*80
+end
 
+print rev
+cliner
 e
-e 'Now testing some stuff. (Note that some of the variables will not exist.)'
-e
-e 'First, we test '+sfancy(input)
-e ' -> '+ConvertGlobalEnv.convert(input)
-e ' -> '+ConvertGlobalEnv.convert('test $IMG/rubyconvention2012')
-e ' -> '+ConvertGlobalEnv.convert('$SRC/RUBY')
-e ' -> '+ConvertGlobalEnv.convert('$T ee')
-e ' -> '+ConvertGlobalEnv.convert('$MY_PHP')
-e ' -> '+ConvertGlobalEnv.convert('--enable-bcmath --enable-calendar '\
-'--enable-cli --enable-dba=shared --enable-fastcgi --enable-force-redirect '\
-'--enable-force-cgi-redirect --enable-inline-optimization '\
-'--with-config-file-path=$MY_PHP '\
-'--with-iconv-dir=/Programs/Libiconv/Current/ '\
-'--with-gdbm --with-gmp --without-gd '\
-'--without-iconv --without-sqlite --disable-debug')
-e
-e "Next, we test Array as input, aka: %w( a b c )+['$MY_SRC/RUBY']:"
+e steelblue('Next testing the gem called "convert_global_env".')
+e steelblue('Keep in mind that not all tested input will cause a replacement to happen.')
+e steelblue('Thus, some test-cases will appear the same rather than show a difference.')
+e steelblue('In these cases the $VARIABLE does not exist, hence why nothing could be replaced.')
 e
-this_array = %w( a b c ) + ['$MY_SRC/RUBY']
-this_array = ConvertGlobalEnv.convert(this_array)
-e ' -> '+this_array.join("\n")
+# =========================================================================== #
+# The next array is the input we want to test against.
+# =========================================================================== #
+array_test_this_input = [
+  'umount $USB3',
+  'umount $USB3EGGGGGGGGGG',
+  '$BIORUBY/bioshell/bio_shell.rb',
+  'test $IMG/rubyconvention2012',
+  '$SRC/ruby',
+  '$MY_SRC/ruby',
+  '$T ee',
+  '$MY_PHP',
+  '$USB3',
+  'umount $USB3',
+  '--enable-bcmath --enable-calendar '\
+  '--enable-cli --enable-dba=shared --enable-fastcgi --enable-force-redirect '\
+  '--enable-force-cgi-redirect --enable-inline-optimization '\
+  '--with-config-file-path=$MY_PHP '\
+  '--with-iconv-dir=/Programs/Libiconv/Current/ '\
+  '--with-gdbm --with-gmp --without-gd '\
+  '--without-iconv --without-sqlite --disable-debug'
+]
+
+array_test_this_input.each {|entry|
+  e '  '+
+    tomato(entry.ljust(30))+
+    lightblue(' → ')+
+    steelblue(
+      ConvertGlobalEnv[entry]
+    )
+}
 e
+cliner
+e royalblue('Next we will test the rcfiles gem in combination with ConvertGlobalEnv.')
+_ = ConvertGlobalEnv.new
+e gold(_.hash?.keys.size)
+_.load_values_from_the_rcfiles_gem
+e gold(_.hash?.keys.size)
+e royalblue('The two values displayed above ^^^ should be different.')
+cliner

metadata

@@ -1,39 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: convert_global_env
 version: !ruby/object:Gem::Version
-  version: 1.0.23
+  version: 1.1.4
 platform: ruby
 authors:
 - Robert A. Heiler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-15 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies: []
 description: |2+
 
-      This module translates a string like $FOO/bar into the corresponding
-      ENV variable, i.e. ENV['FOO']+'/bar'.
-      It has no external dependencies.
+  This module translates a string like $FOO/bar into the corresponding
+  ENV variable, i.e. ENV['FOO']+'/bar'. This gem has no external
+  dependencies.
 
 email: shevy@inbox.lt
 executables: []
 extensions: []
-extra_rdoc_files:
-- USAGE.md
+extra_rdoc_files: []
 files:
-- USAGE.md
+- README.md
+- bin/convert_global_env
 - convert_global_env.gemspec
+- doc/README.gen
 - lib/convert_global_env.rb
 - lib/convert_global_env/autoinclude.rb
-- lib/convert_global_env/constants.rb
-- lib/convert_global_env/convert_global_env.rb
-- lib/convert_global_env/module_methods.rb
+- lib/convert_global_env/class/convert_global_env.rb
+- lib/convert_global_env/constants/constants.rb
+- lib/convert_global_env/images/logo/CONVERT_GLOBAL_ENV_LOGO.png
+- lib/convert_global_env/toplevel_methods/toplevel_methods.rb
 - lib/convert_global_env/version/version.rb
+- test/testing_cgi_environment.cgi
 - test/testing_convert_global_env.rb
 homepage: https://rubygems.org/gems/convert_global_env
 licenses:
-- GPL-2.0
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -48,12 +51,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.24
+      version: 3.3.13
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: This module translates a string like $FOO/bar into the corresponding ENV
-  variable, i.e. ENV['FOO']+'/bar'. It has no external dependencies.
+  variable, i.e. ENV['FOO']+'/bar'. This gem has no external dependencies.
 test_files: []
 ...

data/USAGE.md

@@ -1,15 +0,0 @@
-= Usage of Library
-
-== Description
-
-This small module converts a $FOO variable into an
-ENV variable.
-
-== Requiring it
-
-  require 'convert_global_env'
-
-== Using it in a project
-
-  ConvertGlobalEnv.convert('$FOO/BAR')
-  ConvertGlobalEnv['$FOO/BAR']

data/lib/convert_global_env/convert_global_env.rb

@@ -1,50 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# How would you use this software in your project?
-#
-# Well, first require it:
-#
-#   require 'convert_global_env'
-#
-# Then, feed it the string that contains a '$' character, like so:
-#
-#   ConvertGlobalEnv.convert '$SRC/RUBY'
-#
-# =========================================================================== #
-module ConvertGlobalEnv
-
-  require 'convert_global_env/module_methods.rb'
-  require 'convert_global_env/constants.rb'
-  require 'convert_global_env/version/version.rb'
-
-  alias e puts
-
-  # ========================================================================= #
-  # === @report_errors
-  # ========================================================================= #
-  @report_errors = true
-
-  # ========================================================================= #
-  # === @use_this_target_encoding
-  #
-  # This denotes the encoding in use. If we use the wrong encoding
-  # then failures may happen.
-  #
-  # Since as of 28.08.2020 we will default to UTF as encoding.
-  # ========================================================================= #
-  @use_this_target_encoding = USE_THIS_ENCODING
-
-  # ========================================================================= #
-  # === ConvertGlobalEnv.encoding?
-  # ========================================================================= #
-  def self.encoding?
-    @use_this_target_encoding
-  end
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  puts ConvertGlobalEnv.convert(ARGV.first)
-end # cgenv

data/lib/convert_global_env/module_methods.rb

@@ -1,99 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-module ConvertGlobalEnv
-
-  # ========================================================================= #
-  # === ConvertGlobalEnv.filename?
-  # ========================================================================= #
-  def self.filename?
-    _ = 'convert_global_env.rb'
-    _ = sfancy(_) if Object.const_defined? :Colours
-    _ # This is the result.
-  end
-
-  # ========================================================================= #
-  # === ConvertGlobalEnv.e
-  # ========================================================================= #
-  def self.e(i = '')
-    puts i
-  end
-
-  # ========================================================================= #
-  # === ConvertGlobalEnv.report_errors?
-  # ========================================================================= #
-  def self.report_errors?
-    @report_errors
-  end
-
-  # ========================================================================= #
-  # === ConvertGlobalEnv.be_quiet
-  # ========================================================================= #
-  def self.be_quiet
-    @report_errors = false
-  end
-
-  # ========================================================================= #
-  # === ConvertGlobalEnv[]
-  #
-  # Easier conversion variant. Will also honour the @report_errors
-  # class-instance variable.
-  # ========================================================================= #
-  def self.[](i)
-    ConvertGlobalEnv.convert(i, ConvertGlobalEnv.report_errors?)
-  end
-
-  # ========================================================================= #
-  # === ConvertGlobalEnv.convert(i)
-  #
-  # Use this method to convert from $FOO to ENV['FOO'], if $FOO exists.
-  #
-  # Specific usage examples:
-  #
-  #   ConvertGlobalEnv.convert '$SRC/RUBY'
-  #   ConvertGlobalEnv.convert '$MY_SRC/RUBY'
-  #
-  # ========================================================================= #
-  def self.convert(
-      i,
-      shall_we_report_errors = ConvertGlobalEnv.report_errors?
-    )
-    if shall_we_report_errors == :do_not_report_errors
-      shall_we_report_errors = false
-    end
-    if i.is_a? Array
-      i.map {|entry|
-        ConvertGlobalEnv.convert(entry, shall_we_report_errors)
-      } # Call recursively here.
-    else # Here come strings only.
-      # i.sub!(/\{/, '') # get rid of any { - Not a good idea. Disabled Sep 2012.
-      # i.sub!(/\}/, '') # get rid of any }
-      # ===================================================================== #
-      # We prefer ISO encoding here. No, we no longer do as of August 2020.
-      # ===================================================================== #
-      # case i.encoding.to_s
-      # # =================================================================== #
-      # # === ENCODING_UTF
-      # # =================================================================== #
-      # when ENCODING_UTF
-      #   i = i.dup if i.frozen?
-      #   i = i.force_encoding(ENCODING_ISO)
-      # end if File.exist?(i.to_s) # But only if the file exists.
-      unless i.encoding.to_s == ConvertGlobalEnv.encoding?
-        i = i.dup if i.frozen?
-        i = i.force_encoding(ConvertGlobalEnv.encoding?)
-      end
-      i =~ REGEX_TO_CHECK_FOR_GLOBAL_ENV # defined in this file here.
-      if $1 and ENV[$1]
-        i = i.to_s.dup # We want a clean String here.
-        i.gsub!("$#{$1}", ENV[$1]) unless ENV[$1].nil? # + "#{$2}"
-      else # Do nothing, except if you wish to debug.
-        # puts "The input: #{i} does not match against `#{REGEX_TO_CHECK_FOR_GLOBAL_ENV}`"
-        # pp $1; pp ENV[$1]
-      end
-      return i
-    end
-  end
-
-end