blackboard 3.1.6 → 3.1.7

data/lib/jekyll/commands/help.rb

@@ -0,0 +1,31 @@
+module Jekyll
+  module Commands
+    class Help < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:help) do |c|
+            c.syntax 'help [subcommand]'
+            c.description 'Show the help message, optionally for a given subcommand.'
+
+            c.action do |args, _|
+              cmd = (args.first || "").to_sym
+              if args.empty?
+                puts prog
+              elsif prog.has_command? cmd
+                puts prog.commands[cmd]
+              else
+                invalid_command(prog, cmd)
+                abort
+              end
+            end
+          end
+        end
+
+        def invalid_command(prog, cmd)
+          Jekyll.logger.error "Error:", "Hmm... we don't know what the '#{cmd}' command is."
+          Jekyll.logger.info  "Valid commands:", prog.commands.keys.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/new.rb

@@ -0,0 +1,82 @@
+require 'erb'
+
+module Jekyll
+  module Commands
+    class New < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:new) do |c|
+            c.syntax 'new PATH'
+            c.description 'Creates a new Jekyll site scaffold in PATH'
+
+            c.option 'force', '--force', 'Force creation even if PATH already exists'
+            c.option 'blank', '--blank', 'Creates scaffolding but with empty files'
+
+            c.action do |args, options|
+              Jekyll::Commands::New.process(args, options)
+            end
+          end
+        end
+
+        def process(args, options = {})
+          raise ArgumentError.new('You must specify a path.') if args.empty?
+
+          new_blog_path = File.expand_path(args.join(" "), Dir.pwd)
+          FileUtils.mkdir_p new_blog_path
+          if preserve_source_location?(new_blog_path, options)
+            Jekyll.logger.abort_with "Conflict:", "#{new_blog_path} exists and is not empty."
+          end
+
+          if options["blank"]
+            create_blank_site new_blog_path
+          else
+            create_sample_files new_blog_path
+
+            File.open(File.expand_path(initialized_post_name, new_blog_path), "w") do |f|
+              f.write(scaffold_post_content)
+            end
+          end
+
+          Jekyll.logger.info "New jekyll site installed in #{new_blog_path}."
+        end
+
+        def create_blank_site(path)
+          Dir.chdir(path) do
+            FileUtils.mkdir(%w(_layouts _posts _drafts))
+            FileUtils.touch("index.html")
+          end
+        end
+
+        def scaffold_post_content
+          ERB.new(File.read(File.expand_path(scaffold_path, site_template))).result
+        end
+
+        # Internal: Gets the filename of the sample post to be created
+        #
+        # Returns the filename of the sample post, as a String
+        def initialized_post_name
+          "_posts/#{Time.now.strftime('%Y-%m-%d')}-welcome-to-jekyll.markdown"
+        end
+
+        private
+
+        def preserve_source_location?(path, options)
+          !options["force"] && !Dir["#{path}/**/*"].empty?
+        end
+
+        def create_sample_files(path)
+          FileUtils.cp_r site_template + '/.', path
+          FileUtils.rm File.expand_path(scaffold_path, path)
+        end
+
+        def site_template
+          File.expand_path("../../site_template", File.dirname(__FILE__))
+        end
+
+        def scaffold_path
+          "_posts/0000-00-00-welcome-to-jekyll.markdown.erb"
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/serve.rb

@@ -0,0 +1,205 @@
+module Jekyll
+  module Commands
+    class Serve < Command
+      class << self
+        COMMAND_OPTIONS = {
+          "ssl_cert" => ["--ssl-cert [CERT]", "X.509 (SSL) certificate."],
+          "host"     => ["host", "-H", "--host [HOST]", "Host to bind to"],
+          "open_url" => ["-o", "--open-url", "Launch your browser with your site."],
+          "detach"   => ["-B", "--detach", "Run the server in the background (detach)"],
+          "ssl_key"  => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
+          "port"     => ["-P", "--port [PORT]", "Port to listen on"],
+          "baseurl"  => ["-b", "--baseurl [URL]", "Base URL"],
+          "skip_initial_build" => ["skip_initial_build", "--skip-initial-build",
+            "Skips the initial site build which occurs before the server is started."]
+        }
+
+        #
+
+        def init_with_program(prog)
+          prog.command(:serve) do |cmd|
+            cmd.description "Serve your site locally"
+            cmd.syntax "serve [options]"
+            cmd.alias :server
+            cmd.alias :s
+
+            add_build_options(cmd)
+            COMMAND_OPTIONS.each do |key, val|
+              cmd.option key, *val
+            end
+
+            cmd.action do |_, opts|
+              opts["serving"] = true
+              opts["watch"  ] = true unless opts.key?("watch")
+              Build.process(opts)
+              Serve.process(opts)
+            end
+          end
+        end
+
+        #
+
+        def process(opts)
+          opts = configuration_from_options(opts)
+          destination = opts["destination"]
+          setup(destination)
+
+          server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
+          server.mount(opts["baseurl"], Servlet, destination, file_handler_opts)
+          Jekyll.logger.info "Server address:", server_address(server, opts)
+          launch_browser server, opts if opts["open_url"]
+          boot_or_detach server, opts
+        end
+
+        # Do a base pre-setup of WEBRick so that everything is in place
+        # when we get ready to party, checking for an setting up an error page
+        # and making sure our destination exists.
+
+        private
+        def setup(destination)
+          require_relative "serve/servlet"
+
+          FileUtils.mkdir_p(destination)
+          if File.exist?(File.join(destination, "404.html"))
+            WEBrick::HTTPResponse.class_eval do
+              def create_error_page
+                @header["Content-Type"] = "text/html; charset=UTF-8"
+                @body = IO.read(File.join(@config[:DocumentRoot], "404.html"))
+              end
+            end
+          end
+        end
+
+        #
+
+        private
+        def webrick_opts(opts)
+          opts = {
+            :JekyllOptions      => opts,
+            :DoNotReverseLookup => true,
+            :MimeTypes          => mime_types,
+            :DocumentRoot       => opts["destination"],
+            :StartCallback      => start_callback(opts["detach"]),
+            :BindAddress        => opts["host"],
+            :Port               => opts["port"],
+            :DirectoryIndex     => %W(
+              index.htm
+              index.html
+              index.rhtml
+              index.cgi
+              index.xml
+            )
+          }
+
+          enable_ssl(opts)
+          enable_logging(opts)
+          opts
+        end
+
+        # Recreate NondisclosureName under utf-8 circumstance
+
+        private
+        def file_handler_opts
+          WEBrick::Config::FileHandler.merge({
+            :FancyIndexing     => true,
+            :NondisclosureName => [
+              '.ht*', '~*'
+            ]
+          })
+        end
+
+        #
+
+        private
+        def server_address(server, opts)
+          "%{prefix}://%{address}:%{port}%{baseurl}" % {
+            :prefix => server.config[:SSLEnable] ? "https" : "http",
+            :baseurl => opts["baseurl"] ? "#{opts["baseurl"]}/" : "",
+            :address => server.config[:BindAddress],
+            :port => server.config[:Port]
+          }
+        end
+
+        #
+
+        private
+        def launch_browser(server, opts)
+          command =
+            if Utils::Platforms.windows?
+              "start"
+            elsif Utils::Platforms.osx?
+              "open"
+            else
+              "xdg-open"
+            end
+          system command, server_address(server, opts)
+        end
+
+        # Keep in our area with a thread or detach the server as requested
+        # by the user.  This method determines what we do based on what you
+        # ask us to do.
+
+        private
+        def boot_or_detach(server, opts)
+          if opts["detach"]
+            pid = Process.fork do
+              server.start
+            end
+
+            Process.detach(pid)
+            Jekyll.logger.info "Server detached with pid '#{pid}'.", \
+              "Run `pkill -f jekyll' or `kill -9 #{pid}' to stop the server."
+          else
+            t = Thread.new { server.start }
+            trap("INT") { server.shutdown }
+            t.join
+          end
+        end
+
+        # Make the stack verbose if the user requests it.
+
+        private
+        def enable_logging(opts)
+          opts[:AccessLog] = []
+          level = WEBrick::Log.const_get(opts[:JekyllOptions]["verbose"] ? :DEBUG : :WARN)
+          opts[:Logger] = WEBrick::Log.new($stdout, level)
+        end
+
+        # Add SSL to the stack if the user triggers --enable-ssl and they
+        # provide both types of certificates commonly needed.  Raise if they
+        # forget to add one of the certificates.
+
+        private
+        def enable_ssl(opts)
+          return if !opts[:JekyllOptions]["ssl_cert"] && !opts[:JekyllOptions]["ssl_key"]
+          if !opts[:JekyllOptions]["ssl_cert"] || !opts[:JekyllOptions]["ssl_key"]
+            raise RuntimeError, "--ssl-cert or --ssl-key missing."
+          end
+
+          require "openssl"
+          require "webrick/https"
+          source_key = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_key" ])
+          source_certificate = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_cert"])
+          opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.read(source_certificate))
+          opts[:SSLPrivateKey ] = OpenSSL::PKey::RSA.new(File.read(source_key))
+          opts[:SSLEnable] = true
+        end
+
+        private
+        def start_callback(detached)
+          unless detached
+            proc do
+              Jekyll.logger.info("Server running...", "press ctrl-c to stop.")
+            end
+          end
+        end
+
+        private
+        def mime_types
+          file = File.expand_path('../mime.types', File.dirname(__FILE__))
+          WEBrick::HTTPUtils.load_mime_types(file)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/serve/servlet.rb

@@ -0,0 +1,61 @@
+require "webrick"
+
+module Jekyll
+  module Commands
+    class Serve
+      class Servlet < WEBrick::HTTPServlet::FileHandler
+        DEFAULTS = {
+          "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
+            "no-store, no-cache, must-revalidate"
+        }
+
+        def initialize(server, root, callbacks)
+          # So we can access them easily.
+          @jekyll_opts = server.config[:JekyllOptions]
+          set_defaults
+          super
+        end
+
+        # Add the ability to tap file.html the same way that Nginx does on our
+        # Docker images (or on GitHub Pages.) The difference is that we might end
+        # up with a different preference on which comes first.
+
+        def search_file(req, res, basename)
+          # /file.* > /file/index.html > /file.html
+          super || super(req, res, "#{basename}.html")
+        end
+
+        #
+
+        def do_GET(req, res)
+          rtn = super
+          validate_and_ensure_charset(req, res)
+          res.header.merge!(@headers)
+          rtn
+        end
+
+        #
+
+        private
+        def validate_and_ensure_charset(_req, res)
+          key = res.header.keys.grep(/content-type/i).first
+          typ = res.header[key]
+
+          unless typ =~ /;\s*charset=/
+            res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
+          end
+        end
+
+        #
+
+        private
+        def set_defaults
+          hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
+          DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|
+            hash[key] = val unless hash.key?(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/configuration.rb

@@ -0,0 +1,348 @@
+# encoding: UTF-8
+
+module Jekyll
+  class Configuration < Hash
+    # Default options. Overridden by values in _config.yml.
+    # Strings rather than symbols are used for compatibility with YAML.
+    DEFAULTS = Configuration[{
+      # Where things are
+      'source'        => Dir.pwd,
+      'destination'   => File.join(Dir.pwd, '_site'),
+      'plugins_dir'   => '_plugins',
+      'layouts_dir'   => '_layouts',
+      'data_dir'      => '_data',
+      'includes_dir'  => '_includes',
+      'collections'   => {},
+
+      # Handling Reading
+      'safe'          => false,
+      'include'       => ['.htaccess'],
+      'exclude'       => [],
+      'keep_files'    => ['.git', '.svn'],
+      'encoding'      => 'utf-8',
+      'markdown_ext'  => 'markdown,mkdown,mkdn,mkd,md',
+
+      # Filtering Content
+      'show_drafts'   => nil,
+      'limit_posts'   => 0,
+      'future'        => false,
+      'unpublished'   => false,
+
+      # Plugins
+      'whitelist'     => [],
+      'gems'          => [],
+
+      # Conversion
+      'markdown'      => 'kramdown',
+      'highlighter'   => 'rouge',
+      'lsi'           => false,
+      'excerpt_separator' => "\n\n",
+      'incremental'   => false,
+
+      # Serving
+      'detach'        => false,          # default to not detaching the server
+      'port'          => '4000',
+      'host'          => '127.0.0.1',
+      'baseurl'       => '',
+
+      # Output Configuration
+      'permalink'     => 'date',
+      'paginate_path' => '/page:num',
+      'timezone'      => nil,           # use the local timezone
+
+      'quiet'         => false,
+      'verbose'       => false,
+      'defaults'      => [],
+
+      'rdiscount' => {
+        'extensions' => []
+      },
+
+      'redcarpet' => {
+        'extensions' => []
+      },
+
+      'kramdown' => {
+        'auto_ids'       => true,
+        'toc_levels'     => '1..6',
+        'entity_output'  => 'as_char',
+        'smart_quotes'   => 'lsquo,rsquo,ldquo,rdquo',
+        'input'          => "GFM",
+        'hard_wrap'      => false,
+        'footnote_nr'    => 1
+      }
+    }.map { |k, v| [k, v.freeze] }].freeze
+
+    class << self
+      # Static: Produce a Configuration ready for use in a Site.
+      # It takes the input, fills in the defaults where values do not
+      # exist, and patches common issues including migrating options for
+      # backwards compatiblity. Except where a key or value is being fixed,
+      # the user configuration will override the defaults.
+      #
+      # user_config - a Hash or Configuration of overrides.
+      #
+      # Returns a Configuration filled with defaults and fixed for common
+      # problems and backwards-compatibility.
+      def from(user_config)
+        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys).
+          fix_common_issues.add_default_collections
+      end
+    end
+
+    # Public: Turn all keys into string
+    #
+    # Return a copy of the hash where all its keys are strings
+    def stringify_keys
+      reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) }
+    end
+
+    def get_config_value_with_override(config_key, override)
+      override[config_key] || self[config_key] || DEFAULTS[config_key]
+    end
+
+    # Public: Directory of the Jekyll source folder
+    #
+    # override - the command-line options hash
+    #
+    # Returns the path to the Jekyll source directory
+    def source(override)
+      get_config_value_with_override('source', override)
+    end
+
+    def quiet(override = {})
+      get_config_value_with_override('quiet', override)
+    end
+    alias_method :quiet?, :quiet
+
+    def verbose(override = {})
+      get_config_value_with_override('verbose', override)
+    end
+    alias_method :verbose?, :verbose
+
+    def safe_load_file(filename)
+      case File.extname(filename)
+      when /\.toml/i
+        Jekyll::External.require_with_graceful_fail('toml') unless defined?(TOML)
+        TOML.load_file(filename)
+      when /\.ya?ml/i
+        SafeYAML.load_file(filename) || {}
+      else
+        raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead."
+      end
+    end
+
+    # Public: Generate list of configuration files from the override
+    #
+    # override - the command-line options hash
+    #
+    # Returns an Array of config files
+    def config_files(override)
+      # Adjust verbosity quickly
+      Jekyll.logger.adjust_verbosity(:quiet => quiet?(override), :verbose => verbose?(override))
+
+      # Get configuration from <source>/_config.yml or <source>/<config_file>
+      config_files = override.delete('config')
+      if config_files.to_s.empty?
+        default = %w(yml yaml).find(-> { 'yml' }) do |ext|
+          File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}"))
+        end
+        config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
+        @default_config_file = true
+      end
+      config_files = [config_files] unless config_files.is_a? Array
+      config_files
+    end
+
+    # Public: Read configuration and return merged Hash
+    #
+    # file - the path to the YAML file to be read in
+    #
+    # Returns this configuration, overridden by the values in the file
+    def read_config_file(file)
+      next_config = safe_load_file(file)
+      check_config_is_hash!(next_config, file)
+      Jekyll.logger.info "Configuration file:", file
+      next_config
+    rescue SystemCallError
+      if @default_config_file
+        Jekyll.logger.warn "Configuration file:", "none"
+        {}
+      else
+        Jekyll.logger.error "Fatal:", "The configuration file '#{file}' could not be found."
+        raise LoadError, "The Configuration file '#{file}' could not be found."
+      end
+    end
+
+    # Public: Read in a list of configuration files and merge with this hash
+    #
+    # files - the list of configuration file paths
+    #
+    # Returns the full configuration, with the defaults overridden by the values in the
+    # configuration files
+    def read_config_files(files)
+      configuration = clone
+
+      begin
+        files.each do |config_file|
+          next if config_file.nil? or config_file.empty?
+          new_config = read_config_file(config_file)
+          configuration = Utils.deep_merge_hashes(configuration, new_config)
+        end
+      rescue ArgumentError => err
+        Jekyll.logger.warn "WARNING:", "Error reading configuration. " \
+                     "Using defaults (and options)."
+        $stderr.puts "#{err}"
+      end
+
+      configuration.fix_common_issues.backwards_compatibilize.add_default_collections
+    end
+
+    # Public: Split a CSV string into an array containing its values
+    #
+    # csv - the string of comma-separated values
+    #
+    # Returns an array of the values contained in the CSV
+    def csv_to_array(csv)
+      csv.split(",").map(&:strip)
+    end
+
+    # Public: Ensure the proper options are set in the configuration to allow for
+    # backwards-compatibility with Jekyll pre-1.0
+    #
+    # Returns the backwards-compatible configuration
+    def backwards_compatibilize
+      config = clone
+      # Provide backwards-compatibility
+      if config.key?('auto') || config.key?('watch')
+        Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" \
+                            " be set from your configuration file(s). Use the"\
+                            " --[no-]watch/-w command-line option instead."
+        config.delete('auto')
+        config.delete('watch')
+      end
+
+      if config.key? 'server'
+        Jekyll::Deprecator.deprecation_message "The 'server' configuration option" \
+                            " is no longer accepted. Use the 'jekyll serve'" \
+                            " subcommand to serve your site with WEBrick."
+        config.delete('server')
+      end
+
+      renamed_key 'server_port', 'port', config
+      renamed_key 'plugins', 'plugins_dir', config
+      renamed_key 'layouts', 'layouts_dir', config
+      renamed_key 'data_source', 'data_dir', config
+
+      if config.key? 'pygments'
+        Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option" \
+                            " has been renamed to 'highlighter'. Please update your" \
+                            " config file accordingly. The allowed values are 'rouge', " \
+                            "'pygments' or null."
+
+        config['highlighter'] = 'pygments' if config['pygments']
+        config.delete('pygments')
+      end
+
+      %w(include exclude).each do |option|
+        if config[option].is_a?(String)
+          Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option" \
+            " must now be specified as an array, but you specified" \
+            " a string. For now, we've treated the string you provided" \
+            " as a list of comma-separated values."
+          config[option] = csv_to_array(config[option])
+        end
+        config[option].map!(&:to_s) if config[option]
+      end
+
+      if (config['kramdown'] || {}).key?('use_coderay')
+        Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" \
+          " to 'enable_coderay' in your configuration file."
+        config['kramdown']['use_coderay'] = config['kramdown'].delete('enable_coderay')
+      end
+
+      if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku")
+        Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " \
+          "Markdown processor, which has been removed as of 3.0.0. " \
+          "We recommend you switch to Kramdown. To do this, replace " \
+          "`markdown: maruku` with `markdown: kramdown` in your " \
+          "`_config.yml` file."
+      end
+
+      config
+    end
+
+    def fix_common_issues
+      config = clone
+
+      if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
+        Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a" \
+          " positive integer or nil. It's currently set to '#{config['paginate'].inspect}'."
+        config['paginate'] = nil
+      end
+
+      config
+    end
+
+    def add_default_collections
+      config = clone
+
+      # It defaults to `{}`, so this is only if someone sets it to null manually.
+      return config if config['collections'].nil?
+
+      # Ensure we have a hash.
+      if config['collections'].is_a?(Array)
+        config['collections'] = Hash[config['collections'].map { |c| [c, {}] }]
+      end
+
+      config['collections'] = Utils.deep_merge_hashes(
+        { 'posts' => {} }, config['collections']
+      ).tap do |collections|
+        collections['posts']['output'] = true
+        if config['permalink']
+          collections['posts']['permalink'] ||= style_to_permalink(config['permalink'])
+        end
+      end
+
+      config
+    end
+
+    def renamed_key(old, new, config, _ = nil)
+      if config.key?(old)
+        Jekyll::Deprecator.deprecation_message "The '#{old}' configuration" \
+          "option has been renamed to '#{new}'. Please update your config " \
+          "file accordingly."
+        config[new] = config.delete(old)
+      end
+    end
+
+    private
+
+    def style_to_permalink(permalink_style)
+      case permalink_style.to_sym
+      when :pretty
+        "/:categories/:year/:month/:day/:title/"
+      when :none
+        "/:categories/:title:output_ext"
+      when :date
+        "/:categories/:year/:month/:day/:title:output_ext"
+      when :ordinal
+        "/:categories/:year/:y_day/:title:output_ext"
+      else
+        permalink_style.to_s
+      end
+    end
+
+    # Private: Checks if a given config is a hash
+    #
+    # extracted_config - the value to check
+    # file - the file from which the config was extracted
+    #
+    # Raises an ArgumentError if given config is not a hash
+    def check_config_is_hash!(extracted_config, file)
+      unless extracted_config.is_a?(Hash)
+        raise ArgumentError.new("Configuration file: (INVALID) #{file}".yellow)
+      end
+    end
+  end
+end