coursegen 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63fa8b9bda73769816f40b252c9087e4cffb48d1
+  data.tar.gz: 2c6fcbeffc45abacf2424a8db896d250dade7ade
+SHA512:
+  metadata.gz: 5e8bfe6a515ea7bb22404c7bb2a0650b98e180bcf9f0e3f0f67b72db5d05ddac1f59a59b3c0c2c1394d4a06fce80e453e7d85af1d4f18bbeca4c010da0cef162
+  data.tar.gz: d9d5066535c85ea6544aca09e66636e5edd8b5e4c8a6c3eeb0b625e9b130c3ac3635d7052d9ad1dd9947df1caa38dbae28dba5df1c3c5d45d1a3f4884b4c87e4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coursegen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pito Salas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Coursegen
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'coursegen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coursegen
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/coursegen/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/cg

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'coursegen/cli'
+
+CourseGen::CLI.start

data/coursegen.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coursegen/version'
+
+Gem::Specification.new do |spec|
+  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.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  puts spec.executables
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "nanoc"
+  spec.add_dependency "thor"
+  spec.add_dependency "nanoc-toolbox"
+
+end

data/lib/coursegen/cli.rb

@@ -0,0 +1,49 @@
+require 'thor'
+require "coursegen/templates"
+
+module CourseGen
+  class CLI < Thor
+    include Thor::Actions
+
+    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."
+    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"
+    def compile
+      run("nanoc compile")
+    end
+
+    desc "serve", "start local web server to test the course web site"
+    def serve
+      run("nanoc view")
+    end
+
+    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"
+    end
+
+    desc "view", "view course site locally in browser"
+    def view
+      run "open http://0.0.0.0:3000"
+    end
+
+    no_commands do
+      def check_valid_directory
+        CourseGen::Templates.new.valid_cg_directory? ? 
+          say("Valid cg directory") :
+          error("Invalid cg directory")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+module ContentHelpers
+  def generate_detailed_schedule section
+#        binding.pry
+  end
+
+  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].compiled_content
+  end
+
+  def lookup_nitem the_sect, short_name
+      Toc.instance.lookup_citem(the_sect, short_name).nitem
+  end
+
+  def link_to_doc label, file_name
+      "<a href=\"/docs/#{file_name}\">#{label}</a>"
+  end
+
+  def toc_link_to item
+      link_to_unless_current item[:title], item
+  end
+
+  def bold_red string
+      "<span style=\"color: red; font-style: italic;\">\#{string}</span>"
+  end
+
+  def italic_red string
+      " *#{string}*{: style=\"color: red\"} "
+  end
+
+  def ir string; italic_red(string); end
+
+  def include_image_old string, extra_class: nil
+    css_class = "img-responsive"
+    css_class += " img-"+extra_class unless extra_class.nil?
+
+    "<img src=\"/content/images/#{string}\" class=\"%s\" />"  % css_class
+  end
+
+  def include_image filename_string, width: 8
+  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" />
+  </div>
+</div>
+  HTMLSTRING
+  end
+
+  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 deliverable string
+      "*Deliverable:*{: style=\"color: red\"} *#{string}*"
+  end
+
+  def team_deliverable string
+      "*Team Deliverable:*{: style=\"color: red\"} *#{string}*"
+  end
+
+  def discussion string
+      "*Discussion:*{: style=\"color: blue\"} *#{string}*"
+  end
+
+  def homework_hdr
+    "#### Homework due for today"
+  end
+
+  def carousel(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 << "/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>
+                <a class="right carousel-control" href="#myCarousel" data-slide="next">›</a>
+            </div>~
+    body
+  end
+
+  def ruby_begin
+      "\n~~~~~~"
+  end
+
+  def ruby_end
+      "~~~~~~\n {: .language-ruby}"
+  end
+
+  def ruby_string (str)
+      ruby_begin + "\n" +  str + "\n" + ruby_end
+  end
+
+  def include_ruby name
+      filename = "content/content/scripts/#{name.to_s}.rb"
+      filecontents = File.new(filename).read
+      ruby_string filecontents
+  end
+
+  def code_begin
+      "\n~~~~~~"
+  end
+
+  def code_end
+      "~~~~~~\n"
+  end
+
+  def code_string (str)
+    code_begin + "\n" + str + code_end
+  end
+
+  def include_code name
+    filename = "content/content/scripts/#{name.to_s}"
+    filecontents = File.new(filename).read
+    code_string filecontents
+  end
+
+
+
+end

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

@@ -0,0 +1,9 @@
+module LectureHelpers
+  def lecture_number_str citem
+    citem.lecture_number.to_s
+  end
+
+  def lecture_date
+    "-ddd-"
+  end
+end

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

@@ -0,0 +1,14 @@
+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 compiling item
+		#puts "* compiling #{item[:title]}"
+	end
+end

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

@@ -0,0 +1,64 @@
+module NavigationHelpers
+
+  def link_to_lecture item_symbol
+    link_to_section :lectures, item_symbol
+  end
+
+  def link_to_topic item_symbol
+    link_to_section :topics, item_symbol
+  end
+
+  def link_to_background item_symbol
+    link_to_section :background, item_symbol
+  end
+
+  def link_to_cribsheet item_symbol
+    link_to_section :cribsheets, item_symbol
+  end
+
+  def link_to_intro item_symbol
+    link_to_section :intro, item_symbol
+  end
+
+  def link_to_incubator item_symbol
+    link_to_section :incubator, item_symbol
+  end
+
+  def link_to_lab item_symbol
+    link_to_section :lab, item_symbol
+  end
+
+ 	def link_to_pa item_symbol
+    link_to_section :pa, 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)
+	end
+
+	def link_to_next toc, item
+		nav_markup "", toc.find_next_forn(item).nitem.path, "glyphicon glyphicon-chevron-right", "next page"
+	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_inclusion item
+		inclusion = Toc.instance.lookup_inclusion(item)
+		if inclusion.nil?
+			"(never included)"
+		else
+			" (#{inclusion.identifier})"
+		end
+	end
+
+	private
+
+	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
+
+end

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

@@ -0,0 +1,63 @@
+module SidebarHelpers
+  def section_helper title:nil, selector:nil
+    sect = Toc.instance.section(selector)
+    str = "<li>
+            <label class=\"tree-toggler level1\">
+              #{collapsed_indicator(sect[0].collapsed)}
+              #{title}
+            </label>"
+    if sect.has_subsections?
+      str += nested_section(sect)
+    else
+      str += flat_section(sect)
+    end
+    str += "</li>"
+  end
+
+  def nested_section sect
+    sect.subsections.reduce("") {|acc, subs| acc + subsection_body(subs)}
+  end
+
+  def subsection_body sect
+    "<ul class=\"tree\">
+      <li>
+        <label class=\"tree-toggler level2\">
+          #{collapsed_indicator(sect.content.collapsed)} 
+          #{sect.content.title}
+        </label>
+        #{subsection(sect, sect.content.collapsed)}
+      </li>
+    </ul>"
+  end
+
+  def collapsed_indicator(coll)
+    icon_markup(coll ? :plus : :minus)
+  end
+
+  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>"
+  end
+
+  def subsection_item_link tree_node
+   "<li class=\"#{tree_node.content.css_class}\"><a href=\"#{tree_node.content.path}\">#{tree_node.content.title}</a></li>"
+  end
+
+  def flat_section sect
+    disp_clause = sect[0].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>" 
+  end
+
+  def flat_section_item_link citem
+    "<li class=\"#{citem.css_class}\"><a href=\"#{citem.path}\">#{citem.title}</a></li>"
+  end
+
+  def icon_markup icon_type
+    css_class = {star: "glyphicon-star", plus: "glyphicon-plus-sign", minus: "glyphicon-minus-sign"}.fetch(icon_type)
+    "<span class=\"glyphicon #{css_class} glyphicon-small \"></span>"
+  end
+end

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

@@ -0,0 +1,88 @@
+require 'active_support/inflector'
+
+#
+# Curriculu Item decorates Nanoc Item
+#
+class CItem
+
+  attr_reader :order, :section, :subsection, :subsection_citem, :title,
+              :type, :identifier, :short_name, :status, :nitem, :css_class, :collapsed
+  attr_accessor :lecture_number, :lecture_date
+
+  # Callable with nitem=nil to create a mock
+  def initialize nitem=nil, ident=nil, type=nil, order=nil
+    if nitem != nil
+      raise ArgumentError, "invalid CItem contruction" unless ident.nil?
+      @nitem = nitem
+      defaults_from_nitem @nitem
+      parse_identifier @nitem.identifier
+    else
+      raise ArgumentError, "invalid CItem contruction" unless nitem.nil?
+      @nitem = nil
+      @status = nil
+      @type = type
+      @identifier = ident
+      @order = order
+      @title = ident
+      @style = nil
+      @collapsed = nil
+      parse_identifier ident
+    end
+  end
+
+  def hidden?
+    if @nitem.nil?
+      false
+    else
+      @nitem[:status] == 'hidden' || %w(css min.css js png).include?(@nitem[:extension])
+    end
+  end
+
+  def path
+    @nitem.path
+  end
+
+  def is_lecture?
+    !@lecture_date.nil?
+  end
+
+  def lecture_date_s
+    @lecture_date.strftime('%a %b %-d') unless @lecture_date.nil?
+  end
+
+  def lecture_number_s
+    "#{@section.singularize} #{@lecture_number.to_s}"
+  end
+
+  private
+
+  def defaults_from_nitem(nitem)
+    @type = @nitem[:type] || 'page'
+    fail ArgumentError, 'Invalid page type' unless ["page", "subsection"].include? @type
+
+    @subsection = nil
+    @status = @nitem[:status]
+    @order = @nitem[:order].to_i unless @nitem[:order].nil?
+    @identifier = @nitem.identifier
+    @section = @nitem[:section]
+    @title = @nitem[:title]
+    @css_class = @nitem[:css_class]
+    @collapsed = @nitem[:collapsed].nil? ? true : @nitem[:collapsed]
+  end
+
+  def parse_identifier ident
+    parts = ident.split("/")
+    @section ||= parts[2] 
+    parsed_title = parts[-1].match(/^((\d*)_)?([^\/]*)$/)
+    raise RuntimeError, "Invalid item title" if parsed_title.nil?
+
+    @order ||= parsed_title[2].to_i
+    @short_name = parsed_title[3]
+    @title ||= short_name
+    if @type == "subsection"
+      @subsection = "/#{parts[1..-1].join('/')}/"
+    elsif @type == "page"
+      @subsection = "/#{parts[1..-2].join('/')}/"
+    end 
+  end
+end

data/lib/coursegen/course/lib/helpers_.rb

@@ -0,0 +1,9 @@
+include LoggingHelpers
+include ContentHelpers
+include NavigationHelpers
+include LectureHelpers
+include SidebarHelpers
+include Nanoc::Helpers::Rendering
+include Nanoc::Helpers::LinkTo
+include Nanoc::Toolbox::Helpers::Navigation
+include Nanoc::Helpers::Tagging

data/lib/coursegen/course/lib/lectures.rb

@@ -0,0 +1,91 @@
+require 'tree'
+
+class Lectures < Section
+	def initialize sect, citems, schedule=nil
+		super sect, citems
+		@schedule = schedule || ::Scheduler.new
+		@citems = sort_items
+		build_tree
+	end
+
+	def has_subsections?
+		true
+	end
+
+	def has_lecture_numbers?
+		true
+	end
+
+	def build_tree
+		lecture_num = 1
+		@root = Tree::TreeNode.new("root", "root")
+		@citems.each do |i|
+			i.lecture_number = lecture_num
+			i.lecture_date = @schedule.event_date_by_index(lecture_num - 1) # Lecture numbers are base 1
+			if i.type == "subsection"
+				@root.add(Tree::TreeNode.new(i.subsection, i)) rescue binding.pry
+			elsif i.type == "page"
+				parent_tree_node = parent_node_of(i)
+				parent_tree_node.add(Tree::TreeNode.new(i.identifier, i)) rescue binding.pry
+				lecture_num += 1
+			else
+				raise ArgumentError, "invalid lecture page type of #{i.type}for #{i.title}"
+			end
+		end
+	end
+
+	def parent_node_of citem
+		parent_node = @root[citem.subsection]
+#		binding.pry if parent_node.nil?
+		raise  RuntimeError, "Cant find section for item: #{citem.identifier}" if parent_node.nil?
+		parent_node
+	end
+
+	def treenode_of citem
+		@root.find do 
+			|tree_node| 
+				if citem.type == "subsection"
+					citem.subsection == tree_node.name
+				else 
+					citem.identifier == tree_node.name
+				end
+		end
+	end
+
+	def subsections
+		@root.children
+	end
+
+	def next_for(citem)
+		next_node = treenode_of(citem).next_sibling rescue binding.pry
+		if !next_node.nil?
+			next_node.content
+		else
+			citem
+		end
+	end
+
+	def previous_for(citem)
+		prev_node = treenode_of(citem).previous_sibling
+		if !prev_node.nil?
+			prev_node.content
+		else
+			citem
+		end
+	end
+
+	# def citem_lecture_number citem
+	# 	citem.lecture_number
+	# end
+
+protected
+
+	# def sort_items
+	# 	@citems.sort_by { |i| [ i.type == "subsection" ? "A" : "B", i.order ] }
+	# end
+
+	def sort_items
+		@citems.sort_by! { |i| [ lookup_citem_by_identifier(i.subsection).order, ((i.type == "page" ? 100 : 1 ) * i.order) ] }
+	end
+
+end

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

@@ -0,0 +1,13 @@
+# Define schedule scheme for a lecture series
+
+class ScheduleDef
+		attr_reader :first_day, :weekdays, :number, :skips
+
+		def initialize first_day: nil, weekdays: nil, number: nil, skips: []
+			@first_day = first_day
+			@weekdays = weekdays
+			@number = number
+			@skips = skips
+		end
+
+end