bridgetown-core 0.18.6 → 0.20.0

data/lib/bridgetown-core/concerns/site/writable.rb

@@ -27,11 +27,21 @@ class Bridgetown::Site
     #
     # @return [void]
     def each_site_file
-      %w(pages static_files_to_write docs_to_write).each do |type|
+      %w(pages static_files_to_write docs_to_write resources_to_write).each do |type|
         send(type).each do |item|
           yield item
         end
       end
     end
+
+    def resources_cache_manifest
+      resources.each_with_object({}) do |resource, hsh|
+        next if resource.relative_url == ""
+
+        hsh[resource.relative_url] = {
+          id: resource.model.id,
+        }
+      end
+    end
   end
 end

data/lib/bridgetown-core/concerns/validatable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   module Validatable
     # FIXME: there should be ONE TRUE METHOD to read the YAML frontmatter
     # in the entire project. Both this and the equivalent Document method

data/lib/bridgetown-core/configuration.rb

@@ -23,6 +23,9 @@ module Bridgetown
       "includes_dir"         => "_includes",
       "partials_dir"         => "_partials",
       "collections"          => {},
+      "taxonomies"           => {
+        category: { key: "categories", title: "Category" }, tag: { key: "tags", title: "Tag" },
+      },
 
       # Handling Reading
       "include"              => [".htaccess", "_redirects", ".well-known"],
@@ -32,6 +35,7 @@ module Bridgetown
       "markdown_ext"         => "markdown,mkdown,mkdn,mkd,md",
       "strict_front_matter"  => false,
       "slugify_categories"   => true,
+      "slugify_mode"         => "pretty",
 
       # Filtering Content
       "limit_posts"          => 0,
@@ -56,7 +60,7 @@ module Bridgetown
       # Output Configuration
       "available_locales"    => ["en"],
       "default_locale"       => "en",
-      "permalink"            => "date",
+      "permalink"            => nil, # default is set according to content engine
       "timezone"             => nil, # use the local timezone
 
       "quiet"                => false,
@@ -95,8 +99,8 @@ module Bridgetown
       # user_config - a Hash or Configuration of overrides.
       #
       # Returns a Configuration filled with defaults.
-      def from(user_config)
-        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config])
+      def from(user_config, starting_defaults = DEFAULTS)
+        Utils.deep_merge_hashes(starting_defaults.deep_dup, Configuration[user_config])
           .merge_environment_specific_options!
           .add_default_collections
           .add_default_excludes
@@ -242,23 +246,38 @@ module Bridgetown
       self
     end
 
-    def add_default_collections
+    def add_default_collections # rubocop:todo all
       # It defaults to `{}`, so this is only if someone sets it to null manually.
-      return self if self["collections"].nil?
+      return self if self[:collections].nil?
 
       # Ensure we have a hash.
-      if self["collections"].is_a?(Array)
-        self["collections"] = self["collections"].each_with_object({}) do |collection, hash|
+      if self[:collections].is_a?(Array)
+        self[:collections] = self[:collections].each_with_object({}) do |collection, hash|
           hash[collection] = {}
         end
       end
 
-      self["collections"] = Utils.deep_merge_hashes(
-        { "posts" => {} }, self["collections"]
-      ).tap do |collections|
-        collections["posts"]["output"] = true
-        if self["permalink"]
-          collections["posts"]["permalink"] ||= style_to_permalink(self["permalink"])
+      # Setup default collections
+      self[:collections][:posts] = {} unless self[:collections][:posts]
+      self[:collections][:posts][:output] = true
+      self[:collections][:posts][:sort_direction] ||= "descending"
+
+      if self[:content_engine] == "resource"
+        self[:permalink] = "pretty" if self[:permalink].blank?
+        self[:collections][:pages] = {} unless self[:collections][:pages]
+        self[:collections][:pages][:output] = true
+        self[:collections][:pages][:permalink] ||= "/:path/"
+
+        self[:collections][:data] = {} unless self[:collections][:data]
+        self[:collections][:data][:output] = false
+
+        unless self[:collections][:posts][:permalink]
+          self[:collections][:posts][:permalink] = self[:permalink]
+        end
+      else
+        self[:permalink] = "date" if self[:permalink].blank?
+        unless self[:collections][:posts][:permalink]
+          self[:collections][:posts][:permalink] = style_to_permalink(self[:permalink])
         end
       end
 
@@ -284,9 +303,9 @@ module Bridgetown
         self["ruby_in_front_matter"]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity #
-    def style_to_permalink(permalink_style)
-      case permalink_style.to_sym
+    # Deprecated, to be removed when Bridgetown goes Resource-only
+    def style_to_permalink(permalink_style) # rubocop:todo Metrics/CyclomaticComplexity
+      case permalink_style.to_s.to_sym
       when :pretty
         "/:categories/:year/:month/:day/:title/"
       when :simple
@@ -303,7 +322,6 @@ module Bridgetown
         permalink_style.to_s
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity #
 
     def check_include_exclude
       %w(include exclude).each do |option|
@@ -314,8 +332,10 @@ module Bridgetown
               "'#{option}' should be set as an array, but was: #{self[option].inspect}."
       end
 
-      # add _pages to includes set
-      self[:include] << "_pages"
+      unless self[:include].include?("_pages") || self[:content_engine] == "resource"
+        # add _pages to includes set
+        self[:include] << "_pages"
+      end
 
       self
     end

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