rbt 0.16.12 → 0.16.14

data/lib/rbt/actions/individual_actions/software_manager/query_related_methods.rb

@@ -12,6 +12,127 @@ class Action
 
 class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
 
+  # ========================================================================== #
+  # === will_the_extracted_source_archive_be_removed?
+  #
+  # A boolean value will be returned by this method. This boolean value
+  # determines whether the archive will be kept after it was extracted,
+  # or whether it will be removed again after it was extracted. 
+  # ========================================================================== #
+  def will_the_extracted_source_archive_be_removed?
+    result = !cookbook_dataset_keep_extracted? # ← The default.
+    # ======================================================================== #
+    # Next check whether the user overrided this behaviour or not, via
+    # the appropriate commandline-flag:
+    # ======================================================================== #
+    user_variable = retain_the_extracted_source_archive?
+    if user_variable.nil? # Do nothing in this case.
+    else
+      result = !user_variable
+    end
+    return result 
+  end; alias keep_the_extracted_archive? will_the_extracted_source_archive_be_removed? # === keep_the_extracted_archive?
+       alias keep_extracted_archive?     will_the_extracted_source_archive_be_removed? # === keep_extracted_archive?
+
+  # ========================================================================== #
+  # === retain_the_extracted_source_archive?
+  #
+  # This is a query method towards the variable kept in the
+  # @instance_hash variable.
+  #
+  # It may only query, and never modify anything.
+  # ========================================================================== #
+  def retain_the_extracted_source_archive?
+    @internal_hash[:retain_the_extracted_source_archive]
+  end; alias keep_extracted? retain_the_extracted_source_archive? # === keep_extracted?
+
+  # ========================================================================== #
+  # === cookbook_dataset_keep_extracted?
+  #
+  # This method simply wraps over the cookbook_dataset keep_extracted value.
+  # ========================================================================== #
+  def cookbook_dataset_keep_extracted?
+    cookbook_dataset?.keep_extracted?
+  end; alias dataset_keep_extracted? cookbook_dataset_keep_extracted? # === dataset_keep_extracted?
+
+  # ========================================================================== #
+  # === will_be_extracted_towards?
+  #
+  # This method will tell us the full path of the extracted directory for
+  # the program at hand.
+  #
+  # A trailing '/' is required for the result of this method.
+  #
+  # Returns: a String.
+  # ========================================================================== #
+  def will_be_extracted_towards?
+    "#{rbt_log_directory?}#{program_name_and_program_version?}/"
+  end; alias extracted_source_archive_directory? will_be_extracted_towards? # === extracted_source_archive_directory?
+
+  # ========================================================================== #
+  # === cookbook_dataset_use_this_build_system?
+  #
+  # Query which build-system is to be used. This will determine how we
+  # will install a given program at hand.
+  # ========================================================================== #
+  def cookbook_dataset_use_this_build_system?
+    cookbook_dataset?.use_which_build_system?
+  end; alias use_this_build_system?                      cookbook_dataset_use_this_build_system? # === use_this_build_system?
+       alias build_system_in_use?                        cookbook_dataset_use_this_build_system? # === build_system_in_use?
+       alias cookbookset_dataset_use_which_build_system? cookbook_dataset_use_this_build_system? # === cookbookset_dataset_use_which_build_system?
+       alias cookbook_build_system?                      cookbook_dataset_use_this_build_system? # === cookbook_build_system?
+
+  # ========================================================================== #
+  # === can_be_compiled_statically?
+  # ========================================================================== #
+  def can_be_compiled_statically?
+    cookbooks_dataset?.send(__method__)
+  end
+
+  # ========================================================================= #
+  # === is_this_a_registered_binary?
+  # ========================================================================= #
+  def is_this_a_registered_binary?(i)
+    i != return_program_based_on_this_binary(i)
+  end
+
+  # ========================================================================= #
+  # === directory_rbt_profiles?
+  #
+  # This will point to a location such as
+  # "/home/Programs/Ruby/2.6.5/lib/ruby/site_ruby/2.6.0/rbt/misc/profiles/"
+  # ========================================================================= #
+  def directory_rbt_profiles?
+    DIRECTORY_RBT_PROFILES
+  end
+
+  # ========================================================================= #
+  # === is_a_gem_file?
+  #
+  # Query whether we have a .gem file at hand here.
+  # ========================================================================= #
+  def is_a_gem_file?(
+      i = program_path?
+    )
+    if i
+      i.to_s.end_with? '.gem'
+    end
+  end; alias is_a_gem? is_a_gem_file? # === is_a_gem?
+
+  # ========================================================================= #
+  # === is_on_32_bit_system?
+  # ========================================================================= #
+  def is_on_32_bit_system?
+    TARGET_CPU == 'i686'
+  end
+
+  # ========================================================================== #
+  # === appdir_prefix_points_at?
+  # ========================================================================== #
+  def appdir_prefix_points_at?
+    prefix_object?.prefix?
+  end
+
   # ========================================================================== #
   # === prefix_object?
   # ========================================================================== #
@@ -856,20 +977,6 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     action(:chained_programs) # Load the chained actions, then return it.
   end
 
-  # ========================================================================== #
-  # === will_be_extracted_towards?
-  #
-  # This method will tell us the full path of the extracted directory for
-  # the program at hand.
-  #
-  # A trailing '/' is required for the result of this method.
-  #
-  # Returns: a String.
-  # ========================================================================== #
-  def will_be_extracted_towards?
-    "#{log_directory?}#{program_name_and_program_version?}/"
-  end
-
   # ========================================================================== #
   # === cookbook_aliases?
   # ========================================================================== #
@@ -1635,13 +1742,6 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     return result
   end
 
-  # ========================================================================== #
-  # === appdir_prefix_points_at?
-  # ========================================================================== #
-  def appdir_prefix_points_at?
-    real_prefix?.prefix?
-  end
-
   # ======================================================================= #
   # === cookbook_program_name_and_program_version?
   # ======================================================================= #

data/lib/rbt/actions/individual_actions/software_manager/reset.rb

@@ -280,6 +280,13 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     # ======================================================================= #
     @internal_hash[:cookbook_dataset] = nil
     # ======================================================================= #
+    # === :retain_the_extracted_source_archive
+    #
+    # This variable will retain the extracted source archive, aka
+    # "keep the extracted archive", rather than to remove it.
+    # ======================================================================= #
+    @internal_hash[:retain_the_extracted_source_archive] = nil
+    # ======================================================================= #
     # === :user_prefix
     #
     # This prefix can be determined by the user.
@@ -565,13 +572,6 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     # ======================================================================= #
     @internal_hash[:keep_la_files] = nil
     # ======================================================================= #
-    # === :keep_the_archive_extracted
-    #
-    # The keep-extracted setting will lateron be sanitized. The default
-    # value will be nil.
-    # ======================================================================= #
-    @internal_hash[:keep_the_archive_extracted] = nil
-    # ======================================================================= #
     # === :may_we_download
     # ======================================================================= #
     @internal_hash[:may_we_download] = RBT::TRY_TO_DOWNLOAD_IF_NOT_FOUND

data/lib/rbt/actions/individual_actions/software_manager/setters.rb

@@ -12,6 +12,439 @@ class Action
 
 class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
 
+  # ========================================================================= #
+  # === set_retain_the_extracted_source_archive
+  # ========================================================================= #
+  def set_retain_the_extracted_source_archive(
+      i = true
+    )
+    @internal_hash[:retain_the_extracted_source_archive] = true
+  end; alias set_keep_the_extracted_archive set_retain_the_extracted_source_archive # === set_keep_the_extracted_archive
+
+  # ========================================================================= #
+  # === do_retain_the_extracted_source_archive
+  #
+  # This delegates towards the method called
+  # .set_retain_the_extracted_source_archive().
+  #
+  # It may also optionally report to the user as to what is being done.
+  # ========================================================================= #
+  def do_retain_the_extracted_source_archive(
+      be_verbose = be_verbose?
+    )
+    case be_verbose
+    # ======================================================================= #
+    # === :be_silent
+    # ======================================================================= #
+    when :be_silent,
+         :be_quiet
+      be_verbose = false
+    end
+    if be_verbose
+      orev 'The extracted directory will not be removed after'
+      orev 'compilation / installation has finished.'
+    end
+    set_retain_the_extracted_source_archive(true)
+  end; alias do_set_keep_extracted         do_retain_the_extracted_source_archive # === do_set_keep_extracted
+       alias do_set_keep_extracted_archive do_retain_the_extracted_source_archive # === do_set_keep_extracted_archive
+
+  # ========================================================================= #
+  # === set_dont_keep_archive
+  #
+  # Use this method when you don't want to keep the extracted archive.
+  # ========================================================================= #
+  def set_dont_keep_archive(
+      be_verbose = true
+    )
+    if be_verbose
+      orev 'We will not keep our extracted archive.'
+    end
+    @internal_hash[:keep_the_extracted_archive] = false
+  end
+
+  # ========================================================================= #
+  # === set_keep_the_extracted_archive
+  #
+  # This method will keep the source-archive extracted. Note that this
+  # is not the default - by default we will remove the extracted
+  # archive.
+  # ========================================================================= #
+  def set_keep_the_extracted_archive(
+      i = true
+    )
+    @internal_hash[:keep_the_extracted_archive] = i
+  end; alias set_keep_extracted_archive          set_keep_the_extracted_archive # === set_keep_extracted_archive
+       alias set_keep_extracted                  set_keep_the_extracted_archive # === set_keep_extracted
+       alias do_not_remove_the_extracted_archive set_keep_the_extracted_archive # === do_not_remove_the_extracted_archive
+       alias do_not_remove_extracted_archive     set_keep_the_extracted_archive # === do_not_remove_extracted_archive
+
+  # ========================================================================== #
+  # === set_short_name
+  # ========================================================================== #
+  def set_short_name(i)
+    cookbook_dataset?.set_short_name(i)
+  end; alias set_real_short_name set_short_name # === set_real_short_name
+
+  # =========================================================================== #
+  # === set_internal_pid
+  # =========================================================================== #
+  def set_internal_pid(i = nil)
+    @internal_hash[:pid] = i
+  end; alias set_pid set_internal_pid # === set_pid
+
+  # ========================================================================= #
+  # === set_these_env_variables
+  #
+  # This method can be used to modify ENV variables.
+  #
+  # The first input argument to this method should be the Hash, consisting
+  # of the key-value pairs in the form of key being the NAME of the shell
+  # variable that is to be modified; and the corresponding value being
+  # the new VALUE that you wish to set this variable to.
+  #
+  # The third argument to this method determines whether we will output
+  # what we do to the user. By default this is true, but sometimes we
+  # may want to be able to quietly set these environment variables,
+  # such as when we attempt to use clang.
+  #
+  # Legitimate usage examples for this method, in ruby, would be:
+  #
+  #   set_this_env_variable 'CFLAGS = -gcc'
+  #   set_this_env_variable 'LIBS: -lpthread'
+  #
+  # ========================================================================= #
+  def set_these_env_variables(
+      hash_or_string, # We allow Hash and String as input. But String must be in a special format.
+      do_which_action = :report_only,
+      be_verbose      = true,
+      &block
+    )
+    if block_given?
+      yielded = yield
+      if yielded.is_a? Symbol
+        do_which_action = yielded
+      end
+    end
+    unless @internal_hash[:do_not_use_special_flags]
+      case do_which_action
+      # ===================================================================== #
+      # === :be_quiet
+      # ===================================================================== #
+      when :be_quiet,
+           :be_silent
+        be_verbose = false
+        # =================================================================== #
+        # Also change the do_which_action variable.
+        # =================================================================== #
+        do_which_action = :do_set_these_variables
+      end
+      case be_verbose
+      # ===================================================================== #
+      # === :be_verbose
+      # ===================================================================== #
+      when :be_verbose
+        be_verbose = true
+      # ===================================================================== #
+      # === :be_quiet
+      # ===================================================================== #
+      when :be_quiet,
+           :be_silent
+        be_verbose = false
+      end
+      # ===================================================================== #
+      # === Next, handle Strings
+      # ===================================================================== #
+      if hash_or_string.is_a? String
+        if hash_or_string.include?('=') or
+           hash_or_string.include?(':')
+          if hash_or_string.include?('=')
+            use_this_as_split_token = '='
+          elsif hash_or_string.include?(':')
+            use_this_as_split_token = ':'
+          end
+          splitted = hash_or_string.sub(/^export /,'').split(use_this_as_split_token)
+          this_key   = splitted.first
+          this_value = splitted.last
+          hash_or_string = { this_key => this_value } 
+        end
+      end
+      # ===================================================================== #
+      # === Next, handle Hashes
+      # ===================================================================== #
+      hash_or_string.each_pair {|key, value|
+        value.strip! if value.is_a? String
+        # =================================================================== #
+        # Make some exceptions, e. g. for gems.
+        # =================================================================== #
+        return if cookbook_dataset_has_been_initialized? and is_a_gem?
+        if be_verbose and is_compiled? and !extract_only? and not value.to_s.empty?
+          # ================================================================== #
+          # Notify the user as to the env-value modification. Since as of
+          # November 2018 we will no longer use opnn() here.
+          # ================================================================== #
+          e "  #{sfancy(key)} #{rev}will be set to the "\
+            "value(s): #{lightblue(value.to_s)}#{rev}"
+        end
+        if value.is_a? FalseClass or
+           value.is_a? TrueClass or
+           value.is_a? Integer
+          value = value.to_s
+        end
+        case do_which_action
+        when :do_set_these_variables
+          # ================================================================== #
+          # Next set the value to the environment variable.
+          # ================================================================== #
+          ENV[key] = value
+        end 
+      }
+    end
+  end; alias set_this_env_variable set_these_env_variables # === set_this_env_variable
+
+  # ========================================================================= #
+  # === set_extracted_base_directory
+  # ========================================================================= #
+  def set_extracted_base_directory(i)
+    @internal_hash[:extracted_base_directory] = i
+  end
+
+  # ========================================================================= #
+  # === set_really_compile_this_program
+  # ========================================================================= #
+  def set_really_compile_this_program(i = :qt)
+    set_compile_this_program(i)
+    set_compile_these_programs(i) if compile_these_programs?.empty?
+    initialize_cookbook_dataset
+  end
+
+  # ========================================================================= #
+  # === set_user_prefix                      (set_prefix tag, set prefix tag)
+  #
+  # This method can be used by the user, to designate another prefix in
+  # use for the given program. This will be the target directory into
+  # which the program will be installed into.
+  #
+  # A specialized class, called RBT::Prefix, will handle the prefix.
+  # ========================================================================= #
+  def set_user_prefix(
+      i = :appdir_prefix
+    )
+    # ======================================================================= #
+    # We must rewrite the program version in the following case.
+    #
+    # The input may look like this:
+    #
+    #  "/Programs/Gobjectintrospection/1.53.4/"
+    #
+    # ======================================================================= #
+    if i and use_this_specific_program_version?
+      if i.is_a?(String) and i.include?(programs_directory?)
+        use_this_regex = /(\d{1,2}\.?\d{1,2}\.?\d{1,2}\/)$/ # See: http://rubular.com/r/PPb2Y96XfF
+        i.sub!(use_this_regex, use_this_specific_program_version?)
+        i << '/' unless i.end_with? '/'
+      elsif i.is_a?(Symbol)
+        i = use_this_specific_program_version?
+      end
+    end
+    if i.is_a? Symbol
+      # ===================================================================== #
+      # Next, perform some sanitize operations.
+      #
+      # This clause will handle Symbols such as :app_dir_like or
+      # :use_ntrad_prefix_at_a_later_time.
+      # ===================================================================== #
+      case i.to_s # case tag
+      # ===================================================================== #
+      # === ULOCAL
+      #
+      # This refers to the commonly used /usr/local/ directory.
+      # ===================================================================== #
+      when 'ULOCAL'
+        i = '/usr/local/'
+      # ===================================================================== #
+      # === trad
+      # ===================================================================== #
+      when /^trad$/
+        i = '/usr/'
+      # ===================================================================== #
+      # === --opt_prefix
+      # ===================================================================== #
+      when /^-?-?opt(_|-)?prefix$/,
+           :opt
+        i = '/opt/'
+      # ===================================================================== #
+      # === non_traditional
+      #
+      # This entry point has various aliases such as :ntrad.
+      # ===================================================================== #
+      when /^app(_|-)?dir$/,
+           /^app(_|-)?dir(_|-)?like$/,
+           /^use(_|-)?appdir(_|-)?prefix$/i,
+           /^use(_|-)?ntrad(_|-)?prefix(_|-)?at(_|-)?a(_|-)?later(_|-)?time$/i,
+           'non_traditional',
+           'gobolinux',
+           'ntrad',
+           'default',
+           'app_dir_like',
+           'appdir',
+           'return_appdir_path',
+           'false',
+           'f',
+           'appdir_prefix',
+           ''
+        prefix?.clear_program # Clear it initially.
+        prefix?.do_use_appdir_prefix
+        if handle_which_program?
+          i = return_non_traditional_prefix(handle_which_program?)
+        end
+        # =================================================================== #
+        # Since as of May 2014 we get rid of all '-'
+        # =================================================================== #
+        i.delete!('-') if i.respond_to?(:include?) and i.include? '-'
+      end
+      # ===================================================================== #
+      # === Convert environment variables, if given, and unfreeze frozen
+      #     Strings
+      # ===================================================================== #
+      if i.is_a?(String)
+        # =================================================================== #
+        # Unfreeze frozen Strings.
+        # =================================================================== #
+        if i.is_a? String and i.frozen?
+          i = i.dup # "unfreeze" it.
+        end
+        # =================================================================== #
+        # === Handle Strings that start with the ':' character
+        #
+        # Handle the situation when we input a String that starts with
+        # the character ':'. This will be assumed to be a shortcut to
+        # an environment variable.
+        # =================================================================== #
+        if i.start_with?(':')
+          # ================================================================== #
+          # Next, we must add the proper program_version. This is either the
+          # program_version at hand - or it is an ENV variable if it exists.
+          # We check for the ENV variable first.
+          # ================================================================== #
+          this_key = (i.delete(':').upcase+'_PREFIX').dup
+          if ENV.has_key? this_key
+            # =============================================================== #
+            # The environment variables must be UPCASED and have appended
+            # the string '_PREFIX'.
+            # =============================================================== #
+            i = ENV[this_key].dup.to_s
+          else
+            # =============================================================== #
+            # Assume a special prefix variant targetting the /Programs/
+            # hierarchy.
+            # =============================================================== #
+            i = programs_directory?+i.to_s.delete(':').capitalize+'/'
+            i << program_version?.dup.to_s
+          end
+        end
+        if i.include?('$')
+          i = convert_env_variable(i) # Replace ENV variables here.
+          i << '/' unless i.end_with? '/'
+        end
+        if i.include? '--'
+          if i.include? '--prefix=' # Input is assumed to be like '--prefix=/Depot/j'
+            i = i.split('=').last # ← Obtain just the last part in this case.
+          end
+        end
+      end
+      # ===================================================================== #
+      # === Ensure a trailing '/' for directories.
+      # ===================================================================== #
+      unless i.to_s.end_with? '/' # .to_s to protect against Symbols given.
+        i << '/' if File.directory?(i.to_s)
+      end
+    end
+    # ======================================================================= #
+    # Next, we must check for post-install actions and modify these,
+    # if they exist. We only do so if we have an AppDir-prefix.
+    # ======================================================================= #
+    if is_an_appdir_prefix?(i.to_s)
+      consider_modifying_postinstall
+    end
+    prefix_object?.use_this_as_the_new_prefix = i
+  end; alias set_use_this_prefix set_user_prefix # === set_use_this_prefix
+       alias prefix=             set_user_prefix # === prefix=
+       alias set_prefix          set_user_prefix # === set_prefix
+       alias set_prefix_to_use   set_user_prefix # === set_prefix_to_use
+
+  # ========================================================================== #
+  # === cookbook_dataset_set_program_version
+  # ========================================================================== #
+  def cookbook_dataset_set_program_version(i)
+    cookbook_dataset?.set_program_version(i)
+  end
+
+  # ========================================================================== #
+  # === set_description
+  # ========================================================================== #
+  def set_description(i)
+    cookbook_dataset?.set_description(i)
+  end; alias set_desc set_description # === set_desc
+
+  # ========================================================================== ##
+  # === set_is_an_abbreviation
+  # ========================================================================== #
+  def set_is_an_abbreviation(i = true)
+    @internal_hash[:is_an_abbreviation] = i
+  end
+
+  # ========================================================================= #
+  # === set_cflags                                               (cflags tag)
+  #
+  # This method will enable you to set i.e. new cflags. This then also
+  # allows you to compile some programs in a different manner, such as
+  # if you wish to compile that particular program statically.
+  #
+  # The default argument to this method will be a copy of ENV['CFLAGS'].
+  #
+  # You can overrule this via a shortcut, if you want to, by passing
+  # true as argument, or even better, a Symol such as :static. This
+  # will then allow you to perform the static build, if the program
+  # at hand allows for this.
+  #
+  # -static-libgcc may also be an option here.
+  #
+  # The variable LDFLAGS may be important as well.
+  #
+  # For instance:
+  #
+  #   make LDFLAGS=-all-static
+  #
+  # ========================================================================= #
+  def set_cflags(
+      i = default_cflags?,
+      &block
+    )
+    case i # case tag
+    # ======================================================================= #
+    # === :clear
+    # ======================================================================= #
+    when :clear
+      i = ''
+    # ======================================================================= #
+    # Enable static builds for the CFLAGS at hand
+    # ======================================================================= #
+    when :overrule_static_build,
+         :static,
+         :build_static,
+         true
+      i = "#{old_cflags?} -static -g"
+    end
+    # ======================================================================= #
+    # Do the actual assignment next.
+    # ======================================================================= #
+    set_this_env_variable(
+      "CFLAGS: #{i}",
+      :do_set_these_variables,
+      &block
+    )
+  end
+
   # ========================================================================= #
   # === set_use_this_prefix
   #
@@ -105,20 +538,6 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     @internal_hash[:extract_to_this_directory_as_specified_by_the_user] = i
   end
 
-  # ========================================================================= #
-  # === set_keep_the_extracted_archive
-  #
-  # This method will keep the source-archive extracted. Note that this
-  # is not the default - by default we will remove the extracted
-  # archive.
-  # ========================================================================= #
-  def set_keep_the_extracted_archive(i = true)
-    @internal_hash[:keep_the_extracted_archive] = i
-  end; alias set_keep_extracted_archive          set_keep_the_extracted_archive # === set_keep_extracted_archive
-       alias set_keep_extracted                  set_keep_the_extracted_archive # === set_keep_extracted
-       alias do_not_remove_the_extracted_archive set_keep_the_extracted_archive # === do_not_remove_the_extracted_archive
-       alias do_not_remove_extracted_archive     set_keep_the_extracted_archive # === do_not_remove_extracted_archive
-
   # ========================================================================= #
   # === set_program_name_and_program_version
   #
@@ -558,20 +977,6 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     @internal_hash[:do_not_symlink] = true
   end; alias do_not_symlink set_do_not_symlink # === do_not_symlink
 
-  # ========================================================================= #
-  # === set_dont_keep_archive
-  #
-  # Use this method when you don't want to keep the extracted archive.
-  # ========================================================================= #
-  def set_dont_keep_archive(
-      be_verbose = true
-    )
-    if be_verbose
-      orev 'We will not keep our extracted archive.'
-    end
-    @internal_hash[:keep_the_extracted_archive] = false
-  end
-
   # ========================================================================= #
   # === set_use_these_configure_options
   # ========================================================================= #

data/lib/rbt/actions/individual_actions/software_manager/software_manager.rb

@@ -64,6 +64,7 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     rescue LoadError; end
   end
 
+  require 'rbt/actions/individual_actions/software_manager/actions.rb'
   require 'rbt/actions/individual_actions/software_manager/initialize.rb'
   require 'rbt/actions/individual_actions/software_manager/extract_related_code.rb'
   require 'rbt/actions/individual_actions/software_manager/logic_related_code.rb'