Class: Roebe::TurnRubyFileIntoGem

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

Overview

Roebe::TurnRubyFileIntoGem

Constant Summary collapse

DEFAULT_INPUT =
#

DEFAULT_INPUT

#
''
RUBY_SRC =
#

RUBY_SRC

We depend on the following environment variable to have been properly set.

#
ENV['RUBY_SRC'].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, #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, #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(this_file = nil, run_already = true) ⇒ TurnRubyFileIntoGem

#

initialize

#


48
49
50
51
52
53
54
55
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 48

def initialize(
    this_file   = nil,
    run_already = true
  )
  reset
  set_input(this_file)
  run if run_already
end

Instance Method Details

#append_to_gem_projects ⇒ Object

#

append_to_gem_projects

#


163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 163

def append_to_gem_projects
  opne 'Next appending to the Array of gems that I will install by default.'
  file = HOME_OF_THE_USER_CALLED_X+'DATA/PROGRAMMING_LANGUAGES/RUBY/src/'\
         'roebe/lib/roebe/constants/array_install_these_gem_projects.rb'
  dataset = File.readlines(file)
  dataset[-2,0] = name_of_gem?+N
FileUtils.cp(file, '/Depot/Temp/'+File.basename(file))
  write_what_into(dataset, file)
opne swarn('DEBUG! Check that the file is proper. location is at:')
pp file
e 'A backup was stored at'
e '/Depot/Temp/'+File.basename(file)
e '^^^ DELETE THE ABOVE IF ALL WORKS!!!'
end

#create_base_layout ⇒ Object

#

create_base_layout

Make use of class CreateRubyDirectoryLayout here

#


104
105
106
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 104

def create_base_layout
  CreateRubyDirectoryLayout.new(input?)
end

#generate_proper_gemspec_file(i = @full_pathname) ⇒ Object

#

generate_proper_gemspec_file

This method will generate a valid .gemspec file.

#


113
114
115
116
117
118
119
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 113

def generate_proper_gemspec_file(i = @full_pathname)
  _ = RUBY_SRC+File.basename(@full_pathname, '.rb')
  _ << '/' unless _.end_with? '/'
  opne 'We will next invoke class GenerateGemspec with the'
  opne 'argument '+sfile(_)+' to generate a .gemspec file.'
  GenerateGemspec.new(_) # We pass the full filename here.
end

#generate_version_directory ⇒ Object

#

generate_version_directory

#


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 124

def generate_version_directory
  version_rb = 'version/version.rb'
  cd 'lib'
  cd File.basename(@dirname)
  name_of_the_module = File.basename(@dirname).capitalize
  opne 'Now in directory `'+sdir(rds(return_pwd))+'`.'
  mkdir 'version'
  touch version_rb
  # Ok, version.rb has been touched, but now we will append into it.
  string =<<EOF
    module #{name_of_the_module}
      VERSION = '0.0.1'
    end
EOF
  append_what_into(string, version_rb)
end

#input? ⇒ Boolean Also known as: name_of_gem?

#

input?

#

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 156

def input?
  @input
end

#move_file(from, to = return_pwd) ⇒ Object

#

move_file (move tag)

#


85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 85

def move_file(
    from, to = return_pwd
  )
  if File.directory? to
    to << '/' unless to.end_with? '/'
  end
  to << File.basename(from) # Added this as of Jul 2014.
  if File.exist? from
    opne 'Now moving the file `'+sfile(from)+'` to'
    opne '`'+sfile(to)+'`.'
    mv(from, to)
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


60
61
62
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 60

def reset
  infer_the_namespace
end

#run ⇒ Object

#

run (run tag)

#


181
182
183
184
185
186
187
188
189
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 181

def run
  create_base_layout
  @dirname = @input.gsub(/#{File.extname(@input)}/, '')
  cd @dirname
  move_file(@full_pathname)
  generate_proper_gemspec_file
  generate_version_directory
  append_to_gem_projects
end

#set_full_pathname(i = return_pwd+@input) ⇒ Object

#

set_full_pathname

#


76
77
78
79
80
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 76

def set_full_pathname(
    i = return_pwd+@input
  ) # Contains the full path.
  @full_pathname = i
end

#set_input(i = N) ⇒ Object

#

set_input

#


67
68
69
70
71
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 67

def set_input(i = N) # Turn a .rb file into a gem project.
  i = DEFAULT_INPUT if i.nil?
  @input = i
  set_full_pathname # Associated call.
end

#touch(i) ⇒ Object

#

touch (touch tag)

#


144
145
146
147
148
149
150
151
 
# File 'lib/roebe/classes/turn_ruby_file_into_gem.rb', line 144

def touch(i)
  unless i.include? '/'
    i = return_pwd+i
  end
  opne "Now creating the file #{sfile(i)}."
  create_file(i)
  FileUtils.chmod(0755, i)
end