bridgetown-core 0.19.0 → 0.21.0.beta1

data/lib/bridgetown-core/site.rb

@@ -26,6 +26,10 @@ module Bridgetown
     # @return [Array<Page>]
     attr_accessor :pages
 
+    # NOTE: Eventually pages will be deprecated once the Resource content engine
+    # is default
+    alias_method :generated_pages, :pages
+
     attr_accessor :exclude, :include, :lsi, :highlighter, :permalink_style,
                   :time, :future, :unpublished, :limit_posts,
                   :keep_files, :baseurl, :data, :file_read_opts,
@@ -46,7 +50,7 @@ module Bridgetown
 
       ensure_not_in_dest
 
-      Bridgetown.sites << self
+      Bridgetown::Current.site = self
       Bridgetown::Hooks.trigger :site, :after_init, self
 
       reset   # Processable
@@ -64,5 +68,9 @@ module Bridgetown
         end
       end
     end
+
+    def inspect
+      "#<Bridgetown::Site #{metadata.inspect.delete_prefix("{").delete_suffix("}")}>"
+    end
   end
 end

data/lib/bridgetown-core/static_file.rb

@@ -4,7 +4,7 @@ module Bridgetown
   class StaticFile
     extend Forwardable
 
-    attr_reader :relative_path, :extname, :name, :data
+    attr_reader :relative_path, :extname, :name, :data, :site, :collection
 
     def_delegator :to_liquid, :to_json, :to_json
 
@@ -25,8 +25,7 @@ module Bridgetown
     # base - The String path to the <source>.
     # dir  - The String path between <source> and the file.
     # name - The String filename of the file.
-    # rubocop: disable Metrics/ParameterLists
-    def initialize(site, base, dir, name, collection = nil)
+    def initialize(site, base, dir, name, collection = nil) # rubocop:disable Metrics/ParameterLists
       @site = site
       @base = base
       @dir  = dir
@@ -34,9 +33,15 @@ module Bridgetown
       @collection = collection
       @relative_path = File.join(*[@dir, @name].compact)
       @extname = File.extname(@name)
-      @data = @site.frontmatter_defaults.all(relative_path, type)
+      @data = @site.frontmatter_defaults.all(relative_path, type).with_dot_access
+      if site.uses_resource? && !data.permalink
+        data.permalink = if collection && !collection.builtin?
+                           "/:collection/:path.*"
+                         else
+                           "/:path.*"
+                         end
+      end
     end
-    # rubocop: enable Metrics/ParameterLists
 
     # Returns source file path.
     def path
@@ -51,8 +56,11 @@ module Bridgetown
     #
     # Returns destination file path.
     def destination(dest)
-      dest = @site.in_dest_dir(dest)
-      @site.in_dest_dir(dest, Bridgetown::URL.unescape_path(url))
+      dest = site.in_dest_dir(dest)
+      dest_url = url
+      dest_url = dest_url.delete_prefix(site.baseurl) if site.uses_resource? &&
+        site.baseurl.present? && collection
+      site.in_dest_dir(dest, Bridgetown::URL.unescape_path(dest_url))
     end
 
     def destination_rel_dir
@@ -118,6 +126,15 @@ module Bridgetown
       @basename ||= File.basename(name, extname).gsub(%r!\.*\z!, "")
     end
 
+    def relative_path_basename_without_prefix
+      return_path = Pathname.new("")
+      Pathname.new(cleaned_relative_path).each_filename do |filename|
+        return_path += filename unless filename.starts_with?("_")
+      end
+
+      (return_path.dirname + return_path.basename(".*")).to_s
+    end
+
     def placeholders
       {
         collection: @collection.label,
@@ -154,15 +171,21 @@ module Bridgetown
     # be overriden in the collection's configuration in bridgetown.config.yml.
     def url
       @url ||= begin
-        base = if @collection.nil? || @collection.label == "posts"
+        newly_processed = false
+        special_posts_case = @collection&.label == "posts" &&
+          site.config.content_engine != "resource"
+        base = if @collection.nil? || special_posts_case
                  cleaned_relative_path
+               elsif site.uses_resource?
+                 newly_processed = true
+                 Bridgetown::Resource::PermalinkProcessor.new(self).transform
                else
                  Bridgetown::URL.new(
                    template: @collection.url_template,
                    placeholders: placeholders
                  )
                end.to_s.chomp("/")
-        base << extname
+        newly_processed ? base : "#{base}#{extname}"
       end
     end
 
@@ -174,7 +197,7 @@ module Bridgetown
     # Returns the front matter defaults defined for the file's URL and/or type
     # as defined in bridgetown.config.yml.
     def defaults
-      @defaults ||= @site.frontmatter_defaults.all url, type
+      @defaults ||= site.frontmatter_defaults.all url, type
     end
 
     # Returns a debug string on inspecting the static file.

data/lib/bridgetown-core/url.rb

@@ -129,6 +129,7 @@ module Bridgetown
     #
     # Returns the escaped path.
     def self.escape_path(path)
+      path = path.to_s
       return path if path.empty? || %r!^[a-zA-Z0-9./-]+$!.match?(path)
 
       # Because URI.escape doesn't escape "?", "[" and "]" by default,

data/lib/bridgetown-core/utils.rb

@@ -4,12 +4,10 @@ module Bridgetown
   module Utils
     extend self
     autoload :Ansi, "bridgetown-core/utils/ansi"
-    autoload :Exec, "bridgetown-core/utils/exec"
-    autoload :Internet, "bridgetown-core/utils/internet"
     autoload :RubyExec, "bridgetown-core/utils/ruby_exec"
+    autoload :RubyFrontMatterDSL, "bridgetown-core/utils/ruby_front_matter"
     autoload :Platforms, "bridgetown-core/utils/platforms"
     autoload :ThreadEvent, "bridgetown-core/utils/thread_event"
-    autoload :WinTZ, "bridgetown-core/utils/win_tz"
 
     # Constants for use in #slugify
     SLUGIFY_MODES = %w(raw default pretty simple ascii latin).freeze
@@ -74,38 +72,32 @@ module Bridgetown
       end
     end
 
-    # Read array from the supplied hash favouring the singular key
-    # and then the plural key, and handling any nil entries.
+    # Read array from the supplied hash, merging the singular key with the
+    # plural key as needing, and handling any nil or duplicate entries.
     #
-    # hash - the hash to read from
-    # singular_key - the singular key
-    # plural_key - the plural key
-    #
-    # Returns an array
-    def pluralized_array_from_hash(hash, singular_key, plural_key)
-      array = []
-      value = value_from_singular_key(hash, singular_key)
-      value ||= value_from_plural_key(hash, plural_key)
+    # @param hsh [Hash] the hash to read from
+    # @param singular_key [Symbol] the singular key
+    # @param plural_key [Symbol] the plural key
+    # @return [Array]
+    def pluralized_array_from_hash(hsh, singular_key, plural_key)
+      array = [
+        hsh[singular_key],
+        value_from_plural_key(hsh, plural_key),
+      ]
 
-      array << value
       array.flatten!
       array.compact!
+      array.uniq!
       array
     end
 
-    def value_from_singular_key(hash, key)
-      hash[key] if hash.key?(key) || (hash.default_proc && hash[key])
-    end
-
-    def value_from_plural_key(hash, key)
-      if hash.key?(key) || (hash.default_proc && hash[key])
-        val = hash[key]
-        case val
-        when String
-          val.split
-        when Array
-          val.compact
-        end
+    def value_from_plural_key(hsh, key)
+      val = hsh[key]
+      case val
+      when String
+        val.split
+      when Array
+        val.compact
       end
     end
 
@@ -124,17 +116,23 @@ module Bridgetown
 
     # Determines whether a given file has
     #
-    # Returns true if the YAML front matter is present.
+    # @return [Boolean] if the YAML front matter is present.
     # rubocop: disable Naming/PredicateName
     def has_yaml_header?(file)
-      File.open(file, "rb", &:readline).match? %r!\A---\s*\r?\n!
+      File.open(file, "rb", &:readline).match? Bridgetown::FrontMatterImporter::YAML_HEADER
+    rescue EOFError
+      false
+    end
+
+    def has_rbfm_header?(file)
+      File.open(file, "rb", &:readline).match? Bridgetown::FrontMatterImporter::RUBY_HEADER
     rescue EOFError
       false
     end
 
     # Determine whether the given content string contains Liquid Tags or Vaiables
     #
-    # Returns true is the string contains sequences of `{%` or `{{`
+    # @return [Boolean] if the string contains sequences of `{%` or `{{`
     def has_liquid_construct?(content)
       return false if content.nil? || content.empty?
 
@@ -207,7 +205,7 @@ module Bridgetown
       slug.gsub!(%r!^\-|\-$!i, "")
 
       slug.downcase! unless cased
-      Bridgetown.logger.warn("Warning:", "Empty `slug` generated for '#{string}'.") if slug.empty?
+
       slug
     end
 
@@ -347,7 +345,7 @@ module Bridgetown
 
     # Return an asset path based on the Webpack manifest file
     # @param site [Bridgetown::Site] The current site object
-    # @param asset_type [String] js or css
+    # @param asset_type [String] js or css, or filename in manifest
     #
     # @return [String] Returns "MISSING_WEBPACK_MANIFEST" if the manifest
     # file isnt found
@@ -363,21 +361,30 @@ module Bridgetown
       manifest = JSON.parse(File.read(manifest_file))
 
       known_assets = %w(js css)
+      asset_path = nil
       if known_assets.include?(asset_type)
         asset_path = manifest["main.#{asset_type}"]
-
         log_webpack_asset_error(asset_type) && return if asset_path.nil?
-
-        asset_path = asset_path.split("/").last
-        return [static_frontend_path(site), asset_type, asset_path].join("/")
+      else
+        asset_path = manifest.find do |item, _|
+          item.sub(%r{^../(frontend/|src/)?}, "") == asset_type
+        end&.last
       end
 
-      Bridgetown.logger.error("Unknown Webpack asset type", asset_type)
-      nil
+      if asset_path
+        static_frontend_path(site, ["js", asset_path])
+      else
+        Bridgetown.logger.error("Unknown Webpack asset type", asset_type)
+        nil
+      end
     end
 
-    def static_frontend_path(site)
-      path_parts = [site.config["baseurl"].to_s.chomp("/"), "_bridgetown/static"]
+    def static_frontend_path(site, additional_parts = [])
+      path_parts = [
+        site.config["baseurl"].to_s.gsub(%r(^/|/$), ""),
+        "_bridgetown/static",
+        *additional_parts,
+      ]
       path_parts[0] = "/#{path_parts[0]}" unless path_parts[0].empty?
       Addressable::URI.parse(path_parts.join("/")).normalize.to_s
     end

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

@@ -2,6 +2,7 @@
 
 module Bridgetown
   module Utils
+    # TODO: deprecate, we should try not to have any platform-specific code
     module Platforms
       extend self
 

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

@@ -5,8 +5,8 @@ module Bridgetown
     module RubyExec
       extend self
 
-      # rubocop:disable Metrics/AbcSize
-      def search_data_for_ruby_code(convertible, renderer)
+      # TODO: Deprecate storing Ruby code in YAML, Rb, etc. and just use native Ruby Front Matter
+      def search_data_for_ruby_code(convertible, renderer) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         return if convertible.data.empty?
 
         # Iterate using `keys` here so inline Ruby script can add new data keys
@@ -14,24 +14,21 @@ module Bridgetown
         data_keys = convertible.data.keys
         data_keys.each do |k|
           v = convertible.data[k]
-          next unless v.is_a?(Rb) || v.is_a?(Hash)
+          next unless v.is_a?(Rb) || v.is_a?(Hash) || v.is_a?(Proc)
 
-          if v.is_a?(Hash)
+          if v.is_a?(Proc)
+            convertible.data[k] = convertible.instance_exec(&v)
+          elsif v.is_a?(Hash)
             v.each do |nested_k, nested_v|
               next unless nested_v.is_a?(Rb)
 
-              Bridgetown.logger.debug("Executing inline Ruby…", convertible.relative_path)
               convertible.data[k][nested_k] = run(nested_v, convertible, renderer)
-              Bridgetown.logger.debug("Inline Ruby completed!", convertible.relative_path)
             end
           else
-            Bridgetown.logger.debug("Executing inline Ruby…", convertible.relative_path)
             convertible.data[k] = run(v, convertible, renderer)
-            Bridgetown.logger.debug("Inline Ruby completed!", convertible.relative_path)
           end
         end
       end
-      # rubocop:enable Metrics/AbcSize
 
       # Sets up a new context in which to eval Ruby coming from front matter.
       #

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Utils
+    module RubyFrontMatterDSL
+      def front_matter(&block)
+        RubyFrontMatter.new.tap { |fm| fm.instance_exec(&block) }
+      end
+    end
+
+    class RubyFrontMatter
+      def initialize
+        @data = {}
+      end
+
+      def method_missing(key, value) # rubocop:disable Style/MissingRespondToMissing
+        return super if respond_to?(key)
+
+        set(key, value)
+      end
+
+      def each(&block)
+        @data.each(&block)
+      end
+
+      def get(key)
+        @data[key]
+      end
+
+      def set(key, value)
+        @data[key] = value
+      end
+
+      def to_h
+        @data
+      end
+    end
+  end
+end

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "0.19.0"
-  CODE_NAME = "Arbor Lodge"
+  VERSION = "0.21.0.beta1"
+  CODE_NAME = "Broughton Beach"
 end

data/lib/bridgetown-core/watcher.rb

@@ -140,7 +140,7 @@ module Bridgetown
         if options[:trace]
           Bridgetown.logger.info e.backtrace.join("\n")
         else
-          Bridgetown.logger.warn "Error:", "Use the --trace option for more information."
+          Bridgetown.logger.warn "Backtrace:", "Use the --trace option for more information."
         end
       end
       Bridgetown.logger.info ""

data/lib/site_template/README.md

@@ -0,0 +1,70 @@
+# Bridgetown Website README
+
+Welcome to your new Bridgetown website! You can update this README file to provide additional context and setup information for yourself or other contributors.
+
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Install](#install)
+- [Development](#development)
+- [Commands](#commands)
+- [Deployment](#deployment)
+- [Contributing](#contributing)
+
+## Prerequisites
+
+- [GCC](https://gcc.gnu.org/install/)
+- [Make](https://www.gnu.org/software/make/)
+- [Ruby](https://www.ruby-lang.org/en/downloads/)
+  - `>= 2.5`
+- [Bridgetown Gem](https://rubygems.org/gems/bridgetown)
+  - `gem install bundler bridgetown -N`
+- [Node](https://nodejs.org)
+  - `>= 10.13`
+- [Yarn](https://yarnpkg.com)
+
+## Install
+
+```sh
+cd bridgetown-site-folder
+bundle install && yarn install
+```
+> Learn more: [Bridgetown Getting Started Documentation](https://www.bridgetownrb.com/docs/).
+
+## Development
+
+To start your site in development mode, run `yarn start` and navigate to [localhost:4000](https://localhost:4000/)!
+
+Use a [theme](https://github.com/topics/bridgetown-theme), add some [plugins](https://www.bridgetownrb.com/plugins/), and/or run some [automations](https://github.com/topics/bridgetown-automation) to get started quickly.
+
+### Commands
+
+```sh
+# running locally
+yarn start
+
+# build & deploy to production
+yarn deploy
+
+# load the site up within a Ruby console (IRB)
+bundle exec bridgetown console
+```
+
+> Learn more: [Bridgetown CLI Documentation](https://www.bridgetownrb.com/docs/command-line-usage)
+
+## Deployment
+
+You can deploy Bridgetown sites on "Jamstack" hosts (Netlify, Vercel, Render, etc.) or virtually any tranditional web server by simply building and copying the output folder to your HTML root.
+
+> Read the [Bridgetown Deployment Documentation](https://www.bridgetownrb.com/docs/deployment) for more information.
+
+## Contributing
+
+If repo is on GitHub:
+
+1. Fork it
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request