Class: Tableau::BaseParser

Inherits:

Object

• Object
• Tableau::BaseParser

Defined in:

lib/tableau/baseparser.rb

Direct Known Subclasses

ModuleParser, TimetableParser

Constant Summary

@@COURSE_DESCRIPTION_XPATH =

'/html/body/table[1]//td//td/text()'

@@WEEKS_REGEX =

/^([\d]{2}-[\d]{2})|^([\d]{2})/

Instance Method Summary

• #create_class(class_element) ⇒ Object

  Create a Class from the given data element.

• #create_class_weeks(week_data) ⇒ Object

  Create the week range array for the given week string.

• #get_info(timetable_data) ⇒ Object

  Get the ID string in the first

  element (usually <:code> - <:name>).

  #inc_time(intervals) ⇒ Object

  Increments the @time by 15 minute intervals.

  #initalize(lookup_id) ⇒ Object

  Create a new instance of the BaseParser, with an ID to lookup.

  #parse_table(table_rows) ⇒ Object

  Parse the module table for any classes.

  #xpath_for_table(table_count) ⇒ Object

  Returns the XPath for the nth table.

  Instance Method Details

  #create_class(class_element) ⇒ Object

  Create a Class from the given data element

  # File 'lib/tableau/baseparser.rb', line 51
  
  def create_class(class_element)
    begin
      tt_class = Tableau::Class.new(@day, @time)
      data = class_element.xpath('table/tr/td//text()')
      raise "Misformed cell for #{module_id}" if data.count < 4
    rescue Exception => e
      p "EXCEPTION: #{e.message}", "Data Parsed:", data
      return nil
    end
  
    # If the weeks are in the 2nd index, it's a core timetable
    if @@WEEKS_REGEX.match(data[1].text())
      tt_class.code = data[0].text().match(/^[A-Za-z0-9\-]+/).to_s
      tt_class.type = data[0].text().gsub(tt_class.code, '').gsub('/', '')
  
      tt_class.weeks    = create_class_weeks(data[1].text())
      tt_class.location = data[2].text()
      tt_class.name     = data[3].text()
    else # this is a module timetable, laid out differently
      if data[0].to_s != ""
        tt_class.code = data[0].text().match(/^[A-Za-z0-9\-]+/).to_s
        tt_class.type = data[0].text().gsub(tt_class.code, '').gsub('/', '')
      end
  
      tt_class.location  = data[1].text()
      tt_class.name      = data[2].text()
      tt_class.weeks     = create_class_weeks(data[3].text())
    end
  
    # Same attribute on both timetables, DRY'd here
    tt_class.tutor = data[4] ? data[4].text() : nil
  
    if intervals = class_element.attribute('colspan').value
      tt_class.intervals = intervals.to_i
    end
  
    tt_class
  end
  

  #create_class_weeks(week_data) ⇒ Object

  Create the week range array for the given week string

  # File 'lib/tableau/baseparser.rb', line 91
  
  def create_class_weeks(week_data)
    week_span_regex   = /([\d]{2}-[\d]{2})/
    week_start_regex  = /^[0-9]{2}/
    week_end_regex    = /[0-9]{2}$/
    week_single_regex = /[\d]{2}/
  
    class_weeks = Array.new
  
    week_data.scan(@@WEEKS_REGEX).each do |weekspan|
  
      # if it's a 28-39 week span
      if weekspan =~ week_span_regex
        start  = week_start_regex.match(weekspan)[0].to_i
        finish = week_end_regex.match(weekspan)[0].to_i
  
        while start <= finish
          class_weeks << start
          start += 1
        end
  
      # some single week (30, 31, 32 etc) support
      elsif weekspan =~ week_single_regex
        class_weeks << week_single_regex.match(weekspan)[0].to_i
      end
    end
  
    class_weeks
  end
  

  #get_info(timetable_data) ⇒ Object

  Get the ID string in the first

  element (usually <:code> - <:name>)

  # File 'lib/tableau/baseparser.rb', line 126
  
  def get_info(timetable_data)
    timetable_data.xpath(@@COURSE_DESCRIPTION_XPATH).to_html
  end
  

  #inc_time(intervals) ⇒ Object

  Increments the @time by 15 minute intervals

  # File 'lib/tableau/baseparser.rb', line 121
  
  def inc_time(intervals)
    intervals.to_i.times { @time += 900 }
  end
  

  #initalize(lookup_id) ⇒ Object

  Create a new instance of the BaseParser, with an ID to lookup

  # File 'lib/tableau/baseparser.rb', line 14
  
  def initalize(lookup_id)
    @time, @day = Time.new(2013, 1, 1, 9, 0, 0), 0
    @lookup_id  = lookup_id
  end
  

  #parse_table(table_rows) ⇒ Object

  Parse the module table for any classes

  # File 'lib/tableau/baseparser.rb', line 20
  
  def parse_table(table_rows)
    classes = Tableau::ClassArray.new
    @day = 0
  
    # delete the time header row
    table_rows.delete(table_rows.first)
  
    table_rows.each do |row|
      @time = Time.new(2013, 1, 1, 9, 0, 0)
  
      # drop the 'Day' cell from the row
      row_items = row.xpath('td')
      row_items.delete(row_items.first)
  
      row_items.each do |cell|
        if cell.attribute('colspan')
          intervals = cell.attribute('colspan').value
          classes << create_class(cell)
        else intervals = 1
        end
  
        inc_time(intervals)
      end
  
      @day += 1
    end
  
    classes
  end
  

  #xpath_for_table(table_count) ⇒ Object

  Returns the XPath for the nth table

  # File 'lib/tableau/baseparser.rb', line 131
  
  def xpath_for_table(table_count)
    "/html/body/table[#{3 * table_count - 1}]/tr"
  end
  

  Generated on Tue Apr 14 03:06:52 2026 by yard 0.9.40 (ruby-4.0.2).