studium 0.16.9

data/lib/studium/utility_scripts/stundenplan.rb

@@ -0,0 +1,600 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Studium::Stundenplan
+#
+# This class shows what will happen on any given day.
+#
+# Usage examples:
+#
+#   Studium::Stundenplan.new(ARGV)
+#
+# =========================================================================== #
+# Todo:
+#
+#   - Create an EXCEL File out of that.
+#   - create .pdf file with it.
+#
+# =========================================================================== #
+require 'studium/base/base.rb'
+
+module Studium
+
+class Stundenplan < Studium::Base # === Studium::Stundenplan
+
+  begin
+    require 'x/time/woche_anzeiger.rb'
+  rescue LoadError; end
+
+  begin
+    require 'class_docu_shower'
+  rescue LoadError; end
+
+  begin # Silent attempt to pull in prawn.
+    $VERBOSE = nil
+    require 'prawn'
+    $VERBOSE = false
+  rescue LoadError; end
+
+  begin
+    require 'pdf_paradise/main_pdf/main_pdf.rb'
+  rescue LoadError; end
+ 
+  # ========================================================================= #
+  # === COLOUR_FOR_NAME_OF_UNIVERSITY
+  # ========================================================================= #
+  COLOUR_FOR_NAME_OF_UNIVERSITY = ::Colours::CYAN
+
+  # ========================================================================= #
+  # === COLOUR_FOR_TITLE
+  # ========================================================================= #
+  COLOUR_FOR_TITLE              = ::Colours::MAGENTA
+
+  # ========================================================================= #
+  # === COLOUR_FOR_LEGENDE
+  # ========================================================================= #
+  COLOUR_FOR_LEGENDE            = ::Colours::RED
+
+  # ========================================================================= #
+  # === MAIN_FILE
+  #
+  # MAIN_FILE = '/home/x/STUDIUM/YAML/was_ich_machen_moechte_ws2013.yml'
+  # ========================================================================= #
+  MAIN_FILE = "#{Studium.yaml_directory?}stundenplan.yml"
+
+  # ========================================================================= #
+  # === SOFFICE
+  # ========================================================================= #
+  SOFFICE = '/opt/libreoffice/program/soffice'
+
+  # ========================================================================= #
+  # === THIS_FILE
+  # ========================================================================= #
+  THIS_FILE = __FILE__
+
+  # ========================================================================= #
+  # === ARRAY_WITH_TIMES
+  # ========================================================================= #
+  ARRAY_WITH_TIMES = %w(
+    08:00-09:00
+    09:00-10:00
+    10:00-11:00
+    11:00-12:00
+    12:00-13:00
+    13:00-14:00
+    14:00-15:00
+    15:00-16:00
+    16:00-17:00
+    17:00-18:00
+    18:00-19:00
+    19:00-20:00
+    20:00-21:00
+  )
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === show_usage                                                 (help tag)
+  # ========================================================================= #
+  def show_usage(
+      shall_we_exit = false
+    )
+    if Object.const_defined? :ClassDocuShower
+      ClassDocuShower.new __FILE__, verbose: false
+    end
+    e
+    opne ' - You can also create spreadsheets by '\
+            'passing the argument "xls".'
+    opne ' - You can also generate .pdf files by issuing "PDF".'
+    exit if shall_we_exit
+  end
+
+  # ========================================================================= #
+  # === set_input
+  #
+  # This method contains the commandline-information. We have to sanitize
+  # the input that a user can give to us.
+  # ========================================================================= #
+  def set_input(i = '')
+    i = i.dup if i
+    i = i.join ' ' if i.is_a? Array
+    i = i.strip.chomp if i.is_a? String
+    i = i.to_s.downcase
+    if REVERSE_GERMAN_WEEK_NAMES.has_key?(i)
+      i = REVERSE_GERMAN_WEEK_NAMES[i.capitalize].downcase.to_sym
+    end
+    case i # case tag
+    when '1','monday','mo'
+      i = :mo
+    when '2','tuesday','tu','di'
+      i = :di
+    when '3','wednesday','mi','mit'
+      i = :mi
+    when '4','thursday','do'
+      i = :do
+    when '5','friday','fr'
+      i = :fr
+    when '6','saturday','sa'
+      i = :sa
+    when '7','sunday','so'
+      i = :so
+    when 'week'
+      heute_ist
+      cliner { WocheAnzeiger.new }
+      exit
+    # ======================================================================= #
+    # === stundenplan --help
+    # ======================================================================= #
+    when /-?-?help$/i,'show_usage'
+      show_usage(true)
+    # ======================================================================= #
+    # === stundenplan --excel
+    # ======================================================================= #
+    when 'SPREADSHEET','EXCEL','XLS','xls',/-?-?excel/
+      silent_run
+      create_spreadsheet
+      exit
+    # ======================================================================= #
+    # === stundenplan --show_stats
+    # ======================================================================= #
+    when 'STATS','stats',/-?-?show(_|-)?stats/
+      show_stats    
+    # ======================================================================= #
+    # === stundenplan --pdf
+    # ======================================================================= #
+    when 'PDF',/-?-?pdf/
+      silent_run
+      generate_pdf_file
+      exit
+    # ======================================================================= #
+    # === stundenplan --dataset?
+    # ======================================================================= #
+    when /^-?-?dataset\??$/
+      show_dataset
+      exit
+    # ======================================================================= #
+    # === stundenplan display
+    # ======================================================================= #
+    when 'display','show'
+      display_stundenplan_on_the_terminal
+    # ======================================================================= #
+    # === open_all    
+    # ======================================================================= #
+    when 'open_all','openall','edit'
+      open_this_file_in_editor(false) # false for "don't exit yet."
+      open_stundenplan_in_editor
+    when 'open_self','openself'
+      open_this_file_in_editor
+    when 'open','openyaml','open_yaml'
+      open_stundenplan_in_editor
+    end
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === show_stats
+  #
+  # To invoke this, do:
+  #
+  #   stupa show_stats
+  #
+  # ========================================================================= #
+  def show_stats
+    n_entries = @data.keys.size
+    e 'We found '+sfancy(n_entries)+' entries.'
+    exit
+  end
+
+  # ========================================================================= #
+  # === open_this_file_in_editor
+  # ========================================================================= #
+  def open_this_file_in_editor(shall_we_exit = true)
+      _ = Studium.editor?+' '+THIS_FILE
+    e _; system _
+    exit if shall_we_exit
+  end
+
+  # ========================================================================= #
+  # === open_stundenplan_in_editor
+  # ========================================================================= #
+  def open_stundenplan_in_editor
+    _ = Studium.editor?+' '+MAIN_FILE
+    e _; system _; exit
+  end
+
+  # ========================================================================= #
+  # === display_stundenplan_on_the_terminal
+  # ========================================================================= #
+  def display_stundenplan_on_the_terminal
+    _ = readlines_from_this_input_file(MAIN_FILE)
+    _.each {|line| e line }
+  end
+  
+  # ========================================================================= #
+  # === get_priority_of
+  #
+  # This will return the priority of the given lecture.
+  # ========================================================================= #
+  def get_priority_of(i)
+    @data[i]['Priority'].to_s if @data.has_key? i
+  end
+
+  # ========================================================================= #
+  # === get_location_of
+  # ========================================================================= #
+  def get_location_of(i)
+    if @data.has_key? i
+      result = @data[i]['Wo'].to_s
+      result = '(unknown)' if result.empty?
+      return result
+    else
+      return i
+    end
+  end
+
+  # ========================================================================= #
+  # === get_vorbesprechung_of
+  # ========================================================================= #
+  def get_vorbesprechung_of(i) # <-- This here can return nil.
+    i = @data[i]['Vorbesprechung'] if i.is_a? Hash
+    return i
+  end
+
+  # ========================================================================= #
+  # === my_cliner
+  # ========================================================================= #
+  def my_cliner
+    cliner '','',Colours::GRAY
+  end
+
+  # ========================================================================= #
+  # === try_to_load_data
+  #
+  # This method will try to load the yaml dataset.
+  # ========================================================================= #
+  def try_to_load_data
+    _ = MAIN_FILE
+    if File.exist? _
+      begin
+        @data = YAML.load_file(MAIN_FILE)
+      rescue ArgumentError => error
+        opne 'A syntax-error happened in our dataset, the yaml '+
+                'file at `'+sfile(MAIN_FILE)+'`.'
+        pp error
+        opne 'Please make sure that the yaml file is valid.'
+        @data = {}
+      end
+    else
+      opne 'Can not load `'+sfile(_)+'` as it does not exist.'
+    end
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset # reset tag
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @input
+    # ======================================================================= #
+    @input = ''.dup
+    @may_we_show_the_result = true # if true, we may output the result.
+    @wochentag = ENGLISH_TO_GERMAN_WEEKDAYS[Time.now.strftime('%A')]
+    @date = Time.now.strftime '%d.%m.%Y'
+    @array_show_these_days = ARRAY_ALL_KNOWN_DAYS_OF_THE_WEEK # Which days to show. Should be an array.
+    try_to_load_data
+    # Store all the days in this hash.
+    @all_days = {
+      :mo => [], :di => [],
+      :mi => [], :do => [],
+      :fr => [], :sa => [],
+      :so => []
+    }
+  end
+
+  # ========================================================================= #
+  # === process_dataset
+  # ========================================================================= #
+  def process_dataset
+    @data.keys.each {|key|
+      wann = @data[key]['Wann']
+      if wann # This should be a Hash, not a String.
+        # Sometimes it is not a Hash though.
+        if wann.is_a? String
+          hash = {}
+          array = wann.split(N).reject {|line| line.start_with? '#' }
+          # Now it is an Array.
+          array.each {|entry|
+            _ = entry.split(' ')
+            key = _[0]
+            new_value = _[1..-1].join(' ')
+            if hash.has_key? key
+              hash[key] = hash[key]+' '+new_value 
+            else
+              hash[key] = new_value
+            end
+          }
+          wann = hash
+        end
+        wann.each_pair {|inner_key, new_value|
+          inner_key = inner_key.delete(N)
+          the_day = inner_key.downcase.to_sym
+          begin
+            new_value.gsub!(/ Uhr/,'') if new_value.include? 'Uhr'
+          rescue Exception => error; p error; end
+          array = [
+            get_title_of(key),
+            new_value,
+            get_priority_of(key),
+            get_location_of(key),
+            get_vorbesprechung_of(key) # <-- This here can return nil.
+          ]
+          @all_days[the_day] << array
+        }
+      else
+        opne 'Warning: no Wann entry found for '+sfancy(key)+'.'
+      end
+    } # Now we have @all_days set.
+  end
+
+  # ========================================================================= #
+  # === alle_vorlesungen
+  # ========================================================================= #
+  def alle_vorlesungen
+    @data.keys
+  end
+
+  # ========================================================================= #
+  # === heute_ist
+  # ========================================================================= #
+  def heute_ist
+    if @may_we_show_the_result
+      e 'Heute ist der '+simp(@date)+', ein '+@wochentag+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === show_days
+  # ========================================================================= #
+  def show_days
+    @all_days.each {|entry|
+      if @array_show_these_days.include? entry[0]
+        if entry[1].empty?
+        else # Ok, is included, so we may display them.
+          if @may_we_show_the_result
+            my_cliner
+            e green('Wochentag: ')+
+              simp(GERMAN_WEEK_NAMES[entry[0].to_s.capitalize])+N+N
+          end
+          sorted = entry[1].sort_by {|data| data[1] }
+          title_zeit_priority_ort_vorbesprechung(sorted)
+        end
+      else # Else not included so we won't show these entries.
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === get_title_of
+  #
+  # This method gets the title. Input must be the ID of the Lecture.
+  # ========================================================================= #
+  def get_title_of(i)
+    if i and @data.has_key? i
+      title = @data[i]['Title'].to_s
+      if title.include?    'BOKU'
+        title.gsub!(/BOKU/,
+          colourize_this_university('BOKU'))
+      elsif title.include? 'UNI Wien'
+        title.gsub!(/UNI Wien/,
+          colourize_this_university('UNI Wien'))
+      elsif title.include? 'TU Wien'
+        title.gsub!(/TU Wien/,
+          colourize_this_university('TU Wien'))
+      end
+      return title
+    else
+      return i
+    end
+  end
+
+  # ========================================================================= #
+  # === colourize_this_university
+  # ========================================================================= #
+  def colourize_this_university(i)
+    return COLOUR_FOR_NAME_OF_UNIVERSITY+i+COLOUR_FOR_TITLE
+  end
+
+  # ========================================================================= #
+  # === title_zeit_priority_ort_vorbesprechung
+  #
+  # This method will show the title, the zeit, the priority, the ort and
+  # the Vorbesprechung, which can be optional however.
+  # ========================================================================= #
+  def title_zeit_priority_ort_vorbesprechung(i)
+    i.each {|title, zeit, priority, ort, vorbesprechung|
+      zeit = zeit.force_encoding(::Studium.main_encoding?)
+      ort  = ort.force_encoding(::Studium.main_encoding?)
+      result = '  '+COLOUR_FOR_TITLE+title.to_s+rev+' ('+
+               RED+priority+rev+'): '+zeit.to_s+', '+
+               green(ort)
+      if vorbesprechung
+        result << N+PINK+'Vorbesprechung '+rev+
+                  'ist am: '+sfancy(vorbesprechung)
+      end
+      e result if @may_we_show_the_result
+    }
+  end
+
+  # ========================================================================= #
+  # === remove
+  # ========================================================================= #
+  def remove(i)
+    if File.exist? i
+      opne 'Removing file '+sfile(i)+'.'
+      FileUtils.rm(i)
+    end
+  end; alias try_remove remove # === try_remove
+
+  # ========================================================================= #
+  # === show_legende
+  # ========================================================================= #
+  def show_legende
+    if @may_we_show_the_result
+      e N+'    Legende: '+COLOUR_FOR_LEGENDE+'rot'+rev+' ist Priorität.'
+    end
+  end
+
+  # ========================================================================= #
+  # === create_spreadsheet                                          (xls tag)
+  #
+  # Use this method to create a stundenplan.xls file.
+  # ========================================================================= #
+  def create_spreadsheet
+    require 'spreadsheet'
+    create_xlsfile_where = '/stundenplan.xls'
+    try_remove(create_xlsfile_where)
+    Spreadsheet.client_encoding = 'UTF-8'
+    book = Spreadsheet::Workbook.new
+    opne 'We will store at `'+sfile(create_xlsfile_where)+'`.'
+    sheet1 = book.create_worksheet :name => 'Stundenplan'
+    sheet1.row(0).height = 22
+    sheet1.row(0).concat ['']+ARRAY_WITH_TIMES
+    # ======================================================================= #
+    # Work on each weekday, Monday to Friday.
+    # ======================================================================= #
+    %w(
+      Montag Dienstag Mittwoch Donnerstag Freitag
+    ).each_with_index {|weekday, index|
+      @all_days[weekday[0,2].downcase.to_sym].each {|lecture|
+        # =================================================================== #
+        # Format:
+        #   "Organische Chemie 1","10.00 - 12.00"
+        # =================================================================== #
+        # title     = lecture[0]
+        # =================================================================== #
+        starts_when = lecture[1].delete(' ').tr('.',':')
+        if starts_when.include? ','
+          starts_when = starts_when[0, starts_when.index(',')]
+        end
+        # ARRAY_WITH_TIMES.find_index {|entry| entry == "10:00-11:00"}
+      }
+      this_row = sheet1.row(index+1)
+      this_row.concat [ weekday ]
+    }
+    book.write(create_xlsfile_where)
+    esystem SOFFICE+' '+create_xlsfile_where
+  end
+  
+  # ========================================================================= #
+  # === silent_run
+  # ========================================================================= #
+  def silent_run
+    @may_we_show_the_result = false
+    run
+  end
+
+  # ========================================================================= #
+  # === generate_pdf_file                                           (pdf tag)
+  #
+  # Use this method to generate a .pdf file.
+  # ========================================================================= #
+  def generate_pdf_file
+    create_pdffile_where = '/STUNDENPLAN.pdf'
+    try_remove(create_pdffile_where)
+    opne 'We will store at `'+sfile(create_pdffile_where)+'`.'
+    pdf = Prawn::Document.new(:page_size => 'A4')
+    pdf.font 'Times-Roman'
+    pdf.text 'Stundenplan', :size => 50,
+      :align => :center, :styles => :bold
+    require 'cyberweb'
+    img = Cyberweb.random_web_image
+    # Next, the various weekdays: 
+    %w(
+      Montag Dienstag Mittwoch Donnerstag Freitag
+    ).each_with_index {|weekday, index|
+      # pdf.image filename, :at => [10, 10], :width => 15
+      # pdf.image WebImages.random, :width => 15
+      pdf.image(img)
+      pdf.text(
+        weekday.to_s.encode('UTF-8'),
+        :size => 28, :color => 'black', :fill_color => '0000ff',
+        :styles => :underline
+      )
+      @all_days[weekday[0,2].downcase.to_sym].each {|lecture|
+        starts_when = starts_when.tr('.',':')
+        pdf.fill_color '0000ff'
+        if lecture[0].valid_encoding?
+          lecture[0]  = lecture[0].encode('UTF-8')
+          starts_when = starts_when.encode('UTF-8')
+          pdf.indent(15) { pdf.text(lecture[0]+':'+N) }
+          pdf.fill_color '#000000' # This is the black colour.
+          pdf.indent(25) { pdf.text('    '+starts_when) }
+        else
+          opne 'Something is not correct with the encoding.'
+        end
+      }
+    }
+    pdf.render_file(create_pdffile_where)
+    PdfParadise::MainPdf.new(create_pdffile_where)
+  end
+
+  # ========================================================================= #
+  # === show_dataset
+  # ========================================================================= #
+  def show_dataset
+    opne 'Now displaying the dataset:'
+    pp @data
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run # (run tag)
+    process_dataset # This method will set @data.
+    heute_ist
+    unless @input.to_s.empty? # The user wants to display only a specific day.
+      @array_show_these_days = [@input]
+    end
+    show_days
+    show_legende
+    my_cliner
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Studium::Stundenplan.new(ARGV)
+end # stundenplan