Class: Roebe::OpenPDF

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

Overview

Roebe::OpenPDF

Constant Summary

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?

Constructor Details

#initialize(commandline_arguments = nil, run_already = true) ⇒ OpenPDF

#

initialize

#


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

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

Class Method Details

.[](i = ARGV) ⇒ Object

#

Roebe::OpenPDF[]

#


168
169
170
 
# File 'lib/roebe/classes/open_pdf.rb', line 168

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

Instance Method Details

#add(i) ⇒ Object

#

add

#


109
110
111
112
113
114
115
116
117
 
# File 'lib/roebe/classes/open_pdf.rb', line 109

def add(i)
  if i.is_a? Array
    i.each {|entry| add(entry) }
  else
    if i
      @open_these_pdf_files << i unless i.empty?
    end
  end
end

#menu(i = commandline_arguments? ) ⇒ Object

#

menu (menu tag)

#


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/roebe/classes/open_pdf.rb', line 73

def menu(
    i = commandline_arguments?
  )
  if i.is_a? Array
    i.each {|entry| menu(entry) }
  else
    case i # case tag
    # ===================================================================== #
    # === opdf --overview
    # ===================================================================== #
    when /^-?-?overview$/
      show_overview
    # ===================================================================== #
    # === opdf 1
    # ===================================================================== #
    when '1','2','3','4','5','6','7','8','9'
      i = Roebe.important_pdf_files?[i.to_i - 1]
    # ===================================================================== #
    # === opdf :pdf1
    # ===================================================================== #
    when :pdf1, :pdf2, :pdf3, :pdf4, :pdf5,
         :pdf6, :pdf7, :pdf8, :pdf9,
         'pdf1','pdf2','pdf3','pdf4','pdf5',
         'pdf6','pdf7','pdf8','pdf9'
      position = i.to_s.sub(/pdf/,'').to_i - 1
      i = Roebe.important_pdf_files?[position]
    end
    if File.exist? i
      add(i)
    end
  end
end

#reset ⇒ Object

#

reset (reset tag)

#


44
45
46
47
48
49
50
51
52
 
# File 'lib/roebe/classes/open_pdf.rb', line 44

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @open_these_pdf_files
  # ======================================================================= #
  @open_these_pdf_files = []
  try_to_require_the_open_gem
end

#run ⇒ Object

#

run (run tag)

#


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/roebe/classes/open_pdf.rb', line 153

def run
  menu
  if @open_these_pdf_files.empty?
    try_to_obtain_all_pdf_files_in_the_current_working_directory
  end
  unless @open_these_pdf_files.empty?
    @open_these_pdf_files.each {|this_pdf_file|
      Open.in_editor(this_pdf_file)
    }
  end
end

#set_commandline_arguments(i = '') ⇒ Object

#

set_commandline_arguments

#


57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/roebe/classes/open_pdf.rb', line 57

def set_commandline_arguments(
    i = ''
  )
  i = [i].flatten.compact
  i.map! {|entry|
    if entry.is_a?(String) and entry.start_with?(':')
      entry = entry.delete(':').to_sym
    end
    entry
  }
  @commandline_arguments = i
end

#show_overview ⇒ Object

#

show_overview

To invoke this method from the commandline, try:

opdf --overview
#


139
140
141
142
143
144
145
146
147
148
 
# File 'lib/roebe/classes/open_pdf.rb', line 139

def show_overview
  _ = Roebe.important_pdf_files? # Grab the registered arrays.
  e "Making use of `#{sdir(Roebe.directory_roebe_yaml_pdf?)}`."
  e "The available/registered #{royalblue(_.size.to_s)} .pdf files are:"
  e
  _.each {|this_pdf_file|
    e "  #{sfancy(this_pdf_file)}"
  }
  e
end

#try_to_obtain_all_pdf_files_in_the_current_working_directory ⇒ Object

#

try_to_obtain_all_pdf_files_in_the_current_working_directory

This method will try to find all .pdf files in the current working directory.

#


125
126
127
128
129
 
# File 'lib/roebe/classes/open_pdf.rb', line 125

def try_to_obtain_all_pdf_files_in_the_current_working_directory
  opne 'No specific input was given; attempting to open all .pdf'
  opne 'in the current working directory.'
  add(Dir['*.pdf'])
end