Class: Roebe::RemoveGems

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

Overview

Roebe::RemoveGems

Constant Summary collapse

SLEEP_FOR_N_SECONDS =
#

SLEEP_FOR_N_SECONDS

Specify the delay before trying to delete another gem again. This is a bit trial-and-error - I don’t know the exact delay that rubygems issues out, but 603 seems to be a good delay between removing different versions. (It was 580 before, but I changed this on 18.10.2019).

#
603.0

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(remove_this_gem = nil, remove_these_versions = nil, run_already = true) ⇒ RemoveGems

#

initialize

#


43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/roebe/classes/remove_gems.rb', line 43

def initialize(
    remove_this_gem       = nil,
    remove_these_versions = nil,
    run_already           = true
  )
  reset
  set_remove_this_gem(
    remove_this_gem
  )
  set_remove_these_versions(
    remove_these_versions
  )
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::RemoveGems[]

#


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

def self.[](i = ARGV)
  new(i)
end

Instance Method Details

#notify_the_user_that_no_version_could_be_found ⇒ Object

#

notify_the_user_that_no_version_could_be_found

#


130
131
132
 
# File 'lib/roebe/classes/remove_gems.rb', line 130

def notify_the_user_that_no_version_could_be_found
  opne 'No versions could be found, thus we could not remove anything.'
end

#remove_this_gem? ⇒ Boolean Also known as: which_gem?

#

remove_this_gem?

#

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/roebe/classes/remove_gems.rb', line 92

def remove_this_gem?
  @remove_this_gem
end

#reset ⇒ Object

#

reset (reset tag)

#


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/roebe/classes/remove_gems.rb', line 61

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # @remove_these_versions will keep track which versions are
  # to be removed.
  # ======================================================================= #
  @remove_these_versions = []
  # ======================================================================= #
  # === @remove_this_gem
  # ======================================================================= #
  @remove_this_gem = nil
  # ======================================================================= #
  # === @sleep_for_n_seconds_before_removing_the_next_gem
  #
  # The next variable can be used to use a "pause" step, before
  # proceeding to remove the next gem.
  # ======================================================================= #
  @sleep_for_n_seconds_before_removing_the_next_gem = SLEEP_FOR_N_SECONDS
end

#run ⇒ Object

#

run (run tag)

#


137
138
139
140
141
142
143
144
145
146
147
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/remove_gems.rb', line 137

def run
  remove_this_gem = which_gem?
  if @remove_these_versions and @remove_these_versions.empty?
    notify_the_user_that_no_version_could_be_found
  else
    opne "#{rev}Trying to remove some versions (#{@remove_these_versions.size}) "\
         "#{rev}from the gem `#{sfancy(remove_this_gem?)}#{rev}`."
    @remove_these_versions.each_with_index {|this_version, index|
      this_version = this_version.to_s.strip
      unless this_version.empty?
        esystem "gem yank #{remove_this_gem} -v #{this_version}"
        sleep_for_n_seconds = @sleep_for_n_seconds_before_removing_the_next_gem
        if @remove_these_versions.size == (index+1)
          # =============================================================== #
          # This means we have reached the last element, so it makes no
          # sense to sleep() still.
          # =============================================================== #
          sleep_for_n_seconds = false
        end
        # ================================================================= #
        # Next, consider whether we should sleep or not.
        # ================================================================= #
        if sleep_for_n_seconds and
           (sleep_for_n_seconds > 0)
          opne "#{rev}Next sleeping for #{sfancy(sleep_for_n_seconds.to_s)} "\
               "#{rev}seconds before continuing."
          sleep(sleep_for_n_seconds)
        end
      end
    }
  end
end

#set_remove_these_versions(i = nil) ⇒ Object

#

set_remove_these_versions

#


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/roebe/classes/remove_gems.rb', line 99

def set_remove_these_versions(
    i = nil
  )
  if i and i.is_a?(String)
    i = i.dup if i.frozen?
    i.delete!('(') if i.include? '('
    i.delete!(')') if i.include? ')'
    # ===================================================================== #
    # If a String has been given then we will try to locate the versions
    # to work with.
    # ===================================================================== #
    splitted = i.strip.split(N)
    # ===================================================================== #
    # Re-assign onto i in that case:
    # ===================================================================== #
    i = splitted.reject {|line|
      line.strip.end_with? ' yanked' # entries that are already yanked will be ignored.
    }.map {|line| # line may be like this: "0.9.126 - January 25, 2019 (1.89 MB)"
      if line.include? '-'
        _ = line.split('-').map(&:strip)
        line = _.first.strip
      end
      line
    }
  end
  @remove_these_versions = i
end

#set_remove_this_gem(i) ⇒ Object

#

set_remove_this_gem

#


85
86
87
 
# File 'lib/roebe/classes/remove_gems.rb', line 85

def set_remove_this_gem(i)
  @remove_this_gem = i
end