bridgetown-builder 1.0.0 → 1.1.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57644330313669593a0ef79303b8bb692fd2ea7d69fbed8c878d5d33918d4bed
-  data.tar.gz: 3a79d7726250d9c477b1afb214a6b1aff3fd45b5d400467ba73844d9b608bdc6
+  metadata.gz: bbc911c29c7452724a7aac033623d55d478c210e0c0016b17cc615bd81ca3432
+  data.tar.gz: 3ef397e52602f72936aacecda5ba216a00a74108f8032fcc1548483d5490ddd6
 SHA512:
-  metadata.gz: b31cae7e13054287b31cc4eaac0246370bd366ce8c8537d5a220ebde1daaf0ad27204ab40e9e09b8e47361cd06b4f6e646acc14da00833eea8ac84e3c4223d8c
-  data.tar.gz: a165e07527cf5c2302e66729648445ec7cd84a030c9fa06bb89ca97e57a7a6c3c96981a8fb9838adcb1e5b1dacabf7c193ec8c58afeea3994a71d55b6b3c65b4
+  metadata.gz: 91f62d820a391edad6b285bd1411648de5177a3c66b27c5e5d4151b46b979cffc84c648bf74cd6a143f503a23ac79b75a14be3f3ab0020ebd1531ab3d6d6855c
+  data.tar.gz: 8fa3a72a20b0b6008fbbc3f6cee4436a953541c08ba77aea9d49dfa6570e61dd697e46f83eb51d24141c4ff15d772f232b9900912bea6a090a1117b66b622fee

data/lib/bridgetown-builder/builder.rb

@@ -10,9 +10,7 @@ module Bridgetown
 
     class << self
       def register
-        Bridgetown::Hooks.register_one :site, :pre_read, reloadable: false do |site|
-          new(name, site).build_with_callbacks
-        end
+        Bridgetown::Builders::PluginBuilder.plugin_registrations << self
       end
 
       def before_build(*args, **kwargs, &block)

data/lib/bridgetown-builder/dsl/generators.rb

@@ -7,13 +7,16 @@ module Bridgetown
         def generator(method_name = nil, &block)
           block = method(method_name) if method_name.is_a?(Symbol)
           local_name = name # pull the name method into a local variable
+          builder_priority = self.class.instance_variable_get(:@priority)
 
-          new_gen = Class.new(Bridgetown::Generator) do
+          anon_generator = Class.new(Bridgetown::Generator) do
             define_method(:_builder_block) { block }
             define_singleton_method(:custom_name) { local_name }
 
             attr_reader :site
 
+            priority builder_priority || :low
+
             def inspect
               "#<#{self.class.custom_name} (Generator)>"
             end
@@ -23,10 +26,10 @@ module Bridgetown
             end
           end
 
-          first_low_priority_index = site.generators.find_index { |gen| gen.class.priority == :low }
-          site.generators.insert(first_low_priority_index || 0, new_gen.new(site.config))
+          site.generators << anon_generator.new(site.config)
+          site.generators.sort!
 
-          functions << { name: name, generator: new_gen }
+          functions << { name: name, generator: anon_generator }
         end
       end
     end

data/lib/bridgetown-builder/dsl/inspectors.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Builders
+    module DSL
+      module Inspectors
+        # Add a couple familar DOM API features
+        module QuerySelection
+          def query_selector(selector)
+            css(selector).first
+          end
+
+          def query_selector_all(selector)
+            css(selector)
+          end
+        end
+
+        # HTML inspector type
+        module HTML
+          # Are there inspectors available? Is it an .htm* file?
+          def self.can_run?(resource, inspectors)
+            inspectors &&
+              resource.output_ext&.starts_with?(".htm") &&
+              !resource.data.bypass_inspectors
+          end
+
+          # Process the resource with the available inspectors and return the output HTML
+          #
+          # @return [String] transformed HTML
+          def self.call(resource, inspectors)
+            doc = Nokogiri.HTML5(resource.output)
+
+            inspectors.each do |block|
+              block.call(doc, resource)
+            end
+
+            doc.to_html
+          end
+        end
+
+        # XML inspector type
+        module XML
+          # Strip the resource's initial extension dot. `.rss` => `rss`
+          def self.resource_ext(resource)
+            resource.output_ext&.delete_prefix(".")
+          end
+
+          # Are there any inspectors available which match the resource extension?
+          def self.can_run?(resource, inspectors)
+            inspectors &&
+              inspectors[resource_ext(resource)] &&
+              !resource.data.bypass_inspectors
+          end
+
+          # Process the resource with the available inspectors and return the output XML
+          #
+          # @return [String] transformed XML
+          def self.call(resource, inspectors)
+            doc = Nokogiri::XML(resource.output)
+
+            inspectors[resource_ext(resource)].each do |block|
+              block.call(doc, resource)
+            end
+
+            doc.to_xml
+          end
+        end
+
+        class << self
+          # Require the Nokogiri gem if necessary and add the `QuerySelection` mixin
+          def setup_nokogiri
+            unless defined?(Nokogiri)
+              Bridgetown::Utils::RequireGems.require_with_graceful_fail "nokogiri"
+            end
+
+            return if Nokogiri::XML::Node <= QuerySelection
+
+            Nokogiri::XML::Node.include QuerySelection
+          end
+
+          # Shorthand for `HTML.call`
+          def process_html(...)
+            HTML.call(...)
+          end
+
+          # Shorthand for `XML.call`
+          def process_xml(...)
+            XML.call(...)
+          end
+        end
+
+        # Set up an inspector to review or manipulate HTML resources
+        # @yield the block to be called after the resource has been rendered
+        # @yieldparam [Nokogiri::HTML5::Document] the Nokogiri document
+        def inspect_html(&block)
+          unless @_html_inspectors
+            @_html_inspectors = []
+
+            Inspectors.setup_nokogiri
+
+            hook :resources, :post_render do |resource|
+              next unless HTML.can_run?(resource, @_html_inspectors)
+
+              resource.output = Inspectors.process_html(resource, @_html_inspectors)
+            end
+
+            hook :generated_pages, :post_render do |page|
+              next unless HTML.can_run?(page, @_html_inspectors)
+
+              page.output = Inspectors.process_html(page, @_html_inspectors)
+            end
+          end
+
+          @_html_inspectors << block
+        end
+
+        # Set up an inspector to review or manipulate XML resources
+        # @param extension [String] defaults to `xml`
+        # @yield the block to be called after the resource has been rendered
+        # @yieldparam [Nokogiri::XML::Document] the Nokogiri document
+        def inspect_xml(extension = "xml", &block)
+          unless @_xml_inspectors
+            @_xml_inspectors = {}
+
+            Inspectors.setup_nokogiri
+
+            hook :resources, :post_render do |resource|
+              next unless Inspectors::XML.can_run?(resource, @_xml_inspectors)
+
+              resource.output = Inspectors.process_xml(resource, @_xml_inspectors)
+            end
+
+            hook :generated_pages, :post_render do |page|
+              next unless Inspectors::XML.can_run?(page, @_xml_inspectors)
+
+              page.output = Inspectors.process_xml(page, @_xml_inspectors)
+            end
+          end
+
+          (@_xml_inspectors[extension.to_s] ||= []).tap do |arr|
+            arr << block
+          end
+
+          @_xml_inspectors
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-builder/plugin.rb

@@ -3,21 +3,40 @@
 require "bridgetown-builder/dsl/generators"
 require "bridgetown-builder/dsl/helpers"
 require "bridgetown-builder/dsl/hooks"
+require "bridgetown-builder/dsl/inspectors"
 require "bridgetown-builder/dsl/http"
 require "bridgetown-builder/dsl/liquid"
 require "bridgetown-builder/dsl/resources"
+
 module Bridgetown
   module Builders
     class PluginBuilder
+      include Bridgetown::Prioritizable
+
+      self.priorities = {
+        highest: 100,
+        high: 10,
+        normal: 0,
+        low: -10,
+        lowest: -100,
+      }.freeze
+
       include DSL::Generators
       include DSL::Helpers
       include DSL::Hooks
+      include DSL::Inspectors
       include DSL::HTTP
       include DSL::Liquid
       include DSL::Resources
 
       attr_accessor :functions, :name, :site, :config
 
+      class << self
+        def plugin_registrations
+          @plugin_registrations ||= Set.new
+        end
+      end
+
       def initialize(name = nil, current_site = nil)
         self.functions = Set.new
         self.name = name || self.class.name

data/lib/bridgetown-builder.rb

@@ -12,12 +12,14 @@ module Bridgetown
 end
 
 Bridgetown::Hooks.register_one :site, :pre_read, priority: :low, reloadable: false do |site|
+  builders = Bridgetown::Builders::PluginBuilder.plugin_registrations.to_a
+
   # SiteBuilder is the superclass sites can subclass to create any number of
   # builders, but if the site hasn't defined it explicitly, this is a no-op
-  if defined?(SiteBuilder)
-    SiteBuilder.descendants.map do |c|
-      c.new(c.name, site).build_with_callbacks
-    end
+  builders += SiteBuilder.descendants if defined?(SiteBuilder)
+
+  builders.sort.map do |c|
+    c.new(c.name, site).build_with_callbacks
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-builder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.beta3
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0.beta3
 description: 
 email: maintainers@bridgetownrb.com
 executables: []
@@ -39,6 +39,7 @@ files:
 - lib/bridgetown-builder/dsl/helpers.rb
 - lib/bridgetown-builder/dsl/hooks.rb
 - lib/bridgetown-builder/dsl/http.rb
+- lib/bridgetown-builder/dsl/inspectors.rb
 - lib/bridgetown-builder/dsl/liquid.rb
 - lib/bridgetown-builder/dsl/resources.rb
 - lib/bridgetown-builder/plugin.rb
@@ -57,9 +58,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: