puppet-courseware-manager 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 920d9ead0c7f53930949fc216271fd862730d3af
-  data.tar.gz: eacf4a3bfa5f1f90ff38e5eb1d67a80c660101a3
+  metadata.gz: 5eb2df1ef67e6ef21fd53cb49d0fbba4cca60715
+  data.tar.gz: 97851ebba09d5ae7db6543c0b6fca90fdd3585f8
 SHA512:
-  metadata.gz: cb0b92b90e8221ca981d913a0db22c399baaf7b20b82e7b9970018d2df010ddfc6ce16d7316100596c24e2f9c19493d369a4436085ec762e01f42712bf6884e5
-  data.tar.gz: 3f17f6a5c3cf8977124686a9de48cefb8837129c6c3f63b54ad42c3ef4e2174415caa7b5829f80a27a33fcbbf018ad0441bf55e07ec866b551e1ea4c0daa5883
+  metadata.gz: edb197aa9f1dd9a6aba1461c5effccf5aaa786bcc2f6ec078cc6c6ccef68d698c1ae83507dc41c709c1e82b69ef5f40e17fc94ac213a0f15f33cca09defaa3cb
+  data.tar.gz: e4dc9bd3d1a5d9d95be834f71c1335ae7f7d940552290957e0bf8b492c5c1e063c5d2551cf4b5344d2d3a4ceadea171f8030ef5558d6376dd7b6fc8774fa2c20

data/CHANGELOG.txt

@@ -1,6 +1,11 @@
 # Courseware Manager
 ## Release Notes
 
+### v0.5.2
+* Add support for Showoff named sections, making it possible to validate new courses.
+* Add support for packaging more showoff formats.
+* Add support for running headless, so we can generate PDFs in the classroom.
+
 ### v0.5.1
 * Support modular presentations
 * Allow watermarked PDF files via metadata in showoff

data/bin/courseware

@@ -31,6 +31,14 @@ optparse = OptionParser.new { |opts|
         cmdlineopts[:presfile] = opt
     end
 
+    opts.on("-o", "--output DIRECTORY", "Output directory to place generated files in.") do |opt|
+        cmdlineopts[:output] = opt
+    end
+
+    opts.on("-n", "--no-cache", "Don't cache template content") do
+        cmdlineopts[:nocache] = true
+    end
+
     opts.on("-d", "--debug", "Display debugging messages") do
         cmdlineopts[:debug] = true
     end
@@ -58,6 +66,7 @@ config ||= YAML.load_file(File.expand_path('../courseware.yaml')) rescue {}
 config.merge!(cmdlineopts)
 # finally, apply defaults to any unset options
 config[:templates]            ||= 'git@github.com:puppetlabs/courseware-templates.git'
+config[:nocache]              ||= false
 config[:cachedir]             ||= '~/.courseware'
 config[:stylesheet]           ||= 'courseware.css'
 config[:renderer]             ||= :wkhtmltopdf

data/lib/courseware.rb

@@ -19,8 +19,8 @@ class Courseware
       @manager    = Courseware::Manager.new(config, @repository)
     else
       require 'courseware/dummy'
-      @repository = Courseware::Dummy.new
-      @manager    = Courseware::Dummy.new
+      @repository = Courseware::Dummy.new(config)
+      @manager    = Courseware::Dummy.new(config)
       $logger.debug "Running outside a valid git repository."
     end
   end

data/lib/courseware/cache.rb

@@ -4,8 +4,10 @@ class Courseware::Cache
   def initialize(config)
     @config = config
 
-    clone
-    update
+    unless @config[:nocache]
+      clone
+      update
+    end
   end
 
   def clone

data/lib/courseware/composer.rb

@@ -53,7 +53,7 @@ class Courseware::Composer
 
     subject ||= Courseware.choose_variant
     subject   = subject.to_s
-    content   = JSON.parse(File.read(subject))
+    content   = Courseware.parse_showoff(subject)
     variant   = File.basename(subject, '.json')
     current   = @repository.current(@coursename)
 
@@ -69,13 +69,18 @@ class Courseware::Composer
     FileUtils.cp subject, "build/#{variant}/showoff.json"
 
     content['sections'].each do |section|
-      path  = section['include']
-      next if path.nil?
+      if section.is_a? Hash
+        path = section['include']
+      else
+        path = section
+      end
 
       dir   = File.dirname path
       FileUtils.mkdir_p "build/#{variant}/#{dir}"
       FileUtils.cp path, "build/#{variant}/#{path}"
 
+      next unless section.is_a? Hash
+
       files = JSON.parse(File.read(path))
       files.each do |file|
         FileUtils.cp "#{dir}/#{file}", "build/#{variant}/#{dir}/#{file}"

data/lib/courseware/dummy.rb

@@ -1,4 +1,21 @@
 class Courseware::Dummy
+  attr_reader :coursename, :prefix
+
+  def initialize(config, repository=nil, generator=nil, printer=nil)
+    @config     = config
+
+    showoff     = Courseware.parse_showoff(@config[:presfile])
+    @coursename = showoff['name']
+    @prefix     = showoff['name'].gsub(' ', '_')
+    @sections   = showoff['sections']
+    @password   = showoff['key']
+    @current    = showoff['courseware_release']
+  end
+
+  def current(prefix)
+    @current
+  end
+
   def method_missing(meth, *args, &block)
     raise "Cannot call #{meth} without a working courseware repository"
   end

data/lib/courseware/manager/validators.rb

@@ -32,7 +32,8 @@ class Courseware::Manager
     sections = @sections.dup
 
     # This seems backwards, but we do it this way to get a case sensitive match
-    Dir.glob('**/*.md') do |file|
+    # http://stackoverflow.com/questions/357754/can-i-traverse-symlinked-directories-in-ruby-with-a-glob -- Baby jesus is crying.
+    Dir.glob("**{,/*/**}/*.md") do |file|
       sections.delete(file)
     end
     return if sections.empty?

data/lib/courseware/repository.rb

@@ -3,9 +3,10 @@ require 'rubygems'
 class Courseware::Repository
 
   def initialize(config)
-    raise 'This is not a courseware repository' unless Courseware::Repository.repository?
     @config = config
+    return if @config[:nocache]
 
+    raise 'This is not a courseware repository' unless Courseware::Repository.repository?
     configure_courseware
   end
 

data/lib/courseware/utils.rb

@@ -90,12 +90,20 @@ class Courseware
   # TODO: I'm not happy with this being here, but I don't see a better place for it just now
   def self.parse_showoff(filename)
     showoff    = JSON.parse(File.read(filename))
-    sections   = showoff['sections'].map do |entry|
-      next entry if entry.is_a? String
-      next nil unless entry.is_a? Hash
-      next nil unless entry.include? 'include'
+    sections   = showoff['sections'].map do |entry, section|
+      next entry if entry.is_a? String and section.nil?
+
+      if entry.is_a? Hash
+        file = entry['include']
+      else
+        file = section
+      end
+
+      unless file
+        puts "Malformed entry: #{entry.inspect} - #{section.inspect}"
+        next nil
+      end
 
-      file = entry['include']
       path = File.dirname(file)
       data = JSON.parse(File.read(file))
 

data/lib/courseware/version.rb

@@ -1,4 +1,4 @@
 class Courseware
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-courseware-manager
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mdl
@@ -65,21 +65,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.txt
-- README.txt
 - LICENSE
+- README.txt
 - bin/courseware
+- lib/courseware.rb
 - lib/courseware/cache.rb
 - lib/courseware/composer.rb
 - lib/courseware/dummy.rb
 - lib/courseware/generator.rb
 - lib/courseware/help.rb
-- lib/courseware/manager/validators.rb
 - lib/courseware/manager.rb
+- lib/courseware/manager/validators.rb
 - lib/courseware/printer.rb
 - lib/courseware/repository.rb
 - lib/courseware/utils.rb
 - lib/courseware/version.rb
-- lib/courseware.rb
 homepage: http://github.com/puppetlabs/courseware-manager
 licenses:
 - Apache-2.0
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Manage the development lifecycle of Puppet courseware. Not for general consumption.