Class: Roebe::RubyHeader

Inherits:
Base show all
Defined in:
lib/roebe/classes/ruby_header.rb

Overview

Roebe::RubyHeader

Constant Summary collapse

BOOL_VALUE_FOR_FROZEN_STRING_LITERAL =
#

BOOL_VALUE_FOR_FROZEN_STRING_LITERAL

#
true
USE_THIS_ENCODING_BY_DEFAULT =
#

USE_THIS_ENCODING_BY_DEFAULT

Specify which encoding is to be used by default, by this class.

#

USE_THIS_ENCODING_BY_DEFAULT = ‘# Encoding: ISO-8859-1’+N

'# Encoding: UTF-8'+N

Constants inherited from Base

Base::COLOURS, Base::HOME_DIRECTORY_OF_USER_X, Base::N, Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#actions, #append_this_onto_that_file, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #burlywood, #call_next, #chdir, #cheerful_guy, #cliner, #complex_esystem, #convert_global_env, #copy_directory, #copy_file, #cornflowerblue, #create_directory, #crimson, #current_month?, #current_time?, #current_year?, #cyan, #darkcyan, #darkgreen, #darkkhaki, #darkslateblue, #deeppink, #delete_symlink, #do_not_use_the_base_colours, #do_use_the_base_colours, #e, #ecomment, #editor_to_use?, #efancy, #eimp, #emphasis, #ensure_main_encoding, #ensure_utf_encoding, #eparse, #erev, #esteelblue, #etomato, #ewarn, #exit_program, #firebrick, #get_current_day, #get_current_month, #get_files_and_directories, #get_files_from, #get_german_name_for_this_weekday, #gold, #green, #grey, #hh_mm_ss, #hh_mm_ss_day_month_year, #home_dir?, #home_directory_of_user_x?, #infer_the_namespace, #internal_hash?, #is_a_directory?, #is_a_file?, #is_a_jpg_file?, #is_an_image_file?, #is_archive?, #is_audio_file?, #is_in_studium_dir?, #is_multimedia_file?, #is_on_roebe?, #is_on_windows?, #is_studium_available?, #is_symlink?, #is_this_a_ruby_file?, #is_video_file?, #iso_encoding?, #le, #left_colour, #lightblue, #lightgreen, #lightseagreen, #lightsteelblue, #lime, #limegreen, #localhost_to_data, #log_directory?, #main_encoding?, #mediumorchid, #mediumpurple, #mediumseagreen, #mediumslateblue, #mediumspringgreen, #mediumturquoise, #mkdir_p, #mv, #n_days_in_this_month, #n_pages_in_this_pdf_file?, #namespace?, #no_file_exists_at, #ogrey, #olive, #olivedrab, #open_in_browser, #opne, #opnesystem, #opnn, #orange, #orchid, #orev, #palegoldenrod, #palevioletred, #pink, #powderblue, #programs_dir?, #project_base_dir?, #random_html_colour, #rds, #read_file_in_iso_encoding, #read_file_via_the_default_encoding, #read_lines_via_iso_encoding, #readlines_with_main_encoding, #red, #register_sigint, #remove, #remove_directory, #remove_file, #rename_kde_konsole_tab, #replace_localhost_with_data, #report_pwd, #require_rescue, #reset_the_internal_hash, #return_all_directories_from_this_directory, #return_all_files_from_this_directory, #return_current_directory, #return_dd_mm_yyyy, #return_file_or_directory_of, #return_files_from_pwd, #return_last_part_of_the_current_directory, #return_utc, #rev, #right_arrow?, #right_colour, #roebe_log_directory?, #rosybrown, #royalblue, #ruby_base_directory?, #run_in_background, #run_rcfiles_then_run_ata_via_qdbus, #sandybrown, #sdir, #seagreen, #set_be_verbose, #set_xorg_buffer, #sfancy, #sfile, #show_help, #silent_redirection?, #simp, #simple_esystem, #skyblue, #slateblue, #slategray, #springgreen, #steelblue, #string_italic, #swarn, #symlink, #teal, #temp_dir?, #to_camelcase, #to_counted_hash, #tomato, #touch, #try_to_require_the_beautiful_url_gem, #try_to_require_the_html_template, #try_to_require_the_open_gem, #try_to_require_the_program_information_gem, #try_to_require_the_xorg_buffer, #use_colours?, #verbose_truth, #weekday?, #word_wrap, #write_what_into, #yellow

Methods included from Base::CommandlineArguments

#append_onto_the_commandline_arguments, #clear_commandline_arguments, #commandline_arguments?, #commandline_arguments_as_string?, #commandline_arguments_without_leading_hyphens?, #first_argument?, #first_argument_without_leading_hyphens?, #has_an_argument_been_passed?, #remove_hyphened_arguments_from_the_commandline_arguments, #return_commandline_arguments_with_leading_hyphens, #second_argument?, #set_commandline_arguments

Constructor Details

#initialize(run_already = true) ⇒ RubyHeader

#

initialize

#


39
40
41
42
 
# File 'lib/roebe/classes/ruby_header.rb', line 39

def initialize(run_already = true)
  reset
  run if run_already
end

Class Method Details

.return_ruby_header ⇒ Object

#

Roebe::RubyHeader.return_ruby_header

#


77
78
79
80
81
82
83
84
85
86
 
# File 'lib/roebe/classes/ruby_header.rb', line 77

def self.return_ruby_header
  # ======================================================================= #
  # Next build up the main String that represents a "ruby header".
  # ======================================================================= #
  result  = '#!/usr/bin/ruby -w'+N
  result << USE_THIS_ENCODING_BY_DEFAULT
  result << '# frozen_string_literal: '+BOOL_VALUE_FOR_FROZEN_STRING_LITERAL.to_s+N
  result << '# =========================================================================== #'
  return result
end

Instance Method Details

#reset ⇒ Object

#

reset

#


47
48
49
50
51
52
53
 
# File 'lib/roebe/classes/ruby_header.rb', line 47

def reset
  super()
  # ======================================================================= #
  # === @output_result
  # ======================================================================= #
  @output_result = true
end

#run ⇒ Object

#

run

#


68
69
70
71
72
 
# File 'lib/roebe/classes/ruby_header.rb', line 68

def run
  result = ::Roebe::RubyHeader.return_ruby_header
  try_to_paste_this_xorg_buffer(result)
  e result if @output_result # Output it by default.
end

#try_to_paste_this_xorg_buffer(result) ⇒ Object

#

try_to_paste_this_xorg_buffer

#


58
59
60
61
62
63
 
# File 'lib/roebe/classes/ruby_header.rb', line 58

def try_to_paste_this_xorg_buffer(result)
  begin
    require 'xorg_buffer'
  rescue LoadError; end
  XorgBuffer[result] if Object.const_defined? :XorgBuffer
end