Class: Roebe::Clipboard

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

Overview

Roebe::Clipboard

Constant Summary collapse

LINE =
#

LINE

#
'--------------------------------------------'
DEFAULT_LOCATION_FOR_BUFFER_FILE =
#

DEFAULT_LOCATION_FOR_BUFFER_FILE

This may default to:

cat /root/clipboard.buffer
#
ENV['HOME'].to_s+'/clipboard.buffer'

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, #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(commandline_arguments = nil, run_already = true) ⇒ Clipboard

#

initialize

#


50
51
52
53
54
55
56
57
58
59
 
# File 'lib/roebe/classes/clipboard.rb', line 50

def initialize(
    commandline_arguments = nil,
    run_already           = true
  )
  reset
  set_commandline_arguments(
    commandline_arguments
  )
  run if run_already
end

Class Method Details

.copy(i = '') ⇒ Object

#

Roebe::Clipboard.copy

Copy the clipboard.

#


206
207
208
 
# File 'lib/roebe/classes/clipboard.rb', line 206

def self.copy(i = '')
  new.set_xorg_buffer(i)
end

Instance Method Details

#buffer? ⇒ Boolean Also known as: buffer, content

#

buffer?

#

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/roebe/classes/clipboard.rb', line 78

def buffer? # simply return the @_ variable, which we use as our buffer.
  @_
end

#debug ⇒ Object

#

debug

#


128
129
130
131
132
133
 
# File 'lib/roebe/classes/clipboard.rb', line 128

def debug # Feedback the buffer content here. (debug tag)
  e 'The buffer was:'
  e LINE
  e @_
  e LINE
end

#fetch_user_input ⇒ Object

#

fetch_user_input

#


163
164
165
166
167
168
169
170
171
172
 
# File 'lib/roebe/classes/clipboard.rb', line 163

def fetch_user_input
  @user_input = gets.chomp
  case @user_input
  when 'q', @exit_token
    set_xorg_buffer(@_) # Set to xorg buffer too. Defined in xorg_buffer.rb
    @user_input = false
  else
    @_ << @user_input+N
  end
end

#load_dataset(i = @buffer_file) ⇒ Object Also known as: load

#

load_dataset (load tag)

#


186
187
188
189
190
191
192
193
 
# File 'lib/roebe/classes/clipboard.rb', line 186

def load_dataset(i = @buffer_file) # Assign a dataset here.
  if File.exist? i
    i = YAML.load_file(i) unless File.zero?(i)
    @_ = i
  else
    @_ = nil
  end
end

#read_input ⇒ Object Also known as: fetch_input, run

#

read_input

#


104
105
106
107
108
109
 
# File 'lib/roebe/classes/clipboard.rb', line 104

def read_input
  loop {
    fetch_user_input
    break if @user_input == false
  }
end

#reset ⇒ Object Also known as: clear

#

reset (reset tag)

#


64
65
66
67
68
69
70
71
72
73
 
# File 'lib/roebe/classes/clipboard.rb', line 64

def reset
  super()
  # ======================================================================= #
  # === @_
  # ======================================================================= #
  @_ = ''.dup
  set_buffer_file
  set_operating_system
  set_exit_token # use default.
end

#save ⇒ Object

#

save

For this method to work, we must have defined a buffer file. This is done via set_buffer_file(), keep this in mind.

#


141
142
143
 
# File 'lib/roebe/classes/clipboard.rb', line 141

def save
  File.open(@buffer_file, 'w+') {|out| YAML.dump(@_, out) }
end

#set_buffer_file(i = DEFAULT_LOCATION_FOR_BUFFER_FILE) ⇒ Object

#

set_buffer_file

#


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

def set_buffer_file(i = DEFAULT_LOCATION_FOR_BUFFER_FILE)
  @buffer_file = i
end

#set_exit_token(i = '}') ⇒ Object

#

set_exit_token

#


114
115
116
 
# File 'lib/roebe/classes/clipboard.rb', line 114

def set_exit_token(i = '}')
  @exit_token = i
end

#set_input(i) ⇒ Object

#

set_input

#


178
179
180
181
 
# File 'lib/roebe/classes/clipboard.rb', line 178

def set_input(i) # Use this method to set the user input.
  i = i.join(' ') if i.is_a? Array
  @_ = i
end

#set_operating_system(i = nil) ⇒ Object Also known as: os=

#

set_operating_system

This can be used to specifically set to an operating system.

#


88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/roebe/classes/clipboard.rb', line 88

def set_operating_system(i = nil)
  case RUBY_PLATFORM # Is "i686-linux" on my linux systems usually.
  when /linux/i, /freebsd/i, /bsd/i, /solaris/i
    i = 'linux'
  when /mswin32/i, /mingw32/i, /cygwin/i, /bccwin32/i
    i = 'windows'
  else
    i = 'linux' # Default operating system.
  end unless i # If input was given, we bypass this here.
  i = i.to_s
  @operating_system = i
end

#set_xorg_buffer(i = @_) ⇒ Object

#

set_xorg_buffer

#


148
149
150
 
# File 'lib/roebe/classes/clipboard.rb', line 148

def set_xorg_buffer(i = @_)
  XorgBuffer.set_xorg_buffer(i)
end

#token? ⇒ Boolean

#

token?

#

Returns:

  • (Boolean) 


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

def token?
  @exit_token
end