Class: Roebe::SkelMaker

Inherits:
Base show all
Defined in:
lib/roebe/classes/skel_maker/constants.rb,
lib/roebe/classes/skel_maker/skel_maker.rb

Overview

Roebe::SkelMaker

Constant Summary collapse

RSRC =
#

RSRC

#
ENV['RSRC'].to_s.dup+'/'
SKELETON_DIR =
#

SkelMaker::SKELETON_DIR

#
RSRC+'roebe/lib/classes/skel_maker/'
SETUP_RB_FILE =
#

SETUP_RB_FILE

#
RSRC+'setup/setup.rb'
PATH_TO_EXTCONF_RB_FILE =
#

PATH_TO_EXTCONF_RB_FILE

#
RSRC+'skeleton/extconf.rb'
ARRAY_CREATE_THESE_DIRS =
#

ARRAY_CREATE_THESE_DIRS

Create these directories in the toplevel directory.

#
%w(
  lib/
  bin/
  test/
)
ARRAY_CREATE_THESE_FILES =
#

ARRAY_CREATE_THESE_FILES

Create these files in the toplevel dir.

Some additional files could be:

CHANGELOG.md
MANIFEST.md
INSTALL.md
#
%w(
  LICENSE.md
  README.md
)
INSTALL_TYPE =
#

INSTALL_TYPE

Specify what installation type you want. Right now only :full and :small is supported.

#
:full
MY_TEMP =
#

MY_TEMP

#
ENV['MY_TEMP'].to_s

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, #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(project_name = 'admin_shell-0.1', run_already = true) ⇒ SkelMaker

#

initialize

project_name shall be full.

#


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 32

def initialize(
    project_name = 'admin_shell-0.1',
    run_already  = true
  )
  reset
  set_project_name(project_name)
  # Now sanitize where-to package things.
  case Dir.pwd
  when ENV['JJ']
    create_skel_structure(:jj)
  when ENV['J']
    create_skel_structure(:j)
  else # default to /Depot/Temp
    create_skel_structure(return_pwd)
  end
  run if run_already
end

Instance Method Details

#cd(i) ⇒ Object

#

cd

#


138
139
140
141
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 138

def cd(i)
  i = i.first if i.is_a? Array
  Dir.chdir(i) if File.exist? i
end

#copy_extconf ⇒ Object

#

copy_extconf

This copies extconf to Dir.pwd, then exits. Invoke it like so:

rskel cp
#


82
83
84
85
86
87
88
89
90
91
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 82

def copy_extconf
  _ = PATH_TO_EXTCONF_RB_FILE
  if File.exist? _
    cp _, return_pwd+'extconf.rb'
    e 'Copied extconf.rb to '+sdir(return_pwd)
  else
    e 'No file exists at '+sdir(_)+'.'
  end
  exit
end

#cp(from, to) ⇒ Object

#

cp

#


207
208
209
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 207

def cp(from, to)
  FileUtils.cp(from, to)
end

#create_directories ⇒ Object

#

create_directories

This creates the directories in question

#


148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 148

def create_directories
  case INSTALL_TYPE
  # === :full
  when :full
    cd @base_dir
    edir return_pwd
    mkdir @project_name
    cd @project_name
    edir return_pwd
    # cp(SETUP_RB_FILE,'./')
    ARRAY_CREATE_THESE_DIRS.each {|entry|
      e ' -> '+sdir(return_pwd)+sfile(entry)
      mkdir(entry)
    }
    ARRAY_CREATE_THESE_FILES.each { |this_file| File.new(this_file,'w+') }
    # Now, modify the Readme file.
    # Disabled the following as of March 2017. 
    # write_what_into('The ext/ dir is for extensions, if you dont '\
    #   'need it, delete it.'+N,'README')
  end
  show_fin_message
end

#create_skel_structure(location) ⇒ Object

#

create_skel_structure

The “location” argument is passed in a sanitized, symbolized manner.

#


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 98

def create_skel_structure(location)
  location = location.to_sym unless location.is_a? String
  e sfancy('Now creating a skeleton structure for a Ruby project.')
  case location # case tag
  when :jj, :j
    e 'Creating in '+sdir(ENV[location.to_s.upcase])+'.'
    @base_dir = '/'+ENV[location.to_s.upcase]
  when :temp, :tmp
    e 'Creating in '+MY_TEMP
    set_base_dir MY_TEMP
  when :root
    e 'Creating in /'
    set_base_dir '/'
  else
    e 'The location `'+sfile(location.to_s)+'` is not known.'
    set_base_dir(return_pwd)
  end
  sanitize_base_dir
end

#edir(i) ⇒ Object

#

edir

#


200
201
202
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 200

def edir(i)
  e sdir(i)
end

#mkdir(i) ⇒ Object

#

mkdir

#


174
175
176
177
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 174

def mkdir(i)
  i = i.first if i.is_a? Array
  Dir.mkdir(i) unless File.exist? i
end

#project_name? ⇒ Boolean

#

project_name?

#

Returns:

  • (Boolean) 


182
183
184
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 182

def project_name?
  @project_name
end

#reset ⇒ Object

#

reset

#


53
54
55
56
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 53

def reset
  super()
  @base_dir = ''.dup # denotes where we wanna create it
end

#run ⇒ Object

#

run

#


221
222
223
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 221

def run
  create_directories
end

#sanitize_base_dir ⇒ Object

#

sanitize_base_dir

Whenever called, we will sanitize @base_dir

#


131
132
133
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 131

def sanitize_base_dir
  @base_dir.squeeze!('/')
end

#set_base_dir(i = return_pwd) ⇒ Object

#

set_base_dir

#


121
122
123
124
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 121

def set_base_dir(i = return_pwd)
  i << '/' unless i.end_with? '/'
  @base_dir = i
end

#set_project_name(i) ⇒ Object

#

set_projpect_name

#


61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 61

def set_project_name(i)
  i = return_pwd if i.nil?
  case i.to_s # case tag
  when 'cp'
    copy_extconf
  when /-?-?help/
    show_help
    exit
  end
  i.delete!('-') if i.include? '-' # Never have any '-' in the input.
  @project_name = i
end

#show_fin_message ⇒ Object

#

show_fin_message

Simply show a message that we have finished.

#


191
192
193
194
195
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 191

def show_fin_message
  i = project_name?
  i = i.first if i.is_a? Array
  e 'Finished creating project `'+sfancy(i)+'`.'
end

#show_help ⇒ Object

#

show_help

#


214
215
216
 
# File 'lib/roebe/classes/skel_maker/skel_maker.rb', line 214

def show_help
  e 'This class allows you to create a base-skeleton for ruby projects.'
end