bridgetown-core 0.21.4 → 1.0.0.alpha1

data/lib/bridgetown-core/reader.rb

@@ -12,36 +12,33 @@ module Bridgetown
     # Read Site data from disk and load it into internal data structures.
     #
     # Returns nothing.
-    def read # rubocop:todo Metrics/AbcSize
+    def read
       site.defaults_reader.read
-      site.layouts = LayoutReader.new(site).read
+      read_layouts
       read_directories
-      read_included_excludes
+      read_includes
       sort_files!
-      site.data = if site.uses_resource?
-                    site.collections.data.read
-                    site.collections.data.merge_data_resources
-                  else
-                    DataReader.new(site).read
-                  end
+      site.data = site.collections.data.read.merge_data_resources
       read_collections
-      Bridgetown::PluginManager.source_manifests.map(&:content).compact.each do |plugin_content_dir|
-        PluginContentReader.new(site, plugin_content_dir).read
+      Bridgetown::PluginManager.source_manifests.select(&:content).each do |manifest|
+        PluginContentReader.new(site, manifest).read
       end
     end
 
+    def read_layouts
+      site.layouts = LayoutReader.new(site).read
+    end
+
     def read_collections
       site.collections.each_value do |collection|
-        next if site.uses_resource? && collection.data?
-        next if !site.uses_resource? && collection.legacy_reader?
+        next if collection.data?
 
         collection.read
       end
     end
 
-    # Sorts posts, pages, and static files.
+    # Sorts generated pages and static files.
     def sort_files!
-      site.collections.posts.docs.sort! unless site.uses_resource?
       site.generated_pages.sort_by!(&:name)
       site.static_files.sort_by!(&:relative_path)
     end
@@ -74,24 +71,11 @@ module Bridgetown
         end
       end
 
-      retrieve_posts(dir) unless site.uses_resource?
       retrieve_dirs(base, dir, dot_dirs)
       retrieve_pages(dir, dot_pages)
       retrieve_static_files(dir, dot_static_files)
     end
 
-    # Retrieves all the posts(posts) from the given directory
-    # and add them to the site and sort them.
-    #
-    # dir - The String representing the directory to retrieve the posts from.
-    #
-    # Returns nothing.
-    def retrieve_posts(dir)
-      return if outside_configured_directory?(dir)
-
-      post_reader.read_posts(dir)
-    end
-
     # Recursively traverse directories with the read_directories function.
     #
     # base - The String representing the site's base directory.
@@ -115,14 +99,9 @@ module Bridgetown
     #
     # Returns nothing.
     def retrieve_pages(dir, dot_pages)
-      if site.uses_resource?
-        dot_pages.each do |page_path|
-          site.collections.pages.read_resource(site.in_source_dir(dir, page_path))
-        end
-        return
+      dot_pages.each do |page_path|
+        site.collections.pages.read_resource(site.in_source_dir(dir, page_path))
       end
-
-      site.pages.concat(PageReader.new(site, dir).read(dot_pages))
     end
 
     # Retrieve all the static files from the current directory,
@@ -180,13 +159,7 @@ module Bridgetown
       !collections_dir.empty? && !dir.start_with?("/#{collections_dir}")
     end
 
-    # Create a single PostReader instance to retrieve posts from all valid
-    # directories in current site.
-    def post_reader
-      @post_reader ||= PostReader.new(site)
-    end
-
-    def read_included_excludes
+    def read_includes
       site.config.include.each do |entry|
         next if entry == ".htaccess"
 
@@ -200,12 +173,7 @@ module Bridgetown
     def read_included_file(entry_path)
       dir  = File.dirname(entry_path).sub(site.source, "")
       file = Array(File.basename(entry_path))
-      if Utils.has_yaml_header?(entry_path)
-        # TODO: does this need to get incorporated into the resource engine?
-        site.pages.concat(PageReader.new(site, dir).read(file))
-      else
-        retrieve_static_files(dir, file)
-      end
+      retrieve_static_files(dir, file)
     end
   end
 end

data/lib/bridgetown-core/readers/plugin_content_reader.rb

@@ -2,11 +2,14 @@
 
 module Bridgetown
   class PluginContentReader
-    attr_reader :site, :content_dir
+    attr_reader :site, :manifest, :content_dir
 
-    def initialize(site, plugin_content_dir)
+    # @param site [Bridgetown::Site]
+    # @param manifest [Bridgetown::Plugin::SourceManifest]
+    def initialize(site, manifest)
       @site = site
-      @content_dir = plugin_content_dir
+      @manifest = manifest
+      @content_dir = manifest.content
       @content_files = Set.new
     end
 
@@ -28,13 +31,11 @@ module Bridgetown
       dir = File.dirname(path.sub("#{content_dir}/", ""))
       name = File.basename(path)
 
-      @content_files << if Utils.has_yaml_header?(path)
-                          Bridgetown::Page.new(site, content_dir, dir, name, from_plugin: true)
+      @content_files << if Utils.has_yaml_header?(path) || Utils.has_rbfm_header?(path)
+                          site.collections.pages.read_resource(path, manifest: manifest)
                         else
                           Bridgetown::StaticFile.new(site, content_dir, "/#{dir}", name)
                         end
-
-      add_to(site.pages, Bridgetown::Page)
       add_to(site.static_files, Bridgetown::StaticFile)
     end
 

data/lib/bridgetown-core/renderer.rb

@@ -65,7 +65,7 @@ module Bridgetown
     def execute_inline_ruby!
       return unless site.config.should_execute_inline_ruby?
 
-      Bridgetown::Utils::RubyExec.search_data_for_ruby_code(document, self)
+      Bridgetown::Utils::RubyExec.search_data_for_ruby_code(document)
     end
 
     # Convert the document using the converters which match this renderer's document.
@@ -98,7 +98,6 @@ module Bridgetown
 
       while layout
         output = render_layout(output, layout)
-        add_regenerator_dependencies(layout)
 
         next unless (layout = site.layouts[layout.data["layout"]])
         break if used.include?(layout)
@@ -144,15 +143,6 @@ module Bridgetown
       end
     end
 
-    def add_regenerator_dependencies(layout)
-      return unless document.write?
-
-      site.regenerator.add_dependency(
-        site.in_source_dir(document.path),
-        layout.path
-      )
-    end
-
     def permalink_ext
       document_permalink = document.permalink
       if document_permalink &&

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

@@ -116,6 +116,8 @@ module Bridgetown
 
       def transform!
         transformer.process! unless collection.data?
+
+        self
       end
 
       def trigger_hooks(hook_name, *args)
@@ -261,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.
-      def <=>(other) # rubocop:todo Metrics/AbcSize
+      # @return [Integer] -1, 0, or +1
+      def <=>(other) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity
         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
@@ -293,6 +294,8 @@ module Bridgetown
       private
 
       def ensure_default_data
+        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]
@@ -300,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
@@ -309,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
 
@@ -332,6 +337,24 @@ module Bridgetown
         end
       end
 
+      def determine_locale
+        unless data.locale
+          data.locale = locale_from_alt_data_or_filename.presence || site.config.default_locale
+        end
+
+        if data.locale_overrides&.is_a?(Hash) && data.locale_overrides&.key?(data.locale)
+          data.merge!(data.locale_overrides[data.locale])
+        end
+      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,11 +36,10 @@ 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)
@@ -66,13 +65,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 +95,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 +107,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 +136,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/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

data/lib/bridgetown-core/ruby_template_view.rb

@@ -62,16 +62,16 @@ module Bridgetown
     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
 

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,13 +35,11 @@ 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.
@@ -58,7 +57,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 +111,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 +177,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

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

@@ -119,16 +119,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 +139,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)

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

@@ -29,7 +29,7 @@ module Bridgetown
       end
 
       def ==(other)
-        other.relative_path.match(@name_regex)
+        other.relative_path.to_s.match(@name_regex)
       end
 
       def deprecated_equality(other)
@@ -47,12 +47,7 @@ module Bridgetown
       #
       # Returns the post slug with the subdirectory (relative to _posts)
       def post_slug(other)
-        path = other.basename.split("/")[0...-1].join("/")
-        if path.nil? || path == ""
-          other.data["slug"]
-        else
-          path + "/" + other.data["slug"]
-        end
+        other.data.slug
       end
     end
 
@@ -77,14 +72,14 @@ module Bridgetown
         @context = context
         site = context.registers[:site]
 
-        site.collections.posts.docs.each do |document|
+        site.collections.posts.resources.each do |document|
           return relative_url(document) if @post == document
         end
 
         # New matching method did not match, fall back to old method
         # with deprecation warning if this matches
 
-        site.collections.posts.docs.each do |document|
+        site.collections.posts.resources.each do |document|
           next unless @post.deprecated_equality document
 
           Bridgetown::Deprecator.deprecation_message "A call to "\

data/lib/bridgetown-core/tasks/bridgetown_tasks.rake

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+namespace :frontend do
+  desc "Run frontend bundler independently"
+  task :watcher, :sidecar do |_task, args|
+    # sidecar is when the task is running alongside the start command
+    sidecar = args[:sidecar] == true
+    Bridgetown::Utils::Aux.group do
+      run_process "Frontend", :yellow, "bundle exec bridgetown frontend:dev"
+    end
+    if sidecar
+      sleep 4 # give Webpack time to boot before returning control to the start command
+    else
+      trap("INT") do
+        Bridgetown::Utils::Aux.kill_processes
+        sleep 0.5
+        exit(0)
+      end
+      loop { sleep 1000 }
+    end
+  end
+end
+
+desc "Prerequisite task which loads site and provides automation"
+task :environment do
+  class HammerActions < Thor
+    include Thor::Actions
+    include Bridgetown::Commands::Actions
+
+    def self.source_root
+      Dir.pwd
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    private
+
+    def site
+      @site ||= Bridgetown::Site.new(Bridgetown.configuration)
+    end
+  end
+
+  define_singleton_method :automation do |*args, &block|
+    @hammer ||= HammerActions.new
+    @hammer.instance_exec(*args, &block)
+  end
+
+  define_singleton_method :site do
+    @hammer ||= HammerActions.new
+    @hammer.send(:site)
+  end
+end

data/lib/bridgetown-core/url.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Public: Methods that generate a URL for a resource such as a Post or a Page.
+# Public: Methods that generate a URL for GeneratedPage.
 #
 # Examples
 #
@@ -10,6 +10,7 @@
 #   }).to_s
 #
 module Bridgetown
+  # TODO: remove this class in favor of the new Resource permalink processor
   class URL
     # options - One of :permalink or :template must be supplied.
     #           :template     - The String used as template for URL generation,