puppet-courseware-manager 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36a9e74fc4e32ff8eba79b73b7fda4eee3e6b6d8
-  data.tar.gz: 6896d7dad5206c44fdef7e251e0f35b132f2a2e8
+  metadata.gz: 437863d336c96a49cb06d1408f8adeb5596dfc08
+  data.tar.gz: 6c372f7ec27c63a6e3986c44a6bc38466effcf85
 SHA512:
-  metadata.gz: f088969a94f5d90a9a9954bc301731a51f0d40e8e05493a3964cedb61ed67730bb0da0ebd7557d0ab84073d64807eadf6ce84bee4bf902c05d9a6cc1fb493c23
-  data.tar.gz: e75e95efd177e911c26288e386b0fbaf532dd0cfa497c5436778916fdbac88d1125d9e77c1d99f158c78ce353e75cc7d6285c46a92562d2e558847517da38e69
+  metadata.gz: 0e6f9934a4e590a0504491f52fdd10e142da58e67a6b7327fb98c6302b8da75aacde5c1dfc426eb460c9de21b2271672ece630aa1c5a16a3c38c3be359a11f38
+  data.tar.gz: 56dad38430244340e114f54df83e1aad599858dda115cafb6a58c23d78a4e48780154f4e22726b84a3ca3667f63159b2557f485789d307fe89b517dc5870ae90

data/CHANGELOG.txt

@@ -1,6 +1,13 @@
 # Courseware Manager
 ## Release Notes
 
+### v0.6.1
+* Generate release notes for shared content
+* Allow different schemes for different git remotes
+* More robust printing options, such as key/id CLI args
+* Catch empty PDF files when printing shared content
+
+
 ### v0.6.0
 * Can now work with topic directories.
 * Knows how to identify obsolete slides and images across all courses.

data/bin/courseware

@@ -39,6 +39,14 @@ optparse = OptionParser.new { |opts|
         cmdlineopts[:nocache] = true
     end
 
+    opts.on("-e ID", "--event-id ID", "Event ID to use for generated PDF files") do |opt|
+        cmdlineopts[:event_id] = opt
+    end
+
+    opts.on("-k KEY", "--key KEY", "Key to encrypt PDF files with") do |opt|
+        cmdlineopts[:key] = opt
+    end
+
     opts.on("-d", "--debug", "Display debugging messages") do
         cmdlineopts[:debug] = true
     end

data/lib/courseware/printer.rb

@@ -16,13 +16,23 @@ class Courseware::Printer
 
     if @config[:pdf][:watermark]
       showoff   = Courseware.parse_showoff(@config[:presfile])
+      default   = @event_id[/-?(\w*)$/, 1] rescue nil
 
-      @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))
+      @event_id = @config[:event_id] || showoff['event_id'] || Courseware.question('Enter the Event ID:')
+      @password = @config[:key]      || showoff['key']      || Courseware.question('Enter desired password:', default)
 
       if @config[:nocache]
-        @watermark_style = File.join('_support', 'watermark.css')
-        @watermark_pdf   = File.join('_support', 'watermark.pdf')
+        # Find the '_support' directory, up to three levels up
+        # This allows some flexibility in how the courseware repository is laid out
+        path = '_support'
+        3.times do
+          break if File.exist?(path)
+          path = File.join('..', path)
+        end
+        raise "No support files found" unless File.directory?(path)
+
+        @watermark_style = File.join(path, 'watermark.css')
+        @watermark_pdf   = File.join(path, 'watermark.pdf')
       else
         @watermark_style = File.join(@config[:cachedir], 'templates', 'watermark.css')
         @watermark_pdf   = File.join(@config[:cachedir], 'templates', 'watermark.pdf')
@@ -178,7 +188,8 @@ class Courseware::Printer
       system(*command.flatten)
       raise 'Error generating PDF files' unless $?.success?
 
-      if `pdftk #{output} dump_data | grep NumberOfPages`.chomp == 'NumberOfPages: 1'
+      pagecount = `pdftk #{output} dump_data`.each_line.select {|l| l.match /NumberOfPages/ }.first.split.last.to_i rescue nil
+      if [1, 2].include? pagecount
         puts "#{output} is empty; aborting and cleaning up."
         FileUtils.rm(output)
         return

data/lib/courseware/repository.rb

@@ -105,10 +105,29 @@ class Courseware::Repository
   end
 
   def releasenotes(last, version)
+    # get used files from showoff and combine them into a single array
+    used = JSON.parse(`showoff info --json`).values.reduce(:+)
+    logs = `git log --name-only --no-merges --pretty="format:* (%h) %s [%aN]" #{last}..HEAD`
+    curr = nil
+    keep = []
+
+    # sanitize
+    used.map! {|i| i.sub('_shared', '_content') }
+    used.map! {|i| i.sub('_images/shared', '_images') }
+
+    # now iterate through and select log entries that change files this presentation uses
+    logs.each_line do |line|
+      if (curr.nil? or line.start_with? '*')
+        curr = line
+      else
+        keep << curr if used.include? line.strip
+      end
+    end
+
     str = "### #{version}\n"
     str << "{{{Please summarize the release here}}}\n"
     str << "\n"
-    str << `git log --no-merges --pretty="format:* (%h) %s [%aN]" #{last}..HEAD -- .`
+    str << keep.uniq.join
     str
   end
 
@@ -126,25 +145,24 @@ class Courseware::Repository
 private
 
   def configure_courseware
-    courseware = "#{@config[:github][:public]}/#{@config[:github][:repository]}"
-    upstream   = "#{@config[:github][:development]}/#{@config[:github][:repository]}"
+    check_remote('courseware', "#{@config[:github][:public]}/#{@config[:github][:repository]}")
+    check_remote('upstream',   "#{@config[:github][:development]}/#{@config[:github][:repository]}")
+  end
 
-    # Check the origin to see which scheme we should use
-    origin = `git config --get remote.origin.url`.chomp
-    if origin =~ /^(git@|https:\/\/)github.com[:\/].*\/#{@config[:github][:repository]}(?:-.*)?(?:.git)?$/
+  def check_remote(remote, url)
+    existing = `git config --get remote.#{remote}.url`.chomp
+    if existing =~ /^(git@|https:\/\/)github.com[:\/].*\/#{@config[:github][:repository]}(?:-.*)?(?:.git)?$/
       case $1
       when 'git@'
-        ensure_remote('courseware', "git@github.com:#{courseware}.git")
-        ensure_remote('upstream',   "git@github.com:#{upstream}.git")
+        ensure_remote(remote, "git@github.com:#{url}.git")
       when 'https://'
-        ensure_remote('courseware', "https://github.com/#{courseware}.git")
-        ensure_remote('upstream',   "https://github.com/#{upstream}.git")
+        ensure_remote(remote, "https://github.com/#{url}.git")
       end
-    elsif origin.empty?
+    elsif existing.empty?
       $logger.warn 'Your origin remote is not set properly.'
       $logger.warn 'Generating PDF files and other local operations will work properly, but many repository actions will fail.'
     else
-      raise "Your origin (#{origin}) does not appear to be configured correctly."
+      raise "Your remote (#{existing}) does not appear to be configured correctly."
     end
   end
 

data/lib/courseware/version.rb

@@ -1,4 +1,4 @@
 class Courseware
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-courseware-manager
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-06 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mdl