opensecret 0.0.951 → 0.0.957

data/lib/opensecret/factbase/published.facts/credential-facts.ini

@@ -1,40 +0,0 @@
-
-# --
-# -- If a plugin requires AWS IAM user credentials you must
-# -- define the directory the credentials are in within the
-# -- [plugin+platform] fact file.
-# --
-# -- A credentials INI factfile is expected to exist within
-# -- that directory with the name
-# --
-# --    => [:eco][id] + ".aws.credentials.ini"
-# --    => ci.hub.aws.credentials.ini [(if id is ci.hub)]
-# --
-# -- To specify AWS IAM credentials for a plugin, you
-# --
-# --   [1] specify [:aws][:keys_folder] in [plugin+platform]
-# --   [2] put <<eco.id>>.aws.credentials.ini inside folder
-# --
-# -- The format of the credentials file for a plugin ID of
-# -- (ci.hub) named [ci.hub.aws.credentials.ini] would be
-# --
-# --  [ci.hub]
-# --  aws.access.key  =  AKIA12345
-# --  aws.secret.key  =  abc123secret
-# --  aws.region.key  =  us-east-2
-# --
-# -- ----------------------------
-# -- AWS Credentials | Summary
-# -- ----------------------------
-# --
-# -- [One] plugin running on [a] workstation or inside [a]
-# -- container can only use [one] set of IAM user credentials
-# -- located in [an] accessible folder (on a removable drive).
-# --
-
-[aws]
-creds.name      =  e>> @f[:eco][:id] + Do.t + "aws.credentials.ini"
-dir.exists?     =  e>> !@f[@i[:workstation]][:aws_creds_dir].nil?
-creds.path(if)  =  { @s[:dir_exists?] } e>> File.join @f[@i[:workstation]][:aws_creds_dir], @s[:creds_name]
-creds.exist?    =  e>> exists?(@s[:creds_path]) && File.exists?(@s[:creds_path])
-

data/lib/opensecret/factbase/published.facts/infrastructure-facts.ini

@@ -1,63 +0,0 @@
-
-[terraform]
-aws.instance.id =  e>> "ec2-" + @f[:stamp][:mini_2]
-aws.sgroup.id   =  e>> "acl-" + @f[:stamp][:mini_2]
-route53.dns.id  =  e>> "dns-" + @f[:stamp][:mini_2]
-route53.www.id  =  e>> "www-" + @f[:stamp][:mini_2]
-route53.ssl.id  =  e>> "ssl-" + @f[:stamp][:mini_2]
-resource.group  =  e>> @f[:stamp][:midi]
-
-ec2.acl.name    =  e>> "acl." + @f[:stamp][:midi]
-ec2.tag.name    =  e>> "ec2." + @f[:stamp][:midi]
-ebs.tag.name    =  e>> "ebs." + @f[:stamp][:midi]
-ec2.acl.desc    =  e>> "Rules (acl) for the " + @f[:stamp][:midi] + " tcp/ip traffic."
-
-username        =  ubuntu
-keypair.name    =  e>> "keypair." + @f[:stamp][:midi]
-private.key     =  e>> File.join @f[:runtime][:dir], ( @s[:keypair_name] + ".pem" )
-
-aws.exe.win     =  windows_amd64/terraform-provider-aws_v1.7.0_x4.exe
-aws.exe.linux   =  linux_amd64/terraform-provider-aws_v1.6.0_x4
-
-exe.filename(if)=  { Gem.win_platform? } e>> @s[:aws_exe_win]
-exe.filename(un)=  { Gem.win_platform? } e>> @s[:aws_exe_linux]
-exe.source.dir  =  e>> File.join @f[:runtime][:dir], ".terraform/plugins"
-
-ec2.host        =  e>> LinuxHost.ec2_using_terraform( \
-                               @s[:username],         \
-                               @s[:private_key],      \
-                               @f[:runtime][:dir],    \
-                               @s[:keypair_name],     \
-                               @s[:exe_filename],     \
-                               @s[:exe_source_dir],   \
-                               @f[:runtime][:archive] \
-                       )
-
-
-[domain]
-has.domain?     =  e>> exists?( @p[:root_domain] )
-root(if)        =  { @s[:has_domain?] } e>> @p[:root_domain]
-www(if)         =  { @s[:has_domain?] } e>> "www" + dot + @s[:root]
-https(if)       =  { @s[:has_domain?] } e>> "https://"  + @s[:www]
-http(if)        =  { @s[:has_domain?] } e>> "http://"   + @s[:www]
-
-
-[machine]
-suffix          =  host
-name.known?     =  e>> exists?(@f[@i[:workstation]][plugin_symbol(@s[:suffix])])
-
-fact.name(if)   =  { @s[:name_known?] } e>> @f[@i[:workstation]][plugin_symbol(@s[:suffix])]
-key.name(if)    =  { @s[:name_known?] } e>> @s[:fact_name] + ".ssh.key.pem"
-ssh.key(if)     =  { @s[:name_known?] } e>> File.join @f[@i[:workstation]][:ssh_keydir], @s[:key_name]
-user.name(if)   =  { @s[:name_known?] } e>> @f[symbol(@s[:fact_name])][:username]
-host.name(if)   =  { @s[:name_known?] } e>> @f[symbol(@s[:fact_name])][:hostnames].first
-net.bridge(if)  =  { @s[:name_known?] } e>> @f[symbol(@s[:fact_name])][:net_bridge]
-
-host.class(if)  =  { @s[:name_known?] } e>> LinuxHost.existing_host( \
-                            @s[:host_name], \
-			    @s[:user_name], \
-			    @s[:ssh_key],   \
-			    @s[:net_bridge] \
-                            )
-
-host.class(un)  =  { @s[:name_known?] } e>> @f[:terraform][:ec2_host]

data/lib/opensecret/factbase/readme.md

@@ -1,24 +0,0 @@
-
-# Fact File Read Order
-
-Fact files are assimilated in a simple yet powerful manner.
-
-## Assimilation Order
-
-The fact files are assimilated in this order
-
- - first the **core fact files** in the **reusable.facts** folder
- - next is the **plugin's fact file** eg ***gitlab.dev.ini*** in reusable.plugins/gitlab.dev
- - then every fact file in the **reusable.facts/general** directory and subdirectories
- - then it is all the fact files declared for **import via HTTP, SCP, SFTP and Rest APIs**
- - then from **git repositories, key-value stores** (etcd, redis) and **(nosql) databases**
- - finally, **credential fact files on removable media**, in vaults and key pass structures
-
-## Indexing for Large Fact Repositories
-
-Once the third reusable.facts/general store becomes **large** we could devise methods of
-
- - **indexing** all the **long-lived facts** as and when they are produced
- - **mining fact dependencies** from plugin software, fact files and templates
- - then **importing** just the needful set of facts (and their dependencies)
-

data/lib/opensecret/factbase/retired.facts/maven.database.ide.facts.ini

@@ -1,127 +0,0 @@
-[database]
-name            =  app_datastore
-admin.username  =  e>> "admin.usr." + Stamp.yyjjj_hhmm_sst
-admin.password  =  e>> Secrets.derive_alphanum
-app.username    =  e>> "app.usr." + Stamp.yyjjj_hhmm_sst
-app.password    =  e>> Secrets.derive_alphanum
-
-content.url     =  https://www.eco-platform.co.uk/content/database.git/
-content.name    =  e>> "db.content." + Stamp.yyjjj_hhmm_sst
-content.zip     =  e>> @f[:database][:content_name] + ".zip"
-content.files   =  e>> GitFlow.file_names @f[:database][:content_url]
-content.path    =  /var/lib/mongodb/content.library
-
-import.stmts    =  e>> MongoFlow.to_inport_stmts(     \
-                          @f[:database][:content_files], \
-		          @f[:database][:content_path],  \
-		          @f[:database][:database_name], \
-		          @f[:database][:app_username],  \
-		          @f[:database][:app_password]   \
-		          )
-
-
-[rest]
-docs.url        =  https://www.eco-platform.co.uk/content/rest.documents.git/
-docs.offset     =  application.objects/
-zip.basename    =  e>> @f[:s3][:upload_prefix] + "application.objects"
-zip.filename    =  e>> @f[:rest][:zip_basename] + ".zip"
-
-
-[ide]
-idea.iml.dir    =  e>> File.join @f[:runtime][:dir], "idea_modules"
-conf.repo.url   =  https://www.eco-platform.co.uk/content/intellij.conf.git/
-conf.base.dir   =  e>> File.join @f[:runtime][:dir], "ide_config"
-conf.dir.name   =  apollo.laundry4j
-conf.home.dir   =  e>> File.join @f[:ide][:conf_base_dir], @f[:ide][:conf_dir_name]
-
-idea.prop.src   =  e>> File.join @f[:runtime][:dir], "asset.idea.properties"
-idea.prop.dir   =  C:/Program Files (x86)/JetBrains/IntelliJ IDEA Community Edition 14.0.2/bin
-idea.prop.dst   =  e>> File.join @f[:ide][:idea_prop_dir], "idea.properties"
-
-options.base.dir  = e>> File.join @f[:runtime][:dir], "ide_config/apollo.laundry4j/options"
-default.xml.file  = project.default.xml
-default.xml.path  = e>> File.join @f[:ide][:options_base_dir], @f[:ide][:default_xml_file]
-
-
-[maven]
-jar.projects    = e>> %w[                                                              \
-	                    https://www.eco-platform.co.uk/commons/laundry4j.facility  \
-                            https://www.eco-platform.co.uk/commons/laundry4j.mappable  \
-		      	    https://www.eco-platform.co.uk/commons/laundry4j.mappers   \
-		            https://www.eco-platform.co.uk/commons/laundry4j.clusters  \
-		      	    https://www.eco-platform.co.uk/football/footb4ll.net       \
-		            https://www.eco-platform.co.uk/commons/laundry4j.explorer  \
-			   ]
-
-
-install.dir     =  C:/Program Files/apache-maven-3.3.9
-settings.xml    =  C:/Program Files/apache-maven-3.3.9/conf/settings.xml
-version.dev     =  e>> Stamp.yyjjj_hhmm_sst + "-SNAPSHOT"
-version.push    =  e>> Stamp.yyjjj_hhmm_sst
-
-builds.dir      =  e>> File.join @f[:runtime][:dir], "maven_builds"
-amalgam.dir     =  e>> File.join @f[:runtime][:dir], "maven_projects"
-javadocs.dir    =  e>> File.join @f[:runtime][:dir], "maven_javadocs"
-apidocs.dir     =  e>> File.join @f[:maven][:javadocs_dir], "site/apidocs"
-pom.xml.src     =  e>> File.join @f[:runtime][:dir], "asset.amalgam.pom.xml"
-pom.xml.dst     =  e>> File.join @f[:maven][:amalgam_dir], "pom.xml"
-
-css.file.src    =  e>> File.join @f[:runtime][:dir], "asset.stylesheet.css"
-css.file.dst    =  e>> File.join @f[:maven][:apidocs_dir], "stylesheet.css"
-
-index.html.src  =  e>> File.join @f[:maven][:apidocs_dir], "overview-summary.html"
-index.html.dst  =  e>> File.join @f[:maven][:apidocs_dir], "index.html"
-
-cmd.prefix      =  e>> "mvn -f " + @f[:maven][:pom_xml_dst] + " clean "
-cmd.javadocs    =  e>> @f[:maven][:cmd_prefix] + "javadoc:aggregate source:aggregate"
-
-war.project     =  https://www.eco-platform.co.uk/commons/laundry4j.web
-war.module      =  e>> Pom.get_module_name @f[:maven][:war_project]
-projects        =  e>> @f[:maven][:jar_projects].push @f[:maven][:war_project]
-war.prj.dir     =  e>> File.join @f[:maven][:amalgam_dir], @f[:maven][:war_module]
-war.pom.xml     =  e>> File.join @f[:maven][:war_prj_dir], "pom.xml"
-war.run.cmd     =  e>> "mvn  -f " + @f[:maven][:war_pom_xml] + " cargo:run -P tomcat8x"
-
-module.names    =  e>> Pom.get_module_names @f[:maven][:projects]
-module.lines    =  e>> Refactor.sandwich_lines @f[:maven][:module_names], "<module>", "</module>", 16
-
-no1.prj.dir     =  e>> File.join @f[:maven][:amalgam_dir], @f[:maven][:module_names].first
-no1.pom.xml     =  e>> File.join @f[:maven][:no1_prj_dir], "pom.xml"
-version.cmd     =  e>> "mvn -f " + @f[:maven][:no1_pom_xml] + " versions:set -DgroupId=com.* -DartifactId=* -DnewVersion=" + @f[:maven][:version_dev] + " -DgenerateBackupPoms=false"
-
-
-############ mvn -f facility/pom.xml versions:set -DgroupId=com.* -DartifactId=* -DnewVersion=77.77.00-SNAPSHOT
-###### http://localhost:8899/explorer-17.263.1858-SNAPSHOT
-
-# --
-# -- Create ruby/maven commands that act on one or more projects
-# -- Command examples
-# --   - system "mvn -f maven_projects/customer/pom.xml clean install"
-# --
-install.opts = clean install
-install.cmd = e>> "mvn -f " + @f[:maven][:pom_xml_dst] + " clean install"
-
-## cmd.prefix   = e>> "system " + Ch.dq + "mvn -f maven_projects/"
-## cmd.postfix  = /pom.xml
-
-
-[git]
-base.url        =  https://www.eco-platform.co.uk
-local.dir       =  e>> File.dirname Dir.pwd
-dot.git.dir     =  e>> File.join @f[:git][:local_dir], ".git"
-revision        =  e>> GitFlow.wc_revision @f[:git][:dot_git_dir]
-ssh.keyfile     =  e>> File.join Home.dir, "com.laundry4j.drive/library.ssh.access.keys/gitlab.laundry4j.private.key.pem"
-
-[git.content]
-url             =  e>> File.join @f[:git][:base_url], "content"
-
-
-[git.commons]
-url             =  e>> File.join @f[:git][:base_url], "commons"
-eco.proj.name   =  eco-platform
-eco.repo.name   =  e>> @s[:eco_proj_name] + ".git"
-eco.repo.url    =  e>> File.join @s[:url], @s[:eco_repo_name]
-
-
-
-

data/lib/opensecret/factbase/retired.facts/s3-upload-block-facts.ini

@@ -1,17 +0,0 @@
-# --- --------------------------------------------------------------------- --- #
-# --- This fact (INI) file database carries facts for the s3 upload block.  --- #
-# --- --------------------------------------------------------------------- --- #
-# --- [DEPENDENCY] => @f[:upload][:src_file_name]                          --- #
-# ---              => This dependency must be set before fact evaluation.   --- #
-# --- --------------------------------------------------------------------- --- #
-
-[upload]
-src.file.path = e>> File.join @f[:runtime][:dir], @f[:upload][:src_file_name]
-dot.full.extn = e>> File.extname @f[:upload][:src_file_path]
-src.base.name = e>> File.basename @f[:upload][:src_file_name], @f[:upload][:dot_full_extn]
-prefix.less.name = e>> @f[:upload][:src_base_name][ @f[:s3][:upload_prefix].length .. -1 ]
-app.props.base = e>> @f[:upload][:prefix_less_name] + @f[:upload][:dot_full_extn]
-app.props.key = e>> (@f[:upload][:app_props_base] + Ch.p + "url").gsub(".","_").to_sym
-dst.file.base = e>> @f[:upload][:prefix_less_name] + Ch.p + @f[:stamp][:midi]
-dst.file.name = e>> @f[:upload][:dst_file_base] + @f[:upload][:dot_full_extn]
-dst.file.path = e>> File.join @f[:s3][:uploads_dir], @f[:upload][:dst_file_name]

data/lib/opensecret/plugins.io/file/file.rb

@@ -1,483 +0,0 @@
-#!/usr/bin/ruby
-
-# -- --------------------------------------------------------------- -- #
-# -- File facts are placeholders (keys in effect) just begging to be -- #
-# -- replaced by values sourced from some sort of map. This software -- #
-# -- centres around the DevOps fact replacement placeholder pattern. -- #
-# -- --------------------------------------------------------------- -- #
-class Files
-#### ==> ===================================================================================
-#### ==> ===================================================================================
-#### ==> Name this class FindReplace or simply just Replace => Replace.contains? Replace.do
-#### ==> Name this class FindReplace or simply just Replace => Replace.contains? Replace.do
-#### ==> Name this class FindReplace or simply just Replace => Replace.contains? Replace.do
-#### ==> Name this class FindReplace or simply just Replace => Replace.contains? Replace.do
-#### ==> Name this class FindReplace or simply just Replace => Replace.contains? Replace.do
-#### ==> Name this class FindReplace or simply just Replace => Replace.contains? Replace.do
-#### ==> Name this class FindReplace or simply just Replace => Replace.contains? Replace.do
-#### ==> ===================================================================================
-#### ==> ===================================================================================
-
-
-
-    ## --- ---------------------------------------------------------------------- --- #
-    ## --- How to Use File to extract different parts of an [absolute] file path. --- #
-    ## --- ---------------------------------------------------------------------- --- #
-    ### File Names ====] file = "/path/to/xyz.mp4"
-    ### File Names ====] comp = File.basename file        # => "xyz.mp4"
-    ### File Names ====] extn = File.extname  file        # => ".mp4"
-    ### File Names ====] name = File.basename file, extn  # => "xyz"
-    ### File Names ====] path = File.dirname  file        # => "/path/to"
-    ## --- ---------------------------------------------------------------------- --- #
-
-
-  # --
-  # -- Scan every file in directory for placeholder keys within the
-  # -- parameter map and replace them with the corresponding value.
-  # -- Not Recursive => the scan does [not] recurse into folders
-  # --
-  # -- ----------------------------------
-  # -- Replacing Betty (Nested Replace)
-  # -- ----------------------------------
-  # --
-  # -- "GoBBetBettytyettyne" => "Gone"
-  # --
-  # -- A nested replace is done up to approximately 5 levels deep.
-  # -- So replacing "Betty" from the above string does [NOT] produce
-  # -- "GoBBettyettyne". The string becomes "Gone".
-  # --
-  # -- -----------
-  # -- Parameters
-  # -- -----------
-  # --   fact_map    : driving [placeholder] => [value] map
-  # --   replace_dir : dir subject of the scan and replace
-  # --
-  def self.find_replace fact_map, replace_folder
-
-    log.info(ere){ "#-- --------------------------------------------------------- #" }
-    log.info(ere){ "#-- File changing in #{File.basename replace_folder}" }
-    log.info(ere){ "#-- #{replace_folder}" }
-    log.info(ere){ "#-- --------------------------------------------------------- #" }
-
-    # -- ------------------------------------------------------------------------------ -- #
-    # -- Iterate to substitute matched strings in file with their corresponding values. -- #
-    # -- ------------------------------------------------------------------------------ -- #
-    Dir.foreach( replace_folder ) do | file_name |
-
-      file_path = File.join replace_folder, file_name
-      next if File.directory? file_path
-      next if File.extname(file_path).eql? ".log"
-
-      nested_key_replace fact_map, file_path
-
-    end
-
-    log.info(ere){ "#-- --------------------------------------------------------- #" }
-    log.info(ere){ "#-- Done changing files in #{File.basename replace_folder}" }
-    log.info(ere){ "#-- --------------------------------------------------------- #" }
-    
-  end
-
-  #--
-  #-- Using the parameter [file] [replace] any occurence
-  #-- of any [key] found in the parameter [map] with the
-  #-- corresponding mapped key [value].
-  #--
-  #-- -----------------------------------
-  #-- [Nested Replace]
-  # -- Replacing Betty (Nested Replace)
-  # -- ----------------------------------
-  # --
-  # -- "GoBBetBettytyettyne" => "Gone"
-  # --
-  # -- A nested replace is done up to approximately 5 levels deep.
-  # -- So replacing "Betty" from the above string does [NOT] produce
-  # -- "GoBBettyettyne". The string becomes "Gone".
-  # --
-  def self.nested_key_replace source_map,  filepath
-
-    for i in 1..5
-      file_changed = key_replace source_map, filepath
-      return unless file_changed
-      log.info(ere){ "#-- --------------------------------------------------------- #" }
-      log.info(ere){ "#-- File #{File.basename filepath} has been changed" }
-      log.info(ere){ "#-- --------------------------------------------------------- #" }
-    end
-
-  end
-
-  #--
-  #-- Using the parameter [file] [replace] any occurence
-  #-- of any [key] found in the parameter [map] with the
-  #-- corresponding mapped key [value].
-  #--
-  #-- Side Effect => If at least one replacement occured this
-  #--                method returns true, else false.
-  #--
-  def self.key_replace source_map,  filepath
-
-      replace_happened = false
-
-      source_map.each do |theKey, theValue|
-
-        next unless has_string? filepath, theKey
-        factorize theKey, theValue, filepath
-        replace_happened = true
-
-      end
-
-      return replace_happened
-
-  end
-
-
-  
-  #--
-  #-- Produce a map of every "recursive" file sitting under
-  #-- any and all of the parameter directories array.
-  #--
-  #-- Harboured folders are traversed but folder names are
-  #-- excluded from the resulting map.
-  #--
-  #-- The key/value structure of the map is
-  #--
-  #--   key   => simple filename
-  #--   value => (abs) folder path
-  #--
-  #-- --------------------------------
-  #-- Filename NOT UNIQUE Exception
-  #-- --------------------------------
-  #--
-  #-- Simple filename UNIQUENESS must prevail.
-  #--
-  #-- If the same base filename is found in any part or level
-  #-- of the directory trees under the every parameter parent
-  #-- folder - an exception will be thrown.
-  #--
-  def self.in_folders parent_folders
-
-    files_map = {}
-
-    parent_folders.each do |parent_folder|
-
-      log.info(ere) { "Create map of files under #{nickname parent_folder}" }
-      Throw.if_not_exists parent_folder
-
-      Dir["#{parent_folder}/**/*"].each do |child_file|
-
-        next if File.directory? child_file
-        filename = File.basename child_file
-        foldername = File.dirname child_file
-        log.info(ere) { " #{filename} => #{nickname foldername}" }
-        error_str = "Name NOT UNIQUE Error => [#{filename}].\n\n#{files_map.inspect}"
-        raise RuntimeError.new error_str if files_map.has_key? filename
-        files_map.store filename, foldername
-
-      end
-
-    end
-
-    return files_map
-
-  end
-
-
-  #--
-  #-- Find files of a given type (extension) that exist
-  #-- recursively under a folder.
-  #--
-  #-- --------------------------------
-  #-- Filename NOT UNIQUE Exception
-  #-- --------------------------------
-  #--
-  #-- Simple filename UNIQUENESS must prevail.
-  #--
-  #-- If the same base filename is found in any part or level
-  #-- of the directory trees under the every parameter parent
-  #-- folder - an exception will be thrown.
-  #--
-  #-- ------------
-  #-- Parameters
-  #-- ------------
-  #--
-  #--  base_folder => the top-level folder to search
-  #--               dir at (abs) path must exist
-  #--
-  #--  file_extn => extension of interesting files
-  #--               including the leading [period].
-  #--               (send ".exe" for exe files)
-  #--               (send ".md" for markdown files)
-  #--
-  #-- ------------
-  #-- Map Returned
-  #-- ------------
-  #--
-  #-- Returns a { filename => rel_path } map of the matching
-  #-- files in the folder. The map
-  #--
-  #--   keys   => simple filename without extension
-  #--   values => relative path from the base folder
-  #--
-  def self.to_name_path_map base_folder, file_extn
-
-    files_map = {}
-
-    Dir["#{base_folder}/**/*#{file_extn}"].each do |filepath|
-
-      next if File.directory? filepath
-      ext_error = "File extension not [#{file_extn}] in => #{nickname filepath}"
-      raise RuntimeError.new(ext_error) unless File.extname(filepath).eql? "#{file_extn}"
-
-      filename = File.basename filepath
-
-      error_str = "Name NOT UNIQUE Error => [#{filename}].\n\n#{files_map.inspect}"
-      raise RuntimeError.new error_str if files_map.has_key? filename
-      files_map.store filename, filepath
-
-    end
-
-    return files_map
-
-  end
-
-
-  #--
-  #-- Return a new map with the values folder path
-  #-- forwarded by one level
-  #--
-  #-- If the map contains the below
-  #--
-  #--  {
-  #--    file1 => user/docs/pdfs,
-  #--    file2 => user/docs/pdfs/good,
-  #--    file3 => user/docs/pdfs/bad
-  #--  }
-  #--
-  #-- This method will return a map like this
-  #--
-  #--  {
-  #--    file1 => docs/pdfs,
-  #--    file2 => docs/pdfs/good,
-  #--    file3 => docs/pdfs/bad
-  #--  }
-  #--
-  #-- The values part has been forwarded by one level.
-  #--
-  def self.forwarded_path files_map
-
-    changed_map = {}
-
-    files_map.each do |the_name, the_old_path|
-      the_new_path = the_old_path.split("/")[1..-1].join("/")
-      changed_map.store the_name, the_new_path
-      log.info(ere){ "Forwarded from #{the_old_path} to #{the_new_path}" }
-    end
-
-    return changed_map
-
-  end
-
-
-  #--
-  #-- Path stripper expects the path in the first parameter
-  #-- to start with the path in the second parameter.
-  #--
-  #-- It then returns the first parameter path with the
-  #-- leading path stripped out.
-  #--
-  #-- ---------------------------
-  #-- Strip Leading Path Example
-  #-- ---------------------------
-  #--
-  #-- 1st param path = /home/joe/docs/pdfs/websites
-  #-- 2nd param path = /home/joe/docs
-  #--  Returned Path = pdfs/websites
-  #--
-  #-- ---------------------------------
-  #-- The Middle Separator is Stripped
-  #-- ---------------------------------
-  #--
-  #-- Note above that the middle separator is stripped
-  #-- so the returned string has no leading separator.
-  #--
-  def self.lead_path_chopped long_path, lead_path
-
-    return long_path.gsub(lead_path, "")[1..-1]
-
-  end
-
-
-  # -- ------------------------------------------------------------------- -- #
-  # -- Returns true when the parameter file contains the parameter string. -- #
-  # -- As a side effect the lines with at least 1 string match are logged. -- #
-  # -- ------------------------------------------------------------------- -- #
-  def self.has_string? the_file, theString
-
-    containsMatch = false;
-    line_index = 0;
-
-    File.open( the_file, "r") do | file_obj |
-
-      name_abbrv = File.basename the_file
-      file_obj.each_line do | file_line |
-
-        line_index = line_index + 1
-        lineCount = sprintf '%03d', line_index
-        if file_line.include? theString then
-
-          squeezed_line = file_line.chomp.strip.squeeze(" ")
-          log.info(ere) { "== string [#{theString}] occurs @line #{lineCount} in #{name_abbrv}" }
-          log.info(ere) { "==  |---> #{squeezed_line}" }
-          containsMatch = true
-
-        end
-
-      end
-      
-    end
-
-    return containsMatch;
-
-  end
-
-
-  # --
-  # -- [FIND] lines that include a set of configured strings and
-  # -- [REPLACE] then with the configured alternative.
-  # --
-  # -- -----------
-  # -- Parameters
-  # -- -----------
-  # --
-  # --   filepath : path to existing "to be changed" file
-  # --   includes : include string array for line matching
-  # --   new_line : replace the matched line with this str
-  # --
-  # -- --------------------------------
-  # -- Dependencies and Assumptions
-  # -- --------------------------------
-  # --
-  # --   file exists at filepath
-  # --
-  def self.find_replace_lines filepath, includes, new_line
-
-    Throw.if_not_exists filepath
-    Throw.if_nil includes
-    Throw.if_nil new_line
-
-    line_matches_count = 0;
-    new_file_lines_set = ""
-
-    File.open( filepath, "r") do | file_obj |
-
-      file_obj.each_line do | file_line |
-
-        unless (String.includes_all?( file_line, includes ) ) then
-          new_file_lines_set += file_line
-          next
-        end
-
-        ++line_matches_count
-        new_file_lines_set += new_line
-
-        log.info(ere) { "[replace] - ------------------------------------------------------- ##" }
-        log.info(ere) { "[replace] - file name => #{File.basename filepath}" }
-        log.info(ere) { "[replace] - has words => #{pp includes}" }
-        log.info(ere) { "[replace] - orig line => #{file_line}" }
-        log.info(ere) { "[replace] - -------   ---------    -------    ----------   ------   ##" }
-        log.info(ere) { "[replace] - outgoing line => #{file_line}" }
-        log.info(ere) { "[replace] - incoming line => #{new_line}" }
-        log.info(ere) { "[replace] - -------   ---------    -------    ----------   ------   ##" }
-
-      end
-      
-    end
-
-    # -- ---------------------------------------------------------- -- #
-    # -- [(over)write] new set of file lines to the parameter file. -- #
-    # -- ---------------------------------------------------------- -- #
-    File.write filepath, new_file_lines_set
-    LogObject.file filepath, "replace"
-
-  end
-
-
-  # --
-  # -- Write the 1D key/value map into a properties
-  # -- file at the parameter folder.
-  # --
-  # -- Parameters
-  # --   properties_map : the key/value map to serialize
-  # --   props_dir_path : folder holding new properties file
-  # --   props_filename : name of the new properties file
-  # --
-  # -- Dependencies and Assumptions
-  # --   the directory will be created if it does not exist
-  # --   we assume the properties file DOES NOT EXIST
-  # --   the map is 1D and is not nil (can be empty)
-  # --   the directory is writeable by the user
-  # --
-  def self.write_properties properties_map, props_dir_path, props_filename
-
-    Dir.mkdir props_dir_path unless File.exists? props_dir_path
-    prop_filepath = File.join props_dir_path, props_filename
-    File.write prop_filepath, to_properties_text(properties_map)
-
-    LogObject.file prop_filepath, "write properties"
-
-  end
-
-
-  # --
-  # -- Create txt file in the properties format containing
-  # -- a dictionary of name/value pairs separated by an
-  # -- equals sign.
-  # --
-  # -- Parameters
-  # --   properties_map : the key/value map to serialize
-  # --
-  # -- Dependencies and Assumptions
-  # --   the map is 1D and is not nil (can be empty)
-  # --   map keys are SYMBOLS so underscores are made dots
-  # --
-  def self.to_properties_text properties_map
-
-    hdr_1 = "## Properties file with [#{properties_map.length}] key/value pairs.\n"
-    hdr_u = "## @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ ##\n"
-
-    property_text = hdr_u + hdr_1 + hdr_u + "\n"
-    properties_map.each do |key_symbol,value|
-      key_string = key_symbol.to_s.gsub("_", ".")
-      property_text += "#{key_string}=#{value}\n"
-    end
-
-    property_text += "\n" + hdr_u
-    return property_text
-
-  end
-
-
-  # -- ---------------------------------------------------------- -- #
-  # -- When the [file fact] replace [behaviour] is called against -- #
-  # -- a "file" it [replaces all occurrences] (as best it can) of -- #
-  # -- the given string within the file. Call replace occurrences -- #
-  # -- against a folder and it replaces in all constituent files. -- #
-  # -- ---------------------------------------------------------- -- #
-  # -- Be careful = this implementation is not that clever. So if -- #
-  # -- we try to replace all "Betty" occurrences - lines that may -- #
-  # -- contain ["BetBettyty"] will likely end up with a ["Betty"] -- #
-  # -- ---------------------------------------------------------- -- #
-  def self.factorize from_string, to_string, in_file
-
-    the_filename = File.basename in_file
-
-    log.info(ere) { "From String => #{from_string}" }
-    log.info(ere) { "[To] String => #{to_string}" }
-    log.info(ere) { "File [Name] => #{the_filename}" }
-
-    File.write( in_file, File.open( in_file, &:read ).gsub( from_string, to_string ) );
-
-  end
-
-
-end