coursegen 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 641c6b409ee8a797f79248602e2addc7b025ef63
-  data.tar.gz: 1088e150d540207edb0e717c2b8319841bb0ec75
+  metadata.gz: 4f6fafa449aaa1c612bd2ceee93620309658a577
+  data.tar.gz: 3944ddf885fdc20f3981aafc64f5eda9e5f68fa8
 SHA512:
-  metadata.gz: 5e8731511aa5626696c28882bffe886de272b5f2b1c1061c53bda28f24c3134dc3b4b35ca1e714e05214ee92e059fb91439b83c15ed8f3485ba7ded02af01a8c
-  data.tar.gz: f94af8c16f907a600feb17cc5fffd514d47cea493100b6f54fa4bc14c250452acad148e5eacd874b1f75b66281adb4dccd36cafdeaca6d07dc1e1dc847bbdd65
+  metadata.gz: a51af70545c7dad4360845bc63c04fe211c2742988cb2295d8ac4ca2fe8daba44ff383df733e582bb2d44ded1d760937c68fc0816abae5a2938dbc70cfa958a4
+  data.tar.gz: 885fbdf8a783e77379114d906b573a4a2761e6896b69f127877000a9e8a00cb4783b2ddb586bb44fa96a2cea32ef430473f39a444f3a6788474364d04979d3c1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.idea/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coursegen (0.0.1)
+    coursegen (0.0.5)
       nanoc
       thor
 
@@ -9,9 +9,9 @@ GEM
   remote: https://rubygems.org/
   specs:
     colored (1.2)
-    cri (2.6.0)
+    cri (2.6.1)
       colored (~> 1.2)
-    nanoc (3.6.11)
+    nanoc (3.7.1)
       cri (~> 2.3)
     rake (10.3.2)
     thor (0.19.1)

data/coursegen.gemspec

@@ -22,8 +22,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 
-  spec.add_dependency "nanoc"
+
+  spec.add_dependency "nanoc", "~>3.6.11"
   spec.add_dependency "thor"
-  spec.add_dependency "nanoc-toolbox"
+  spec.add_dependency "rubytree"
+  spec.add_dependency "cri"
+  spec.add_dependency "pry"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "activesupport"
 
 end

data/lib/coursegen.rb

@@ -1,5 +1,3 @@
-require 'nanoc/toolbox'
-require 'pry'
 require 'nokogiri'
 
 require "coursegen/version"
@@ -7,16 +5,21 @@ require "coursegen/course/helpers/sidebar_helpers"
 require "coursegen/course/helpers/lecture_helpers"
 require "coursegen/course/helpers/content_helpers"
 require "coursegen/course/helpers/logging_helpers"
+require "coursegen/course/helpers/list_of_helpers"
+require 'coursegen/course/helpers/bootstrap_markup'
 require "coursegen/course/helpers/navigation_helpers"
-require 'coursegen/course/lib/section'
-require "coursegen/course/lib/toc"
-require 'coursegen/course/lib/citem'
+require "coursegen/course/data/section"
+require "coursegen/course/data/toc"
+require 'coursegen/course/data/citem'
 require 'coursegen/course/lib/helpers_'
-require 'coursegen/course/lib/schedule_def'
-require 'coursegen/course/lib/section_def'
-require 'coursegen/course/lib/scheduler'
-require 'coursegen/course/lib/lectures'
+require 'coursegen/course/schedule/schedule_def'
+require 'coursegen/course/data/section_def'
+require 'coursegen/course/schedule/scheduler'
+require 'coursegen/course/data/lectures'
 require 'coursegen/course/lib/search_data_generator'
+require 'coursegen/course/data/data_adaptor'
+require 'coursegen/course/helpers/list_of'
+
 
 module Coursegen
   # Your code goes here...

data/lib/coursegen/cli.rb

@@ -1,6 +1,7 @@
 require 'thor'
 require 'coursegen/templates'
-require './cg_config.rb'
+require 'nanoc'
+require './cg_config.rb' if File.exists? 'cg_config.rb'
 
 module CourseGen
   class CLI < Thor

data/lib/coursegen/course/{lib → data}/citem.rb

@@ -6,7 +6,7 @@ require 'active_support/inflector'
 class CItem
 
   attr_reader :order, :section, :subsection, :subsection_citem, :title,
-              :type, :identifier, :short_name, :status, :nitem, :css_class
+              :type, :identifier, :short_name, :status, :nitem, :css_class, :homework, :desc
   attr_accessor :lecture_number, :lecture_date
 
   # Callable with nitem=nil to create a mock
@@ -25,7 +25,7 @@ class CItem
       @order = order
       @title = ident
       @style = nil
-      parse_identifier ident
+      parse_identifier(ident)
     end
   end
 
@@ -70,6 +70,8 @@ class CItem
     @section = @nitem[:section]
     @title = @nitem[:title]
     @css_class = @nitem[:css_class]
+    @homework = @nitem[:homework]
+    @desc = @nitem[:desc]
   end
 
   def parse_identifier ident

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

@@ -0,0 +1,37 @@
+class DataAdaptor
+  def initialize(source)
+    @section = Toc.instance.section(source)
+  end
+
+  # column_selector is one of: :number, :date, :title, :homework
+  COL_NAMES = { number: "#", date: "lecture date", title: "title", homework: "homework", desc: "description"}
+
+  def column_name(column_selector)
+    COL_NAMES[column_selector]
+  end
+
+  def rows
+    @section.each do |citem|
+      yield citem
+    end
+  end
+
+  def cell_value(citem, col_selector)
+    case col_selector
+    when :number
+      citem.lecture_number
+    when :date
+      citem.lecture_date
+    when :title
+      citem.title
+    when :url
+      citem.identifier
+    when :desc
+      citem.desc
+    when :homework
+      citem.homework
+    else
+      "error!"
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+require 'singleton'
+class Toc
+
+  include Enumerable
+  include Singleton
+
+  def prepare items, config
+    raise "Toc.prepare called twice!" unless @sections.nil?
+    @section_config = config
+    build_mapping_table items
+    build_citem_table
+    build_sections @citems
+    @info = {}
+  end
+
+  def build_sections items
+    @sections = {}
+    @section_config.each do 
+      |sect|
+      selector = sect.selector.to_s
+      if sect.options[:type] == :lecture
+        schedule = Scheduler.new
+        schedule.setup_from_schedule_def(sect.options[:schedule])
+        @sections[selector] = Lectures.new(selector, items, schedule, sect.options[:collapsed])
+      elsif sect.options[:type] == :section
+        @sections[selector] = Section.new(selector, items, sect.options[:collapsed])
+      else
+        raise ArgumentError.new("Invalid section option")
+      end
+    end
+  end
+
+  def build_mapping_table items
+    @map_n2c = {}
+    items.each do
+      |nitem|
+      citem = CItem.new(nitem)
+      @map_n2c[nitem] = citem
+    end
+  end
+
+  def build_citem_table
+    @citems = @map_n2c.map { |k, v| v}
+  end
+
+  def n2c nitem
+    @map_n2c[nitem]
+  end
+
+  def lookup_citem the_sect, item_short_name
+    section(the_sect).find_by_short_name(item_short_name)
+  end
+
+  def reset
+    @sections = nil
+  end
+
+  def section selector
+    section = @sections[selector]
+    raise RuntimeError, "Invalid Section: #{selector}" if section.nil?
+    section
+  end
+
+
+  def find_next_forn(nitem)
+    p = find_next_for(n2c(nitem)) 
+    binding.pry if p.nil?
+    p
+  end
+
+  def find_previous_forn(nitem)
+    p = find_previous_for(n2c(nitem))
+    binding.pry if p.nil?
+    p
+  end
+
+  def find_next_for(citem)
+    section(citem.section).next_for(citem)
+  end
+
+  def find_previous_for(citem)
+    section(citem.section).previous_for(citem)
+  end
+
+  # def section_for nitem
+  #   sec = @sections[n2c(nitem).section]
+  #   binding.pry if sec.nil?
+  #   sec
+  # end
+
+  def citem_section citem
+    @sections[citem.section]
+  end
+
+   def record_inclusion host_item, included_item
+    @info[included_item.identifier] = host_item
+  end
+
+  private
+
+  def subsections(section, &block)
+    items = sort_section_by_subsection_name section
+    item_iterator = items.chunk do |item|
+      subsection_name section.to_s, item.identifier
+    end
+    item_iterator.each do |subsection_item|
+      block.call(subsection_item)
+    end
+  end
+
+
+
+  def index_in_section item
+    section_for(item).find_index(item)
+  end
+
+  def each_by(section_selector, &block)
+    sub_toc = @sections[section_selector]
+    sub_toc.sort! { |a,b| a[:order] <=> b[:order] }.each do |member|
+      block.call(member)
+    end
+  end
+
+  def sort_section_by_order sect
+      @sections[sect].sort! { |a,b| a[:order] <=> b[:order] }
+  end
+
+  def sort_section_by_subsection_name(sect)
+    items = @sections[sect]
+    items.sort! do
+      |item1, item2|
+      subsection_name(sect.to_s, item1.identifier) <=> subsection_name(sect.to_s, item2.identifier)
+    end
+    items
+  end
+
+  def subsection_name section_name, item_name
+    item_matcher = item_name.match('\A/'+section_name+'/([^/]*)/([^/]*)/\z')
+    if !item_matcher.nil?
+      item_matcher[1]
+    else
+      ""
+    end
+  end
+
+  def lookup_inclusion included_item
+    @info[included_item.identifier]
+  end
+
+  def lookup_by_index section, index
+    sect = section.section
+    if index >= @sections[sect].count
+      index = @sections[sect].count-1
+    elsif index < 0
+      index = 0
+    end
+    @sections[sect][index]
+  end
+
+end

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

@@ -0,0 +1,64 @@
+class BootstrapMarkup
+  def initialize
+    @str = ""
+  end
+  def table_begin
+    @str << "<table class=\"table table-condensed\">"
+  end
+
+  def table_end
+    @str << "</table>"
+  end
+
+  def headers_begin
+    @str << "<thead><tr>"
+  end
+
+  def headers_end
+    @str << "</tr></thead>"
+  end
+
+  def header_begin
+    @str << "<th>"
+  end
+
+  def header_end
+    @str << "</th>"
+  end
+
+  def header_content(str)
+    @str << str
+  end
+
+  def row_begin
+    @str << "<tr>"
+  end
+
+  def row_end
+    @str << "</tr>"
+  end
+
+  def cell_begin
+    @str << "<td>"
+  end
+
+  def cell_end
+    @str << "</td>"
+  end
+
+  def bigcell_begin
+    @str << "<td colspan=\"3\"><h5>"
+  end
+
+  def bigcell_end
+    @str << "</h5></td>"
+  end
+
+  def cell_content(str)
+    @str << str
+  end
+
+  def render
+    @str
+  end
+end

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

@@ -1,7 +1,4 @@
 module ContentHelpers
-  def generate_detailed_schedule section
-#        binding.pry
-  end
 
   def include_topic item_symbol
       incorporated_topic = lookup_nitem("topics", item_symbol.to_s)
@@ -22,7 +19,7 @@ module ContentHelpers
   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
@@ -31,6 +28,14 @@ module ContentHelpers
 
   def ir string; italic_red(string); end
 
+  def callout title, body, format=nil
+    template_string = <<-HTMLSTRING
+<div class="well well-sm">
+<span class="label label-primary">#{title}</span>#{body}
+</div>
+HTMLSTRING
+  end
+
   def include_image_old string, extra_class: nil
     css_class = "img-responsive"
     css_class += " img-"+extra_class unless extra_class.nil?
@@ -42,7 +47,7 @@ module ContentHelpers
   template_string = <<-HTMLSTRING
 <div class="row">
   <div class="col-md-offset-2 col-md-#{width}">
-    <img src="/content/images/#{filename_string}" class="img-responsive img-thumbnail" />
+    <img src="../#{filename_string}" class="img-responsive img-thumbnail" />
   </div>
 </div>
   HTMLSTRING

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

@@ -0,0 +1,89 @@
+class ListOf
+
+  # 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
+
+  def initialize(markup_adaptor, data_adaptor, rows, cols)
+    @mark = markup_adaptor
+    @rows = rows
+    @cols = cols
+    @data = data_adaptor
+  end
+
+  def render
+    @mark.table_begin
+    generate_headers
+    generate_rows
+    @mark.table_end
+    @mark.render
+  end
+
+  private
+
+  def generate_headers
+    @mark.headers_begin
+
+    @cols.each do |col|
+      @mark.header_begin
+      @mark.header_content(@data.column_name(col))
+      @mark.header_end
+    end
+
+    @mark.headers_end
+  end
+
+  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
+        generate_detail_row(row_id)
+      end
+    end
+  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
+  end
+
+  def generate_summary_row(row_id)
+    @mark.row_begin
+    @mark.bigcell_begin
+    @mark.cell_content(cell_content_string(row_id, :title, detail: false))
+    @mark.bigcell_end
+    @mark.row_end
+  end
+
+  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)
+    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
+  end
+
+  def include_row?(row_id)
+    @rows.include?(row_id.type)
+  end
+
+  def subsection_hdr?(row_id)
+    row_id.type == "subsection"
+  end
+
+end