coursegen 0.3.1 → 0.4.2

data/lib/coursegen/course/data/section_def.rb

@@ -1,10 +1,10 @@
 # Sidebar configuration
 
 class SectionDef
-	attr_accessor :title, :selector, :options
-	def initialize(title, selector, options = {})
-		@title = title
-		@selector = selector
-		@options = options
-	end
+  attr_accessor :title, :selector, :options
+  def initialize(title, selector, options = {})
+    @title = title
+    @selector = selector
+    @options = options
+  end
 end

data/lib/coursegen/course/data/toc.rb

@@ -15,8 +15,7 @@ class Toc
 
   def build_sections items
     @sections = {}
-    @section_config.each do
-      |sect|
+    @section_config.each do |sect|
       selector = sect.selector.to_s
       if sect.options[:type] == :lecture
         schedule = Scheduler.new

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

@@ -2,6 +2,7 @@ class BootstrapMarkup
   def initialize
     @str = ""
   end
+
   def table_begin(css_class="table-condensed")
     @str << "<table class=\"table #{css_class}\">"
   end
@@ -27,7 +28,7 @@ class BootstrapMarkup
   end
 
   def header_content(str)
-    @str << str
+    @str << str unless str.nil?
   end
 
   def row_begin
@@ -61,4 +62,4 @@ class BootstrapMarkup
   def render
     @str
   end
-end
+end

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

@@ -1,9 +1,23 @@
+# Helpers to be used to annotate content
 module ContentHelpers
-
   def include_topic item_symbol
-      incorporated_topic = lookup_nitem("topics", item_symbol.to_s)
-#      Toc.instance.record_inclusion @item, incorporated_topic
-      items[incorporated_topic.identifier.to_s].compiled_content
+    incorporated_topic = lookup_nitem("topics", item_symbol.to_s)
+    items[incorporated_topic.identifier.to_s].compiled_content
+  end
+
+  def include_page item_symbol
+    incorporated_topic = lookup_nitem("pages", item_symbol.to_s)
+    items[incorporated_topic.identifier.to_s].compiled_content
+  end
+
+  def include_background item_symbol
+    incorporated_topic = lookup_nitem("background", item_symbol.to_s)
+    items[incorporated_topic.identifier.to_s].compiled_content
+  end
+
+  def include_intro item_symbol
+    incorporated_topic = lookup_nitem("intro", item_symbol.to_s)
+    items[incorporated_topic.identifier.to_s].compiled_content
   end
 
   def include_from_section sect_symbol, item_symbol
@@ -13,44 +27,76 @@ module ContentHelpers
   end
 
   def lookup_nitem the_sect, short_name
-    citem = Toc.instance.lookup_citem(the_sect, short_name).nitem
+    Toc.instance.lookup_citem(the_sect, short_name).nitem
   end
 
   def link_to_doc label, file_name
-      "<a href=\"/docs/#{file_name}\">#{label}</a>"
+    "<a href=\"/docs/#{file_name}\">#{label}</a>"
   end
 
   def toc_link_to item
-      link_to_unless_current item[:title], item
+    link_to_unless_current item[:title], item
   end
 
   def bold_red string
-      "<span style=\"color: red; font-style: italic;\">#{string}</span>"
+    "<span style=\"color: red; font-style: italic;\">#{string}</span>"
   end
 
   def italic_red string
-      " *#{string}*{: style=\"color: red\"} "
+    " *#{string}*{: style=\"color: red\"} "
   end
 
   def ir string; italic_red(string); end
 
-  def callout title, body, format=nil
-    template_string = <<-HTMLSTRING
+  def callout title, body
+    <<-HTMLSTRING
 <div class="well well-sm">
-<span class="label label-primary">#{title}</span>#{body}
+<span class="themebg label label-primary">#{title}</span>#{body}
 </div>
 HTMLSTRING
   end
 
+  def textbadge text, tooltip
+    %(<span class="label label-info" data-toggle="tooltip" data-placement="top" title="#{tooltip}">#{text}</span>)
+  end
+
+  def iconbadge icon, tooltip
+    %(<span class="glyphicon glyphicon-#{icon} themefg" data-toggle="tooltip" data-placement="top" title="#{tooltip}"></span>)
+  end
+
+  def pdfbadge
+    iconbadge("file", "Submit as 1 page pdf, include name and homework #")
+  end
+
+  def codebadge
+    iconbadge("cloud", "Work on code in your portfolio")
+  end
+
+  def cloudbadge
+    codebadge
+  end
+
+  def zipbadge
+    iconbadge("briefcase", "Submit code as a .zip file")
+  end
+
+  def partbadge
+    iconbadge("check", "Graded for participation only")
+  end
+
+  def timebadge
+    iconbadge("time", "Must be submitted first thing on day of class")
+  end
+
   def include_image_old string, extra_class: nil
     css_class = "img-responsive"
-    css_class += " img-"+extra_class unless extra_class.nil?
+    css_class += " img-" + extra_class unless extra_class.nil?
 
-    "<img src=\"/content/images/#{string}\" class=\"%s\" />"  % css_class
+    "<img src=\"/content/images/#{string}\" class=\"%s\" />" % css_class
   end
 
   def include_image filename_string, width: 8
-  template_string = <<-HTMLSTRING
+    <<-HTMLSTRING
 <div class="row">
   <div class="col-md-offset-2 col-md-#{width}">
     <img src="#{filename_string}" class="img-responsive img-thumbnail" />
@@ -59,28 +105,36 @@ HTMLSTRING
   HTMLSTRING
   end
 
-  def important string=":"
-      "**Important#{string}**{: style=\"color: red\"}"
+  def important string = ":"
+    "**Important#{string}**{: style=\"color: red\"}"
+  end
+
+  def nb string = ""
+    "*NB: #{string}*{: style=\"color: green\"}"
+  end
+
+  def tbd string = ""
+    "*[TO BE DETERMINED#{string}]*{: style=\"color: red\"}"
   end
 
-  def nb string=""
-      "*NB: #{string}*{: style=\"color: green\"}"
+  def deliverable string, append=""
+    "*Deliverable:*{: style=\"color: red\"} #{string + append} "
   end
 
-  def tbd string=""
-      "*[TO BE DETERMINED#{string}]*{: style=\"color: red\"}"
+  def deliverable_po(string)
+    deliverable(string, " *(graded for participation only)*")
   end
 
-  def deliverable string
-      "*Deliverable:*{: style=\"color: red\"} *#{string}*"
+  def deliverable_popdf(string)
+    deliverable(string, " *(pdf with name and hw number, graded for participation only)*")
   end
 
   def team_deliverable string
-      "*Team Deliverable:*{: style=\"color: red\"} *#{string}*"
+    "*Team Deliverable:*{: style=\"color: red\"} *#{string}*"
   end
 
   def discussion string
-      "*Discussion:*{: style=\"color: blue\"} *#{string}*"
+    "*Discussion:*{: style=\"color: blue\"} *#{string}*"
   end
 
   def homework_hdr
@@ -88,90 +142,82 @@ HTMLSTRING
   end
 
   def carousel(filenames)
-    body = %~<div id="myCarousel" class="carousel slide" style="width: 500px; margin: 0 auto;">
-            <div class="carousel-inner" style="margin: 20px; ">~
+    body = %(<div id="myCarousel" class="carousel slide" style="width: 500px; margin: 0 auto;">
+            <div class="carousel-inner" style="margin: 20px; ">)
     counter = 0
-  filenames.each do
-    |nam|
-    if counter == 0
-        body << %~<div class="item active">~
-    else
-        body << %~<div class="item">~
+    filenames.each do |nam|
+      body << counter == 0 ? %(div class="item active">) : body << %(<div class="item">~
+      body << %~<img src=")
+      body << "/content/images/#{nam}"
+      body << %(" class="img-polaroid" alt=""></div>)
+      counter += 1
     end
-    body << %~<img src="~
-    body << "/content/images/#{nam}"
-    body << %~" class="img-polaroid" alt=""></div>~
-    counter += 1
-  end
-    body << %~</div> <a class="left carousel-control" href="#myCarousel" data-slide="prev">‹</a>
+    body << %(</div> <a class="left carousel-control" href="#myCarousel" data-slide="prev">‹</a>
                 <a class="right carousel-control" href="#myCarousel" data-slide="next">›</a>
-            </div>~
+            </div>)
     body
   end
 
   def carousel_new(filenames)
-    carousel_work(filenames.map {|filename| "/content/topics/images/"+filename })
-  end
-
- def carousel_work(filenames)
-  body = %~<div id="myCarousel" class="carousel slide" style="width: 500px; margin: 0 auto;">
-            <div class="carousel-inner" style="margin: 20px; ">~
-  counter = 0
-  filenames.each do
-    |nam|
-    if counter == 0
-        body << %~<div class="item active">~
-    else
-        body << %~<div class="item">~
-    end
-    body << %~<img src="~
-    body << nam
-    body << %~" class="img-polaroid" alt=""></div>~
-    counter += 1
+    carousel_work(filenames.map {|filename| "/content/topics/images/" + filename })
   end
-    body << %~</div> <a class="left carousel-control" href="#myCarousel" data-slide="prev">‹</a>
-                <a class="right carousel-control" href="#myCarousel" data-slide="next">›</a>
-            </div>~
+
+  def carousel_work(filenames)
+    body = %(<div id="myCarousel" class="carousel slide" data-ride="carousel" style="width: 500px; margin: 0 auto;">
+            <div class="carousel-inner" role="listbox" style="margin: 20px; ">)
+    counter = 0
+    filenames.each do |nam|
+      ci = counter == 0 ? %(<div class="carousel-item active">) : %(<div class="carousel-item">)
+      puts "****** #{ci}"
+      body << ci
+      body << %(<img src=")
+      body << nam
+      body << %(" class="d-block img-fluid"></div>)
+      counter += 1
+    end
+    body << %(</div> <a class="carousel-control-prev" role="button" href="#myCarousel" data-slide="prev">‹</a>
+                <a class="carousel-control-next" role="button" href="#myCarousel" data-slide="next">›</a>
+            </div>)
     body
   end
 
-
   def ruby_begin
-      "\n~~~~~~"
+    "\n~~~~~~"
   end
 
   def ruby_end
-      "~~~~~~\n {: .language-ruby}"
+    "~~~~~~\n {: .language-ruby}"
   end
 
-  def ruby_string (str)
-      ruby_begin + "\n" +  str + "\n" + ruby_end
+  def ruby_string str
+    ruby_begin + "\n" + str + "\n" + ruby_end
   end
 
   def include_ruby name
-    filename = Dir.pwd+"/content/content/topics/scripts/"+name.to_s+".rb"
+    filename = Dir.pwd + "/content/content/topics/scripts/" + name.to_s + ".rb"
     filecontents = File.new(filename).read
     ruby_string filecontents
   end
 
   def code_begin
-      "\n~~~~~~"
+    "\n~~~~~~"
   end
 
-  def code_end
-      "~~~~~~\n"
+  def code_end lang=""
+    str = "~~~~~~\n"
+    if ["ruby", "css", "java", "html"].include? lang
+      str += "{: .language-#{lang}}"
+    end
+    str
   end
 
-  def code_string (str)
+  def code_string str
     code_begin + "\n" + str + code_end
   end
 
   def include_code name
-    filename = Dir.pwd+"/content/content/topics/scripts/"+name
+    filename = Dir.pwd + "/content/content/topics/scripts/" + name
     filecontents = File.new(filename).read
     code_string filecontents
   end
-
-
-
 end

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

@@ -1,7 +1,7 @@
 module ICalFeedHelpers
   def generate_ical source
     data_adaptor = DataAdaptor.new(source)
-    ical_adaptor = ICalAdaptor.new()
+    ical_adaptor = ICalAdaptor.new
     schedule_feed = ScheduleFeed.new(ical_adaptor, data_adaptor)
     schedule_feed.render
   end

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

@@ -1,5 +1,4 @@
 class ListOf
-
   # source: name of a section as a string
   # rows: array with one or more of:
   #     "pages"
@@ -11,13 +10,15 @@ class ListOf
   #     :number
   #     :title
   #     :homeworks
+  # items: refers to nanoc's @items (temp hack!)
 
-  def initialize(markup_adaptor, data_adaptor, rows, cols, subsections)
+  def initialize(markup_adaptor, data_adaptor, rows, cols, subsections, items)
     @mark = markup_adaptor
     @rows = rows
     @cols = cols
     @data = data_adaptor
     @subsections = subsections
+    @items = items
   end
 
   def render
@@ -54,13 +55,13 @@ class ListOf
   end
 
   def generate_detail_row(row_id)
-      @mark.row_begin
-      @cols.each do |col_selector|
-        @mark.cell_begin
-        @mark.cell_content(cell_content_string(row_id, col_selector, detail: true))
-        @mark.cell_end
-      end
-      @mark.row_end
+    @mark.row_begin
+    @cols.each do |col_selector|
+      @mark.cell_begin
+      @mark.cell_content(cell_content_string(row_id, col_selector, detail: true))
+      @mark.cell_end
+    end
+    @mark.row_end
   end
 
   def generate_summary_row(row_id)
@@ -73,8 +74,8 @@ class ListOf
 
   def cell_content_string(row_id, col_selector, detail:)
     if (col_selector == :title && detail)
-#      link_to_unless_current(row_id.nitem[:title], row_id.identifier)
-      link_to_unless_current(row_id.nitem[:title], row_id)
+      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")
     else
@@ -97,5 +98,4 @@ class ListOf
   def subsection_hdr?(row_id)
     row_id.type == "subsection"
   end
-
 end

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

@@ -10,10 +10,10 @@ module ListOfHelpers
   #     :title
   #     :homeworks
 
-  def list_of(source:, rows:, cols:, subsections: [])
+  def list_of(source:, rows:, cols:, subsections: [], items:)
     markup_adaptor = BootstrapMarkup.new
     data_adaptor = DataAdaptor.new(source)
-    lecture_table_builder = ListOf.new(markup_adaptor, data_adaptor, rows, cols, subsections)
+    lecture_table_builder = ListOf.new(markup_adaptor, data_adaptor, rows, cols, subsections, items)
     lecture_table_builder.render
   end
 end

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

@@ -1,12 +1,13 @@
+# 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
     link_to_section :lectures, item_symbol
   end
 
   def link_to_next_lecture
-    the_item = Toc.instance.find_next_forn(@item)
-    link_to(the_item.title, the_item)
+    the_citem = Toc.instance.find_next_forn(@item)
+    the_item = @items[the_citem.identifier]
+    link_to(the_citem.title, the_item)
   end
 
   def link_to_topic item_symbol
@@ -33,37 +34,45 @@ module NavigationHelpers
     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
+    link_to_section :pages, item_symbol
+  end
+
+  def link_to_project item_symbol
+    link_to_section :projects, item_symbol
+  end
+
   def link_to_section section_symbol, item_symbol
-	   the_item = lookup_nitem(section_symbol.to_s, item_symbol.to_s)
-		#link_to_unless_current(the_item[:title], the_item.identifier)
+    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
-		nav_markup "", toc.find_next_forn(item).nitem.path, "glyphicon glyphicon-chevron-right", "next page"
-	end
+  end
 
-	def link_to_prev toc, item
-		nav_markup "", toc.find_previous_forn(item).nitem.path, "glyphicon glyphicon-chevron-left", "previous page"
-	end
+  def link_to_next toc, item
+    next_nitem = toc.find_next_forn(item).identifier
+    nav_markup "", @items[next_nitem].path, "glyphicon glyphicon-arrow-right", "next page"
+  end
 
-	def link_to_inclusion item
-		inclusion = Toc.instance.lookup_inclusion(item)
-		if inclusion.nil?
-			"(never included)"
-		else
-			" (#{inclusion.identifier})"
-		end
-	end
+  def link_to_prev toc, item
+    prev_nitem = toc.find_previous_forn(item).identifier
+    nav_markup "", @items[prev_nitem].path, "glyphicon glyphicon-arrow-left", "previous page"
+  end
 
-	private
+  def link_to_inclusion item
+    inclusion = Toc.instance.lookup_inclusion(item)
+    if inclusion.nil?
+      "(never included)"
+    else
+      " (#{inclusion.identifier})"
+    end
+  end
 
-	def nav_markup text, path, icon, tooltip=""
-		"<a class=\"btn btn-mini\" href=\"#{path}\"><i class=\"#{icon}\" rel=\"tooltip\" title=\"#{tooltip}\"></i>#{text}</a>"
-	end
+  private
 
+  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>"
+  end
 end

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

@@ -1,6 +1,6 @@
+# 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>
@@ -8,12 +8,8 @@ module SidebarHelpers
               #{collapsed_indicator(sect.collapsed?)}
               #{title}
             </label>"
-    if sect.has_subsections?
-      str += nested_section(sect)
-    else
-      str += flat_section(sect)
-    end
-    str += "</li>"
+    str += sect.has_subsections? ? nested_section(sect) : flat_section(sect)
+    str + "</li>"
   end
 
   def nested_section sect
@@ -36,28 +32,30 @@ module SidebarHelpers
     icon_markup(coll ? :plus : :minus)
   end
 
-  def subsection subsect, collapsed
+  def subsection(subsect, collapsed)
     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
-  bullet = @sect_def.options[:bullet]
-   "<li class=\"#{tree_node.content.css_class}\">#{icon_markup(bullet)}<a href=\"#{tree_node.content.path}\">#{tree_node.content.title}</a></li>"
+    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"
     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
     bullet = @sect_def.options[:bullet]
-    "<li class=\"#{citem.css_class}\">#{icon_markup(bullet)}<a href=\"#{citem.path}\">#{citem.title}</a></li>"
+    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
@@ -65,6 +63,4 @@ module SidebarHelpers
     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/lib/ical_adaptor.rb

@@ -10,13 +10,11 @@ class ICalAdaptor
     @cal.add_timezone tz.ical_timezone(Time.now)
   end
 
-  def feed_begin
-  end
+  def feed_begin; end
 
-  def feed_end
-  end
+  def feed_end; end
 
-  def feed_event(title, dt_start, dt_end, desc, url)
+  def feed_event(title, dt_start, dt_end, desc, _url)
     event = Icalendar::Event.new
     event.dtstart = dt_start
 #    event.dtstart = Icalendar::Values::DateOrDateTime.new(dt_start, tzid: 'UTC').call

data/lib/coursegen/course/lib/search_data_generator.rb

@@ -4,12 +4,12 @@ class SearchIndex
     all_citems = all_items.map { |itm| Toc.instance.n2c(itm) }
     @index = all_citems.select { |citem| include_in_index? (citem)}.map do
       |item|
-        nok_parse = Nokogiri::HTML(item.nitem.compiled_content).at('body')
+        nok_parse = Nokogiri::HTML(all_items[item.identifier].compiled_content).at('body')
         nok_parse_inner_text = nok_parse.nil? ? "" : nok_parse.inner_text
         { title:  clean_string(item.title),
           text:   clean_string(nok_parse_inner_text),
           tags:   "",
-          loc:  item.nitem.reps[:default].path }
+          loc:  all_items[item.identifier].reps[:default].path }
     end
   end
 
@@ -18,10 +18,9 @@ class SearchIndex
   end
 
   def include_in_index?(citem)
-    skiplist = Regexp.union([/\/tipuesearch_logic\/.*/, /\/bootstrap\/.*/, /\/config\/.*/, /\/tipuesearch\/.*/])
+    skiplist = Regexp.union([/\/tipuesearch\/.*/, /\/bootstrap\/.*/, /\/config\/.*/, /\/tipuesearch\/.*/])
     citem.type == "page" &&
       !citem.nitem.binary? &&
       !citem.identifier.to_s.match(skiplist)
   end
-
 end

data/lib/coursegen/course/schedule/schedule_def.rb

@@ -1,16 +1,17 @@
 # Define schedule scheme for a lecture series
 
 class ScheduleDef
-		attr_reader :first_day, :weekdays, :number, :skips, :start_time, :end_time
-
-		def initialize(first_day: nil, weekdays: nil, number: nil,
-									 skips: [], start_time: "12:15", end_time: "13:15")
-			@first_day = first_day
-			@weekdays = weekdays
-			@number = number
-			@skips = skips
-			@start_time = start_time
-			@end_time = end_time
-		end
+  attr_reader :first_day, :weekdays, :number, :skips, :start_time, :end_time, :start_times, :end_times
 
+  def initialize(first_day: nil, weekdays: nil, number: nil,
+                skips: [], start_time: nil, end_time: nil, start_times: [], end_times: [])
+    @first_day = first_day
+    @weekdays = weekdays
+    @number = number
+    @skips = skips
+    @start_time = start_time
+    @end_time = end_time
+    @start_times = start_times
+    @end_times = end_times
+  end
 end

data/lib/coursegen/course/schedule/schedule_feed.rb

@@ -1,4 +1,6 @@
-# Used in generating iCal feed. Given a data_adapter (who knows how to get data out and iterate across things) and a feed_builder (who knows how to turn that data into some kind of feed), produce the feed. This same class could also generate, for example, an RSs feed.
+# Used in generating iCal feed. Given a data_adapter (who knows how to get data out and iterate across things) and a
+# feed_builder (who knows how to turn that data into some kind of feed), produce the feed. This same class could also
+# generate, for example, an RSs feed.
 
 class ScheduleFeed
   def initialize feed_builder, data_adapter