Class: Roebe::RandomBackground

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

Overview

Roebe::RandomBackground

Constant Summary collapse

IMG_DIRECTORY =
'/home/x/DATA/images/'

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(input = '', run_already = true) ⇒ RandomBackground

#

initialize

#


31
32
33
34
35
36
37
38
39
40
# File 'lib/roebe/classes/random_background.rb', line 31

def initialize(
    input       = '',
    run_already = true
  )
  reset
  set_input(
    input
  )
  run if run_already
end

Class Method Details

.[]Object

#

Roebe::RandomBackground[]

#


172
173
174
# File 'lib/roebe/classes/random_background.rb', line 172

def self.[]
  self.new :njoy
end

Instance Method Details

#add_njoy_images(path = IMG_DIRECTORY+'NJOY/') ⇒ Object

#

add_njoy_images

#


87
88
89
90
91
# File 'lib/roebe/classes/random_background.rb', line 87

def add_njoy_images(
    path = IMG_DIRECTORY+'NJOY/'
  )
  @array_available_images << Dir[path+'**/*'].flatten
end

#assign_image_to_file(i) ⇒ Object

#

assign_image_to_file

#


112
113
114
# File 'lib/roebe/classes/random_background.rb', line 112

def assign_image_to_file(i)
  @file = i
end

#assign_random_image_to_fileObject

#

assign_random_image_to_file

#


103
104
105
106
107
# File 'lib/roebe/classes/random_background.rb', line 103

def assign_random_image_to_file
  assign_image_to_file(
    @array_available_images.sample
  )
end

#file?Boolean Also known as: file

#

file?

#

Returns:

  • (Boolean)


55
56
57
# File 'lib/roebe/classes/random_background.rb', line 55

def file?
  @file
end

#fill_up_arrayObject

#

fill_up_array

#


119
120
121
122
123
124
125
# File 'lib/roebe/classes/random_background.rb', line 119

def fill_up_array
  if @array_available_images.empty?
    add_njoy_images
    @array_available_images << Dir[IMG_DIRECTORY+'wallpapers/**/*'].flatten
  end
  sanitize_main_array
end

#resetObject

#

reset

#


45
46
47
48
49
50
# File 'lib/roebe/classes/random_background.rb', line 45

def reset
  super()
  infer_the_namespace
  @array_available_images = []
  @may_we_continue = true
end

#runObject

#

run

#


161
162
163
164
165
166
167
# File 'lib/roebe/classes/random_background.rb', line 161

def run
  if @may_we_continue
    fill_up_array
    assign_random_image_to_file
    set_background # This should be optional.
  end
end

#sanitize_main_arrayObject

#

sanitize_main_array

#


96
97
98
# File 'lib/roebe/classes/random_background.rb', line 96

def sanitize_main_array
  @array_available_images = @array_available_images.flatten
end

#set_background(use_this_file = @file) ⇒ Object

#

set_background

We will use fbsetbg for this.

#


132
133
134
135
136
137
138
139
140
141
# File 'lib/roebe/classes/random_background.rb', line 132

def set_background(
    use_this_file = @file
  )
  _ = "fbsetbg -f -c #{use_this_file}"
  e
  e "  #{gold(_)}"
  e
  system _
  store_this_as_last_background_used(use_this_file)
end

#set_input(i) ⇒ Object

#

set_input

#


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

def set_input(i)
  i = i.first if i.is_a? Array
  i = i.to_s.dup if i
  # Process input next.
  case i # case tag
  # ======================================================================= #
  # === random_background njoy
  # ======================================================================= #
  when 'njoy' # only njoy image
    add_njoy_images
  else
    if i and File.exist?(i)
      # =================================================================== #
      # In this case we will simply use that image as background image.
      # =================================================================== #
      set_background(i)
      @may_we_continue = false
    end
  end
  @input = i
end

#store_this_as_last_background_used(what) ⇒ Object

#

store_this_as_last_background_used

#


146
147
148
149
150
151
152
153
154
155
156
# File 'lib/roebe/classes/random_background.rb', line 146

def store_this_as_last_background_used(what)
  into = log_dir?+'last_wallpaper.md'
  if is_on_roebe?
    opne 'Keeping track of the last wallpaper '\
            'by storing this into:'
    e
    e "  #{sfile(into)}"
    e
  end
  write_what_into(what, into)
end