bridgetown-core 0.7.0 → 0.7.1

data/lib/bridgetown-core/drops/unified_payload_drop.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Drops
+    class UnifiedPayloadDrop < Drop
+      mutable true
+
+      attr_accessor :page, :layout, :content, :paginator
+      attr_accessor :highlighter_prefix, :highlighter_suffix
+
+      def bridgetown
+        BridgetownDrop.global
+      end
+
+      def site
+        @site_drop ||= SiteDrop.new(@obj)
+      end
+
+      private
+
+      def fallback_data
+        @fallback_data ||= {}
+      end
+    end
+  end
+end

data/lib/bridgetown-core/drops/url_drop.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Drops
+    class UrlDrop < Drop
+      extend Forwardable
+
+      mutable false
+
+      def_delegator :@obj, :cleaned_relative_path, :path
+      def_delegator :@obj, :output_ext, :output_ext
+
+      def collection
+        @obj.collection.label
+      end
+
+      def name
+        Utils.slugify(@obj.basename_without_ext)
+      end
+
+      def title
+        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)
+      end
+
+      def categories
+        category_set = Set.new
+        Array(@obj.data["categories"]).each do |category|
+          category_set << category.to_s.downcase
+        end
+        category_set.to_a.join("/")
+      end
+
+      # CCYY
+      def year
+        @obj.date.strftime("%Y")
+      end
+
+      # MM: 01..12
+      def month
+        @obj.date.strftime("%m")
+      end
+
+      # DD: 01..31
+      def day
+        @obj.date.strftime("%d")
+      end
+
+      # hh: 00..23
+      def hour
+        @obj.date.strftime("%H")
+      end
+
+      # mm: 00..59
+      def minute
+        @obj.date.strftime("%M")
+      end
+
+      # ss: 00..59
+      def second
+        @obj.date.strftime("%S")
+      end
+
+      # D: 1..31
+      def i_day
+        @obj.date.strftime("%-d")
+      end
+
+      # M: 1..12
+      def i_month
+        @obj.date.strftime("%-m")
+      end
+
+      # MMM: Jan..Dec
+      def short_month
+        @obj.date.strftime("%b")
+      end
+
+      # MMMM: January..December
+      def long_month
+        @obj.date.strftime("%B")
+      end
+
+      # YY: 00..99
+      def short_year
+        @obj.date.strftime("%y")
+      end
+
+      # CCYYw, ISO week year
+      # may differ from CCYY for the first days of January and last days of December
+      def w_year
+        @obj.date.strftime("%G")
+      end
+
+      # WW: 01..53
+      # %W and %U do not comply with ISO 8601-1
+      def week
+        @obj.date.strftime("%V")
+      end
+
+      # d: 1..7 (Monday..Sunday)
+      def w_day
+        @obj.date.strftime("%u")
+      end
+
+      # dd: Mon..Sun
+      def short_day
+        @obj.date.strftime("%a")
+      end
+
+      # ddd: Monday..Sunday
+      def long_day
+        @obj.date.strftime("%A")
+      end
+
+      # DDD: 001..366
+      def y_day
+        @obj.date.strftime("%j")
+      end
+
+      private
+
+      def fallback_data
+        @fallback_data ||= {}
+      end
+    end
+  end
+end

data/lib/bridgetown-core/entry_filter.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class EntryFilter
+    attr_reader :site
+    SPECIAL_LEADING_CHAR_REGEX = %r!\A#{Regexp.union([".", "_", "#", "~"])}!o.freeze
+
+    def initialize(site, base_directory = nil)
+      @site = site
+      @base_directory = derive_base_directory(
+        @site, base_directory.to_s.dup
+      )
+    end
+
+    def base_directory
+      @base_directory.to_s
+    end
+
+    def derive_base_directory(site, base_dir)
+      base_dir[site.source] = "" if base_dir.start_with?(site.source)
+      base_dir
+    end
+
+    def relative_to_source(entry)
+      File.join(
+        base_directory, entry
+      )
+    end
+
+    def filter(entries)
+      entries.reject do |e|
+        # Reject this entry if it is just a "dot" representation.
+        #   e.g.: '.', '..', '_movies/.', 'music/..', etc
+        next true if e.end_with?(".")
+        # Reject this entry if it is a symlink.
+        next true if symlink?(e)
+        # Do not reject this entry if it is included.
+        next false if included?(e)
+
+        # Reject this entry if it is special, a backup file, or excluded.
+        special?(e) || backup?(e) || excluded?(e)
+      end
+    end
+
+    def included?(entry)
+      glob_include?(site.include, entry) ||
+        glob_include?(site.include, File.basename(entry))
+    end
+
+    def special?(entry)
+      SPECIAL_LEADING_CHAR_REGEX.match?(entry) ||
+        SPECIAL_LEADING_CHAR_REGEX.match?(File.basename(entry))
+    end
+
+    def backup?(entry)
+      entry.end_with?("~")
+    end
+
+    def excluded?(entry)
+      glob_include?(site.exclude - site.include, relative_to_source(entry)).tap do |excluded|
+        if excluded
+          Bridgetown.logger.debug(
+            "EntryFilter:",
+            "excluded #{relative_to_source(entry)}"
+          )
+        end
+      end
+    end
+
+    # --
+    # TODO: this is for old Safe mode and can be removed.
+    # --
+    def symlink?(_entry)
+      false
+    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)
+      !Pathutil.new(entry).in_path?(
+        site.in_source_dir
+      )
+    end
+
+    # Check if an entry matches a specific pattern.
+    # Returns true if path matches against any glob pattern, else false.
+    def glob_include?(enumerator, entry)
+      entry_with_source = PathManager.join(site.source, entry)
+
+      enumerator.any? do |pattern|
+        case pattern
+        when String
+          pattern_with_source = PathManager.join(site.source, pattern)
+
+          File.fnmatch?(pattern_with_source, entry_with_source) ||
+            entry_with_source.start_with?(pattern_with_source)
+        when Regexp
+          pattern.match?(entry_with_source)
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-core/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  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)
+    InvalidURLError             = Class.new(FatalException)
+    InvalidConfigurationError   = Class.new(FatalException)
+  end
+end

data/lib/bridgetown-core/excerpt.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class Excerpt
+    extend Forwardable
+
+    attr_accessor :doc
+    attr_accessor :content, :ext
+    attr_writer   :output
+
+    def_delegators :@doc,
+                   :site, :name, :ext, :extname,
+                   :collection, :related_posts, :type,
+                   :yaml_file?,
+                   :url, :next_doc, :previous_doc
+
+    private :yaml_file?
+
+    # Initialize this Excerpt instance.
+    #
+    # doc - The Document.
+    #
+    # Returns the new Excerpt.
+    def initialize(doc)
+      self.doc = doc
+      self.content = extract_excerpt(doc.content)
+    end
+
+    # Fetch YAML front-matter data from related doc, without layout key
+    #
+    # Returns Hash of doc data
+    def data
+      @data ||= doc.data.dup
+      @data.delete("layout")
+      @data.delete("excerpt")
+      @data
+    end
+
+    def trigger_hooks(*); end
+
+    # 'Path' of the excerpt.
+    #
+    # Returns the path for the doc this excerpt belongs to with #excerpt appended
+    def path
+      File.join(doc.path, "#excerpt")
+    end
+
+    # 'Relative Path' of the excerpt.
+    #
+    # Returns the relative_path for the doc this excerpt belongs to with #excerpt appended
+    def relative_path
+      @relative_path ||= File.join(doc.relative_path, "#excerpt")
+    end
+
+    # Check if excerpt includes a string
+    #
+    # Returns true if the string passed in
+    def include?(something)
+      output&.include?(something) || content.include?(something)
+    end
+
+    # The UID for this doc (useful in feeds).
+    # e.g. /2008/11/05/my-awesome-doc
+    #
+    # Returns the String UID.
+    def id
+      "#{doc.id}#excerpt"
+    end
+
+    def to_s
+      output || content
+    end
+
+    def to_liquid
+      Bridgetown::Drops::ExcerptDrop.new(self)
+    end
+
+    # Returns the shorthand String identifier of this doc.
+    def inspect
+      "<#{self.class} id=#{id}>"
+    end
+
+    def output
+      @output ||= Renderer.new(doc.site, self, site.site_payload).run
+    end
+
+    def place_in_layout?
+      false
+    end
+
+    def render_with_liquid?
+      return false if data["render_with_liquid"] == false
+
+      !(yaml_file? || !Utils.has_liquid_construct?(content))
+    end
+
+    protected
+
+    # Internal: Extract excerpt from the content
+    #
+    # By default excerpt is your first paragraph of a doc: everything before
+    # the first two new lines:
+    #
+    #     ---
+    #     title: Example
+    #     ---
+    #
+    #     First paragraph with [link][1].
+    #
+    #     Second paragraph.
+    #
+    #     [1]: http://example.com/
+    #
+    # This is fairly good option for Markdown and Textile files. But might cause
+    # problems for HTML docs (which is quite unusual for Bridgetown). If default
+    # excerpt delimiter is not good for you, you might want to set your own via
+    # configuration option `excerpt_separator`. For example, following is a good
+    # alternative for HTML docs:
+    #
+    #     # file: bridgetown.config.yml
+    #     excerpt_separator: "<!-- more -->"
+    #
+    # Notice that all markdown-style link references will be appended to the
+    # excerpt. So the example doc above will have this excerpt source:
+    #
+    #     First paragraph with [link][1].
+    #
+    #     [1]: http://example.com/
+    #
+    # Excerpts are rendered same time as content is rendered.
+    #
+    # Returns excerpt String
+
+    LIQUID_TAG_REGEX = %r!{%-?\s*(\w+)\s*.*?-?%}!m.freeze
+    MKDWN_LINK_REF_REGEX = %r!^ {0,3}(?:(\[[^\]]+\])(:.+))$!.freeze
+
+    def extract_excerpt(doc_content)
+      head, _, tail = doc_content.to_s.partition(doc.excerpt_separator)
+      return head if tail.empty?
+
+      head = sanctify_liquid_tags(head) if head.include?("{%")
+      definitions = extract_markdown_link_reference_defintions(head, tail)
+      return head if definitions.empty?
+
+      head << "\n\n" << definitions.join("\n")
+    end
+
+    private
+
+    # append appropriate closing tag(s) (for each Liquid block), to the `head` if the
+    # partitioning resulted in leaving the closing tag somewhere in the `tail` partition.
+    def sanctify_liquid_tags(head)
+      modified  = false
+      tag_names = head.scan(LIQUID_TAG_REGEX)
+      tag_names.flatten!
+      tag_names.reverse_each do |tag_name|
+        next unless liquid_block?(tag_name)
+        next if endtag_regex_stash(tag_name).match?(head)
+
+        modified = true
+        head << "\n{% end#{tag_name} %}"
+      end
+
+      print_build_warning if modified
+      head
+    end
+
+    def extract_markdown_link_reference_defintions(head, tail)
+      [].tap do |definitions|
+        tail.scan(MKDWN_LINK_REF_REGEX).each do |segments|
+          definitions << segments.join if head.include?(segments[0])
+        end
+      end
+    end
+
+    def endtag_regex_stash(tag_name)
+      @endtag_regex_stash ||= {}
+      @endtag_regex_stash[tag_name] ||= %r!{%-?\s*end#{tag_name}.*?\s*-?%}!m
+    end
+
+    def liquid_block?(tag_name)
+      return false unless tag_name.is_a?(String)
+      return false unless Liquid::Template.tags[tag_name]
+
+      Liquid::Template.tags[tag_name].ancestors.include?(Liquid::Block)
+    rescue NoMethodError
+      Bridgetown.logger.error "Error:", "A Liquid tag in the excerpt of" \
+                              " #{doc.relative_path} couldn't be parsed."
+      raise
+    end
+
+    def print_build_warning
+      Bridgetown.logger.warn "Warning:", "Excerpt modified in #{doc.relative_path}!"
+      Bridgetown.logger.warn "", "Found a Liquid block containing the excerpt separator" \
+                         " #{doc.excerpt_separator.inspect}. "
+      Bridgetown.logger.warn "", "The block has been modified with the appropriate closing tag."
+      Bridgetown.logger.warn "", "Feel free to define a custom excerpt or excerpt_separator in the"
+      Bridgetown.logger.warn "", "document's Front Matter if the generated excerpt is" \
+                                " unsatisfactory."
+    end
+  end
+end