bridgetown-core 0.21.2 → 1.0.0.alpha2

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

@@ -30,9 +30,9 @@ module Bridgetown
       def initialize(model:)
         @model = model
         @site = model.site
-        self.data = HashWithDotAccess::Hash.new
+        @data = front_matter_defaults
 
-        trigger_hooks(:post_init)
+        trigger_hooks :post_init
       end
 
       # Collection associated with this resource
@@ -53,7 +53,7 @@ module Bridgetown
         @layout = site.layouts[data.layout].tap do |layout|
           unless layout
             Bridgetown.logger.warn "Resource:", "Layout '#{data.layout}' " \
-            "requested via #{relative_path} does not exist."
+                                                "requested via #{relative_path} does not exist."
           end
         end
       end
@@ -75,20 +75,21 @@ module Bridgetown
         @relations ||= Bridgetown::Resource::Relations.new(self)
       end
 
+      # Loads in any default front matter associated with the resource.
+      #
+      # @return [HashWithDotAccess::Hash]
+      def front_matter_defaults
+        site.frontmatter_defaults.all(
+          relative_path.to_s,
+          collection.label.to_sym
+        ).with_dot_access
+      end
+
+      # Merges new data into the existing data hash.
+      #
       # @param new_data [HashWithDotAccess::Hash]
       def data=(new_data)
-        unless new_data.is_a?(HashWithDotAccess::Hash)
-          raise "#{self.class} data should be of type HashWithDotAccess::Hash"
-        end
-
-        @data = new_data
-        @data.default_proc = proc do |_, key|
-          site.frontmatter_defaults.find(
-            relative_path.to_s,
-            collection.label.to_sym,
-            key.to_s
-          )
-        end
+        @data = @data.merge(new_data)
       end
 
       # @return [Bridgetown::Resource::Base]
@@ -107,7 +108,7 @@ module Bridgetown
 
         @destination = Destination.new(self) if requires_destination?
 
-        trigger_hooks(:post_read)
+        trigger_hooks :post_read
 
         self
       end
@@ -115,6 +116,8 @@ module Bridgetown
 
       def transform!
         transformer.process! unless collection.data?
+
+        self
       end
 
       def trigger_hooks(hook_name, *args)
@@ -188,7 +191,7 @@ module Bridgetown
       def summary
         return summary_extension_output if respond_to?(:summary_extension_output)
 
-        content.to_s.strip.lines.first.to_s.strip
+        content.to_s.strip.lines.first.to_s.strip.html_safe
       end
 
       # @return [Hash<String, Hash<String => Bridgetown::Resource::TaxonomyType,
@@ -260,19 +263,18 @@ module Bridgetown
         "#<#{self.class} #{id}>"
       end
 
-      # Compare this document against another document.
-      # Comparison is a comparison between the 2 paths of the documents.
+      # Compare this resource against another resource.
+      # Comparison is a comparison between the 2 dates or paths of the resources.
       #
-      # Returns -1, 0, +1 or nil depending on whether this doc's path is less than,
-      #   equal or greater than the other doc's path. See String#<=> for more details.
+      # @return [Integer] -1, 0, or +1
       def <=>(other) # rubocop:todo Metrics/AbcSize
         return nil unless other.respond_to?(:data)
 
-        if data.date.respond_to?(:to_datetime) && other.data.date.respond_to?(:to_datetime)
-          return data.date.to_datetime <=> other.data.date.to_datetime
-        end
+        cmp = if data.date.respond_to?(:to_datetime) && other.data.date.respond_to?(:to_datetime)
+                data.date.to_datetime <=> other.data.date.to_datetime
+              end
 
-        cmp = data["date"] <=> other.data["date"]
+        cmp = data["date"] <=> other.data["date"] if cmp.nil?
         cmp = path <=> other.path if cmp.nil? || cmp.zero?
         cmp
       end
@@ -291,7 +293,9 @@ module Bridgetown
 
       private
 
-      def ensure_default_data
+      def ensure_default_data # rubocop:todo Metrics/AbcSize
+        determine_locale
+
         slug = if matches = relative_path.to_s.match(DATE_FILENAME_MATCHER) # rubocop:disable Lint/AssignmentInCondition
                  set_date_from_string(matches[1]) unless data.date
                  matches[2]
@@ -299,6 +303,8 @@ module Bridgetown
                  basename_without_ext
                end
 
+        slug.chomp!(".#{data.locale}") if data.locale && slug.ends_with?(".#{data.locale}")
+
         data.slug ||= slug
         data.title ||= Bridgetown::Utils.titleize_slug(slug)
       end
@@ -308,7 +314,7 @@ module Bridgetown
 
         data.date = Bridgetown::Utils.parse_date(
           new_date,
-          "Document '#{relative_path}' does not have a valid date in the #{model}."
+          "Resource '#{relative_path}' does not have a valid date."
         )
       end
 
@@ -331,6 +337,24 @@ module Bridgetown
         end
       end
 
+      def determine_locale # rubocop:todo Metrics/AbcSize
+        unless data.locale
+          data.locale = locale_from_alt_data_or_filename.presence || site.config.default_locale
+        end
+
+        return unless data.locale_overrides.is_a?(Hash) && data.locale_overrides&.key?(data.locale)
+
+        data.merge!(data.locale_overrides[data.locale])
+      end
+
+      # Look for alternative front matter or look at the filename pattern: slug.locale.ext
+      def locale_from_alt_data_or_filename
+        found_locale = data.language || data.lang || basename_without_ext.split(".")[1..-1].last
+        return unless found_locale && site.config.available_locales.include?(found_locale.to_sym)
+
+        found_locale
+      end
+
       def format_url(url)
         url.to_s.sub(%r{index\.html?$}, "").sub(%r{\.html?$}, "")
       end

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

@@ -36,20 +36,20 @@ module Bridgetown
         new_url = url_segments.map do |segment|
           segment.starts_with?(":") ? process_segment(segment.sub(%r{^:}, "")) : segment
         end.select(&:present?).join("/")
-
         # No relative URLs should ever end in /index.html
         new_url.sub!(%r{/index$}, "") if final_ext == ".html"
 
-        add_base_path finalize_permalink(new_url, permalink)
+        ensure_base_path finalize_permalink(new_url, permalink)
       end
 
       def process_segment(segment)
         segment = segment.to_sym
         if self.class.placeholder_processors[segment]
           segment_value = self.class.placeholder_processors[segment].(resource)
-          if segment_value.is_a?(Hash)
+          case segment_value
+          when Hash
             segment_value[:raw_value]
-          elsif segment_value.is_a?(Array)
+          when Array
             segment_value.map do |subsegment|
               Utils.slugify(subsegment, mode: slugify_mode)
             end.join("/")
@@ -66,13 +66,13 @@ module Bridgetown
 
         case permalink_style.to_sym
         when :pretty
-          "#{collection_prefix}/:categories/:year/:month/:day/:slug/"
+          "/:locale/#{collection_prefix}/:categories/:year/:month/:day/:slug/"
         when :pretty_ext, :date
-          "#{collection_prefix}/:categories/:year/:month/:day/:slug.*"
+          "/:locale/#{collection_prefix}/:categories/:year/:month/:day/:slug.*"
         when :simple
-          "#{collection_prefix}/:categories/:slug/"
+          "/:locale/#{collection_prefix}/:categories/:slug/"
         when :simple_ext
-          "#{collection_prefix}/:categories/:slug.*"
+          "/:locale/#{collection_prefix}/:categories/:slug.*"
         else
           permalink_style.to_s
         end
@@ -96,7 +96,7 @@ module Bridgetown
         end
       end
 
-      def add_base_path(permalink)
+      def ensure_base_path(permalink)
         if resource.site.base_path.present?
           return "#{resource.site.base_path(strip_slash_only: true)}#{permalink}"
         end
@@ -108,7 +108,16 @@ module Bridgetown
 
       # @param resource [Bridgetown::Resource::Base]
       register_placeholder :path, ->(resource) do
-        { raw_value: resource.relative_path_basename_without_prefix }
+        {
+          raw_value: resource.relative_path_basename_without_prefix.tap do |path|
+            if resource.site.config["collections_dir"].present?
+              path.delete_prefix! "#{resource.site.config["collections_dir"]}/"
+            end
+            if resource.data.locale && path.ends_with?(".#{resource.data.locale}")
+              path.chomp!(".#{resource.data.locale}")
+            end
+          end,
+        }
       end
 
       # @param resource [Bridgetown::Resource::Base]
@@ -128,8 +137,10 @@ module Bridgetown
 
       # @param resource [Bridgetown::Resource::Base]
       register_placeholder :locale, ->(resource) do
-        locale_data = resource.data.locale
-        resource.site.config.available_locales.include?(locale_data) ? locale_data : nil
+        next nil if resource.data.locale&.to_sym == resource.site.config.default_locale
+
+        locale_data = resource.data.locale&.to_sym
+        resource.site.config.available_locales.include?(locale_data) ? locale_data.to_s : nil
       end
       register_placeholder :lang, placeholder_processors[:locale]
 

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

@@ -94,9 +94,8 @@ module Bridgetown
       # @return [Bridgetown::Resource::Base, Array<Bridgetown::Resource::Base>]
       def belongs_to_relation_for_type(type)
         if resource.data[type].is_a?(Array)
-          other_collection_for_type(type).resources.select do |other_resource|
-            other_resource.data.slug.in?(resource.data[type])
-          end
+          other_slugs = other_collection_for_type(type).resources_by_slug
+          resource.data[type].map { |slug| other_slugs[slug] }.compact
         else
           other_collection_for_type(type).resources.find do |other_resource|
             other_resource.data.slug == resource.data[type]

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

@@ -3,11 +3,7 @@
 module Bridgetown
   module Resource
     class TaxonomyTerm
-      attr_reader :resource
-
-      attr_reader :label
-
-      attr_reader :type
+      attr_reader :resource, :label, :type
 
       def initialize(resource:, label:, type:)
         @resource = resource

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

@@ -41,7 +41,7 @@ module Bridgetown
       def execute_inline_ruby!
         return unless site.config.should_execute_inline_ruby?
 
-        Bridgetown::Utils::RubyExec.search_data_for_ruby_code(resource, self)
+        Bridgetown::Utils::RubyExec.search_data_for_ruby_code(resource)
       end
 
       def inspect
@@ -103,10 +103,12 @@ module Bridgetown
       end
 
       def warn_on_missing_layout(layout, layout_name)
-        if layout.nil? && layout_name
-          Bridgetown.logger.warn "Build Warning:", "Layout '#{layout_name}' " \
-          "requested via #{resource.relative_path} does not exist."
-        end
+        return unless layout.nil? && layout_name
+
+        Bridgetown.logger.warn(
+          "Build Warning:",
+          "Layout '#{layout_name}' requested via #{resource.relative_path} does not exist."
+        )
       end
 
       ### Transformation Actions
@@ -152,7 +154,7 @@ module Bridgetown
         layout_input = layout.content.dup
 
         layout_converters.inject(layout_input) do |content, converter|
-          next(content) unless [2, -2].include?(converter.method(:convert).arity)
+          next(content) unless [2, -2].include?(converter.method(:convert).arity) # rubocop:disable Performance/CollectionLiteralInLoop
 
           layout.current_document = resource
           layout.current_document_output = output

data/lib/bridgetown-core/ruby_template_view.rb

@@ -61,19 +61,17 @@ module Bridgetown
       @helpers ||= Helpers.new(self, site)
     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
+    ruby2_keywords def method_missing(method_name, *args, &block)
+      if helpers.respond_to?(method_name.to_sym)
+        helpers.send method_name.to_sym, *args, &block
       else
         super
       end
     end
 
-    def respond_to_missing?(method, include_private = false)
-      helpers.respond_to?(method.to_sym, include_private) || super
+    def respond_to_missing?(method_name, include_private = false)
+      helpers.respond_to?(method_name.to_sym, include_private) || super
     end
-    # rubocop:enable Style/MissingRespondToMissing
 
     private
 
@@ -84,7 +82,7 @@ module Bridgetown
                            ["{% render \"#{component}\""]
                          end
       unless options.empty?
-        render_statement << ", " + options.keys.map { |k| "#{k}: #{k}" }.join(", ")
+        render_statement << ", #{options.keys.map { |k| "#{k}: #{k}" }.join(", ")}"
       end
       render_statement << " %}"
       if options[:_block_content]

data/lib/bridgetown-core/site.rb

@@ -10,10 +10,11 @@ module Bridgetown
     include Localizable
     include Processable
     include Renderable
+    include SSR
     include Writable
 
     attr_reader   :root_dir, :source, :dest, :cache_dir, :config,
-                  :regenerator, :liquid_renderer, :components_load_paths,
+                  :liquid_renderer, :components_load_paths,
                   :includes_load_paths
 
     # All files not pages/documents or structured data in the source folder
@@ -23,12 +24,8 @@ module Bridgetown
     # @return [Array<Layout>]
     attr_accessor :layouts
 
-    # @return [Array<Page>]
-    attr_accessor :pages
-
-    # NOTE: Eventually pages will be deprecated once the Resource content engine
-    # is default
-    alias_method :generated_pages, :pages
+    # @return [Array<GeneratedPage>]
+    attr_accessor :generated_pages
 
     attr_accessor :permalink_style, :time, :data,
                   :file_read_opts, :plugin_manager, :converters,
@@ -44,7 +41,6 @@ module Bridgetown
       @plugin_manager  = PluginManager.new(self)
       @cleaner         = Cleaner.new(self)
       @reader          = Reader.new(self)
-      @regenerator     = Regenerator.new(self)
       @liquid_renderer = LiquidRenderer.new(self)
 
       ensure_not_in_dest

data/lib/bridgetown-core/static_file.rb

@@ -21,10 +21,11 @@ module Bridgetown
 
     # Initialize a new StaticFile.
     #
-    # site - The Site.
-    # base - The String path to the <source>.
-    # dir  - The String path between <source> and the file.
-    # name - The String filename of the file.
+    # @param site [Bridgetown::Site]
+    # @param base [String] path to the <source>.
+    # @param dir [String] path between <source> and the file.
+    # @param name [String] filename of the file.
+    # @param collection [Bridgetown::Collection] optional collection the file is attached to
     def initialize(site, base, dir, name, collection = nil) # rubocop:disable Metrics/ParameterLists
       @site = site
       @base = base
@@ -34,20 +35,16 @@ module Bridgetown
       @relative_path = File.join(*[@dir, @name].compact)
       @extname = File.extname(@name)
       @data = @site.frontmatter_defaults.all(relative_path, type).with_dot_access
-      if site.uses_resource? && !data.permalink
-        data.permalink = if collection && !collection.builtin?
-                           "/:collection/:path.*"
+      data.permalink ||= if collection && !collection.builtin?
+                           "#{collection.default_permalink.chomp("/").chomp(".*")}.*"
                          else
                            "/:path.*"
                          end
-      end
     end
 
     # Returns source file path.
     def path
-      @path ||= begin
-        File.join(*[@base, @dir, @name].compact)
-      end
+      @path ||= File.join(*[@base, @dir, @name].compact)
     end
 
     # Obtain destination path.
@@ -58,7 +55,7 @@ module Bridgetown
     def destination(dest)
       dest = site.in_dest_dir(dest)
       dest_url = url
-      if site.uses_resource? && site.base_path.present? && collection
+      if site.base_path.present? && collection
         dest_url = dest_url.delete_prefix site.base_path(strip_slash_only: true)
       end
       site.in_dest_dir(dest, Bridgetown::URL.unescape_path(dest_url))
@@ -112,6 +109,7 @@ module Bridgetown
 
       FileUtils.mkdir_p(File.dirname(dest_path))
       FileUtils.rm(dest_path) if File.exist?(dest_path)
+      Bridgetown.logger.debug "Saving file:", dest_path
       copy_file(dest_path)
 
       true
@@ -177,14 +175,9 @@ module Bridgetown
           site.config.content_engine != "resource"
         base = if @collection.nil? || special_posts_case
                  cleaned_relative_path
-               elsif site.uses_resource?
+               else
                  newly_processed = true
                  Bridgetown::Resource::PermalinkProcessor.new(self).transform
-               else
-                 Bridgetown::URL.new(
-                   template: @collection.url_template,
-                   placeholders: placeholders
-                 )
                end.to_s.chomp("/")
         newly_processed ? base : "#{base}#{extname}"
       end
@@ -212,9 +205,9 @@ module Bridgetown
     def copy_file(dest_path)
       FileUtils.copy_entry(path, dest_path)
 
-      unless File.symlink?(dest_path)
-        File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
-      end
+      return if File.symlink?(dest_path)
+
+      File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
     end
   end
 end

data/lib/bridgetown-core/tags/find.rb

@@ -11,12 +11,7 @@ module Bridgetown
 
       def initialize(tag_name, markup, tokens)
         super
-        if markup.strip =~ SYNTAX
-          @new_var_name = Regexp.last_match(1).strip
-          @single_or_group = Regexp.last_match(2)
-          @arr_name = Regexp.last_match(3).strip
-          @conditions = process_conditions(Regexp.last_match(4).strip)
-        else
+        unless markup.strip =~ SYNTAX
           raise SyntaxError, <<~MSG
             Syntax Error in tag 'find' while parsing the following markup:
 
@@ -25,6 +20,11 @@ module Bridgetown
             Valid syntax: find <varname> where|in <array>, <condition(s)>
           MSG
         end
+
+        @new_var_name = Regexp.last_match(1).strip
+        @single_or_group = Regexp.last_match(2)
+        @arr_name = Regexp.last_match(3).strip
+        @conditions = process_conditions(Regexp.last_match(4).strip)
       end
 
       def render(context)

data/lib/bridgetown-core/tags/highlight.rb

@@ -14,10 +14,7 @@ module Bridgetown
 
       def initialize(tag_name, markup, tokens)
         super
-        if markup.strip =~ SYNTAX
-          @lang = Regexp.last_match(1).downcase
-          @highlight_options = parse_options(Regexp.last_match(2))
-        else
+        unless markup.strip =~ SYNTAX
           raise SyntaxError, <<~MSG
             Syntax Error in tag 'highlight' while parsing the following markup:
 
@@ -26,6 +23,9 @@ module Bridgetown
             Valid syntax: highlight <lang> [linenos]
           MSG
         end
+
+        @lang = Regexp.last_match(1).downcase
+        @highlight_options = parse_options(Regexp.last_match(2))
       end
 
       LEADING_OR_TRAILING_LINE_TERMINATORS = %r!\A(\n|\r)+|(\n|\r)+\z!.freeze
@@ -89,7 +89,7 @@ module Bridgetown
           "data-lang=\"#{@lang}\"",
         ].join(" ")
         "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
-        "#{code.chomp}</code></pre></figure>"
+          "#{code.chomp}</code></pre></figure>"
       end
     end
   end

data/lib/bridgetown-core/tags/include.rb

@@ -9,15 +9,18 @@ module Bridgetown
 
       VALID_SYNTAX = %r!
         ([\w-]+)\s*=\s*
-        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
+        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w.-]+))
       !x.freeze
+
+      # rubocop:disable Lint/MixedRegexpCaptureTypes
       VARIABLE_SYNTAX = %r!
-        (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
+        (?<variable>[^{]*(\{\{\s*[\w\-.]+\s*(\|.*)?\}\}[^\s{}]*)+)
         (?<params>.*)
       !mx.freeze
+      # rubocop:enable Lint/MixedRegexpCaptureTypes
 
       FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!.freeze
-      VALID_FILENAME_CHARS = %r!^[\w/\.-]+$!.freeze
+      VALID_FILENAME_CHARS = %r!^[\w/.-]+$!.freeze
       INVALID_SEQUENCES = %r![./]{2,}!.freeze
 
       def initialize(tag_name, markup, tokens)
@@ -66,33 +69,33 @@ module Bridgetown
       end
 
       def validate_file_name(file)
-        if INVALID_SEQUENCES.match?(file) || !VALID_FILENAME_CHARS.match?(file)
-          raise ArgumentError, <<~MSG
-            Invalid syntax for include tag. File contains invalid characters or sequences:
+        return unless INVALID_SEQUENCES.match?(file) || !VALID_FILENAME_CHARS.match?(file)
 
-              #{file}
+        raise ArgumentError, <<~MSG
+          Invalid syntax for include tag. File contains invalid characters or sequences:
 
-            Valid syntax:
+            #{file}
 
-              #{syntax_example}
+          Valid syntax:
 
-          MSG
-        end
+            #{syntax_example}
+
+        MSG
       end
 
       def validate_params
-        unless FULL_VALID_SYNTAX.match?(@params)
-          raise ArgumentError, <<~MSG
-            Invalid syntax for include tag:
+        return if FULL_VALID_SYNTAX.match?(@params)
 
-            #{@params}
+        raise ArgumentError, <<~MSG
+          Invalid syntax for include tag:
 
-            Valid syntax:
+          #{@params}
 
-            #{syntax_example}
+          Valid syntax:
 
-          MSG
-        end
+          #{syntax_example}
+
+        MSG
       end
 
       # Grab file read opts in the context
@@ -119,16 +122,12 @@ module Bridgetown
       end
 
       def render(context)
-        site = context.registers[:site]
-
         file = render_variable(context) || @file
         validate_file_name(file)
 
         path = locate_include_file(context, file)
         return unless path
 
-        add_include_to_dependency(site, path, context)
-
         partial = load_cached_partial(path, context)
 
         context.stack do
@@ -143,15 +142,6 @@ module Bridgetown
         end
       end
 
-      def add_include_to_dependency(site, path, context)
-        if context.registers[:page]&.key?("path")
-          site.regenerator.add_dependency(
-            site.in_source_dir(context.registers[:page]["path"]),
-            path
-          )
-        end
-      end
-
       def load_cached_partial(path, context)
         context.registers[:cached_partials] ||= {}
         cached_partial = context.registers[:cached_partials]

data/lib/bridgetown-core/tags/link.rb

@@ -23,6 +23,10 @@ module Bridgetown
         relative_path = Liquid::Template.parse(@relative_path).render(context)
 
         site.each_site_file do |item|
+          # Resource engine:
+          if item.respond_to?(:relative_url) && item.relative_path.to_s == relative_path
+            return item.relative_url
+          end
           return relative_url(item) if item.relative_path == relative_path
           # This takes care of the case for static files that have a leading /
           return relative_url(item) if item.relative_path == "/#{relative_path}"

data/lib/bridgetown-core/tags/live_reload_dev_js.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Tags
+    class LiveReloadJsTag < Liquid::Tag
+      def render(context)
+        Bridgetown::Utils.live_reload_js(context.registers[:site])
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("live_reload_dev_js", Bridgetown::Tags::LiveReloadJsTag)