bridgetown-core 1.3.4 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb150e09ad6d4f40f0f5cd7a636b19b4ff0d40922d31601f33c67a98e7ffd24b
-  data.tar.gz: '02795bee7a4b0ec92ef8fd8d2c61c2295e9882e145e023a2de697a56a3b3a4a4'
+  metadata.gz: 390375353b8c9d8064d5ae48c531c73337cb0b55eec6d803e11e327244a6d39f
+  data.tar.gz: 820fbb87dde20f864e6928038310fe5d18bfb4d0490c47e35fcce56843287bb7
 SHA512:
-  metadata.gz: 94f8313458630933d419a4b001a9da01328c92a0668068198a6b84330ce79e37dde9d6dffcb6db5d56596c243ca1740ab7e04045fabaf608e3ee8ca36be5742f
-  data.tar.gz: 7ebe8c1ae5bbdd275b31d321fd8d3c9d007abd3679e8b9d61fc370970470830c60373b7ea84dad8a1c043461d38fa1ee90747bb0df2c9d1c033fccf8f747db60
+  metadata.gz: e54b13230360699dd9162a1d525b61b0af97e010479016e90b1b75bd798111617f0975e6ea73b7d4e22e13fa91db6cb426887118f203627dbd25c214709ade2b
+  data.tar.gz: dae2470b585eb7ee3cdc2a6b5a9926420a1f47ba09f5f7f7e552c1b037e15067a19b5de84dbf65f5fd02ddb2096f0e4c5e3e2fb9c0b9a88c3f1e683b25486d54

data/bin/bridgetown

@@ -5,12 +5,6 @@ STDOUT.sync = true
 
 $LOAD_PATH.unshift File.expand_path("../../bridgetown/lib", __dir__)
 
-# Used by commands/automations
-require "active_support"
-require "active_support/core_ext/array/extract_options"
-require "active_support/core_ext/string/strip"
-require "active_support/core_ext/string/indent"
-
 require "bridgetown"
 
 # Support NO_COLOR: https://no-color.org

data/bin/bt

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# `bt` is a shortcut to `bridgetown`
+
+load File.join(File.dirname(__FILE__), 'bridgetown')

data/bridgetown-core.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r!^(benchmark|features|script|test)/!)
   end
-  s.executables   = ["bridgetown"]
+  s.executables   = ["bridgetown", "bt"] # `bt` is a shortcut to `bridgetown` command
   s.bindir        = "bin"
   s.require_paths = ["lib"]
 
@@ -29,27 +29,30 @@ Gem::Specification.new do |s|
 
   s.rdoc_options = ["--charset=UTF-8"]
 
-  s.required_ruby_version     = ">= 2.7.0"
+  s.required_ruby_version     = ">= 3.1.0"
 
-  s.add_runtime_dependency("activemodel",               [">= 6.0", "< 8.0"])
   s.add_runtime_dependency("activesupport",             [">= 6.0", "< 8.0"])
   s.add_runtime_dependency("addressable",               "~> 2.4")
   s.add_runtime_dependency("amazing_print",             "~> 1.2")
-  s.add_runtime_dependency("colorator",                 "~> 1.0")
+  s.add_runtime_dependency("bridgetown-foundation",     Bridgetown::VERSION)
   s.add_runtime_dependency("csv",                       "~> 3.2")
+  s.add_runtime_dependency("dry-inflector",             ">= 1.0")
   s.add_runtime_dependency("erubi",                     "~> 1.9")
   s.add_runtime_dependency("faraday",                   "~> 2.0")
   s.add_runtime_dependency("faraday-follow_redirects",  "~> 0.3")
-  s.add_runtime_dependency("hash_with_dot_access",      "~> 1.2")
   s.add_runtime_dependency("i18n",                      "~> 1.0")
   s.add_runtime_dependency("kramdown",                  "~> 2.1")
   s.add_runtime_dependency("kramdown-parser-gfm",       "~> 1.0")
   s.add_runtime_dependency("liquid",                    [">= 5.0", "< 5.5"])
   s.add_runtime_dependency("listen",                    "~> 3.0")
+  s.add_runtime_dependency("rack",                      ">= 3.0")
+  s.add_runtime_dependency("rackup",                    "~> 2.0")
   s.add_runtime_dependency("rake",                      ">= 13.0")
   s.add_runtime_dependency("roda",                      "~> 3.46")
   s.add_runtime_dependency("rouge",                     [">= 3.0", "< 5.0"])
-  s.add_runtime_dependency("serbea",                    "~> 1.0")
+  s.add_runtime_dependency("serbea",                    "~> 2.1")
+  s.add_runtime_dependency("signalize",                 "~> 1.3")
+  s.add_runtime_dependency("streamlined",               ">= 0.5.2")
   s.add_runtime_dependency("thor",                      "~> 1.1")
   s.add_runtime_dependency("tilt",                      "~> 2.0")
   s.add_runtime_dependency("zeitwerk",                  "~> 2.5")

data/lib/bridgetown-core/cleaner.rb

@@ -3,7 +3,7 @@
 module Bridgetown
   # Handles the cleanup of a site's destination before it is built.
   class Cleaner
-    HIDDEN_FILE_REGEX = %r!/\.{1,2}$!.freeze
+    HIDDEN_FILE_REGEX = %r!/\.{1,2}$!
     attr_reader :site
 
     def initialize(site)

data/lib/bridgetown-core/collection.rb

@@ -2,6 +2,9 @@
 
 module Bridgetown
   class Collection
+    using Bridgetown::Refinements
+    include Enumerable
+
     # @return [Bridgetown::Site]
     attr_reader :site
 
@@ -20,7 +23,7 @@ module Bridgetown
     end
 
     def builtin?
-      @is_builtin ||= label.in?(%w(posts pages data).freeze)
+      @is_builtin ||= label.within?(%w(posts pages data).freeze)
     end
 
     def data?
@@ -49,10 +52,10 @@ module Bridgetown
       resources.group_by(&:relative_url).transform_values(&:first)
     end
 
-    # Iterate over Resources
-    def each(&block)
-      resources.each(&block)
-    end
+    # Iterate over Resources, support Enumerable
+    def each(...) = resources.each(...)
+
+    def deconstruct = resources.deconstruct
 
     # Fetch the static files in this collection.
     # Defaults to an empty array if no static files have been read in.
@@ -62,11 +65,6 @@ module Bridgetown
       @static_files ||= []
     end
 
-    def files
-      Bridgetown::Deprecator.deprecation_message "Collection#files is now Collection#static_files"
-      static_files
-    end
-
     # Read the allowed resources into the collection's array of resources.
     #
     # @return [Bridgetown::Collection] self
@@ -77,8 +75,7 @@ module Bridgetown
 
         next if File.basename(file_path).starts_with?("_")
 
-        if label == "data" || Utils.has_yaml_header?(full_path) ||
-            Utils.has_rbfm_header?(full_path)
+        if label == "data" || FrontMatter::Loaders.front_matter?(full_path)
           read_resource(full_path)
         else
           read_static_file(file_path, full_path)
@@ -212,10 +209,25 @@ module Bridgetown
       !!metadata.fetch("output", false)
     end
 
-    # Used by Resource's permalink processor
+    # Used by Resources permalink processors
     # @return [String]
     def default_permalink
-      metadata.fetch("permalink", "/:locale/:collection/:path/")
+      metadata.fetch("permalink", default_configured_permalink)
+    end
+
+    # What the configured permalink should be absent of user overrides
+    # @return [String]
+    def default_configured_permalink
+      @default_configured_permalink ||= case label
+                                        when "data"
+                                          nil
+                                        when "posts"
+                                          site.config.permalink
+                                        when "pages"
+                                          "/:locale/:path/"
+                                        else
+                                          "/:locale/:collection/:path/"
+                                        end
     end
 
     # Extract options for this collection from the site configuration.
@@ -253,7 +265,7 @@ module Bridgetown
         end
       end
 
-      merge_environment_specific_metadata(data_contents).with_dot_access
+      merge_environment_specific_metadata(data_contents).as_dots
     end
 
     def merge_environment_specific_metadata(data_contents)
@@ -273,10 +285,10 @@ module Bridgetown
     # @param manifest [Bridgetown::Configuration::SourceManifest]
     # @return [void]
     def read_resource(full_path, manifest: nil)
-      model_relative_path = relative_model_path_for(full_path, manifest: manifest)
+      model_relative_path = relative_model_path_for(full_path, manifest:)
       model = Bridgetown::Model::Base.find(
-        model_id_from_relative_path(model_relative_path, manifest: manifest),
-        site: site
+        model_id_from_relative_path(model_relative_path, manifest:),
+        site:
       )
 
       if model_is_multi_locale?(model, model_relative_path)

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

@@ -31,23 +31,22 @@ module Bridgetown
       def build
         Bridgetown.logger.adjust_verbosity(options)
 
-        unless caller_locations.find do |loc|
-                 loc.to_s.include?("bridgetown-core/commands/start.rb")
-               end
-          self.class.print_startup_message
-        end
-
         # @type [Bridgetown::Configuration]
         config_options = configuration_with_overrides(
           options, Bridgetown::Current.preloaded_configuration
         )
 
-        config_options.run_initializers! context: :static
+        self.class.print_startup_message unless config_options["start_command"]
 
-        config_options["serving"] = false unless config_options["serving"]
+        Process.setproctitle(
+          "bridgetown #{Bridgetown::VERSION} " \
+          "(#{config_options["start_command"] ? "start" : "build"}) [#{File.basename(Dir.pwd)}]"
+        )
+
+        config_options.run_initializers! context: :static
 
         if !Bridgetown.env.production? &&
-            !config_options[:skip_frontend] && config_options["using_puma"]
+            !config_options[:skip_frontend] && config_options["start_command"]
           if Bridgetown::Utils.frontend_bundler_type(config_options[:root_dir]) == :esbuild
             Bridgetown::Utils.update_esbuild_autogenerated_config config_options
           end
@@ -67,6 +66,7 @@ module Bridgetown
           build_site(config_options)
         end
 
+        # TODO: remove this logic…I can't find "detach" anywhere
         if config_options.fetch("detach", false)
           Bridgetown.logger.info "Auto-regeneration:",
                                  "disabled when running server detached."
@@ -95,19 +95,6 @@ module Bridgetown
         @site.process
         Bridgetown.logger.info "Done! 🎉", "#{"Completed".bold.green} in less than " \
                                           "#{(Time.now - t).ceil(2)} seconds."
-
-        return unless config_options[:using_puma]
-
-        require "socket"
-        external_ip = Socket.ip_address_list.find do |ai|
-          ai.ipv4? && !ai.ipv4_loopback?
-        end&.ip_address
-        scheme = config_options.bind&.split("://")&.first == "ssl" ? "https" : "http"
-        port = config_options.bind&.split(":")&.last || ENV["BRIDGETOWN_PORT"] || 4000
-        Bridgetown.logger.info ""
-        Bridgetown.logger.info "Now serving at:", "#{scheme}://localhost:#{port}".magenta
-        Bridgetown.logger.info "", "#{scheme}://#{external_ip}:#{port}".magenta if external_ip
-        Bridgetown.logger.info ""
       end
 
       # Watch for file changes and rebuild the site.

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

@@ -3,10 +3,12 @@
 module Bridgetown
   module Commands
     module Actions
-      GITHUB_REGEX = %r!https://github\.com!.freeze
-      GITHUB_TREE_REGEX = %r!#{GITHUB_REGEX}/.*/.*/tree/.*/?!.freeze
-      GITHUB_BLOB_REGEX = %r!#{GITHUB_REGEX}/.*/.*/blob/!.freeze
-      GITHUB_REPO_REGEX = %r!github\.com/(.*?/[^/]*)!.freeze
+      using Bridgetown::Refinements
+
+      GITHUB_REGEX = %r!https://github\.com!
+      GITHUB_TREE_REGEX = %r!#{GITHUB_REGEX}/.*/.*/tree/.*/?!
+      GITHUB_BLOB_REGEX = %r!#{GITHUB_REGEX}/.*/.*/blob/!
+      GITHUB_REPO_REGEX = %r!github\.com/(.*?/[^/]*)!
 
       def create_builder(filename, data = nil)
         say_status :create_builder, filename
@@ -99,14 +101,19 @@ module Bridgetown
                          before: %r!^end$!, verbose: false, force: false
       end
 
-      def add_yarn_for_gem(gemname)
-        say_status :add_yarn, gemname
+      def add_npm_for_gem(gemname)
+        say_status :add_npm, gemname
 
         Bundler.reset!
         Bridgetown::PluginManager.load_determined_bundler_environment
-        Bridgetown::PluginManager.install_yarn_dependencies(name: gemname)
+        Bridgetown::PluginManager.install_npm_dependencies(name: gemname)
       rescue SystemExit
-        say_status :add_yarn, "Package not added due to yarn error", :red
+        say_status :add_npm, "Package not added due to NPM error", :red
+      end
+      alias_method :add_yarn_for_gem, :add_npm_for_gem
+
+      def add_npm_package(package_details)
+        run "#{Bridgetown::PluginManager.package_manager} #{Bridgetown::PluginManager.package_manager_install_command} #{package_details}" # rubocop:disable Layout
       end
 
       def apply_from_url(url)

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

@@ -7,7 +7,7 @@ module Bridgetown
         desc = "The environment used for this command (aka development, test, production, etc.)"
         klass.class_option :environment,
                            aliases: "-e",
-                           desc: desc
+                           desc:
       end
 
       # Create a full Bridgetown configuration with the options passed in as overrides

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

@@ -95,6 +95,9 @@ module Bridgetown
         workspace = IRB::WorkSpace.new
         workspace.main.define_singleton_method(:site) { Bridgetown::Current.site }
         workspace.main.define_singleton_method(:collections) { site.collections }
+        workspace.main.define_singleton_method(:helpers) do
+          Bridgetown::RubyTemplateView::Helpers.new
+        end
         irb = IRB::Irb.new(workspace)
         IRB.conf[:IRB_RC]&.call(irb.context)
         IRB.conf[:MAIN_CONTEXT] = irb.context

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

@@ -97,11 +97,9 @@ module Bridgetown
 
       def collect_urls(urls, things, destination)
         things.each do |thing|
-          dest = if thing.method(:destination).arity == 1
-                   thing.destination(destination)
-                 else
+          dest = thing.method(:destination).arity == 1 ?
+                   thing.destination(destination) :
                    thing.destination
-                 end
           if urls[dest]
             urls[dest] << thing.path
           else

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

@@ -155,7 +155,7 @@ const sassPlugin = (options) => ({
     // Process .scss and .sass files with Sass
     build.onLoad({ filter: /\.(sass|scss)$/ }, async (args) => {
       if (!sass) {
-        console.error("error: Sass is not installed. Try running `yarn add sass` and then building again.")
+        console.error("error: Sass is not installed. Try running `npm i sass -D` and then building again.")
         return
       }
 

data/lib/bridgetown-core/commands/esbuild/migrate-from-webpack.rb

@@ -18,7 +18,7 @@ unless Bridgetown.environment.test?
 
   gsub_file "package.json", %r!    "postcss-focus-within": "^4.0.0",?!, ""
 
-  run "yarn add -D #{required_packages.join(" ")}"
+  add_npm_package "-D #{required_packages.join(" ")}"
 
   packages_to_remove = package_json["devDependencies"].slice(*redundant_packages).keys
   unless packages_to_remove.empty?

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

@@ -5,5 +5,5 @@ copy_file "jsconfig.json"
 say "🎉 esbuild configuration updated successfully!"
 say "You may need to add `$styles/` to the front of your main CSS imports."
 say "See https://www.bridgetownrb.com/docs/frontend-assets#esbuild-setup for details."
-say "⚠️ Don't forget to update the esbuild version in your `package.json` file to \"^0.19.2\""
-say "and run `yarn install`!"
+say "⚠️ Don't forget to update the esbuild version in your `package.json` file to \"^0.20.2\""
+say "and run `npm install`!"

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

@@ -24,7 +24,7 @@ module Bridgetown
         return show_actions if args.empty?
 
         action = args.first
-        if supported_actions.include?(action)
+        if supported_actions.include?(action.to_sym)
           perform action
         else
           @logger.error "Error:".red, "🚨 Please enter a valid action."
@@ -66,7 +66,7 @@ module Bridgetown
 
         longest_action = supported_actions.keys.max_by(&:size).size
         supported_actions.each do |action, description|
-          say "#{action.ljust(longest_action).to_s.bold.blue}\t# #{description}"
+          say "#{action.to_s.ljust(longest_action).bold.blue}\t# #{description}"
         end
       end
 
@@ -76,7 +76,7 @@ module Bridgetown
           update: "Updates the Bridgetown esbuild defaults to the latest available version",
           "migrate-from-webpack":
             "Removes Webpack from your project and installs/configures esbuild",
-        }.with_indifferent_access
+        }
       end
     end
   end

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

@@ -26,21 +26,21 @@ module Bridgetown
                    desc: "Comma separated list of bundled configurations to perform"
       class_option :templates,
                    aliases: "-t",
-                   banner: "liquid|erb|serbea",
-                   desc: "Preferred template engine (defaults to Liquid)"
+                   banner: "erb|serbea|liquid",
+                   desc: "Preferred template engine (defaults to ERB)"
       class_option :"frontend-bundling",
                    aliases: "-e",
-                   banner: "esbuild|webpack",
-                   desc: "Choose your frontend bundling stack (defaults to esbuild)"
+                   banner: "esbuild",
+                   desc: "Choose frontend bundling stack (defaults to esbuild)"
       class_option :force,
                    type: :boolean,
                    desc: "Force creation even if PATH already exists"
       class_option :"skip-bundle",
                    type: :boolean,
                    desc: "Skip 'bundle install'"
-      class_option :"skip-yarn",
+      class_option :"skip-npm",
                    type: :boolean,
-                   desc: "Skip 'yarn install'"
+                   desc: "Skip 'npm install'"
       class_option :"use-sass",
                    type: :boolean,
                    desc: "Set up a Sass configuration for your stylesheet"
@@ -91,7 +91,7 @@ module Bridgetown
       end
 
       def frontend_bundling_option
-        options["frontend-bundling"] == "webpack" ? "webpack" : "esbuild"
+        "esbuild"
       end
 
       def postcss_option
@@ -99,7 +99,8 @@ module Bridgetown
       end
 
       def disable_postcss?
-        options["use-sass"] && options["frontend-bundling"] == "webpack"
+        # TODO: add option not to use postcss/sass at all
+        false
       end
 
       def create_site(new_site_path)
@@ -120,50 +121,42 @@ module Bridgetown
         copy_file("frontend/styles/syntax-highlighting.css")
 
         case options["templates"]
-        when "erb"
-          setup_erb_templates
         when "serbea"
           setup_serbea_templates
-        else
+        when "liquid"
           setup_liquid_templates
+        else # default if no option specififed
+          setup_erb_templates
         end
 
         postcss_option ? configure_postcss : configure_sass
 
-        if frontend_bundling_option == "esbuild"
-          invoke(Esbuild, ["setup"], {})
-        else
-          invoke(Webpack, ["setup"], {})
-        end
+        return unless frontend_bundling_option == "esbuild"
+
+        invoke(Esbuild, ["setup"], {})
       end
 
       def setup_erb_templates
         directory "TEMPLATES/erb/_layouts", "src/_layouts"
         directory "TEMPLATES/erb/_components", "src/_components"
         directory "TEMPLATES/erb/_partials", "src/_partials"
-        gsub_file "bridgetown.config.yml", %r!permalink: pretty\n!, <<~YML
-          permalink: pretty
-          template_engine: erb
-        YML
       end
 
       def setup_serbea_templates
         directory "TEMPLATES/serbea/_layouts", "src/_layouts"
         directory "TEMPLATES/serbea/_components", "src/_components"
         directory "TEMPLATES/serbea/_partials", "src/_partials"
-        gsub_file "bridgetown.config.yml", %r!permalink: pretty\n!, <<~YML
-          permalink: pretty
-          template_engine: serbea
-        YML
+        gsub_file "config/initializers.rb", %r!template_engine "erb"\n!, <<~RUBY
+          template_engine "serbea"
+        RUBY
       end
 
       def setup_liquid_templates
         directory "TEMPLATES/liquid/_layouts", "src/_layouts"
         directory "TEMPLATES/liquid/_components", "src/_components"
-        gsub_file "bridgetown.config.yml", %r!permalink: pretty\n!, <<~YML
-          permalink: pretty
-          template_engine: liquid
-        YML
+        gsub_file "config/initializers.rb", %r!template_engine "erb"\n!, <<~RUBY
+          template_engine "liquid"
+        RUBY
       end
 
       def configure_sass
@@ -172,7 +165,7 @@ module Bridgetown
       end
 
       def configure_postcss
-        template("postcss.config.js.erb", "postcss.config.js")
+        template("postcss.config.js.erb", "postcss.config.js") unless disable_postcss?
         copy_file("frontend/styles/index.css")
       end
 
@@ -187,8 +180,8 @@ module Bridgetown
         @skipped_bundle = true # is set to false if bundle install worked
         bundle_install path unless options["skip-bundle"]
 
-        @skipped_yarn = true
-        yarn_install path unless options["skip-yarn"]
+        @skipped_npm = true
+        npm_install path unless options["skip-npm"]
 
         invoke(Apply, [], options) if options[:apply]
         invoke(Configure, options[:configure].split(","), {}) if options[:configure]
@@ -198,9 +191,9 @@ module Bridgetown
         logger.info ""
         logger.info "Success!".green, "🎉 Your new Bridgetown site was " \
                                       "generated in #{cli_path.cyan}."
-        if options["skip-yarn"]
+        if options["skip-npm"]
           logger.info "You can now #{"cd".cyan} #{cli_path.cyan} to get started."
-          logger.info "You'll probably also want to #{"yarn install".cyan} " \
+          logger.info "You'll probably also want to #{"npm install".cyan} " \
                       "to load in your frontend assets."
         else
           logger.info "You can now #{"cd".cyan} #{cli_path.cyan} and run #{bt_start.cyan} " \
@@ -214,7 +207,7 @@ module Bridgetown
           logger.info "You will need to run #{"bundle binstubs bridgetown-core".cyan} manually."
         end
 
-        logger.info "Yarn install skipped.".yellow if @skipped_yarn
+        logger.info "NPM install skipped.".yellow if @skipped_npm
       end
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/PerceivedComplexity
@@ -225,8 +218,8 @@ module Bridgetown
           Bridgetown.with_unbundled_env do
             inside(path) do
               run "bundle install", abort_on_failure: true
+              # create binstubs to `bin/bridgetown` and `bin/bt`
               run "bundle binstubs bridgetown-core"
-              run "cp bin/bridgetown bin/bt"
             end
           end
         end
@@ -247,15 +240,15 @@ module Bridgetown
         say_status :alert, "Could not load git. git init skipped.", :red
       end
 
-      def yarn_install(path)
+      def npm_install(path)
         unless Bridgetown.environment.test?
           inside(path) do
-            run "yarn install", abort_on_failure: true
+            run "npm install", abort_on_failure: true
           end
         end
-        @skipped_yarn = false
+        @skipped_npm = false
       rescue SystemExit
-        say_status :alert, "Could not load yarn. yarn install skipped.", :red
+        say_status :alert, "Could not load npm. NPM install skipped.", :red
       end
     end
   end