bridgetown-core 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5434399f502bf037e77a019dfda4b2deae10b6a532349ec21b32977a224ca448
-  data.tar.gz: cae6a4eb2d435bfd0e85f18320e76a90619c872ccf69f44c9ac2e13e987e1fe7
+  metadata.gz: d2c8f263d4104e1dc79885d0ecb19226a5b504518af3c43cb48c9e8da90fe971
+  data.tar.gz: b52e7a958ea715407c689c492365e44de88cd42ed0193be58f4acaed00efd58d
 SHA512:
-  metadata.gz: 5344308e24f519099a33af769a1c5dd908d1fd54f10aaec4c81f4254c9ff772787f1a2e4b9f0d488a21167cc98c6a1c526df1fd2e7d6ee4e86cf33afc4efe2bd
-  data.tar.gz: f2eedc957c8782b03e08f0834b88981e40f6539ac65899096bcfc1c1e4ed196b4046859530d5e281dee2b1455ac4e01e7b8a63dfdf29e3ad36e8725d1ed00f64
+  metadata.gz: ef77c2319ef1a31cbc9a4a00c6bbfcfc148d662f97b18b337d094f8bb473ea16ad61ccc5bcc0a16070db5beea331a48754c0ef83e2841e804f598cb6e052c420
+  data.tar.gz: 22727baee9961e123388a683eac0d03fb9db6b0dece4cdb1c5e2515d022eb12c4c7ad3f7d34116bb7548691d955febc86d7d174be9482ff6db1dcceda5153040

data/bin/bridgetown

@@ -17,31 +17,6 @@ Mercenary.program(:bridgetown) do |p|
   p.description "Bridgetown is a Webpack-aware, Ruby-powered static site generator for the modern Jamstack era"
   p.syntax "bridgetown <subcommand> [options]"
 
-  # TODO: it seems wonky to include build options in this top-level
-  # exe. Should probably remove most things here and relocated to
-  # individual comments. …in fact there are duplicate option listings
-  # if you do bridgetown build --help — ouch!
-  p.option "source", "-s", "--source [DIR]", "Source directory (defaults to src)"
-  p.option "destination", "-d", "--destination [DIR]",
-           "Destination directory (defaults to output)"
-  p.option "plugins_dir", "-p", "--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]", Array,
-           "Plugins directory (defaults to plugins)"
-  p.option "layouts_dir", "--layouts DIR", String,
-           "Layouts directory (defaults to src/_layouts)"
-  p.option "profile", "--profile", "Generate a Liquid rendering profile"
-
-  #  TODO: this is not the way to bring in extra command gems!
-  #  Bridgetown::External.require_if_present(Bridgetown::External.blessed_gems) do |g, ver_constraint|
-  #    cmd = g.split("-").last
-  #    p.command(cmd.to_sym) do |c|
-  #      c.syntax cmd
-  #      c.action do
-  #        Bridgetown.logger.abort_with "You must install the '#{g}' gem" \
-  #          " version #{ver_constraint} to use the 'bridgetown #{cmd}' command."
-  #      end
-  #    end
-  #  end
-
   Bridgetown::Command.subclasses.each { |c| c.init_with_program(p) }
 
   p.action do |args, _|

data/bridgetown-core.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.license       = "MIT"
   s.author        = "Bridgetown Team"
   s.email         = "maintainers@bridgetownrb.com"
-  s.homepage      = "https://bridgetownrb.com"
+  s.homepage      = "https://www.bridgetownrb.com"
   s.summary       = "A Webpack-aware, Ruby-based static site generator for the modern Jamstack era"
   s.description   = "Bridgetown is a Webpack-aware, Ruby-powered static site generator for the modern Jamstack era"
 
@@ -31,13 +31,16 @@ Gem::Specification.new do |s|
   s.required_ruby_version     = ">= 2.5.0"
   s.required_rubygems_version = ">= 2.7.0"
 
+  s.add_runtime_dependency("activesupport",         "~> 6.0")
   s.add_runtime_dependency("addressable",           "~> 2.4")
   s.add_runtime_dependency("colorator",             "~> 1.0")
   s.add_runtime_dependency("faraday",               "~> 1.0")
+  s.add_runtime_dependency("faraday_middleware",    "~> 1.0")
   s.add_runtime_dependency("i18n",                  "~> 1.0")
   s.add_runtime_dependency("kramdown",              "~> 2.1")
   s.add_runtime_dependency("kramdown-parser-gfm",   "~> 1.0")
   s.add_runtime_dependency("liquid",                "~> 4.0")
+  s.add_runtime_dependency("liquid-render-tag",     "~> 0.2")
   s.add_runtime_dependency("listen",                "~> 3.0")
   s.add_runtime_dependency("mercenary",             "~> 0.4.0")
   s.add_runtime_dependency("pathutil",              "~> 0.9")

data/lib/bridgetown-core.rb

@@ -29,10 +29,12 @@ require "csv"
 require "json"
 
 # 3rd party
+require "active_support/core_ext/hash/indifferent_access"
 require "pathutil"
 require "addressable/uri"
 require "safe_yaml/load"
 require "liquid"
+require "liquid-render-tag"
 require "kramdown"
 require "colorator"
 require "i18n"
@@ -49,7 +51,7 @@ module Bridgetown
   autoload :Cleaner,             "bridgetown-core/cleaner"
   autoload :Collection,          "bridgetown-core/collection"
   autoload :Configuration,       "bridgetown-core/configuration"
-  autoload :Convertible,         "bridgetown-core/convertible"
+  autoload :Convertible,         "bridgetown-core/concerns/convertible"
   autoload :Deprecator,          "bridgetown-core/deprecator"
   autoload :Document,            "bridgetown-core/document"
   autoload :EntryFilter,         "bridgetown-core/entry_filter"
@@ -65,6 +67,7 @@ module Bridgetown
   autoload :LayoutReader,        "bridgetown-core/readers/layout_reader"
   autoload :PostReader,          "bridgetown-core/readers/post_reader"
   autoload :PageReader,          "bridgetown-core/readers/page_reader"
+  autoload :PluginContentReader, "bridgetown-core/readers/plugin_content_reader"
   autoload :StaticFileReader,    "bridgetown-core/readers/static_file_reader"
   autoload :LogAdapter,          "bridgetown-core/log_adapter"
   autoload :Page,                "bridgetown-core/page"

data/lib/bridgetown-core/cleaner.rb

@@ -24,6 +24,7 @@ module Bridgetown
     def obsolete_files
       out = (existing_files - new_files - new_dirs + replaced_files).to_a
       Bridgetown::Hooks.trigger :clean, :on_obsolete, out
+      @new_files = @new_dirs = nil
       out
     end
 

data/lib/bridgetown-core/command.rb

@@ -53,11 +53,16 @@ module Bridgetown
       def add_build_options(cmd)
         cmd.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]",
                    Array, "Custom configuration file"
-        cmd.option "destination", "-d", "--destination DESTINATION",
-                   "The current folder will be generated into DESTINATION"
-        cmd.option "root_dir", "-r", "--root_dir ROOT_DIR", "The top-level root folder" \
+        cmd.option "source", "-s", "--source [DIR]",
+                   "Source directory (defaults to src)"
+        cmd.option "destination", "-d", "--destination [DIR]",
+                   "Destination directory (defaults to output)"
+        cmd.option "root_dir", "-r", "--root_dir [DIR]", "The top-level root folder" \
                     " where config files are located"
-        cmd.option "source", "-s", "--source SOURCE", "Custom source directory"
+        cmd.option "plugins_dir", "-p", "--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]", Array,
+                   "Plugins directory (defaults to plugins)"
+        cmd.option "layouts_dir", "--layouts [DIR]", String,
+                   "Layouts directory (defaults to src/_layouts)"
         cmd.option "future", "--future", "Publishes posts with a future date"
         cmd.option "limit_posts", "--limit_posts MAX_POSTS", Integer,
                    "Limits the number of posts to parse and publish"
@@ -70,6 +75,7 @@ module Bridgetown
                    "Render posts that were marked as unpublished"
         cmd.option "disable_disk_cache", "--disable-disk-cache",
                    "Disable caching to disk"
+        cmd.option "profile", "--profile", "Generate a Liquid rendering profile"
         cmd.option "quiet", "-q", "--quiet", "Silence output."
         cmd.option "verbose", "-V", "--verbose", "Print verbose output."
         cmd.option "incremental", "-I", "--incremental", "Enable incremental rebuild."

data/lib/bridgetown-core/commands/console.rb

@@ -12,8 +12,7 @@ module Bridgetown
             c.description "Invoke an IRB console with the site loaded"
             c.alias :c
 
-            c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
-                     "Custom configuration file"
+            add_build_options(c)
 
             c.action do |_, options|
               Bridgetown::Commands::Console.process(options)

data/lib/bridgetown-core/commands/doctor.rb

@@ -9,8 +9,7 @@ module Bridgetown
             c.syntax "doctor"
             c.description "Search site and print specific deprecation warnings"
 
-            c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
-                     "Custom configuration file"
+            add_build_options(c)
 
             c.action do |_, options|
               Bridgetown::Commands::Doctor.process(options)

data/lib/bridgetown-core/commands/new.rb

@@ -72,9 +72,6 @@ module Bridgetown
             #
             # Happy Bridgetowning!
 
-            # Pull in latest Liquid from Shopify with new Render tag
-            gem 'liquid', "> 4.0.3", github: "jaredcwhite/liquid"
-
             gem "bridgetown", "~> #{Bridgetown::VERSION}"
 
           RUBY

data/lib/bridgetown-core/commands/plugins.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    class Plugins < Command
+      class << self
+        def init_with_program(prog)
+          plugins_cmd = prog.command(:plugins) do |c|
+            c.syntax "plugins <subcommand>"
+            c.description "List installed plugins or access plugin content"
+
+            c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
+                     "Custom configuration file"
+
+            c.action do
+              output_supercommand_syntax(c)
+            end
+          end
+
+          plugins_cmd.command(:list) do |subcmd|
+            subcmd.syntax "list"
+            subcmd.description "List information about installed plugins"
+
+            subcmd.action do |_, options|
+              list(options)
+            end
+          end
+
+          plugins_cmd.command(:cd) do |subcmd|
+            subcmd.syntax "cd <origin/dir>"
+            subcmd.description "Open directory (content, layouts, etc.) within the plugin origin"
+
+            subcmd.action do |args, options|
+              if args.empty?
+                puts subcmd.to_s
+              else
+                cd(args, options)
+              end
+            end
+          end
+        end
+
+        def output_supercommand_syntax(supercmd)
+          puts supercmd.to_s
+        end
+
+        def list(options)
+          site = Bridgetown::Site.new(configuration_from_options(options))
+          site.reset
+          Bridgetown::Hooks.trigger :site, :pre_read, site
+
+          pm = site.plugin_manager
+
+          plugins_list = pm.class.registered_plugins.reject do |plugin|
+            plugin.to_s.end_with? "site_builder.rb"
+          end
+
+          Bridgetown.logger.info("Registered Plugins:", plugins_list.length.to_s.yellow.bold)
+
+          plugins_list.each do |plugin|
+            unless plugin.to_s.end_with? "site_builder.rb"
+              Bridgetown.logger.info("", plugin.to_s.sub(site.in_root_dir("/"), ""))
+            end
+          end
+
+          Bridgetown.logger.info("Source Manifests:", "---") unless pm.class.source_manifests.empty?
+
+          pm.class.source_manifests.each do |manifest|
+            Bridgetown.logger.info("Origin:", (manifest.origin || "n/a").to_s.green)
+            Bridgetown.logger.info("Components:", (manifest.components || "n/a").to_s.cyan)
+            Bridgetown.logger.info("Content:", (manifest.content || "n/a").to_s.cyan)
+            Bridgetown.logger.info("Layouts:", (manifest.layouts || "n/a").to_s.cyan)
+
+            Bridgetown.logger.info("", "---")
+          end
+
+          unless Bridgetown.autoload? :Builder
+            builders = Bridgetown::Builder.descendants
+            Bridgetown.logger.info("Builders:", builders.length.to_s.yellow.bold)
+
+            builders.each do |builder|
+              name = builder.respond_to?(:custom_name) ? builder.custom_name : builder.name
+              name_components = name.split("::")
+              last_name = name_components.pop
+              name_components.push last_name.magenta
+              Bridgetown.logger.info("", name_components.join("::"))
+            end
+          end
+
+          Bridgetown.logger.info("Converters:", site.converters.length.to_s.yellow.bold)
+
+          site.converters.each do |converter|
+            name = plugin_name_for(converter)
+            name_components = name.split("::")
+            last_name = name_components.pop
+            name_components.push last_name.magenta
+            Bridgetown.logger.info("", name_components.join("::"))
+          end
+
+          Bridgetown.logger.info("Generators:", site.generators.length.to_s.yellow.bold)
+
+          site.generators.each do |generator|
+            name = plugin_name_for(generator)
+            name_components = name.split("::")
+            last_name = name_components.pop
+            name_components.push last_name.magenta
+            Bridgetown.logger.info("", name_components.join("::"))
+          end
+        end
+
+        # This is super useful if you want to copy files out of plugins to override.
+        #
+        # Example:
+        #   bridgetown plugins cd AwesomePlugin/layouts
+        #   cp -r * $BRIDGETOWN_SITE/src/_layouts
+        #
+        # Now all the plugin's layouts will be in the site repo directly.
+        #
+        def cd(args, options)
+          site = Bridgetown::Site.new(configuration_from_options(options))
+
+          pm = site.plugin_manager
+
+          directive = args[0].split("/")
+          unless directive[1]
+            Bridgetown.logger.warn("Oops!", "Your command needs to be in the <origin/dir> format")
+            return
+          end
+
+          manifest = pm.class.source_manifests.find do |source_manifest|
+            source_manifest.origin.to_s == directive[0]
+          end
+
+          if manifest&.respond_to?(directive[1].downcase)
+            dir = manifest.send(directive[1].downcase)
+            Bridgetown.logger.info("Opening the #{dir.green} folder for" \
+                                   " #{manifest.origin.to_s.cyan}…")
+            Bridgetown.logger.info("Type #{"exit".yellow} when you're done to" \
+                                   " return to your site root.")
+            puts
+
+            Dir.chdir dir do
+              ENV["BRIDGETOWN_SITE"] = site.root_dir
+              if ENV["SHELL"]
+                system(ENV["SHELL"])
+              else
+                system("/bin/sh")
+              end
+            end
+
+            puts
+            Bridgetown.logger.info("Done!", "You're back in #{Dir.pwd.green}")
+          else
+            Bridgetown.logger.warn("Oops!", "I wasn't able to find the" \
+                                   " #{directive[1]} folder for #{directive[0]}")
+          end
+        end
+
+        def plugin_name_for(plugin)
+          if plugin.class.respond_to?(:custom_name)
+            plugin.class.custom_name
+          else
+            plugin.class.name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-core/{convertible.rb → concerns/convertible.rb}

@@ -42,7 +42,7 @@ module Bridgetown
                                  **Utils.merged_file_read_opts(site, opts))
         if content =~ Document::YAML_FRONT_MATTER_REGEXP
           self.content = $POSTMATCH
-          self.data = SafeYAML.load(Regexp.last_match(1))
+          self.data = SafeYAML.load(Regexp.last_match(1))&.with_indifferent_access
         end
       rescue Psych::SyntaxError => e
         Bridgetown.logger.warn "YAML Exception reading #{filename}: #{e.message}"
@@ -52,7 +52,7 @@ module Bridgetown
         raise e if site.config["strict_front_matter"]
       end
 
-      self.data ||= {}
+      self.data ||= ActiveSupport::HashWithIndifferentAccess.new
 
       validate_data! filename
       validate_permalink! filename

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

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Site::Configurable
+    # Public: Set the site's configuration. This handles side-effects caused by
+    # changing values in the configuration.
+    #
+    # config - a Bridgetown::Configuration, containing the new configuration.
+    #
+    # Returns the new configuration.
+    def config=(config)
+      @config = config.clone
+
+      # Source and destination may not be changed after the site has been created.
+      @root_dir        = File.expand_path(config["root_dir"]).freeze
+      @source          = File.expand_path(config["source"]).freeze
+      @dest            = File.expand_path(config["destination"]).freeze
+      @cache_dir       = in_root_dir(config["cache_dir"]).freeze
+
+      %w(lsi highlighter baseurl exclude include future unpublished
+         limit_posts keep_files).each do |opt|
+        send("#{opt}=", config[opt])
+      end
+
+      configure_cache
+      configure_component_paths
+      configure_include_paths
+      configure_file_read_opts
+
+      self.permalink_style = config["permalink"].to_sym
+
+      @config
+    end
+
+    # Returns the FrontmatterDefaults or creates a new FrontmatterDefaults
+    # if it doesn't already exist.
+    #
+    # Returns The FrontmatterDefaults
+    def frontmatter_defaults
+      @frontmatter_defaults ||= FrontmatterDefaults.new(self)
+    end
+
+    # Whether to perform a full rebuild without incremental regeneration
+    #
+    # Returns a Boolean: true for a full rebuild, false for normal build
+    def incremental?(override = {})
+      override["incremental"] || config["incremental"]
+    end
+
+    # Returns the publisher or creates a new publisher if it doesn't
+    # already exist.
+    #
+    # Returns The Publisher
+    def publisher
+      @publisher ||= Publisher.new(self)
+    end
+
+    # Public: Prefix a given path with the root directory.
+    #
+    # paths - (optional) path elements to a file or directory within the
+    #         root directory
+    #
+    # Returns a path which is prefixed with the root_dir directory.
+    def in_root_dir(*paths)
+      paths.reduce(root_dir) do |base, path|
+        Bridgetown.sanitized_path(base, path)
+      end
+    end
+
+    # Public: Prefix a given path with the source directory.
+    #
+    # paths - (optional) path elements to a file or directory within the
+    #         source directory
+    #
+    # Returns a path which is prefixed with the source directory.
+    def in_source_dir(*paths)
+      paths.reduce(source) do |base, path|
+        Bridgetown.sanitized_path(base, path)
+      end
+    end
+
+    # Public: Prefix a given path with the destination directory.
+    #
+    # paths - (optional) path elements to a file or directory within the
+    #         destination directory
+    #
+    # Returns a path which is prefixed with the destination directory.
+    def in_dest_dir(*paths)
+      paths.reduce(dest) do |base, path|
+        Bridgetown.sanitized_path(base, path)
+      end
+    end
+
+    # Public: Prefix a given path with the cache directory.
+    #
+    # paths - (optional) path elements to a file or directory within the
+    #         cache directory
+    #
+    # Returns a path which is prefixed with the cache directory.
+    def in_cache_dir(*paths)
+      paths.reduce(cache_dir) do |base, path|
+        Bridgetown.sanitized_path(base, path)
+      end
+    end
+
+    # Public: The full path to the directory that houses all the collections registered
+    # with the current site.
+    #
+    # Returns the source directory or the absolute path to the custom collections_dir
+    def collections_path
+      dir_str = config["collections_dir"]
+      @collections_path ||= dir_str.empty? ? source : in_source_dir(dir_str)
+    end
+
+    private
+
+    # Disable Marshaling cache to disk in Safe Mode
+    def configure_cache
+      Bridgetown::Cache.cache_dir = in_root_dir(config["cache_dir"], "Bridgetown/Cache")
+      Bridgetown::Cache.disable_disk_cache! if config["disable_disk_cache"]
+    end
+
+    def configure_component_paths
+      # Loop through plugins paths first
+      plugin_components_load_paths = Bridgetown::PluginManager.source_manifests
+        .map(&:components).compact
+
+      local_components_load_paths = config["components_dir"].yield_self do |dir|
+        dir.is_a?(Array) ? dir : [dir]
+      end
+      local_components_load_paths.map! do |dir|
+        if !!(dir =~ %r!^\.\.?\/!)
+          # allow ./dir or ../../dir type options
+          File.expand_path(dir.to_s, root_dir)
+        else
+          in_source_dir(dir.to_s)
+        end
+      end
+
+      @components_load_paths = plugin_components_load_paths + local_components_load_paths
+    end
+
+    def configure_include_paths
+      @includes_load_paths = Array(in_source_dir(config["includes_dir"].to_s))
+    end
+
+    def configure_file_read_opts
+      self.file_read_opts = {}
+      file_read_opts[:encoding] = config["encoding"] if config["encoding"]
+      self.file_read_opts = Bridgetown::Utils.merged_file_read_opts(self, {})
+    end
+  end
+end