bridgetown-core 0.19.2 → 0.21.0.beta3

data/lib/bridgetown-core/utils.rb

@@ -4,12 +4,9 @@ module Bridgetown
   module Utils
     extend self
     autoload :Ansi, "bridgetown-core/utils/ansi"
-    autoload :Exec, "bridgetown-core/utils/exec"
-    autoload :Internet, "bridgetown-core/utils/internet"
+    autoload :RequireGems, "bridgetown-core/utils/require_gems"
     autoload :RubyExec, "bridgetown-core/utils/ruby_exec"
-    autoload :Platforms, "bridgetown-core/utils/platforms"
-    autoload :ThreadEvent, "bridgetown-core/utils/thread_event"
-    autoload :WinTZ, "bridgetown-core/utils/win_tz"
+    autoload :RubyFrontMatterDSL, "bridgetown-core/utils/ruby_front_matter"
 
     # Constants for use in #slugify
     SLUGIFY_MODES = %w(raw default pretty simple ascii latin).freeze
@@ -74,38 +71,32 @@ module Bridgetown
       end
     end
 
-    # Read array from the supplied hash favouring the singular key
-    # and then the plural key, and handling any nil entries.
+    # Read array from the supplied hash, merging the singular key with the
+    # plural key as needing, and handling any nil or duplicate entries.
     #
-    # hash - the hash to read from
-    # singular_key - the singular key
-    # plural_key - the plural key
-    #
-    # Returns an array
-    def pluralized_array_from_hash(hash, singular_key, plural_key)
-      array = []
-      value = value_from_singular_key(hash, singular_key)
-      value ||= value_from_plural_key(hash, plural_key)
+    # @param hsh [Hash] the hash to read from
+    # @param singular_key [Symbol] the singular key
+    # @param plural_key [Symbol] the plural key
+    # @return [Array]
+    def pluralized_array_from_hash(hsh, singular_key, plural_key)
+      array = [
+        hsh[singular_key],
+        value_from_plural_key(hsh, plural_key),
+      ]
 
-      array << value
       array.flatten!
       array.compact!
+      array.uniq!
       array
     end
 
-    def value_from_singular_key(hash, key)
-      hash[key] if hash.key?(key) || (hash.default_proc && hash[key])
-    end
-
-    def value_from_plural_key(hash, key)
-      if hash.key?(key) || (hash.default_proc && hash[key])
-        val = hash[key]
-        case val
-        when String
-          val.split
-        when Array
-          val.compact
-        end
+    def value_from_plural_key(hsh, key)
+      val = hsh[key]
+      case val
+      when String
+        val.split
+      when Array
+        val.compact
       end
     end
 
@@ -124,17 +115,23 @@ module Bridgetown
 
     # Determines whether a given file has
     #
-    # Returns true if the YAML front matter is present.
+    # @return [Boolean] if the YAML front matter is present.
     # rubocop: disable Naming/PredicateName
     def has_yaml_header?(file)
-      File.open(file, "rb", &:readline).match? %r!\A---\s*\r?\n!
+      File.open(file, "rb", &:readline).match? Bridgetown::FrontMatterImporter::YAML_HEADER
+    rescue EOFError
+      false
+    end
+
+    def has_rbfm_header?(file)
+      File.open(file, "rb", &:readline).match? Bridgetown::FrontMatterImporter::RUBY_HEADER
     rescue EOFError
       false
     end
 
     # Determine whether the given content string contains Liquid Tags or Vaiables
     #
-    # Returns true is the string contains sequences of `{%` or `{{`
+    # @return [Boolean] if the string contains sequences of `{%` or `{{`
     def has_liquid_construct?(content)
       return false if content.nil? || content.empty?
 
@@ -207,7 +204,7 @@ module Bridgetown
       slug.gsub!(%r!^\-|\-$!i, "")
 
       slug.downcase! unless cased
-      Bridgetown.logger.warn("Warning:", "Empty `slug` generated for '#{string}'.") if slug.empty?
+
       slug
     end
 
@@ -347,7 +344,7 @@ module Bridgetown
 
     # Return an asset path based on the Webpack manifest file
     # @param site [Bridgetown::Site] The current site object
-    # @param asset_type [String] js or css
+    # @param asset_type [String] js or css, or filename in manifest
     #
     # @return [String] Returns "MISSING_WEBPACK_MANIFEST" if the manifest
     # file isnt found
@@ -363,21 +360,30 @@ module Bridgetown
       manifest = JSON.parse(File.read(manifest_file))
 
       known_assets = %w(js css)
+      asset_path = nil
       if known_assets.include?(asset_type)
         asset_path = manifest["main.#{asset_type}"]
-
         log_webpack_asset_error(asset_type) && return if asset_path.nil?
-
-        asset_path = asset_path.split("/").last
-        return [static_frontend_path(site), asset_type, asset_path].join("/")
+      else
+        asset_path = manifest.find do |item, _|
+          item.sub(%r{^../(frontend/|src/)?}, "") == asset_type
+        end&.last
       end
 
-      Bridgetown.logger.error("Unknown Webpack asset type", asset_type)
-      nil
+      if asset_path
+        static_frontend_path(site, ["js", asset_path])
+      else
+        Bridgetown.logger.error("Unknown Webpack asset type", asset_type)
+        nil
+      end
     end
 
-    def static_frontend_path(site)
-      path_parts = [site.config["baseurl"].to_s.chomp("/"), "_bridgetown/static"]
+    def static_frontend_path(site, additional_parts = [])
+      path_parts = [
+        site.config["baseurl"].to_s.gsub(%r(^/|/$), ""),
+        "_bridgetown/static",
+        *additional_parts,
+      ]
       path_parts[0] = "/#{path_parts[0]}" unless path_parts[0].empty?
       Addressable::URI.parse(path_parts.join("/")).normalize.to_s
     end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Utils
+    module RequireGems
+      class << self
+        #
+        # Require a gem or file if it's present, otherwise silently fail.
+        #
+        # names - a string gem name or array of gem names
+        #
+        def require_if_present(names)
+          Array(names).each do |name|
+            require name
+          rescue LoadError
+            Bridgetown.logger.debug "Couldn't load #{name}. Skipping."
+            yield(name, version_constraint(name)) if block_given?
+            false
+          end
+        end
+
+        #
+        # The version constraint required to activate a given gem.
+        #
+        # Returns a String version constraint in a parseable form for
+        # RubyGems.
+        def version_constraint
+          "> 0"
+        end
+
+        #
+        # 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
+        #
+        def require_with_graceful_fail(names)
+          Array(names).each do |name|
+            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.
+
+              The full error message from Ruby is: '#{e.message}'
+
+              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
+    end
+  end
+end

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

@@ -5,8 +5,8 @@ module Bridgetown
     module RubyExec
       extend self
 
-      # rubocop:disable Metrics/AbcSize
-      def search_data_for_ruby_code(convertible, renderer)
+      # TODO: Deprecate storing Ruby code in YAML, Rb, etc. and just use native Ruby Front Matter
+      def search_data_for_ruby_code(convertible, renderer) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         return if convertible.data.empty?
 
         # Iterate using `keys` here so inline Ruby script can add new data keys
@@ -14,24 +14,21 @@ module Bridgetown
         data_keys = convertible.data.keys
         data_keys.each do |k|
           v = convertible.data[k]
-          next unless v.is_a?(Rb) || v.is_a?(Hash)
+          next unless v.is_a?(Rb) || v.is_a?(Hash) || v.is_a?(Proc)
 
-          if v.is_a?(Hash)
+          if v.is_a?(Proc)
+            convertible.data[k] = convertible.instance_exec(&v)
+          elsif v.is_a?(Hash)
             v.each do |nested_k, nested_v|
               next unless nested_v.is_a?(Rb)
 
-              Bridgetown.logger.debug("Executing inline Ruby…", convertible.relative_path)
               convertible.data[k][nested_k] = run(nested_v, convertible, renderer)
-              Bridgetown.logger.debug("Inline Ruby completed!", convertible.relative_path)
             end
           else
-            Bridgetown.logger.debug("Executing inline Ruby…", convertible.relative_path)
             convertible.data[k] = run(v, convertible, renderer)
-            Bridgetown.logger.debug("Inline Ruby completed!", convertible.relative_path)
           end
         end
       end
-      # rubocop:enable Metrics/AbcSize
 
       # Sets up a new context in which to eval Ruby coming from front matter.
       #

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Utils
+    module RubyFrontMatterDSL
+      def front_matter(&block)
+        RubyFrontMatter.new.tap { |fm| fm.instance_exec(&block) }
+      end
+    end
+
+    class RubyFrontMatter
+      def initialize
+        @data = {}
+      end
+
+      def method_missing(key, value) # rubocop:disable Style/MissingRespondToMissing
+        return super if respond_to?(key)
+
+        set(key, value)
+      end
+
+      def each(&block)
+        @data.each(&block)
+      end
+
+      def get(key)
+        @data[key]
+      end
+
+      def set(key, value)
+        @data[key] = value
+      end
+
+      def to_h
+        @data
+      end
+    end
+  end
+end

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "0.19.2"
-  CODE_NAME = "Arbor Lodge"
+  VERSION = "0.21.0.beta3"
+  CODE_NAME = "Broughton Beach"
 end

data/lib/bridgetown-core/watcher.rb

@@ -140,7 +140,7 @@ module Bridgetown
         if options[:trace]
           Bridgetown.logger.info e.backtrace.join("\n")
         else
-          Bridgetown.logger.warn "Error:", "Use the --trace option for more information."
+          Bridgetown.logger.warn "Backtrace:", "Use the --trace option for more information."
         end
       end
       Bridgetown.logger.info ""

data/lib/bridgetown-core/yaml_parser.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class YAMLParser
+    PERMITTED_CLASSES = [Date, Time, Rb].freeze
+
+    class << self
+      def load_file(filename, **kwargs)
+        kwargs = { permitted_classes: PERMITTED_CLASSES }.merge(kwargs)
+        YAML.safe_load_file(filename, **kwargs)
+      end
+
+      def load(yaml)
+        if RUBY_VERSION.start_with?("2.5")
+          YAML.safe_load yaml, PERMITTED_CLASSES
+        else
+          YAML.safe_load yaml, permitted_classes: PERMITTED_CLASSES
+        end
+      end
+    end
+  end
+end

data/lib/site_template/package.json.erb

@@ -30,8 +30,8 @@
     "postcss-loader": "^4.1.0",
     "postcss-preset-env": "^6.7.0",
     <% else %>
-    "node-sass": "^4.13.1",
-    "sass-loader": "^8.0.2",    
+    "sass": "^1.32.8",
+    "sass-loader": "^8.0.2",
     <% end %>
     "webpack": "^4.44.2",
     "webpack-cli": "^3.3.11",

data/lib/site_template/plugins/site_builder.rb

@@ -1,4 +1,4 @@
 class SiteBuilder < Bridgetown::Builder
-  # write builders which subclass SiteBuilder in plugins/builder
+  # write builders which subclass SiteBuilder in plugins/builders
 end
 

data/lib/site_template/src/_posts/0000-00-00-welcome-to-bridgetown.md.erb

@@ -21,6 +21,6 @@ def print_hi(name)
 end
 print_hi('Tom')
 #=> prints 'Hi, Tom' to STDOUT.
-````
+```
 
 Check out the [Bridgetown docs](https://bridgetownrb.com/docs/) for more info on how to get the most out of Bridgetown. File all bugs/feature requests at [Bridgetown’s GitHub repo](https://github.com/bridgetownrb/bridgetown). If you have questions, you can ask them on [Bridgetown Discussions on GitHub](https://github.com/bridgetownrb/bridgetown/discussions).

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

@@ -3,7 +3,9 @@ const MiniCssExtractPlugin = require("mini-css-extract-plugin");
 const ManifestPlugin = require("webpack-manifest-plugin");
 
 module.exports = {
-  entry: "./frontend/javascript/index.js",
+  entry: {
+    main: "./frontend/javascript/index.js"
+  },
   devtool: "source-map",
   // Set some or all of these to true if you want more verbose logging:
   stats: {
@@ -14,7 +16,7 @@ module.exports = {
   },
   output: {
     path: path.resolve(__dirname, "output", "_bridgetown", "static", "js"),
-    filename: "all.[contenthash].js",
+    filename: "[name].[contenthash].js",
   },
   resolve: {
     extensions: [".js", ".jsx"],
@@ -29,7 +31,7 @@ module.exports = {
   },
   plugins: [
     new MiniCssExtractPlugin({
-      filename: "../css/all.[contenthash].css",
+      filename: "../css/[name].[contenthash].css",
     }),
     new ManifestPlugin({
       fileName: path.resolve(__dirname, ".bridgetown-webpack", "manifest.json"),
@@ -64,22 +66,30 @@ module.exports = {
           {
             loader: "css-loader",
             options: {
+              url: url => !url.startsWith('/'),
               importLoaders: 1
             }
           },
           "postcss-loader"
         ],
-      },      
+      },
       <% else %>
       {
         test: /\.(s[ac]|c)ss$/,
         use: [
           MiniCssExtractPlugin.loader,
-          "css-loader",
+          {
+            loader: "css-loader",
+            options: {
+              url: url => !url.startsWith('/')
+            }
+          },
           {
             loader: "sass-loader",
             options: {
+              implementation: require("sass"),
               sassOptions: {
+                fiber: false,
                 includePaths: [
                   path.resolve(__dirname, "src/_components")
                 ],
@@ -90,13 +100,23 @@ module.exports = {
       },
       <% end %>
       {
-        test: /\.woff2?$|\.ttf$|\.eot$|\.svg$/,
+        test: /\.woff2?$|\.ttf$|\.eot$/,
         loader: "file-loader",
         options: {
+          name: "[name]-[contenthash].[ext]",
           outputPath: "../fonts",
           publicPath: "../fonts",
         },
       },
+      {
+        test: /\.png?$|\.gif$|\.jpg$|\.svg$/,
+        loader: "file-loader",
+        options: {
+          name: "[path][name]-[contenthash].[ext]",
+          outputPath: "../",
+          publicPath: "../",
+        },
+      },
     ],
   },
 };