bunto 3.0.0 → 3.2.1

data/lib/bunto/drops/excerpt_drop.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+module Bunto
+  module Drops
+    class ExcerptDrop < DocumentDrop
+      def layout
+        @obj.doc.data["layout"]
+      end
+
+      def excerpt
+        nil
+      end
+    end
+  end
+end

data/lib/bunto/drops/site_drop.rb

@@ -24,11 +24,13 @@ module Bunto
       end
 
       def html_pages
-        @site_html_pages ||= @obj.pages.select { |page| page.html? || page.url.end_with?("/") }
+        @site_html_pages ||= @obj.pages.select do |page|
+          page.html? || page.url.end_with?("/")
+        end
       end
 
       def collections
-        @site_collections ||= @obj.collections.values.map(&:to_liquid)
+        @site_collections ||= @obj.collections.values.sort_by(&:label).map(&:to_liquid)
       end
 
       private

data/lib/bunto/drops/url_drop.rb

@@ -19,20 +19,20 @@ module Bunto
       end
 
       def title
-        Utils.slugify(@obj.data['slug'], :mode => "pretty", :cased => true) ||
+        Utils.slugify(@obj.data["slug"], :mode => "pretty", :cased => true) ||
           Utils.slugify(@obj.basename_without_ext, :mode => "pretty", :cased => true)
       end
 
       def slug
-        Utils.slugify(@obj.data['slug']) || Utils.slugify(@obj.basename_without_ext)
+        Utils.slugify(@obj.data["slug"]) || Utils.slugify(@obj.basename_without_ext)
       end
 
       def categories
         category_set = Set.new
-        Array(@obj.data['categories']).each do |category|
+        Array(@obj.data["categories"]).each do |category|
           category_set << category.to_s.downcase
         end
-        category_set.to_a.join('/')
+        category_set.to_a.join("/")
       end
 
       def year

data/lib/bunto/entry_filter.rb

@@ -1,12 +1,15 @@
 module Bunto
   class EntryFilter
-    SPECIAL_LEADING_CHARACTERS = ['.', '_', '#', '~'].freeze
-
     attr_reader :site
+    SPECIAL_LEADING_CHARACTERS = [
+      ".", "_", "#", "~"
+    ].freeze
 
     def initialize(site, base_directory = nil)
       @site = site
-      @base_directory = derive_base_directory(@site, base_directory.to_s.dup)
+      @base_directory = derive_base_directory(
+        @site, base_directory.to_s.dup
+      )
     end
 
     def base_directory
@@ -14,14 +17,14 @@ module Bunto
     end
 
     def derive_base_directory(site, base_dir)
-      if base_dir.start_with?(site.source)
-        base_dir[site.source] = ""
-      end
+      base_dir[site.source] = "" if base_dir.start_with?(site.source)
       base_dir
     end
 
     def relative_to_source(entry)
-      File.join(base_directory, entry)
+      File.join(
+        base_directory, entry
+      )
     end
 
     def filter(entries)
@@ -33,7 +36,8 @@ module Bunto
     end
 
     def included?(entry)
-      glob_include?(site.include, entry)
+      glob_include?(site.include,
+        entry)
     end
 
     def special?(entry)
@@ -42,34 +46,75 @@ module Bunto
     end
 
     def backup?(entry)
-      entry[-1..-1] == '~'
+      entry[-1..-1] == "~"
     end
 
     def excluded?(entry)
       excluded = glob_include?(site.exclude, relative_to_source(entry))
-      Bunto.logger.debug "EntryFilter:", "excluded #{relative_to_source(entry)}" if excluded
+      if excluded
+        Bunto.logger.debug(
+          "EntryFilter:",
+          "excluded #{relative_to_source(entry)}"
+        )
+      end
       excluded
     end
 
+    # --
+    # Check if a file is a symlink.
+    # NOTE: This can be converted to allowing even in safe,
+    #   since we use Pathutil#in_path? now.
+    # --
     def symlink?(entry)
       site.safe && File.symlink?(entry) && symlink_outside_site_source?(entry)
     end
 
+    # --
+    # NOTE: Pathutil#in_path? gets the realpath.
+    # @param [<Anything>] entry the entry you want to validate.
+    # Check if a path is outside of our given root.
+    # --
     def symlink_outside_site_source?(entry)
-      ! File.realpath(entry).start_with?(File.realpath(@site.source))
-    end
-
-    def ensure_leading_slash(path)
-      path[0..0] == "/" ? path : "/#{path}"
+      !Pathutil.new(entry).in_path?(
+        site.in_source_dir
+      )
     end
 
+    # --
+    # Check if an entry matches a specific pattern and return true,false.
     # Returns true if path matches against any glob pattern.
-    # Look for more detail about glob pattern in method File::fnmatch.
+    # --
     def glob_include?(enum, e)
-      entry = ensure_leading_slash(e)
+      entry = Pathutil.new(site.in_source_dir).join(e)
       enum.any? do |exp|
-        item = ensure_leading_slash(exp)
-        File.fnmatch?(item, entry) || entry.start_with?(item)
+        # Users who send a Regexp knows what they want to
+        # exclude, so let them send a Regexp to exclude files,
+        # we will not bother caring if it works or not, it's
+        # on them at this point.
+
+        if exp.is_a?(Regexp)
+          entry =~ exp
+
+        else
+          item = Pathutil.new(site.in_source_dir).join(exp)
+
+          # If it's a directory they want to exclude, AKA
+          # ends with a "/" then we will go on to check and
+          # see if the entry falls within that path and
+          # exclude it if that's the case.
+
+          if e.end_with?("/")
+            entry.in_path?(
+              item
+            )
+
+          else
+            File.fnmatch?(item, entry) ||
+              entry.to_path.start_with?(
+                item
+              )
+          end
+        end
       end
     end
   end

data/lib/bunto/errors.rb

@@ -2,13 +2,16 @@ module Bunto
   module Errors
     FatalException = Class.new(::RuntimeError)
 
+    InvalidThemeName = Class.new(FatalException)
+
     DropMutationException       = Class.new(FatalException)
     InvalidPermalinkError       = Class.new(FatalException)
     InvalidYAMLFrontMatterError = Class.new(FatalException)
     MissingDependencyException  = Class.new(FatalException)
 
-    InvalidDateError = Class.new(FatalException)
-    InvalidPostNameError = Class.new(FatalException)
-    PostURLError = Class.new(FatalException)
+    InvalidDateError      = Class.new(FatalException)
+    InvalidPostNameError  = Class.new(FatalException)
+    PostURLError          = Class.new(FatalException)
+    InvalidURLError       = Class.new(FatalException)
   end
 end

data/lib/bunto/excerpt.rb

@@ -7,7 +7,8 @@ module Bunto
     attr_writer   :output
 
     def_delegators :@doc, :site, :name, :ext, :relative_path, :extname,
-                          :render_with_liquid?, :collection, :related_posts
+                          :render_with_liquid?, :collection, :related_posts,
+                          :url, :next_doc, :previous_doc
 
     # Initialize this Excerpt instance.
     #
@@ -59,10 +60,7 @@ module Bunto
     end
 
     def to_liquid
-      doc.data['excerpt'] = nil
-      @to_liquid ||= doc.to_liquid
-      doc.data['excerpt'] = self
-      @to_liquid
+      Bunto::Drops::ExcerptDrop.new(self)
     end
 
     # Returns the shorthand String identifier of this doc.
@@ -120,7 +118,7 @@ module Bunto
       if tail.empty?
         head
       else
-        "" << head << "\n\n" << tail.scan(/^\[[^\]]+\]:.+$/).join("\n")
+        "" << head << "\n\n" << tail.scan(%r!^\[[^\]]+\]:.+$!).join("\n")
       end
     end
   end

data/lib/bunto/external.rb

@@ -17,13 +17,13 @@ module Bunto
       #
       # names - a string gem name or array of gem names
       #
-      def require_if_present(names, &block)
+      def require_if_present(names)
         Array(names).each do |name|
           begin
             require name
           rescue LoadError
             Bunto.logger.debug "Couldn't load #{name}. Skipping."
-            block.call(name) if block
+            yield(name) if block_given?
             false
           end
         end
@@ -39,7 +39,7 @@ module Bunto
       def require_with_graceful_fail(names)
         Array(names).each do |name|
           begin
-            Bunto.logger.debug "Requiring:", "#{name}"
+            Bunto.logger.debug "Requiring:", name.to_s
             require name
           rescue LoadError => e
             Bunto.logger.error "Dependency Error:", <<-MSG
@@ -50,7 +50,7 @@ The full error message from Ruby is: '#{e.message}'
 
 If you run into trouble, you can find helpful resources at http://bunto.github.io/help/!
             MSG
-            raise Bunto::Errors::MissingDependencyException.new(name)
+            raise Bunto::Errors::MissingDependencyException, name
           end
         end
       end

data/lib/bunto/filters.rb

@@ -1,7 +1,7 @@
-require 'uri'
-require 'json'
-require 'date'
-require 'liquid'
+require "uri"
+require "json"
+require "date"
+require "liquid"
 
 module Bunto
   module Filters
@@ -13,7 +13,7 @@ module Bunto
     def markdownify(input)
       site = @context.registers[:site]
       converter = site.find_converter_instance(Bunto::Converters::Markdown)
-      converter.convert(input)
+      converter.convert(input.to_s)
     end
 
     # Convert quotes into smart quotes.
@@ -24,7 +24,7 @@ module Bunto
     def smartify(input)
       site = @context.registers[:site]
       converter = site.find_converter_instance(Bunto::Converters::SmartyPants)
-      converter.convert(input)
+      converter.convert(input.to_s)
     end
 
     # Convert a Sass string into CSS output.
@@ -56,7 +56,7 @@ module Bunto
     #
     # Returns the given filename or title as a lowercase URL String.
     # See Utils.slugify for more detail.
-    def slugify(input, mode=nil)
+    def slugify(input, mode = nil)
       Utils.slugify(input, :mode => mode)
     end
 
@@ -118,7 +118,7 @@ module Bunto
     #
     # Returns the escaped String.
     def xml_escape(input)
-      input.to_s.encode(:xml => :attr).gsub(/\A"|"\Z/, "")
+      input.to_s.encode(:xml => :attr).gsub(%r!\A"|"\Z!, "")
     end
 
     # CGI escape a string for use in a URL. Replaces any special characters
@@ -133,7 +133,7 @@ module Bunto
     #
     # Returns the escaped String.
     def cgi_escape(input)
-      CGI::escape(input)
+      CGI.escape(input)
     end
 
     # URI escape a string.
@@ -150,6 +150,15 @@ module Bunto
       URI.escape(input)
     end
 
+    # Replace any whitespace in the input string with a single space
+    #
+    # input - The String on which to operate.
+    #
+    # Returns the formatted String
+    def normalize_whitespace(input)
+      input.to_s.gsub(%r!\s+!, " ").strip
+    end
+
     # Count the number of words in the input string.
     #
     # input - The String on which to operate.
@@ -180,7 +189,7 @@ module Bunto
       when 2
         "#{array[0]} #{connector} #{array[1]}"
       else
-        "#{array[0...-1].join(', ')}, #{connector} #{array[-1]}"
+        "#{array[0...-1].join(", ")}, #{connector} #{array[-1]}"
       end
     end
 
@@ -203,11 +212,14 @@ module Bunto
     #   "items" => [...] } # all the items where `property` == "larry"
     def group_by(input, property)
       if groupable?(input)
-        input.group_by do |item|
-          item_property(item, property).to_s
-        end.inject([]) do |memo, i|
-          memo << { "name" => i.first, "items" => i.last, "size" => i.last.size }
-        end
+        input.group_by { |item| item_property(item, property).to_s }
+          .each_with_object([]) do |item, array|
+            array << {
+              "name"  => item.first,
+              "items" => item.last,
+              "size"  => item.last.size
+            }
+          end
       else
         input
       end
@@ -221,9 +233,11 @@ module Bunto
     #
     # Returns the filtered array of objects
     def where(input, property, value)
-      return input unless input.is_a?(Enumerable)
+      return input unless input.respond_to?(:select)
       input = input.values if input.is_a?(Hash)
-      input.select { |object| Array(item_property(object, property)).map(&:to_s).include?(value.to_s) }
+      input.select do |object|
+        Array(item_property(object, property)).map(&:to_s).include?(value.to_s)
+      end || []
     end
 
     # Filters an array of objects against an expression
@@ -234,7 +248,7 @@ module Bunto
     #
     # Returns the filtered array of objects
     def where_exp(input, variable, expression)
-      return input unless input.is_a?(Enumerable)
+      return input unless input.respond_to?(:select)
       input = input.values if input.is_a?(Hash) # FIXME
 
       condition = parse_condition(expression)
@@ -243,7 +257,18 @@ module Bunto
           @context[variable] = object
           condition.evaluate(@context)
         end
-      end
+      end || []
+    end
+
+    # Convert the input into integer
+    #
+    # input - the object string
+    #
+    # Returns the integer value
+    def to_integer(input)
+      return 1 if input == true
+      return 0 if input == false
+      input.to_i
     end
 
     # Sort an array of objects
@@ -255,33 +280,21 @@ module Bunto
     # Returns the filtered array of objects
     def sort(input, property = nil, nils = "first")
       if input.nil?
-        raise ArgumentError.new("Cannot sort a null object.")
+        raise ArgumentError, "Cannot sort a null object."
       end
       if property.nil?
         input.sort
       else
-        case
-        when nils == "first"
+        if nils == "first"
           order = - 1
-        when nils == "last"
+        elsif nils == "last"
           order = + 1
         else
-          raise ArgumentError.new("Invalid nils order: " \
-            "'#{nils}' is not a valid nils order. It must be 'first' or 'last'.")
+          raise ArgumentError, "Invalid nils order: " \
+            "'#{nils}' is not a valid nils order. It must be 'first' or 'last'."
         end
 
-        input.sort do |apple, orange|
-          apple_property = item_property(apple, property)
-          orange_property = item_property(orange, property)
-
-          if !apple_property.nil? && orange_property.nil?
-            - order
-          elsif apple_property.nil? && !orange_property.nil?
-            + order
-          else
-            apple_property <=> orange_property
-          end
-        end
+        sort_input(input, property, order)
       end
     end
 
@@ -332,6 +345,22 @@ module Bunto
       xml_escape(input.inspect)
     end
 
+    private
+    def sort_input(input, property, order)
+      input.sort do |apple, orange|
+        apple_property = item_property(apple, property)
+        orange_property = item_property(orange, property)
+
+        if !apple_property.nil? && orange_property.nil?
+          - order
+        elsif apple_property.nil? && !orange_property.nil?
+          + order
+        else
+          apple_property <=> orange_property
+        end
+      end
+    end
+
     private
     def time(input)
       case input
@@ -344,15 +373,17 @@ module Bunto
       when Numeric
         Time.at(input)
       else
-        Bunto.logger.error "Invalid Date:", "'#{input}' is not a valid datetime."
-        exit(1)
+        raise Errors::InvalidDateError,
+          "Invalid Date: '#{input.inspect}' is not a valid datetime."
       end.localtime
     end
 
+    private
     def groupable?(element)
       element.respond_to?(:group_by)
     end
 
+    private
     def item_property(item, property)
       if item.respond_to?(:to_liquid)
         item.to_liquid[property.to_s]
@@ -363,6 +394,7 @@ module Bunto
       end
     end
 
+    private
     def as_liquid(item)
       case item
       when Hash
@@ -386,6 +418,7 @@ module Bunto
     end
 
     # Parse a string to a Liquid Condition
+    private
     def parse_condition(exp)
       parser = Liquid::Parser.new(exp)
       left_expr = parser.expression