bridgetown-core 0.21.5 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9369cb49650eed5ad6776258f190b8afd8afa714d6dfaa77b2c6c1c15537346
-  data.tar.gz: f8625881a5386a7520e4e22981254352d0040d28052e2f85c64f072884da6f05
+  metadata.gz: 835cfe03f425b73a33a5086c3d36a343c81bad231d31bf01049a4f7dd0d6cea5
+  data.tar.gz: 9c9a1a226a5ec9f40ad74203d8b692c4d4c126b3e35ab672893f69bea71dc79b
 SHA512:
-  metadata.gz: f8d19b3e0926ed332e4030ddf4c039292d14f490b509708dd51f81b0cd4b177b22a819920d35a3e4f0a4924204893f36fdc00c388ef9bed28dbf672af590dc96
-  data.tar.gz: 25dc48e4587613c547cd12cb762c7a968efedda1905d3fca1814deeab3af2f70ebdb755c6572793e8db817cbef8e16a8d741e517ae1eb7c978da05d353492d39
+  metadata.gz: ad5c876760ccc74c3662b989e682e7aa774fa91fb55e616ecc88d9237b37fede1edb0b5e2a48eccb9d9ecf5880cef46d5c8357ec4fb8550f4cad48c88c4b66b7
+  data.tar.gz: fa62ec5bbb0b5a121a1f0d0d68e11a562dba1a6714539c1a29802994722b9c783722313bc43248b99b75f87e979d9d74a7e84a40e11da567e9555dd3ae4b295c

data/bin/bridgetown

@@ -24,5 +24,7 @@ output_version = if ARGV[0] == "-v"
                    true
                  end
 
+ENV["RACK_ENV"] = ENV["BRIDGETOWN_ENV"]
+
 require "bridgetown-core/commands/base"
 Bridgetown::Commands::Base.start unless output_version

data/bridgetown-core.gemspec

@@ -46,6 +46,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("liquid",                "~> 5.0")
   s.add_runtime_dependency("liquid-component",      ">= 0.1")
   s.add_runtime_dependency("listen",                "~> 3.0")
+  s.add_runtime_dependency("rack-indifferent",      ">= 1.2.0")
+  s.add_runtime_dependency("rake",                  ">= 13.0")
+  s.add_runtime_dependency("roda",                  "~> 3.46")
   s.add_runtime_dependency("rouge",                 "~> 3.0")
   s.add_runtime_dependency("terminal-table",        "~> 1.8")
   s.add_runtime_dependency("thor",                  "~> 1.1")

data/lib/bridgetown-core/cleaner.rb

@@ -13,7 +13,6 @@ module Bridgetown
     # Cleans up the site's destination directory
     def cleanup!
       FileUtils.rm_rf(obsolete_files)
-      FileUtils.rm_rf(metadata_file) unless @site.incremental?
     end
 
     private
@@ -28,13 +27,6 @@ module Bridgetown
       out
     end
 
-    # Private: The metadata file storing dependency tree and build history
-    #
-    # Returns an Array with the metdata file as the only item
-    def metadata_file
-      [site.regenerator.metadata_file]
-    end
-
     # Private: The list of existing files, apart from those included in
     # keep_files and hidden files.
     #

data/lib/bridgetown-core/collection.rb

@@ -6,7 +6,6 @@ module Bridgetown
     attr_reader :site
 
     attr_reader :label, :metadata
-    attr_writer :docs
 
     attr_writer :resources
 
@@ -24,22 +23,10 @@ module Bridgetown
       label.in? %w(posts pages data).freeze
     end
 
-    def legacy_reader?
-      label.in? %w(posts data).freeze
-    end
-
     def data?
       label == "data"
     end
 
-    # Fetch the Documents in this collection.
-    # Defaults to an empty array if no documents have been read in.
-    #
-    # @return [Array<Bridgetown::Document>]
-    def docs
-      @docs ||= []
-    end
-
     # Fetch the Resources in this collection.
     # Defaults to an empty array if no resources have been read in.
     #
@@ -48,10 +35,23 @@ module Bridgetown
       @resources ||= []
     end
 
-    # Iterate over either Resources or Documents depending on how the site is
-    # configured
+    # Fetch the collection resources and arrange them by slug in a hash.
+    #
+    # @return [Hash<String, Bridgetown::Resource::Base>]
+    def resources_by_slug
+      resources.group_by { |item| item.data.slug }.transform_values(&:first)
+    end
+
+    # Fetch the collection resources and arrange them by relative URL in a hash.
+    #
+    # @return [Hash<String, Bridgetown::Resource::Base>]
+    def resources_by_relative_url
+      resources.group_by(&:relative_url).transform_values(&:first)
+    end
+
+    # Iterate over Resources
     def each(&block)
-      site.uses_resource? ? resources.each(&block) : docs.each(&block)
+      resources.each(&block)
     end
 
     # Fetch the static files in this collection.
@@ -67,38 +67,32 @@ module Bridgetown
       static_files
     end
 
-    # Read the allowed documents into the collection's array of docs.
+    # Read the allowed resources into the collection's array of resources.
     #
     # @return [Bridgetown::Collection] self
-    def read # rubocop:todo Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+    def read
       filtered_entries.each do |file_path|
         full_path = collection_dir(file_path)
         next if File.directory?(full_path)
 
-        if site.uses_resource?
-          next if File.basename(file_path).starts_with?("_")
+        next if File.basename(file_path).starts_with?("_")
 
-          if label == "data" || Utils.has_yaml_header?(full_path) ||
-              Utils.has_rbfm_header?(full_path)
-            read_resource(full_path)
-          else
-            read_static_file(file_path, full_path)
-          end
-        elsif Utils.has_yaml_header? full_path
-          read_document(full_path)
+        if label == "data" || Utils.has_yaml_header?(full_path) ||
+            Utils.has_rbfm_header?(full_path)
+          read_resource(full_path)
         else
           read_static_file(file_path, full_path)
         end
       end
       site.static_files.concat(static_files)
-      sort_docs!
+      sort_resources!
 
       self
     end
 
     # All the entries in this collection.
     #
-    # @return [Array<String>] file paths to the documents in this collection
+    # @return [Array<String>] file paths to the resources in this collection
     #   relative to the collection's folder
     def entries
       return [] unless exists?
@@ -178,7 +172,7 @@ module Bridgetown
       @entry_filter ||= Bridgetown::EntryFilter.new(
         site,
         base_directory: folder_name,
-        include_underscores: site.uses_resource?
+        include_underscores: true
       )
     end
 
@@ -186,7 +180,7 @@ module Bridgetown
     #
     # @return [String]
     def inspect
-      "#<#{self.class} @label=#{label} docs=#{docs} resources=#{resources}>"
+      "#<#{self.class} @label=#{label} resources=#{resources}>"
     end
 
     # Produce a sanitized label name
@@ -202,7 +196,7 @@ module Bridgetown
     # Produce a representation of this Collection for use in Liquid.
     # Exposes two attributes:
     #   - label
-    #   - docs
+    #   - resources
     #
     # @return [Bridgetown::Drops::CollectionDrop] representation of this
     #   collection for use in Liquid
@@ -210,7 +204,7 @@ module Bridgetown
       Drops::CollectionDrop.new self
     end
 
-    # Whether the collection's documents ought to be written as individual
+    # Whether the collection's resources ought to be written as individual
     #   files in the output.
     #
     # @return [Boolean] true if the 'write' metadata is true, false otherwise.
@@ -226,15 +220,6 @@ module Bridgetown
       end
     end
 
-    # LEGACY: The URL template to render collection's documents at.
-    #
-    # @return [String]
-    def url_template
-      @url_template ||= metadata.fetch("permalink") do
-        Utils.add_permalink_suffix("/:collection/:path", site.permalink_style)
-      end
-    end
-
     # Extract options for this collection from the site configuration.
     #
     # @return [HashWithDotAccess::Hash]
@@ -287,11 +272,30 @@ module Bridgetown
 
     # Read in resource from repo path
     # @param full_path [String]
-    def read_resource(full_path)
-      id = "repo://#{label}.collection/" + Addressable::URI.escape(
-        Pathname(full_path).relative_path_from(Pathname(site.source)).to_s
-      )
-      resource = Bridgetown::Model::Base.find(id).to_resource.read!
+    def read_resource(full_path, manifest: nil) # rubocop:todo Metrics/AbcSize
+      scheme = manifest ? "plugin" : "repo"
+      id = +"#{scheme}://#{label}.collection/"
+      id += "#{manifest.origin}/" if manifest
+      id += Addressable::URI.escape(
+        Pathname(full_path).relative_path_from(
+          manifest ? Pathname(manifest.content) : Pathname(site.source)
+        ).to_s
+      ).gsub("#", "%23")
+      model = Bridgetown::Model::Base.find(id)
+
+      if model.attributes.key?(:locale) && model.locale.to_sym == :multi
+        site.config.available_locales.each do |locale|
+          model.locale = locale
+          add_model_resource model
+        end
+        return
+      end
+
+      add_model_resource model
+    end
+
+    def add_model_resource(model)
+      resource = model.to_resource.read!
       resources << resource if site.config.unpublished || resource.published?
     end
 
@@ -301,50 +305,24 @@ module Bridgetown
       @container ||= site.config["collections_dir"]
     end
 
-    def read_document(full_path)
-      doc = Document.new(full_path, site: site, collection: self).tap(&:read)
-      docs << doc if site.config.unpublished || doc.published?
-    end
-
-    def sort_docs!
+    def sort_resources!
       if metadata["sort_by"].is_a?(String)
-        sort_docs_by_key!
         sort_resources_by_key!
       else
-        docs.sort!
         resources.sort!
       end
-      docs.reverse! if metadata.sort_direction == "descending"
       resources.reverse! if metadata.sort_direction == "descending"
     end
 
     # A custom sort function based on Schwartzian transform
     # Refer https://byparker.com/blog/2017/schwartzian-transform-faster-sorting/ for details
-    def sort_docs_by_key!
-      meta_key = metadata["sort_by"]
-      # Modify `docs` array to cache document's property along with the Document instance
-      docs.map! { |doc| [doc.data[meta_key], doc] }.sort! do |apples, olives|
-        order = determine_sort_order(meta_key, apples, olives)
-
-        # Fall back to `Document#<=>` if the properties were equal or were non-sortable
-        # Otherwise continue with current sort-order
-        if order.nil? || order.zero?
-          apples[-1] <=> olives[-1]
-        else
-          order
-        end
-
-        # Finally restore the `docs` array with just the Document objects themselves
-      end.map!(&:last)
-    end
-
     def sort_resources_by_key!
       meta_key = metadata["sort_by"]
-      # Modify `docs` array to cache document's property along with the Document instance
-      resources.map! { |doc| [doc.data[meta_key], doc] }.sort! do |apples, olives|
+      # Modify array to cache property along with the Resource instance
+      resources.map! { |r| [r.data[meta_key], r] }.sort! do |apples, olives|
         order = determine_sort_order(meta_key, apples, olives)
 
-        # Fall back to `Document#<=>` if the properties were equal or were non-sortable
+        # Fall back to `Resource::Base#<=>` if the properties were equal or were non-sortable
         # Otherwise continue with current sort-order
         if order.nil? || order.zero?
           apples[-1] <=> olives[-1]
@@ -352,7 +330,7 @@ module Bridgetown
           order
         end
 
-        # Finally restore the `docs` array with just the Document objects themselves
+        # Finally restore the `resources` array with just the objects themselves
       end.map!(&:last)
     end
 
@@ -369,9 +347,9 @@ module Bridgetown
       end
     end
 
-    def order_with_warning(sort_key, document, order)
+    def order_with_warning(sort_key, resource, order)
       Bridgetown.logger.warn "Sort warning:", "'#{sort_key}' not defined in" \
-                              " #{document.relative_path}"
+                              " #{resource.relative_path}"
       order
     end
 

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

@@ -19,11 +19,55 @@ module Bridgetown
         def find_command_possibilities(subcommand)
           if subcommand == "c"
             ["console"]
+          elsif subcommand == "s"
+            ["start"]
           else
             super
           end
         end
+
+        def display_rake_tasks(rake)
+          rake.options.show_all_tasks = true
+          rake.options.show_task_pattern = Regexp.new("")
+          rake.options.show_tasks = :tasks
+          rake.display_tasks_and_comments
+        end
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Style/GlobalVars
+        def handle_no_command_error(cmd, _has_namespace = $thor_runner)
+          require "rake"
+          Rake::TaskManager.record_task_metadata = true
+
+          Rake.with_application do |rake|
+            rake.instance_variable_set(:@name, "bridgetown")
+            rake.standard_exception_handling do
+              rakefile, _location = rake.find_rakefile_location
+              unless rakefile
+                puts "No Rakefile found (searching: #{rake.class::DEFAULT_RAKEFILES.join(", ")})\n"
+                new.invoke("help")
+                return # rubocop:disable Lint/NonLocalExitFromIterator
+              end
+              rake.load_rakefile
+              rake.top_level
+            end
+            cmd = cmd.split("[")
+            args = []
+            if cmd[1]
+              args = cmd[1].gsub('\,', "__COMMA__").delete_suffix!("]").split(",").map do |item|
+                item.gsub("__COMMA__", ",")
+              end
+            end
+
+            if Rake::Task.task_defined?(cmd[0])
+              Rake::Task[cmd[0]].invoke(*args)
+            else
+              puts "Unknown task: #{cmd[0]}\n\nHere's a list of tasks you can run:"
+              display_rake_tasks(rake)
+            end
+          end
+        end
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Style/GlobalVars
 
       desc "dream", "There's a place where that idea still exists as a reality"
       def dream
@@ -35,7 +79,7 @@ module Bridgetown
       end
 
       desc "help <command>", "Show detailed command usage information and exit"
-      def help(subcommand = nil)
+      def help(subcommand = nil) # rubocop:disable Metrics/MethodLength
         if subcommand && respond_to?(subcommand)
           klass = Kernel.const_get("Bridgetown::Commands::#{subcommand.capitalize}")
           klass.start(["-h"])
@@ -47,6 +91,21 @@ module Bridgetown
           puts "  bridgetown <command> [options]"
           puts ""
           super
+
+          require "rake"
+          Rake::TaskManager.record_task_metadata = true
+          Rake.with_application do |rake|
+            rake.instance_variable_set(:@name, "  bridgetown")
+            rake.standard_exception_handling do
+              rakefile, _location = rake.find_rakefile_location
+              return unless rakefile # rubocop:disable Lint/NonLocalExitFromIterator
+
+              rake.load_rakefile
+              rake.top_level
+              puts "Available Rake Tasks:"
+              self.class.display_rake_tasks(rake)
+            end
+          end
         end
       end
     end

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

@@ -21,15 +21,26 @@ module Bridgetown
                    aliases: "-w",
                    desc: "Watch for changes and rebuild"
 
+      def self.print_startup_message
+        Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
+                               " (codename \"#{Bridgetown::CODE_NAME.yellow}\")"
+      end
+
       # Build your bridgetown site
       # Continuously watch if `watch` is set to true in the config.
       def build
         Bridgetown.logger.adjust_verbosity(options)
 
-        Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
-                               " (codename \"#{Bridgetown::CODE_NAME.yellow}\")"
+        unless caller_locations.find do |loc|
+          loc.to_s.include?("bridgetown-core/commands/start.rb")
+        end
+          self.class.print_startup_message
+        end
+
+        config_options = (
+          Bridgetown::Current.preloaded_configuration || configuration_with_overrides(options)
+        ).merge(options)
 
-        config_options = Serve.loaded_config || configuration_with_overrides(options)
         config_options["serving"] = false unless config_options["serving"]
         @site = Bridgetown::Site.new(config_options)
 
@@ -64,13 +75,22 @@ module Bridgetown
           Bridgetown.logger.info "Unpublished mode:",
                                  "enabled. Processing documents marked unpublished"
         end
-        incremental = config_options["incremental"]
-        Bridgetown.logger.info "Incremental build:",
-                               (incremental ? "enabled" : "disabled. Enable with --incremental")
         Bridgetown.logger.info "Generating…"
         @site.process
         Bridgetown.logger.info "Done! 🎉", "#{"Completed".green} in less than" \
                                 " #{(Time.now - t).ceil(2)} seconds."
+        if 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
       end
 
       # Watch for file changes and rebuild the site.

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

@@ -33,18 +33,15 @@ module Bridgetown
         klass.class_option :future,
                            type: :boolean,
                            desc: "Publishes posts with a future date"
-        klass.class_option :limit_posts,
-                           type: :numeric,
-                           desc: "Limits the number of posts to parse and publish"
+        klass.class_option :url,
+                           aliases: "-u",
+                           desc: "Override the configured url for the website"
         klass.class_option :base_path,
                            aliases: "-b",
                            desc: "Serve the website from the given base path"
         klass.class_option :force_polling,
                            type: :boolean,
                            desc: "Force watch to use polling"
-        klass.class_option :lsi,
-                           type: :boolean,
-                           desc: "Use LSI for improved related posts"
         klass.class_option :unpublished,
                            type: :boolean,
                            aliases: "-U",
@@ -63,10 +60,6 @@ module Bridgetown
                            aliases: "-V",
                            type: :boolean,
                            desc: "Print verbose output."
-        klass.class_option :incremental,
-                           aliases: "-I",
-                           type: :boolean,
-                           desc: "Enable incremental rebuild."
         klass.class_option :strict_front_matter,
                            type: :boolean,
                            desc: "Fail if errors are present in front matter"

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

@@ -11,7 +11,9 @@ module Bridgetown
       def configuration_with_overrides(options)
         return options if options.is_a?(Bridgetown::Configuration)
 
-        Bridgetown.configuration(options)
+        Bridgetown.configuration(options).tap do |new_config|
+          Bridgetown::Current.preloaded_configuration = new_config
+        end
       end
     end
   end

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

@@ -71,7 +71,7 @@ module Bridgetown
 
       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
 
@@ -106,9 +106,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

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

@@ -119,7 +119,7 @@ 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}."
@@ -128,12 +128,17 @@ module Bridgetown
           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 +150,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

@@ -145,8 +145,7 @@ module Bridgetown
         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

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,9 @@ module Bridgetown
       ).freeze
 
       def serve
+        Bridgetown::Deprecator.deprecation_message "The serve command will be " \
+          "removed in favor of using Puma in the next major release of Bridgetown"
+
         @mutex = Mutex.new
         @run_cond = ConditionVariable.new
         @running = false
@@ -63,10 +62,13 @@ module Bridgetown
         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,11 +78,10 @@ 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)
@@ -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)