bridgetown-core 0.12.0 → 0.15.0.beta1

data/lib/bridgetown-core/static_file.rb

@@ -186,11 +186,7 @@ module Bridgetown
     private
 
     def copy_file(dest_path)
-      if Bridgetown.env == "production"
-        FileUtils.cp(path, dest_path)
-      else
-        FileUtils.copy_entry(path, dest_path)
-      end
+      FileUtils.copy_entry(path, dest_path)
 
       unless File.symlink?(dest_path)
         File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)

data/lib/bridgetown-core/tags/include.rb

@@ -3,6 +3,10 @@
 module Bridgetown
   module Tags
     class IncludeTag < Liquid::Tag
+      class << self
+        attr_accessor :deprecation_message_shown
+      end
+
       VALID_SYNTAX = %r!
         ([\w-]+)\s*=\s*
         (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
@@ -18,6 +22,14 @@ module Bridgetown
 
       def initialize(tag_name, markup, tokens)
         super
+
+        unless self.class.deprecation_message_shown
+          Bridgetown.logger.warn "NOTICE: the {% include %} tag is deprecated and" \
+                                 " will be removed in Bridgetown 1.0. You should" \
+                                 " use the {% render %} tag instead."
+          self.class.deprecation_message_shown = true
+        end
+
         matched = markup.strip.match(VARIABLE_SYNTAX)
         if matched
           @file = matched["variable"].strip

data/lib/bridgetown-core/tags/render_content.rb

@@ -3,27 +3,38 @@
 module Bridgetown
   module Tags
     class BlockRenderTag < Liquid::Block
-      def initialize(tag_name, markup, options)
-        super
+      def render(context)
+        context.stack({}) do
+          content = super.gsub(%r!^[ \t]+!, "") # unindent the incoming text
+          regions = gather_content_regions(context)
 
-        @tag = tag_name
-        @markup = markup
-        @options = options
-      end
+          site = context.registers[:site]
+          converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
+          markdownified_content = converter.convert(content)
+          context["processed_component_content"] = markdownified_content
 
-      def render(context)
-        content = super.gsub(%r!^[ \t]+!, "") # unindent the incoming text
+          render_params = [@markup, "content: processed_component_content"]
+          unless regions.empty?
+            regions.each do |region_name, region_content|
+              region_name = region_name.sub("content_with_region_", "")
+              context[region_name] = converter.convert(region_content.gsub(%r!^[ \t]+!, ""))
+              render_params.push "#{region_name}: #{region_name}"
+            end
+          end
 
-        site = context.registers[:site]
-        converter = site.find_converter_instance(Bridgetown::Converters::Markdown)
-        markdownified_content = converter.convert(content)
+          Liquid::Render.parse("render", render_params.join(","), nil, @parse_context)
+            .render_tag(context, +"")
+        end
+      end
+
+      private
 
-        context.stack do
-          context["componentcontent"] = markdownified_content
-          render_params = "#{@markup}, content: componentcontent"
-          render_tag = Liquid::Render.parse("render", render_params, @options, @parse_context)
-          render_tag.render_tag(context, +"")
+      def gather_content_regions(context)
+        unless context.scopes[0].keys.find { |k| k.to_s.start_with? "content_with_region_" }
+          return {}
         end
+
+        context.scopes[0].select { |k| k.to_s.start_with? "content_with_region_" }
       end
     end
   end

data/lib/bridgetown-core/tags/with.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Tags
+    class WithTag < Liquid::Block
+      def render(context)
+        region_name = @markup.strip
+        context["content_with_region_#{region_name}"] = super
+        ""
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("with", Bridgetown::Tags::WithTag)

data/lib/bridgetown-core/utils.rb

@@ -6,6 +6,7 @@ module Bridgetown
     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 :Platforms, "bridgetown-core/utils/platforms"
     autoload :ThreadEvent, "bridgetown-core/utils/thread_event"
     autoload :WinTZ, "bridgetown-core/utils/win_tz"
@@ -19,7 +20,7 @@ module Bridgetown
 
     # Takes a slug and turns it into a simple title.
     def titleize_slug(slug)
-      slug.split("-").map!(&:capitalize).join(" ")
+      slug.gsub(%r![_ ]!, "-").split("-").map!(&:capitalize).join(" ")
     end
 
     # Non-destructive version of deep_merge_hashes! See that method.
@@ -94,32 +95,6 @@ module Bridgetown
       end
     end
 
-    def transform_keys(hash)
-      result = {}
-      hash.each_key do |key|
-        result[yield(key)] = hash[key]
-      end
-      result
-    end
-
-    # Apply #to_sym to all keys in the hash
-    #
-    # hash - the hash to which to apply this transformation
-    #
-    # Returns a new hash with symbolized keys
-    def symbolize_hash_keys(hash)
-      transform_keys(hash) { |key| key.to_sym rescue key }
-    end
-
-    # Apply #to_s to all keys in the Hash
-    #
-    # hash - the hash to which to apply this transformation
-    #
-    # Returns a new hash with stringified keys
-    def stringify_hash_keys(hash)
-      transform_keys(hash) { |key| key.to_s rescue key }
-    end
-
     # Parse a date/time and throw an error if invalid
     #
     # input - the date/time to parse

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Utils
+    module RubyExec
+      extend self
+
+      # rubocop:disable Metrics/AbcSize
+      def search_data_for_ruby_code(convertible, renderer)
+        return if convertible.data.empty?
+
+        # Iterate using `keys` here so inline Ruby script can add new data keys
+        # if necessary without an error
+        data_keys = convertible.data.keys
+        data_keys.each do |k|
+          v = convertible.data[k]
+          next unless v.is_a?(Rb) || v.is_a?(Hash)
+
+          if v.is_a?(Hash)
+            v.each do |nested_k, nested_v|
+              next unless nested_v.is_a?(Rb)
+
+              Bridgetown.logger.warn("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)
+            end
+          else
+            Bridgetown.logger.warn("Executing inline Ruby…", convertible.relative_path)
+            convertible.data[k] = run(v, convertible, renderer)
+            Bridgetown.logger.warn("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.
+      #
+      # ruby_code - a string of code
+      # convertible - the Document/Page/Layout with the Ruby front matter
+      # renderer - the Renderer instance that's processing the document (optional)
+      #
+      # Returns the transformed output of the code
+      def run(ruby_code, convertible, renderer)
+        return unless ruby_code.is_a?(Rb)
+
+        klass = Class.new
+        obj = klass.new
+
+        if convertible.is_a?(Layout)
+          klass.attr_accessor :layout, :site, :data
+          obj.layout = convertible
+        else
+          klass.attr_accessor :document, :page, :renderer, :site, :data
+          obj.document = obj.page = convertible
+          obj.renderer = renderer
+        end
+        obj.site = convertible.site
+        obj.data = convertible.data
+
+        # This is where the magic happens! DON'T BE EVIL!!! ;-)
+        output = obj.instance_eval(ruby_code)
+        output.is_a?(Hash) ? output.with_indifferent_access : output
+      end
+    end
+  end
+end

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "0.12.0"
-  CODE_NAME = "Lovejoy"
+  VERSION = "0.15.0.beta1"
+  CODE_NAME = "Overlook"
 end

data/lib/bridgetown-core/watcher.rb

@@ -39,16 +39,21 @@ module Bridgetown
     def build_listener(site, options)
       webpack_path = site.in_root_dir(".bridgetown-webpack")
       FileUtils.mkdir(webpack_path) unless Dir.exist?(webpack_path)
+      plugin_paths_to_watch = site.plugin_manager.plugins_path.select do |path|
+        Dir.exist?(path)
+      end
+
       Listen.to(
         options["source"],
-        site.in_root_dir(".bridgetown-webpack"),
+        webpack_path,
+        *plugin_paths_to_watch,
         ignore: listen_ignore_paths(options),
         force_polling: options["force_polling"],
-        &listen_handler(site)
+        &listen_handler(site, options)
       )
     end
 
-    def listen_handler(site)
+    def listen_handler(site, options)
       proc do |modified, added, removed|
         t = Time.now
         c = modified + added + removed
@@ -58,7 +63,7 @@ module Bridgetown
         Bridgetown.logger.info "", "#{n} file(s) changed at #{t.strftime("%Y-%m-%d %H:%M:%S")}"
 
         c.each { |path| Bridgetown.logger.info "", path["#{site.root_dir}/".length..-1] }
-        process(site, t)
+        process(site, t, options)
       end
     end
 
@@ -94,7 +99,6 @@ module Bridgetown
     # options - A Hash of options passed to the command
     #
     # Returns a list of relative paths from source that should be ignored
-    # rubocop: disable Metrics/AbcSize
     def listen_ignore_paths(options)
       source = Pathname.new(options["source"]).expand_path
       paths  = to_exclude(options)
@@ -116,20 +120,27 @@ module Bridgetown
         end
       end.compact + [%r!^\.bridgetown\-metadata!]
     end
-    # rubocop:enable Metrics/AbcSize
 
     def sleep_forever
       loop { sleep 1000 }
     end
 
-    def process(site, time)
+    def process(site, time, options)
       begin
+        Bridgetown::Hooks.trigger :site, :pre_reload, site
+        Bridgetown::Hooks.clear_reloadable_hooks
+        site.plugin_manager.reload_plugin_files
         site.process
         Bridgetown.logger.info "Done! 🎉", "#{"Completed".green} in less than" \
                                " #{(Time.now - time).ceil(2)} seconds."
-      rescue StandardError => e
-        Bridgetown.logger.warn "Error:", e.message
-        Bridgetown.logger.warn "Error:", "Run bridgetown build --trace for more information."
+      rescue Exception => e
+        Bridgetown.logger.error "Error:", e.message
+
+        if options[:trace]
+          Bridgetown.logger.info e.backtrace.join("\n")
+        else
+          Bridgetown.logger.warn "Error:", "Use the --trace option for more information."
+        end
       end
       Bridgetown.logger.info ""
     end

data/lib/site_template/Gemfile.erb

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Hello! This is where you manage which Bridgetown version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Bridgetown with `bundle exec`, like so:
+#
+#   bundle exec bridgetown serve
+#
+# This will help ensure the proper Bridgetown version is running.
+#
+# To install a plugin, simply run bundle add and specify the group
+# "bridgetown_plugins". For example:
+#
+#   bundle add some-new-plugin -g bridgetown_plugins
+#
+# Happy Bridgetowning!
+
+gem "bridgetown", "~> <%= Bridgetown::VERSION %>"

data/lib/site_template/plugins/site_builder.rb

@@ -0,0 +1,4 @@
+class SiteBuilder < Bridgetown::Builder
+  # write builders which subclass SiteBuilder in plugins/builder
+end
+

data/lib/site_template/src/_components/footer.html

@@ -0,0 +1,3 @@
+<footer>
+  Contact me at {{ metadata.email }}
+</footer>

data/lib/site_template/src/_components/head.html

@@ -0,0 +1,9 @@
+<meta charset="utf-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+{% capture page_title %}{{ title | strip_html | strip_newlines }}{% endcapture %}
+<title>{% if page_title != "" %}{{ page_title | escape }} | {{ metadata.title | escape }}{% else %}{{ metadata.title | escape }}: {{ metadata.tagline | escape }}{% endif %}</title>
+
+<meta name="description" content="{{ metadata.description }}" />
+
+<link rel="stylesheet" href="{% webpack_path css %}" />
+<script src="{% webpack_path js %}" defer></script>

data/lib/site_template/src/{_includes → _components}/navbar.html

@@ -1,4 +1,5 @@
 <nav>
   <a href="/">Home</a>
   <a href="/about">About</a>
+  <a href="/posts">Posts</a>
 </nav>

data/lib/site_template/src/_layouts/default.html

@@ -1,15 +1,15 @@
 <!doctype html>
 <html lang="en">
   <head>
-    {% include head.html %}
+    {% render "head", metadata: site.metadata, title: page.title %}
   </head>
   <body class="{{ page.layout }} {{ page.page_class }}">
-    {% include navbar.html %}
+    {% render "navbar" %}
 
     <main>
       {{ content }}
     </main>
 
-    {% include footer.html %}
+    {% render "footer", metadata: site.metadata %}
   </body>
 </html>

data/lib/site_template/src/posts.md

@@ -0,0 +1,15 @@
+---
+layout: page
+title: Posts
+permalink: /posts/
+---
+
+<ul>
+  {% for post in site.posts %}
+    <li>
+      <a href="{{ post.url }}">{{ post.title }}</a>
+    </li>
+  {% endfor %}
+</ul>
+
+If you have a lot of posts, you may want to consider adding [pagination](https://www.bridgetownrb.com/docs/content/pagination)!

data/lib/site_template/start.js

@@ -14,4 +14,4 @@ concurrently([
 ], {
   restartTries: 3,
   killOthers: ['failure', 'success'],
-}).then(() => {}, () => {});
+}).then(() => { console.log("Done.");console.log('\033[0G'); }, () => {});

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.0.beta1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -95,33 +137,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: liquid-component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: liquid-render-tag
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: mercenary
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pathutil
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Bridgetown is a Webpack-aware, Ruby-powered static site generator for
   the modern Jamstack era
 email: maintainers@bridgetownrb.com
@@ -193,22 +263,34 @@ files:
 - lib/bridgetown-core/cache.rb
 - lib/bridgetown-core/cleaner.rb
 - lib/bridgetown-core/collection.rb
-- lib/bridgetown-core/command.rb
+- lib/bridgetown-core/commands/apply.rb
+- lib/bridgetown-core/commands/base.rb
 - lib/bridgetown-core/commands/build.rb
 - lib/bridgetown-core/commands/clean.rb
+- lib/bridgetown-core/commands/concerns/actions.rb
+- lib/bridgetown-core/commands/concerns/build_options.rb
+- lib/bridgetown-core/commands/concerns/configuration_overridable.rb
+- lib/bridgetown-core/commands/concerns/summarizable.rb
 - lib/bridgetown-core/commands/console.rb
 - lib/bridgetown-core/commands/doctor.rb
-- lib/bridgetown-core/commands/help.rb
 - lib/bridgetown-core/commands/new.rb
+- lib/bridgetown-core/commands/plugins.rb
+- lib/bridgetown-core/commands/registrations.rb
 - lib/bridgetown-core/commands/serve.rb
 - lib/bridgetown-core/commands/serve/servlet.rb
+- lib/bridgetown-core/concerns/convertible.rb
+- lib/bridgetown-core/concerns/site/configurable.rb
+- lib/bridgetown-core/concerns/site/content.rb
+- lib/bridgetown-core/concerns/site/extensible.rb
+- lib/bridgetown-core/concerns/site/processable.rb
+- lib/bridgetown-core/concerns/site/renderable.rb
+- lib/bridgetown-core/concerns/site/writable.rb
 - lib/bridgetown-core/configuration.rb
 - lib/bridgetown-core/converter.rb
 - lib/bridgetown-core/converters/identity.rb
 - lib/bridgetown-core/converters/markdown.rb
 - lib/bridgetown-core/converters/markdown/kramdown_parser.rb
 - lib/bridgetown-core/converters/smartypants.rb
-- lib/bridgetown-core/convertible.rb
 - lib/bridgetown-core/deprecator.rb
 - lib/bridgetown-core/document.rb
 - lib/bridgetown-core/drops/bridgetown_drop.rb
@@ -253,6 +335,7 @@ files:
 - lib/bridgetown-core/readers/data_reader.rb
 - lib/bridgetown-core/readers/layout_reader.rb
 - lib/bridgetown-core/readers/page_reader.rb
+- lib/bridgetown-core/readers/plugin_content_reader.rb
 - lib/bridgetown-core/readers/post_reader.rb
 - lib/bridgetown-core/readers/static_file_reader.rb
 - lib/bridgetown-core/regenerator.rb
@@ -266,46 +349,51 @@ files:
 - lib/bridgetown-core/tags/post_url.rb
 - lib/bridgetown-core/tags/render_content.rb
 - lib/bridgetown-core/tags/webpack_path.rb
+- lib/bridgetown-core/tags/with.rb
 - lib/bridgetown-core/url.rb
 - lib/bridgetown-core/utils.rb
 - lib/bridgetown-core/utils/ansi.rb
 - lib/bridgetown-core/utils/exec.rb
 - lib/bridgetown-core/utils/internet.rb
 - lib/bridgetown-core/utils/platforms.rb
+- lib/bridgetown-core/utils/ruby_exec.rb
 - lib/bridgetown-core/utils/thread_event.rb
 - lib/bridgetown-core/utils/win_tz.rb
 - lib/bridgetown-core/version.rb
 - lib/bridgetown-core/watcher.rb
 - lib/site_template/.gitignore
+- lib/site_template/Gemfile.erb
 - lib/site_template/bridgetown.config.yml
 - lib/site_template/frontend/javascript/index.js
 - lib/site_template/frontend/styles/index.scss
 - lib/site_template/package.json
-- lib/site_template/plugins/.keep
+- lib/site_template/plugins/builders/.keep
+- lib/site_template/plugins/site_builder.rb
 - lib/site_template/src/404.html
-- lib/site_template/src/_components/.keep
+- lib/site_template/src/_components/footer.html
+- lib/site_template/src/_components/head.html
+- lib/site_template/src/_components/navbar.html
 - lib/site_template/src/_data/site_metadata.yml
-- lib/site_template/src/_includes/footer.html
-- lib/site_template/src/_includes/head.html
-- lib/site_template/src/_includes/navbar.html
 - lib/site_template/src/_layouts/default.html
 - lib/site_template/src/_layouts/home.html
 - lib/site_template/src/_layouts/page.html
 - lib/site_template/src/_layouts/post.html
 - lib/site_template/src/_posts/0000-00-00-welcome-to-bridgetown.md.erb
 - lib/site_template/src/about.md
+- lib/site_template/src/favicon.ico
 - lib/site_template/src/index.md
+- lib/site_template/src/posts.md
 - lib/site_template/start.js
 - lib/site_template/sync.js
 - lib/site_template/webpack.config.js
-homepage: https://bridgetownrb.com
+homepage: https://www.bridgetownrb.com
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/bridgetownrb/bridgetown
   bug_tracker_uri: https://github.com/bridgetownrb/bridgetown/issues
   changelog_uri: https://github.com/bridgetownrb/bridgetown/releases
-  homepage_uri: https://bridgetownrb.com
+  homepage_uri: https://www.bridgetownrb.com
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -315,7 +403,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="