bridgetown-core 0.21.4 → 1.0.0.alpha4

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

@@ -44,7 +44,7 @@ module Kramdown
       end
     end
 
-    def initialize(source, options = {})
+    def initialize(source, options = {}) # rubocop:disable Lint/MissingSuper
       BridgetownDocument.setup(options)
 
       @options = BridgetownDocument.options

data/lib/bridgetown-core/converters/smartypants.rb

@@ -25,6 +25,7 @@ module Bridgetown
       priority :low
 
       def initialize(config)
+        super
         unless defined?(Kramdown)
           Bridgetown::Utils::RequireGems.require_with_graceful_fail "kramdown"
         end

data/lib/bridgetown-core/current.rb

@@ -6,5 +6,9 @@ module Bridgetown
     #   @return [Bridgetown::Site]
 
     attribute :site
+
+    # @!method self.preloaded_configuration
+    #   @return [Bridgetown::Configuration]
+    attribute :preloaded_configuration
   end
 end

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

@@ -8,7 +8,7 @@ module Bridgetown
       mutable false
 
       def_delegator  :@obj, :write?, :output
-      def_delegators :@obj, :label, :docs, :files, :relative_path, :resources, :static_files
+      def_delegators :@obj, :label, :files, :relative_path, :resources, :static_files
 
       private def_delegator :@obj, :metadata, :fallback_data
 

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

@@ -28,7 +28,7 @@ module Bridgetown
       # drop.
       #
       # Returns nothing
-      def initialize(obj)
+      def initialize(obj) # rubocop:disable Lint/MissingSuper
         @obj = obj
       end
 
@@ -69,11 +69,11 @@ module Bridgetown
         if respond_to?(setter)
           public_send(setter, val)
         elsif respond_to?(key.to_s)
-          if self.class.mutable?
-            mutations[key] = val
-          else
+          unless self.class.mutable?
             raise Errors::DropMutationException, "Key #{key} cannot be set in the drop."
           end
+
+          mutations[key] = val
         else
           fallback_data[key] = val
         end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Drops
+    class GeneratedPageDrop < Drop
+      extend Forwardable
+
+      mutable false
+
+      def_delegators :@obj,
+                     :data,
+                     :content,
+                     :dir,
+                     :name,
+                     :path,
+                     :url,
+                     :relative_url,
+                     :relative_path
+
+      private def_delegator :@obj, :data, :fallback_data
+    end
+  end
+end

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

@@ -11,7 +11,6 @@ module Bridgetown
 
       mutable false
 
-      def_delegator :@obj, :relative_path, :path
       def_delegators :@obj,
                      :id,
                      :data,
@@ -20,6 +19,7 @@ module Bridgetown
                      :summary,
                      :to_s,
                      :absolute_url,
+                     :path,
                      :relative_path,
                      :relative_url,
                      :date,
@@ -32,8 +32,8 @@ module Bridgetown
         @collection ||= @obj.collection.to_liquid
       end
 
-      def excerpt
-        fallback_data["excerpt"].to_s
+      def relative_path
+        @relative_path ||= @obj.relative_path.to_s
       end
 
       def <=>(other)

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

@@ -13,7 +13,6 @@ module Bridgetown
                      :data,
                      :locale,
                      :time,
-                     :pages,
                      :generated_pages,
                      :static_files,
                      :tags,
@@ -25,51 +24,10 @@ module Bridgetown
 
       attr_writer :current_document
 
-      def [](key)
-        if !@obj.uses_resource? && !%w(posts data).freeze.include?(key) &&
-            @obj.collections.key?(key)
-          return @obj.collections[key].docs
-        end
-
-        super(key)
-      end
-
-      def key?(key)
-        (!@obj.uses_resource? && key != "posts" && @obj.collections.key?(key)) || super
-      end
-
       def uses_resource
         @obj.uses_resource?
       end
 
-      def posts
-        unless @obj.uses_resource?
-          @site_posts ||= @obj.collections.posts.docs.sort { |a, b| b <=> a }
-        end
-      end
-
-      # TODO: deprecate before v1.0
-      def html_pages
-        @site_html_pages ||= @obj.pages.select do |page|
-          page.html? || page.url.end_with?("/")
-        end
-      end
-
-      # TODO: deprecate before v1.0
-      def collections
-        @site_collections ||= @obj.collections.values.sort_by(&:label).map(&:to_liquid)
-      end
-
-      # `Site#documents` cannot be memoized so that `Site#docs_to_write` can access the
-      # latest state of the attribute.
-      #
-      # Since this method will be called after `Site#pre_render` hook, the `Site#documents`
-      # array shouldn't thereafter change and can therefore be safely memoized to prevent
-      # additional computation of `Site#documents`.
-      def documents
-        @documents ||= @obj.documents
-      end
-
       def resources
         @resources ||= @obj.resources
       end
@@ -82,11 +40,9 @@ module Bridgetown
         @site_metadata ||= @obj.data["site_metadata"]
       end
 
-      # TODO: change this so you *do* use site.config...aka site.config.timezone,
-      # not site.timezone
-      #
-      # return nil for `{{ site.config }}` even if --config was passed via CLI
-      def config; end
+      def config
+        @obj.config
+      end
     end
   end
 end

data/lib/bridgetown-core/entry_filter.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class EntryFilter
     attr_reader :site
+
     SPECIAL_LEADING_CHAR_REGEX = %r!\A#{Regexp.union([".", "_", "#", "~"])}!o.freeze
     SPECIAL_LEADING_CHAR_NO_UNDERSCORES_REGEX = %r!\A#{Regexp.union([".", "#", "~"])}!o.freeze
 

data/lib/bridgetown-core/filters/url_filters.rb

@@ -51,6 +51,7 @@ module Bridgetown
 
       def compute_absolute_url(input)
         return if input.nil?
+        return input.absolute_url if input.respond_to?(:absolute_url)
 
         input = input.url if input.respond_to?(:url)
         return input if Addressable::URI.parse(input.to_s).absolute?
@@ -66,6 +67,7 @@ module Bridgetown
 
       def compute_relative_url(input)
         return if input.nil?
+        return input.relative_url if input.respond_to?(:relative_url)
 
         input = input.url if input.respond_to?(:url)
         return input if Addressable::URI.parse(input.to_s).absolute?

data/lib/bridgetown-core/filters.rb

@@ -104,7 +104,7 @@ module Bridgetown
     def obfuscate_link(input, prefix = "mailto")
       link = "<a href=\"#{prefix}:#{input}\">#{input}</a>"
       script = "<script type=\"text/javascript\">document.currentScript.insertAdjacentHTML('"
-      script += "beforebegin', '#{rot47(link).gsub(%r!\\!, '\\\\\\')}'.replace(/[!-~]/g,"
+      script += "beforebegin', '#{rot47(link).gsub(%r!\\!, '\\\\\\')}'.replace(/[!-~]/g," # rubocop:disable Style/StringLiteralsInInterpolation
       script += "function(c){{var j=c.charCodeAt(0);if((j>=33)&&(j<=126)){"
       script += "return String.fromCharCode(33+((j+ 14)%94));}"
       script += "else{return String.fromCharCode(j);}}}));</script>"
@@ -180,7 +180,7 @@ module Bridgetown
     #            their `#inspect` string object.
     #
     # Returns the filtered array of objects
-    def where(input, property, value)
+    def where(input, property, value) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       return input if !property || value.is_a?(Array) || value.is_a?(Hash)
       return input unless input.respond_to?(:select)
 
@@ -194,11 +194,9 @@ module Bridgetown
       @where_filter_cache[input_id][property] ||= {}
 
       # stash or retrive results to return
-      @where_filter_cache[input_id][property][value] ||= begin
-        input.select do |object|
-          compare_property_vs_target(item_property(object, property), value)
-        end.to_a
-      end
+      @where_filter_cache[input_id][property][value] ||= input.select do |object|
+        compare_property_vs_target(item_property(object, property), value)
+      end.to_a
     end
 
     # Filters an array of objects against an expression
@@ -247,13 +245,14 @@ module Bridgetown
       if property.nil?
         input.sort
       else
-        if nils == "first"
+        case nils
+        when "first"
           order = - 1
-        elsif nils == "last"
+        when "last"
           order = + 1
         else
           raise ArgumentError, "Invalid nils order: " \
-            "'#{nils}' is not a valid nils order. It must be 'first' or 'last'."
+                               "'#{nils}' is not a valid nils order. It must be 'first' or 'last'."
         end
 
         sort_input(input, property, order)
@@ -327,7 +326,7 @@ module Bridgetown
     # If the property doesn't exist, return the sort order respective of
     # which item doesn't have the property.
     # We also utilize the Schwartzian transform to make this more efficient.
-    def sort_input(input, property, order)
+    def sort_input(input, property, order) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       input.map { |item| [item_property(item, property), item] }
         .sort! do |a_info, b_info|
           a_property = a_info.first
@@ -413,7 +412,7 @@ module Bridgetown
       case item
       when Hash
         pairs = item.map { |k, v| as_liquid([k, v]) }
-        Hash[pairs]
+        Hash[pairs] # rubocop:todo Style/HashConversion
       when Array
         item.map { |i| as_liquid(i) }
       else

data/lib/bridgetown-core/frontmatter_defaults.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  # This class handles custom defaults for YAML frontmatter variables.
+  # This class handles custom defaults for front matter settings.
   # It is exposed via the frontmatter_defaults method on the site class.
-  # TODO: needs simplification/refactoring.
   class FrontmatterDefaults
     # @return [Bridgetown::Site]
     attr_reader :site
@@ -16,24 +15,6 @@ module Bridgetown
       @glob_cache = {}
     end
 
-    def update_deprecated_types(set)
-      return set unless set.key?("scope") && set["scope"].key?("type")
-
-      set["scope"]["type"] =
-        case set["scope"]["type"]
-        when "page"
-          Deprecator.defaults_deprecate_type("page", "pages")
-          "pages"
-        when "post"
-          Deprecator.defaults_deprecate_type("post", "posts")
-          "posts"
-        else
-          set["scope"]["type"]
-        end
-
-      set
-    end
-
     def ensure_time!(set)
       return set unless set.key?("values") && set["values"].key?("date")
       return set if set["values"]["date"].is_a?(Time)
@@ -45,44 +26,19 @@ module Bridgetown
       set
     end
 
-    # TODO: deprecated. See `all` method instead
-    #
-    # path - the path (relative to the source) of the page or
-    # post the default is used in
-    # type - a symbol indicating whether a :page,
-    # a :post calls this method
-    #
-    # Returns the default value or nil if none was found
-    def find(path, type, setting)
-      merged_data = {}
-      merge_data_cascade_for_path(path, merged_data)
-      return merged_data[setting] if merged_data.key?(setting)
-
-      value = nil
-      old_scope = nil
-
-      matching_sets(path, type).each do |set|
-        if set["values"].key?(setting) && has_precedence?(old_scope, set["scope"])
-          value = set["values"][setting]
-          old_scope = set["scope"]
-        end
-      end
-      value
-    end
-
-    # Collects a hash with all default values for a page or post
+    # Collects a hash with all default values for a resource
     #
-    # path - the relative path of the page or post
-    # type - a symbol indicating the type (:post or :page)
+    # @param path [String] the relative path of the resource
+    # @param collection [Symbol] :posts, :pages, etc.
     #
-    # Returns a hash with all default values (an empty hash if there are none)
-    def all(path, type)
+    # @returns [Hash] all default values (an empty hash if there are none)
+    def all(path, collection)
       defaults = {}
 
       merge_data_cascade_for_path(path, defaults)
 
       old_scope = nil
-      matching_sets(path, type).each do |set|
+      matching_sets(path, collection).each do |set|
         if has_precedence?(old_scope, set["scope"])
           defaults = Utils.deep_merge_hashes(defaults, set["values"])
           old_scope = set["scope"]
@@ -105,22 +61,22 @@ module Bridgetown
         end
     end
 
-    # Checks if a given default setting scope matches the given path and type
+    # Checks if a given default setting scope matches the given path and collection
     #
     # scope - the hash indicating the scope, as defined in bridgetown.config.yml
     # path - the path to check for
-    # type - the type (:post or :page) to check for
+    # collection - the collection (:posts or :pages) to check for
     #
-    # Returns true if the scope applies to the given type and path
-    def applies?(scope, path, type)
-      applies_type?(scope, type) && applies_path?(scope, path)
+    # Returns true if the scope applies to the given collection and path
+    def applies?(scope, path, collection)
+      applies_collection?(scope, collection) && applies_path?(scope, path)
     end
 
     def applies_path?(scope, path)
       rel_scope_path = scope["path"]
       return true if !rel_scope_path.is_a?(String) || rel_scope_path.empty?
 
-      sanitized_path = sanitize_path(path)
+      sanitized_path = strip_collections_dir(sanitize_path(path))
 
       if rel_scope_path.include?("*")
         glob_scope(sanitized_path, rel_scope_path)
@@ -159,26 +115,24 @@ module Bridgetown
       path.sub(slashed_coll_dir, "")
     end
 
-    # Determines whether the scope applies to type.
-    # The scope applies to the type if:
-    #   1. no 'type' is specified
-    #   2. the 'type' in the scope is the same as the type asked about
+    # Determines whether the scope applies to collection.
+    # The scope applies to the collection if:
+    #   1. no 'collection' is specified
+    #   2. the 'collection' in the scope is the same as the collection asked about
     #
-    # scope - the Hash defaults set being asked about application
-    # type  - the type of the document being processed / asked about
-    #         its defaults.
+    # @param scope [Hash] the defaults set being asked about
+    # @param collection [Symbol] the collection of the resource being processed
     #
-    # Returns true if either of the above conditions are satisfied,
-    #   otherwise returns false
-    def applies_type?(scope, type)
-      !scope.key?("type") || scope["type"].eql?(type.to_s)
+    # @returns [Boolean] whether either of the above conditions are satisfied
+    def applies_collection?(scope, collection)
+      !scope.key?("collection") || scope["collection"].eql?(collection.to_s)
     end
 
     # Checks if a given set of default values is valid
     #
-    # set - the default value hash, as defined in bridgetown.config.yml
+    # @param set [Hash] the default value hash as defined in bridgetown.config.yml
     #
-    # Returns true if the set is valid and can be used in this class
+    # @returns [Boolean] if the set is valid and can be used
     def valid?(set)
       set.is_a?(Hash) && set["values"].is_a?(Hash)
     end
@@ -198,24 +152,22 @@ module Bridgetown
 
       if new_path.length != old_path.length
         new_path.length >= old_path.length
-      elsif new_scope.key?("type")
+      elsif new_scope.key?("collection")
         true
       else
-        !old_scope.key? "type"
+        !old_scope.key? "collection"
       end
     end
     # rubocop: enable Naming/PredicateName
 
-    # Collects a list of sets that match the given path and type
+    # Collects a list of sets that match the given path and collection
     #
-    # Returns an array of hashes
-    def matching_sets(path, type)
+    # @return [Array<Hash>]
+    def matching_sets(path, collection)
       @matched_set_cache ||= {}
       @matched_set_cache[path] ||= {}
-      @matched_set_cache[path][type] ||= begin
-        valid_sets.select do |set|
-          !set.key?("scope") || applies?(set["scope"], path, type)
-        end
+      @matched_set_cache[path][collection] ||= valid_sets.select do |set|
+        !set.key?("scope") || applies?(set["scope"], path, collection)
       end
     end
 
@@ -224,14 +176,16 @@ module Bridgetown
     # This is not cached to allow plugins to modify the configuration
     # and have their changes take effect
     #
-    # Returns an array of hashes
+    # @return [Array<Hash>]
     def valid_sets
       sets = site.config["defaults"]
       return [] unless sets.is_a?(Array)
 
       sets.map do |set|
         if valid?(set)
-          ensure_time!(update_deprecated_types(set))
+          massage_scope!(set)
+          # TODO: is this trip really necessary?
+          ensure_time!(set)
         else
           Bridgetown.logger.warn "Defaults:", "An invalid front-matter default set was found:"
           Bridgetown.logger.warn set.to_s
@@ -240,10 +194,18 @@ module Bridgetown
       end.compact
     end
 
-    # Sanitizes the given path by removing a leading and adding a trailing slash
+    # Set path to blank if not specified and alias older type to collection
+    def massage_scope!(set)
+      set["scope"] ||= {}
+      set["scope"]["path"] ||= ""
+      return unless set["scope"]["type"] && !set["scope"]["collection"]
+
+      set["scope"]["collection"] = set["scope"]["type"]
+    end
 
     SANITIZATION_REGEX = %r!\A/|(?<=[^/])\z!.freeze
 
+    # Sanitizes the given path by removing a leading and adding a trailing slash
     def sanitize_path(path)
       if path.nil? || path.empty?
         ""

data/lib/bridgetown-core/{page.rb → generated_page.rb}

@@ -1,18 +1,13 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  # TODO: to be retired once the Resource engine is made official
-  class Page
-    include DataAccessible
+  class GeneratedPage
     include LayoutPlaceable
     include LiquidRenderable
     include Publishable
-    include Validatable
 
     attr_writer :dir
-    attr_accessor :site, :paginator, :pager
-    attr_accessor :name, :ext, :basename
-    attr_accessor :data, :content, :output
+    attr_accessor :site, :paginator, :name, :ext, :basename, :data, :content, :output
 
     alias_method :extname, :ext
 
@@ -25,7 +20,7 @@ module Bridgetown
       .htm
     ).freeze
 
-    # Initialize a new Page.
+    # Initialize a new GeneratedPage.
     #
     # site - The Site object.
     # base - The String path to the source.
@@ -38,23 +33,36 @@ module Bridgetown
       @base = base
       @dir  = dir
       @name = name
+      @ext = File.extname(name)
+      @basename = File.basename(name, ".*")
       @path = if from_plugin
                 File.join(base, dir, name)
               else
                 site.in_source_dir(base, dir, name)
               end
 
-      process(name)
-      read_yaml(File.join(base, dir), name)
+      process
 
-      data.default_proc = proc do |_, key|
-        site.frontmatter_defaults.find(relative_path, type, key.to_s)
-      end
+      self.data ||= HashWithDotAccess::Hash.new
 
-      Bridgetown::Hooks.trigger :pages, :post_init, self
+      Bridgetown::Hooks.trigger :generated_pages, :post_init, self
     end
     # rubocop:enable Metrics/ParameterLists
 
+    # Returns the contents as a String.
+    def to_s
+      output || content || ""
+    end
+
+    # Accessor for data properties by Liquid.
+    #
+    # property - The String name of the property to retrieve.
+    #
+    # Returns the String value or nil if the property isn't included.
+    def [](property)
+      data[property]
+    end
+
     # The generated directory into which the page will be placed
     # upon generation. This is derived from the permalink or, if
     # permalink is absent, will be '/'
@@ -69,29 +77,15 @@ module Bridgetown
       end
     end
 
-    def liquid_drop
-      @liquid_drop ||= begin
-        defaults = site.frontmatter_defaults.all(relative_path, type)
-        unless defaults.empty?
-          Utils.deep_merge_hashes!(data, Utils.deep_merge_hashes!(defaults, data))
-        end
-        Drops::PageDrop.new(self)
-      end
-    end
-
-    # Public
-    #
     # Liquid representation of current page
     def to_liquid
-      liquid_drop
+      @liquid_drop ||= Drops::GeneratedPageDrop.new(self)
     end
 
     # The full path and filename of the post. Defined in the YAML of the post
-    # body.
-    #
-    # Returns the String permalink or nil if none has been set.
+    # body
     def permalink
-      data.nil? ? nil : data["permalink"]
+      data&.permalink
     end
 
     # The template of the permalink.
@@ -123,33 +117,20 @@ module Bridgetown
     # desired placeholder replacements. For details see "url.rb"
     def url_placeholders
       {
-        path: qualified_pages_path_for_url,
-        basename: basename,
+        path: @dir,
+        basename: @basename,
         output_ext: output_ext,
       }
     end
 
-    # Strips _pages prefix off if needed for the url/destination generation
-    # @return [String]
-    def qualified_pages_path_for_url
-      @dir.sub(%r!^/_pages!, "")
-    end
-
-    # Extract information from the page filename.
-    #
-    # name - The String filename of the page file.
-    #
-    # NOTE: `String#gsub` removes all trailing periods (in comparison to `String#chomp`)
-    # Returns nothing.
-    def process(name)
-      self.ext = File.extname(name)
-      self.basename = name[0..-ext.length - 1].gsub(%r!\.*\z!, "")
+    # Overide this in subclasses for custom initialization behavior
+    def process
+      # no-op by default
     end
 
     # The path to the source file
-    #
-    # Returns the path to the source file
     def path
+      # TODO: is this trip really necessary?!
       data.fetch("path") { relative_path }
     end
 
@@ -190,7 +171,7 @@ module Bridgetown
       FileUtils.mkdir_p(File.dirname(path))
       Bridgetown.logger.debug "Writing:", path
       File.write(path, output, mode: "wb")
-      Bridgetown::Hooks.trigger :pages, :post_write, self
+      Bridgetown::Hooks.trigger :generated_pages, :post_write, self
     end
 
     # Returns the object as a debug String.
@@ -209,22 +190,15 @@ module Bridgetown
     end
 
     def trigger_hooks(hook_name, *args)
-      Bridgetown::Hooks.trigger :pages, hook_name, self, *args
+      Bridgetown::Hooks.trigger :generated_pages, hook_name, self, *args
     end
 
     def type
-      :pages
+      :generated_pages
     end
 
     def write?
       true
     end
   end
-
-  # set up virtual page class for future compatibility
-  class GeneratedPage < Page
-    def read_yaml(_base, _name, _opts = {})
-      self.data ||= HashWithDotAccess::Hash.new
-    end
-  end
 end