puppet-courseware-manager 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e5f648ab76b06e7ed35d6d4c39494a234373eeb
-  data.tar.gz: ef0ce0e41aba93367e57d0b459cd38c1f54ea38d
+  metadata.gz: 36a9e74fc4e32ff8eba79b73b7fda4eee3e6b6d8
+  data.tar.gz: 6896d7dad5206c44fdef7e251e0f35b132f2a2e8
 SHA512:
-  metadata.gz: c2355ef7dd7a4d924e16fe62f70c053d18c88304d7d13a338274f07dd4b40f2b3abadae4d81c1d6c627645696835b2e1ab71d4fa93d9e35878eb8ce236fb1062
-  data.tar.gz: ea1525e76dd59d35fd130d54b3925c52958d80e3a7489e3962556b24846c3d88014f666f9a902e3f6e7673463ea3394cb4d1dac57736d9996da7a010276520c9
+  metadata.gz: f088969a94f5d90a9a9954bc301731a51f0d40e8e05493a3964cedb61ed67730bb0da0ebd7557d0ab84073d64807eadf6ce84bee4bf902c05d9a6cc1fb493c23
+  data.tar.gz: e75e95efd177e911c26288e386b0fbaf532dd0cfa497c5436778916fdbac88d1125d9e77c1d99f158c78ce353e75cc7d6285c46a92562d2e558847517da38e69

data/CHANGELOG.txt

@@ -1,6 +1,14 @@
 # Courseware Manager
 ## Release Notes
 
+### v0.6.0
+* Can now work with topic directories.
+* Knows how to identify obsolete slides and images across all courses.
+* Smarter use of `showoff info` to find which files are in use.
+* Can package course variants containing only the files & images in use.
+* Default to `no` when making irreversible changes to the repo.
+
+
 ### v0.5.4
 * When running non-interactively and a default is provided, don't prompt for input.
 

data/README.txt

@@ -42,14 +42,15 @@ DESCRIPTION
       Runs validation checks on the presentation. Defaults to running all the checks.
 
       Validators:
-          obsolete: Lists all unreferenced images and slides. This reference checks
-                    all slides and all CSS stylesheets. Case sensitive.
+          obsolete: Lists all unreferenced images and slides. This reference checks all
+                    slides and all CSS stylesheets. This validation is case sensitive
+                    and should be run from the toplevel courseware root directory.
 
-           missing: Lists all slides that are missing. Note that this does not check
-                    for missing image files yet. Case sensitive.
+           missing: Lists all slides and images that are missing. This validation is case
+                    sensitive and should be run from within an individual course directory.
 
               lint: Runs a markdown linter on each slide file, using our own style
-                    definition.
+                    definition. This should be run within a course directory.
 
 
   * release [type]

data/bin/courseware

@@ -86,10 +86,14 @@ config[:pdf][:license]        ||= nil
 config[:release]              ||= {}
 config[:release][:links]      ||= []
 
-# Validating obsolete slides is special because we have to load all variants;
+# Validating obsolete slides is special because we have to load all courses;
 # nonetheless, we do need *something* valid there, so drop in a dummy value.
 if ARGV == ['validate', 'obsolete']
+  config[:presfile] ||= :none
+
+elsif ARGV.first == 'compose'
   config[:presfile] ||= 'showoff.json'
+
 else
   config[:presfile] ||= Courseware.choose_variant
 end
@@ -153,7 +157,7 @@ begin
     courseware.compose subject.first
 
   when :package
-    courseware.package subject.first
+    courseware.package config[:presfile]
 
   when :shell
     courseware.debug

data/lib/courseware/composer.rb

@@ -3,11 +3,12 @@ class Courseware::Composer
     @config     = config
     @repository = repository || Courseware::Repository.new(config)
 
+    return if @config[:presfile] == :none
+
     if File.exists?(@config[:presfile])
       @showoff    = JSON.parse(File.read(@config[:presfile]))
       @coursename = @showoff['name']
       @prefix     = @showoff['name'].gsub(' ', '_')
-      @sections   = @showoff['sections']
     end
   end
 
@@ -16,31 +17,27 @@ class Courseware::Composer
 
     if subject.nil?
       display_tags
-      raise "Please re-run this task with a list of tags to include."
+      raise 'Please re-run this task with a list of tags to include.'
     end
+    raise 'Please re-run this task with a list of tags to include.' unless subject.is_a? Array
+    raise 'No master section defined in `showoff.json`' unless @showoff.include? 'master'
 
-    subject.each do |tag|
-      key = "tag:#{tag}"
-      @showoff['sections'].each do |section|
-        raise 'All sections must be represented as Hashes to customize.' unless section.is_a? Hash
-
-        if section.include? key
-          raise "A section in showoff.json refers to #{section[key]}, which does not exist." unless File.exist? section[key]
-          section['include'] = section[key]
-        end
-      end
-    end
+    newsections = {}
+    @showoff['master'].each do |section|
+      next if (section['tags'] & subject).empty?
 
-    # normalize the output and trim unused tags
-    @showoff['sections'].each do |section|
-      section.select! { |k,v| k == 'include' }
+      name = section['name']
+      newsections[name] = section['content']
     end
-    @showoff['sections'].reject! { |section| section.empty? }
 
     name = Courseware.question('What would you like to call this variant?', 'custom').gsub(/\W+/, '_')
     desc = Courseware.question("Enter a customized description if you'd like:")
 
+    @showoff.delete 'tags'
+    @showoff.delete 'master'
+    @showoff['name']        = name if name
     @showoff['description'] = desc if desc
+    @showoff['sections']    = newsections
 
     File.write("#{name}.json", JSON.pretty_generate(@showoff))
     puts "Run your presentation with `showoff serve -f #{name}.json` or `rake present`"
@@ -51,61 +48,56 @@ class Courseware::Composer
     on_release!
     pristine!
 
-    subject ||= Courseware.choose_variant
-    subject   = subject.to_s
-    content   = Courseware.parse_showoff(subject)
+    content   = JSON.parse(`showoff info -jf #{subject}`)
     variant   = File.basename(subject, '.json')
     current   = @repository.current(@coursename)
 
     if variant == 'showoff'
-      variant = @prefix
       output  = @prefix
     else
       output  = "#{@prefix}-#{variant}"
     end
 
-    FileUtils.rm_rf "build/#{variant}"
-    FileUtils.mkdir_p "build/#{variant}"
-    FileUtils.cp subject, "build/#{variant}/showoff.json"
-
-    content['sections'].each do |section|
-      if section.is_a? Hash
-        path = section['include']
-      else
-        path = section
-      end
+    FileUtils.rm_rf "build/#{@prefix}"
+    FileUtils.mkdir_p "build/#{@prefix}"
+    FileUtils.cp subject, "build/#{@prefix}/showoff.json"
 
-      dir   = File.dirname path
-      FileUtils.mkdir_p "build/#{variant}/#{dir}"
-      FileUtils.cp path, "build/#{variant}/#{path}"
-
-      next unless section.is_a? Hash
+    # Copy in only the slides used
+    content['files'].each do |path|
+      FileUtils.mkdir_p "build/#{@prefix}/#{File.dirname(path)}"
+      FileUtils.cp path, "build/#{@prefix}/#{path}"
+    end
 
-      files = JSON.parse(File.read(path))
-      files.each do |file|
-        FileUtils.cp "#{dir}/#{file}", "build/#{variant}/#{dir}/#{file}"
-      end
+    # Copy in only the images used
+    content['images'].each do |path|
+      FileUtils.mkdir_p "build/#{@prefix}/#{File.dirname(path)}"
+      FileUtils.cp path, "build/#{@prefix}/#{path}"
     end
 
     # support is special
-    FileUtils.cp_r '../_support', "build/#{variant}/_support"
-    FileUtils.rm_f "build/#{variant}/_support/*.pem"
-    FileUtils.rm_f "build/#{variant}/_support/*.pub"
-    FileUtils.rm_f "build/#{variant}/_support/aws_credentials"
+    FileUtils.cp_r '../_support', "build/#{@prefix}/_support"
+    FileUtils.rm_f "build/#{@prefix}/_support/*.pem"
+    FileUtils.rm_f "build/#{@prefix}/_support/*.pub"
+    FileUtils.rm_f "build/#{@prefix}/_support/aws_credentials"
 
     # duplicate from cwd to build/variant everything not already copied
-    Dir.glob('*').each do |thing|
-      next if thing == 'build'
-      next if File.extname(thing) == '.json'
-      next if File.exist? "build/#{variant}/#{thing}"
-      FileUtils.ln_s "../../#{thing}", "build/#{variant}/#{thing}"
+    Dir.glob('**{,/*/**}/*').each do |path|
+      next if path.start_with? 'build'
+      next if path.start_with? 'stats'
+      next if path.start_with? 'pdf'
+      next if path.start_with? '_images'
+      next if path == 'user.js'
+      next if path =~ /^\w+.json$/
+      next if File.exist? "build/#{@prefix}/#{path}"
+
+      FileUtils.mkdir_p "build/#{@prefix}/#{File.dirname(path)}" unless File.directory?(path)
+      FileUtils.ln_s File.expand_path(path), "build/#{@prefix}/#{path}"
     end
 
-    system("tar -C build --dereference -czf build/#{output}-#{current}.tar.gz  #{variant}")
+    system("tar -C build --dereference -czf build/#{output}-#{current}.tar.gz  #{@prefix}")
     if Courseware.confirm("Would you like to clean up the output build directory?")
-      FileUtils.rm_rf "build/#{variant}"
+      FileUtils.rm_rf "build/#{@prefix}"
     end
-
   end
 
 private

data/lib/courseware/dummy.rb

@@ -7,7 +7,6 @@ class Courseware::Dummy
     showoff     = Courseware.parse_showoff(@config[:presfile])
     @coursename = showoff['name']
     @prefix     = showoff['name'].gsub(' ', '_')
-    @sections   = showoff['sections']
     @password   = showoff['key']
     @current    = showoff['courseware_release']
   end

data/lib/courseware/help.rb

@@ -46,16 +46,15 @@ class Courseware
               Runs validation checks on the presentation. Defaults to running all the checks.
 
               Validators:
-                  obsolete: Lists all unreferenced images and slides. This reference checks
-                            all slides and all CSS stylesheets. Case sensitive.
+                  obsolete: Lists all unreferenced images and slides. This reference checks all
+                            slides and all CSS stylesheets. This validation is case sensitive
+                            and should be run from the toplevel courseware root directory.
 
-                            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.
+                   missing: Lists all slides and images that are missing. This validation is case
+                            sensitive and should be run from within an individual course directory.
 
                       lint: Runs a markdown linter on each slide file, using our own style
-                            definition.
+                            definition. This should be run within a course directory.
 
           * release [type]
               Orchestrate a courseware release. Defaults to `point`.

data/lib/courseware/manager.rb

@@ -15,10 +15,11 @@ class Courseware::Manager
     @warnings   = 0
     @errors     = 0
 
+    return if @config[:presfile] == :none
+
     showoff     = Courseware.parse_showoff(@config[:presfile])
     @coursename = showoff['name']
     @prefix     = showoff['name'].gsub(' ', '_')
-    @sections   = showoff['sections']
     @password   = showoff['key']
   end
 
@@ -55,13 +56,13 @@ class Courseware::Manager
     version = Courseware.increment(@repository.current(@coursename), type)
     Courseware.bailout?("Building a release for #{@coursename} version #{version}.")
 
-    raise "Release notes not updated for #{version}" unless Courseware.grep(version, 'Release-Notes.md')
+    raise "Release notes not updated for #{version}" if Dir.glob('Release-Notes*').select { |path| Courseware.grep(version, path) }.empty?
 
     Courseware.dialog('Last Repository Commit', @repository.last_commit)
     Courseware.bailout?('Abort now if the commit message displayed is not what you expected.')
     build_pdfs(version)
     point_of_no_return
-    Courseware.bailout?('Please inspect the generated PDF files and abort if corrections must be made.') do
+    Courseware.bailout?('Please inspect the generated PDF files and abort if corrections must be made.', true) do
       @repository.discard(@config[:stylesheet])
     end
 

data/lib/courseware/manager/validators.rb

@@ -1,51 +1,99 @@
 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
+    toplevel!
 
-    puts "Obsolete images:"
-    Dir.glob('**/_images/*') do |file|
-      next if File.symlink? file
-      next if File.directory? file
-      next if system("grep #{file} *.css */*.md >/dev/null 2>&1")
+    allslides = Dir.glob('_content/**/*.md')
+    allimages = Dir.glob('_images/**/*').reject {|path| path.include? '_images/src' }
+    slides    = []
+    images    = []
 
-      puts "  * #{file}"
-      @warnings += 1
+    Dir.glob('*').each do |path|
+      next if path == 'spec'
+      next if path.start_with? '_'
+      next unless File.directory? path
+
+      print "Validating #{path}."
+
+      # stuff presentation local slides & images into the collections of available content
+      allslides.concat Dir.glob("#{path}/**/*.md").reject {|file| file.include?('README.md')      ||
+                                                                  file.include?('_notes')         ||
+                                                                  File.dirname(file) == path }
+
+      allimages.concat Dir.glob("#{path}/_images/**/*").reject {|file| file.include?('README.md') ||
+                                                                       file.include?('src/')      ||
+                                                                       File.directory?(file) }
+
+      Dir.chdir(path) do
+        Dir.glob('*.json').each do |filename|
+          # determine which slides and images are actually used
+          content = JSON.parse(`showoff info -jf #{filename}`)
+          lslides = content['files'].map do |slide|
+            slide.start_with?('_') ? slide.sub('_shared', '_content') : "#{path}/#{slide}"
+          end
+          limages = content['images'].map do |image|
+            image.start_with?('_images/shared') ? image.sub('_images/shared', '_images') : "#{path}/#{image}"
+          end
+
+          slides.concat(lslides)
+          images.concat(limages)
+
+          print '.'
+        end
+        puts
+      end
     end
 
-    puts "Obsolete slides:"
-    Dir.glob('**/*.md') do |file|
-      next if File.symlink? file
-      next if File.directory? file
-      next if file =~ /^_.*$|^[^\/]*$/
-      next if allsections.include? file
+    # remove the intersection, and what's left over is obsolete
+    obs_slides = (allslides - slides.uniq!)
+    obs_images = (allimages - images.uniq!)
+
+    puts "Obsolete slides:" unless obs_slides.empty?
+    obs_slides.each do |slide|
+      puts "  * #{slide}"
+      @warnings += 1
+    end
 
-      puts "  * #{file}"
+    puts "Obsolete images:" unless obs_images.empty?
+    obs_images.each do |image|
+      puts "  * #{image}"
       @warnings += 1
     end
   end
 
   def missing
-    sections = @sections.dup
+    courselevel!
+
+    filename = @config[:presfile]
+    content  = JSON.parse(`showoff info -jf #{filename}`)
+    sections = content['files']
+    images   = content['images']
 
-    # This seems backwards, but we do it this way to get a case sensitive match
+    # This seems backwards, but we do it this way to get a case sensitive match on a case-insensitive-preserving filesystem
     # 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?
+    Dir.glob("_images/**{,/*/**}/*") do |file|
+      images.delete(file)
+    end
 
-    puts "Missing slides:"
+    puts "Missing slides:" unless sections.empty?
     sections.each do |slide|
       puts "  * #{slide}"
       @errors += 1
     end
+
+    puts "Missing images:" unless images.empty?
+    images.each do |slide|
+      puts "  * #{slide}"
+      @errors += 1
+    end
   end
 
   def lint
+    courselevel!
+
     puts "Checking Markdown style:"
     style  = File.join(@config[:cachedir], 'templates', 'markdown_style.rb')
     style  = File.exists?(style) ? style : 'all'

data/lib/courseware/utils.rb

@@ -35,9 +35,15 @@ class Courseware
     answers.include? STDIN.gets.strip.downcase
   end
 
-  def self.bailout?(message)
-    print "#{message} Continue? [Y/n]: "
-    unless [ 'y', 'yes', '' ].include? STDIN.gets.strip.downcase
+  def self.bailout?(message, required=false)
+    if required
+      print "#{message} Continue? [y/N]: "
+      options = ['y', 'yes']
+    else
+      print "#{message} Continue? [Y/n]: "
+      options = [ 'y', 'yes', '']
+    end
+    unless options.include? STDIN.gets.strip.downcase
       if block_given?
         yield
       end
@@ -83,10 +89,12 @@ class Courseware
 
   def self.choose_variant
     variants = Dir.glob('*.json')
-    maxlen   = variants.max { |x,y| x.size <=> y.size }.size - 4 # accomodate for the extension we're stripping
-
+    return :none if variants.empty?
     return 'showoff.json' if variants == ['showoff.json']
 
+    maxlen = variants.max { |x,y| x.size <=> y.size }.size - 4 # accomodate for the extension we're stripping
+
+
     # Ensures that the default `showoff.json` is listed first
     variants.unshift "showoff.json"
     variants.uniq!
@@ -103,31 +111,9 @@ 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
+  # TODO: we could use some validation here
   def self.parse_showoff(filename)
-    showoff    = JSON.parse(File.read(filename))
-    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
-
-      path = File.dirname(file)
-      data = JSON.parse(File.read(file))
-
-      data.map { |source| "#{path}/#{source}" }
-    end.flatten.compact
-    showoff['sections'] = sections
-
-    return showoff
+    JSON.parse(File.read(filename))
   end
 
   def self.get_component(initial)

data/lib/courseware/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-courseware-manager
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mdl
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: word_wrap
   requirement: !ruby/object:Gem::Requirement