bunto 3.2.1 → 3.4.5

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

@@ -6,7 +6,7 @@ module Bunto
       class Servlet < WEBrick::HTTPServlet::FileHandler
         DEFAULTS = {
           "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
-            "no-store, no-cache, must-revalidate"
+            "no-store, no-cache, must-revalidate",
         }.freeze
 
         def initialize(server, root, callbacks)

data/lib/bunto/configuration.rb

@@ -17,7 +17,9 @@ module Bunto
       # Handling Reading
       "safe"              => false,
       "include"           => [".htaccess"],
-      "exclude"           => [],
+      "exclude"           => %w(
+        node_modules vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/
+      ),
       "keep_files"        => [".git", ".svn"],
       "encoding"          => "utf-8",
       "markdown_ext"      => "markdown,mkdown,mkdn,mkd,md",
@@ -43,7 +45,7 @@ module Bunto
       "detach"            => false, # default to not detaching the server
       "port"              => "4000",
       "host"              => "127.0.0.1",
-      "baseurl"           => "",
+      "baseurl"           => nil, # this mounts at /, i.e. no subdirectory
       "show_dir_listing"  => false,
 
       # Output Configuration
@@ -56,15 +58,15 @@ module Bunto
       "defaults"          => [],
 
       "liquid"            => {
-        "error_mode" => "warn"
+        "error_mode" => "warn",
       },
 
       "rdiscount"         => {
-        "extensions" => []
+        "extensions" => [],
       },
 
       "redcarpet"         => {
-        "extensions" => []
+        "extensions" => [],
       },
 
       "kramdown"          => {
@@ -74,8 +76,8 @@ module Bunto
         "smart_quotes"  => "lsquo,rsquo,ldquo,rdquo",
         "input"         => "GFM",
         "hard_wrap"     => false,
-        "footnote_nr"   => 1
-      }
+        "footnote_nr"   => 1,
+      },
     }.map { |k, v| [k, v.freeze] }].freeze
 
     class << self

data/lib/bunto/converters/markdown/kramdown_parser.rb

@@ -11,7 +11,7 @@ module Bunto
           "line_numbers"      => "inline",
           "line_number_start" => 1,
           "tab_width"         => 4,
-          "wrap"              => "div"
+          "wrap"              => "div",
         }.freeze
 
         def initialize(config)
@@ -104,7 +104,7 @@ module Bunto
 
         private
         def modernize_coderay_config
-          if highlighter == "coderay"
+          unless @config["coderay"].empty?
             Bunto::Deprecator.deprecation_message(
               "You are using 'kramdown.coderay' in your configuration, " \
               "please use 'syntax_highlighter_opts' instead."

data/lib/bunto/converters/markdown/redcarpet_parser.rb

@@ -21,7 +21,7 @@ class Bunto::Converters::Markdown::RedcarpetParser
           code,
           {
             :lexer   => lang,
-            :options => { :encoding => "utf-8" }
+            :options => { :encoding => "utf-8" },
           }
         ),
         lang

data/lib/bunto/convertible.rb

@@ -35,6 +35,7 @@ module Bunto
     # opts - optional parameter to File.read, default at site configs
     #
     # Returns nothing.
+    # rubocop:disable Metrics/AbcSize
     def read_yaml(base, name, opts = {})
       filename = File.join(base, name)
 
@@ -58,6 +59,7 @@ module Bunto
 
       self.data
     end
+    # rubocop:enable Metrics/AbcSize
 
     def validate_data!(filename)
       unless self.data.is_a?(Hash)
@@ -76,18 +78,7 @@ module Bunto
     #
     # Returns the transformed contents.
     def transform
-      converters.reduce(content) do |output, converter|
-        begin
-          converter.convert output
-        rescue => e
-          Bunto.logger.error(
-            "Conversion error:",
-            "#{converter.class} encountered an error while converting '#{path}':"
-          )
-          Bunto.logger.error("", e.to_s)
-          raise e
-        end
-      end
+      _renderer.transform
     end
 
     # Determine the extension depending on content_type.
@@ -95,7 +86,7 @@ module Bunto
     # Returns the String extension for the output file.
     #   e.g. ".html" for an HTML output file.
     def output_ext
-      Bunto::Renderer.new(site, self).output_ext
+      _renderer.output_ext
     end
 
     # Determine which converter to use based on this convertible's
@@ -103,7 +94,7 @@ module Bunto
     #
     # Returns the Converter instance.
     def converters
-      @converters ||= site.converters.select { |c| c.matches(ext) }.sort
+      _renderer.converters
     end
 
     # Render Liquid in the content
@@ -114,17 +105,7 @@ module Bunto
     #
     # Returns the converted content
     def render_liquid(content, payload, info, path)
-      template = site.liquid_renderer.file(path).parse(content)
-      template.warnings.each do |e|
-        Bunto.logger.warn "Liquid Warning:",
-          LiquidRenderer.format_error(e, path || self.path)
-      end
-      template.render!(payload, info)
-    # rubocop: disable RescueException
-    rescue Exception => e
-      Bunto.logger.error "Liquid Exception:",
-        LiquidRenderer.format_error(e, path || self.path)
-      raise e
+      _renderer.render_liquid(content, payload, info, path)
     end
     # rubocop: enable RescueException
 
@@ -211,40 +192,10 @@ module Bunto
     #
     # Returns nothing
     def render_all_layouts(layouts, payload, info)
-      # recursively render layouts
-      layout = layouts[data["layout"]]
-
-      Bunto.logger.warn(
-        "Build Warning:",
-        "Layout '#{data["layout"]}' requested in #{path} does not exist."
-      ) if invalid_layout? layout
-
-      used = Set.new([layout])
-
-      # Reset the payload layout data to ensure it starts fresh for each page.
-      payload["layout"] = nil
-
-      while layout
-        Bunto.logger.debug "Rendering Layout:", path
-        payload["content"] = output
-        payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
-
-        self.output = render_liquid(layout.content,
-                                    payload,
-                                    info,
-                                    layout.relative_path)
-
-        # Add layout to dependency tree
-        site.regenerator.add_dependency(
-          site.in_source_dir(path),
-          site.in_source_dir(layout.path)
-        )
-
-        if (layout = layouts[layout.data["layout"]])
-          break if used.include?(layout)
-          used << layout
-        end
-      end
+      _renderer.layouts = layouts
+      self.output = _renderer.place_in_layouts(output, payload, info)
+    ensure
+      @_renderer = nil # this will allow the modifications above to disappear
     end
 
     # Add any necessary layouts to this convertible document.
@@ -254,32 +205,15 @@ module Bunto
     #
     # Returns nothing.
     def do_layout(payload, layouts)
-      Bunto.logger.debug "Rendering:", self.relative_path
-
-      Bunto.logger.debug "Pre-Render Hooks:", self.relative_path
-      Bunto::Hooks.trigger hook_owner, :pre_render, self, payload
-      info = {
-        :filters   => [Bunto::Filters],
-        :registers => { :site => site, :page => payload["page"] }
-      }
+      self.output = _renderer.tap do |renderer|
+        renderer.layouts = layouts
+        renderer.payload = payload
+      end.run
 
-      # render and transform content (this becomes the final content of the object)
-      payload["highlighter_prefix"] = converters.first.highlighter_prefix
-      payload["highlighter_suffix"] = converters.first.highlighter_suffix
-
-      if render_with_liquid?
-        Bunto.logger.debug "Rendering Liquid:", self.relative_path
-        self.content = render_liquid(content, payload, info, path)
-      end
-      Bunto.logger.debug "Rendering Markup:", self.relative_path
-      self.content = transform
-
-      # output keeps track of what will finally be written
-      self.output = content
-
-      render_all_layouts(layouts, payload, info) if place_in_layout?
       Bunto.logger.debug "Post-Render Hooks:", self.relative_path
       Bunto::Hooks.trigger hook_owner, :post_render, self
+    ensure
+      @_renderer = nil # this will allow the modifications above to disappear
     end
 
     # Write the generated page file to the destination directory.
@@ -306,5 +240,10 @@ module Bunto
         data[property]
       end
     end
+
+    private
+    def _renderer
+      @_renderer ||= Bunto::Renderer.new(site, self)
+    end
   end
 end

data/lib/bunto/desktop.ini

@@ -1,2 +1,2 @@
 [.ShellClassInfo]
-LocalizedResourceName=bunto
+LocalizedResourceName=jekl

data/lib/bunto/document.rb

@@ -9,7 +9,7 @@ module Bunto
 
     YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m
     DATELESS_FILENAME_MATCHER = %r!^(?:.+/)*(.*)(\.[^.]+)$!
-    DATE_FILENAME_MATCHER = %r!^(?:.+/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$!
+    DATE_FILENAME_MATCHER = %r!^(?:.+/)*(\d{2,4}-\d{1,2}-\d{1,2})-(.*)(\.[^.]+)$!
 
     # Create a new Document.
     #
@@ -51,19 +51,9 @@ module Bunto
     #
     # Returns the merged data.
     def merge_data!(other, source: "YAML front matter")
-      if other.key?("categories") && !other["categories"].nil?
-        if other["categories"].is_a?(String)
-          other["categories"] = other["categories"].split(" ").map(&:strip)
-        end
-        other["categories"] = (data["categories"] || []) | other["categories"]
-      end
+      merge_categories!(other)
       Utils.deep_merge_hashes!(data, other)
-      if data.key?("date") && !data["date"].is_a?(Time)
-        data["date"] = Utils.parse_date(
-          data["date"].to_s,
-          "Document '#{relative_path}' does not have a valid date in the #{source}."
-        )
-      end
+      merge_date!(source)
       data
     end
 
@@ -90,8 +80,7 @@ module Bunto
     # Returns a String path which represents the relative path
     #   from the site source to this document
     def relative_path
-      @relative_path ||= Pathname.new(path)
-        .relative_path_from(Pathname.new(site.source)).to_s
+      @relative_path ||= Pathutil.new(path).relative_path_from(site.source).to_s
     end
 
     # The output extension of the document.
@@ -207,7 +196,7 @@ module Bunto
       @url = URL.new({
         :template     => url_template,
         :placeholders => url_placeholders,
-        :permalink    => permalink
+        :permalink    => permalink,
       }).to_s
     end
 
@@ -264,20 +253,9 @@ module Bunto
         @data = SafeYAML.load_file(path)
       else
         begin
-          defaults = @site.frontmatter_defaults.all(
-            relative_path,
-            collection.label.to_sym
-          )
-          merge_data!(defaults, :source => "front matter defaults") unless defaults.empty?
-
-          self.content = File.read(path, Utils.merged_file_read_opts(site, opts))
-          if content =~ YAML_FRONT_MATTER_REGEXP
-            self.content = $POSTMATCH
-            data_file = SafeYAML.load(Regexp.last_match(1))
-            merge_data!(data_file, :source => "YAML front matter") if data_file
-          end
-
-          post_read
+          merge_defaults
+          read_content(opts)
+          read_post_data
         rescue SyntaxError => e
           Bunto.logger.error "Error:", "YAML Exception reading #{path}: #{e.message}"
         rescue => e
@@ -287,56 +265,6 @@ module Bunto
       end
     end
 
-    def post_read
-      if relative_path =~ DATE_FILENAME_MATCHER
-        date, slug, ext = Regexp.last_match.captures
-        if !data["date"] || data["date"].to_i == site.time.to_i
-          merge_data!({ "date" => date }, :source => "filename")
-        end
-      elsif relative_path =~ DATELESS_FILENAME_MATCHER
-        slug, ext = Regexp.last_match.captures
-      end
-
-      # Try to ensure the user gets a title.
-      data["title"] ||= Utils.titleize_slug(slug)
-      # Only overwrite slug & ext if they aren't specified.
-      data["slug"] ||= slug
-      data["ext"]  ||= ext
-
-      populate_categories
-      populate_tags
-      generate_excerpt
-    end
-
-    # Add superdirectories of the special_dir to categories.
-    # In the case of es/_posts, 'es' is added as a category.
-    # In the case of _posts/es, 'es' is NOT added as a category.
-    #
-    # Returns nothing.
-    def categories_from_path(special_dir)
-      superdirs = relative_path.sub(%r!#{special_dir}(.*)!, "")
-        .split(File::SEPARATOR)
-        .reject do |c|
-        c.empty? || c.eql?(special_dir) || c.eql?(basename)
-      end
-      merge_data!({ "categories" => superdirs }, :source => "file path")
-    end
-
-    def populate_categories
-      merge_data!({
-        "categories" => (
-          Array(data["categories"]) +
-          Utils.pluralized_array_from_hash(data, "category", "categories")
-        ).map(&:to_s).flatten.uniq
-      })
-    end
-
-    def populate_tags
-      merge_data!({
-        "tags" => Utils.pluralized_array_from_hash(data, "tag", "tags").flatten
-      })
-    end
-
     # Create a Liquid-understandable version of this Document.
     #
     # Returns a Hash representing this Document's data.
@@ -443,7 +371,116 @@ module Bunto
       end
     end
 
-    private # :nodoc:
+    def respond_to_missing?(method, *)
+      data.key?(method.to_s) || super
+    end
+
+    private
+    def merge_categories!(other)
+      if other.key?("categories") && !other["categories"].nil?
+        if other["categories"].is_a?(String)
+          other["categories"] = other["categories"].split(%r!\s+!).map(&:strip)
+        end
+        other["categories"] = (data["categories"] || []) | other["categories"]
+      end
+    end
+
+    private
+    def merge_date!(source)
+      if data.key?("date") && !data["date"].is_a?(Time)
+        data["date"] = Utils.parse_date(
+          data["date"].to_s,
+          "Document '#{relative_path}' does not have a valid date in the #{source}."
+        )
+      end
+    end
+
+    private
+    def merge_defaults
+      defaults = @site.frontmatter_defaults.all(
+        relative_path,
+        collection.label.to_sym
+      )
+      merge_data!(defaults, :source => "front matter defaults") unless defaults.empty?
+    end
+
+    private
+    def read_content(opts)
+      self.content = File.read(path, Utils.merged_file_read_opts(site, opts))
+      if content =~ YAML_FRONT_MATTER_REGEXP
+        self.content = $POSTMATCH
+        data_file = SafeYAML.load(Regexp.last_match(1))
+        merge_data!(data_file, :source => "YAML front matter") if data_file
+      end
+    end
+
+    private
+    def read_post_data
+      populate_title
+      populate_categories
+      populate_tags
+      generate_excerpt
+    end
+
+    private
+    def populate_title
+      if relative_path =~ DATE_FILENAME_MATCHER
+        date, slug, ext = Regexp.last_match.captures
+        modify_date(date)
+      elsif relative_path =~ DATELESS_FILENAME_MATCHER
+        slug, ext = Regexp.last_match.captures
+      end
+
+      # Try to ensure the user gets a title.
+      data["title"] ||= Utils.titleize_slug(slug)
+      # Only overwrite slug & ext if they aren't specified.
+      data["slug"]  ||= slug
+      data["ext"]   ||= ext
+    end
+
+    private
+    def modify_date(date)
+      if !data["date"] || data["date"].to_i == site.time.to_i
+        merge_data!({ "date" => date }, :source => "filename")
+      end
+    end
+
+    # Add superdirectories of the special_dir to categories.
+    # In the case of es/_posts, 'es' is added as a category.
+    # In the case of _posts/es, 'es' is NOT added as a category.
+    #
+    # Returns nothing.
+    private
+    def categories_from_path(special_dir)
+      superdirs = relative_path.sub(%r!#{special_dir}(.*)!, "")
+        .split(File::SEPARATOR)
+        .reject do |c|
+        c.empty? || c == special_dir || c == basename
+      end
+      merge_data!({ "categories" => superdirs }, :source => "file path")
+    end
+
+    private
+    def populate_categories
+      merge_data!({
+        "categories" => (
+        Array(data["categories"]) + Utils.pluralized_array_from_hash(
+          data,
+          "category",
+          "categories"
+        )
+        ).map(&:to_s).flatten.uniq,
+      })
+    end
+
+    private
+    def populate_tags
+      merge_data!({
+        "tags" => Utils.pluralized_array_from_hash(data, "tag", "tags").flatten,
+      })
+    end
+
+    private
     def generate_excerpt
       if generate_excerpt?
         data["excerpt"] ||= Bunto::Excerpt.new(self)