bridgetown-core 1.0.0.alpha10 → 1.0.0.beta3

data/lib/bridgetown-core/configurations/tailwindcss.rb

@@ -11,15 +11,22 @@ unless File.exist?("postcss.config.js")
   return
 end
 
+say_status :tailwind, "Installing Tailwind CSS..."
+
 confirm = ask "This configuration will ovewrite your existing #{"postcss.config.js".bold.white}. Would you like to continue? [Yn]"
 return unless confirm.casecmp?("Y")
 
 run "yarn add -D tailwindcss"
 run "npx tailwindcss init"
 
-copy_file in_templates_dir("postcss.config.js"), "postcss.config.js", force: true
+gsub_file "tailwind.config.js", "content: [],", <<~JS.strip
+  content: [
+      './src/**/*.{html,md,liquid,erb,serb}',
+      './frontend/javascript/**/*.js',
+    ],
+JS
 
-run "bundle exec bridgetown configure purgecss"
+copy_file in_templates_dir("postcss.config.js"), "postcss.config.js", force: true
 
 if File.exist?("frontend/styles/index.css")
   prepend_to_file "frontend/styles/index.css",
@@ -29,4 +36,26 @@ else
   say File.read(in_templates_dir("/css_imports.css"))
 end
 
+create_file "frontend/styles/jit-refresh.css", "/* #{Time.now.to_i} */"
+
+create_builder "tailwind_jit.rb" do
+  <<~RUBY
+    class Builders::TailwindJit < SiteBuilder
+      def build
+        hook :site, :pre_reload do |_, paths|
+          # Don't trigger refresh if it's a frontend-only change
+          next if paths.length == 1 && paths.first.ends_with?("manifest.json")
+    
+          # Save out a comment file to trigger Tailwind's JIT
+          refresh_file = site.in_root_dir("frontend", "styles", "jit-refresh.css")
+          File.write refresh_file, "/* \#{Time.now.to_i} */"
+          throw :halt # don't continue the build, wait for watcher rebuild
+        end
+      end
+    end
+  RUBY
+end
+
+say_status :tailwind, "Tailwind CSS is now configured."
+
 # rubocop:enable all

data/lib/bridgetown-core/configurations/turbo/turbo_transitions.js

@@ -0,0 +1,48 @@
+document.addEventListener("turbo:visit", () => {
+  let main = document.querySelector("main");
+  if (main.dataset.turboTransition == "false") return;
+
+  let [movement, scale] = ["15px", "0.99"];
+
+  if (window.matchMedia("(prefers-reduced-motion: reduce)").matches) {
+    [movement, scale] = ["7px", "1"]
+  };
+
+  main.style.transformOrigin = "50% 0%";
+  main.dataset.animatingOut = true;
+
+  main.animate(
+    [
+      { opacity: 1, transform: "translateY(0px) scale(1)" },
+      { opacity: 0, transform: `translateY(${movement}) scale(${scale})` }
+    ],
+    { duration: 300, easing: "cubic-bezier(0.45, 0, 0.55, 1)" }
+  );
+
+  Promise.all(main.getAnimations().map(animation => animation.finished)).then(() => {
+    if (main.dataset.animatingOut) main.style.visibility = "hidden"
+  })
+});
+
+document.addEventListener("turbo:load", () => {
+  let main = document.querySelector("main");
+  if (main.dataset.turboTransition == "false") return;
+
+  let [movement, scale] = ["-10px", "0.99"];
+
+  if (window.matchMedia("(prefers-reduced-motion: reduce)").matches) {
+    [movement, scale] = ["-5px", "1"]
+  };
+
+  main.style.visibility = "visible";
+  main.style.transformOrigin = "50% 0%";
+  delete main.dataset.animatingOut;
+
+  main.animate(
+    [
+      { opacity: 0, transform: `translateY(${movement}) scale(${scale})` },
+      { opacity: 1, transform: "translateY(0px) scale(1)" }
+    ],
+    { duration: 150, easing: "cubic-bezier(0.45, 0, 0.55, 1)" }
+  )
+})

data/lib/bridgetown-core/configurations/turbo.rb

@@ -1,16 +1,26 @@
 # frozen_string_literal: true
 
-say "Installing Turbo...", :green
+say_status :turbo, "Installing Turbo..."
 
 run("yarn add @hotwired/turbo")
 
-say 'Adding Turbo to "frontend/javascript/index.js"...', :magenta
+say_status :turbo, 'Adding Turbo to "frontend/javascript/index.js"...', :magenta
 
 javascript_import do
   <<~JS
-    import Turbo from "@hotwired/turbo"
+    import * as Turbo from "@hotwired/turbo"
+
+    // Uncomment the line below to add transition animations when Turbo navigates.
+    // We recommend adding <meta name="turbo-cache-control" content="no-preview" />
+    // to your HTML head if you turn on transitions. Use data-turbo-transition="false"
+    // on your <main> element for pages where you don't want any transition animation.
+    //
+    // import "./turbo_transitions.js"
   JS
 end
 
-say "Turbo successfully added", :green
-say 'For further reading, check out "https://turbo.hotwired.dev/"', :blue
+copy_file in_templates_dir("turbo_transitions.js"), "frontend/javascript/turbo_transitions.js"
+
+say_status :turbo, "Turbo successfully added!", :magenta
+say_status :turbo, "Take a look in your index.js file for optional animation setup.", :blue
+say_status :turbo, 'For further reading, check out "https://turbo.hotwired.dev/"', :blue

data/lib/bridgetown-core/configurations/vercel/vercel.json

@@ -0,0 +1,45 @@
+{
+  "cleanUrls": true,
+  "trailingSlash": false,
+  "redirects": [],
+  "headers": [
+    {
+      "source": "/(.*)",
+      "headers": [
+        {
+          "key": "X-Content-Type-Options",
+          "value": "nosniff"
+        },
+        {
+          "key": "X-Frame-Options",
+          "value": "DENY"
+        },
+        {
+          "key": "X-XSS-Protection",
+          "value": "1; mode=block"
+        },
+        {
+          "key": "Referrer-Policy",
+          "value": "strict-origin"
+        },
+        {
+          "key": "Permissions-Policy",
+          "value": "geolocation=(self), microphone=()"
+        }
+      ]
+    },
+    {
+      "source": "/feed.xml",
+      "headers": [
+        {
+          "key": "Content-Type",
+          "value": "application/rss+xml"
+        },
+        {
+          "key": "Cache-Control",
+          "value": "public, max-age=3600"
+        }
+      ]
+    }
+  ]
+}

data/lib/bridgetown-core/configurations/vercel/vercel_url.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Builders::VercelUrl < SiteBuilder
+  def build
+    hook :site, :pre_render do |site|
+      next unless ENV["VERCEL_URL"] && ENV["VERCEL_ENV"] != "production"
+
+      Bridgetown.logger.info("Subbing Vercel URL")
+      site.config.update(url: "https://#{ENV["VERCEL_URL"]}")
+    end
+  end
+end

data/lib/bridgetown-core/configurations/vercel.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+copy_file in_templates_dir("vercel.json"), "vercel.json"
+copy_file in_templates_dir("vercel_url.rb"), "plugins/builders/vercel_url.rb"

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

@@ -83,16 +83,14 @@ module Bridgetown
       options.merge!(options[:locals]) if options[:locals]
       options[:content] = yield if block_given?
 
-      partial_segments = partial_name.split("/")
-      partial_segments.last.sub!(%r!^!, "_")
-      partial_name = partial_segments.join("/")
-
-      Tilt::ErubiTemplate.new(
-        site.in_source_dir(site.config[:partials_dir], "#{partial_name}.erb"),
+      partial_path = _partial_path(partial_name, "erb")
+      tmpl = site.tmp_cache["partial-tmpl:#{partial_path}"] ||= Tilt::ErubiTemplate.new(
+        partial_path,
         outvar: "@_erbout",
         bufval: "Bridgetown::OutputBuffer.new",
         engine_class: ERBEngine
-      ).render(self, options)
+      )
+      tmpl.render(self, options)
     end
   end
 
@@ -115,7 +113,7 @@ module Bridgetown
         erb_view = Bridgetown::ERBView.new(convertible)
 
         erb_renderer = Tilt::ErubiTemplate.new(
-          convertible.relative_path,
+          convertible.path,
           line_start(convertible),
           outvar: "@_erbout",
           bufval: "Bridgetown::OutputBuffer.new",

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

@@ -9,7 +9,7 @@ module Bridgetown
       def convert(content, convertible)
         erb_view = Bridgetown::ERBView.new(convertible)
         erb_view.instance_eval(
-          content, convertible.relative_path.to_s, line_start(convertible)
+          content, convertible.path.to_s, line_start(convertible)
         ).to_s
       end
     end

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

@@ -11,13 +11,10 @@ module Bridgetown
       options.merge!(options[:locals]) if options[:locals]
       options[:content] = capture(&block) if block
 
-      partial_segments = partial_name.split("/")
-      partial_segments.last.sub!(%r!^!, "_")
-      partial_name = partial_segments.join("/")
-
-      Tilt::SerbeaTemplate.new(
-        site.in_source_dir(site.config[:partials_dir], "#{partial_name}.serb")
-      ).render(self, options)
+      partial_path = _partial_path(partial_name, "serb")
+      tmpl = site.tmp_cache["partial-tmpl:#{partial_path}"] ||=
+        Tilt::SerbeaTemplate.new(partial_path)
+      tmpl.render(self, options)
     end
   end
 
@@ -39,7 +36,7 @@ module Bridgetown
 
         serb_view = Bridgetown::SerbeaView.new(convertible)
 
-        serb_renderer = Tilt::SerbeaTemplate.new(convertible.relative_path) { content }
+        serb_renderer = Tilt::SerbeaTemplate.new(convertible.path) { content }
 
         if convertible.is_a?(Bridgetown::Layout)
           serb_renderer.render(serb_view) do

data/lib/bridgetown-core/drops/drop.rb

@@ -110,7 +110,7 @@ module Bridgetown
       # underlying data hashes and performs a set union to ensure a list
       # of unique keys for the Drop.
       #
-      # Returns an Array of unique keys for content for the Drop.
+      # @return [Array<String>]
       def keys
         (content_methods |
           mutations.keys |

data/lib/bridgetown-core/drops/resource_drop.rb

@@ -6,7 +6,7 @@ module Bridgetown
       extend Forwardable
 
       NESTED_OBJECT_FIELD_BLACKLIST = %w(
-        content output excerpt next previous
+        content output excerpt next previous next_resource previous_resource
       ).freeze
 
       mutable false
@@ -44,13 +44,15 @@ module Bridgetown
         cmp
       end
 
-      def previous
-        @previous ||= @obj.previous_resource.to_liquid
+      def next_resource
+        @next ||= @obj.next_resource.to_liquid
       end
+      alias_method :next, :next_resource
 
-      def next
-        @next ||= @obj.next_resource.to_liquid
+      def previous_resource
+        @previous ||= @obj.previous_resource.to_liquid
       end
+      alias_method :previous, :previous_resource
 
       # Generate a Hash for use in generating JSON.
       # This is useful if fields need to be cleared before the JSON can generate.
@@ -79,6 +81,27 @@ module Bridgetown
           result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
         end
       end
+
+      # Generates a list of keys with user content as their values.
+      # This gathers up the Drop methods and keys of the mutations and
+      # underlying data hashes and performs a set union to ensure a list
+      # of unique keys for the Drop.
+      #
+      # @return [Array<String>]
+      def keys
+        keys_to_remove = %w[next_resource previous_resource]
+        (content_methods |
+          mutations.keys |
+          fallback_data.keys).flatten.reject do |key|
+          keys_to_remove.include?(key)
+        end
+      end
+
+      # Inspect the drop's keys and values through a JSON representation
+      # of its keys and values.
+      def inspect
+        JSON.pretty_generate hash_for_json
+      end
     end
   end
 end

data/lib/bridgetown-core/errors.rb

@@ -14,5 +14,26 @@ module Bridgetown
     PostURLError                = Class.new(FatalException)
     InvalidURLError             = Class.new(FatalException)
     InvalidConfigurationError   = Class.new(FatalException)
+
+    def self.print_build_error(exc, trace: false)
+      Bridgetown.logger.error "Exception raised:", exc.class.to_s.bold
+      Bridgetown.logger.error exc.message.reset_ansi
+
+      trace_args = ["-t", "--trace"]
+      print_trace_msg = true
+      traces = if trace || ARGV.find { |arg| trace_args.include?(arg) }
+                 print_trace_msg = false
+                 exc.backtrace
+               else
+                 exc.backtrace[0..4]
+               end
+      traces.each_with_index do |backtrace_line, index|
+        Bridgetown.logger.error "#{index + 1}:", backtrace_line.reset_ansi
+      end
+
+      return unless print_trace_msg
+
+      Bridgetown.logger.warn "Backtrace:", "Use the --trace option for complete information."
+    end
   end
 end

data/lib/bridgetown-core/generated_page.rb

@@ -5,6 +5,7 @@ module Bridgetown
     include LayoutPlaceable
     include LiquidRenderable
     include Publishable
+    include Transformable
 
     attr_writer :dir
     attr_accessor :site, :paginator, :name, :ext, :basename, :data, :content, :output
@@ -12,7 +13,7 @@ module Bridgetown
     alias_method :extname, :ext
 
     # A set of extensions that are considered HTML or HTML-like so we
-    # should not alter them,  this includes .xhtml through XHTM5.
+    # should not alter them
 
     HTML_EXTENSIONS = %w(
       .html
@@ -54,11 +55,11 @@ module Bridgetown
       output || content || ""
     end
 
-    # Accessor for data properties by Liquid.
+    # Accessor for data properties by Liquid
     #
-    # property - The String name of the property to retrieve.
+    # @param property [String] name of the property to retrieve
     #
-    # Returns the String value or nil if the property isn't included.
+    # @return [Object]
     def [](property)
       data[property]
     end
@@ -67,7 +68,7 @@ module Bridgetown
     # upon generation. This is derived from the permalink or, if
     # permalink is absent, will be '/'
     #
-    # Returns the String destination directory.
+    # @return [String]
     def dir
       if url.end_with?("/")
         url
@@ -78,6 +79,8 @@ module Bridgetown
     end
 
     # Liquid representation of current page
+    #
+    # @return [Bridgetown::Drops::GeneratedPageDrop]
     def to_liquid
       @liquid_drop ||= Drops::GeneratedPageDrop.new(self)
     end
@@ -90,7 +93,7 @@ module Bridgetown
 
     # The template of the permalink.
     #
-    # Returns the template String.
+    # @return [String]
     def template
       if !html?
         "/:path/:basename:output_ext"
@@ -103,7 +106,7 @@ module Bridgetown
 
     # The generated relative url of this page. e.g. /about.html.
     #
-    # Returns the String url.
+    # @return [String]
     def url
       @url ||= URL.new(
         template: template,
@@ -123,6 +126,22 @@ module Bridgetown
       }
     end
 
+    # Layout associated with this resource
+    # This will output a warning if the layout can't be found.
+    #
+    # @return [Bridgetown::Layout]
+    def layout
+      return @layout if @layout
+      return if no_layout?
+
+      @layout = site.layouts[data.layout].tap do |layout|
+        unless layout
+          Bridgetown.logger.warn "Generated Page:", "Layout '#{data.layout}' " \
+                                                    "requested via #{relative_path} does not exist."
+        end
+      end
+    end
+
     # Overide this in subclasses for custom initialization behavior
     def process
       # no-op by default
@@ -139,21 +158,68 @@ module Bridgetown
       @relative_path ||= File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).delete_prefix("/")
     end
 
-    # FIXME: spinning up a new Renderer object just to get an extension
-    # seems excessive
-    #
     # The output extension of the page.
     #
-    # Returns the output extension
+    # @return [String]
     def output_ext
-      @output_ext ||= Bridgetown::Renderer.new(site, self).output_ext
+      @output_ext ||= (permalink_ext || converter_output_ext)
+    end
+
+    def permalink_ext
+      page_permalink = permalink
+      if page_permalink &&
+          !page_permalink.end_with?("/")
+        permalink_ext = File.extname(page_permalink)
+        permalink_ext unless permalink_ext.empty?
+      end
+    end
+
+    def converter_output_ext
+      if output_exts.size == 1
+        output_exts.last
+      else
+        output_exts[-2]
+      end
+    end
+
+    def output_exts
+      @output_exts ||= converters.filter_map do |c|
+        c.output_ext(extname)
+      end
+    end
+
+    # @return [Array<Bridgetown::Converter>]
+    def converters
+      @converters ||= site.matched_converters_for_convertible(self)
+    end
+
+    def transform!
+      Bridgetown.logger.debug "Transforming:", relative_path
+
+      trigger_hooks :pre_render
+      self.content = transform_content(self)
+      place_in_layout? ? place_into_layouts : self.output = content.dup
+      trigger_hooks :post_render
+
+      self
+    end
+
+    def place_into_layouts
+      Bridgetown.logger.debug "Placing in Layouts:", relative_path
+      rendered_output = content.dup
+
+      site.validated_layouts_for(self, data.layout).each do |layout|
+        rendered_output = transform_with_layout(layout, rendered_output, self)
+      end
+
+      self.output = rendered_output
     end
 
     # Obtain destination path.
     #
-    # dest - The String path to the destination dir.
+    # @param dest [String] path to the destination dir
     #
-    # Returns the destination file path String.
+    # @return [String]
     def destination(dest)
       path = site.in_dest_dir(dest, URL.unescape_path(url))
       path = File.join(path, "index") if url.end_with?("/")
@@ -163,9 +229,7 @@ module Bridgetown
 
     # Write the generated page file to the destination directory.
     #
-    # dest - The String path to the destination dir.
-    #
-    # Returns nothing.
+    # @param dest [String] path to the destination dir
     def write(dest)
       path = destination(dest)
       FileUtils.mkdir_p(File.dirname(path))

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

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 # Handles Generated Pages
-Bridgetown::Hooks.register :generated_pages, :post_init, reloadable: false do |page|
+Bridgetown::Hooks.register_one :generated_pages, :post_init, reloadable: false do |page|
   if page.class != Bridgetown::PrototypePage && page.data["prototype"].is_a?(Hash)
     Bridgetown::PrototypeGenerator.add_matching_template(page)
   end
 end
 
 # Handles Resources
-Bridgetown::Hooks.register :resources, :post_read, reloadable: false do |resource|
+Bridgetown::Hooks.register_one :resources, :post_read, reloadable: false do |resource|
   if resource.data["prototype"].is_a?(Hash)
     Bridgetown::PrototypeGenerator.add_matching_template(resource)
   end
 end
 
 # Ensure sites clear out templates before rebuild
-Bridgetown::Hooks.register :site, :after_reset, reloadable: false do |_site|
+Bridgetown::Hooks.register_one :site, :after_reset, reloadable: false do |_site|
   Bridgetown::PrototypeGenerator.matching_templates.clear
 end
 

data/lib/bridgetown-core/helpers.rb

@@ -22,9 +22,10 @@ module Bridgetown
         @context = Context.new({ site: site })
       end
 
-      def webpack_path(asset_type)
-        Bridgetown::Utils.parse_webpack_manifest_file(site, asset_type.to_s)
+      def asset_path(asset_type)
+        Bridgetown::Utils.parse_frontend_manifest_file(site, asset_type.to_s)
       end
+      alias_method :webpack_path, :asset_path
 
       def live_reload_dev_js
         Bridgetown::Utils.live_reload_js(site)