jekyll-theme-open-course 0.0.1 → 1.3.0

data/exe/jtoc

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require 'mercenary'
+require 'jtoc'
+
+Mercenary.program(:jtoc) do |p|
+  p.version JTOpenCourse::VERSION
+  p.description "A generator for the Open Course Jekyll theme"
+  p.syntax "jtoc <subcommand> [options]"
+
+  p.command(:version) do |c|
+    c.description "Ouput the version number"
+    c.syntax "version"
+    c.action do |_,_|
+      puts JTOpenCourse::VERSION
+    end
+  end
+
+  p.command(:setup) do |c|
+    c.syntax "setup"
+    c.description <<~DESC
+      Interactively set up a new course site.
+    DESC
+    c.action do |_,_|
+      puts "Enter the short identifier for this course:"
+      while true
+        path = gets.chomp
+        if JTOpenCourse::SiteBuilder.path_check(path)
+          puts "A course with that identifier already exists. Try another:"
+        else
+          break
+        end
+      end
+    end
+  end
+
+  p.command(:new) do |c|
+    c.syntax "new PATH [options]"
+    c.description <<~DESC
+      Create a new course site at PATH. By design, the PATH value is used for the
+      directory value as well as the GitHub repo name, and the base URL for the
+      course site (e.g., https://example.com/PATH/)
+    DESC
+    c.option 'monday', '-m DATE', '--monday DATE', 'Set the first Monday of the term (e.g., 2020-01-13)'
+    c.option 'weeks', '-w NUM', '--weeks NUM', 'Set the number of weeks in the term'
+    c.option 'projects', '-p NUM', '--projects NUM', 'Set the number of major projects in the course'
+    c.option 'days', '-d DAYS', '--days DAYS', 'Set the course meeting days (e.g., "Monday, Wednesday")'
+    c.option 'url', '-u URL', '--url URL', 'Set the course URL (e.g., https://example.com).'
+    c.option 'number', '-n COURSE', '--number COURSE', 'Set the course number (e.g., "COM 101")'
+    c.option 'title', '-l TITLE', '--title TITLE', 'Set the course title (e.g., "Intro to Communication")'
+    c.option 'instructor', '-i NAME', '--instructor NAME', 'Set the instructor name (e.g., "Marcus Cicero")'
+    c.option 'cc', '-c', '--creative-commons', 'Add a Creative Commons license'
+    c.action do |args, options|
+      course = JTOpenCourse::SiteBuilder.new(args, options)
+      if course.path.exist?
+        puts "A directory named '#{course.name}' already exists. Aborting."
+        abort
+      end
+      course.create!
+    end
+  end
+
+  p.action do |args, _|
+    if args.empty?
+      puts p
+    else
+      subcommand = args.first
+      unless p.has_command? subcommand
+        puts "Sorry, I don't know how to '#{args.first}'."
+        puts "Try running `jtgen --help` for help."
+      end
+    end
+  end
+end

data/lib/jtoc.rb

@@ -0,0 +1,177 @@
+module JTOpenCourse
+
+  require 'erb'
+  require 'date'
+
+  VERSION = "1.3.0"
+
+  SPELLED_NUMS = %w(
+    Zero One Two Three Four Five Six Seven Eight Nine Ten Eleven Twelve Thirteen Fourteen Fifteen
+    Sixteen Seventeen Eighteen Nineteen Twenty Twenty-One Twenty-Two Twenty-Three Twenty-Four
+    Twenty-Five
+  )
+
+  # No small amount of this code has been either inspired or just about lifted from Jekyll's
+  # ThemeBuilder class at https://github.com/jekyll/jekyll/blob/master/lib/jekyll/theme_builder.rb
+
+  class SiteBuilder
+    SCAFFOLD_DIRECTORIES = %w(
+      _data policies projects syllabus/_policies syllabus/_projects syllabus/_weeks
+    ).freeze
+
+    SCAFFOLD_PAGE_STUBS = %w(
+      index.md projects/index.md policies/index.md
+    ).freeze
+
+    DEFAULT_VALUES = {
+      weeks: 16,
+      projects: 3,
+      days: "Monday, Wednesday",
+      url: "http://example.com/",
+      number: "COM 101",
+      title: "Introduction to Communication",
+      instructor: "Horatio Q. Birdbath",
+      email: "instructor@example.com",
+      cc: false
+    }
+
+    attr_reader :counter, :name, :path, :anchor_date, :week_count, :project_count, :days, :url, :number, :title, :instructor, :cc, :email
+
+    def initialize(args, options)
+      @counter = 0
+      @name = args.first.chomp
+      @path = Pathname.new(File.expand_path(name, Dir.pwd))
+
+      @anchor_date = set_value(find_next_monday(options['monday']),find_next_monday)
+      @week_count = set_value(options['weeks'], DEFAULT_VALUES[:weeks]).to_i
+      @project_count = set_value(options['projects'], DEFAULT_VALUES[:projects]).to_i
+      @days = set_value(options['days'], DEFAULT_VALUES[:days]).split(/\W+/)
+
+      @url = set_value(options['url'],DEFAULT_VALUES[:url]).chomp('/')
+      @number = set_value(options['number'],DEFAULT_VALUES[:number])
+      @title = set_value(options['title'],DEFAULT_VALUES[:title])
+      @instructor = set_value(options['instructor'], set_value(query_git_config('user.name'),DEFAULT_VALUES[:instructor]))
+      @cc = set_value(options['cc'], DEFAULT_VALUES[:cc])
+
+      @email = set_value(query_git_config('user.email'),DEFAULT_VALUES[:email])
+    end
+
+    def self.path_check(name)
+      Pathname.new(File.expand_path(name, Dir.pwd)).exist?
+    end
+
+    def set_value(custom,default)
+      if custom.to_s.empty?
+        custom = default
+      end
+      custom
+    end
+
+    def query_git_config(val)
+      begin
+        val = `git config --global #{val}`.chomp
+        val.empty? ? false : val
+      rescue
+        false
+      end
+    end
+
+    def find_next_monday(date=Date.today.to_s)
+      date = Date.parse(date)
+      while date.cwday > 1
+        date += 1
+      end
+      date
+    end
+
+    def create!
+      create_directories
+      create_config_yml
+      create_utility_data
+      create_calendar_data
+      create_projects
+      create_weeks
+      create_policies
+      create_page_stubs
+    end
+
+    def starter_path
+      @starter_path ||= Pathname.new(File.expand_path("starter_files", __dir__))
+    end
+
+    def create_directories
+      mkdir_p(SCAFFOLD_DIRECTORIES)
+    end
+
+    def create_projects
+      for @counter in 1..@project_count do
+        process_file("syllabus/_projects/project-#{@counter.to_s.rjust(2,"0")}.md", "syllabus/_projects/project-00.md")
+      end
+    end
+
+    def create_weeks
+      for @counter in 1..@week_count do
+        process_file("syllabus/_weeks/week-#{@counter.to_s.rjust(2,"0")}.md", "syllabus/_weeks/week-00.md")
+      end
+    end
+
+    def create_policies
+      Dir.chdir(starter_path) do
+        Dir.glob("syllabus/_policies/*.md").each do |f|
+          process_file(f)
+        end
+      end
+    end
+
+    def create_config_yml
+      process_file("_config.yml")
+    end
+
+    def create_calendar_data
+      process_file("_data/calendar.yml")
+    end
+
+    def create_utility_data
+      process_file("_data/utility.yml")
+    end
+
+    def create_page_stubs
+      SCAFFOLD_PAGE_STUBS.each_with_index do |stub,c|
+        @counter = c
+        process_file(stub,"index.md")
+      end
+    end
+
+    def mkdir_p(directories)
+      Array(directories).each do |d|
+        FileUtils.mkdir_p(path.join(d))
+      end
+    end
+
+    def render_erb(contents)
+      ERB.new(contents, trim_mode: "<>").result binding
+    end
+
+    def process_file(output,input=output)
+      write_file(output,process_template(input))
+    end
+
+    def process_template(filename)
+      render_erb(find_template_file(filename).read)
+    end
+
+    def find_template_file(filename)
+      [
+        starter_path.join("#{filename}.erb"),
+        starter_path.join(filename.to_s)
+      ].find(&:exist?)
+    end
+
+    def write_file(filename, contents)
+      full_path = path.join(filename)
+      File.write(full_path, contents)
+    end
+
+  end
+
+end

data/lib/starter_files/_config.yml.erb

@@ -0,0 +1,84 @@
+url: <%= url %>
+baseurl: /<%= name %>/
+
+timezone: America/Chicago
+
+course:
+  number: <%= number %>
+  title: <%= title %>
+  uid: <%= name %>
+  tagline: >
+    Write a course tagline in `_config.yml`
+  term: <%= anchor_date.year %>
+  # Set `days: ""` (empty string) for weekly/asynchronous classes
+  days: <%= '""' unless days.length > 0 %>
+    <% days.each do |d| %>- <%= d %>
+    <% end %>
+<% if cc %>
+  license:
+    name: Creative Commons
+    url: https://creativecommons.org/licenses/by/4.0/
+<% end %>
+  instructor:
+    honorific: Dr.
+    name: <%= instructor %>
+    title: Professor
+    full_title: Enter a full professional title in `_config.yml`
+    url: https://example.com/instructor/
+    github: https://github.com/example/
+    email: <%= email %>
+    office_hours: >
+      Detail your office hours in `_config.yml`
+  navigation:
+    - label: Calendar
+      href: "#this-week"
+      id: cal
+    - label: Projects
+      href: "projects/#current"
+      id: pro
+    - label: Policies
+      href: "policies/"
+      id: pol
+  css:
+    font-url: "https://use.typekit.net/pig5ein.css"
+
+collections_dir: syllabus
+
+collections:
+  weeks:
+  projects:
+  policies:
+    # Rearrange the files listed here to change their order on the policies page.
+    # To remove a section from the policies page, you *must* delete the file in the
+    # /syllabus/_policies/ directory
+    order:
+      - description.md
+      - goals.md
+      - outcomes.md
+      - objectives.md
+      - books.md
+      - materials.md
+      - special-needs.md
+      - participation.md
+      - assignment-submission.md
+      - late-work.md
+      - grading-policy.md
+      - grading-criteria.md
+      - technology-policy.md
+      - academic-integrity.md
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "default"
+
+theme: jekyll-theme-open-course
+
+exclude:
+  - backstop_data
+  - backstop.json
+  - exe
+  - lib
+  - Rakefile
+  - "*.gemspec"

data/lib/starter_files/_data/calendar.yml.erb

@@ -0,0 +1,6 @@
+- begins: <%= anchor_date %>T00:00
+  expires: &two <%= anchor_date + 7 %>T00:00
+<% week_num = 2; while week_num <= week_count %>
+- begins: *<%= SPELLED_NUMS[week_num].downcase %>
+  expires: &<%= SPELLED_NUMS[week_num + 1].downcase %> <%= anchor_date + (week_num * 7) %>T00:00<% week_num += 1 %>
+<% end %>

data/lib/starter_files/_data/utility.yml

@@ -0,0 +1,35 @@
+day_offsets:
+  monday: 0
+  tuesday: 86400
+  wednesday: 172800
+  thursday: 259200
+  friday: 345600
+  saturday: 432000
+  sunday: 518400
+spelled_nums:
+  - Zero
+  - One
+  - Two
+  - Three
+  - Four
+  - Five
+  - Six
+  - Seven
+  - Eight
+  - Nine
+  - Ten
+  - Eleven
+  - Twelve
+  - Thirteen
+  - Fourteen
+  - Fifteen
+  - Sixteen
+  - Seventeen
+  - Eighteen
+  - Nineteen
+  - Twenty
+  - Twenty-One
+  - Twenty-Two
+  - Twenty-Three
+  - Twenty-Four
+  - Twenty-Five

data/lib/starter_files/index.md.erb

@@ -0,0 +1,5 @@
+---<% page_fragment = SCAFFOLD_PAGE_STUBS[counter].split('/').first; page_title = page_fragment == 'index.md' ? "Calendar" : page_fragment %>
+title: Course <%= page_title.capitalize %>
+id: <%= page_title.downcase %>
+layout: <%= page_title.downcase %>
+---

data/lib/starter_files/offline/index.md

@@ -0,0 +1,7 @@
+---
+title: Site Offline
+layout: error
+---
+
+Well this is embarrassing. Either there’s something the matter with your internet connection, or the
+server where this course site is hosted. Best to just try again later.

data/lib/starter_files/syllabus/_policies/academic-integrity.md

@@ -0,0 +1,3 @@
+---
+title: Academic Integrity
+---

data/lib/starter_files/syllabus/_policies/assignment-submission.md

@@ -0,0 +1,3 @@
+---
+title: Assignment Submission
+---

data/lib/starter_files/syllabus/_policies/books.md

@@ -0,0 +1,17 @@
+---
+title: Books
+---
+
+<section class="required" markdown="1">
+<h3>Required</h3>
+
+- Required book one
+- Required book two
+</section>
+
+<section class="recommended" markdown="1">
+<h3>Recommended</h3>
+
+- Recommended book one
+- Recommended book two
+</section>

data/lib/starter_files/syllabus/_policies/description.md

@@ -0,0 +1,3 @@
+---
+title: Course Description
+---

data/lib/starter_files/syllabus/_policies/goals.md

@@ -0,0 +1,3 @@
+---
+title: Course Goals
+---

data/lib/starter_files/syllabus/_policies/grading-criteria.md

@@ -0,0 +1,3 @@
+---
+title: Grading Criteria
+---

data/lib/starter_files/syllabus/_policies/grading-policy.md

@@ -0,0 +1,3 @@
+---
+title: Grading Policy
+---

data/lib/starter_files/syllabus/_policies/late-work.md

@@ -0,0 +1,3 @@
+---
+title: Late Work
+---