coursegen 0.0.2

data/lib/coursegen/course/lib/scheduler.rb

@@ -0,0 +1,77 @@
+WEEKDAYS = {  sunday: 0,    monday: 1,    tuesday: 2,
+              wednesday: 3, thursday: 4,  friday: 5,  saturday: 6 }
+
+# Calculate days on which each event occurs, based on the configuration info
+class Scheduler
+  def self.add_weeks(the_date, number)
+    the_date.to_date + Integer(number) * 7
+  end
+
+  def setup_from_args(start: nil, weekdays: nil, number: nil, skips: [])
+    if start.nil?
+      @start = nil
+      return
+    end
+    convert_and_verify_arguments(start, weekdays, number, skips)
+    @weekdays.sort!
+    recalc_event_map
+  end
+
+  def setup_from_schedule_def(sdef)
+    if sdef.nil?
+      @start = nil
+      return
+    end
+    setup_from_args(start: sdef.first_day, weekdays: sdef.weekdays,
+                    number: sdef.number, skips: sdef.skips)
+  end
+
+  def event_date_by_index(ind)
+    null? ? nil : @event_dates[ind]
+  end
+
+  def null?
+    @start_date.nil?
+  end
+
+  private
+
+  def recalc_event_map
+    return if self.null?
+    @event_dates = []
+    wkdy_of_start = @start_date.cwday
+    wkday_index = @weekdays.find_index(wkdy_of_start)
+    curr_event_date = @start_date
+    @number.times do
+      |i|
+      @event_dates << curr_event_date unless @skips.include? curr_event_date
+      if @weekdays.length == 1
+        curr_event_date += 7
+      elsif wkday_index < @weekdays.length-1
+        wkday_index += 1
+        curr_event_date += @weekdays[wkday_index] - @weekdays[wkday_index-1]
+      elsif wkday_index == @weekdays.length-1
+        wkday_index = 0 # wrap
+        curr_event_date += 7 + @weekdays.first - @weekdays.last
+      end
+    end
+  end
+
+  def convert_and_verify_arguments(start, weekdays, number, skips)
+    @number = number + skips.length
+    @start_date = string_to_date(start)
+    @skips = skips.map { |d| string_to_date(d) } rescue raise(ArgumentError, "Scheduler: Invalid skip date")
+
+    raise ArgumentError, "Scheduler: invalid weekdays" unless weekdays.all? { |wd| WEEKDAYS.include? wd } 
+
+    @weekdays = weekdays.map { |wd| WEEKDAYS[wd]}
+    raise ArgumentError, "Scheduler: Start date is not on one of the weekdays" unless @weekdays.include? @start_date.cwday
+    raise ArgumentError, "Scheduler: Skip date is not on a valid weekday" if !@skips.reduce(true) { |accum, skip| accum && @weekdays.include?(skip.cwday) }
+  end
+
+private
+
+  def string_to_date(string_date)
+    Date.strptime(string_date, "%b-%d-%Y") rescue binding.pry
+  end
+end

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

@@ -0,0 +1,21 @@
+class SearchIndex
+  attr_reader :index
+  def initialize all_items
+    all_citems = all_items.map { |itm| Toc.instance.n2c(itm) }
+    skiplist = Regexp.union([/\/search_index\/.*/, /\/bootstrap\/.*/, /\/config\/.*/, /\/tipuesearch\/.*/])
+    @index = all_citems.select { |citem| citem.type == "page" && !citem.nitem.binary? && !citem.identifier.match(skiplist)}.map do
+      |item|
+#        puts "indexing: #{item.title}, match: #{item.identifier.match(skiplist) ? "true" : "false"}"
+        nok_parse = Nokogiri::HTML(item.nitem.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.rep_named(:default).path }
+    end
+  end
+
+  def clean_string str
+    str.nil? ? "" : str.gsub(/(\s+|\"|\“|\”)/, " ")
+  end
+end

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

@@ -0,0 +1,74 @@
+require 'forwardable'
+require 'pry'
+
+class Section
+	extend Forwardable
+	attr_reader :section
+	def_delegators :@citems, :[], :count, :each, :sort!, :reduce
+
+	def initialize sect, citems
+		@section = sect
+		@citems = section_filter(citems)
+		sort_pages
+	end
+
+	def find_index(citem)
+		@citems.find_index(citem)
+	end
+
+	def find_by_short_name(sname)
+		matches = @citems.select { |c| sname == c.short_name}
+		binding.pry	if matches.length != 1
+	  raise RuntimeError,"#{sname}: invalid reference in section \"#{@section}\"" if matches.length == 0
+    raise RunimeError, "#{sname}: duplicate referenced in section \"#{@section}\"" if matches.length != 1
+		matches[0]
+	end
+
+	def [](ind)
+		@citems[ind]
+	end
+
+	def next_for(citem)
+		index = @citems.find_index(citem)
+		raise ArgumentError, "invalid citem in next_for" if index.nil?
+		new_index = [index, @citems.length-2].min
+		@citems[new_index+1]
+	end
+
+	def previous_for(citem)
+		index = @citems.find_index(citem)
+		raise ArgumentError, "invalid citem in next_for" if index.nil?
+		new_index = [index, 1].max
+		@citems[new_index-1]
+	end
+
+	def has_subsections?
+		false
+	end
+
+	def has_lecture_numbers?
+		false
+	end
+
+	protected
+
+  def lookup_citem_by_identifier identifier
+    res = @citems.select { |i| i.identifier == identifier }
+    binding.pry if res.length != 1
+    raise RuntimeError, "lookup by identifier failed #{identifier}" if res.length != 1
+    res[0]
+  end
+
+
+	def section_filter citems
+		filtered_citems = citems.map do 
+			|citem|
+  		citem.section == @section && !citem.hidden? ? citem : nil
+  	end
+  	filtered_citems.compact
+  end
+
+	def sort_pages
+		@citems.sort! { |a,b| a.order <=> b.order } rescue binding.pry
+	end
+end

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

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

data/lib/coursegen/course/lib/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)
+      elsif sect.options[:type] == :section
+        @sections[selector] = Section.new(selector, items)
+      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/templates.rb

@@ -0,0 +1,54 @@
+require 'pry'
+
+module CourseGen
+  class Templates < Thor::Group
+    include Thor::Actions
+
+    def generate_all
+      copy_template_dir("layouts", "layouts")
+      copy_template_dir("content/bootstrap", "content/bootstrap")
+      copy_template_dir("content/content", "content/content")
+      delete_target_file("lib/default.rb")
+      copy_template_dir("lib", "lib")
+      delete_target_file("Rules")
+      copy_template_file("Rules", "Rules")
+      copy_template_file("cg_config.rb", "cg_config.rb")
+      copy_template_file("cg_config.rb_sample", "cg_config.rb_sample")
+      delete_target_file("content/stylesheet.css")
+      delete_target_file("content/index.html")
+    end
+
+    def valid_cg_directory?
+      valid = true
+      list = ["Rules", "nanoc.yaml", "content", "lib"]
+      list.each do |filename|
+        if !File.exists?(filename)
+          valid = false
+          say("Required file not found: #{filename}")
+        end
+      end
+      valid
+    end
+
+    def self.source_root
+      Pathname.new(File.dirname(__FILE__)).parent.parent.to_s
+    end
+
+    def initialize
+      super
+      destination_root = Dir.getwd
+    end
+
+    def copy_template_dir from, to
+      directory("templates/#{from}", "#{to}")
+    end
+
+    def copy_template_file from, to
+      template("templates/#{from}", "#{to}")
+    end
+
+    def delete_target_file(to)
+      remove_file(to)
+    end
+  end
+end

data/lib/coursegen/version.rb

@@ -0,0 +1,3 @@
+module Coursegen
+  VERSION = "0.0.2"
+end

data/lib/coursegen.rb

@@ -0,0 +1,23 @@
+require 'nanoc/toolbox'
+require 'pry'
+require 'nokogiri'
+
+require "coursegen/version"
+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/navigation_helpers"
+require 'coursegen/course/lib/section'
+require "coursegen/course/lib/toc"
+require 'coursegen/course/lib/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/lib/search_data_generator'
+
+module Coursegen
+  # Your code goes here...
+end

data/templates/Rules

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+# A few helpful tips about the Rules file:
+#
+# * The string given to #compile and #route are matching patterns for
+#   identifiers--not for paths. Therefore, you can’t match on extension.
+#
+# * The order of rules is important: for each item, only the first matching
+#   rule is applied.
+#
+# * Item identifiers start and end with a slash (e.g. “/about/” for the file
+#   “content/about.html”). To select all children, grandchildren, … of an
+#   item, use the pattern “/about/*/”; “/about/*” will also select the parent,
+#   because “*” matches zero or more characters.
+
+require 'pry'
+require './cg_config.rb'
+
+preprocess do
+  Toc.instance.prepare @items, SECTION_CONFIG
+end
+
+compile '/bootstrap/*' do
+  nil
+end
+
+compile '/tipuesearch/*' do
+  nil
+end
+
+compile '/content/scripts/*' do
+  nil
+end
+
+compile "/search_index/tipuesearch_content/" do
+  filter :erb
+end
+
+compile '*' do
+  if item.binary? || item[:status] == "hidden"
+    nil
+  elsif item[:status] == "hidden"
+    nil
+  elsif item[:type] == "subsection"
+    nil    
+  elsif item[:extension] == "haml"
+    filter :haml;
+    layout 'course'
+  else
+    item[:extension].split('.').reverse.each do
+      |f|
+      case f
+      when 'md', 'markdown'
+        filter :kramdown, coderay_tab_width: 3
+      when 'erb'
+        filter :erb
+      end
+    end
+    layout 'course'
+  end
+end
+
+route '/bootstrap/*' do
+  @item.identifier.chop + '.' + @item[:extension]
+end
+
+route '/tipuesearch/*' do
+  @item.identifier.chop + '.' + @item[:extension]
+end  
+
+route '/content/' do
+  '/index.html'
+end
+
+route "/search_index/tipuesearch_content/" do
+  '/tipuesearch/js/tipuesearch_content.js'
+end
+
+route '*' do
+  if item[:extension].nil?
+    raise RuntimeError, "Missing required extension: \".#{item.identifier}\""
+  elsif item.binary?
+    # Write item with identifier /foo/ to /foo.ext
+    item.identifier.chop + '.' + item[:extension] rescue binding.pry
+  elsif item.identifier == "/search_index/tipuesearch_content/"
+      item.identifier.chop + '.' + item[:extension] rescue binding.pry
+  elsif item[:status] == "hidden"
+    nil
+  elsif item[:type] == "subsection"
+    nil
+  elsif item[:extension] != "css"
+    # Write item with identifier /foo/ to /foo/index.html
+    item.identifier + 'index.html'
+  end
+end
+
+layout '*', :erb
+

data/templates/cg_config.rb

@@ -0,0 +1,12 @@
+# Copyright string
+COPYRIGHT_STRING = "Copyright (2013-2014) R. Pito Salas, pitosalas@gmail.com"
+
+# Course short name
+COURSE_SHORT_NAME = "Cosi 000"
+COURSE_LONG_NAME = "Not a course"
+
+# Sections in the right hand margin of the page
+SECTION_CONFIG = [
+    SectionDef.new("Background", "background", type: :section)
+]
+

data/templates/cg_config.rb_sample

@@ -0,0 +1,46 @@
+require './lib/schedule_def.rb'
+require './lib/section_def.rb'
+
+# URL for AWS Deployment of the course
+AWS_BUCKET = "cosi236b.courses.salas.com"
+
+# Local directory path for directory of topics
+TOPICS_PATH = "/mydev/curriculous-topics"
+
+# Local directory path for directory of content
+CONTENT_PATH = "/mydev/cosi236b"
+
+# Copyright string
+COPYRIGHT_STRING = "Copyright (2013-2014) R. Pito Salas, pitosalas@gmail.com"
+
+# Course short name
+COURSE_SHORT_NAME = "COSI 236B"
+COURSE_LONG_NAME = "Software Engineering"
+
+# Schedule information. Note that Monday is day 0
+LECTURES_SCHEDULE_CONFIG = ScheduleDef.new(
+		first_day: "jan-14-2014", 
+		weekdays: [:tuesday, :friday],
+		number: 26,
+		skips: ["feb-18-2014", "feb-21-2014", "apr-15-2014", "apr-18-2014", "apr-22-2014"])
+
+LABS_SCHEDULE_CONFIG = ScheduleDef.new(
+		first_day: "jan-16-2014", 
+		weekdays: [:thursday],
+		number: 13,
+		skips: ["feb-20-2014", "apr-17-2014"])
+
+# Sections in the right hand margin of the page
+SECTION_CONFIG = [
+		SectionDef.new("Lectures", "lectures", type: :lecture, schedule: LECTURES_SCHEDULE_CONFIG),
+		SectionDef.new("Labs", "lab", type: :lecture, schedule: LABS_SCHEDULE_CONFIG),
+		SectionDef.new("Incubator", "incubator", type: :section),
+		SectionDef.new("PA", "pa", type: :section),
+		SectionDef.new("Crib Sheets", "cribsheets", type: :section),
+		SectionDef.new("Background", "background", type: :section),
+		SectionDef.new("Root", "root", hidden: true, type: :section),
+		SectionDef.new("Topics", "topics", hidden: true, type: :section),
+		SectionDef.new("Search", "search_results", hidden: true, type: :section)
+]
+
+