bridgetown-core 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c0ce7bce739e63c69f338a2b614156fcf1b287f4d0742ae159055bbc64c8a6
-  data.tar.gz: 3ecd352f397904b828a924fcc4e58813b8d9c0c37313bd17a7fab4a08600ba64
+  metadata.gz: e3ba931e1d2393d0b13861c33e41c465a4e422baac0f9a68e39699b8159a2c5c
+  data.tar.gz: ff03f8af4f51257689ec84b0b661b0ba22ceb16a9110c5715aab56645020219c
 SHA512:
-  metadata.gz: 2d17ec6dea80449358e73cc7c7c0d8ac1b3be7dd9d5a55d4d05771fbe59d7d7f27504c08143cb56b8d97e9c0329245c9f68476bfed2708d8915201c16f6ce1bc
-  data.tar.gz: 5ceb50825db51531cad5f9ae141d53a30791ef35ffeb44169911e764ce4ec6bcb082ce54f8a456da275853128dc8cd3768985fd1854001bab9cd0edc0ba057bc
+  metadata.gz: 82407b17c101d072436853bb2892108b544d91d2667dbdef36696d674ce3af18a123920f0e33dd3acce352bf7ad48c9df162c03aba977d7dad2a23ad1dfbc20e
+  data.tar.gz: 6c6c47fbf536cf3e3104040ce480be88183b60df5220845fe8a163af32de700b9f358c9d2bf58d19985da42d66e4005765c3d47a5e3c29def6039f77a640447b

data/lib/bridgetown-core.rb

@@ -257,7 +257,16 @@ end
 
 module Bridgetown
   module Model; end
-  module Resource; end
+  module Resource
+    def self.register_extension(mod)
+      if mod.const_defined?(:LiquidResource)
+        Bridgetown::Drops::ResourceDrop.include mod.const_get(:LiquidResource)
+      end
+      if mod.const_defined?(:RubyResource)
+        Bridgetown::Resource::Base.include mod.const_get(:RubyResource)
+      end
+    end
+  end
 end
 
 # This method is available in Ruby 3, monkey patching for older versions

data/lib/bridgetown-core/collection.rb

@@ -242,7 +242,7 @@ module Bridgetown
       site.config.collections[label] || HashWithDotAccess::Hash.new
     end
 
-    def merge_data_resources
+    def merge_data_resources # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       data_contents = {}
 
       sanitize_filename = ->(name) do
@@ -256,11 +256,16 @@ module Bridgetown
         segments.each_with_index do |segment, index|
           sanitized_segment = sanitize_filename.(File.basename(segment, ".*"))
           hsh = nested.empty? ? data_contents : data_contents.dig(*nested)
-          hsh[sanitized_segment] = if index == segments.length - 1
-                                     data_resource.data.rows || data_resource.data
-                                   else
-                                     {}
-                                   end
+          if !hsh.is_a?(Hash)
+            Bridgetown.logger.error(
+              "Error:",
+              "#{nested.join("/")} is not a Hash structure, #{segment} cannot be read"
+            )
+          elsif index == segments.length - 1
+            hsh[sanitized_segment] = data_resource.data.rows || data_resource.data
+          elsif !hsh.key?(sanitized_segment)
+            hsh[sanitized_segment] = {}
+          end
           nested << sanitized_segment
         end
       end

data/lib/bridgetown-core/commands/concerns/build_options.rb

@@ -36,9 +36,9 @@ module Bridgetown
         klass.class_option :limit_posts,
                            type: :numeric,
                            desc: "Limits the number of posts to parse and publish"
-        klass.class_option :baseurl,
+        klass.class_option :base_path,
                            aliases: "-b",
-                           desc: "Serve the website from the given base URL"
+                           desc: "Serve the website from the given base path"
         klass.class_option :force_polling,
                            type: :boolean,
                            desc: "Force watch to use polling"

data/lib/bridgetown-core/commands/serve.rb

@@ -119,7 +119,7 @@ module Bridgetown
 
       def start_up_webrick(opts, destination)
         @server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
-        @server.mount(opts["baseurl"].to_s, Servlet, destination, file_handler_opts)
+        @server.mount(opts["base_path"].to_s, Servlet, destination, file_handler_opts)
 
         Bridgetown.logger.info "Server address:", server_address(@server, opts)
         launch_browser @server, opts if opts["open_url"]

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

@@ -41,11 +41,18 @@ module Bridgetown
         config.root_dir
       end
 
+      protected
+
       def config
         @config ||= Bridgetown.configuration({ root_dir: Dir.pwd })
       end
 
-      protected
+      def package_json
+        @package_json ||= begin
+          package_json_file = File.read(Bridgetown.sanitized_path(config.root_dir, "package.json"))
+          JSON.parse(package_json_file)
+        end
+      end
 
       def perform(action)
         automation = find_in_source_paths("#{action}.rb")

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

@@ -1,3 +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

@@ -1,7 +1,9 @@
-const config = require("./config/webpack.defaults.js")
+const { merge } = require('webpack-merge')
 
-// Add any overrides to the default webpack config here:
+var config = require("./config/webpack.defaults.js")
 
+// Add any overrides to the default webpack config here:
+//
 // Eg:
 //
 //  ```
@@ -9,6 +11,17 @@ const config = require("./config/webpack.defaults.js")
 //    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)
+//  ```
+
 
 
 

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

@@ -11,12 +11,89 @@
 const path = require("path");
 const rootDir = path.resolve(__dirname, "..")
 const MiniCssExtractPlugin = require("mini-css-extract-plugin");
-const ManifestPlugin = require("webpack-manifest-plugin");
+const { WebpackManifestPlugin } = require("webpack-manifest-plugin");
 
-module.exports = {
-  entry: {
-    main: path.resolve(rootDir, "frontend", "javascript", "index.js")
+// 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: {
@@ -25,10 +102,7 @@ module.exports = {
     timings: false,
     children: false,
   },
-  output: {
-    path: path.resolve(rootDir, "output", "_bridgetown", "static", "js"),
-    filename: "[name].[contenthash].js",
-  },
+  output: output,
   resolve: {
     extensions: [".js", ".jsx"],
     modules: [
@@ -44,91 +118,13 @@ module.exports = {
     new MiniCssExtractPlugin({
       filename: "../css/[name].[contenthash].css",
     }),
-    new ManifestPlugin({
+    new WebpackManifestPlugin({
       fileName: path.resolve(rootDir, ".bridgetown-webpack", "manifest.json"),
     }),
   ],
   module: {
     rules: [
-      {
-        test: /\.(js|jsx)/,
-        use: {
-          loader: "babel-loader",
-          options: {
-            presets: ["@babel/preset-env"],
-            plugins: [
-              ["@babel/plugin-proposal-decorators", { "legacy": true }],
-              ["@babel/plugin-proposal-class-properties", { "loose" : true }],
-              [
-                "@babel/plugin-transform-runtime",
-                {
-                  helpers: false,
-                },
-              ],
-              ["@babel/plugin-proposal-private-methods", { "loose": true }],
-            ],
-          },
-        },
-      },
-      <% if self.config.uses_postcss? %>
-      {
-        test: /\.(s[ac]|c)ss$/,
-        use: [
-          MiniCssExtractPlugin.loader,
-          {
-            loader: "css-loader",
-            options: {
-              url: url => !url.startsWith('/'),
-              importLoaders: 1
-            }
-          },
-          "postcss-loader"
-        ],
-      },
-      <% else %>
-      {
-        test: /\.(s[ac]|c)ss$/,
-        use: [
-          MiniCssExtractPlugin.loader,
-          {
-            loader: "css-loader",
-            options: {
-              url: url => !url.startsWith('/')
-            }
-          },
-          {
-            loader: "sass-loader",
-            options: {
-              implementation: require("sass"),
-              sassOptions: {
-                fiber: false,
-                includePaths: [
-                  path.resolve(rootDir, "src/_components")
-                ],
-              },
-            },
-          },
-        ],
-      },
-      <% end %>
-      {
-        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: "../",
-        },
-      },
-    ],
-  },
-};
+      jsRule, cssRules[cssRules.mode](), fontsRule, imagesRule
+    ]
+  }
+}

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

@@ -24,7 +24,6 @@ class Bridgetown::Site
       configure_include_paths
       configure_file_read_opts
 
-      self.baseurl = config.baseurl
       self.permalink_style = (config["permalink"] || "pretty").to_sym
 
       @config
@@ -34,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

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

data/lib/bridgetown-core/configurations/tailwindcss.rb

@@ -21,9 +21,14 @@ run "npx tailwindcss init"
 
 copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js", force: true
 
-prepend_to_file "frontend/styles/index.css",
-                File.read("#{TEMPLATE_PATH}/css_imports.css")
-
 run "bundle exec bridgetown configure purgecss"
 
+if File.exist?("frontend/styles/index.css")
+  prepend_to_file "frontend/styles/index.css",
+                  File.read("#{TEMPLATE_PATH}/css_imports.css")
+else
+  say "\nPlease add the following lines to your CSS index file:"
+  say File.read("#{TEMPLATE_PATH}/css_imports.css")
+end
+
 # rubocop:enable all

data/lib/bridgetown-core/configurations/tailwindcss/postcss.config.js

@@ -6,7 +6,7 @@ module.exports = {
       autoprefixer: {
         flexbox: 'no-2009'
       },
-      stage: 3
+      stage: 2
     }
   }
-}
+}

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

@@ -17,6 +17,7 @@ module Bridgetown
                      :data,
                      :output,
                      :content,
+                     :summary,
                      :to_s,
                      :absolute_url,
                      :relative_path,
@@ -48,7 +49,7 @@ module Bridgetown
       end
 
       def next
-        @next ||= @obj.previous_resource.to_liquid
+        @next ||= @obj.next_resource.to_liquid
       end
 
       # Generate a Hash for use in generating JSON.

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

@@ -8,6 +8,8 @@ module Bridgetown
       mutable false
 
       def_delegators :@obj,
+                     :baseurl, # deprecated
+                     :base_path,
                      :data,
                      :locale,
                      :time,

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

@@ -5,7 +5,7 @@ module Bridgetown
     module URLFilters
       extend self
 
-      # Produces an absolute URL based on site.url and site.baseurl.
+      # Produces an absolute URL based on site.url and site.base_path.
       #
       # input - the URL to make absolute.
       #
@@ -15,7 +15,7 @@ module Bridgetown
         cache[input] ||= compute_absolute_url(input)
       end
 
-      # Produces a URL relative to the domain root based on site.baseurl
+      # Produces a URL relative to the domain root based on site.base_path
       # unless it is already an absolute url with an authority (host).
       #
       # input - the URL to make relative to the domain root
@@ -70,17 +70,13 @@ module Bridgetown
         input = input.url if input.respond_to?(:url)
         return input if Addressable::URI.parse(input.to_s).absolute?
 
-        parts = [sanitized_baseurl, input]
+        site = @context.registers[:site]
+        parts = [site.base_path.chomp("/"), input]
         Addressable::URI.parse(
           parts.compact.map { |part| ensure_leading_slash(part.to_s) }.join
         ).normalize.to_s
       end
 
-      def sanitized_baseurl
-        site = @context.registers[:site]
-        site.config["baseurl"].to_s.chomp("/")
-      end
-
       def ensure_leading_slash(input)
         return input if input.nil? || input.empty? || input.start_with?("/")
 

data/lib/bridgetown-core/resource/base.rb

@@ -181,6 +181,16 @@ module Bridgetown
         data["date"] ||= site.time
       end
 
+      # Ask the configured summary extension to output a summary of the content,
+      # otherwise return the first line.
+      #
+      # @return [String]
+      def summary
+        return summary_extension_output if respond_to?(:summary_extension_output)
+
+        content.to_s.strip.lines.first.to_s.strip
+      end
+
       # @return [Hash<String, Hash<String => Bridgetown::Resource::TaxonomyType,
       #   Array<Bridgetown::Resource::TaxonomyTerm>>>]
       def taxonomies

data/lib/bridgetown-core/resource/destination.rb

@@ -32,7 +32,9 @@ module Bridgetown
 
       def output_path
         path = URL.unescape_path(relative_url)
-        path = path.delete_prefix(resource.site.baseurl) if resource.site.baseurl.present?
+        if resource.site.base_path.present?
+          path = path.delete_prefix resource.site.base_path(strip_slash_only: true)
+        end
         path = resource.site.in_dest_dir(path)
         path = File.join(path, "index.html") if relative_url.end_with? "/"
         path

data/lib/bridgetown-core/resource/permalink_processor.rb

@@ -40,7 +40,7 @@ module Bridgetown
         # No relative URLs should ever end in /index.html
         new_url.sub!(%r{/index$}, "") if final_ext == ".html"
 
-        add_baseurl finalize_permalink(new_url, permalink)
+        add_base_path finalize_permalink(new_url, permalink)
       end
 
       def process_segment(segment)
@@ -96,8 +96,12 @@ module Bridgetown
         end
       end
 
-      def add_baseurl(permalink)
-        resource.site.baseurl.present? ? "#{resource.site.baseurl}#{permalink}" : permalink
+      def add_base_path(permalink)
+        if resource.site.base_path.present?
+          return "#{resource.site.base_path(strip_slash_only: true)}#{permalink}"
+        end
+
+        permalink
       end
 
       ### Default Placeholders Processors

data/lib/bridgetown-core/site.rb

@@ -30,7 +30,7 @@ module Bridgetown
     # is default
     alias_method :generated_pages, :pages
 
-    attr_accessor :permalink_style, :time, :baseurl, :data,
+    attr_accessor :permalink_style, :time, :data,
                   :file_read_opts, :plugin_manager, :converters,
                   :generators, :reader
 

data/lib/bridgetown-core/static_file.rb

@@ -58,8 +58,9 @@ module Bridgetown
     def destination(dest)
       dest = site.in_dest_dir(dest)
       dest_url = url
-      dest_url = dest_url.delete_prefix(site.baseurl) if site.uses_resource? &&
-        site.baseurl.present? && collection
+      if site.uses_resource? && site.base_path.present? && collection
+        dest_url = dest_url.delete_prefix site.base_path(strip_slash_only: true)
+      end
       site.in_dest_dir(dest, Bridgetown::URL.unescape_path(dest_url))
     end
 

data/lib/bridgetown-core/utils.rb

@@ -380,7 +380,7 @@ module Bridgetown
 
     def static_frontend_path(site, additional_parts = [])
       path_parts = [
-        site.config["baseurl"].to_s.gsub(%r(^/|/$), ""),
+        site.base_path.gsub(%r(^/|/$), ""),
         "_bridgetown/static",
         *additional_parts,
       ]

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "0.21.0"
+  VERSION = "0.21.1"
   CODE_NAME = "Broughton Beach"
 end

data/lib/site_template/bridgetown.config.yml

@@ -15,9 +15,13 @@
 # https://learnxinyminutes.com/docs/yaml/
 #
 
-baseurl: "" # OPTIONAL: the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. https://example.com
 
 permalink: pretty
 
+# Other options you might want to investigate:
+# 
+# base_path: "/" # the subpath of your site, e.g. /blog
 # timezone: America/Los_Angeles
+# pagination:
+#   enabled: true

data/lib/site_template/package.json.erb

@@ -13,15 +13,11 @@
     "start": "node start.js"
   },
   "devDependencies": {
-    "@babel/core": "^7.9.0",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-proposal-decorators": "^7.10.1",
-    "@babel/plugin-transform-runtime": "^7.9.0",
-    "@babel/preset-env": "^7.9.0",
-    "babel-loader": "^8.1.0",
     "browser-sync": "^2.26.7",
     "concurrently": "^5.2.0",
     "css-loader": "^4.3.0",
+    "esbuild": "^0.12.7",
+    "esbuild-loader": "^2.13.1",
     "file-loader": "^6.2.0",
     "mini-css-extract-plugin": "^1.3.1",
     <% if options["use-postcss"] %>
@@ -33,8 +29,9 @@
     "sass": "^1.32.8",
     "sass-loader": "^8.0.2",
     <% end %>
-    "webpack": "^4.44.2",
-    "webpack-cli": "^3.3.11",
-    "webpack-manifest-plugin": "^2.1.0"
+    "webpack": "^5.39.1",
+    "webpack-cli": "^4.7.2",
+    "webpack-manifest-plugin": "^3.1.1"
+    "webpack-merge": "^5.8.0"
   }
 }

data/lib/site_template/src/_data/site_metadata.yml

@@ -7,5 +7,5 @@
 title: Your awesome title
 tagline: This site is totally awesome
 email: your-email@example.com
-description: >- # this means to ignore newlines until "baseurl:"
+description: >-
   Write an awesome description for your new site here. It will appear in your document head meta (for Google search results) and in your feed.xml site description.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel