class Cookbooks::AvailableCookbooks

Constants

NAMESPACE
#

NAMESPACE

#

Public Class Methods

[](optional_argument = '') click to toggle source
#

Cookbooks::AvailableCookbooks[]

Return all available cookbooks here.

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 143
def self.[](optional_argument = '') # This argument is not needed though.
  AvailableCookbooks.new(optional_argument)
end
new( shall_we_use_a_filter_or_not = true, run_already = true ) click to toggle source
#

initialize

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 33
def initialize(
    shall_we_use_a_filter_or_not = true,
    run_already                  = true
  )
  reset
  set_apply_filter(shall_we_use_a_filter_or_not)
  run if run_already
end

Public Instance Methods

determine_how_many_entries_exist() click to toggle source
#

#determine_how_many_entries_exist

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 125
def determine_how_many_entries_exist
  @entries = @result.size.to_s
end
entries()
Alias for: entries?
entries?() click to toggle source
#

entries?

Will return how many entries exist.

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 54
def entries?
  @entries
end
Also aliased as: entries
get_results() click to toggle source
#

#get_results

This method may also apply some filtering. The results are the names of the individual programs.

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 93
def get_results
  # ======================================================================= #
  # Here comes the code to define which programs are registered.
  # ======================================================================= #
  result = Dir[target?].map {|entry| # Fetch all entries from the cookbooks dir.
    if @apply_filter # if true we return only the name. This is the default behaviour.
      entry = File.basename(entry).sub(/\.yml$/, '')
      entry
    else
      entry
    end
  }
  set_result(result)
end
opnn() click to toggle source
#

opnn

#
Calls superclass method Cookbooks::Base#opnn
# File lib/cookbooks/misc/available_cookbooks.rb, line 166
def opnn
  super(NAMESPACE)
end
programs?()
Alias for: result?
report()
Alias for: report_result
report_how_many_cookbook_entries_were_found() click to toggle source
#

#report_how_many_cookbook_entries_were_found

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 158
def report_how_many_cookbook_entries_were_found
  opnn; e 'How many cookbook entries have we been able '\
         'to find? '+simp(entries?)+'.'
end
report_result() click to toggle source
#

#report_result

Here we will report our result.

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 134
def report_result
  result?.each {|entry| e entry }
end
Also aliased as: report
reset() click to toggle source
#

reset

#
Calls superclass method Cookbooks::Base#reset
# File lib/cookbooks/misc/available_cookbooks.rb, line 45
def reset
  super()
end
result()
Alias for: result?
result?() click to toggle source
#

result?

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 83
def result?
  @result
end
Also aliased as: results?, result, programs?
results?()
Alias for: result?
run() click to toggle source
#

run (run tag)

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 183
def run
  run_everything
end
run_everything() click to toggle source
#

#run_everything

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 173
def run_everything
  set_target
  get_results
  determine_how_many_entries_exist
  sort_result
end
set_apply_filter(i = true) click to toggle source
#

#set_apply_filter

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 68
def set_apply_filter(i = true)
  i = false if i == :do_not_use_a_filter
  @apply_filter = i
end
set_result(i) click to toggle source
#

#set_result

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 118
def set_result(i)
  @result = i # Assign to @result here.
end
set_target() click to toggle source
#

#set_target

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 61
def set_target
  @target = Cookbooks.individual_cookbooks_directory?+'*.yml'
end
sort_result() click to toggle source
#

#sort_result

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 111
def sort_result
  set_result(result?.sort) # Always sort it and keep it in a sorted display.
end
target?() click to toggle source
#

target?

#
# File lib/cookbooks/misc/available_cookbooks.rb, line 76
def target?
  @target
end