class RBT::Cookbooks::RegisteredLibraries

Constants

LOCATION_REGISTERED_LIBRARIES
#

LOCATION_REGISTERED_LIBRARIES

#
SHOW_PROGRAM_NAME
#

SHOW_PROGRAM_NAME

#

Public Class Methods

new( run_already = true ) click to toggle source
#

initialize

#
# File lib/rbt/registered/registered_libraries.rb, line 38
def initialize(
    run_already = true
  )
  reset
  case run_already
  when :do_not_run_yet
    run_already = false
  end
  run if run_already
end

Public Instance Methods

create_yaml_file()
Alias for: save_yaml_file
report_to_the_user_what_we_will_do() click to toggle source
#

report_to_the_user_what_we_will_do

#
# File lib/rbt/registered/registered_libraries.rb, line 72
def report_to_the_user_what_we_will_do
  opne 'Obtaining information about the '+
       steelblue('available libraries')+rev+' next.'
  opne 'This may take a while.'
  opne 'Please be patient.'
end
reset() click to toggle source
#

reset

#
Calls superclass method RBT::Cookbooks::Registered#reset
# File lib/rbt/registered/registered_libraries.rb, line 52
def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @hash_to_be_stored
  # ======================================================================= #
  @hash_to_be_stored = {} # This is the hash that will be stored.
  # ======================================================================= #
  # === @query
  # ======================================================================= #
  @query = nil
  # ======================================================================= #
  # === @this_program
  # ======================================================================= #
  @this_program = nil
end
run() click to toggle source
#

run

#
# File lib/rbt/registered/registered_libraries.rb, line 82
def run
  report_to_the_user_what_we_will_do
  use_this_key = :libraries # This is either a String or a Symbol.
  available_programs?.each { |program_name|
    @query = action(:SanitizeCookbook, program_name) { :fast }
    data = @query.return_dataset
    libraries = data[use_this_key] # This is an Array.
    unless libraries.empty?
      e program_name if SHOW_PROGRAM_NAME # ← This constant is defined in the file registered.rb
      libraries.each {|entry|
        @hash_to_be_stored[entry] = program_name
      }
    end
  }
  save_yaml_file
end
save_yaml_file() click to toggle source
#

save_yaml_file

The method ‘save_yaml_file` will create the yaml file which lists our libraries (in hash format). Right now, we need to manually update this yaml file on our own.

#
# File lib/rbt/registered/registered_libraries.rb, line 127
def save_yaml_file
  what = YAML.dump(@hash_to_be_stored)
  into = LOCATION_REGISTERED_LIBRARIES
  e sfancy('Storing yaml dataset in ')
  e "  #{sfile(into)}"
  write_what_into(what, into)
  if is_on_roebe?
    into = "#{ruby_src_dir_for_the_registered_yaml_files?}"\
           "#{File.basename(into)}"
    e 'Also storing into:'
    e "  #{sfile(into)}"
    write_what_into(what, into)
  end
end
Also aliased as: create_yaml_file
search_for_this_program( i = @this_program ) click to toggle source
#

search_for_this_program

Use this method to search for a specific program.

#
# File lib/rbt/registered/registered_libraries.rb, line 104
def search_for_this_program(
    i = @this_program
  )
  i = i.to_s
  opne "Searching for #{sfancy(i)} now:"
  hash = load_yaml(File.location_registered_libraries)
  if hash.keys.include? i
    opne "The library called `#{sfancy(i)}` was found."
    it_is_part_of_the_package(hash[i])
  else
    opne p+' is '+swarn('NOT')+' included. We could not '\
            'find any program'
    opne 'including this program.'
  end
end