Class: Roebe::Usage

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

Overview

Roebe::Usage

Constant Summary collapse

CREATE_THIS_FILE =
#

CREATE_THIS_FILE

#
'USAGE.md'
MAIN_EDITOR =
#

MAIN_EDITOR

#
Roebe.editor?

Constants inherited from Base

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

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(optional_argument = nil, run_already = true) ⇒ Usage

#

initialize

#


35
36
37
38
39
40
41
42
43
44
 
# File 'lib/roebe/classes/usage.rb', line 35

def initialize(
    optional_argument = nil,
    run_already       = true
  )
  reset
  check_optional_argument(
    optional_argument
  )
  run if run_already
end

Instance Method Details

#build_main_string ⇒ Object

#

build_main_string

#


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/roebe/classes/usage.rb', line 87

def build_main_string
  @string =<<-EOF
= Usage of this Library

== Requiring it

require '#{@project_name}'

== Using it in a project

_ = #{@project_name.capitalize}.new("science_news")
_.run

EOF
end

#check_optional_argument(i) ⇒ Object

#

check_optional_argument

#


62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/roebe/classes/usage.rb', line 62

def check_optional_argument(i)
  i = i.to_s
  case i # case tag
  # ======================================================================= #
  # === --help
  # ======================================================================= #
  when /-?-?help/i
    opn; e 'This class will generate a '+sfile(@create_this_file)+'.'
    exit
  when '' # Empty means pass through.'
  else
    set_create_this_file(i)
  end
end

#determine_project_data ⇒ Object

#

determine_project_data

#


80
81
82
 
# File 'lib/roebe/classes/usage.rb', line 80

def determine_project_data # set @project_name variable via this method.
  @project_name = File.basename(Dir.pwd).downcase # Keep it downcased.
end

#open_file_in_editor ⇒ Object

#

open_file_in_editor

#


106
107
108
 
# File 'lib/roebe/classes/usage.rb', line 106

def open_file_in_editor # editor tag.
  system "#{MAIN_EDITOR} #{@to}"
end

#report_to_user_and_save_file ⇒ Object

#

report_to_user_and_save_file

#


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/roebe/classes/usage.rb', line 113

def report_to_user_and_save_file
  if File.exist? @to
    if File.directory? @to
      opn; e 'This is a directory ('+@to+'). We can not store into '\
             'a directory. Thus exiting now.'
      exit
    else
      opn; e 'We are trying to save the file `'+sfile(@to)+'` but it '+
             'already exists.'
      opn; e 'The current behaviour is to not overwrite it, thus we can'
      opn; e 'not generate a new file there.'
    end
  else
    opn; e "Saving now into the new file `#{sfile(@to)}`."
    write_what_to(@string, @to)
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


49
50
51
52
53
54
55
56
57
 
# File 'lib/roebe/classes/usage.rb', line 49

def reset
  super()
  infer_the_namespace
  set_create_this_file
  # ======================================================================= #
  # === @string
  # ======================================================================= #
  @string = ''.dup
end

#run ⇒ Object

#

run (run tag)

#


147
148
149
150
151
152
 
# File 'lib/roebe/classes/usage.rb', line 147

def run
  determine_project_data
  build_main_string
  report_to_user_and_save_file
  open_file_in_editor
end

#set_create_this_file(i = CREATE_THIS_FILE) ⇒ Object

#

set_create_this_file

Here we designate where we will save the file.

#


136
137
138
139
140
141
142
 
# File 'lib/roebe/classes/usage.rb', line 136

def set_create_this_file(i = CREATE_THIS_FILE)
  i = CREATE_THIS_FILE if i.nil?
  i = return_owd+i unless i.include? '/'
  i = File.absolute_path(File.dirname(i)+'../../../')+'/'
  @create_this_file = i
  @to = @create_this_file
end