bridgetown-core 2.0.5 → 2.1.0.beta1

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "samovar"
+require "freyia"
+
+unless defined?(Thor)
+  class ThorishCommand < Samovar::Command
+    Actions = Freyia::Setup
+
+    def self.inherited(klass)
+      super
+
+      klass.nested :command, {}
+
+      klass.define_method :call do
+        Bridgetown::Deprecator.deprecation_message(
+          "The #{self.class} command is using the Thor shim. Please migrate to using the " \
+          "Samovar-based command API in Bridgetown 2.1+. The Thor shim will be removed " \
+          "in a later Bridgetown release."
+        )
+
+        if @command
+          @command.()
+        else
+          print_usage
+        end
+      end
+    end
+
+    def self.desc(name, description)
+      @next_cmd_name = name
+      @next_cmd_description = description
+    end
+
+    def self.option(name, desc: "...", **kwargs, &block)
+      @next_cmd_options ||= []
+      @next_cmd_options << { args: [name, desc], kwargs:, block: }
+    end
+
+    def self.method_added(meth) # rubocop:disable Metrics
+      super
+
+      return unless @next_cmd_name
+
+      next_cmd_name = @next_cmd_name
+      new_cmd = Class.new(Samovar::Command)
+      new_cmd.define_method(:call) do
+        parent.instance_variable_set(:@options, @options)
+        parent.send(next_cmd_name)
+      end
+      new_cmd.description = @next_cmd_description
+
+      if @next_cmd_options&.empty?&.!
+        next_cmd_options = @next_cmd_options
+        new_cmd.options do
+          next_cmd_options.each do |opt|
+            name = opt[:args].shift
+            name = "--#{name}"
+            extra_kwargs = {}
+            extra_block = nil
+            if !opt[:kwargs][:type] || opt[:kwargs][:type] != :boolean
+              name = case opt[:kwargs][:type] # rubocop:disable Metrics/BlockNesting
+                     when :numeric
+                       extra_kwargs[:type] = Integer
+                       "#{name} <NUM>"
+                     when :array
+                       extra_block = proc do |value|
+                         value.split(%r{\s*,\s*})
+                       end
+                       "#{name} <ARR1,ARR2>"
+                     else
+                       "#{name} <STR>"
+                     end
+            end
+
+            name = "#{opt[:kwargs][:aliases]}/#{name}" if opt[:kwargs][:aliases]
+
+            option(name, opt[:args][1], required: opt[:kwargs][:required], **extra_kwargs,
+                   &extra_block)
+          end
+        end
+      end
+
+      table[:command].commands[next_cmd_name] = new_cmd
+
+      @next_cmd_name = nil
+      @next_cmd_description = nil
+    end
+
+    attr_reader :options
+  end
+
+  Thor = ThorishCommand
+end

data/lib/bridgetown-core/component.rb

@@ -11,7 +11,7 @@ module Bridgetown
     # @return [Bridgetown::Site]
     attr_reader :site # will be nil unless you explicitly set a `@site` ivar
 
-    # @return [Bridgetown::RubyTemplateView, Bridgetown::Component]
+    # @return [Bridgetown::TemplateView, Bridgetown::Component]
     attr_reader :view_context
 
     class << self
@@ -195,7 +195,7 @@ module Bridgetown
 
     # This is where the magic happens. Render the component within a view context.
     #
-    # @param view_context [Bridgetown::RubyTemplateView]
+    # @param view_context [Bridgetown::TemplateView]
     def render_in(view_context, &block)
       @view_context = view_context
       @_content_block = block
@@ -249,7 +249,7 @@ module Bridgetown
     end
 
     def helpers
-      @helpers ||= Bridgetown::RubyTemplateView::Helpers.new(self, view_context&.site)
+      @helpers ||= Bridgetown::TemplateView::Helpers.new(self, view_context&.site)
     end
 
     def method_missing(method, ...)

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

@@ -14,9 +14,7 @@ module Bridgetown
       return false unless published? || @site.config.unpublished
 
       future_allowed = collection.metadata.future || @site.config.future
-      this_time = date.is_a?(Date) ? date.to_time.to_i : date.to_i
-
-      future_allowed || this_time <= @site.time.to_i
+      future_allowed || date <= @site.time
     end
   end
 end

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

@@ -8,6 +8,8 @@ class Bridgetown::Site
     def locale
       @locale ||= begin
         locale = ENV.fetch("BRIDGETOWN_LOCALE", config[:default_locale]).to_sym
+        I18n.load_path += Gem.find_files_from_load_path("bridgetown-core/locale/en.*")
+        I18n.load_path.uniq!
         I18n.load_path += Dir["#{in_source_dir("_locales")}/**/*.{json,rb,yml}"]
         I18n.available_locales = config[:available_locales]
         I18n.default_locale = locale

data/lib/bridgetown-core/configuration/configuration_dsl.rb

@@ -56,8 +56,8 @@ module Bridgetown
         Bridgetown::Hooks.register_one(owner, event, priority:, reloadable: false, &)
       end
 
-      def source_manifest(**kwargs)
-        @scope.source_manifests << SourceManifest.new(**kwargs)
+      def source_manifest(**)
+        @scope.source_manifests << SourceManifest.new(**)
       end
 
       def builder(klass = nil, &)

data/lib/bridgetown-core/configuration.rb

@@ -5,17 +5,37 @@ module Bridgetown
   class Configuration < HashWithDotAccess::Hash
     using Bridgetown::Refinements
 
-    REQUIRE_DENYLIST = %i(parse_routes ssr) # rubocop:disable Style/MutableConstant
+    # Built-in initializer list which isn't Gem-backed:
+    REQUIRE_DENYLIST = %i(external_sources parse_routes ssr) # rubocop:disable Style/MutableConstant
 
-    Initializer = Struct.new(:name, :block, :completed, keyword_init: true) do
+    Initializer = Struct.new(:name, :block, :completed) do
       def to_s
         "#{name} (Initializer)"
       end
     end
 
-    SourceManifest = Struct.new(:origin, :components, :content, :layouts, keyword_init: true)
+    SourceManifest = Struct.new(:origin, :components, :contents, :layouts, :bare_text) do
+      def initialize(**kwargs)
+        # for backwards compatibility, we need to support plugin code which sets `content`
+        # directly, rather than uses the new multi-collections `contents` hash
+        if kwargs[:content]
+          kwargs[:contents] = { pages: kwargs[:content] }
+          kwargs.delete :content
+        end
+
+        super
+      end
+
+      def content
+        Bridgetown::Deprecator.deprecation_message(
+          "source_manifest.content is deprecated, use " \
+          "source_manifest.contents instead"
+        )
+        contents.values.first
+      end
+    end
 
-    Preflight = Struct.new(:source_manifests, :initializers, keyword_init: true) do
+    Preflight = Struct.new(:source_manifests, :initializers) do
       def initialize(*)
         super
         self.source_manifests ||= Set.new
@@ -44,7 +64,7 @@ module Bridgetown
         category: { key: "categories", title: "Category" }, tag: { key: "tags", title: "Tag" },
       },
       "autoload_paths"               => [],
-      "inflector"                    => Bridgetown::Inflector.new,
+      "inflector"                    => Bridgetown::Foundation::Inflector.new,
       "eager_load_paths"             => [],
       "autoloader_collapsed_paths"   => [],
       "additional_watch_paths"       => [],
@@ -359,9 +379,9 @@ module Bridgetown
     end
 
     DEFAULT_EXCLUDES = %w(
-      .sass-cache .bridgetown-cache
+      .sass-cache/ .bridgetown-cache/ tmp/
       gemfiles Gemfile Gemfile.lock gems.rb gems.locked
-      node_modules
+      node_modules/ config/
       vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/
     ).freeze
 

data/lib/bridgetown-core/converters/erb_templates.rb

@@ -56,9 +56,7 @@ module Bridgetown
         @buffer == other.to_str
     end
 
-    def html_safe?
-      true
-    end
+    def html_safe? = true
 
     def html_safe = to_s
 
@@ -74,13 +72,9 @@ module Bridgetown
       safe_concat val.to_s
     end
 
-    def to_s
-      @buffer.html_safe
-    end
+    def to_s = @buffer.html_safe
 
-    def to_str
-      @buffer.dup
-    end
+    def to_str = @buffer.dup
   end
 
   class ERBEngine < Erubi::CaptureBlockEngine
@@ -96,34 +90,50 @@ module Bridgetown
   end
 
   module ERBCapture
-    def capture(*args)
+    def capture(*)
       previous_buffer_state = @_erbout
       @_erbout = OutputBuffer.new
-      result = yield(*args)
-      result = @_erbout.presence || result
+      result = yield(*)
+      result = @_erbout unless @_erbout.empty?
       @_erbout = previous_buffer_state
       return result.to_s if result.is_a?(OutputBuffer)
 
-      # TODO: resolve below logic once Active Support patch to `ERB::Util.h` is removed
-      result.is_a?(String) ? ERB::Util.h(result) : result
+      result.is_a?(String) && !result.html_safe? ? Erubi.h(result) : result
     end
   end
 
-  class ERBView < RubyTemplateView
-    def h(input)
-      Erubi.h(input)
-    end
+  class ERBView < TemplateView
+    input :erb
+
+    def h(input) = Erubi.h(input)
 
     def partial(partial_name = nil, **options, &block)
       partial_name = options[:template] if partial_name.nil? && options[:template]
+      partial_path = _partial_path(partial_name, self.class.extname_list.first.delete_prefix("."))
+      unless _partial_path_exist?(partial_path)
+        @_call_super_method = true
+        return super
+      end
+
       options.merge!(options[:locals]) if options[:locals]
       options[:content] = capture(&block) if block
 
-      _render_partial partial_name, options
+      # The reason we have to do this funky rigamarole is because if a view superclass ends up
+      # needing to render the the partial, we want to call the superclass' `_render_partial`
+      # method, not the subclass'. Like, if `partial` is called for `SerbeaView`, and a `.serb`
+      # partial can't be found, we'll kick up to `ERBView`. Then if an `.erb` partial is found,
+      # we want `_render_partial` to be called via the `ERBView` definition, not `SerbeaView`!
+      if @_call_super_method
+        @_call_super_method = false
+        method(:_render_partial).super_method.call partial_path, options
+      else
+        _render_partial partial_path, options
+      end
     end
 
-    def _render_partial(partial_name, options)
-      partial_path = _partial_path(partial_name, "erb")
+    protected
+
+    def _render_partial(partial_path, options)
       site.tmp_cache["partial-tmpl:#{partial_path}"] ||= {
         signal: site.config.fast_refresh ? Signalize.signal(1) : nil,
       }

data/lib/bridgetown-core/converters/ruby_templates.rb

@@ -3,7 +3,9 @@
 require "streamlined/renderable"
 
 module Bridgetown
-  class PureRubyView < ERBView
+  class RubyView < ERBView
+    input :rb
+
     def render(item = nil, **options, &block) # rubocop:disable Metrics
       return @_erbout if !block && options.empty? && item.nil?
 
@@ -25,10 +27,12 @@ module Bridgetown
       end
     end
 
-    def _render_partial(partial_name, options) # rubocop:todo Metrics
-      partial_path = _partial_path(partial_name, "rb")
-      return super unless File.exist?(partial_path)
+    # @return [OutputBuffer, nil]
+    def output_buffer = @_erbout
+
+    protected
 
+    def _render_partial(partial_path, options) # rubocop:todo Metrics
       (@_locals_stack ||= []).push(options)
       (@_buffer_stack ||= []).push(@_erbout)
       @_erbout = OutputBuffer.new
@@ -48,15 +52,12 @@ module Bridgetown
       end
     end
 
-    def _output_buffer
-      @_erbout # might be nil
-    end
-
-    def locals
-      @_locals_stack&.last || {}
-    end
+    def locals = @_locals_stack&.last || {}
   end
 
+  # TODO: this class alias is deprecated and will be removed in the next major Bridgetown release
+  PureRubyView = RubyView
+
   module Converters
     class RubyTemplates < Converter
       priority :highest
@@ -65,7 +66,7 @@ module Bridgetown
 
       # rubocop:disable Style/DocumentDynamicEvalDefinition, Style/EvalWithLocation
       def convert(content, convertible)
-        rb_view = Bridgetown::PureRubyView.new(convertible)
+        rb_view = Bridgetown::RubyView.new(convertible)
 
         rb_view.instance_eval(
           "def __ruby_template;#{content};end", convertible.path.to_s, line_start(convertible)
@@ -76,7 +77,7 @@ module Bridgetown
                   else
                     rb_view.__ruby_template
                   end
-        (rb_view._output_buffer || results).to_s
+        (rb_view.output_buffer || results).to_s
       end
       # rubocop:enable Style/DocumentDynamicEvalDefinition, Style/EvalWithLocation
     end

data/lib/bridgetown-core/converters/serbea_templates.rb

@@ -7,8 +7,11 @@ module Bridgetown
   class SerbeaView < ERBView
     include Serbea::Helpers
 
-    def _render_partial(partial_name, options)
-      partial_path = _partial_path(partial_name, "serb")
+    input :serb
+
+    protected
+
+    def _render_partial(partial_path, options)
       site.tmp_cache["partial-tmpl:#{partial_path}"] ||= {
         signal: site.config.fast_refresh ? Signalize.signal(1) : nil,
       }

data/lib/bridgetown-core/entry_filter.rb

@@ -19,10 +19,7 @@ module Bridgetown
       @base_directory.to_s
     end
 
-    def derive_base_directory(site, base_dir)
-      base_dir[site.source] = "" if base_dir.start_with?(site.source)
-      base_dir
-    end
+    def derive_base_directory(site, base_dir) = base_dir.delete_prefix!(site.source)
 
     def relative_to_source(entry)
       File.join(

data/lib/bridgetown-core/front_matter/defaults.rb

@@ -134,7 +134,7 @@ module Bridgetown
       # @param collection [Symbol] the collection of the resource being processed
       # @return [Boolean] whether either of the above conditions are satisfied
       def applies_collection?(scope, collection)
-        !scope.key?("collection") || scope["collection"].eql?(collection.to_s)
+        !scope.key?("collection") || scope["collection"].to_s.eql?(collection.to_s)
       end
 
       # Checks if a given set of default values is valid

data/lib/bridgetown-core/front_matter/importer.rb

@@ -8,10 +8,16 @@ module Bridgetown
         klass.include Bridgetown::FrontMatter::RubyDSL
       end
 
-      def read_front_matter(file_path)
+      def read_front_matter(file_path, bare_text: false) # rubocop:todo Metrics/MethodLength
         file_contents = File.read(
           file_path, **Bridgetown::Utils.merged_file_read_opts(Bridgetown::Current.site, {})
         )
+
+        if bare_text
+          self.content = file_contents
+          return {}
+        end
+
         fm_result = nil
         Loaders.for(self).each do |loader|
           fm_result = loader.read(file_contents, file_path:) and break

data/lib/bridgetown-core/front_matter/loaders.rb

@@ -7,7 +7,7 @@ module Bridgetown
       autoload :Ruby, "bridgetown-core/front_matter/loaders/ruby"
       autoload :YAML, "bridgetown-core/front_matter/loaders/yaml"
 
-      Result = Struct.new(:content, :front_matter, :line_count, keyword_init: true)
+      Result = Struct.new(:content, :front_matter, :line_count)
 
       # Constructs a list of possible loaders for a {Model::RepoOrigin} or {Layout}
       #

data/lib/bridgetown-core/front_matter/ruby.rb

@@ -21,13 +21,9 @@ module Bridgetown
         set(key, value[0], &block)
       end
 
-      def each(&)
-        @data.each(&)
-      end
+      def each(&) = @data.each(&)
 
-      def get(key)
-        @data[key]
-      end
+      def get(key) = @data[key]
 
       def set(key, value = nil, &block)
         # Handle nested data within a block
@@ -45,9 +41,7 @@ module Bridgetown
         @data[key] = value
       end
 
-      def to_h
-        @data
-      end
+      def to_h = @data
     end
   end
 end

data/lib/bridgetown-core/generated_page.rb

@@ -289,8 +289,8 @@ module Bridgetown
       basename == "index"
     end
 
-    def trigger_hooks(hook_name, *args)
-      Bridgetown::Hooks.trigger :generated_pages, hook_name, self, *args
+    def trigger_hooks(hook_name, *)
+      Bridgetown::Hooks.trigger(:generated_pages, hook_name, self, *)
     end
 
     def type

data/lib/bridgetown-core/generators/prototype_generator.rb

@@ -80,7 +80,7 @@ module Bridgetown
     def validate_search_term(prototype_page)
       # @type [String]
       search_term = prototype_page.data["prototype"]["term"].to_s
-      return nil unless search_term.present?
+      return nil if search_term.empty?
 
       if prototype_page.data["prototype"]["collection"]
         @configured_collection = prototype_page.data["prototype"]["collection"].to_s

data/lib/bridgetown-core/helpers.rb

@@ -3,7 +3,7 @@
 require "streamlined/helpers"
 
 module Bridgetown
-  class RubyTemplateView
+  class TemplateView
     class Helpers
       using Bridgetown::Refinements
       include Bridgetown::Refinements::Helper
@@ -12,18 +12,18 @@ module Bridgetown
       include ::Streamlined::Helpers
       include Inclusive
 
-      # @return [Bridgetown::RubyTemplateView, Bridgetown::Component]
+      # @return [Bridgetown::TemplateView, Bridgetown::Component]
       attr_reader :view
 
       # @return [Bridgetown::Site]
       attr_reader :site
 
-      Context = Struct.new(:registers)
+      Context = Data.define(:registers)
 
       # @return [Bridgetown::Foundation::SafeTranslations]
       packages def translate_package = [Bridgetown::Foundation::Packages::SafeTranslations]
 
-      # @param view [Bridgetown::RubyTemplateView, Bridgetown::Component]
+      # @param view [Bridgetown::TemplateView, Bridgetown::Component]
       # @param site [Bridgetown::Site]
       def initialize(view = nil, site = nil)
         @view = view
@@ -112,10 +112,10 @@ module Bridgetown
       # @param options [Hash] pass keyword arguments to add HTML attributes
       # @return [String] the anchor tag HTML
       # @raise [ArgumentError] if the file cannot be found
-      def link_to(text, relative_path = nil, **options, &block)
-        if block.present?
+      def link_to(text, relative_path = nil, **options, &)
+        if block_given?
           relative_path = text
-          text = view.respond_to?(:capture) ? view.capture(&block) : yield
+          text = view.respond_to?(:capture) ? view.capture(&) : yield
         elsif relative_path.nil?
           raise ArgumentError, "You must provide a relative path"
         end
@@ -162,9 +162,9 @@ module Bridgetown
       end
       alias_method :t, :translate
 
-      def translate_with_html(key, **options)
+      def translate_with_html(key, **)
         escaper = ->(input) { input.to_s.encode(xml: :attr).gsub(%r{\A"|"\Z}, "") }
-        translate_package.translate(key, escaper, **options)
+        translate_package.translate(key, escaper, **)
       end
 
       # Delegates to <tt>I18n.localize</tt> with no additional functionality.
@@ -176,8 +176,7 @@ module Bridgetown
       end
       alias_method :l, :localize
 
-      # For template contexts where ActiveSupport's output safety is loaded, we
-      # can ensure a string has been marked safe
+      # In template contexts with output safety, we can ensure a string has been marked safe
       #
       # @param input [Object]
       # @return [String]

data/lib/bridgetown-core/hooks.rb

@@ -2,13 +2,12 @@
 
 module Bridgetown
   module Hooks
-    HookRegistration = Struct.new(
+    HookRegistration = Data.define(
       :owner,
       :event,
       :priority,
       :reloadable,
-      :block,
-      keyword_init: true
+      :block
     ) do
       def to_s
         "#{owner}:#{event} for #{block}"

data/lib/bridgetown-core/locale/en.yml

@@ -0,0 +1,30 @@
+# based on source material in the Active Support gem
+en:
+  date:
+    formats:
+      # Use the strftime parameters for formats.
+      # When no format has been given, it uses default.
+      # You can provide other formats here if you like!
+      default: "%Y-%m-%d"
+      short: "%b %d"
+      long: "%B %d, %Y"
+
+    day_names: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]
+    abbr_day_names: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
+
+    # Don't forget the nil at the beginning; there's no such thing as a 0th month
+    month_names: [~, January, February, March, April, May, June, July, August, September, October, November, December]
+    abbr_month_names: [~, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
+    # Used in date_select and datetime_select.
+    order:
+      - year
+      - month
+      - day
+
+  time:
+    formats:
+      default: "%a, %d %b %Y %H:%M:%S %z"
+      short: "%d %b %H:%M"
+      long: "%B %d, %Y %H:%M"
+    am: "am"
+    pm: "pm"

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

@@ -6,14 +6,14 @@ module Bridgetown
       include Bridgetown::RodaCallable
 
       class << self
-        def find(id, site: Bridgetown::Current.site)
+        def find(id, site: Bridgetown::Current.site, bare_text: false)
           raise "A Bridgetown site must be initialized and added to Current" unless site
 
-          origin = origin_for_id(id, site:)
+          origin = origin_for_id(id, site:, bare_text:)
           klass_for_id(id, origin:).new(origin.read)
         end
 
-        def origin_for_id(id, site: Bridgetown::Current.site)
+        def origin_for_id(id, site: Bridgetown::Current.site, bare_text: false)
           scheme = URI.parse(id).scheme
           origin_klass = Origin.descendants.find do |klass|
             klass.handle_scheme?(scheme)
@@ -21,7 +21,7 @@ module Bridgetown
 
           raise "No origin could be found for #{id}" unless origin_klass
 
-          origin_klass.new(id, site:)
+          origin_klass.new(id, site:, bare_text:)
         end
 
         def klass_for_id(id, origin: nil)
@@ -148,7 +148,7 @@ module Bridgetown
         return attributes[key.chop] = args.first if key.end_with?("=")
 
         Bridgetown.logger.warn "key `#{method_name}' not found in attributes for " \
-                               "#{attributes[:id].presence || "new #{self.class}"}"
+                               "#{attributes[:id] || "new #{self.class}"}"
         nil
       end
 

data/lib/bridgetown-core/model/builder_origin.rb

@@ -16,7 +16,7 @@ module Bridgetown
         end
       end
 
-      def initialize(id, site: Bridgetown::Current.site)
+      def initialize(id, site: Bridgetown::Current.site, bare_text: false)
         super
         @relative_path = Pathname.new(url.path.delete_prefix("/"))
       end

data/lib/bridgetown-core/model/origin.rb

@@ -12,14 +12,18 @@ module Bridgetown
       # @return [Bridgetown::Site]
       attr_accessor :site
 
+      # @return [Boolean]
+      attr_accessor :bare_text
+
       # You must implement in subclasses
       def self.handle_scheme?(_scheme)
         false
       end
 
-      def initialize(id, site: Bridgetown::Current.site)
+      def initialize(id, site: Bridgetown::Current.site, bare_text: false)
         self.id = id
         self.site = site
+        self.bare_text = bare_text
       end
 
       # You can override in subclass