bridgetown-core 0.13.0 → 0.15.0.beta3

data/lib/bridgetown-core/concerns/site/writable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Site::Writable
+    # Remove orphaned files and empty directories in destination.
+    #
+    # Returns nothing.
+    def cleanup
+      @cleaner.cleanup!
+    end
+
+    # Write static files, pages, and posts.
+    #
+    # Returns nothing.
+    def write
+      each_site_file do |item|
+        item.write(dest) if regenerator.regenerate?(item)
+      end
+      regenerator.write_metadata
+      Bridgetown::Hooks.trigger :site, :post_write, self
+    end
+
+    def each_site_file
+      %w(pages static_files docs_to_write).each do |type|
+        send(type).each do |item|
+          yield item
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-core/configuration.rb

@@ -4,7 +4,7 @@ module Bridgetown
   # TODO: refactor this whole object! Already had to fix obscure
   # bugs just making minor changes, and all the indirection is
   # quite hard to decipher. -JW
-  class Configuration < Hash
+  class Configuration < ActiveSupport::HashWithIndifferentAccess
     # Default options. Overridden by values in bridgetown.config.yml.
     # Strings rather than symbols are used for compatibility with YAML.
     DEFAULTS = {
@@ -91,7 +91,7 @@ module Bridgetown
       #
       # Returns a Configuration filled with defaults.
       def from(user_config)
-        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
+        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config])
           .merge_environment_specific_options!
           .add_default_collections
           .add_default_excludes
@@ -99,13 +99,6 @@ module Bridgetown
       end
     end
 
-    # Public: Turn all keys into string
-    #
-    # Return a copy of the hash where all its keys are strings
-    def stringify_keys
-      each_with_object({}) { |(k, v), hsh| hsh[k.to_s] = v }
-    end
-
     def get_config_value_with_override(config_key, override)
       override[config_key] || self[config_key] || DEFAULTS[config_key]
     end

data/lib/bridgetown-core/converters/markdown/kramdown_parser.rb

@@ -11,8 +11,6 @@ module Kramdown
       attr_reader :options, :parser
 
       # The implementation is basically the core logic in +Kramdown::Document#initialize+
-      #
-      # rubocop:disable Naming/MemoizedInstanceVariableName
       def setup(options)
         @cache ||= {}
 
@@ -36,7 +34,6 @@ module Kramdown
           end
         end
       end
-      # rubocop:enable Naming/MemoizedInstanceVariableName
 
       private
 

data/lib/bridgetown-core/document.rb

@@ -59,7 +59,7 @@ module Bridgetown
     # Returns a Hash containing the data. An empty hash is returned if
     #   no data was read.
     def data
-      @data ||= {}
+      @data ||= ActiveSupport::HashWithIndifferentAccess.new
     end
 
     # Merge some data in with this document's data.

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

@@ -7,7 +7,7 @@ module Bridgetown
 
       mutable false
 
-      def_delegators :@obj, :content, :dir, :name, :path, :url
+      def_delegators :@obj, :content, :dir, :name, :path, :url, :pager
       private def_delegator :@obj, :data, :fallback_data
     end
   end

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

@@ -7,7 +7,7 @@ module Bridgetown
 
       mutable false
 
-      def_delegator  :@obj, :site_data, :data
+      def_delegator  :@obj, :data
       def_delegators :@obj, :time, :pages, :static_files, :tags, :categories
 
       private def_delegator :@obj, :config, :fallback_data

data/lib/bridgetown-core/excerpt.rb

@@ -81,7 +81,10 @@ module Bridgetown
     end
 
     def output
-      @output ||= Renderer.new(doc.site, self, site.site_payload).run
+      @output || (
+        Renderer.new(doc.site, self, site.site_payload).run
+        @output
+      )
     end
 
     def place_in_layout?

data/lib/bridgetown-core/external.rb

@@ -10,13 +10,11 @@ module Bridgetown
       #
       def require_if_present(names)
         Array(names).each do |name|
-          begin
-            require name
-          rescue LoadError
-            Bridgetown.logger.debug "Couldn't load #{name}. Skipping."
-            yield(name, version_constraint(name)) if block_given?
-            false
-          end
+          require name
+        rescue LoadError
+          Bridgetown.logger.debug "Couldn't load #{name}. Skipping."
+          yield(name, version_constraint(name)) if block_given?
+          false
         end
       end
 
@@ -38,23 +36,21 @@ module Bridgetown
       #
       def require_with_graceful_fail(names)
         Array(names).each do |name|
-          begin
-            Bridgetown.logger.debug "Requiring:", name.to_s
-            require name
-          rescue LoadError => e
-            Bridgetown.logger.error "Dependency Error:", <<~MSG
-              Yikes! It looks like you don't have #{name} or one of its dependencies installed.
-              In order to use Bridgetown as currently configured, you'll need to install this gem.
+          Bridgetown.logger.debug "Requiring:", name.to_s
+          require name
+        rescue LoadError => e
+          Bridgetown.logger.error "Dependency Error:", <<~MSG
+            Yikes! It looks like you don't have #{name} or one of its dependencies installed.
+            In order to use Bridgetown as currently configured, you'll need to install this gem.
 
-              If you've run Bridgetown with `bundle exec`, ensure that you have included the #{name}
-              gem in your Gemfile as well.
+            If you've run Bridgetown with `bundle exec`, ensure that you have included the #{name}
+            gem in your Gemfile as well.
 
-              The full error message from Ruby is: '#{e.message}'
+            The full error message from Ruby is: '#{e.message}'
 
-              If you run into trouble, you can find helpful resources at https://bridgetownrb.com/help/!
-            MSG
-            raise Bridgetown::Errors::MissingDependencyException, name
-          end
+            If you run into trouble, you can find helpful resources at https://www.bridgetownrb.com/docs/community/
+          MSG
+          raise Bridgetown::Errors::MissingDependencyException, name
         end
       end
     end

data/lib/bridgetown-core/filters.rb

@@ -63,6 +63,16 @@ module Bridgetown
       Utils.slugify(input, mode: mode)
     end
 
+    # Titleize a slug or identifier string.
+    #
+    # input - The string to titleize.
+    #
+    # Returns a transformed string with spaces and capitalized words.
+    # See Utils.titleize_slug for more detail.
+    def titleize(input)
+      Utils.titleize_slug(input)
+    end
+
     # XML escape a string for use. Replaces any special characters with
     # appropriate HTML entity replacements.
     #

data/lib/bridgetown-core/generators/prototype_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Bridgetown::Hooks.register :pages, :post_init do |page|
+Bridgetown::Hooks.register :pages, :post_init, reloadable: false do |page|
   if page.class != Bridgetown::PrototypePage && page.data["prototype"].is_a?(Hash)
     Bridgetown::PrototypeGenerator.add_matching_template(page)
   end
@@ -63,6 +63,8 @@ module Bridgetown
       new_page
     end
 
+    # TODO: this would be a great use of .try
+    # document.try(:collection).try(:label) == @configured_collection
     def terms_matching_pages(search_term)
       selected_docs = @site.documents.select do |document|
         document.respond_to?(:collection) && document.collection.label == @configured_collection

data/lib/bridgetown-core/hooks.rb

@@ -2,6 +2,19 @@
 
 module Bridgetown
   module Hooks
+    HookRegistration = Struct.new(
+      :owner,
+      :event,
+      :priority,
+      :reloadable,
+      :block,
+      keyword_init: true
+    ) do
+      def to_s
+        "#{owner}:#{event} for #{block}"
+      end
+    end
+
     DEFAULT_PRIORITY = 20
 
     # compatibility layer for octopress-hooks users
@@ -12,51 +25,11 @@ module Bridgetown
     }.freeze
 
     # initial empty hooks
-    @registry = {
-      site: {
-        after_init: [],
-        after_reset: [],
-        post_read: [],
-        pre_render: [],
-        post_render: [],
-        post_write: [],
-      },
-      pages: {
-        post_init: [],
-        pre_render: [],
-        post_render: [],
-        post_write: [],
-      },
-      posts: {
-        post_init: [],
-        pre_render: [],
-        post_render: [],
-        post_write: [],
-      },
-      documents: {
-        post_init: [],
-        pre_render: [],
-        post_render: [],
-        post_write: [],
-      },
-      clean: {
-        on_obsolete: [],
-      },
-    }
-
-    # map of all hooks and their priorities
-    @hook_priority = {}
+    @registry = {}
 
     NotAvailable = Class.new(RuntimeError)
     Uncallable = Class.new(RuntimeError)
 
-    # register hook(s) to be called later, public API
-    def self.register(owners, event, priority: DEFAULT_PRIORITY, &block)
-      Array(owners).each do |owner|
-        register_one(owner, event, priority_value(priority), &block)
-      end
-    end
-
     # Ensure the priority is a Fixnum
     def self.priority_value(priority)
       return priority if priority.is_a?(Integer)
@@ -64,39 +37,66 @@ module Bridgetown
       PRIORITY_MAP[priority] || DEFAULT_PRIORITY
     end
 
-    # register a single hook to be called later, internal API
-    def self.register_one(owner, event, priority, &block)
-      @registry[owner] ||= {
-        post_init: [],
-        pre_render: [],
-        post_render: [],
-        post_write: [],
-      }
-
-      unless @registry[owner][event]
-        raise NotAvailable, "Invalid hook. #{owner} supports only the " \
-          "following hooks #{@registry[owner].keys.inspect}"
+    # register hook(s) to be called later
+    def self.register(owners, event, priority: DEFAULT_PRIORITY, reloadable: true, &block)
+      Array(owners).each do |owner|
+        register_one(owner, event, priority: priority, reloadable: reloadable, &block)
       end
+    end
+
+    # register a single hook to be called later
+    def self.register_one(owner, event, priority: DEFAULT_PRIORITY, reloadable: true, &block)
+      @registry[owner] ||= []
 
       raise Uncallable, "Hooks must respond to :call" unless block.respond_to? :call
 
-      insert_hook owner, event, priority, &block
+      @registry[owner] << HookRegistration.new(
+        owner: owner,
+        event: event,
+        priority: priority_value(priority),
+        reloadable: reloadable,
+        block: block
+      )
+      if ENV["BRIDGETOWN_LOG_LEVEL"] == "debug"
+        if Bridgetown.respond_to?(:logger)
+          Bridgetown.logger.debug("Registering hook:", @registry[owner].last.to_s)
+        else
+          p "Registering hook:", @registry[owner].last.to_s
+        end
+      end
+
+      block
     end
 
-    def self.insert_hook(owner, event, priority, &block)
-      @hook_priority[block] = [-priority, @hook_priority.size]
-      @registry[owner][event] << block
+    def self.remove_hook(owner, _event, block)
+      @registry[owner].delete_if { |item| item.block == block }
     end
 
-    # interface for Bridgetown core components to trigger hooks
     def self.trigger(owner, event, *args)
       # proceed only if there are hooks to call
-      hooks = @registry.dig(owner, event)
+      hooks = @registry[owner]&.select { |item| item.event == event }
       return if hooks.nil? || hooks.empty?
 
-      # sort and call hooks according to priority and load order
-      hooks.sort_by { |h| @hook_priority[h] }.each do |hook|
-        hook.call(*args)
+      prioritized_hooks(hooks).each do |hook|
+        if ENV["BRIDGETOWN_LOG_LEVEL"] == "debug"
+          hook_info = args[0]&.respond_to?(:url) ? args[0].relative_path : hook.block
+          Bridgetown.logger.debug("Triggering hook:", "#{owner}:#{event} for #{hook_info}")
+        end
+        hook.block.call(*args)
+      end
+    end
+
+    def self.prioritized_hooks(hooks)
+      # sort hooks according to priority and load order
+      grouped_hooks = hooks.group_by(&:priority)
+      grouped_hooks.keys.sort.reverse.map { |priority| grouped_hooks[priority] }.flatten
+    end
+
+    def self.clear_reloadable_hooks
+      Bridgetown.logger.debug("Clearing reloadable hooks")
+
+      @registry.each_value do |hooks|
+        hooks.delete_if(&:reloadable)
       end
     end
   end

data/lib/bridgetown-core/layout.rb

@@ -29,14 +29,20 @@ module Bridgetown
     #
     # site - The Site.
     # base - The String path to the source.
-    # name - The String filename of the post file.
-    def initialize(site, base, name)
+    # name - The String filename of the layout file.
+    # from_plugin - true if the layout comes from a Gem-based plugin folder.
+    def initialize(site, base, name, from_plugin: false)
       @site = site
       @base = base
       @name = name
 
-      @base_dir = site.source
-      @path = site.in_source_dir(base, name)
+      if from_plugin
+        @base_dir = base.sub("/layouts", "")
+        @path = File.join(base, name)
+      else
+        @base_dir = site.source
+        @path = site.in_source_dir(base, name)
+      end
       @relative_path = @path.sub(@base_dir, "")
 
       self.data = {}

data/lib/bridgetown-core/liquid_renderer.rb

@@ -26,6 +26,7 @@ module Bridgetown
     def reset
       @stats = {}
       @cache = {}
+      Renderer.cached_partials = {}
     end
 
     def file(filename)

data/lib/bridgetown-core/liquid_renderer/file.rb

@@ -10,11 +10,8 @@ module Bridgetown
 
       def parse(content)
         measure_time do
-          # Remove extraneous indentation for rendercontent tags
-          processed_content = content.gsub(%r!^[ \t]+{%-? rendercontent!, "{% rendercontent")
-
           @renderer.cache[@filename] ||= Liquid::Template.parse(
-            processed_content, line_numbers: true
+            content, line_numbers: true
           )
         end
         @template = @renderer.cache[@filename]

data/lib/bridgetown-core/liquid_renderer/file_system.rb

@@ -31,7 +31,9 @@ module Bridgetown
         raise Liquid::FileSystemError, "No such template '#{template_path}'" if found_paths.empty?
 
         # Last path in the list wins
-        ::File.read(found_paths.last, site.file_read_opts)
+        LiquidComponent.parse(
+          ::File.read(found_paths.last, site.file_read_opts)
+        ).content
       end
     end
   end

data/lib/bridgetown-core/page.rb

@@ -35,12 +35,18 @@ module Bridgetown
     # base - The String path to the source.
     # dir  - The String path between the source and the file.
     # name - The String filename of the file.
-    def initialize(site, base, dir, name)
+    # from_plugin - true if the Page file is located in a Gem-based plugin folder
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(site, base, dir, name, from_plugin: false)
       @site = site
       @base = base
       @dir  = dir
       @name = name
-      @path = site.in_source_dir(base, dir, name)
+      @path = if from_plugin
+                File.join(base, dir, name)
+              else
+                site.in_source_dir(base, dir, name)
+              end
 
       process(name)
       read_yaml(PathManager.join(base, dir), name)
@@ -51,6 +57,7 @@ module Bridgetown
 
       Bridgetown::Hooks.trigger :pages, :post_init, self
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # The generated directory into which the page will be placed
     # upon generation. This is derived from the permalink or, if
@@ -66,18 +73,6 @@ module Bridgetown
       end
     end
 
-    # For backwards-compatibility in subclasses that do not redefine
-    # the `:to_liquid` method, stash existing definition under a new name
-    #
-    # TODO: Remove in Bridgetown 5.0
-    alias_method :legacy_to_liquid, :to_liquid
-    private :legacy_to_liquid
-
-    # Private
-    # Subclasses can choose to optimize their `:to_liquid` method by wrapping
-    # it around this definition.
-    #
-    # TODO: Remove in Bridgetown 5.0
     def liquid_drop
       @liquid_drop ||= begin
         defaults = site.frontmatter_defaults.all(relative_path, type)
@@ -87,15 +82,12 @@ module Bridgetown
         Drops::PageDrop.new(self)
       end
     end
-    private :liquid_drop
 
     # Public
     #
     # Liquid representation of current page
-    #
-    # TODO: Remove optional parameter in Bridgetown 5.0
-    def to_liquid(attrs = nil)
-      self.class == Bridgetown::Page ? liquid_drop : legacy_to_liquid(attrs)
+    def to_liquid
+      liquid_drop
     end
 
     # The full path and filename of the post. Defined in the YAML of the post