coursegen 0.1.3 → 0.3.1

data/lib/coursegen/templates.rb

@@ -13,6 +13,8 @@ module CourseGen
       copy_template_dir("lib", "lib")
       delete_target_file("Rules")
       copy_template_file("Rules", "Rules")
+      copy_template_file("Guardfile", "Guardfile")
+      copy_template_file(".gitignore", ".gitignore")
       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")

data/lib/coursegen/version.rb

@@ -1,3 +1,3 @@
 module Coursegen
-  VERSION = "0.1.3"
+  VERSION = "0.3.1"
 end

data/lib/coursegen.rb

@@ -12,15 +12,17 @@ require "coursegen/course/helpers/navigation_helpers"
 require "coursegen/course/data/section"
 require "coursegen/course/data/toc"
 require 'coursegen/course/data/citem'
-require 'coursegen/course/lib/helpers_'
 require 'coursegen/course/schedule/schedule_def'
 require 'coursegen/course/data/section_def'
 require 'coursegen/course/schedule/scheduler'
+require 'coursegen/course/schedule/schedule_feed'
 require 'coursegen/course/data/lectures'
 require 'coursegen/course/lib/search_data_generator'
 require 'coursegen/course/data/data_adaptor'
+require 'coursegen/course/lib/ical_adaptor'
 require 'coursegen/course/helpers/list_of'
-
+require 'coursegen/course/helpers/ical_feed_helpers'
+require 'coursegen/course/lib/helpers_'
 
 module Coursegen
   # Your code goes here...

data/spec/citem_spec.rb

@@ -1,5 +1,4 @@
 require_relative "./spec_helper.rb"
-require 'pry'
 
 class NIMock
   attr_reader :identifier
@@ -29,6 +28,8 @@ describe "null Case" do
   it "works as expected" do
     expect(@ci.title).to eq("db_design")
     expect(@ci.section).to eq("lectures")
+    expect(@ci.short_name).to eq("db_design")
+    expect(@ci.subsection).to eq("/content/lectures/iter4/")
     expect(@ci.order).to eq(7)
   end
 end
@@ -39,7 +40,7 @@ describe "more complicated cases" do
     ['/content/intro/term_overview/', 7, "intro", "term_overview", "intro", 7, "/content/intro/"],
     ['/content/intro/001_term_overview/', nil, "intro", "term_overview", "intro", 1, "/content/intro/"],
     ['/content/lectures/iter2/02_db_design/', 7, "lectures", "db_design", "lectures", 7, "/content/lectures/iter2/"],
-    ['/content/', 7, "lectures", "content", "lectures", 7, "//"],   
+    ['/content/', 7, "lectures", "content", "lectures", 7, "//"],
   ]
 
   context "table driven cases" do

data/spec/lectures_spec.rb

@@ -1,13 +1,13 @@
 require_relative "./spec_helper.rb"
 describe Lectures do
 	before do
-		mocks1_templates = 
-			[["/lectures/intro/wonders/", "subsection", 0],
-			 	["/lectures/intro/wonders/page2/", "page", 1],
-			 	["/lectures/intro/wonders/page3/", "page", 2],
-			 ["/lectures/intro/wonder2/", "subsection", 1],
-			 	["/lectures/intro/wonder2/page22/", "page", 1],
-			 	["/lectures/intro/wonder2/page32/", "page",2 ]
+		mocks1_templates =
+			[["/lectures/intro/wonders/index.html", "subsection", 0],
+			 	["/lectures/intro/wonders/page2.md.erb", "page", 1],
+			 	["/lectures/intro/wonders/page3.md.erb", "page", 2],
+			 ["/lectures/intro/wonder2/index.html", "subsection", 1],
+			 	["/lectures/intro/wonder2/page22.md.erb", "page", 1],
+			 	["/lectures/intro/wonder2/page32.md.erb/", "page",2 ]
 			]
 		@citems1 = mocks1_templates.map { |i, t, o| CItem.new(nil, i, t, o) }
 		@sect = Lectures.new "intro", @citems1

data/spec/play_spec.rb

@@ -0,0 +1,23 @@
+require_relative "./spec_helper.rb"
+describe "Does it work?" do
+	before do
+		@abc = 1
+	mocks1_templates =
+		[["/lectures/intro/wonders/", "subsection", 0],
+			["/lectures/intro/wonders/page2/", "page", 1],
+			["/lectures/intro/wonders/page3/", "page", 2],
+		 ["/lectures/intro/wonder2/", "subsection", 1],
+			["/lectures/intro/wonder2/page22/", "page", 1],
+			["/lectures/intro/wonder2/page32/", "page",2 ]
+		]
+		binding.pry
+	@citems1 = mocks1_templates.map { |i, t, o| CItem.new(nil, i, t, o) }
+	@sect = Lectures.new "intro", @citems1
+	end
+
+
+	it "correctly counts subsections" do
+		binding.pry
+		expect (@abc).to eq 1
+	end
+end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 require 'rspec'
-require 'pry'
-require './lib/coursegen/course/lib/section'
-require './lib/coursegen/course/lib/toc'
-require './lib/coursegen/course/lib/lectures'
-require './lib/coursegen/course/lib/citem'
-require './lib/coursegen/course/lib/scheduler'
-require './lib/coursegen/course/lib/section_def'
+require 'pry-byebug'
+require './lib/coursegen/course/data/section'
+require './lib/coursegen/course/data/toc'
+require './lib/coursegen/course/data/lectures'
+require './lib/coursegen/course/data/citem'
+require './lib/coursegen/course/schedule/scheduler'
+require './lib/coursegen/course/data/section_def'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -14,7 +14,6 @@ require './lib/coursegen/course/lib/section_def'
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   #config.run_all_when_everything_filtered = true
   #config.filter_run :focus
 

data/templates/.gitignore

@@ -1,3 +1,2 @@
 output/*
-
-tmp/*
+tmp/*

data/{Guardfile → templates/Guardfile}

@@ -2,5 +2,8 @@
 #   watch(%r{file/path}) { `command(s)` }
 #
 guard :shell do
+  clearing :on
+  directories %w(. /mydev/cg-topics)
   watch(/.erb/) { |m| `cg compile` }
+  watch(/(cg_config.rb|Rules)/) { |m| `cg reset; cg compile`}
 end

data/templates/Rules

@@ -1,54 +1,45 @@
 #!/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 './cg_config.rb'
 
 preprocess do
   Toc.instance.prepare @items, SECTION_CONFIG
 end
 
-compile '/bootstrap/*' do
+compile '/bootstrap/**/*' do
   nil
 end
 
-compile '/content/scripts/*' do
+compile '/content/scripts/**/*' do
   nil
 end
 
-compile '/chalkmark/*' do
+compile '/chalkmark/**/*' do
   nil
 end
 
-compile '/tipuesearch/*' do
+compile '/tipuesearch/**/*' do
   nil
 end
 
-compile "/tipuesearch_logic/tipuesearch_content" do
+compile "/tipuesearch_logic/tipuesearch_content.*" do
+  filter :erb
+end
+
+compile "/content/**/*.ical.erb" do
   filter :erb
 end
 
-compile '*' do
+compile '/**/*' do
   if item.binary? || item[:status] == "hidden"
     nil
   elsif item[:status] == "hidden"
     nil
   elsif item[:type] == "subsection"
-    nil    
+    nil
   elsif item[:extension] == "haml"
     filter :haml;
-    layout 'course'
+    layout '/course.*'
   else
     item[:extension].split('.').reverse.each do
       |f|
@@ -59,37 +50,47 @@ compile '*' do
         filter :erb
       end
     end
-    layout 'course'
+    layout '/course.*'
   end
 end
 
-route '/bootstrap/*' do
-  @item.identifier.chop + '.' + @item[:extension]
+route '/bootstrap/**/*' do
+  @item.identifier.to_s
 end
 
-route '/tipuesearch/*' do
-  @item.identifier.chop + '.' + @item[:extension]
+route '/tipuesearch/**/*' do
+  @item.identifier.to_s
 end
 
-route "/tipuesearch_logic/tipuesearch_content/" do
+route "/tipuesearch_logic/tipuesearch_content.*" do
   '/tipuesearch/tipuesearch_content.js'
 end
 
 
-route '/chalkmark/*' do
-  @item.identifier.chop + '.' + @item[:extension]
+route '/chalkmark/**/*' do
+  @item.identifier.to_s
+end
+
+# Output the search page
+route '/tipuesearch_logic/search.md.erb' do
+  '/tipuesearch_logic/search/index.html'
+end
+
+route '/**/*.ical.erb' do
+  @item.identifier.without_ext
 end
 
-route '/content/' do
+
+# Select which .md.erb becomes the home page of the site
+route '/content/index.md.erb' do
   '/index.html'
 end
 
-route '*' do
+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 fail "in route * in Rules"
+    item.identifier.to_s
   elsif item.identifier == "/search_logic/tipuesearch_content/"
       item.identifier.chop + '.' + item[:extension] rescue fail "in route * in Rules"
   elsif item[:status] == "hidden"
@@ -97,10 +98,9 @@ route '*' do
   elsif item[:type] == "subsection"
     nil
   elsif item[:extension] != "css"
-    # Write item with identifier /foo/ to /foo/index.html
-    item.identifier + 'index.html'
+    item.identifier.without_ext + '/index.html'
+
   end
 end
 
-layout '*', :erb
-
+layout '/**/*', :erb

data/templates/cg_config.rb

@@ -4,12 +4,25 @@ require 'coursegen'
 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"
+COURSE_SHORT_NAME = "Sample Course"
+COURSE_LONG_NAME = "Sample Coursegen Course"
+COURSE_ABBREV = "SC"
+
+LECTURES_SCHEDULE_CONFIG = ScheduleDef.new(
+		first_day: "aug-11-2015",
+		weekdays: [:tuesday, :friday],
+		number: 26,
+		skips: [],
+		start_time: "15:00",
+		end_time: "16:20")
+
 
 # Sections in the right hand margin of the page
 SECTION_CONFIG = [
-  SectionDef.new("Background", "background", type: :section),
-  SectionDef.new("Hidden", "hidden", hidden: true, type: :section)
+  SectionDef.new("Intro", "intro", type: :section),
+  SectionDef.new("Lectures", "lectures", type: :lecture, schedule: LECTURES_SCHEDULE_CONFIG),
+  SectionDef.new("Extras", "extras", hidden: true, type: :section)
 ]
-
+# Options are:
+# bullet_style: css style for each bullet
+STYLING_CONFIG = {bullet_style: "\"font-size: 60%; width: 10px; color: grey\""}

data/templates/cg_config.rb_sample

@@ -15,13 +15,13 @@ COURSE_LONG_NAME = "Software Engineering"
 
 # Schedule information. Note that Monday is day 0
 LECTURES_SCHEDULE_CONFIG = ScheduleDef.new(
-		first_day: "jan-14-2014", 
+		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", 
+		first_day: "jan-16-2014",
 		weekdays: [:thursday],
 		number: 13,
 		skips: ["feb-20-2014", "apr-17-2014"])
@@ -39,4 +39,6 @@ SECTION_CONFIG = [
 		SectionDef.new("Hidden", "hidden", hidden: true, type: :section)
 ]
 
-
+# Options are:
+# bullet_style: css style for each bullet
+STYLING_CONFIG = {bullet_style: "\"font-size: 60%; width: 10px; color: grey\""}

data/templates/content/content/extras/extra_content.md.erb

@@ -0,0 +1,4 @@
+---
+title: Extra Content
+---
+This page is in a hidden section and so will not be part of the resulting course.

data/templates/content/content/index.md.erb

@@ -1,4 +1,10 @@
 ---
 title: Welcome!
-section: background
+section: extras
 ---
+<div class="jumbotron">
+	<h2>Welcome to the Sample Course!</h2>
+	<p>This course is generated when you first install Coursegen. It uses all the features (almost) of the software, to allow you to see what is possible.</p>
+
+	<p>Pito Salas, pitosalas@brandeis.edu</p>
+</div>

data/templates/content/content/intro/course_toc.md.erb

@@ -0,0 +1,4 @@
+---
+title: List of lectures
+---
+<%= list_of(source: "lectures", rows: ["subsection","page"], cols: [:number, :date, :title, :desc, :homework]) %>

data/templates/content/content/intro/welcome.md.erb

@@ -0,0 +1,8 @@
+---
+title: Welcome to Sample Course
+---
+### Welcome!
+
+This page is part of the sample course in Coursegen
+
+Also it is used as the home page.

data/templates/content/content/lectures/part1/01_first_lecture.md.erb

@@ -0,0 +1,4 @@
+---
+title: First Lecture
+---
+This page is part of a scheduled series of lectures. It turns out to be the first lecture in Part 1. In the sample course the lectures are in two groups, part1 and part2.

data/templates/content/content/lectures/part1/02_here_we_go.md.erb

@@ -0,0 +1,5 @@
+---
+title: Second Lecture - Here we go
+---
+### Continuing
+This page is the second one in the first part. It is the second lecture of the Sample Course.

data/templates/content/content/lectures/part1/index.html

@@ -0,0 +1,6 @@
+---
+title: Part 1 of the Sample Course
+type: subsection
+collapsed: false
+order: 1
+---

data/templates/content/content/lectures/part2/01_start_part2.md.erb

@@ -0,0 +1,5 @@
+---
+title: Third Lecture - Launching Part 2
+---
+### Part 2 starts here
+In the sample course, there are two sections or parts. This page is the first page of the second part.

data/templates/content/content/lectures/part2/02_continue_part2.md.erb

@@ -0,0 +1,5 @@
+---
+title: Fourth Lecture - Part2s second lecture
+---
+### Second lecture of part 2
+This is actually the fourth lecture of the Sample course.

data/templates/content/content/lectures/part2/index.html

@@ -0,0 +1,6 @@
+---
+title: Part 2 of the Sample Course
+type: subsection
+collapsed: false
+order: 2
+---

data/templates/content/content/lectures/schedule.ical.erb

@@ -0,0 +1,5 @@
+---
+title: Generates the ical feed for these lectures
+section: extras
+---
+<%= generate_ical "lectures" %>

data/templates/content/tipuesearch_logic/search.md.erb

@@ -1,6 +1,6 @@
 ---
 title: Search Results
-section: hidden
+section: extras
 ---
 
 >    *note: for now, each search result includes the first several lines of the page, which may or may not include the occurences of the words you searched for. Don't let that make you think that the search didn't work. It's just that the results page can be improved (a lot)*

data/templates/layouts/course.html

@@ -3,8 +3,8 @@
   <head>
     <title><%= @item[:title] %> - <%= COURSE_SHORT_NAME %></title>
     <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0"> 
-    
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
     <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.0/css/bootstrap.min.css">
     <link rel="stylesheet" href="/bootstrap/css/custom.css">
     <script src="https://code.jquery.com/jquery.js"></script>
@@ -19,12 +19,12 @@
 
     <% @citem = Toc.instance.n2c(@item) %>
     <div class="navbar navbar-inverse navbar-fixed-top">
-      <%= render "main_navbar", toc: Toc.instance, item: item, citem: @citem %>
+      <%= render "/main_navbar.*", toc: Toc.instance, item: item, citem: @citem %>
     </div>
     <div class="container">
       <div class="row">
         <div class="col-xs-12">
-        <%= render "body_header", toc: Toc.instance, item: item, citem: @citem %>
+        <%= render "/body_header.*", toc: Toc.instance, item: item, citem: @citem %>
         </div>
       </div>
       <div class="row">
@@ -33,7 +33,7 @@
         </div>
         <div class="col-xs-3">
           <div class="row well right-nav" style="color: rgb(158, 48, 48);padding-top: 4px;padding-bottom: 4px;padding-left: 8px;padding-right: 8px;margin-bottom: 8px;">
-            <%= render "helpful_box" %>
+            <%= render "/helpful_box.*" %>
           </div>
           <div class="row well right-nav" style="padding: 5px;">
             <ul>
@@ -44,7 +44,7 @@
           </div>
         </div>
       </div>
-      <%= render "body_footer" %>
+      <%= render "/body_footer.*" %>
     </div>
     <!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
     <!-- Include all compiled plugins (below), or include individual files as needed -->

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coursegen
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Pito Salas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: nanoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0rc2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,6 +192,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Use Nanoc to build courses and deploy them to S3
 email:
 - pitosalas@gmail.com
@@ -203,7 +231,6 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -219,6 +246,7 @@ files:
 - lib/coursegen/course/data/toc.rb
 - lib/coursegen/course/helpers/bootstrap_markup.rb
 - lib/coursegen/course/helpers/content_helpers.rb
+- lib/coursegen/course/helpers/ical_feed_helpers.rb
 - lib/coursegen/course/helpers/lecture_helpers.rb
 - lib/coursegen/course/helpers/list_of.rb
 - lib/coursegen/course/helpers/list_of_helpers.rb
@@ -227,20 +255,23 @@ files:
 - lib/coursegen/course/helpers/sidebar_helpers.rb
 - lib/coursegen/course/helpers/table_helpers.rb
 - lib/coursegen/course/lib/helpers_.rb
+- lib/coursegen/course/lib/ical_adaptor.rb
 - lib/coursegen/course/lib/search_data_generator.rb
-- lib/coursegen/course/lib/toc.rb
 - lib/coursegen/course/schedule/schedule_def.rb
+- lib/coursegen/course/schedule/schedule_feed.rb
 - lib/coursegen/course/schedule/scheduler.rb
 - lib/coursegen/templates.rb
 - lib/coursegen/version.rb
 - spec/citem_spec.rb
 - spec/lectures_spec.rb
+- spec/play_spec.rb
 - spec/scheduler_spec.rb
 - spec/section_spec.rb
 - spec/spec_helper.rb
 - spec/toc_spec.rb
 - tech_debt.md
 - templates/.gitignore
+- templates/Guardfile
 - templates/Rules
 - templates/cg_config.rb
 - templates/cg_config.rb_sample
@@ -248,7 +279,17 @@ files:
 - templates/content/bootstrap/fonts/glyphicons-halflings-regular.ttf
 - templates/content/bootstrap/js/custom.js
 - templates/content/chalkmark/chalkmark.js
+- templates/content/content/extras/extra_content.md.erb
 - templates/content/content/index.md.erb
+- templates/content/content/intro/course_toc.md.erb
+- templates/content/content/intro/welcome.md.erb
+- templates/content/content/lectures/part1/01_first_lecture.md.erb
+- templates/content/content/lectures/part1/02_here_we_go.md.erb
+- templates/content/content/lectures/part1/index.html
+- templates/content/content/lectures/part2/01_start_part2.md.erb
+- templates/content/content/lectures/part2/02_continue_part2.md.erb
+- templates/content/content/lectures/part2/index.html
+- templates/content/content/lectures/schedule.ical.erb
 - templates/content/tipuesearch/img/loader.gif
 - templates/content/tipuesearch/img/search.png
 - templates/content/tipuesearch/tipuesearch_set.js
@@ -290,6 +331,7 @@ summary: Use Nanoc to build courses and deploy them to S3
 test_files:
 - spec/citem_spec.rb
 - spec/lectures_spec.rb
+- spec/play_spec.rb
 - spec/scheduler_spec.rb
 - spec/section_spec.rb
 - spec/spec_helper.rb