bridgetown-core 0.21.3 → 1.0.0.alpha3

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

@@ -32,8 +32,8 @@ module Bridgetown
         require "amazing_print" unless options[:"bypass-ap"]
 
         Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
-                                    " (codename \"#{Bridgetown::CODE_NAME.yellow}\")" \
-                                    " console…"
+                                            " (codename \"#{Bridgetown::CODE_NAME.yellow}\")" \
+                                            " console…"
         Bridgetown.logger.info "Environment:", Bridgetown.environment.cyan
         site = Bridgetown::Site.new(configuration_with_overrides(options))
 
@@ -54,7 +54,7 @@ module Bridgetown
         IRB.conf[:IRB_RC]&.call(irb.context)
         IRB.conf[:MAIN_CONTEXT] = irb.context
         eval("site = $BRIDGETOWN_SITE", workspace.binding, __FILE__, __LINE__)
-        Bridgetown.logger.info "Console:", "Now loaded as " + "site".cyan + " variable."
+        Bridgetown.logger.info "Console:", "Now loaded as #{"site".cyan} variable."
 
         trap("SIGINT") do
           irb.signal_handle

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

@@ -50,7 +50,7 @@ module Bridgetown
                                "Detected '_posts' directory outside custom `collections_dir`!"
         Bridgetown.logger.warn "",
                                "Please move '#{posts_at_root}' into the custom directory at " \
-              "'#{site.in_source_dir(site.config["collections_dir"])}'"
+                               "'#{site.in_source_dir(site.config["collections_dir"])}'"
         false
       end
 
@@ -64,21 +64,23 @@ module Bridgetown
 
           conflicting_urls = true
           Bridgetown.logger.warn "Conflict:", "The URL '#{url}' is the destination" \
-            " for the following pages: #{paths.join(", ")}"
+                                              " for the following pages: #{paths.join(", ")}"
         end
         conflicting_urls
       end
 
       def urls_only_differ_by_case(site)
         urls_only_differ_by_case = false
-        urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
+        urls = case_insensitive_urls(site.resources, site.dest)
         urls.each_value do |real_urls|
           next unless real_urls.uniq.size > 1
 
           urls_only_differ_by_case = true
-          Bridgetown.logger.warn "Warning:", "The following URLs only differ" \
-            " by case. On a case-insensitive file system one of the URLs" \
-            " will be overwritten by the other: #{real_urls.join(", ")}"
+          Bridgetown.logger.warn(
+            "Warning:",
+            "The following URLs only differ by case. On a case-insensitive file system one of the" \
+            " URLs will be overwritten by the other: #{real_urls.join(", ")}"
+          )
         end
         urls_only_differ_by_case
       end
@@ -106,9 +108,9 @@ module Bridgetown
         urls
       end
 
-      def case_insensitive_urls(things, destination)
+      def case_insensitive_urls(things, _destination)
         things.each_with_object({}) do |thing, memo|
-          dest = thing.destination(destination)
+          dest = thing.destination.output_path
           (memo[dest.downcase] ||= []) << dest
         end
       end
@@ -117,7 +119,7 @@ module Bridgetown
         return true unless url.nil? || url.empty?
 
         Bridgetown.logger.warn "Warning:", "You didn't set an URL in the config file, "\
-            "you may encounter problems with some plugins."
+                                           "you may encounter problems with some plugins."
         false
       end
 
@@ -128,7 +130,7 @@ module Bridgetown
       # https://git.io/vFfbx
       rescue TypeError
         Bridgetown.logger.warn "Warning:", "The site URL does not seem to be valid, "\
-            "check the value of `url` in your config file."
+                                           "check the value of `url` in your config file."
         false
       end
 
@@ -136,7 +138,7 @@ module Bridgetown
         return true if url.is_a?(String) && Addressable::URI.parse(url).absolute?
 
         Bridgetown.logger.warn "Warning:", "Your site URL does not seem to be absolute, "\
-            "check the value of `url` in your config file."
+                                           "check the value of `url` in your config file."
         false
       end
     end

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

@@ -59,8 +59,10 @@ module Bridgetown
 
         if preserve_source_location?(new_site_path, options)
           say_status :conflict, "#{new_site_path} exists and is not empty.", :red
-          Bridgetown.logger.abort_with "Ensure #{new_site_path} is empty or else " \
-                    "try again with `--force` to proceed and overwrite any files."
+          Bridgetown.logger.abort_with(
+            "Ensure #{new_site_path} is empty or else try again with `--force` to proceed and" \
+            " overwrite any files."
+          )
         end
 
         self.destination_root = self.class.created_site_dir = new_site_path
@@ -119,21 +121,26 @@ module Bridgetown
         invoke(Configure, options[:configure].split(","), {}) if options[:configure]
 
         logger = Bridgetown.logger
-        yarn_start = "yarn start"
+        bt_start = "bin/bridgetown start"
         logger.info ""
         logger.info "Success!".green, "🎉 Your new Bridgetown site was" \
-                    " generated in #{cli_path.cyan}."
+                                      " generated in #{cli_path.cyan}."
         if options["skip-yarn"]
           logger.info "You can now #{"cd".cyan} #{cli_path.cyan} to get started."
           logger.info "You'll probably also want to #{"yarn install".cyan}" \
                       " to load in your frontend assets."
         else
-          logger.info "You can now #{"cd".cyan} and run #{yarn_start.cyan} to get started."
+          logger.info "You can now #{"cd".cyan} #{cli_path.cyan} and run #{bt_start.cyan}" \
+                      " to get started."
         end
         logger.info "Then check out our online documentation for" \
                     " next steps: #{DOCSURL.cyan}"
 
-        logger.info "Bundle install skipped.".yellow if @skipped_bundle
+        if @skipped_bundle
+          logger.info "Bundle install skipped.".yellow
+          logger.info "You will need to run #{"bundle binstub bridgetown-core".cyan} manually."
+        end
+
         logger.info "Yarn install skipped.".yellow if @skipped_yarn
       end
       # rubocop:enable Metrics/CyclomaticComplexity
@@ -145,6 +152,7 @@ module Bridgetown
           Bridgetown.with_unbundled_env do
             inside(path) do
               run "bundle install", abort_on_failure: true
+              run "bundle binstub bridgetown-core"
             end
           end
         end

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

@@ -112,12 +112,12 @@ module Bridgetown
           source_manifest.origin.to_s == directive[0]
         end
 
-        if manifest&.respond_to?(directive[1].downcase)
+        if manifest.respond_to?(directive[1].downcase)
           dir = manifest.send(directive[1].downcase)
           Bridgetown.logger.info("Opening the #{dir.green} folder for" \
-                                  " #{manifest.origin.to_s.cyan}…")
+                                 " #{manifest.origin.to_s.cyan}…")
           Bridgetown.logger.info("Type #{"exit".yellow} when you're done to" \
-                                  " return to your site root.")
+                                 " return to your site root.")
           puts
 
           Dir.chdir dir do
@@ -133,20 +133,18 @@ module Bridgetown
           Bridgetown.logger.info("Done!", "You're back in #{Dir.pwd.green}")
         else
           Bridgetown.logger.warn("Oops!", "I wasn't able to find the" \
-                                  " #{directive[1]} folder for #{directive[0]}")
+                                          " #{directive[1]} folder for #{directive[0]}")
         end
       end
 
       desc "new NAME", "Create a new plugin NAME (please-use-dashes) by" \
                        " cloning the sample plugin repo"
-      # rubocop:disable Layout/LineLength
       def new(plugin_name)
         folder_name = plugin_name.underscore
         name = folder_name.dasherize
         module_name = folder_name.camelize
 
-        # TODO: upon 0.21 release, remove the explicit branch name!
-        run "git clone -b switch-to-minitest https://github.com/bridgetownrb/bridgetown-sample-plugin #{name}"
+        run "git clone https://github.com/bridgetownrb/bridgetown-sample-plugin #{name}"
         new_gemspec = "#{name}.gemspec"
 
         inside name do # rubocop:todo Metrics/BlockLength
@@ -188,11 +186,10 @@ module Bridgetown
         say ""
         say_status "Done!", "Have fun writing your new #{name} plugin :)"
         say_status "Remember:", "Don't forget to rename the SamplePlugin" \
-                               " code identifiers and paths to your own" \
-                               " indentifer, as well as update your README " \
-                               " and CHANGELOG files as necessary."
+                                " code identifiers and paths to your own" \
+                                " indentifer, as well as update your README " \
+                                " and CHANGELOG files as necessary."
       end
-      # rubocop:enable Layout/LineLength
 
       protected
 

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

@@ -8,7 +8,7 @@ module Bridgetown
       class Servlet < WEBrick::HTTPServlet::FileHandler
         DEFAULTS = {
           "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
-            "no-store, no-cache, must-revalidate",
+                             "no-store, no-cache, must-revalidate",
         }.freeze
 
         def initialize(server, root, callbacks)
@@ -51,9 +51,9 @@ module Bridgetown
           key = res.header.keys.grep(%r!content-type!i).first
           typ = res.header[key]
 
-          unless %r!;\s*charset=!.match?(typ)
-            res.header[key] = "#{typ}; charset=#{@bridgetown_opts["encoding"]}"
-          end
+          return if %r!;\s*charset=!.match?(typ)
+
+          res.header[key] = "#{typ}; charset=#{@bridgetown_opts["encoding"]}"
         end
 
         def set_defaults

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

@@ -34,11 +34,7 @@ module Bridgetown
       def self.banner
         "bridgetown serve [options]"
       end
-      summary "Serve your site locally using WEBrick"
-
-      class << self
-        attr_accessor :loaded_config
-      end
+      summary "DEPRECATED (Serve your site locally using WEBrick)"
 
       DIRECTORY_INDEX = %w(
         index.htm
@@ -52,6 +48,10 @@ module Bridgetown
       ).freeze
 
       def serve
+        Bridgetown::Deprecator.deprecation_message(
+          "WEBrick (serve) will be removed in favor of Puma (start) in the next Bridgetown release"
+        )
+
         @mutex = Mutex.new
         @run_cond = ConditionVariable.new
         @running = false
@@ -59,14 +59,16 @@ module Bridgetown
         no_watch = options["watch"] == false
 
         options = Thor::CoreExt::HashWithIndifferentAccess.new(self.options)
-
         options["serving"] = true
         options["watch"] = true unless no_watch
 
-        # TODO: this prints the configuration file log message out-of-order
-        self.class.loaded_config = configuration_with_overrides(options)
+        config = Bridgetown::Current.preloaded_configuration ||
+          configuration_with_overrides(options)
         if Bridgetown.environment == "development"
-          self.class.loaded_config["url"] = default_url(self.class.loaded_config)
+          default_url(config).tap do |url|
+            options["url"] = url
+            config.url = url
+          end
         end
 
         invoke(Build, [], options)
@@ -76,23 +78,22 @@ module Bridgetown
       protected
 
       def start_server
-        config = self.class.loaded_config
-        destination = config["destination"]
+        destination = Bridgetown::Current.preloaded_configuration.destination
         setup(destination)
 
-        start_up_webrick(config, destination)
+        start_up_webrick(destination)
       end
 
       def setup(destination)
         require_relative "serve/servlet"
 
         FileUtils.mkdir_p(destination)
-        if File.exist?(File.join(destination, "404.html"))
-          WEBrick::HTTPResponse.class_eval do
-            def create_error_page
-              @header["Content-Type"] = "text/html; charset=UTF-8"
-              @body = IO.read(File.join(@config[:DocumentRoot], "404.html"))
-            end
+        return unless File.exist?(File.join(destination, "404.html"))
+
+        WEBrick::HTTPResponse.class_eval do
+          def create_error_page
+            @header["Content-Type"] = "text/html; charset=UTF-8"
+            @body = File.read(File.join(@config[:DocumentRoot], "404.html"))
           end
         end
       end
@@ -117,7 +118,8 @@ module Bridgetown
         opts
       end
 
-      def start_up_webrick(opts, destination)
+      def start_up_webrick(destination)
+        opts = Bridgetown::Current.preloaded_configuration
         @server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
         @server.mount(opts["base_path"].to_s, Servlet, destination, file_handler_opts)
 
@@ -209,34 +211,32 @@ module Bridgetown
         begin
           opts[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(read_file(src, key))
         rescue StandardError
-          if defined?(OpenSSL::PKey::EC)
-            opts[:SSLPrivateKey] = OpenSSL::PKey::EC.new(read_file(src, key))
-          else
-            raise
-          end
+          raise unless defined?(OpenSSL::PKey::EC)
+
+          opts[:SSLPrivateKey] = OpenSSL::PKey::EC.new(read_file(src, key))
         end
         opts[:SSLEnable] = true
       end
 
       def start_callback(detached)
-        unless detached
-          proc do
-            @mutex.synchronize do
-              @running = true
-              Bridgetown.logger.info("Server running…", "press ctrl-c to stop.")
-              @run_cond.broadcast
-            end
+        return if detached
+
+        proc do
+          @mutex.synchronize do
+            @running = true
+            Bridgetown.logger.info("Server running…", "press ctrl-c to stop.")
+            @run_cond.broadcast
           end
         end
       end
 
       def stop_callback(detached)
-        unless detached
-          proc do
-            @mutex.synchronize do
-              @running = false
-              @run_cond.broadcast
-            end
+        return if detached
+
+        proc do
+          @mutex.synchronize do
+            @running = false
+            @run_cond.broadcast
           end
         end
       end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    class Start < Thor::Group
+      extend BuildOptions
+      extend Summarizable
+      include ConfigurationOverridable
+
+      Registrations.register do
+        register(Start, "start", "start", Start.summary)
+        register(Start, "dev", "dev", "Alias of start")
+      end
+
+      class_option :bind, aliases: "-B", desc: "URI for Puma to bind to (start with tcp://)"
+      class_option :skip_frontend,
+                   type: :boolean,
+                   desc: "Don't load the frontend bundler (always true for production)"
+      class_option :skip_live_reload,
+                   type: :boolean,
+                   desc: "Don't use the live reload functionality (always true for production)"
+
+      def self.banner
+        "bridgetown start [options]"
+      end
+      summary "Start the Puma server, frontend bundler, and Bridgetown watcher"
+
+      def start # rubocop:todo Metrics/PerceivedComplexity
+        Bridgetown.logger.writer.enable_prefix
+        Bridgetown::Commands::Build.print_startup_message
+        sleep 0.25
+
+        unless Bundler.definition.specs.find { |s| s.name == "puma" }
+          raise "** No Rack-compatible server found **"
+        end
+
+        options = Thor::CoreExt::HashWithIndifferentAccess.new(self.options)
+        options[:using_puma] = true
+
+        # Load Bridgetown configuration into thread memory
+        bt_options = configuration_with_overrides(options)
+
+        puma_pid =
+          Process.fork do
+            require "puma/cli"
+
+            Puma::Runner.class_eval do
+              def output_header(mode)
+                log "* Puma version: #{Puma::Const::PUMA_VERSION} (#{ruby_engine}) (\"#{Puma::Const::CODE_NAME}\")" # rubocop:disable Layout/LineLength
+                if mode == "cluster"
+                  log "* Cluster Master PID: #{Process.pid}"
+                else
+                  log "* PID: #{Process.pid}"
+                end
+              end
+            end
+
+            puma_args = []
+            if bt_options[:bind]
+              puma_args << "--bind"
+              puma_args << bt_options[:bind]
+            end
+
+            cli = Puma::CLI.new puma_args
+            cli.run
+          end
+
+        begin
+          unless Bridgetown.env.production? || options[:skip_frontend]
+            require "rake"
+            Rake.with_application do |rake|
+              rake.load_rakefile
+              rake["frontend:watcher"].invoke(true)
+            end
+          end
+
+          Signal.trap("TERM") do
+            Process.kill "SIGINT", puma_pid
+            sleep 0.5 # let it breathe
+            exit 0 # this runs the ensure block below
+          end
+
+          Process.setproctitle("bridgetown #{Bridgetown::VERSION} [#{File.basename(Dir.pwd)}]")
+
+          build_args = ["-w"] + ARGV.reject { |arg| arg == "start" }
+          if Bridgetown.env.development? && !options["url"]
+            scheme = bt_options.bind&.split("://")&.first == "ssl" ? "https" : "http"
+            port = bt_options.bind&.split(":")&.last || ENV["BRIDGETOWN_PORT"] || 4000
+            build_args << "--url"
+            build_args << "#{scheme}://localhost:#{port}"
+          end
+          Bridgetown::Commands::Build.start(build_args)
+        rescue StandardError => e
+          Process.kill "SIGINT", puma_pid
+          sleep 0.5
+          raise e
+        ensure
+          # Shut down webpack, browsersync, etc. if they're running
+          Bridgetown::Utils::Aux.kill_processes
+        end
+
+        sleep 0.5 # finish cleaning up
+      end
+    end
+  end
+end

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

@@ -24,8 +24,8 @@ const output = {
 
 // Rules and Loaders
 
-const jsRule =  {
-  test: /\.(js|jsx)/,
+const jsRule = {
+  test: /\.(js|jsx)$/,
   use: {
     loader: "esbuild-loader",
     options: {

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

@@ -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.ljust(longest_action).to_s.bold.blue}\t# #{description}"
         end
       end
 

data/lib/bridgetown-core/component.rb

@@ -30,7 +30,7 @@ module Bridgetown
       #
       # @param ext [String] erb, slim, etc.
       def renderer_for_ext(ext, &block)
-        @_tmpl ||= case ext
+        @_tmpl ||= case ext.to_s
                    when "erb"
                      include ERBCapture
                      Tilt::ErubiTemplate.new(component_template_path,
@@ -97,9 +97,7 @@ module Bridgetown
     #
     # @return [String] or nil
     def content
-      @_content ||= begin
-        view_context.capture(self, &@_content_block) if @_content_block
-      end
+      @_content ||= (view_context.capture(self, &@_content_block) if @_content_block)
     end
 
     # Provide a render helper for evaluation within the component context.
@@ -166,7 +164,6 @@ module Bridgetown
       end
     end
 
-    # rubocop:disable Style/MissingRespondToMissing
     ruby2_keywords def method_missing(method, *args, &block)
       if helpers.respond_to?(method.to_sym)
         helpers.send method.to_sym, *args, &block
@@ -178,6 +175,5 @@ module Bridgetown
     def respond_to_missing?(method, include_private = false)
       helpers.respond_to?(method.to_sym, include_private) || super
     end
-    # rubocop:enable Style/MissingRespondToMissing
   end
 end

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

@@ -14,10 +14,10 @@ module Bridgetown
     end
 
     def liquid_engine_configured?
-      data["template_engine"] == "liquid" ||
+      data["template_engine"].to_s == "liquid" ||
         (
           data["template_engine"].nil? && (
-            site.config[:template_engine].nil? || site.config[:template_engine] == "liquid"
+            site.config[:template_engine].nil? || site.config[:template_engine].to_s == "liquid"
           )
         )
     end

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

@@ -62,18 +62,6 @@ class Bridgetown::Site
       @frontmatter_defaults ||= Bridgetown::FrontmatterDefaults.new(self)
     end
 
-    # Whether to perform a full rebuild without incremental regeneration.
-    #   If either `override["incremental"]` or `config["incremental"]` are true,
-    #   fully rebuild the site. If not, incrementally build the site.
-    #
-    # @param [Hash] override
-    #   An override hash to override the current config value
-    # @option override [Boolean] "incremental" Whether to incrementally build
-    # @return [Boolean] true for full rebuild, false for normal build
-    def incremental?(override = {})
-      override["incremental"] || config["incremental"]
-    end
-
     # Returns the current instance of {Publisher} or creates a new instance of
     #   {Publisher} if one doesn't exist.
     #
@@ -177,7 +165,7 @@ class Bridgetown::Site
         dir.is_a?(Array) ? dir : [dir]
       end
       local_components_load_paths.map! do |dir|
-        if !!(dir =~ %r!^\.\.?\/!)
+        if !!(dir =~ %r!^\.\.?/!)
           # allow ./dir or ../../dir type options
           File.expand_path(dir.to_s, root_dir)
         else