coursegen 0.8.3 → 0.9.1

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/coursegen.gemspec

@@ -1,37 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'coursegen/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "coursegen"
+  spec.name          = 'coursegen'
   spec.version       = Coursegen::VERSION
-  spec.authors       = ["Pito Salas"]
-  spec.email         = ["pitosalas@gmail.com"]
-  spec.summary       = "Use Nanoc to build courses and deploy them to S3"
-  spec.description   = "Use Nanoc to build courses and deploy them to S3"
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Pito Salas']
+  spec.email         = ['pitosalas@gmail.com']
+  spec.summary       = 'Use Nanoc to build courses and deploy them to S3'
+  spec.description   = 'Use Nanoc to build courses and deploy them to S3'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-
-  spec.add_dependency "nanoc"
-  spec.add_dependency "thor"
-  spec.add_dependency "rubytree"
-  spec.add_dependency "cri"
-  spec.add_dependency "nokogiri"
-  spec.add_dependency "activesupport"
-  spec.add_dependency "kramdown"
-  spec.add_dependency "adsf"
-  spec.add_dependency "guard"
-  spec.add_dependency "guard-shell"
-  spec.add_dependency "tzinfo"
-  spec.add_dependency "icalendar"
-  spec.add_dependency "byebug"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'adsf'
+  spec.add_dependency 'byebug'
+  spec.add_dependency 'cri'
+  spec.add_dependency 'guard'
+  spec.add_dependency 'guard-shell'
+  spec.add_dependency 'icalendar'
+  spec.add_dependency 'kramdown'
+  spec.add_dependency 'nanoc'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'rubytree'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'tzinfo'
 end

data/lib/coursegen.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
 require 'coursegen/version'
@@ -25,7 +27,8 @@ require 'coursegen/course/helpers/list_of'
 require 'coursegen/course/helpers/ical_feed_helpers'
 require 'coursegen/course/lib/helpers_'
 
-
+# Coursegen is a course curriculum site generator based on nanoc, with
+# support for sections, lectures, code examples, homeworks, course
+# calendar and lots more.
 module Coursegen
-  # Your code goes here...
 end

data/lib/coursegen/cli.rb

@@ -1,46 +1,81 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'coursegen/templates'
 require 'nanoc'
 require './cg_config.rb' if File.exist? 'cg_config.rb'
 
 module CourseGen
+  # Class CLI provides a command line utility for creating, building, and
+  # deploying a Coursegen site.
   class CLI < Thor
     include Thor::Actions
 
-    desc "new COURSE", "Create a new course by calling nanoc. Argument is name of the COURSE"
+    # New creates a new nanoc site.
+    #
+    # By default, the new site does not contain any course template.
+    # To generate a course template within the newly created nanoc site,
+    # run: `cg prepare`.
+    #
+    # See: https://nanoc.ws/doc/reference/commands/#create-site
+    desc 'new COURSE',
+         'Create a new course by calling nanoc. Argument is name of the COURSE'
     def new(course)
       run("nanoc create-site #{course}")
     end
 
-    desc "prepare", "Update with the latest coursegen code and templates."
+    # Prepare generates a new course template within a nanoc site.
+    desc 'prepare',
+         'Update with the latest coursegen code and templates.'
     def prepare
       check_valid_directory
       tplt = CourseGen::Templates.new
       tplt.generate_all
     end
 
-    desc "compile", "build the course and put resultant site into output directory"
+    # Compile builds the course site and outputs it to a local directory.
+    #
+    # By default, it outputs the course site to ./output.
+    #
+    # See: https://nanoc.ws/doc/reference/commands/#compile
+    desc 'compile',
+         'build the course and put resultant site into output directory'
     def compile
-      run("nanoc compile")
+      run 'nanoc compile'
     end
 
-    desc "serve", "start local web server to test the course web site"
+    # Serve starts a static web server that serves the course site.
+    #
+    # By default, the web server serves from ./output.
+    #
+    # See: https://nanoc.ws/doc/reference/commands/#view
+    desc 'serve',
+         'start local web server to test the course web site'
     def serve
-      run("nanoc view")
+      run 'nanoc view'
     end
 
-    desc "reset", "reset all generated content to bring the course back to a base state."
+    # Reset removes all generated contents.
+    desc 'reset',
+         'reset all generated content to bring the course back to a base state.'
     def reset
-      run "rm -frd tmp"
-      run "rm -frd output"
+      run 'rm -frd tmp'
+      run 'rm -frd output'
     end
 
-    desc "view", "view course site locally in browser"
+    # View opens an browser to the running course site.
+    desc 'view',
+         'view course site locally in browser'
     def view
-      run "open http://0.0.0.0:3000"
+      run 'open http://0.0.0.0:3000'
     end
 
-    desc "deploy", "Deploy course to S3"
+    # Deploy deploys the course site to AWS S3.
+    #
+    # Note: `s3cmd` needs to be properly setup before this can work. Refer
+    # to README.md for detailed instructions.
+    desc 'deploy',
+         'Deploy course to S3'
     def deploy
       run "s3cmd sync --delete-removed output/ s3://#{AWS_BUCKET}/"
     end
@@ -48,9 +83,9 @@ module CourseGen
     no_commands do
       def check_valid_directory
         if CourseGen::Templates.new.valid_cg_directory?
-          say("Valid cg directory")
+          say 'Valid cg directory'
         else
-          error("Invalid cg directory")
+          error 'Invalid cg directory'
         end
       end
     end

data/lib/coursegen/course/data/citem.rb

@@ -6,7 +6,8 @@ require 'active_support/inflector'
 #
 class CItem
   attr_reader :order, :section, :subsection, :subsection_citem, :title,
-              :type, :identifier, :short_name, :status, :nitem, :css_class, :homework, :desc, :cat, :assigned
+              :type, :identifier, :short_name, :status, :nitem, :css_class,
+              :homework, :hwref, :desc, :cat, :assigned, :slides, :lectref, :reading, :due
   attr_accessor :lecture_number, :lecture_date, :start_time, :end_time
 
   # Callable with nitem=nil to create a mock
@@ -53,6 +54,7 @@ class CItem
 
   def schedule_start_date_time
     return if @lecture_date.nil?
+
     # schedule = Toc.instance.section(@section).schedule
     # lecture_date + schedule.start_time
     lecture_date + @start_time
@@ -60,6 +62,7 @@ class CItem
 
   def schedule_end_date_time
     return if @lecture_date.nil?
+
     # schedule = Toc.instance.section(@section).schedule
     # lecture_date + schedule.end_time
     lecture_date + @end_time
@@ -85,7 +88,13 @@ class CItem
     @homework = @nitem[:homework]
     @desc = @nitem[:desc]
     @cat = @nitem[:cat]
+    @hwref = @nitem[:hwref]
     @assigned = @nitem[:assigned]
+    @slides = @nitem[:slides]
+    @lectref = @nitem[:lectref]
+    @reading = @nitem[:reading]
+    @due = @nitem[:due]
+
   end
 
   def parse_identifier(ident)

data/lib/coursegen/course/data/data_adaptor.rb

@@ -5,8 +5,8 @@ class DataAdaptor
   end
 
   # column_selector is one of: :number, :date, :title, :homework
-  COL_NAMES = {number: "#", date: "lecture date", title: "title",
-                homework: "homework", desc: "description", cat: "category"}
+  COL_NAMES = { number: '#', date: 'lecture date', title: 'title',
+                homework: 'homework', desc: 'description', cat: 'category', hwref: 'homework', lectref: 'topics', reading: 'reading' }
 
   def column_name(column_selector)
     COL_NAMES[column_selector]
@@ -30,6 +30,8 @@ class DataAdaptor
       citem.identifier
     when :desc
       citem.desc
+    when :due
+      citem.due
     when :homework
       citem.homework
     when :assigned
@@ -39,13 +41,21 @@ class DataAdaptor
     when :end_date_time
       citem.schedule_end_date_time
     when :full_desc
-      desc = citem.desc || ""
-      hw = citem.homework || ""
-      desc + ". HW: " + hw
+      desc = citem.desc || ''
+      hw = citem.homework || ''
+      desc + '. HW: ' + hw
     when :cat
       citem.cat
+    when :lectref
+      citem.lectref
+    when :hwref
+      citem.hwref
+    when :reading
+      citem.reading
+    when :order
+      citem.order
     else
-      "error!"
+      'error!'
     end
   end
 end

data/lib/coursegen/course/data/section.rb

@@ -60,7 +60,7 @@ class Section
   def lookup_citem_by_identifier identifier
     res = @citems.select { |i| i.identifier.to_s == identifier }
     fail "TOC#lookup_citem_by_identifier failed to find: '#{identifier}'"  if res.length != 1
-#		binding.pry if res.length != 1
+    byebug if res.length != 1
     res[0]
   end
 

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

@@ -1,32 +1,32 @@
+# Class BootstrapMarkup provides methods for using Bootstrap specific HTML
+# markups.
 class BootstrapMarkup
   def initialize
-    @str = ""
+    @str = ''
   end
 
-  def table_begin(css_class = "table-condensed")
-    puts css_class.class
+  def table_begin(css_class = 'table-condensed')
     @str << "<table class=\"table x #{css_class}\">"
-    puts @str
   end
 
   def table_end
-    @str << "</table>"
+    @str << '</table>'
   end
 
   def headers_begin
-    @str << "<thead><tr>"
+    @str << '<thead><tr>'
   end
 
   def headers_end
-    @str << "</tr></thead>"
+    @str << '</tr></thead>'
   end
 
   def header_begin
-    @str << "<th>"
+    @str << '<th>'
   end
 
   def header_end
-    @str << "</th>"
+    @str << '</th>'
   end
 
   def header_content(str)
@@ -34,27 +34,27 @@ class BootstrapMarkup
   end
 
   def row_begin
-    @str << "<tr>"
+    @str << '<tr>'
   end
 
   def row_end
-    @str << "</tr>"
+    @str << '</tr>'
   end
 
   def cell_begin
-    @str << "<td>"
+    @str << '<td>'
   end
 
   def cell_end
-    @str << "</td>"
+    @str << '</td>'
   end
 
   def bigcell_begin
-    @str << "<td colspan=\"3\"><h5>"
+    @str << '<td colspan="3"><h5>'
   end
 
   def bigcell_end
-    @str << "</h5></td>"
+    @str << '</h5></td>'
   end
 
   def cell_content(str)

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

@@ -1,23 +1,22 @@
-# Helpers to be used to annotate content
-require 'byebug'
+# ContentHelpers is used to annotate content.
 module ContentHelpers
   def include_topic(item_symbol)
-    incorporated_topic = lookup_nitem("topics", item_symbol.to_s)
+    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)
+    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)
+    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)
+    incorporated_topic = lookup_nitem('intro', item_symbol.to_s)
     items[incorporated_topic.identifier.to_s].compiled_content
   end
 
@@ -47,69 +46,85 @@ module ContentHelpers
     " *#{string}*{: style=\"color: red\"} "
   end
 
-  def ir(string); italic_red(string); end
+  def ir(string)
+    italic_red(string)
+  end
 
   def callout_1(title, body)
     <<~HTMLSTRING
-      <div class="well well-sm">
+      <div class="well well-sm callout">
       <span class="themebg label label-primary">#{title}</span>#{body}
       </div>
     HTMLSTRING
   end
 
-  def callout(title, body)
+  def callout_2(title, body)
     <<~HTMLSTRING
-      <div class="border border-primary rounded p-2 m-3">
+      <div class="callout border border-primary rounded p-2 m-3">
       <span class="badge badge-pill badge-primary">#{title}</span>#{body}
       </div>
     HTMLSTRING
   end
 
+  def callout(title, body)
+    %(<div class="jumbotron py-1 border border-primary border-rounded-lg">
+       <h1 class="display-5">#{title}</h1>
+       <p class="lead">#{body}</p></div>)
+  end
+
+  def iconbadge1(icon, tooltip)
+    %(<img src="/bootstrap/bootstrap-icons-1.0.0/#{icon}.svg" title="#{tooltip}" class="iconbadge">)
+  end
+
+  def iconbadge(icon, tooltip)
+    %(<svg class="bi iconbadge" fill="blue"><use xlink:href="/bootstrap/bootstrap-icons-1.0.0/bootstrap-icons.svg##{icon}"/></svg>)
+  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)
+  def iconbadge2(icon, tooltip)
     %(<span class="fas fa-#{icon} themefg" data-toggle="tooltip" data-placement="top" title="#{tooltip}"></span>)
   end
 
   def pdfbadge
-    iconbadge("file-pdf", "Submit as 1 page pdf, include name and homework #")
+    iconbadge('file-earmark-richtext-fill', 'Submit as 1 page pdf, include name and homework #')
   end
 
   def codebadge
-    iconbadge("code", "Work on code in your portfolio")
+    iconbadge('file-code-fill', 'Work on code in your portfolio')
   end
 
   def cloudbadge
-    iconbadge("cloud-upload-alt", "Work on code in your portfolio")
+    iconbadge('cloud-fill', 'Work on code in your portfolio')
   end
 
   def zipbadge
-    iconbadge("briefcase", "Submit work as an attachment")
+    iconbadge('file-earmark-zip-fill', 'Submit work as an attachment')
   end
 
   def partbadge
-    iconbadge("hand-peace", "Graded for participation only - pass/fail")
+    iconbadge('heart-half', 'Graded for participation only - pass/fail')
   end
 
   def timebadge
-    iconbadge("coffee", "Must be submitted first thing on day of class")
+    iconbadge('alarm-fill', 'Must be submitted first thing on day of class')
   end
 
   def teambadge
-    iconbadge("handshake", "Team Deliverable")
+    iconbadge('people-fill', 'Team Deliverable')
   end
 
   def include_image_old(filename_string, extra_class: nil)
-    css_class = "img-responsive"
-    css_class += " img-" + extra_class unless extra_class.nil?
+    css_class = 'img-responsive'
+    css_class += ' img-' + extra_class unless extra_class.nil?
     <<-HTMLSTRING
     <img src="#{filename_string}" class=\"%s\" />" % css_class
     HTMLSTRING
   end
 
-  def include_image(filename_string, extra: "")
+  def include_image(filename_string, extra: '')
     <<~HTMLSTRING
       <div class="row">
         <div class="col-md-offset-2 col-md-8">
@@ -119,13 +134,13 @@ module ContentHelpers
     HTMLSTRING
   end
 
-  def image(filename_string, extra: "")
-    <<-HTMLSTRING
-    <img src="/content/topics/images/#{filename_string}" class="img-responsive img-thumbnail" #{extra}/>
+  def image(filename_string, extra: '')
+    <<~HTMLSTRING
+      <img src="/content/topics/images/#{filename_string}" class="img-responsive img-thumbnail" #{extra}/>
     HTMLSTRING
   end
 
-  def important(string = ":")
+  def important(string = ':')
     <<-HTMLSTRING
     <div class="cg-important">
         #{string}
@@ -133,26 +148,26 @@ module ContentHelpers
     HTMLSTRING
   end
 
-  def nb(string = ":")
+  def nb(string = ':')
     <<-HTMLSTRING
     <div class="label label-info">#{string}</div>
     HTMLSTRING
   end
 
-  def tbd(string = "")
+  def tbd(string = '')
     "*[TO BE DETERMINED#{string}]*{: style=\"color: red\"}"
   end
 
-  def deliverable(string, append = "")
+  def deliverable(string, append = '')
     "*Deliverable:*{: style=\"color: red\"} #{string + append} "
   end
 
   def deliverable_po(string)
-    deliverable(string, " *(graded for participation only)*")
+    deliverable(string, ' *(graded for participation only)*')
   end
 
   def deliverable_popdf(string)
-    deliverable(string, " *(pdf with name and hw number, graded for participation only)*")
+    deliverable(string, ' *(pdf with name and hw number, graded for participation only)*')
   end
 
   def team_deliverable(string)
@@ -168,7 +183,7 @@ module ContentHelpers
   end
 
   def homework_hdr(show_legend: :on)
-    body = "#### Homework due for today"
+    body = '## Homework due for today'
     legend = "\n**Legend**: #{partbadge}: Participation (pass/fail) | #{pdfbadge}: PDF | #{teambadge}: Team | #{zipbadge}:  Attachment"
     body += legend if show_legend == :on
     body
@@ -221,32 +236,31 @@ module ContentHelpers
 
   def carousel_V4(filenames)
     body = <<~HEREDOC
-    <div id="carouselExampleControls" class="carousel slide" data-ride="carousel">
-      <div class="carousel-inner">
+      <div id="carouselExampleControls" class="carousel slide" data-ride="carousel">
+        <div class="carousel-inner">
     HEREDOC
     count = 0
     filenames.each do |fname|
-      active = count == 0 ? "active" : ""
+      active = count == 0 ? 'active' : ''
       body << <<~HEREDOC
-      <div class="carousel-item #{active}">
-        <img class="d-block w-100" src="/content/topics/images/#{fname}">
-      </div>
+        <div class="carousel-item #{active}">
+          <img class="d-block w-100" src="/content/topics/images/#{fname}">
+        </div>
       HEREDOC
       count += 1
     end
     body << <<~HEREDOC
+        </div>
+        <a class="carousel-control-prev" href="#carouselExampleControls" role="button" data-slide="prev">
+        <span class="carousel-control-prev-icon" aria-hidden="true"></span>
+        <span class="sr-only">Previous</span>
+      </a>
+      <a class="carousel-control-next" href="#carouselExampleControls" role="button" data-slide="next">
+        <span class="carousel-control-next-icon" aria-hidden="true"></span>
+        <span class="sr-only">Next</span>
+      </a>
       </div>
-      <a class="carousel-control-prev" href="#carouselExampleControls" role="button" data-slide="prev">
-      <span class="carousel-control-prev-icon" aria-hidden="true"></span>
-      <span class="sr-only">Previous</span>
-    </a>
-    <a class="carousel-control-next" href="#carouselExampleControls" role="button" data-slide="next">
-      <span class="carousel-control-next-icon" aria-hidden="true"></span>
-      <span class="sr-only">Next</span>
-    </a>  
-    </div>
     HEREDOC
-    puts body
     body
   end
 
@@ -275,13 +289,13 @@ module ContentHelpers
   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 include_python(name)
-    filename = Dir.pwd + "/content/content/topics/robotcode/" + name.to_s + ".py"
+    filename = Dir.pwd + '/content/content/topics/robotcode/' + name.to_s + '.py'
     filecontents = File.new(filename).read
     ruby_string filecontents
   end
@@ -290,11 +304,9 @@ module ContentHelpers
     "\n~~~~~~"
   end
 
-  def code_end(lang = "")
+  def code_end(lang = '')
     str = "~~~~~~\n"
-    if ["ruby", "css", "java", "html"].include? lang
-      str += "{: .language-#{lang}}"
-    end
+    str += "{: .language-#{lang}}" if %w[ruby css java html].include? lang
     str
   end
 
@@ -303,61 +315,64 @@ module ContentHelpers
   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
 
   def source_begin(language)
-    "<pre><code class=\"#{language}\">"
+    "<pre class=\"#{language}\">"
   end
 
   def source_end
-    "</code></pre>"
+    '</pre>'
   end
 
-
-  def postit_begin title
-    "<div class=\"postit\">" + "<h5>" + title + "</h5>"
+  def postit_begin(title)
+    '<div class="postit">' + '<h5>' + title + '</h5>'
   end
 
   def postit_end
-    "</div>"
+    '</div>'
   end
 
   def ul_begin
-    "<ul>"
+    '<ul>'
   end
 
   def ul_end
-    "</ul>"
+    '</ul>'
   end
 
-  def ul body
+  def ul(body)
     "<ul>#{body}</ul>"
   end
 
-  def list_items *items
-    items.reduce("") do |s, i|
-      if i.start_with?("<ul>")
+  def slide
+    '<slide_break></slide_break>'
+  end
+
+  def list_items(*items)
+    items.reduce('') do |s, i|
+      if i.start_with?('<ul>')
         s + i
       else
-        s + "<li>" + i + "</li>"
+        s + '<li>' + i + '</li>'
       end
     end
   end
 
   def lab_note(title)
-    "<h5 style=\"font-family:'Permanent Marker'; font-szie:18px; color: red;\">#{title}</h5>"
+    "<h3 style=\"font-family:'Permanent Marker'; font-szie:18px; color: red;\">#{title}</h3>"
   end
 
   def toasty(header, *items)
-    str = %Q(<div class="border border-info rounded w-75 mx-auto p-2 m-3">
+    str = %(<div class="border border-info rounded w-75 mx-auto p-2 m-3">
       <h5>#{header}</h5><ul>)
     items.each do |itm|
-      str += "<li>" + itm + "</li>"
+      str += '<li>' + itm + '</li>'
     end
-    str += "</ul></div>"
+    str += '</ul></div>'
     str
   end
 end