bridgetown-core 0.18.5 → 0.19.3

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+TEMPLATE_PATH = File.expand_path("./netlify", __dir__)
+
+copy_file "#{TEMPLATE_PATH}/netlify.toml", "netlify.toml"
+copy_file "#{TEMPLATE_PATH}/netlify.sh", "bin/netlify.sh"

data/lib/bridgetown-core/configurations/netlify/netlify.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+# Taken from https://docs.netlify.com/configure-builds/file-based-configuration/#inject-environment-variable-values
+
+echo "Updating netlify.toml with references to our built files"
+
+CSS_PATH=`find output/_bridgetown/static/css/*.css -type f | sed -e 's,output\/,/,g'`
+JS_PATH=`find output/_bridgetown/static/js/*.js -type f | sed -e 's,output\/,/,g'`
+
+echo "CSS Path: ${CSS_PATH}"
+echo "JS Path: ${JS_PATH}"
+
+sed -i s,CSS_PATH,${CSS_PATH},g netlify.toml
+sed -i s,JS_PATH,${JS_PATH},g netlify.toml
+sed -i s,NETLIFY_IMAGES_CDN_DOMAIN,${NETLIFY_IMAGES_CDN_DOMAIN},g netlify.toml

data/lib/bridgetown-core/configurations/netlify/netlify.toml

@@ -0,0 +1,44 @@
+[build]
+  command = "yarn deploy && ./bin/netlify.sh"
+  publish = "output"
+
+[build.environment]
+  NODE_ENV = "development"
+  BRIDGETOWN_ENV = "production"
+
+[build.processing]
+  skip_processing = false
+[build.processing.css]
+  bundle = false
+  minify = true
+[build.processing.js]
+  bundle = false
+  minify = true
+[build.processing.html]
+  pretty_urls = true
+[build.processing.images]
+  compress = true
+
+[[headers]]
+  for = "*"
+  [headers.values]
+    X-Frame-Options = "DENY"
+    X-XSS-Protection = "1; mode=block"
+    X-Content-Type-Options = "nosniff"
+    Strict-Transport-Security = "max-age=15552000; includeSubDomains"
+    Referrer-Policy = "no-referrer-when-downgrade"
+    Cache-Control = "public, max-age=604800, s-max-age=604800"
+
+[[headers]]
+  for = "/"
+  [headers.values]
+    Link = [
+      "<CSS_PATH>; rel=preload; as=style",
+      "<JS_PATH>; rel=preload; as=script",
+      "<https://NETLIFY_IMAGES_CDN_DOMAIN>; rel=preconnect"
+    ]
+
+[[headers]]
+  for = "/*.(png|jpg|js|css|svg|woff|ttf|eot|ico|woff2)"
+  [headers.values]
+    Cache-Control = "public, max-age=31536000, s-max-age=31536000"

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+
+say_status :purgecss, "Installing PurgeCSS"
+
+run "yarn add -D purgecss"
+
+create_builder "purgecss_builder.rb" do
+  <<~RUBY
+    class PurgeCSS < SiteBuilder
+      def build
+        unless config[:watch] # don't run in "watch mode"
+          hook :site, :post_write do
+            purgecss_file = site.in_root_dir("purgecss.config.js")
+            unless File.exist?(purgecss_file)
+              config_js = <<~PURGE
+                module.exports = {
+                  content: ['frontend/javascript/*.js','./output/**/*.html'],
+                  output: "./output/_bridgetown/static/css"
+                }
+              PURGE
+              File.write(purgecss_file, config_js.strip)
+            end
+            manifest_file = site.in_root_dir(".bridgetown-webpack", "manifest.json")
+            if File.exist?(manifest_file)
+              manifest = JSON.parse(File.read(manifest_file))
+              css_file = manifest["main.css"].split("/").last
+              css_path = ["output", "_bridgetown", "static", "css", css_file].join("/")
+              Bridgetown.logger.info "PurgeCSS", "Purging \#{css_file}"
+              oldsize = File.stat(css_path).size / 1000
+              system "./node_modules/.bin/purgecss -c purgecss.config.js -css \#{css_path}"
+              newsize = File.stat(css_path).size / 1000
+              if newsize < oldsize
+                Bridgetown.logger.info "PurgeCSS", "Done! File size reduced from \#{oldsize}kB to \#{newsize}kB"
+              else
+                Bridgetown.logger.info "PurgeCSS", "Done. No apparent change in file size (\#{newsize}kB)."
+              end
+            end
+          end
+        end
+      end
+    end
+  RUBY
+end
+
+say_status :purgecss, "All set! Open plugins/builders/purgecss_builder.rb if you'd like to customize the PurgeCSS config."
+
+# rubocop:enable all

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+say "Installing Stimulus...", :green
+
+run("yarn add stimulus")
+
+say 'Adding Stimulus to "frontend/javascript/index.js"...', :magenta
+
+javascript_import do
+  <<~JS
+    import { Application } from "stimulus"
+    import { definitionsFromContext } from "stimulus/webpack-helpers"
+  JS
+end
+
+javascript_dir = File.join("frontend", "javascript")
+
+append_to_file(File.join(javascript_dir, "index.js")) do
+  <<~JS
+    const application = Application.start()
+    const context = require.context("./controllers", true, /\.js$/)
+    application.load(definitionsFromContext(context))
+  JS
+end
+
+controller_dir = File.join(javascript_dir, "controllers")
+
+say "Creating a `./#{controller_dir}` directory...", :magenta
+FileUtils.mkdir_p(controller_dir)
+
+say "Creating an example Stimulus Controller for you!...", :magenta
+create_file(File.join(controller_dir, "example_controller.js")) do
+  <<~JS
+    import { Controller } from "stimulus"
+    export default class extends Controller {
+      connect() {
+        console.log("Hello, Stimulus!", this.element)
+      }
+    }
+  JS
+end
+
+say "Stimulus successfully added", :green
+
+say "To start adding controllers, visit the `./frontend/javascript/controllers/` directory", :blue
+say "Make sure your controllers follow the `[name]_controller.js` convention", :blue
+say 'For further reading, check out "https://stimulus.hotwire.dev/"', :blue

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+
+packages = "swup @swup/body-class-plugin @swup/scroll-plugin @swup/fade-theme"
+say_status :swup, "Adding the following yarn packages: #{packages}"
+system("yarn add #{packages}")
+
+javascript_import do
+  <<~JS
+    import Swup from "swup"
+    import SwupBodyClassPlugin from "@swup/body-class-plugin"
+    import SwupScrollPlugin from "@swup/scroll-plugin"
+    import SwupFadeTheme from "@swup/fade-theme"
+    const swup = new Swup({
+      plugins: [
+        new SwupBodyClassPlugin(),
+        new SwupScrollPlugin(),
+        new SwupFadeTheme(),
+      ]
+    })
+  JS
+end
+
+css_index = File.exist?(File.expand_path("frontend/styles/index.scss", destination_root)) ? "frontend/styles/index.scss" : "frontend/styles/index.css"
+append_to_file css_index do
+  <<~CSS
+    .swup-transition-main {
+      transition: opacity .2s;
+    }
+  CSS
+end
+
+say_status :swup, "All done! Edit .swup-transition-main in #{css_index} if you wish to adjust the transition animation"
+say_status :swup, "Make sure you add id=\"swup\" to the primary container of your HTML layout (perhaps <main>)"
+
+# rubocop:enable all

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+
+TEMPLATE_PATH = File.expand_path("./tailwindcss", __dir__)
+
+begin
+  find_in_source_paths("postcss.config.js")
+rescue Thor::Error
+  error_message = "#{"postcss.config.js".bold} not found. Please configure postcss in your project."
+
+  @logger.error "\nError:".red, "🚨 #{error_message}"
+  @logger.info "\nFor new projects, you can use #{"bridgetown new my_project --use-postcss".bold.blue}\n"
+
+  return
+end
+
+run "yarn add -D tailwindcss"
+run "npx tailwindcss init"
+
+remove_file "postcss.config.js"
+copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js"
+
+prepend_to_file "frontend/styles/index.css",
+                File.read("#{TEMPLATE_PATH}/css_imports.css")
+
+run "bundle exec bridgetown configure purgecss"
+
+# rubocop:enable all

data/lib/bridgetown-core/configurations/tailwindcss/css_imports.css

@@ -0,0 +1,4 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+

data/lib/bridgetown-core/configurations/tailwindcss/postcss.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  plugins: {
+    'tailwindcss': {},
+    'postcss-flexbugs-fixes': {},
+    'postcss-preset-env': {
+      autoprefixer: {
+        flexbox: 'no-2009'
+      },
+      stage: 3
+    }
+  }
+}

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+say "Installing Turbo...", :green
+
+run("yarn add @hotwired/turbo")
+
+say 'Adding Turbo to "frontend/javascript/index.js"...', :magenta
+
+javascript_import do
+  <<~JS
+    import Turbo from "@hotwired/turbo"
+  JS
+end
+
+say "Turbo successfully added", :green
+say 'For further reading, check out "https://turbo.hotwire.dev/"', :blue

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

@@ -65,24 +65,17 @@ module Bridgetown
         block.nil? ? input.to_s : capture(&block)
       )
       converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
-      converter.convert(content).strip
+      result = converter.convert(content).strip
+      result.respond_to?(:html_safe) ? result.html_safe : result
     end
 
-    def capture(obj = nil, &block)
+    def capture(*args, &block)
+      return capture_in_view_component(*args, &block) if @in_view_component
+
       previous_buffer_state = @_erbout
       @_erbout = ERBBuffer.new
-
-      # For compatibility with ActionView, not used by Bridgetown normally
-      previous_ob_state = @output_buffer
-      @output_buffer = ERBBuffer.new
-
-      result = instance_exec(obj, &block)
-      if @output_buffer != ""
-        # use Rails' ActionView buffer if present
-        result = @output_buffer
-      end
+      result = yield(*args)
       @_erbout = previous_buffer_state
-      @output_buffer = previous_ob_state
 
       result.respond_to?(:html_safe) ? result.html_safe : result
     end

data/lib/bridgetown-core/filters.rb

@@ -126,8 +126,8 @@ module Bridgetown
     # @return [String] a link unreadable for bots but will be recovered on focus or mouseover
     def obfuscate_link(input, prefix = "mailto")
       link = "<a href=\"#{prefix}:#{input}\">#{input}</a>"
-      script = "<script type=\"text/javascript\">document.currentScript.insertAdjacentHTML("
-      script += "beforebegin', '#{rot47(link)}'.replace(/[!-~]/g,"
+      script = "<script type=\"text/javascript\">document.currentScript.insertAdjacentHTML('"
+      script += "beforebegin', '#{rot47(link).gsub(%r!\\!, '\\\\\\')}'.replace(/[!-~]/g,"
       script += "function(c){{var j=c.charCodeAt(0);if((j>=33)&&(j<=126)){"
       script += "return String.fromCharCode(33+((j+ 14)%94));}"
       script += "else{return String.fromCharCode(j);}}}));</script>"
@@ -375,7 +375,7 @@ module Bridgetown
       case target
       when NilClass
         return true if property.nil?
-      when Liquid::Expression::MethodLiteral # `empty` or `blank`
+      when "" # aka `empty` or `blank`
         target = target.to_s
         return true if property == target || Array(property).join == target
       else

data/lib/bridgetown-core/generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  Generator = Class.new(Plugin)
+  class Generator < Plugin
+  end
 end

data/lib/bridgetown-core/page_without_a_file.rb

@@ -7,6 +7,9 @@ module Bridgetown
   # The class instance is basically just a bare-bones entity with just
   # attributes "dir", "name", "path", "url" defined on it.
   class PageWithoutAFile < Page
+    Bridgetown.logger.warn "NOTICE: the PageWithoutAFile class is deprecated and" \
+                           " will be removed in Bridgetown 0.20."
+
     def read_yaml(*)
       @data ||= {}
     end

data/lib/bridgetown-core/plugin.rb

@@ -2,6 +2,8 @@
 
 module Bridgetown
   class Plugin
+    extend ActiveSupport::DescendantsTracker
+
     PRIORITIES = {
       low: -10,
       highest: 100,
@@ -12,32 +14,6 @@ module Bridgetown
 
     SourceManifest = Struct.new(:origin, :components, :content, :layouts, keyword_init: true)
 
-    #
-
-    def self.inherited(const)
-      catch_inheritance(const) do |const_|
-        catch_inheritance(const_)
-      end
-    end
-
-    #
-
-    def self.catch_inheritance(const)
-      const.define_singleton_method :inherited do |const_|
-        (@children ||= Set.new).add const_
-        yield const_ if block_given?
-      end
-    end
-
-    #
-
-    def self.descendants
-      @children ||= Set.new
-      out = @children.map(&:descendants)
-      out << self unless superclass == Plugin
-      Set.new(out).flatten
-    end
-
     # Get or set the priority of this plugin. When called without an
     # argument it returns the priority. When an argument is given, it will
     # set the priority.

data/lib/bridgetown-core/ruby_template_view.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "digest"
-require "active_support/core_ext/hash/keys"
 
 module Bridgetown
   class RubyTemplateView
@@ -28,7 +27,15 @@ module Bridgetown
 
     def render(item, options = {}, &block)
       if item.respond_to?(:render_in)
-        item.render_in(self, &block)
+        previous_buffer_state = @_erbout
+        @_erbout = Bridgetown::ERBBuffer.new
+
+        @in_view_component ||= defined?(::ViewComponent::Base) && item.is_a?(::ViewComponent::Base)
+        result = item.render_in(self, &block)
+        @in_view_component = false
+
+        @_erbout = previous_buffer_state
+        result
       else
         partial(item, options, &block)
       end

data/lib/bridgetown-core/utils/ruby_exec.rb

@@ -20,14 +20,14 @@ module Bridgetown
             v.each do |nested_k, nested_v|
               next unless nested_v.is_a?(Rb)
 
-              Bridgetown.logger.warn("Executing inline Ruby…", convertible.relative_path)
+              Bridgetown.logger.debug("Executing inline Ruby…", convertible.relative_path)
               convertible.data[k][nested_k] = run(nested_v, convertible, renderer)
-              Bridgetown.logger.warn("Inline Ruby completed!", convertible.relative_path)
+              Bridgetown.logger.debug("Inline Ruby completed!", convertible.relative_path)
             end
           else
-            Bridgetown.logger.warn("Executing inline Ruby…", convertible.relative_path)
+            Bridgetown.logger.debug("Executing inline Ruby…", convertible.relative_path)
             convertible.data[k] = run(v, convertible, renderer)
-            Bridgetown.logger.warn("Inline Ruby completed!", convertible.relative_path)
+            Bridgetown.logger.debug("Inline Ruby completed!", convertible.relative_path)
           end
         end
       end

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "0.18.5"
-  CODE_NAME = "Taylor Street"
+  VERSION = "0.19.3"
+  CODE_NAME = "Arbor Lodge"
 end