bridgetown-core 2.0.0.beta2 → 2.0.0.beta3

data/lib/bridgetown-core/static_file.rb

@@ -48,11 +48,10 @@ module Bridgetown
       @path ||= File.join(*[@base, @dir, @name].compact)
     end
 
-    # Obtain destination path.
+    # Obtain destination path
     #
-    # dest - The String path to the destination dir.
-    #
-    # Returns destination file path.
+    # @param dest [String] path to the destination dir
+    # @return [String]
     def destination(dest)
       dest = site.in_dest_dir(dest)
       dest_url = url
@@ -76,22 +75,21 @@ module Bridgetown
 
     alias_method :date, :modified_time
 
-    # Returns last modification time for this file.
+    # @return [Integer] last modification time for this file
     def mtime
       modified_time.to_i
     end
 
     # Is source path modified?
     #
-    # Returns true if modified since last write.
+    # @return [Boolean] true if modified since last write
     def modified?
       self.class.mtimes[path] != mtime
     end
 
     # Whether to write the file to the filesystem
     #
-    # Returns true unless the defaults for the destination path from
-    # bridgetown.config.yml contain `published: false`.
+    # @return [Boolean] true unless the defaults for the destination path contain `published: false`
     def write?
       publishable = defaults.fetch("published", true)
       return publishable unless @collection
@@ -99,11 +97,10 @@ module Bridgetown
       publishable && @collection.write?
     end
 
-    # Write the static file to the destination directory (if modified).
-    #
-    # dest - The String path to the destination dir.
+    # Write the static file to the destination directory (if modified)
     #
-    # Returns false if the file was not modified since last time (no-op).
+    # @param dest [String] path to the destination dir
+    # @return [Boolean] false if the file was not modified since last time (no-op)
     def write(dest)
       dest_path = destination(dest)
       return false if File.exist?(dest_path) && !modified?
@@ -152,12 +149,12 @@ module Bridgetown
     #
     # NOTE: `String#gsub!` removes all trailing periods (in comparison to `String#chomp!`)
     #
-    # Examples:
+    # @example
     #   When `relative_path` is "_methods/site/my-cool-avatar...png":
     #     cleaned_relative_path
     #     # => "/site/my-cool-avatar"
     #
-    # Returns the cleaned relative path of the static file.
+    # @return [String] cleaned relative path of the static file
     def cleaned_relative_path
       @cleaned_relative_path ||= begin
         cleaned = relative_path[0..-extname.length - 1]
@@ -169,7 +166,7 @@ module Bridgetown
 
     # Applies a similar URL-building technique as resources that takes
     # the collection's URL template into account. The default URL template can
-    # be overriden in the collection's configuration in bridgetown.config.yml.
+    # be overriden in the collection's configuration
     def url
       @url ||= begin
         newly_processed = false
@@ -183,19 +180,17 @@ module Bridgetown
       end
     end
 
-    # Returns the type of the collection if present, nil otherwise.
+    # @return [Symbol, nil] type of the collection if present
     def type
       @type ||= @collection&.label&.to_sym
     end
 
-    # Returns the front matter defaults defined for the file's URL and/or type
-    # as defined in bridgetown.config.yml.
+    # @return [Hash] front matter defaults defined for the file's URL and/or type
     def defaults
       @defaults ||= site.frontmatter_defaults.all url, type
     end
 
-    # Returns a debug string on inspecting the static file.
-    # Includes only the relative path of the object.
+    # @return [String] includes only the relative path of the object
     def inspect
       "#<#{self.class} @relative_path=#{relative_path.inspect}>"
     end

data/lib/bridgetown-core/tags/class_map.rb

@@ -23,7 +23,7 @@ module Bridgetown
     class ClassMap < Liquid::Tag
       # @see https://api.rubyonrails.org/classes/ActiveModel/Type/Boolean.html
       FALSE_VALUES = [
-        nil, "nil", "NIL", false, 0, "0", :"0", "f", :f, "F", :F, "false",
+        nil, "nil", "NIL", 0, "0", :"0", "f", :f, "F", :F, "false",
         false, "FALSE", :FALSE,
       ].to_set.freeze
 

data/lib/bridgetown-core/tags/post_url.rb

@@ -12,7 +12,7 @@ module Bridgetown
 
         all, @path, @date, @slug = *name.sub(%r!^/!, "").match(MATCHER)
         unless all
-          raise Bridgetown::Errors::InvalidPostNameError,
+          raise Bridgetown::Errors::FatalException,
                 "'#{name}' does not contain valid date and/or title."
         end
 
@@ -31,24 +31,6 @@ module Bridgetown
       def ==(other)
         other.relative_path.to_s.match(@name_regex)
       end
-
-      def deprecated_equality(other)
-        slug == post_slug(other) &&
-          post_date.year  == other.date.year &&
-          post_date.month == other.date.month &&
-          post_date.day   == other.date.day
-      end
-
-      private
-
-      # Construct the directory-aware post slug for a Bridgetown::Post
-      #
-      # other - the Bridgetown::Post
-      #
-      # Returns the post slug with the subdirectory (relative to _posts)
-      def post_slug(other)
-        other.data.slug
-      end
     end
 
     class PostUrl < Liquid::Tag
@@ -75,19 +57,7 @@ module Bridgetown
         site.collections.posts.resources.each do |document|
           return relative_url(document) if @post == document
 
-          # New matching method did not match, fall back to old method
-          # with deprecation warning if this matches
-          next unless @post.deprecated_equality document
-
-          Bridgetown::Deprecator.deprecation_message(
-            "A call to " \
-            "'{% post_url #{@post.name} %}' did not match " \
-            "a post using the new matching method of checking name " \
-            "(path-date-slug) equality. Please make sure that you " \
-            "change this tag to match the post's name exactly."
-          )
-
-          return relative_url(document)
+          next
         end
 
         raise Bridgetown::Errors::PostURLError, <<~MSG

data/lib/bridgetown-core/utils/require_gems.rb

@@ -4,13 +4,11 @@ module Bridgetown
   module Utils
     module RequireGems
       class << self
-        #
         # Require a gem or gems. If it's not present, show a very nice error
         # message that explains everything and is much more helpful than the
         # normal LoadError.
         #
-        # names - a string gem name or array of gem names
-        #
+        # @param names [String, Array<String>] gem name or array of gem names
         def require_with_graceful_fail(names)
           Array(names).each do |name|
             Bridgetown.logger.debug "Requiring:", name.to_s

data/lib/bridgetown-core/utils.rb

@@ -49,15 +49,12 @@ module Bridgetown
       deep_merge_hashes!(master_hash.dup, other_hash)
     end
 
-    # Merges a master hash with another hash, recursively.
+    # Merges a master hash with another hash, recursively. This code was lovingly stolen from
+    # some random gem: https://rubygems.org/gems/tartan Thanks to whoever made it.
     #
-    # master_hash - the "parent" hash whose values will be overridden
-    # other_hash  - the other hash whose values will be persisted after the merge
-    #
-    # This code was lovingly stolen from some random gem:
-    # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
-    #
-    # Thanks to whoever made it.
+    # @param target [Hash] the "parent" hash whose values will be overridden
+    # @param overwrite [Hash] the other hash whose values will be persisted after the merge
+    # @return [Hash]
     def deep_merge_hashes!(target, overwrite)
       merge_values(target, overwrite)
       merge_default_proc(target, overwrite)
@@ -110,11 +107,9 @@ module Bridgetown
 
     # Parse a date/time and throw an error if invalid
     #
-    # input - the date/time to parse
-    # msg - (optional) the error message to show the user
-    #
-    # Returns the parsed date if successful, throws a FatalException
-    # if not
+    # @param input [String] the date/time to parse
+    # @param msg [String] the error message to show the user
+    # @return [Time] the parsed date if successful, throws a FatalException if not
     def parse_date(input, msg = "Input could not be parsed.")
       Time.parse(input).localtime
     rescue ArgumentError
@@ -140,35 +135,30 @@ module Bridgetown
       FrontMatter::Loaders::Ruby.header?(file)
     end
 
-    # Slugify a filename or title.
+    # Slugify a filename or title
     #
-    # string - the filename or title to slugify
-    # mode - how string is slugified
-    # cased - whether to replace all uppercase letters with their
-    # lowercase counterparts
+    # When mode is `none`, return the given string.
     #
-    # When mode is "none", return the given string.
-    #
-    # When mode is "raw", return the given string,
+    # When mode is `raw`, return the given string,
     # with every sequence of spaces characters replaced with a hyphen.
     #
-    # When mode is "default", "simple", or nil, non-alphabetic characters are
+    # When mode is `default`, `simple`, or `nil`, non-alphabetic characters are
     # replaced with a hyphen too.
     #
-    # When mode is "pretty", some non-alphabetic characters (._~!$&'()+,;=@)
+    # When mode is `pretty`, some non-alphabetic characters (`._~!$&'()+,;=@`)
     # are not replaced with hyphen.
     #
-    # When mode is "ascii", some everything else except ASCII characters
-    # a-z (lowercase), A-Z (uppercase) and 0-9 (numbers) are not replaced with hyphen.
+    # When mode is `ascii`, some everything else except ASCII characters
+    # `a-z` (lowercase), `A-Z` (uppercase) and `0-9` (numbers) are not replaced with hyphen.
     #
-    # When mode is "latin", the input string is first preprocessed so that
+    # When mode is `latin`, the input string is first preprocessed so that
     # any letters with accents are replaced with the plain letter. Afterwards,
-    # it follows the "default" mode of operation.
+    # it follows the `default` mode of operation.
     #
-    # If cased is true, all uppercase letters in the result string are
+    # If `cased` is `true`, all uppercase letters in the result string are
     # replaced with their lowercase counterparts.
     #
-    # Examples:
+    # @example
     #   slugify("The _config.yml file")
     #   # => "the-config-yml-file"
     #
@@ -184,7 +174,11 @@ module Bridgetown
     #   slugify("The _config.yml file", "latin")
     #   # => "the-config-yml-file"
     #
-    # Returns the slugified string.
+    # @param string [String] filename or title to slugify
+    # @param mode [String] how string is slugified
+    # @param cased [Boolean] whether to replace all uppercase letters with their
+    #   lowercase counterparts
+    # @return [String] the slugified string.
     def slugify(string, mode: nil, cased: false)
       mode ||= "default"
       return nil if string.nil?
@@ -210,13 +204,13 @@ module Bridgetown
     end
 
     # Work the same way as Dir.glob but seperating the input into two parts
-    # ('dir' + '/' + 'pattern') to make sure the first part('dir') does not act
+    # (`'dir' + '/' + 'pattern'`) to make sure the first part(`'dir'`) does not act
     # as a pattern.
     #
-    # For example, Dir.glob("path[/*") always returns an empty array,
-    # because the method fails to find the closing pattern to '[' which is ']'
+    # For example, `Dir.glob("path[/*")` always returns an empty array,
+    # because the method fails to find the closing pattern to `[` which is `]`
     #
-    # Examples:
+    # @example
     #   safe_glob("path[", "*")
     #   # => ["path[/file1", "path[/file2"]
     #
@@ -226,12 +220,13 @@ module Bridgetown
     #   safe_glob("path", ["**", "*"])
     #   # => ["path[/file1", "path[/folder/file2"]
     #
-    # dir      - the dir where glob will be executed under
-    #           (the dir will be included to each result)
-    # patterns - the patterns (or the pattern) which will be applied under the dir
-    # flags    - the flags which will be applied to the pattern
-    #
-    # Returns matched pathes
+    # @param dir [String] the dir where glob will be executed under
+    #   (the dir will be included to each result)
+    # @param patterns [String, Array<String>] the patterns (or the pattern) which will be applied
+    #   under the dir
+    # @param flags [Integer] the flags which will be applied to the pattern,
+    #   a bitwise OR of the `File::FNM_XXX` constants
+    # @return [Array<String>] matched pathes
     def safe_glob(dir, patterns, flags = 0)
       return [] unless Dir.exist?(dir)
 
@@ -243,8 +238,8 @@ module Bridgetown
       end
     end
 
-    # Returns merged option hash for File.read of self.site (if exists)
-    # and a given param
+    # @return [Hash] merged option hash for `File.read` of `site` (if exists)
+    #   and a given param
     def merged_file_read_opts(site, opts)
       merged = (site ? site.file_read_opts : {}).merge(opts)
       if merged[:encoding] && !merged[:encoding].start_with?("bom|")
@@ -256,8 +251,10 @@ module Bridgetown
       merged
     end
 
-    # Returns a string that's been reindented so that Markdown's four+ spaces =
-    # code doesn't get triggered for nested Liquid components
+    # Provides a string that's been reindented so that Markdown's four+ spaces =
+    #   code doesn't get triggered for nested components
+    # @param input [String]
+    # @return [String]
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
     def reindent_for_markdown(input)
       lines = input.lines

data/lib/bridgetown-core/watcher.rb

@@ -159,9 +159,8 @@ module Bridgetown
 
     # Paths to ignore for the watch option
     #
-    # options - A Hash of options passed to the command
-    #
-    # Returns a list of relative paths from source that should be ignored
+    # @param options [Bridgetown::Configuration] options loaded from config and/or CLI
+    # @return [Array<String>] list of relative paths from source that should be ignored
     def listen_ignore_paths(options)
       source = Pathname.new(options["source"]).expand_path
       paths  = to_exclude(options)

data/lib/bridgetown-core.rb

@@ -35,7 +35,7 @@ require "yaml"
 require "bridgetown-foundation"
 
 # 3rd party
-require "active_support" # TODO: remove by the end of 2024
+require "active_support" # TODO: remove by the end of 2025
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/string/output_safety"
@@ -76,7 +76,6 @@ module Bridgetown
   autoload :DefaultsReader,      "bridgetown-core/readers/defaults_reader"
   autoload :Deprecator,          "bridgetown-core/deprecator"
   autoload :EntryFilter,         "bridgetown-core/entry_filter"
-  # TODO: we have too many errors! This is silly
   autoload :Errors,              "bridgetown-core/errors"
   autoload :FrontMatter,         "bridgetown-core/front_matter"
   autoload :GeneratedPage,       "bridgetown-core/generated_page"

data/lib/roda/plugins/bridgetown_server.rb

@@ -158,17 +158,16 @@ class Roda
           scope.initialize_bridgetown_context
           scope.initialize_bridgetown_root
 
-          # Run the static file server
-          ssg
-
           # There are two different code paths depending on if there's a site `base_path` configured
           if Bridgetown::Current.preloaded_configuration.base_path == "/"
+            ssg # static file server
             Bridgetown::Rack::Routes.load_all scope
             return
           end
 
           # Support custom base_path configurations
           on(Bridgetown::Current.preloaded_configuration.base_path.delete_prefix("/")) do
+            ssg # static file server
             Bridgetown::Rack::Routes.load_all scope
           end
 

data/lib/site_template/package.json.erb

@@ -1,6 +1,7 @@
 {
   "name": "<%= @site_name %>",
   "version": "1.0.0",
+  "type": "module",
   "private": true,
   "scripts": {
     "esbuild": "node esbuild.config.js --minify",

data/lib/site_template/postcss.config.js.erb

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   plugins: {
     'postcss-flexbugs-fixes': {},
     'postcss-preset-env': {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.beta3
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: 2.0.0.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: 2.0.0.beta3
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -328,14 +328,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement