rbt 0.16.13 → 0.16.15

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

@@ -12,6 +12,156 @@ class Action
 
 class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
 
+  # ========================================================================== #
+  # === cookbook_dataset_manual_steps?
+  # ========================================================================== #
+  def cookbook_dataset_manual_steps?
+    cookbook_dataset?.manual_steps?
+  end
+
+  # ========================================================================== #
+  # === extract_to_this_directory?
+  #
+  # This query-method tells us where we will extract (our archive) to.
+  #
+  # The temp-directory is initially the same as RBT.rbt_log_directory?.
+  # ========================================================================== #
+  def extract_to_this_directory?
+    _ = @internal_hash[:extract_to_this_directory]
+    # ======================================================================== #
+    # Allow the user to overrule this value.
+    # ======================================================================== #
+    if extract_to_this_directory_as_specified_by_the_user?
+      _ = extract_to_this_directory_as_specified_by_the_user?
+    end
+    return _
+  end; alias extract_to_which_directory? extract_to_this_directory? # === extract_to_which_directory?
+       alias extract_to?                 extract_to_this_directory? # === extract_to?
+       alias extract_where_to?           extract_to_this_directory? # === extract_where_to?
+       alias extracted_directory?        extract_to_this_directory? # === extracted_directory?
+       alias extracted_dir?              extract_to_this_directory? # === extracted_dir?
+       alias dir?                        extract_to_this_directory? # === dir?
+       alias extract_to_this_dir?        extract_to_this_directory? # === extract_to_this_dir?
+       alias extracted_path?             extract_to_this_directory? # === extracted_path?
+       alias extracted_towards?          extract_to_this_directory? # === extracted_towards?
+
+  # ========================================================================== #
+  # === extract_to_this_directory_as_specified_by_the_user?
+  # ========================================================================== #
+  def extract_to_this_directory_as_specified_by_the_user?
+    @internal_hash[:extract_to_this_directory_as_specified_by_the_user]
+  end
+
+  # ========================================================================== #
+  # === show_flexbox?
+  # ========================================================================== #
+  def show_flexbox?
+    @internal_hash[:show_the_flexbox]
+  end; alias show_the_flexbox? show_flexbox? # === show_the_flexbox?
+       alias show_the_infobox? show_flexbox? # === show_the_infobox?
+       alias show_infobox?     show_flexbox? # === show_infobox?
+
+  # ========================================================================== #
+  # === 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
+
+  # ========================================================================== #
+  # === keep_the_extracted_archive?
+  # ========================================================================== #
+  def keep_the_extracted_archive?
+    !will_the_extracted_source_archive_be_removed?
+  end; alias keep_extracted_archive? keep_the_extracted_archive? # === 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
+
+  # ========================================================================== #
+  # === use_autoconf?
+  #
+  # This method determines as to whether we will use autoconf or whether
+  # we will not. By default the value of @internal_hash[:use_autoconf]
+  # is nil. If a user modifies this value from the commandline, to
+  # either true or false, then we will use that value; otherwise we
+  # will use the value defined in the cookbook-dataset for this
+  # particular program at hand.
+  # ========================================================================== #
+  def use_autoconf?
+    _ = cookbook_use_autoconf? # ← This is the default.
+    unless @internal_hash[:use_autoconf].nil?
+      _ = @internal_hash[:use_autoconf]
+    end
+    return _
+  end
+
   # ========================================================================= #
   # === is_this_a_registered_binary?
   # ========================================================================= #
@@ -201,9 +351,9 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
   # ========================================================================== #
   def program_version?
     _ = cookbook_dataset_program_version? # ← Default value.
-    # ======================================================================= #
+    # ======================================================================== #
     # The user can override it.
-    # ======================================================================= #
+    # ======================================================================== #
     if @internal_hash[:use_this_specific_program_version]
       _ = @internal_hash[:use_this_specific_program_version]
     end
@@ -900,20 +1050,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?
   # ========================================================================== #
@@ -1018,9 +1154,9 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
     result = @internal_hash[:an_error_has_occurred]
     ignore_errors = ignore_errors?
     case ignore_errors
-    # ======================================================================= #
+    # ======================================================================== #
     # === :infer
-    # ======================================================================= #
+    # ======================================================================== #
     when :infer
       ignore_errors = cookbook_dataset_ignore_errors?
     end
@@ -1190,9 +1326,9 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
       i = compile_which_program?
     )
     dependencies = required_dependencies_on?
-    # ======================================================================= #
+    # ======================================================================== #
     # Simplify the dependencies next.
-    # ======================================================================= #
+    # ======================================================================== #
     dependencies.map! {|entry|
       if entry.include?(' >') or entry.include?(' <')
         entry = entry.split(' ').first.strip
@@ -1331,10 +1467,10 @@ class SoftwareManager < RBT::Action # === RBT::Action::SoftwareManager
   # === use_which_build_system?
   # ========================================================================== #
   def use_which_build_system?
-    # ======================================================================= #
+    # ======================================================================== #
     # We default to the cookbook dataset when it comes to a specific
     # build system.
-    # ======================================================================= #
+    # ======================================================================== #
     _ = cookbookset_dataset_use_which_build_system?
     unless @internal_hash[:use_this_build_system].nil?
       _ = @internal_hash[:use_this_build_system]

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