bridgetown-core 0.19.1 → 0.21.0.beta2

data/lib/bridgetown-core/configurations/bt-postcss.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+
+TEMPLATE_PATH = File.expand_path("./bt-postcss", __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
+
+plugins = %w(postcss-easy-import postcss-mixins postcss-color-function cssnano)
+
+say "Adding the following PostCSS plugins: #{plugins.join(' | ')}", :green
+run "yarn add -D #{plugins.join(' ')}"
+
+remove_file "postcss.config.js"
+copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js"
+
+# rubocop:enable all

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

@@ -0,0 +1,21 @@
+module.exports = {
+  plugins: {
+    'postcss-easy-import': {},
+    'postcss-mixins': {},
+    'postcss-color-function': {},
+    'postcss-flexbugs-fixes': {},
+    'postcss-preset-env': {
+      autoprefixer: {
+        flexbox: 'no-2009'
+      },
+      stage: 2,
+      features: {
+        'nesting-rules': true,
+        'custom-media-queries': true
+      },
+    },
+    'cssnano' : {
+      preset: 'default'
+    }
+  }
+}

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+
+say_status :minitesting, "Adding test gems, package.json scripts, and examples"
+
+append_to_file "Gemfile" do
+  <<~GEMS
+    \n
+    group :test, optional: true do
+      gem "nokogiri"
+      gem "minitest"
+      gem "minitest-profile"
+      gem "minitest-reporters"
+      gem "shoulda"
+      gem "rails-dom-testing"
+    end
+  GEMS
+end
+
+new_scripts = '    "test": "BRIDGETOWN_ENV=test yarn build",'
+new_scripts += "\n" + '    "deploy:test": "bundle install --with test && yarn deploy"'
+package_json = "package.json"
+script_regex = %r{"scripts": \{(\s+".*,?)*}
+inject_into_file(package_json, ",\n" + new_scripts, after: script_regex)
+
+create_file "test/helper.rb" do
+  <<~RUBY
+    require "nokogiri"
+    require "minitest/autorun"
+    require "minitest/reporters"
+    require "minitest/profile"
+    require "shoulda"
+    require "rails-dom-testing"
+    # Report with color.
+    Minitest::Reporters.use! [
+      Minitest::Reporters::DefaultReporter.new(
+        color: true
+      ),
+    ]
+    Minitest::Test.class_eval do
+      include Rails::Dom::Testing::Assertions
+      def site
+        @site ||= Bridgetown.sites.first
+      end
+      def nokogiri(input)
+        input.respond_to?(:output) ? Nokogiri::HTML(input.output) : Nokogiri::HTML(input)
+      end
+      def document_root(root)
+        @document_root = root.is_a?(Nokogiri::XML::Document) ? root : nokogiri(root)
+      end
+      def document_root_element
+        if @document_root.nil?
+          raise "Call `document_root' with a Nokogiri document before testing your assertions"
+        end
+        @document_root
+      end
+    end
+  RUBY
+end
+
+create_file "test/test_homepage.rb" do
+  <<~RUBY
+    require_relative "./helper"
+    class TestHomepage < Minitest::Test
+      context "homepage" do
+        setup do
+          page = site.pages.find { |doc| doc.url == "/" }
+          document_root page
+        end
+        should "exist" do
+          assert_select "body"
+        end
+      end
+    end
+  RUBY
+end
+
+create_file "plugins/test_output.rb" do
+  <<~RUBY
+    unless Bridgetown.environment == "development"
+      Bridgetown::Hooks.register :site, :post_write do
+        # Load test suite to run on exit
+        require "nokogiri"
+        Dir["test/**/*.rb"].each { |file| require_relative("../\#{file}") }
+      rescue LoadError
+        Bridgetown.logger.warn "Testing:", "To run tests, you must first run \`bundle install --with test\`"
+      end
+    end
+  RUBY
+end
+
+say_status :minitesting, "All set! To get started, look at test/test_homepage.rb and then run \`yarn test\`"
+
+# rubocop:enable all

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/converter.rb

@@ -23,6 +23,16 @@ module Bridgetown
       @config = config
     end
 
+    # Logic to do the content conversion.
+    #
+    # @param content [String] content of file (without front matter).
+    # @param convertible [Bridgetown::Document, Bridgetown::Layout, Bridgetown::Resource::Base]
+    #
+    # @return [String] the converted content.
+    def convert(content, convertible = nil) # rubocop:disable Lint/UnusedMethodArgument
+      content
+    end
+
     # Does the given extension match this converter's list of acceptable extensions?
     #
     # @param [String] ext
@@ -42,5 +52,18 @@ module Bridgetown
     def output_ext(_ext)
       ".html"
     end
+
+    def line_start(convertible)
+      if convertible.is_a?(Bridgetown::Resource::Base) &&
+          convertible.model.origin.respond_to?(:front_matter_line_count)
+        convertible.model.origin.front_matter_line_count + 4
+      else
+        1
+      end
+    end
+
+    def inspect
+      "#<#{self.class}#{self.class.extname_list ? " #{self.class.extname_list.join(", ")}" : nil}>"
+    end
   end
 end