bridgetown-builder 2.0.0.beta2 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5988f5c80e105125c96f5fafb1a62e1b658271aaa1e5ae1f7a18699194213a76
-  data.tar.gz: 5eb9cfed91973c392f207c36e89205b1545c34c817499f8ca98b6b57955c40bd
+  metadata.gz: 838d55bbb0f5156418d716123a70ca4332cf730897465522bf2035d5b6ec84b7
+  data.tar.gz: 03b21bc088a0973c209de3bfe345c5f90282ab254b75524d8b66b4f6e1fc837c
 SHA512:
-  metadata.gz: 9d69e072c3b9ae899ccc16cd2836fc5a90677b4245e62e347a9921cd3a41dbbf009aae2a73dce3295ca6626f16204f64b337bd0d0d6608c97cb4d4ae9f67528d
-  data.tar.gz: 8318fa593a7c4cc620e6a3a1d5b4df5fc21725fb5cffaf25f8e7aba155270be40ba3eead5ec17d8bfa41b7990a8112fba292aae399c06d80b4772fe9071d5aea
+  metadata.gz: b7deb7c43bac84aeef089f883e5dc53837cfcc2d536dcbd41d4f0058f1232c3695ba3755d1ea214c9c574a4b21490d374ebdca83cf82a3aa40c71865ded00c41
+  data.tar.gz: 0620d42e542547589c1f4dd34dae17c0881b9fdd336f9cebfc0a0eaf6fbcc54f6048de04230f6c4e5ba9fa6388cdb3d45c07789f7403e5b045fd63dbe62f7f76

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

@@ -4,6 +4,10 @@ module Bridgetown
   module Builders
     module DSL
       module Generators
+        # Set up a new generator based on the block or method provided which will run alongside
+        # other generators during the build process
+        #
+        # @param method_name [Symbol] use a Builder method rather than a block to run
         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

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

@@ -5,9 +5,15 @@ module Bridgetown
     module DSL
       module Helpers
         def helpers
-          @helpers # could be nil
+          @helpers # could be nil. gets set once a helper method is actually called
         end
 
+        # Define a helper for use in view templates, alongside built-in helpers, using either a
+        # builder method or a block
+        #
+        # @param helper_name [Symbol] name of the helper
+        # @param method_name [Symbol] name of a Builder method to use, if block isn't provided
+        #   and the method is named different from the helper
         def helper(helper_name, method_name = nil, &block)
           m = Module.new
 

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

@@ -4,6 +4,13 @@ module Bridgetown
   module Builders
     module DSL
       module Hooks
+        # Define a hook to run at some point during the build process
+        #
+        # @param owner [Symbol] name of the owner (`:site`, `:resource`, etc.)
+        # @param event [Symbol] name of the event (`:pre_read`, `:post_render`, etc.)
+        # @param method_name [Symbol] name of a Builder method to use, if block isn't provided
+        # @param priority [Integer, Symbol] either `:low`, `:normal`, or `:high`, or an integer.
+        #   Default is normal (20)
         def hook(
           owner,
           event,
@@ -17,9 +24,13 @@ module Bridgetown
           functions << { name:, hook: [owner, event, priority, hook_block] }
         end
 
+        # Define a site post_read hook and add data returned by the block to the site data/signals
         def add_data(data_key)
           hook(:site, :post_read) do
-            site.data[data_key] = yield
+            yield.tap do |value|
+              site.data[data_key] = value
+              site.signals[data_key] = value
+            end
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-builder
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.beta3
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: 2.0.0.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: 2.0.0.beta3
 description:
 email: maintainers@bridgetownrb.com
 executables: []