coursegen 0.8.3 → 0.9.1

data/lib/coursegen/course/helpers/formatting_helpers.rb

@@ -1,21 +1,17 @@
-# Helpers to be used to format content
+# FormattingHelpers is used to format content.
 module FormattingHelpers
-
   def list_begin
-    "<dl class=\"dl-horizontal\" style=\"font-size: 125%;\">"
+    '<dl class="dl-horizontal" style="font-size: 125%;">'
   end
 
   def list_end
-    "</dd></dl>"
+    '</dd></dl>'
   end
 
-  def le (name, first_entry=false)
-    str = ""
-    if !first_entry
-      str += "</dd><br/>"
-    end
+  def le(name, first_entry = false)
+    str = ''
+    str += '</dd><br/>' unless first_entry
     str += "<dt>#{name}</dt><dd>"
     str
   end
-
 end

data/lib/coursegen/course/helpers/ical_feed_helpers.rb

@@ -1,5 +1,6 @@
+# ICalFeedHelpers is used to create icalender.
 module ICalFeedHelpers
-  def generate_ical source
+  def generate_ical(source)
     data_adaptor = DataAdaptor.new(source)
     ical_adaptor = ICalAdaptor.new
     schedule_feed = ScheduleFeed.new(ical_adaptor, data_adaptor)

data/lib/coursegen/course/helpers/lecture_helpers.rb

@@ -1,9 +1,10 @@
+# LectureHelpers is used to calculate lecture number and date.
 module LectureHelpers
-  def lecture_number_str citem
+  def lecture_number_str(citem)
     citem.lecture_number.to_s
   end
 
   def lecture_date
-    "-ddd-"
+    '-ddd-'
   end
 end

data/lib/coursegen/course/helpers/list_of.rb

@@ -1,26 +1,33 @@
+# Class ListOf represents a lecture table.
 class ListOf
-  # source: name of a section as a string
-  # rows: array with one or more of:
-  #     "pages"
-  #     "subsections"
-  # subsections: array with one or more strings corresponding to subsection string in an item
-  #     .e.g. "/content/topics/arch/"
-  # cols: array with one or more of:
-  #     :date
-  #     :number
-  #     :title
-  #     :homeworks
-  # items: refers to nanoc's @items (temp hack!)
-
-  def initialize(markup_adaptor, data_adaptor, rows, cols, subsections, items)
+  # Initialize creates an instance of ListOf.
+  #
+  # source:       name of a section as a string
+  # rows:         array with one or more of:
+  #               "pages"
+  #               "subsections"
+  # subsections:  array with one or more strings corresponding to subsection
+  #               string in an item
+  #               e.g. "/content/topics/arch/"
+  # cols:         array with one or more of:
+  #               :date
+  #               :number
+  #               :title
+  #               :homeworks
+  #               :lectref
+  #               :readings
+  # items:        refers to nanoc's @items (temp hack!)
+  def initialize(markup_adaptor, data_adaptor, rows, cols, subsections, items, headers)
     @mark = markup_adaptor
     @rows = rows
     @cols = cols
     @data = data_adaptor
     @subsections = subsections
     @items = items
+    @headers = headers
   end
 
+  # Render renders the underlying lecture table.
   def render
     @mark.table_begin
     generate_headers
@@ -36,7 +43,7 @@ class ListOf
 
     @cols.each do |col|
       @mark.header_begin
-      @mark.header_content(@data.column_name(col))
+      @mark.header_content(@headers[col] || @data.column_name(col))
       @mark.header_end
     end
 
@@ -46,6 +53,7 @@ class ListOf
   def generate_rows
     @data.rows do |row_id|
       next unless include_row?(row_id)
+
       if subsection_hdr?(row_id)
         generate_summary_row(row_id)
       else
@@ -73,11 +81,23 @@ class ListOf
   end
 
   def cell_content_string(row_id, col_selector, detail:)
-    if (col_selector == :title && detail)
+    if col_selector == :title && detail
       nitem = @items[row_id.identifier]
       link_to_unless_current(nitem[:title], nitem)
-    elsif (col_selector == :date)
-      @data.cell_value(row_id, col_selector).strftime("%b %-d")
+    elsif col_selector == :hwref
+      tag_value = @data.cell_value(row_id, :hwref)
+      tag_value.nil? ? "n/a" : link_to_section(:homework, tag_value.to_sym)
+    elsif col_selector == :lectref
+      tag_value = @data.cell_value(row_id, :lectref)
+      if tag_value.nil?
+        "n/a"
+      else
+        atag_values = tag_value.split(" ")
+        atag_links = atag_values.map {|tv| link_to_lecture(tv.to_sym)}
+        atag_links.join(", ")
+      end
+    elsif col_selector == :date
+      @data.cell_value(row_id, col_selector).strftime('%b %-d')
     else
       @data.cell_value(row_id, col_selector).to_s
     end
@@ -92,10 +112,10 @@ class ListOf
   end
 
   def include_by_subsection_path?(row_id)
-    @subsections.length == 0 || @subsections.include?(row_id.subsection)
+    @subsections.empty? || @subsections.include?(row_id.subsection)
   end
 
   def subsection_hdr?(row_id)
-    row_id.type == "subsection"
+    row_id.type == 'subsection'
   end
 end

data/lib/coursegen/course/helpers/list_of_helpers.rb

@@ -1,20 +1,26 @@
+# ListOfHelpers is used to create a lecture table.
 module ListOfHelpers
-
-  # source: name of a section as a string
-  # rows: array with one or more of:
-  #     "page"
-  #     "subsection"
-  # cols: array with one or more of:
-  #     :date
-  #     :number
-  #     :title
-  #     :homeworks
-  #     :assigned
-
-  def list_of(source:, rows:, cols:, subsections: [], items:)
+  # List_of creates and renders a lecture table based on the given info.
+  #
+  # source:       name of a section as a string
+  # rows:         array with one or more of:
+  #               "pages"
+  #               "subsections"
+  # cols:         array with one or more of:
+  #               :date
+  #               :number
+  #               :title
+  #               :homeworks
+  #               :assigned
+  #               :lectref
+  # subsections:  array with one or more strings corresponding to subsection
+  #               string in an item
+  #               e.g. "/content/topics/arch/"
+  # items:        refers to nanoc's @items (temp hack!)
+  def list_of(source:, rows:, cols:, headers: {}, subsections: [], items:)
     markup_adaptor = BootstrapMarkup.new
     data_adaptor = DataAdaptor.new(source)
-    lecture_table_builder = ListOf.new(markup_adaptor, data_adaptor, rows, cols, subsections, items)
+    lecture_table_builder = ListOf.new(markup_adaptor, data_adaptor, rows, cols, subsections, items, headers)
     lecture_table_builder.render
   end
 end

data/lib/coursegen/course/helpers/logging_helpers.rb

@@ -1,14 +1,15 @@
+# LoggingHelpers is used to debug log items.
 module LoggingHelpers
-	def log_item_info
-		puts
-		puts "*** ITEM Info: #{item.identifier}"
-		puts "Parent = #{item.parent}"
-		puts "Children = #{item.children}"
-		puts "Reps = #{item.reps}"
-		pp item.attributes
-	end
+  def log_item_info
+    puts
+    puts "*** ITEM Info: #{item.identifier}"
+    puts "Parent = #{item.parent}"
+    puts "Children = #{item.children}"
+    puts "Reps = #{item.reps}"
+    pp item.attributes
+  end
 
-	def compiling item
-		#puts "* compiling #{item[:title]}"
-	end
-end
+  def compiling(item)
+    # puts "* compiling #{item[:title]}"
+  end
+end

data/lib/coursegen/course/helpers/navigation_helpers.rb

@@ -1,6 +1,8 @@
-# Used in the nav bar along the top of the page. Called by main_navbar.html.erb
+# NavigationHelpers provides methods for navigating the course.
+# This is used in the nav bar along the top of the page.
+# Called by main_navbar.html.erb
 module NavigationHelpers
-  def link_to_lecture item_symbol
+  def link_to_lecture(item_symbol)
     link_to_section :lectures, item_symbol
   end
 
@@ -10,73 +12,110 @@ module NavigationHelpers
     link_to(the_citem.title, the_item)
   end
 
-  def link_to_topic item_symbol
+  def link_to_topic(item_symbol)
     link_to_section :topics, item_symbol
   end
 
-  def link_to_background item_symbol
+  def link_to_background(item_symbol)
     link_to_section :background, item_symbol
   end
 
-  def link_to_cribsheet item_symbol
+  def link_to_cribsheet(item_symbol)
     link_to_section :cribsheets, item_symbol
   end
 
-  def link_to_intro item_symbol
+  def link_to_intro(item_symbol)
     link_to_section :intro, item_symbol
   end
 
-  def link_to_incubator item_symbol
+  def link_to_incubator(item_symbol)
     link_to_section :incubator, item_symbol
   end
 
-  def link_to_lab item_symbol
+  def link_to_lab(item_symbol)
     link_to_section :lab, item_symbol
   end
 
-  def link_to_pa item_symbol
+  def link_to_pa(item_symbol)
     link_to_section :pa, item_symbol
   end
 
-  def link_to_page item_symbol
+  def link_to_page(item_symbol)
     link_to_section :pages, item_symbol
   end
 
-  def link_to_project item_symbol
+  def link_to_project(item_symbol)
     link_to_section :projects, item_symbol
   end
 
-  def link_to_section section_symbol, item_symbol
+  def link_to_section(section_symbol, item_symbol)
     the_item = @items[lookup_nitem(section_symbol.to_s, item_symbol.to_s).identifier]
     link_to(the_item[:title], the_item)
   end
 
-  def link_to_next toc, item
+  def link_to_next(toc, item, attrs = {})
     next_nitem = toc.find_next_forn(item).identifier
-    nav_markup2 @items[next_nitem].path, "next"
+    link_to 'next', @items[next_nitem].path, attrs
   end
 
-  def link_to_prev toc, item
+  def link_to_prev(toc, item, attrs = {})
     prev_nitem = toc.find_previous_forn(item).identifier
-    nav_markup2 @items[prev_nitem].path, "previous"
+    link_to 'previous', @items[prev_nitem].path, attrs
   end
 
-  def link_to_inclusion item
+  def link_to_inclusion(item)
     inclusion = Toc.instance.lookup_inclusion(item)
     if inclusion.nil?
-      "(never included)"
+      '(never included)'
     else
       " (#{inclusion.identifier})"
     end
   end
 
-  private
+  # def link_to_slides_2
+  #   '<a
+  #     class="btn btn-sm btn-primary"
+  #     href="./slides.html"
+  #     title="slides">
+  #     <i class="fas fa-chalkboard-teacher"></i> Slides
+  #   </a>'
+  # end
 
-  def nav_markup text, path, icon, tooltip=""
-    "<a class=\"nav-btn btn btn-mini\" href=\"#{path}\"><i class=\"#{icon}\" rel=\"tooltip\" title=\"#{tooltip}\"></i>#{text}</a>"
+  def link_to_slides(attrs = {})
+    link_to("slides", "./slides.html", attrs)
   end
 
-  def nav_markup2 path, text
-    "<a class=\"btn btn-sm btn-light\" href=\"#{path}\">#{text}</a>"
+  # def link_to_homework_2(citem)
+  #   unless citem.hwref.nil?
+  #     "<div class=\"btn btn-sm btn-primary\">" +
+  #     "<i class=\"fad fa-backpack\"></i>" +
+  #     link_to_section(:homework, citem.hwref.to_sym) +
+  #     "</div>"
+  #   end
+  # end
+
+  def link_to_homework(citem, attrs = {})
+    return "" if citem.hwref.nil?
+
+    the_item = @items[lookup_nitem("homework", citem.hwref).identifier]
+    # link_to(the_item[:title], the_item, attrs)
+    link_to("homework", the_item, attrs)
   end
+
+  private
+
+  # def nav_markup2(text, path, icon, tooltip = '')
+  #   "<a class=\"nav-btn btn btn-mini\" href=\"#{path}\">
+  #   <i class=\"#{icon}\" rel=\"tooltip\" title=\"#{tooltip}\"></i>#{text}</a>"
+  # end
+
+  def nav_markup(path, text)
+    "<a class=\"btn btn-sm btn-primary\" href=\"#{path}\">#{text}</a>"
+  end
+
+  # def nav_markup_3(path, text, fontawesome, tooltip = '')
+  #   "<a class=\"btn btn-sm btn-primary\" href=\"#{path}\">" + 
+  #   "<i class=\"#{fontawesome}\"></i>" + 
+  #   "#{text}</a>"
+  # end
 end

data/lib/coursegen/course/helpers/sidebar_helpers.rb

@@ -1,22 +1,22 @@
-# Set of helpers to display the navigation sidebar
+# SidebarHelpers is a set of helpers to display the navigation sidebar.
 module SidebarHelpers
-  def section_helper title: nil, selector: nil
+  def section_helper(title: nil, selector: nil)
     sect = Toc.instance.section(selector)
     @sect_def = Toc.instance.section_def(selector)
     str = "<li>
             <label class=\"tree-toggler level1\">
               #{collapsed_indicator(sect.collapsed?)}
               #{title}
-            </label>"
-    str += sect.has_subsections? ? nested_section(sect) : flat_section(sect)
-    str + "</li>"
+            </label>
+            #{sect.has_subsections? ? nested_section(sect) : flat_section(sect)}
+          </li>"
   end
 
-  def nested_section sect
-    sect.subsections.reduce("") {|acc, subs| acc + subsection_body(subs)}
+  def nested_section(sect)
+    sect.subsections.reduce('') { |acc, subs| acc + subsection_body(subs) }
   end
 
-  def subsection_body sect
+  def subsection_body(sect)
     "<ul class=\"tree\">
       <li>
         <label class=\"tree-toggler level2\">
@@ -33,34 +33,35 @@ module SidebarHelpers
   end
 
   def subsection(subsect, collapsed)
-    disp_clause = collapsed ? "display: none" : "display: block"
+    disp_clause = collapsed ? 'display: none' : 'display: block'
     str = "<ul class=\"tree\" style=\"#{disp_clause}\">"
     str = subsect.children.reduce(str) { |acc, item| acc + subsection_item_link(item) }
-    str + "</ul>"
+    str + '</ul>'
   end
 
-  def subsection_item_link tree_node
+  def subsection_item_link(tree_node)
     bullet = @sect_def.options[:bullet]
     link_path = @items[tree_node.content.identifier].path
     "<li class=\"#{tree_node.content.css_class}\">#{icon_markup(bullet)}<a href=\"#{link_path}\">#{tree_node.content.title}</a></li>"
   end
 
-  def flat_section sect
-    disp_clause = sect.collapsed? ? "display: none" : "display: block"
+  def flat_section(sect)
+    disp_clause = sect.collapsed? ? 'display: none' : 'display: block'
     str = "<ul class=\"tree\" style=\"#{disp_clause}\">"
     str = sect.reduce(str) { |acc, item| acc + flat_section_item_link(item) }
-    str + "</ul>"
+    str + '</ul>'
   end
 
-  def flat_section_item_link citem
+  def flat_section_item_link(citem)
     bullet = @sect_def.options[:bullet]
     path = @items[citem.identifier].path
     "<li class=\"#{citem.css_class}\">#{icon_markup(bullet)}<a href=\"#{path}\">#{citem.title}</a></li>"
   end
 
-  def icon_markup icon_type
-    return "" if icon_type.nil?
-    css_class = {dash: "glyphicon-minus", star: "glyphicon-star", plus: "glyphicon-plus-sign", minus: "glyphicon-minus-sign"}.fetch(icon_type)
+  def icon_markup(icon_type)
+    return '' if icon_type.nil?
+
+    css_class = { dash: 'glyphicon-minus', star: 'glyphicon-star', plus: 'glyphicon-plus-sign', minus: 'glyphicon-minus-sign' }.fetch(icon_type)
     "<span class=\"glyphicon #{css_class}\" style=#{STYLING_CONFIG[:bullet_style]}></span>"
   end
 end

data/lib/coursegen/course/helpers/table_helpers.rb

@@ -1,3 +1,4 @@
+# Class TableHelper provides methods for creating a table.
 class TableHelper
   def initialize(*property)
     @prop = property
@@ -5,9 +6,9 @@ class TableHelper
   end
 
   def headers(*labels)
-    css_style = ""
-    css_style += " table-condensed" if @prop.include? :normal
-    css_style += " table-bordered" if @prop.include? :bordered
+    css_style = ''
+    css_style += ' table-condensed' if @prop.include? :normal
+    css_style += ' table-bordered' if @prop.include? :bordered
     @bm.table_begin(css_style)
     @bm.headers_begin
     labels.each do |h|
@@ -28,7 +29,7 @@ class TableHelper
     @bm.row_end
   end
 
-  def render()
+  def render
     @bm.table_end
     @bm.render
   end