bridgetown-core 0.13.0 → 0.14.0

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Site::Content
+    # Construct a Hash of Posts indexed by the specified Post attribute.
+    #
+    # post_attr - The String name of the Post attribute.
+    #
+    # Examples
+    #
+    #   post_attr_hash('categories')
+    #   # => { 'tech' => [<Post A>, <Post B>],
+    #   #      'ruby' => [<Post B>] }
+    #
+    # Returns the Hash: { attr => posts } where
+    #   attr  - One of the values for the requested attribute.
+    #   posts - The Array of Posts with the given attr value.
+    def post_attr_hash(post_attr)
+      # Build a hash map based on the specified post attribute ( post attr =>
+      # array of posts ) then sort each array in reverse order.
+      @post_attr_hash[post_attr] ||= begin
+        hash = Hash.new { |h, key| h[key] = [] }
+        posts.docs.each do |p|
+          p.data[post_attr]&.each { |t| hash[t] << p }
+        end
+        hash.each_value { |posts| posts.sort!.reverse! }
+        hash
+      end
+    end
+
+    def tags
+      post_attr_hash("tags")
+    end
+
+    def categories
+      post_attr_hash("categories")
+    end
+
+    def metadata
+      data["site_metadata"] ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    # The Hash payload containing site-wide data.
+    #
+    # Returns the Hash: { "site" => data } where data is a Hash with keys:
+    #   "time"       - The Time as specified in the configuration or the
+    #                  current time if none was specified.
+    #   "posts"      - The Array of Posts, sorted chronologically by post date
+    #                  and then title.
+    #   "pages"      - The Array of all Pages.
+    #   "html_pages" - The Array of HTML Pages.
+    #   "categories" - The Hash of category values and Posts.
+    #                  See Site#post_attr_hash for type info.
+    #   "tags"       - The Hash of tag values and Posts.
+    #                  See Site#post_attr_hash for type info.
+    def site_payload
+      Drops::UnifiedPayloadDrop.new self
+    end
+    alias_method :to_liquid, :site_payload
+
+    # The list of collections and their corresponding Bridgetown::Collection instances.
+    # If config['collections'] is set, a new instance is created
+    # for each item in the collection, a new hash is returned otherwise.
+    #
+    # Returns a Hash containing collection name-to-instance pairs.
+    def collections
+      @collections ||= collection_names.each_with_object(
+        ActiveSupport::HashWithIndifferentAccess.new
+      ) do |name, hsh|
+        hsh[name] = Bridgetown::Collection.new(self, name)
+      end
+    end
+
+    # The list of collection names.
+    #
+    # Returns an array of collection names from the configuration,
+    #   or an empty array if the `collections` key is not set.
+    def collection_names
+      case config["collections"]
+      when Hash
+        config["collections"].keys
+      when Array
+        config["collections"]
+      when nil
+        []
+      else
+        raise ArgumentError, "Your `collections` key must be a hash or an array."
+      end
+    end
+
+    # Get all the documents
+    #
+    # Returns an Array of all Documents
+    def documents
+      collections.each_with_object(Set.new) do |(_, collection), set|
+        set.merge(collection.docs).merge(collection.files)
+      end.to_a
+    end
+
+    # Get the to be written documents
+    #
+    # Returns an Array of Documents which should be written
+    def docs_to_write
+      documents.select(&:write?)
+    end
+
+    def posts
+      collections["posts"] ||= Collection.new(self, "posts")
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Site::Extensible
+    # Load necessary libraries, plugins, converters, and generators.
+    #
+    # Returns nothing.
+    def setup
+      plugin_manager.require_plugin_files
+      self.converters = instantiate_subclasses(Bridgetown::Converter)
+      self.generators = instantiate_subclasses(Bridgetown::Generator)
+    end
+
+    # Run each of the Generators.
+    #
+    # Returns nothing.
+    def generate
+      generators.each do |generator|
+        start = Time.now
+        generator.generate(self)
+
+        next unless ENV["BRIDGETOWN_LOG_LEVEL"] == "debug"
+
+        generator_name = if generator.class.respond_to?(:custom_name)
+                           generator.class.custom_name
+                         else
+                           generator.class.name
+                         end
+        Bridgetown.logger.debug "Generating:",
+                                "#{generator_name} finished in #{Time.now - start} seconds."
+      end
+    end
+
+    # Get the implementation class for the given Converter.
+    # Returns the Converter instance implementing the given Converter.
+    # klass - The Class of the Converter to fetch.
+    def find_converter_instance(klass)
+      @find_converter_instance ||= {}
+      @find_converter_instance[klass] ||= begin
+        converters.find { |converter| converter.instance_of?(klass) } || \
+          raise("No Converters found for #{klass}")
+      end
+    end
+
+    # klass - class or module containing the subclasses.
+    # Returns array of instances of subclasses of parameter.
+    # Create array of instances of the subclasses of the class or module
+    # passed in as argument.
+
+    def instantiate_subclasses(klass)
+      klass.descendants.sort.map do |c|
+        c.new(config)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Site::Processable
+    # Public: Read, process, and write this Site to output.
+    #
+    # Returns nothing.
+    def process
+      reset
+      read
+      generate  # Extensible
+      render    # Renderable
+      cleanup   # Writable
+      write     # Writable
+      print_stats if config["profile"]
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    #
+    # Reset Site details.
+    #
+    # Returns nothing
+    def reset
+      self.time = if config["time"]
+                    Utils.parse_date(config["time"].to_s, "Invalid time in bridgetown.config.yml.")
+                  else
+                    Time.now
+                  end
+      self.layouts = ActiveSupport::HashWithIndifferentAccess.new
+      self.pages = []
+      self.static_files = []
+      self.data = ActiveSupport::HashWithIndifferentAccess.new
+      @post_attr_hash = {}
+      @collections = nil
+      @documents = nil
+      @docs_to_write = nil
+      @regenerator.clear_cache
+      @liquid_renderer.reset
+      frontmatter_defaults.reset
+
+      raise ArgumentError, "limit_posts must be a non-negative number" if limit_posts.negative?
+
+      Bridgetown::Cache.clear_if_config_changed config
+      Bridgetown::Hooks.trigger :site, :after_reset, self
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Read Site data from disk and load it into internal data structures.
+    #
+    # Returns nothing.
+    def read
+      Bridgetown::Hooks.trigger :site, :pre_read, self
+      reader.read
+      limit_posts!
+      Bridgetown::Hooks.trigger :site, :post_read, self
+    end
+
+    private
+
+    # Limits the current posts; removes the posts which exceed the limit_posts
+    #
+    # Returns nothing
+    def limit_posts!
+      if limit_posts.positive?
+        limit = posts.docs.length < limit_posts ? posts.docs.length : limit_posts
+        posts.docs = posts.docs[-limit, limit]
+      end
+    end
+
+    def print_stats
+      Bridgetown.logger.info @liquid_renderer.stats_table
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Site::Renderable
+    # Render the site to the destination.
+    #
+    # Returns nothing.
+    def render
+      payload = site_payload
+
+      Bridgetown::Hooks.trigger :site, :pre_render, self, payload
+
+      execute_inline_ruby_for_layouts!
+
+      render_docs(payload)
+      render_pages(payload)
+
+      Bridgetown::Hooks.trigger :site, :post_render, self, payload
+    end
+
+    def execute_inline_ruby_for_layouts!
+      return unless config.should_execute_inline_ruby?
+
+      layouts.each_value do |layout|
+        Bridgetown::Utils::RubyExec.search_data_for_ruby_code(layout, self)
+      end
+    end
+
+    def render_docs(payload)
+      collections.each_value do |collection|
+        collection.docs.each do |document|
+          render_regenerated(document, payload)
+        end
+      end
+    end
+
+    def render_pages(payload)
+      pages.each do |page|
+        render_regenerated(page, payload)
+      end
+    end
+
+    def render_regenerated(document, payload)
+      return unless regenerator.regenerate?(document)
+
+      document.output = Bridgetown::Renderer.new(self, document, payload).run
+      document.trigger_hooks(:post_render)
+    end
+  end
+end

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/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/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