class RBT::Cookbooks::RegisteredGirFiles

Constants

LOCATION_REGISTERED_GIR_FILES
#

LOCATION_REGISTERED_GIR_FILES

#
SHOW_PROGRAM_NAME
#

SHOW_PROGRAM_NAME

#

Public Class Methods

new( run_already = true ) click to toggle source
#

initialize

#
# File lib/rbt/registered/registered_gir_files.rb, line 51
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
location_gir_files?() click to toggle source
#

location_gir_files?

#
# File lib/rbt/registered/registered_gir_files.rb, line 91
def location_gir_files?
  RBT.file_registered_gir_files
end
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_gir_files.rb, line 82
def report_to_the_user_what_we_will_do
  opne 'Obtaining Information about available .gir files 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_gir_files.rb, line 65
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 = nil
end
run() click to toggle source
#

run

#
# File lib/rbt/registered/registered_gir_files.rb, line 98
def run
  report_to_the_user_what_we_will_do
  available_programs?.each { |program_name|
    @query = RBT::Cookbooks::SanitizeCookbook.new(program_name) { :fast }
    data = @query.return_dataset
    gir_files = data['gir_files'] # This is an Array.
    if gir_files.nil?
      # Simply ignore these nil values then.
    else
      unless gir_files.empty?
        if SHOW_PROGRAM_NAME # <- This constant is defined in the file registered.rb
          e program_name+
            steelblue(
              ' ['+
              gir_files.join(',').strip+
              ']'
            )
        end
        gir_files.each {|entry|
          @hash_to_be_stored[entry] = program_name
        }
      end
    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 .gir files (in hash format). Right now, we need to manually update this yaml file on our own.

#
# File lib/rbt/registered/registered_gir_files.rb, line 132
def save_yaml_file
  what = YAML.dump(@hash_to_be_stored)
  into = location_gir_files?
  e sfancy('Storing yaml dataset in ')
  e "  #{sfile(into)}"
  write_what_into(what, into)
  if is_on_roebe? # Also store at home next.
    into = "#{ruby_src_dir_for_the_registered_yaml_files?}"\
           "#{File.basename(into)}"
    e 'Also storing into:'
    e
    e "  #{sfile(into)}"
    e
    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_gir_files.rb, line 154
def search_for_this_program(
    i = @this_program
  )
  i = i.to_s
  opne "Searching for #{sfancy(i)} now:"
  hash = load_yaml(location_registered_gir_files?)
  if hash.keys.include? i
    opne "The .gir file called `#{sfancy(i)}` was found."
    opne "It is part of the package → `#{simp(hash[i])}`."
  else
    opne p+' is '+swarn('NOT')+' included. We could not '\
         'find any program'
    opne 'including this program.'
  end
end