convert_global_env 1.0.23

checksums.yaml

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

data/USAGE.md

@@ -0,0 +1,15 @@
+= 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/convert_global_env.gemspec

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

data/lib/convert_global_env/autoinclude.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'convert_global_env/convert_global_env.rb'
+
+include ConvertGlobalEnv

data/lib/convert_global_env/constants.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ConvertGlobalEnv
+
+  # ========================================================================= #
+  # === ENCODING_ISO
+  # ========================================================================= #
+  ENCODING_ISO = 'ISO-8859-1'
+
+  # ========================================================================= #
+  # === ENCODING_UTF
+  # ========================================================================= #
+  ENCODING_UTF = 'UTF-8'
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv::USE_THIS_ENCODING
+  # ========================================================================= #
+  USE_THIS_ENCODING = ENCODING_UTF
+
+  # ========================================================================= #
+  # === REGEX_TO_CHECK_FOR_GLOBAL_ENV
+  #
+  # The regex to check for the global env.
+  #
+  # See:
+  #
+  #   https://rubular.com/r/tTX6lVBpSa
+  #
+  # ========================================================================= #
+  REGEX_TO_CHECK_FOR_GLOBAL_ENV =
+    /\$([A-Za-z_]+)+/
+
+end

data/lib/convert_global_env/convert_global_env.rb

@@ -0,0 +1,50 @@
+#!/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

@@ -0,0 +1,99 @@
+#!/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

data/lib/convert_global_env/version/version.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module ConvertGlobalEnv
+
+  # ========================================================================= #
+  # === ConvertGlobalEnv::VERSION
+  # ========================================================================= #
+  VERSION = '1.0.23'
+
+end

data/lib/convert_global_env.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'convert_global_env/convert_global_env.rb'

data/test/testing_convert_global_env.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/colours_e_autoinclude.rb'
+require 'convert_global_env/autoinclude'
+
+input = '$BIORUBY/bioshell/bio_shell.rb'
+
+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
+this_array = %w( a b c ) + ['$MY_SRC/RUBY']
+this_array = ConvertGlobalEnv.convert(this_array)
+e ' -> '+this_array.join("\n")
+e

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: convert_global_env
+version: !ruby/object:Gem::Version
+  version: 1.0.23
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-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.
+
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files:
+- USAGE.md
+files:
+- USAGE.md
+- convert_global_env.gemspec
+- 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/version/version.rb
+- test/testing_convert_global_env.rb
+homepage: https://rubygems.org/gems/convert_global_env
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.24
+requirements: []
+rubygems_version: 3.2.24
+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.
+test_files: []
+...