coursegen 0.8.1 → 0.9.3

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

@@ -1,5 +1,9 @@
-WEEKDAYS = {sunday: 0, monday: 1, tuesday: 2,
-              wednesday: 3, thursday: 4, friday: 5, saturday: 6}
+require 'date'
+require 'active_support'
+require 'active_support/core_ext/numeric/time'
+
+WEEKDAYS = { sunday: 0, monday: 1, tuesday: 2,
+             wednesday: 3, thursday: 4, friday: 5, saturday: 6 }.freeze
 
 # Calculate days on which each event occurs, based on the configuration info
 class Scheduler
@@ -26,8 +30,17 @@ class Scheduler
       @start = nil
       return
     end
-    setup_from_args(start: sdef.first_day, weekdays: sdef.weekdays,
-                    number: sdef.number, skips: sdef.skips, start_time: sdef.start_time, end_time: sdef.end_time, start_times: sdef.start_times, end_times: sdef.end_times)
+
+    setup_from_args(
+      start: sdef.first_day,
+      weekdays: sdef.weekdays,
+      number: sdef.number,
+      skips: sdef.skips,
+      start_time: sdef.start_time,
+      end_time: sdef.end_time,
+      start_times: sdef.start_times,
+      end_times: sdef.end_times
+    )
   end
 
   def event_date_by_index(ind)
@@ -41,14 +54,15 @@ class Scheduler
   private
 
   def recalc_event_map
-    return if self.null?
+    return if null?
+
     @event_dates = []
     @event_start_times = []
     @event_end_times = []
     wkdy_of_start = @start_date.cwday
     wkday_index = @weekdays.find_index(wkdy_of_start)
     curr_event_date = @start_date
-    @number.times do |i|
+    @number.times do |_i|
       unless @skips.include? curr_event_date
         @event_dates << curr_event_date
         @event_start_times << @start_times[wkday_index]
@@ -70,31 +84,50 @@ class Scheduler
                                    start_time, end_time, start_times, end_times)
     @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 }
+    @skips = begin
+               skips.map { |d| string_to_date(d) }
+             rescue StandardError
+               raise(ArgumentError, 'Scheduler: Invalid skip date')
+             end
+
+    unless weekdays.all? { |wd| WEEKDAYS.include? wd }
+      raise ArgumentError, 'Scheduler: invalid weekdays'
+    end
 
-    @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) }
+    @weekdays = weekdays.map { |wd| WEEKDAYS[wd] }
+    unless @weekdays.include? @start_date.cwday
+      raise ArgumentError, 'Scheduler: Start date is not on one of the weekdays'
+    end
+    unless @skips.reduce(true) { |accum, skip| accum && @weekdays.include?(skip.cwday) }
+      raise ArgumentError, 'Scheduler: Skip date is not on a valid weekday'
+    end
 
-    @start_time = time_span_to_seconds(start_time) rescue raise(ArgumentError, "error converting start time. Use hh:mm: #{start_time} ")
-    @end_time = time_span_to_seconds(end_time) rescue raise(ArgumentError, "error converting end time. Use hh:mm: #{end_time}")
-    @start_times = start_times.map { |x| time_span_to_seconds(x)}
-    @end_times = end_times.map { |x| time_span_to_seconds(x)}
+    @start_time = begin
+                    time_span_to_seconds(start_time)
+                  rescue StandardError
+                    raise(ArgumentError, "error converting start time. Use hh:mm: #{start_time} ")
+                  end
+    @end_time = begin
+                  time_span_to_seconds(end_time)
+                rescue StandardError
+                  raise(ArgumentError, "error converting end time. Use hh:mm: #{end_time}")
+                end
+    @start_times = start_times.map { |x| time_span_to_seconds(x) }
+    @end_times = end_times.map { |x| time_span_to_seconds(x) }
   end
 
   def string_to_date(string_date)
-    Date.strptime(string_date, "%b-%d-%Y") rescue  fail "string to date in scheduler.rb"
+    Date.strptime(string_date, '%b-%d-%Y')
+  rescue StandardError
+    raise "string to date in scheduler.rb #{string_date}"
   end
 
   def strings_to_date_time(string_date, string_time)
-    DateTime.strptime(string_date + " " + string_time, "%b-%d-%Y %H:%M")
+    DateTime.strptime(string_date + ' ' + string_time, '%b-%d-%Y %H:%M')
   end
 
   def time_span_to_seconds(string_time)
     result = string_time.match(/(\d\d):(\d\d)/)
     result[1].to_i.hours + result[2].to_i.minutes
   end
-
 end

data/lib/coursegen/templates.rb

@@ -1,32 +1,39 @@
+# frozen_string_literal: true
+
 require 'pry'
 
 module CourseGen
+  # Class Templates represent a Coursegen template.
   class Templates < Thor::Group
     include Thor::Actions
 
+    # Generate_all generates a Coursegen site using the default template.
     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("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")
-      delete_target_file("content/index.html")
-      delete_target_file("layouts/default.html")
-      create_empty_dir("content/images")
+      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('.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')
+      delete_target_file('content/index.html')
+      delete_target_file('layouts/default.html')
+      create_empty_dir('content/images')
     end
 
+    # Valid_cg_directory? checks if the underlying directory is a valid
+    # nanoc site.
+    #
+    # This method is used by Coursegen::CLI.
     def valid_cg_directory?
       valid = true
-      list = ["Rules", "nanoc.yaml", "content", "lib"]
+      list = ['Rules', 'nanoc.yaml', 'content', 'lib']
       list.each do |filename|
-        if !File.exists?(filename)
+        unless File.exist?(filename)
           valid = false
           say("Required file not found: #{filename}")
         end
@@ -38,22 +45,22 @@ module CourseGen
       Pathname.new(File.dirname(__FILE__)).parent.parent.to_s
     end
 
-# invoke methods from Thor::Actions
+    # invoke methods from Thor::Actions
     def initialize
       super
       destination_root = Dir.getwd
     end
 
-    def create_empty_dir to
+    def create_empty_dir(to)
       empty_directory(to)
     end
 
-    def copy_template_dir from, to
-      directory("templates/#{from}", "#{to}")
+    def copy_template_dir(from, to)
+      directory("templates/#{from}", to.to_s)
     end
 
-    def copy_template_file from, to
-      template("templates/#{from}", "#{to}")
+    def copy_template_file(from, to)
+      template("templates/#{from}", to.to_s)
     end
 
     def delete_target_file(to)

data/lib/coursegen/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Coursegen
-  VERSION = "0.8.1"
+  VERSION = '0.9.3'
 end

data/spec/lectures_spec.rb

@@ -1,52 +1,62 @@
-require_relative "./spec_helper.rb"
-describe Lectures do
-	before do
-		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
-	end
-
-	it "correctly counts subsections" do
-		expect(@sect.subsections.length).to eq 2
-	end
-
-	it "correctly handles next from page to page " do
-		expect(@sect.next_for(@citems1[1])).to eq @citems1[2]
-	end
-
-	it "correctly handles prev from page to page " do
-		expect(@sect.previous_for(@citems1[2])).to eq @citems1[1]
-	end
-
-	it "correctly handles prev from first page in section " do
-		expect(@sect.previous_for(@citems1[1])).to eq @citems1[1]
-	end
-
-	it "correctly handles next from last page in section " do
-		expect(@sect.next_for(@citems1[5])).to eq @citems1[5]
-	end
-
-
-	it "correctly handles next from subsection to subseciton" do
-		expect(@sect.next_for(@citems1[0])).to eq @citems1[3]
-	end
-
-	it "correctly handles next from last subsection" do
-		expect(@sect.next_for(@citems1[3])).to eq @citems1[3]
-	end
-
-	it { expect(@citems1[0].lecture_number).to eq 1 }
-	it { expect(@citems1[1].lecture_number).to eq 1 }
-	it { expect(@citems1[2].lecture_number).to eq 2 }
-	it { expect(@citems1[3].lecture_number).to eq 3 }
-	it { expect(@citems1[4].lecture_number).to eq 3 }
-	it { expect(@citems1[5].lecture_number).to eq 4 }
+require_relative './spec_helper.rb'
 
+describe Lectures do
+  before do
+    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) }
+    @schd = Scheduler.new
+    @schd.setup_from_args(
+      start: 'jan-17-2017',
+      weekdays: %i[tuesday wednesday thursday],
+      start_times: %w[15:30 14:00 15:30],
+      end_times: %w[16:50 16:00 16:50],
+      number: 39,
+      start_time: '15:30',
+      end_time: '16:50',
+      skips: %w[feb-9-2017 feb-21-2017 feb-22-2017 feb-23-2017 apr-11-2017
+                apr-12-2017 apr-13-2017 apr-18-2017 apr-19-2017]
+    )
+    @sect = Lectures.new('intro', @citems1, @schd)
+  end
+
+  it 'correctly counts subsections' do
+    expect(@sect.subsections.length).to eq 2
+  end
+
+  it 'correctly handles next from page to page' do
+    expect(@sect.next_for(@citems1[1])).to eq @citems1[2]
+  end
+
+  it 'correctly handles prev from page to page' do
+    expect(@sect.previous_for(@citems1[2])).to eq @citems1[1]
+  end
+
+  it 'correctly handles prev from first page in section' do
+    expect(@sect.previous_for(@citems1[1])).to eq @citems1[1]
+  end
+
+  it 'correctly handles next from last page in section' do
+    expect(@sect.next_for(@citems1[5])).to eq @citems1[5]
+  end
+
+  it 'correctly handles next from subsection to subsecton' do
+    expect(@sect.next_for(@citems1[0])).to eq @citems1[3]
+  end
+
+  it 'correctly handles next from last subsection' do
+    expect(@sect.next_for(@citems1[3])).to eq @citems1[3]
+  end
+
+  it { expect(@citems1[0].lecture_number).to eq 1 }
+  it { expect(@citems1[1].lecture_number).to eq 1 }
+  it { expect(@citems1[2].lecture_number).to eq 2 }
+  it { expect(@citems1[3].lecture_number).to eq 3 }
+  it { expect(@citems1[4].lecture_number).to eq 3 }
+  it { expect(@citems1[5].lecture_number).to eq 4 }
 end

data/spec/play_spec.rb

@@ -1,19 +1,31 @@
-require_relative "./spec_helper.rb"
-describe "Does it work?" do
+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]]
+      [['/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
+    @schd = Scheduler.new
+    @schd.setup_from_args(
+      start: 'jan-17-2017',
+      weekdays: %i[tuesday wednesday thursday],
+      start_times: %w[15:30 14:00 15:30],
+      end_times: %w[16:50 16:00 16:50],
+      number: 39,
+      start_time: '15:30',
+      end_time: '16:50',
+      skips: %w[feb-9-2017 feb-21-2017 feb-22-2017 feb-23-2017 apr-11-2017
+                apr-12-2017 apr-13-2017 apr-18-2017 apr-19-2017]
+    )
+    @sect = Lectures.new('intro', @citems1, @schd)
   end
 
-  it "correctly counts subsections" do
-    expect (@abc).to eq 1
+  it 'correctly counts subsections' do
+    expect(@sect).to be_truthy
   end
 end

data/spec/scheduler_spec.rb

@@ -1,75 +1,135 @@
 require 'active_support/core_ext/date/conversions'
 
-require_relative "./spec_helper.rb"
+require_relative './spec_helper.rb'
 
 def s2d(string_date)
-  Date.strptime(string_date, "%b-%d-%Y")
+  Date.strptime(string_date, '%b-%d-%Y')
 end
 
 describe Scheduler do
-  let(:sched) {Scheduler.new}
-  let(:target_date) {"nov-25-2013"}
+  let(:sched) { Scheduler.new }
+  let(:target_date) { 'nov-25-2013' }
   let(:target_date_bin) { s2d(target_date) }
 
-  describe "Single day scheduler"  do
-    it "knows date for first event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday], number: 1)
+  describe 'Single day scheduler' do
+    it 'knows date for first event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: [:monday],
+        number: 1,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 0
       expect(a_date).to eq target_date_bin
     end
 
-    it "knows date for second event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday], number: 2)
+    it 'knows date for second event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: [:monday],
+        number: 2,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 1
       expect(a_date).to eq target_date_bin + 7
     end
   end
 
-  describe "Double day scheduler" do
-    it "knows date for first event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :tuesday], number: 1)
+  describe 'Double day scheduler' do
+    it 'knows date for first event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday tuesday],
+        number: 1,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 0
       expect(a_date).to eq target_date_bin
     end
 
-    it "knows date for second event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :tuesday], number: 2)
+    it 'knows date for second event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday tuesday],
+        number: 2,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 1
       expect(a_date).to eq target_date_bin + 1
     end
 
-    it "knows date for third event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :tuesday], number: 3)
+    it 'knows date for third event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday tuesday],
+        number: 3,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 2
       expect(a_date).to eq target_date_bin + 7
     end
 
-    it "knows date for fourth event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :tuesday], number: 4)
+    it 'knows date for fourth event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday tuesday],
+        number: 4,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 3
       expect(a_date).to eq target_date_bin + 7 + 1
     end
   end
 
-  describe "Tripple day scheduler" do
-    it "knows date for first event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :wednesday, :friday], number: 1)
+  describe 'Triple day scheduler' do
+    it 'knows date for first event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday wednesday friday],
+        number: 1,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 0
       expect(a_date).to eq target_date_bin
     end
-    it "knows date for second event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :wednesday, :friday], number: 2)
+    it 'knows date for second event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday wednesday friday],
+        number: 2,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 1
       expect(a_date).to eq target_date_bin + 2
     end
 
-    it "knows date for third event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :wednesday, :friday], number: 3)
+    it 'knows date for third event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday wednesday friday],
+        number: 3,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 2
       expect(a_date).to eq target_date_bin + 4
     end
-    it "knows date for fourth event" do
-      sched.setup_from_args(start: target_date, weekdays: [:monday, :wednesday, :friday], number: 4)
+    it 'knows date for fourth event' do
+      sched.setup_from_args(
+        start: target_date,
+        weekdays: %i[monday wednesday friday],
+        number: 4,
+        start_time: '10:00',
+        end_time: '11:00'
+      )
       a_date = sched.event_date_by_index 3
       expect(a_date).to eq target_date_bin + 7
     end