bridgetown-builder 0.21.3 → 1.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59cfc3dcbdf5d01342b47ea1925deeb8279bc5cee3885063e15bca6df8b6efcb
-  data.tar.gz: 58d1c5273b9359e943e934ea4a8613c4e1162a948c4140f698c68958aadc94f3
+  metadata.gz: 5daed3d805daca68bcf04c10c5a129aa3543958ed7cb40e7fd1bfc48ff1b5d71
+  data.tar.gz: 1bf1cab7474d8a296fabd72f1c64d7bb98460a56104f56a154565d59424f3ded
 SHA512:
-  metadata.gz: 0bf0956d311b58cb6d1b7b1be682c46909e1080df66bec183c8eabf6ef94b53c1295f2fe1a0b8cf62b8d061fbde8224b9397ec5438d9a3e59c06bf2fe728a031
-  data.tar.gz: 0ed5480305575531e84e69a2fc59c6a1be923fbf27c73b9b641059d017629fe3a62d03a9d937d06bb340089cba4540450e2e223fe9aadd0db3a57347e1c7a244
+  metadata.gz: 869e94944138ff6dbf0d756a51828f3d6a520b9f843b98a812d21113c8fc543dfecd1e4b10b82d0566945e31137b5b902d08c3d91de5990fd21da9a092db90db
+  data.tar.gz: 105b9688d9065c50a7ff21a01f0f34c91d6c10c73aea3f56803f9ebecda2b1dcf411fb7d56e9167d05df24d2e5c385cd32c15f613fcd40ad6ec78b23f4afb24a

data/.rubocop.yml

@@ -2,9 +2,9 @@
 inherit_from: ../.rubocop.yml
 
 AllCops:
-  Include:
-    - lib/**/*.rb
-    - spec/**/*.rb
+  Exclude:
+    - "*.gemspec"
+    - test/**/*.rb
 
 Metrics/AbcSize:
   Exclude:

data/bridgetown-builder.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.author        = "Bridgetown Team"
   spec.email         = "maintainers@bridgetownrb.com"
   spec.summary       = "A Bridgetown plugin to provide a sophisticated DSL for writing plugins at a higher level of abstraction."
-  spec.homepage      = "https://github.com/bridgetownrb/bridgetown/tree/master/bridgetown-builder"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-builder"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }

data/lib/bridgetown-builder/builder.rb

@@ -4,19 +4,33 @@ module Bridgetown
   # Superclass for a website's SiteBuilder abstract class
   class Builder < Bridgetown::Builders::PluginBuilder
     extend ActiveSupport::DescendantsTracker
+    include ActiveSupport::Callbacks
+
+    define_callbacks :build
 
     class << self
       def register
         Bridgetown::Hooks.register_one :site, :pre_read, reloadable: false do |site|
-          new(name, site)
+          new(name, site).build_with_callbacks
         end
       end
+
+      ruby2_keywords def before_build(*args, &block)
+        set_callback :build, :before, *args, &block
+      end
+
+      ruby2_keywords def after_build(*args, &block)
+        set_callback :build, :after, *args, &block
+      end
+
+      ruby2_keywords def around_build(*args, &block)
+        set_callback :build, :around, *args, &block
+      end
     end
 
-    # Subclass is expected to implement #build
-    def initialize(name, current_site = nil)
-      super(name, current_site)
-      build
+    def build_with_callbacks
+      run_callbacks(:build) { build }
+      self
     end
 
     def inspect
@@ -24,7 +38,8 @@ module Bridgetown
     end
 
     def self.descendants
-      super.reject { |klass| ["SiteBuilder"].include?(klass.name) }
+      site_builder_name = "SiteBuilder"
+      super.reject { |klass| [site_builder_name].include?(klass.name) }
     end
   end
 end

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

@@ -10,14 +10,14 @@ module Bridgetown
       module HTTP
         def get(url, headers: {}, parse_json: true)
           body = begin
-                   connection(parse_json: parse_json).get(url, headers: headers).body
-                 rescue Faraday::ParsingError
-                   Bridgetown.logger.error(
-                     "Faraday::ParsingError",
-                     "The response from #{url} did not contain valid JSON"
-                   )
-                   nil
-                 end
+            connection(parse_json: parse_json).get(url, headers: headers).body
+          rescue Faraday::ParsingError
+            Bridgetown.logger.error(
+              "Faraday::ParsingError",
+              "The response from #{url} did not contain valid JSON"
+            )
+            nil
+          end
           yield body
         end
 

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Builders
+    module DSL
+      module Resources
+        def add_resource(collection_name, path, &block) # rubocop:todo Metrics/AbcSize
+          data = Bridgetown::Utils::RubyFrontMatter.new(scope: self).tap do |fm|
+            fm.define_singleton_method(:___) do |hsh|
+              hsh.each do |k, v|
+                fm.set k, v
+              end
+            end
+            fm.instance_exec(&block)
+          end.to_h
+          if data[:content]
+            data[:_content_] = data[:content]
+            data.delete :content
+          end
+
+          collection_name = collection_name.to_s
+          unless @site.collections[collection_name]
+            Bridgetown.logger.info(
+              "#{self.class.name}:",
+              "Creating `#{collection_name}' collection on the fly..."
+            )
+            collection = Collection.new(@site, collection_name)
+            collection.metadata["output"] = true
+            @site.collections[collection_name] = collection
+          end
+
+          Bridgetown::Model::Base.build(
+            self,
+            collection_name,
+            path,
+            data
+          ).as_resource_in_collection
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-builder/plugin.rb

@@ -5,6 +5,7 @@ require "bridgetown-builder/dsl/helpers"
 require "bridgetown-builder/dsl/hooks"
 require "bridgetown-builder/dsl/http"
 require "bridgetown-builder/dsl/liquid"
+require "bridgetown-builder/dsl/resources"
 module Bridgetown
   module Builders
     class PluginBuilder
@@ -13,12 +14,13 @@ module Bridgetown
       include DSL::Hooks
       include DSL::HTTP
       include DSL::Liquid
+      include DSL::Resources
 
       attr_accessor :functions, :name, :site, :config
 
-      def initialize(name, current_site = nil)
+      def initialize(name = nil, current_site = nil)
         self.functions = Set.new
-        self.name = name
+        self.name = name || self.class.name
         self.site = current_site || Bridgetown.sites.first
 
         self.config = if defined?(self.class::CONFIG_DEFAULTS)
@@ -34,8 +36,9 @@ module Bridgetown
         "#{name} (Hook)"
       end
 
-      def doc(path, &block)
-        DocumentsGenerator.add(path, block)
+      def doc(*)
+        raise Bridgetown::Errors::FatalException,
+              "The `doc' method has been removed. Please use the `new_resource' builder DSL instead"
       end
     end
   end

data/lib/bridgetown-builder.rb

@@ -6,8 +6,6 @@ require "bridgetown-core/version"
 module Bridgetown
   module Builders
     autoload :PluginBuilder, "bridgetown-builder/plugin"
-    autoload :DocumentBuilder, "bridgetown-builder/document"
-    autoload :DocumentsGenerator, "bridgetown-builder/documents_generator"
   end
 
   autoload :Builder, "bridgetown-builder/builder"
@@ -18,24 +16,13 @@ Bridgetown::Hooks.register_one :site, :pre_read, priority: :low, reloadable: fal
   # 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)
+      c.new(c.name, site).build_with_callbacks
     end
   end
-
-  # If the documents generator is in use, we need to add it at the top of the
-  # list so the site runs the generator before any others
-  if Bridgetown::Builders.autoload?(:DocumentsGenerator).nil? &&
-      !site.generators.first.is_a?(Bridgetown::Builders::DocumentsGenerator)
-    site.generators.unshift Bridgetown::Builders::DocumentsGenerator.new(site.config)
-  end
 end
 
 Bridgetown::Hooks.register_one :site, :pre_reload, reloadable: false do |site|
   # Remove all anonymous generator classes so they can later get reloaded
   site.converters.delete_if { |generator| generator.class.name.nil? }
   site.generators.delete_if { |generator| generator.class.name.nil? }
-
-  unless Bridgetown::Builders.autoload? :DocumentsGenerator
-    Bridgetown::Builders::DocumentsGenerator.clear_documents_to_generate
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-builder
 version: !ruby/object:Gem::Version
-  version: 0.21.3
+  version: 1.0.0.alpha3
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-07 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.3
+        version: 1.0.0.alpha3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.21.3
+        version: 1.0.0.alpha3
 description: 
 email: maintainers@bridgetownrb.com
 executables: []
@@ -35,15 +35,14 @@ files:
 - bridgetown-builder.gemspec
 - lib/bridgetown-builder.rb
 - lib/bridgetown-builder/builder.rb
-- lib/bridgetown-builder/document.rb
-- lib/bridgetown-builder/documents_generator.rb
 - lib/bridgetown-builder/dsl/generators.rb
 - lib/bridgetown-builder/dsl/helpers.rb
 - lib/bridgetown-builder/dsl/hooks.rb
 - lib/bridgetown-builder/dsl/http.rb
 - lib/bridgetown-builder/dsl/liquid.rb
+- lib/bridgetown-builder/dsl/resources.rb
 - lib/bridgetown-builder/plugin.rb
-homepage: https://github.com/bridgetownrb/bridgetown/tree/master/bridgetown-builder
+homepage: https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-builder
 licenses:
 - MIT
 metadata: {}
@@ -58,9 +57,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: 

data/lib/bridgetown-builder/document.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  module Builders
-    class DocumentBuilder
-      attr_reader :site
-
-      def initialize(site, path)
-        @site = site
-        @path = path
-        @data = HashWithDotAccess::Hash.new
-      end
-
-      def front_matter(data)
-        @data.merge!(data)
-      end
-
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      def _add_document_to_site
-        @collection = (@data[:collection] || :posts).to_s
-        collection = @site.collections[@collection]
-        unless collection
-          collection = Collection.new(@site, @collection)
-          collection.metadata["output"] = true
-          @site.collections[@collection] = collection
-        end
-
-        doc = Document.new(
-          File.join(collection.directory, @path),
-          site: @site,
-          collection: collection
-        )
-        doc.send(:merge_defaults)
-        doc.content = @data[:content]
-        @data.delete(:content)
-
-        if @path.start_with?("/")
-          pathname = Pathname.new(@path)
-          @data[:permalink] = File.join(
-            pathname.dirname,
-            pathname.basename.sub(pathname.extname, "")
-          ) + "/"
-        end
-
-        doc.merge_data!(@data)
-        doc.send(:read_post_data)
-
-        collection.docs << doc
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-      # rubocop:disable Style/MissingRespondToMissing
-      def method_missing(key, value = nil)
-        if respond_to?(key)
-          super
-        else
-          @data[key] = value
-        end
-      end
-      # rubocop:enable Style/MissingRespondToMissing
-    end
-  end
-end

data/lib/bridgetown-builder/documents_generator.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  module Builders
-    class DocumentsGenerator < Bridgetown::Generator
-      priority :high
-
-      def self.add(path, block)
-        @documents_to_generate ||= []
-        @documents_to_generate << [path, block]
-      end
-
-      class << self
-        attr_reader :documents_to_generate
-      end
-
-      def self.clear_documents_to_generate
-        @documents_to_generate = []
-      end
-
-      def generate(site)
-        self.class.documents_to_generate&.each do |doc_block|
-          path, block = doc_block
-          doc_builder = DocumentBuilder.new(site, path)
-          doc_builder.instance_exec(&block)
-          doc_builder._add_document_to_site
-        end
-      end
-    end
-  end
-end