puppet-courseware-manager 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e135fcbc76fc11962651ceef46e571a9c5da544b
+  data.tar.gz: 04f2a882f9c12822ed9f6a865479dab8443c4a22
+SHA512:
+  metadata.gz: f97ddc37a246bc5fc92dce8b2f979e9b9d264b077211ca0f12db645cdee487406b55eb4e3997e64155fd573c47ea890088e4f9983e225dd77ffeb62cc7c06fdb
+  data.tar.gz: bc0af0f84e9f0c4fb59069d792656003700e064529dacad54a001ce55c95e8761762b51511670edf96fab4aa9ffe3cbabadd35545cb7faa96425d21153fd2497

data/CHANGELOG.txt

@@ -0,0 +1,60 @@
+# Courseware Manager
+## Release Notes
+
+### v0.5.0 (Public release)
+* First public release
+    * Not for general consumption, merely for ease of distribution.
+* Enable printing of new style instructor guide.
+* Enable printing of course variants
+* Bugfix: corrected printing regression introduced in v0.4.0
+
+### v0.4.0
+* Can now generate custom courses via the `compose` action
+    * requires Showoff >= v0.15.2
+    * requires specific as-yet undocumented form of `showoff.json`
+    * `rake present` allows instructor to choose variant
+* Can now package standalone presentations as a tarball
+    * Defaults to main presentation
+    * Can package any variant
+    * Includes all assets other than certificates
+* Adds wordcount functionality
+    * Converts presentation to plain text and counts words > 1 character
+
+### v0.3.2
+* Better validation for missing slides
+* Check for the mdl Markdown linter
+* More thorough git remote validation
+* Made versioning more consistent.
+
+### v0.3.1
+* Properly handle x.x.1 releases again.
+* Simplify PDF passwords.
+    * uses just the last 4 of the longer event IDs
+    * writes the full event ID into the PDF subject field
+
+### v0.3.0
+* This adopts the new EDU release numbering scheme. See `courseware help`
+  for information on release types.
+
+### v0.2.5
+* corrected printing with Prince
+* fetch tags to reduce chances of double releasing a version
+
+### v0.2.4
+* Rebranding name change.
+* Don't generate empty PDF files.
+
+### v0.2.3
+* Improve docs slightly.
+* Simplify release notes generator.
+
+### v0.2.2
+* Added Rakefile generator.
+
+### v0.2.1
+* Enabled content copying.
+
+### v0.2.0
+* Port to wkhtmltopdf.
+* Abstracted renderer, can use either Prince or wkhtmltopdf.
+* Behaviour change, so minor rev bump.

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.txt

@@ -0,0 +1,100 @@
+                     Courseware Manager
+
+SYNOPSIS
+  courseware [-c CONFIG] [-d] <verb> [subject] [subject] ...
+
+DESCRIPTION
+  Manage the development lifecycle of Puppet courseware. This tool is not
+  required for presenting the material or for contributing minor updates.
+
+  The following verbs are recognized:
+
+  * print
+      Render course material as PDF files. This verb accepts one or more of the
+      following arguments, where the default is all.
+
+      Arguments (optional):
+         handouts: Generate handout notes
+        exercises: Generate the lab exercise manual
+        solutions: Generate the solution guide
+            guide: Generate the instructor guide
+
+  * watermark
+      Render watermarked PDF files. Accepts same arguments as the `print` verb.
+
+  * generate or update
+      Build new or update certain kinds of configuration. By default, this will
+      update the stylesheet.
+
+      Arguments (optional):
+        skeleton <name>: Build a new course directory named <name> and generate
+                         required metadata for a Showoff presentation.
+
+                 config: Write current configuration to a `courseware.yaml` file.
+
+                 styles: Generate or update the stylesheet for the current version.
+
+                  links: Ensure that all required symlinks are in place.
+
+               metadata: Interactively generate or update the `showoff.json` file.
+
+  * validate [check]
+      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.
+
+           missing: Lists all slides that are missing. Note that this does not check
+                    for missing image files yet. Case sensitive.
+
+              lint: Runs a markdown linter on each slide file, using our own style
+                    definition.
+
+
+  * release [type]
+      Orchestrate a courseware release. Defaults to `point`.
+
+      All instructors are expected to deliver the most current point release, except
+      in extraordinary cases. We follow Semver, as closely as it can be adapted to
+      classroom usage. Instructors can trust that updates with high potential to cause
+      classroom disruptions will never make it into a point release.
+
+                               http://semver.org
+
+      Release types:
+              major: This is a major release with "breaking" changes, such as a major
+                     product update, or significant classroom workflow changes. This
+                     is not necessarily tied to product releases. Instructors should
+                     expect to spend significant time studying the new material thoroughly.
+
+              minor: This indicates a significant change in content. Instructors
+                     should take extra time to review updates in minor releases.
+                     The release cadence is roughly once a quarter, give or take.
+
+              point: Release early and release often. Changes made in the regular
+                     maintenance cycle will typically fit into this category.
+
+              notes: Display release notes since last release and copy to clipboard.
+
+  * wordcount [type]
+      Display a simple wordcount of one or more content types.
+
+      Arguments (optional):
+         handouts: Counts words in the student handout guide
+        exercises: Counts words in the lab exercise manual
+        solutions: Counts words in the solution guide
+
+  * compose [comma,separated,list,of,tags]
+      Generates a variant of the complete course, using tags defined in `showoff.json`.
+      The practical effect of this action is to generate a new presentation `.json` file,
+      which can be displayed directly by passing the `-f` flag to Showoff, or by choosing
+      a variant in the classroom `rake present` task.
+
+  * package [variant.json]
+      Package up a standalone form of a given variant of the presentation. You can pass
+      in a `variant.json` file, or choose from a menu. Tarballs will be saved into the
+      `build` directory and you can optionally retain the full working directory.
+
+  * help
+      You're looking at it.

data/bin/courseware

@@ -0,0 +1,146 @@
+#! /usr/bin/env ruby
+require 'rubygems'
+require 'json'
+require 'optparse'
+require 'logger'
+
+require 'courseware'
+
+configfile  = 'courseware.yaml'
+cmdlineopts = {}
+optparse = OptionParser.new { |opts|
+    opts.banner = "Usage : courseware <verb> [subject] [options]
+
+        Manage the development lifecycle of Puppet courseware. This tool is not
+        required for presenting the material or for contributing minor updates.
+
+        Type courseware help for full usage instructions.
+
+"
+
+    opts.on("-c CONFIG", "--config CONFIG", "Choose an alternate configuration file. Defaults to #{configfile}") do |opt|
+        configfile = File.expand_path(opt)
+        raise ArgumentError, "No such file: #{configfile}" unless File.exists? configfile
+    end
+
+    opts.on("-r ENGINE", "--renderer ENGINE", "Choose an alternate rendering engine. (wkhtmltopdf|prince)") do |opt|
+        cmdlineopts[:renderer] = opt.to_sym
+    end
+
+    opts.on("-d", "--debug", "Display debugging messages") do
+        cmdlineopts[:debug] = true
+    end
+
+    opts.separator('')
+
+    opts.on("-v", "--version", "Print out the version") do
+        require 'courseware/version'
+        puts Courseware::VERSION
+        exit
+    end
+
+    opts.on("-h", "--help", "Displays this help") do
+        puts opts
+        exit
+    end
+}
+optparse.parse!
+
+# Search for config file. Expand path in case we're using the default unexpanded.
+config   = YAML.load_file(File.expand_path(configfile)) rescue nil
+config ||= YAML.load_file(File.expand_path('courseware.yaml')) rescue nil
+config ||= YAML.load_file(File.expand_path('../courseware.yaml')) rescue {}
+# defer to command line overrides
+config.merge!(cmdlineopts)
+# finally, apply defaults to any unset options
+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='
+config[:github]               ||= {}
+config[:github][:public]      ||= 'puppet-training'
+config[:github][:development] ||= 'puppetlabs'
+config[:github][:repository]  ||= 'courseware'
+config[:pdf]                  ||= {}
+config[:pdf][:author]         ||= 'Puppet'
+config[:pdf][:subject]        ||= 'http://learn.puppet.com'
+config[:pdf][:password]       ||= 'default'
+config[:pdf][:protected]      ||= true
+config[:pdf][:watermark]      ||= false
+config[:pdf][:license]        ||= nil
+
+# expand out all path shortcuts in one single place.
+[ :cachedir ].each do |path|
+  config[path] = File.expand_path(config[path])
+end
+
+# Log to stdout
+$logger = Logger.new(STDOUT)
+if config[:debug]
+  $logger.level = Logger::DEBUG
+else
+  $logger.level = Logger::INFO
+  $logger.formatter = proc do |severity, datetime, progname, msg|
+      "#{severity}: #{msg}\n"
+  end
+end
+
+# grab the arguments after we've scraped the options out
+verb, *subject = ARGV.collect {|arg| arg.to_sym }
+
+if verb == :help
+  require 'courseware/help'
+  Courseware.help
+  exit
+end
+
+courseware = Courseware.new(config, configfile)
+
+begin
+  case verb
+  when :print
+    subject = [:handouts, :exercises, :solutions] if subject.empty?
+    courseware.print subject
+
+  when :watermark
+    subject = [:handouts, :exercises, :solutions] if subject.empty?
+    courseware.options(:section => :pdf, :watermark => true)
+    courseware.print subject
+
+  when :generate, :update
+    subject = [:styles] if subject.empty?
+    courseware.generate subject
+
+  when :validate
+    subject = [:obsolete, :missing, :lint] if subject.empty?
+    courseware.validate subject
+
+  when :release
+    subject = [:point] if subject.empty?
+    courseware.release subject.first
+
+  when :wordcount
+    subject = [:handouts, :exercises, :solutions] if subject.empty?
+    courseware.wordcount subject
+
+  when :compose
+    subject.collect! {|tags| tags.to_s.split ',' }.flatten
+    courseware.compose subject.first
+
+  when :package
+    courseware.package subject.first
+
+  when :shell
+    courseware.debug
+
+  else
+    $logger.warn "Unknown verb: #{verb}"
+  end
+rescue RuntimeError => e
+  puts "Error: #{e.message}"
+  puts e.backtrace.join("\n\t") if config[:debug]
+  exit 1
+end