bridgetown-core 0.21.0.beta2 → 0.21.1

data/lib/bridgetown-core/commands/webpack/setup.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+template "webpack.defaults.js.erb", "config/webpack.defaults.js"
+copy_file "webpack.config.js", force: true

data/lib/bridgetown-core/commands/webpack/update.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+
+required_packages = %w(esbuild esbuild-loader webpack@5.39.1 webpack-cli@4.7.2 webpack-manifest-plugin@3.1.1)
+redundant_packages = %w(@babel/core @babel/plugin-proposal-class-properties @babel/plugin-proposal-decorators @babel/plugin-transform-runtime @babel/preset-env babel-loader)
+
+template "webpack.defaults.js.erb", "config/webpack.defaults.js", force: true
+say "🎉 Webpack configuration updated successfully!"
+
+return if Bridgetown.environment.test?
+
+say "Installing required packages"
+run "yarn add -D #{required_packages.join(" ")}"
+
+packages_to_remove = package_json["devDependencies"].slice(*redundant_packages).keys
+unless packages_to_remove.empty?
+  confirm = ask "\nThe following packages will be removed: \n\n#{packages_to_remove.join("\n")}\n\nWould you like to continue? [Yn]"
+  return unless confirm.casecmp?("Y")
+
+  run "yarn remove #{packages_to_remove.join(" ")}"
+end
+
+# rubocop:enable Layout/LineLength

data/lib/bridgetown-core/commands/webpack/webpack.config.js

@@ -0,0 +1,31 @@
+const { merge } = require('webpack-merge')
+
+var config = require("./config/webpack.defaults.js")
+
+// Add any overrides to the default webpack config here:
+//
+// Eg:
+//
+//  ```
+//    const path = require("path")
+//    config.resolve.modules.push(path.resolve(__dirname, 'frontend', 'components'))
+//    config.resolve.alias.frontendComponents = path.resolve(__dirname, 'frontend', 'components')
+//  ```
+//
+// You can also merge in a custom config using the included `webpack-merge` package.
+// Complete docs available at: https://github.com/survivejs/webpack-merge
+//
+// Eg:
+//
+//  ```
+//    const customConfig = { ..... }
+//    config = merge(config, customConfig)
+//  ```
+
+
+
+
+
+////////////////////////////////////////////////////////
+
+module.exports = config

data/lib/bridgetown-core/commands/webpack/webpack.defaults.js.erb

@@ -0,0 +1,130 @@
+// This file is created and managed by Bridgetown.
+// Instead of editing this file, add your overrides to `webpack.config.js`
+//
+// To update this file to the latest version provided by Bridgetown,
+// run `bridgetown webpack update`. Any changes to this file will be overwritten
+// when an update is applied hence we strongly recommend adding overrides to
+// `webpack.config.js` instead of editing this file.
+//
+// Shipped with Bridgetown v<%= Bridgetown::VERSION %>
+
+const path = require("path");
+const rootDir = path.resolve(__dirname, "..")
+const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const { WebpackManifestPlugin } = require("webpack-manifest-plugin");
+
+// Input and output
+
+const entry = { main: path.resolve(rootDir, "frontend", "javascript", "index.js") }
+const output = {
+  path: path.resolve(rootDir, "output", "_bridgetown", "static", "js"),
+  filename: "[name].[contenthash].js",
+  publicPath: "",
+}
+
+// Rules and Loaders
+
+const jsRule =  {
+  test: /\.(js|jsx)/,
+  use: {
+    loader: "esbuild-loader",
+    options: {
+      target: 'es2016'
+    },
+  },
+}
+
+const cssRules = {
+  test: /\.(s[ac]|c)ss$/,
+  use: [
+    MiniCssExtractPlugin.loader,
+    {
+      loader: "css-loader",
+      options: {
+        url: url => !url.startsWith('/'),
+        importLoaders: 1
+      }
+    }
+  ],
+  mode: '<%= self.config.uses_postcss? ? "postcss" : "sass" %>',
+
+  postcss: () => {
+    cssRules.use.push("postcss-loader")
+    return { test: cssRules.test, use: cssRules.use }
+  },
+
+  sass: () => {
+    cssRules.use.push({
+      loader: "sass-loader",
+      options: {
+        implementation: require("sass"),
+        sassOptions: {
+          fiber: false,
+          includePaths: [
+            path.resolve(rootDir, "src/_components")
+          ],
+        },
+      },
+    })
+    return { test: cssRules.test, use: cssRules.use }
+  }
+}
+
+const fontsRule = {
+  test: /\.woff2?$|\.ttf$|\.eot$/,
+  loader: "file-loader",
+  options: {
+    name: "[name]-[contenthash].[ext]",
+    outputPath: "../fonts",
+    publicPath: "../fonts",
+  },
+}
+
+const imagesRule = {
+  test: /\.png?$|\.gif$|\.jpg$|\.svg$/,
+  loader: "file-loader",
+  options: {
+    name: "[path][name]-[contenthash].[ext]",
+    outputPath: "../",
+    publicPath: "../",
+  },
+}
+
+// Default configuration object
+
+module.exports = {
+  entry: entry,
+  devtool: "source-map",
+  // Set some or all of these to true if you want more verbose logging:
+  stats: {
+    modules: false,
+    builtAt: false,
+    timings: false,
+    children: false,
+  },
+  output: output,
+  resolve: {
+    extensions: [".js", ".jsx"],
+    modules: [
+      path.resolve(rootDir, 'frontend', 'javascript'),
+      path.resolve(rootDir, 'frontend', 'styles'),
+      path.resolve(rootDir, 'node_modules')
+    ],
+    alias: {
+      bridgetownComponents: path.resolve(rootDir, "src", "_components")
+    }
+  },
+  plugins: [
+    new MiniCssExtractPlugin({
+      filename: "../css/[name].[contenthash].css",
+    }),
+    new WebpackManifestPlugin({
+      fileName: path.resolve(rootDir, ".bridgetown-webpack", "manifest.json"),
+    }),
+  ],
+  module: {
+    rules: [
+      jsRule, cssRules[cssRules.mode](), fontsRule, imagesRule
+    ]
+  }
+}

data/lib/bridgetown-core/component.rb

@@ -30,24 +30,24 @@ module Bridgetown
       #
       # @param ext [String] erb, slim, etc.
       def renderer_for_ext(ext, &block)
-        case ext
-        when "erb"
-          include ERBCapture
-          Tilt::ErubiTemplate.new(component_template_path,
-                                  outvar: "@_erbout",
-                                  bufval: "Bridgetown::OutputBuffer.new",
-                                  engine_class: Bridgetown::ERBEngine,
-                                  &block)
-        when "serb" # requires serbea
-          include Serbea::Helpers
-          Tilt::SerbeaTemplate.new(component_template_path, &block)
-        when "slim" # requires bridgetown-slim
-          Slim::Template.new(component_template_path, &block)
-        when "haml" # requires bridgetown-haml
-          Tilt::HamlTemplate.new(component_template_path, &block)
-        else
-          raise NameError
-        end
+        @_tmpl ||= case ext
+                   when "erb"
+                     include ERBCapture
+                     Tilt::ErubiTemplate.new(component_template_path,
+                                             outvar: "@_erbout",
+                                             bufval: "Bridgetown::OutputBuffer.new",
+                                             engine_class: Bridgetown::ERBEngine,
+                                             &block)
+                   when "serb" # requires serbea
+                     include Serbea::Helpers
+                     Tilt::SerbeaTemplate.new(component_template_path, &block)
+                   when "slim" # requires bridgetown-slim
+                     Slim::Template.new(component_template_path, &block)
+                   when "haml" # requires bridgetown-haml
+                     Tilt::HamlTemplate.new(component_template_path, &block)
+                   else
+                     raise NameError
+                   end
       rescue NameError, LoadError
         raise "No component rendering engine could be found for .#{ext} templates"
       end
@@ -56,26 +56,32 @@ module Bridgetown
       #
       # @return [String]
       def component_template_path
-        stripped_path = File.join(
-          File.dirname(source_location),
-          File.basename(source_location, ".*")
-        )
-        supported_template_extensions.each do |ext|
-          test_path = "#{stripped_path}.#{ext}"
-          return test_path if File.exist?(test_path)
-
-          test_path = "#{stripped_path}.html.#{ext}"
-          return test_path if File.exist?(test_path)
+        @_tmpl_path ||= begin
+          stripped_path = File.join(
+            File.dirname(source_location),
+            File.basename(source_location, ".*")
+          )
+          supported_template_extensions.each do |ext|
+            test_path = "#{stripped_path}.#{ext}"
+            break test_path if File.exist?(test_path)
+
+            test_path = "#{stripped_path}.html.#{ext}"
+            break test_path if File.exist?(test_path)
+          end
+        end
+
+        unless @_tmpl_path.is_a?(String)
+          raise "#{name}: no matching template could be found in #{File.dirname(source_location)}"
         end
 
-        raise "No matching templates could be found in #{File.dirname(source_location)}"
+        @_tmpl_path
       end
 
       # Read the template file.
       #
       # @return [String]
       def component_template_content
-        File.read(component_template_path)
+        @_tmpl_content ||= File.read(component_template_path)
       end
 
       # A list of extensions supported by the renderer
@@ -154,7 +160,6 @@ module Bridgetown
     end
 
     def _renderer
-      # TODO: figure out a way to compile templates for increased performance
       @_renderer ||= begin
         ext = File.extname(self.class.component_template_path).delete_prefix(".")
         self.class.renderer_for_ext(ext) { self.class.component_template_content }

data/lib/bridgetown-core/concerns/front_matter_importer.rb

@@ -25,7 +25,7 @@ module Bridgetown
       if yaml_content
         self.content = yaml_content.post_match
         self.front_matter_line_count = yaml_content[1].lines.size - 1
-        SafeYAML.load(yaml_content[1])
+        YAMLParser.load(yaml_content[1])
       elsif ruby_content
         # rbfm header + content underneath
         self.content = ruby_content.post_match
@@ -37,7 +37,7 @@ module Bridgetown
         self.content = file_contents
         {}
       else
-        yaml_data = SafeYAML.load_file(file_path)
+        yaml_data = YAMLParser.load_file(file_path)
         yaml_data.is_a?(Array) ? { rows: yaml_data } : yaml_data
       end
     end

data/lib/bridgetown-core/concerns/layout_placeable.rb

@@ -11,7 +11,7 @@ module Bridgetown
     end
 
     def no_layout?
-      data["layout"] == "none" || data["layout"] == false
+      data.layout.nil? || data.layout == "none" || data.layout == false
     end
   end
 end

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

@@ -18,12 +18,6 @@ class Bridgetown::Site
       @root_dir        = File.expand_path(config["root_dir"]).freeze
       @source          = File.expand_path(config["source"]).freeze
       @dest            = File.expand_path(config["destination"]).freeze
-      @cache_dir       = in_root_dir(config["cache_dir"]).freeze
-
-      %w(lsi highlighter baseurl exclude include future unpublished
-         limit_posts keep_files).each do |opt|
-        send("#{opt}=", config[opt])
-      end
 
       configure_cache
       configure_component_paths
@@ -39,6 +33,22 @@ class Bridgetown::Site
       config[:content_engine] == "resource"
     end
 
+    # Returns a base path from which the site is served (aka `/cool-site`) or
+    # `/` if served from root.
+    #
+    # @param strip_slash_only [Boolean] set to true if you wish "/" to be returned as ""
+    # @return [String]
+    def base_path(strip_slash_only: false)
+      (config[:base_path] || config[:baseurl]).yield_self do |path|
+        strip_slash_only ? path.to_s.sub(%r{^/$}, "") : path
+      end
+    end
+
+    def baseurl
+      Bridgetown::Deprecator.deprecation_message "Site#baseurl is now Site#base_path"
+      base_path(strip_slash_only: true).presence
+    end
+
     def defaults_reader
       @defaults_reader ||= Bridgetown::DefaultsReader.new(self)
     end
@@ -153,7 +163,8 @@ class Bridgetown::Site
 
     # Disable Marshaling cache to disk in Safe Mode
     def configure_cache
-      Bridgetown::Cache.cache_dir = in_root_dir(config["cache_dir"], "Bridgetown/Cache")
+      @cache_dir = in_root_dir(config["cache_dir"]).freeze
+      Bridgetown::Cache.cache_dir = File.join(cache_dir, "Bridgetown/Cache")
       Bridgetown::Cache.disable_disk_cache! if config["disable_disk_cache"]
     end
 

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

@@ -5,13 +5,11 @@ class Bridgetown::Site
     # Returns the current and/or default configured locale
     # @return String
     def locale
-      if @locale
-        @locale
-      else
-        @locale = ENV.fetch("BRIDGETOWN_LOCALE", config[:default_locale]).to_sym
+      @locale ||= begin
+        locale = ENV.fetch("BRIDGETOWN_LOCALE", config[:default_locale]).to_sym
         I18n.load_path << Dir[in_source_dir("_locales") + "/*.yml"]
         I18n.available_locales = config[:available_locales]
-        I18n.default_locale = @locale
+        I18n.default_locale = locale
       end
     end
 

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

@@ -42,8 +42,6 @@ class Bridgetown::Site
       @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
@@ -61,8 +59,11 @@ class Bridgetown::Site
 
     # Limits the current posts; removes the posts which exceed the limit_posts
     def limit_posts!
-      if limit_posts.positive?
-        limit = posts.docs.length < limit_posts ? posts.docs.length : limit_posts
+      if config.limit_posts.positive?
+        Bridgetown::Deprecator.deprecation_message(
+          "The limit_posts config option will be removed prior to Bridgetown 1.0"
+        )
+        limit = posts.docs.length < config.limit_posts ? posts.docs.length : config.limit_posts
         posts.docs = posts.docs[-limit, limit]
       end
     end

data/lib/bridgetown-core/concerns/validatable.rb

@@ -19,7 +19,7 @@ module Bridgetown
                                  **Utils.merged_file_read_opts(site, opts))
         if content =~ Document::YAML_FRONT_MATTER_REGEXP
           self.content = $POSTMATCH
-          self.data = SafeYAML.load(Regexp.last_match(1))&.with_dot_access
+          self.data = YAMLParser.load(Regexp.last_match(1))&.with_dot_access
         end
       rescue Psych::SyntaxError => e
         Bridgetown.logger.warn "YAML Exception reading #{filename}: #{e.message}"

data/lib/bridgetown-core/configuration.rb

@@ -54,7 +54,7 @@ module Bridgetown
       "detach"               => false, # default to not detaching the server
       "port"                 => "4000",
       "host"                 => "127.0.0.1",
-      "baseurl"              => nil, # this mounts at /, i.e. no subdirectory
+      "base_path"            => "/",
       "show_dir_listing"     => false,
 
       # Output Configuration
@@ -118,7 +118,7 @@ module Bridgetown
     # override - the command-line options hash
     #
     # Returns the path to the Bridgetown root directory
-    def root_dir(override)
+    def root_dir(override = "")
       get_config_value_with_override("root_dir", override)
     end
 
@@ -127,7 +127,7 @@ module Bridgetown
     # override - the command-line options hash
     #
     # Returns the path to the Bridgetown source directory
-    def source(override)
+    def source(override = "")
       get_config_value_with_override("source", override)
     end
 
@@ -147,7 +147,7 @@ module Bridgetown
         Bridgetown::Utils::RequireGems.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
         Tomlrb.load_file(filename)
       when %r!\.ya?ml!i
-        SafeYAML.load_file(filename) || {}
+        YAMLParser.load_file(filename) || {}
       else
         raise ArgumentError,
               "No parser for '#{filename}' is available. Use a .y(a)ml or .toml file instead."
@@ -226,7 +226,7 @@ module Bridgetown
         raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
       end
 
-      Bridgetown.logger.info "Configuration file:", file
+      Bridgetown.logger.debug "Configuration file:", file
       next_config
     rescue SystemCallError
       if @default_config_file ||= nil
@@ -340,5 +340,12 @@ module Bridgetown
 
       self
     end
+
+    # Whether or not PostCSS is being used to process stylesheets.
+    #
+    # @return [Boolean] true if `postcss.config.js` exists, false if not
+    def uses_postcss?
+      File.exist?(Bridgetown.sanitized_path(root_dir, "postcss.config.js"))
+    end
   end
 end