puppet-courseware-manager 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e135fcbc76fc11962651ceef46e571a9c5da544b
-  data.tar.gz: 04f2a882f9c12822ed9f6a865479dab8443c4a22
+  metadata.gz: 920d9ead0c7f53930949fc216271fd862730d3af
+  data.tar.gz: eacf4a3bfa5f1f90ff38e5eb1d67a80c660101a3
 SHA512:
-  metadata.gz: f97ddc37a246bc5fc92dce8b2f979e9b9d264b077211ca0f12db645cdee487406b55eb4e3997e64155fd573c47ea890088e4f9983e225dd77ffeb62cc7c06fdb
-  data.tar.gz: bc0af0f84e9f0c4fb59069d792656003700e064529dacad54a001ce55c95e8761762b51511670edf96fab4aa9ffe3cbabadd35545cb7faa96425d21153fd2497
+  metadata.gz: cb0b92b90e8221ca981d913a0db22c399baaf7b20b82e7b9970018d2df010ddfc6ce16d7316100596c24e2f9c19493d369a4436085ec762e01f42712bf6884e5
+  data.tar.gz: 3f17f6a5c3cf8977124686a9de48cefb8837129c6c3f63b54ad42c3ef4e2174415caa7b5829f80a27a33fcbbf018ad0441bf55e07ec866b551e1ea4c0daa5883

data/CHANGELOG.txt

@@ -1,6 +1,11 @@
 # Courseware Manager
 ## Release Notes
 
+### v0.5.1
+* Support modular presentations
+* Allow watermarked PDF files via metadata in showoff
+* Open file storage links during release process
+
 ### v0.5.0 (Public release)
 * First public release
     * Not for general consumption, merely for ease of distribution.

data/bin/courseware

@@ -27,6 +27,10 @@ optparse = OptionParser.new { |opts|
         cmdlineopts[:renderer] = opt.to_sym
     end
 
+    opts.on("-f", "--file FILE", "Presentation file. Defaults to 'showoff.json'.") do |opt|
+        cmdlineopts[:presfile] = opt
+    end
+
     opts.on("-d", "--debug", "Display debugging messages") do
         cmdlineopts[:debug] = true
     end
@@ -56,7 +60,6 @@ config.merge!(cmdlineopts)
 config[:templates]            ||= 'git@github.com:puppetlabs/courseware-templates.git'
 config[:cachedir]             ||= '~/.courseware'
 config[:stylesheet]           ||= 'courseware.css'
-config[:presfile]             ||= 'showoff.json'
 config[:renderer]             ||= :wkhtmltopdf
 config[:output]               ||= 'pdf'
 config[:collector]            ||= 'http://puppetlabs.com/training/issues?s='
@@ -71,6 +74,16 @@ config[:pdf][:password]       ||= 'default'
 config[:pdf][:protected]      ||= true
 config[:pdf][:watermark]      ||= false
 config[:pdf][:license]        ||= nil
+config[:release]              ||= {}
+config[:release][:links]      ||= []
+
+# Validating obsolete slides is special because we have to load all variants;
+# nonetheless, we do need *something* valid there, so drop in a dummy value.
+if ARGV == ['validate', 'obsolete']
+  config[:presfile] ||= 'showoff.json'
+else
+  config[:presfile] ||= Courseware.choose_variant
+end
 
 # expand out all path shortcuts in one single place.
 [ :cachedir ].each do |path|

data/lib/courseware.rb

@@ -45,7 +45,6 @@ class Courseware
       :course  => @manager.coursename,
       :prefix  => @manager.prefix,
       :version => @repository.current(@manager.prefix),
-      :variant => Courseware.choose_variant,
     }
     Courseware::Printer.new(@config, opts) do |printer|
       subject.each do |item|

data/lib/courseware/help.rb

@@ -49,6 +49,8 @@ class Courseware
                   obsolete: Lists all unreferenced images and slides. This reference checks
                             all slides and all CSS stylesheets. Case sensitive.
 
+                            Note: This validator will validate all course variants.
+
                    missing: Lists all slides that are missing. Note that this does not check
                             for missing image files yet. Case sensitive.
 

data/lib/courseware/manager.rb

@@ -15,12 +15,11 @@ class Courseware::Manager
     @warnings   = 0
     @errors     = 0
 
-    if File.exists?(@config[:presfile])
-      showoff     = JSON.parse(File.read(@config[:presfile]))
-      @coursename = showoff['name']
-      @prefix     = showoff['name'].gsub(' ', '_')
-      @sections   = showoff['sections']
-    end
+    showoff     = Courseware.parse_showoff(@config[:presfile])
+    @coursename = showoff['name']
+    @prefix     = showoff['name'].gsub(' ', '_')
+    @sections   = showoff['sections']
+    @password   = showoff['key']
   end
 
   def releasenotes
@@ -68,6 +67,12 @@ class Courseware::Manager
 
     @repository.commit(@config[:stylesheet], "Updating for #{@coursename} release #{version}")
     @repository.tag("#{@prefix}-#{version}", "Releasing #{@coursename} version #{version}")
+
+    # places the PDF files should be uploaded to
+    @config[:release][:links].each do |link|
+      system("open #{link}")
+    end
+
     puts "Release shipped. Please upload PDF files to printer and break out the bubbly."
   end
 
@@ -122,7 +127,6 @@ private
       :course  => @coursename,
       :prefix  => @prefix,
       :version => version,
-      :variant => Courseware.choose_variant,
     }
   end
 

data/lib/courseware/manager/validators.rb

@@ -1,6 +1,11 @@
 class Courseware::Manager
 
   def obsolete
+    # We need to get all slides from all variants to determine what's obsolete.
+    allsections = Dir.glob('*.json').collect do |variant|
+      Courseware.parse_showoff(variant)['sections'] rescue nil
+    end.flatten.uniq
+
     puts "Obsolete images:"
     Dir.glob('**/_images/*') do |file|
       next if File.symlink? file
@@ -16,7 +21,7 @@ class Courseware::Manager
       next if File.symlink? file
       next if File.directory? file
       next if file =~ /^_.*$|^[^\/]*$/
-      next if @sections.include? file
+      next if allsections.include? file
 
       puts "  * #{file}"
       @warnings += 1

data/lib/courseware/printer.rb

@@ -6,18 +6,19 @@ class Courseware::Printer
     @course  = opts[:course]  or raise 'Course is a required option'
     @prefix  = opts[:prefix]  or raise 'Prefix is a required option'
     @version = opts[:version] or raise 'Version is a required option'
-    @varfile = opts[:variant] or raise 'Variant is a required option'
+    raise unless can_print?
 
+    @varfile = config[:presfile] or raise 'Presentation file is not set properly!'
     @variant = File.basename(@varfile, '.json') unless @varfile == 'showoff.json'
 
-    raise unless can_print?
-
     @pdfopts = "--pdf-title '#{@course}' --pdf-author '#{@config[:pdf][:author]}' --pdf-subject '#{@config[:pdf][:subject]}'"
     @pdfopts << " --disallow-modify" if @config[:pdf][:protected]
 
     if @config[:pdf][:watermark]
-      @event_id        = Courseware.question('Enter the Event ID:')
-      @password        = Courseware.question('Enter desired password:', (@event_id[/-?(\w*)$/, 1] rescue nil))
+      showoff          = Courseware.parse_showoff(@config[:presfile])
+
+      @event_id        = showoff['event_id'] || Courseware.question('Enter the Event ID:')
+      @password        = showoff['key']      || Courseware.question('Enter desired password:', (@event_id[/-?(\w*)$/, 1] rescue nil))
       @watermark_style = File.join(@config[:cachedir], 'templates', 'watermark.css')
       @watermark_pdf   = File.join(@config[:cachedir], 'templates', 'watermark.pdf')
     end
@@ -123,7 +124,7 @@ class Courseware::Printer
     begin
       # Until showoff static knows about -f, we have to schlup around files
       if @variant
-        FileUtils.mv 'showoff.json', 'showoff.json.tmp'
+        FileUtils.mv 'showoff.json', '.showoff.json.tmp'
         FileUtils.cp @varfile, 'showoff.json'
       end
 
@@ -134,7 +135,7 @@ class Courseware::Printer
         FileUtils.cp('cobrand.png', File.join('static', 'image', 'cobrand.png'))
       end
     ensure
-      FileUtils.mv('showoff.json.tmp', 'showoff.json') if File.exist? 'showoff.json.tmp'
+      FileUtils.mv('.showoff.json.tmp', 'showoff.json') if File.exist? '.showoff.json.tmp'
     end
   end
 

data/lib/courseware/utils.rb

@@ -87,6 +87,25 @@ class Courseware
     variants[idx]
   end
 
+  # 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'
+
+      file = entry['include']
+      path = File.dirname(file)
+      data = JSON.parse(File.read(file))
+
+      data.map { |source| "#{path}/#{source}" }
+    end.flatten.compact
+    showoff['sections'] = sections
+
+    return showoff
+  end
+
   def self.get_component(initial)
     puts 'The component ID for this course can be found at:'
     puts ' * https://tickets.puppetlabs.com/browse/COURSES/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel'

data/lib/courseware/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-courseware-manager
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-01 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mdl