Class: RBT::GenerateMachomebrewFormula

Inherits:
Base show all
Defined in:
lib/rbt/generate_files/generate_machomebrew_formula.rb

Overview

RBT::GenerateMachomebrewFormula

Constant Summary collapse

DEFAULT_PROGRAM =
#

DEFAULT_PROGRAM

#
'htop'

Constants inherited from LeanPrototype

LeanPrototype::ALL_COLOUR_METHODS, LeanPrototype::ARRAY_KDE_KONSOLE_COLOURS_IN_USE, LeanPrototype::DAY_NAMES, LeanPrototype::NAMESPACE, LeanPrototype::SILENT_REDIRECTION

Instance Method Summary collapse

Methods inherited from Base

#cat, #cd_back_to_the_current_working_directory, #consider_reporting_how_many_programs_are_registered, #cookbook_files?, #copy_recursively, #delete_code_of_conduct?, #determine_appdir_prefix_from_this_input, #directory_validation?, #do_not_show_names, #fast_return_file_size_of_this_program, #file_last_symlinked_program?, #file_programs_version_url, #gem_version, #is_a_64bit_system?, #is_ccache_available?, #is_porg_available?, #is_this_binary_registered?, #is_this_program_included?, #make_command?, #make_install_command?, #new_cookbook_instance_for, #program_exists?, #publish_list_of_all_programs_version, #rcp, registered_binaries?, #remove_symlink, #rename_kde_konsole_tab, #repackage, #report_n_programs, #report_working_directory, #return_compile_time_statistics, #return_n_random_characters, #return_version_of_this_program, #run_make_then_make_install, #sanitize_url1_entry, #set_source_directory, #show_overview_over_available_utility_scripts, #symlink_all_files_from_this_directory_to_that_directory, #system_tags?, #upload_list_of_all_programs_version, #use_yaml_database_for_tags?, #warn_and_exit, #wget

Methods inherited from LeanPrototype

#a_or_an?, #abbreviations?, #absolute_path, #action, #add_to_the_commandline_arguments, #all_binaries?, #all_files_from, #all_libraries?, #allowed_cookbook_entries?, #appdir_location_of?, #append_onto_the_internal_hash, #append_what_into, #archive_type_of?, #available_programs?, #be_quiet?, #be_verbose?, #begins_with_a_comment?, #capitalize_first_alphabetical_character, #cd_to_the_log_directory, #cd_to_the_temp_directory, #change_directory, #change_permission, #cheering_person?, #chmod, #chop_off_archive, #clear_commandline_arguments, #cliner, #coloured_and_padded_e, #coloured_and_padded_esystem, #coloured_esystem, #colourize_directory_for_system_results, #colourize_this_error, #colourize_this_file_path, #colourize_this_warning, #commandline_arguments?, #commandline_arguments_without_hyphens?, #comment, #convert_dd_mm_yyyy_to_its_long_variant, #convert_env_variable, #copy_directory, #copy_files, #cpr, #create_directory, #current_hour?, #dd_mmm_yyy, #debug, #debug?, #directory_expanded_cookbooks?, #disable_colours, #display_md5sum?, #do_not_debug, #does_the_cookbook_include_this_program?, #does_this_expanded_cookbook_file_exist_for_this_program?, #does_this_file_exist?, #does_this_file_exist_and_is_it_a_file?, #e, #eblue, #ecomment, #ecrimson, #edir, #editor?, #efancy, #eimp, #enable_colours, #enable_debug, #ensure_main_encoding_for, #eparse, #esystem, #esystem_gold, #etomato, #ewarn, #exit_program, #expanded_cookbooks_directory_exists?, #extract_this_archive, #extract_to?, #file_compiled_programs?, #file_dirname_retaining_trailing_slash, #file_predefined_installation_instructions?, #file_specification_of_registered_cookbook_entries, #find_cookbook_alias_for, #find_this_yaml_file, #first_argument?, #first_non_hyphen_argument?, #get_all_directories_from, #get_all_files_from, #get_all_programs, #get_date, #get_extended_date, #get_files_and_directories_from, #go_to_base_dir, #home_dir?, #host_system?, #infer_the_namespace, #internal_hash?, #internal_hash_set_commandline_arguments, #is_an_archive?, #is_directory?, #is_file?, #is_github_url?, #is_make_available?, #is_meson_installed?, #is_on_gobolinux?, #is_on_windows?, #is_roebe?, #is_superuser?, #is_symlink?, #is_this_a_header?, #is_this_a_library?, #is_this_program_included?, #iso_encoding?, #load_dataset_from_this_expanded_cookbook, #load_yaml, #load_yaml_file_from_the_cookbook_directory_for_this_program, #log_directory?, #main_encoding?, #meson_build_file_exists?, #months?, #move_file, #n_programs_are_available?, #n_programs_available?, #namespace?, #no_directory_exists_at, #no_directory_was_found_at, #no_opn, #no_such_file_exists, #open_in_browser, #open_in_editor, #opncomment, #opne, #opnef, #opnerev, #opnerror, #opnesystem, #opnewarn, #opnfancy, #opnn, #otomato, #packages_directory?, #path_to_this_expanded_cookbooks_dataset, #pkgconfig_directory?, #populate_the_internal_hash_with_default_values, #predefined_installation_instructions?, #prepend_this_commandline_argument, #program_version_of?, #project_base_directory?, #project_yaml_directory?, #query_path?, #rarrow?, #read_file, #read_file_in_default_encoding, #read_file_with_default_encoding, #readlines, #readlines_with_proper_encoding, #register_sigint, #registered_cookbook_entries?, #remove, #remove_archive_from_the_end, #remove_comments_from_each_line, #remove_directory, #remove_double_slashes, #remove_file, #remove_newlines, #remove_parens, #remove_symlink, #remove_the_first_commandline_argument, #remove_this_commandline_argument, #remove_this_entry_from_the_commandline_arguments, #remove_trailing_ANSII_escape_code, #remove_unnecessary_data_from_url, #rename, #report_pwd, #require_the_rbt_aliases, #reset_the_internal_hash, #return_all_archives_from_this_directory, #return_appdir_prefix, #return_commandline_arguments_with_leading_hyphens, #return_current_hour_minutes_second, #return_date, #return_day_of_the_month_based_on_utc, #return_full_time, #return_hours_minutes_seconds_based_on_utc, #return_location_to_this_programs_yaml_file, #return_month_based_on_this_number, #return_month_based_on_utc, #return_opnn, #return_program_name, #return_program_name_for_gobolinux_systems, #return_program_name_via_program_information, #return_pwd, #return_unicode_warning_symbol_or_empty_string, #return_utc, #return_utc_time_in_a_format_similar_to_slackware, #return_weekday_based_on_utc, #return_year_based_on_utc, #rev, #rpn, #run_simulation=, #run_simulation?, #sdir, #sdir_return_pwd, #set_be_silent, #set_be_verbose, #set_first_commandline_argument, #set_namespace, #set_use_colours, #set_use_opn, #set_xorg_buffer, #sfancy, #sfile, #silent_redirection?, #silently_create_this_directory_if_it_does_not_yet_exist, #simp, #source_base_directory?, #ssym, #stderr, #store_into_this_directory?, #string_right_arrow?, #swarn, #symlink, #sysbin_directory?, #sysetc_directory?, #sysinclude_directory?, #syslib_directory?, #sysshare_directory?, #system_directory?, #temp_directory?, #to_bool, #to_camelcase, #to_iso_encoding, #to_unicode, #today?, #touch, #try_to_require_beautiful_url, #try_to_require_the_environment_information_gem, #try_to_require_the_extracter_gem, #try_to_require_the_open_gem, #try_to_require_the_xorg_buffer, #try_to_require_wget, #try_to_return_a_special_compile_component, #unicode_cliner, #unicode_middle_cliner, #use_colours=, #use_colours?, #use_opn=, #use_opn?, #utf_encoding?, #verbose_truth, #word_wrap, #write_what_into, #write_what_into_via_unicode, #yes_or_no

Constructor Details

#initialize(commandline_arguments = ARGV, run_already = true) ⇒ GenerateMachomebrewFormula

#

initialize

#


32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 32

def initialize(
    commandline_arguments = ARGV,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  run if run_already
end

Instance Method Details

#determine_the_program ⇒ Object

#

determine_the_program

#


79
80
81
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 79

def determine_the_program
  set_program(first_argument?)
end

#extra_information? ⇒ Boolean

#

extra_information?

#

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 178

def extra_information?
  @dataset.send(__method__)
end

#find_remote_homepage ⇒ Object

#

find_remote_homepage

This method finds the last URL.

#


114
115
116
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 114

def find_remote_homepage
  @dataset.remote_homepage?.to_s
end

#generate_main_string ⇒ Object

#

generate_main_string

#


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 185

def generate_main_string
  short_name        = @dataset.short_name?.to_s.capitalize
  if short_name.empty?
    short_name = program_name?.to_s.dup.capitalize
  end
  link_to_remote_package = @dataset.url1?
  dependencies      = @dataset.required_deps_on?
  configure_options = @dataset.configure_options_or_meson_options?
  program_homepage  = find_remote_homepage
  @_ << "require 'formula'

class #{short_name.to_s} < Formula

desc '"+return_short_description.to_s.chomp('.')+"'
homepage '"+program_homepage+"'
url '"+link_to_remote_package+"'
sha256 '#{shasum?}'
revision 1

"
# Next, add the dependencies:
dependencies.each {|dep|
  @_ << "  depends_on '"+dep+"'"+N
}

@_ << "

skip_clean :all

def options
  [['--disable-etcdir', 'Disable the reading of Zsh rc files in /etc']]
end

def install
  args = %w(
"

  # ======================================================================= #
  # Next, add the dependencies onto args:
  # ======================================================================= #
  if configure_options.is_a? String
    @_ << "#{configure_options}\n"
  elsif configure_options.is_a? Array
    configure_options.each {|option|
      @_ << "#{option}#{N}"
    } unless configure_options.empty?
  end
  @_ << ")\n"
  # ======================================================================= #
  # And add more to the main String:
  # ======================================================================= #
  @_ << "

  system './configure', \"--prefix=#{prefix?}\", *args
  system 'make install'
end

def caveats; <<-EOS
#{extra_information?}

EOS

end
end
"
end

#menu(i = nil) ⇒ Object

#

menu (menu tag)

#


130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 130

def menu(i = nil)
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i
    # ===================================================================== #
    # === homebrew --help
    # ===================================================================== #
    when /help$/i
      show_help
      exit
    end
  end
end

#prefix? ⇒ Boolean

#

prefix?

#

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 171

def prefix?
  @dataset.send(__method__)
end

#program? ⇒ Boolean Also known as: program_name?

#

program?

#

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 96

def program?
  @program
end

#program_path? ⇒ Boolean

#

program_path?

#

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 155

def program_path?
  @dataset.send(__method__)
end

#reset ⇒ Object

#

reset

#


46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 46

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @program
  # ======================================================================= #
  @program = nil
  # ======================================================================= #
  # === @_
  # ======================================================================= #
  @_ = ''.dup # This is the string we use to generate a machomebrew formula.
  setup_dataset
end

#return_short_description ⇒ Object

#

return_short_description

#


148
149
150
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 148

def return_short_description
  @dataset.send(__method__)
end

#run ⇒ Object

#

run

#


267
268
269
270
271
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 267

def run
  setup_dataset # Set it up anew again.
  generate_main_string
  save_string
end

#save_string ⇒ Object

#

save_string

#


255
256
257
258
259
260
261
262
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 255

def save_string
  _ = "#{rbt_log_directory?}homebrew_formulas/#{program?}.rb"
  unless File.directory? File.dirname(_)
    mkdir(File.dirname(_))
  end
  orev "Saving into the file `#{sfile(_)}#{rev}`."
  save_what_to(@_, _)
end

#set_commandline_arguments(i) ⇒ Object

#

set_commandline_arguments

#


63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 63

def set_commandline_arguments(
    i
  )
  i = [i].flatten.compact
  if i.any? {|entry| entry.start_with?('--') }
    selection = i.select {|entry| entry.start_with?('--') }
    menu(selection)
    i.reject! {|entry| entry.start_with?('--') }
  end
  @internal_hash[:commandline_arguments] = i
  determine_the_program
end

#set_program(i = DEFAULT_PROGRAM) ⇒ Object

#

set_program

#


86
87
88
89
90
91
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 86

def set_program(
    i = DEFAULT_PROGRAM
  )
  i = DEFAULT_PROGRAM if i.nil?
  @program = i.to_s.dup
end

#setup_dataset(i = program?) ) ⇒ Object

#

setup_dataset

#


105
106
107
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 105

def setup_dataset(i = program?)
  @dataset = action(:SanitizeCookbook, i)
end

#shasum?(i = program_path? ) ⇒ Boolean

#

shasum?

#

Returns:

  • (Boolean) 


162
163
164
165
166
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 162

def shasum?(
    i = program_path?
  )
  return RBT.shasum(i)
end

#show_help ⇒ Object

#

show_help (help tag)

#


121
122
123
124
125
 
# File 'lib/rbt/generate_files/generate_machomebrew_formula.rb', line 121

def show_help
  e
  e 'Currently this class has no documented help options.'
  e
end