Class: Roebe::PublishGem

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

Overview

Roebe::PublishGem

Constant Summary collapse

PUSH_GEM =
#

PUSH_GEM

#
'gem push *.gem'
FTP_URL =
#

FTP_URL

#
'http://shevegen.square7.ch/'
UPLOAD_TO_THE_REMOTE_FTP_SITE =
#

UPLOAD_TO_THE_REMOTE_FTP_SITE

#
false

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_args = nil, run_already = true) ⇒ PublishGem

#

initialize

#


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/roebe/classes/publish_gem.rb', line 53

def initialize(
    optional_args = nil,
    run_already   = true
  )
  register_sigint
  reset
  if optional_args
    if optional_args.is_a?(Array) and !optional_args.empty?
      case optional_args.first
      # =================================================================== #
      # === publish_gem --help
      # =================================================================== #
      when 'TEST','HELP','--help'
        opne 'The way to push a gem is this:'
        e
        e "  #{sfancy('gem push *.gem')}"
        e
      end
    end
  end
  run if run_already
end

Instance Method Details

#consider_creating_remote_ftp_project ⇒ Object

#

consider_creating_remote_ftp_project

Here we may create a new FTP project on the main ftp host, if FtpParadise is available and if the constant UPLOAD_TO_THE_REMOTE_FTP_SITE is set to true.

#


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

def consider_creating_remote_ftp_project
  if ftp_available? and UPLOAD_TO_THE_REMOTE_FTP_SITE
    remote_target = main_url?.dup
    # Add the name of the project next:
    @remote_directory = 'rubygems/'+File.basename(return_pwd)
    remote_target << @remote_directory
    remote_target = remote_target.squeeze('/')
    if FtpParadise.directory? remote_target # if it returns true, the dir already exists
    else # Else we will create the directory.
      begin
        FtpParadise.create_directory(@remote_directory)
      rescue Exception => error
        opne 'An error happened in the file '+orange('publish_gem.rb')
        opne ', in the method '+sfancy(__method__.to_s)
        pp error
        pp error.class
      end
    end
    upload_the_gem
  end
end

#consider_removing_the_gem(gemspec_file) ⇒ Object

#

consider_removing_the_gem

#


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

def consider_removing_the_gem(
    gemspec_file
  )
  gemspec_file = gemspec_file.first if gemspec_file.is_a? Array
  gem_file = @files.grep(/\.gem$/).first
  if File.exist? gem_file.to_s
    opne rev+'We found a local gem called `'+sfile(gem_file.to_s)+
         rev+'` (in the directory '+
         sdir(return_pwd)+rev+').'
    opne rev+'We will now remove it, as we already uploaded the '\
          'old gem. (Local time: '+orange(return_dd_mm_yyyy)+
          rev+')'
    remove(gem_file.to_s)
  # else # Else it does not exist. No message required.
  end
end

#consider_uploading_the_pdf_manual ⇒ Object Also known as: consider_uploading_manual

#

consider_uploading_the_pdf_manual

This method may upload the DiamondShell .pdf tutorial.

#


208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/roebe/classes/publish_gem.rb', line 208

def consider_uploading_the_pdf_manual
  if is_on_roebe?
    if return_pwd.include?('src/diamond_shell')
      if Object.const_defined? :DiamondShell
        DiamondShell.generate_pdf_tutorial_then_upload_it
      else
        e 'No constant called DiamondShell is known.'
      end
    elsif return_pwd.include?('src/rbt')
      # RBT.generate_pdf_tutorial_then_upload_it
      # ^^^ Disabled as of 07.12.2019
    end
  end
end

#ftp_available? ⇒ Boolean

#

ftp_available?

#

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/roebe/classes/publish_gem.rb', line 137

def ftp_available?
  Object.const_defined? :FtpParadise
end

#main_url? ⇒ Boolean Also known as: url?

#

main_url?

#

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/roebe/classes/publish_gem.rb', line 107

def main_url?
  FTP_URL
end

#obtain_all_files_from_the_current_directory ⇒ Object

#

obtain_all_files_from_the_current_directory

#


173
174
175
 
# File 'lib/roebe/classes/publish_gem.rb', line 173

def obtain_all_files_from_the_current_directory
  @files = Dir['*']
end

#push_gem ⇒ Object

#

push_gem

This will push to the remote site.

#


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

def push_gem
  esystem PUSH_GEM
end

#reset ⇒ Object

#

reset

#


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

def reset
  super()
  infer_the_namespace
end

#run ⇒ Object

#

run (run tag)

#


226
227
228
229
230
231
232
233
234
 
# File 'lib/roebe/classes/publish_gem.rb', line 226

def run
  if try_to_push_the_gem?
    obtain_all_files_from_the_current_directory
    gemspec_file = @files.grep(/gemspec$/)
    consider_creating_remote_ftp_project
    consider_uploading_the_pdf_manual
    consider_removing_the_gem(gemspec_file)
  end
end

#try_to_push_the_gem? ⇒ Boolean

#

try_to_push_the_gem?

This method will try to push the .gem file; it will return true or false, depending on the success of the operation.

#

Returns:

  • (Boolean) 


192
193
194
195
196
197
198
199
200
201
 
# File 'lib/roebe/classes/publish_gem.rb', line 192

def try_to_push_the_gem?
  if Dir['*.gem'].empty?
    opne 'No .gem file can be pushed/uploaded because '\
            'no .gem exists in this directory.'
    false
  else
    push_gem
    true
  end
end

#upload_the_gem ⇒ Object

#

upload_the_gem

#


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

def upload_the_gem
  # ======================================================================= #
  # Next, upload the .gem file finally.
  # ======================================================================= #
  if ftp_available?
    begin
      library = FtpParadise.new(:dont_run_yet)
      library.show_user_name_and_password
      library. :shevy
      library.rcd(@remote_directory)
      gem = @files.grep(/\.gem$/).first
      library.upload_binary(gem)
    rescue Exception => error
      opne 'An error happened in the method '+sfancy(__method__.to_s)+'.'
      pp error.class
      pp error
    end
  end
end