bridgetown-prismic 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9490120f332e574829b9e86bb4e5cd8e116cc5d56459deaa6d008918d1259e7
-  data.tar.gz: 429b14738f5b6d15cee42b023085b71aa27ce69fcb9a108398efcabccc4aca33
+  metadata.gz: a64037c715098425b27a464a43b5f8cea1edaf1127b669fbc4df73405b9aede8
+  data.tar.gz: 1fa416c491f88cc63e8f20f09432888bfd02abdb83f5056570a7f621facfa797
 SHA512:
-  metadata.gz: 847aebd7f01e975dead3b109ff69d65171da42d1f2a163b1ebf2fc26ffffc5b54db23949ab7027687b20d5b02da6266a1bcb6c90191343658ddfe138d1be1e52
-  data.tar.gz: 1d3cde2d78fcd09a22fa26b67caec953a8f9074b101079ead246f74f6e1c19936b405c9e3857c56c9d97eb7612f3f9d459c4dadabe62800b24fbc42ed6920df9
+  metadata.gz: 942a5d2e94dbfb4dd6aca256d1313bbbfd1cca88f5e540ff4f72ddb954c144fcfca5abb527900ff5caec1f9cb285c93e1d77edbcd47f470814da97e97c6c4552
+  data.tar.gz: 425c8b63a93eb13393cb77ce6f14de8b8f13dcd2f8da8af0c5330badacf3a5f6219fd0bf7b21303add95484a4361d02bbf9c3d5a96b53fc908fe89e8cdf53cab

data/CHANGELOG.md

@@ -9,6 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ...
 
+## 0.2.3
+
+- Register resource extensions upfront
+
+## 0.2.2
+
+- Lock Async dependency to < 2.0 until fiber race condition is resolved
+
+## 0.2.1
+
+- Fix issue where link resolvers didn't provide the full document
+
 ## 0.2.0
 
 - Automatically paginate through results sets

data/README.md

@@ -115,7 +115,7 @@ end
 * `collection_name`: this can be a built-in collection such as `posts` or `pages`, or it can be a custom collection you've configured in `bridgetown.config.yml`.
 * `prismic_custom_type`: this will be the "API ID" of the custom type in Prismic.
 * `prismic_slug`: this should return the "slug" (aka `my-document-title`) of a Prismic document. In this example the slug Prismic chose is being used verbatim, but you can make alterations as you see fit.
-* `prismic_url`: this should return the full URL of the final destination for the content. It should match the permalink settings of your collection. This is used by the "link resolver"—aka anywhere in a Prismic document where you've added a link to another Prismic document, the URL for that link to resolved using this return value for the custom type.
+* `prismic_url`: this should return the full URL of the final destination for the content. It should match the permalink settings of your collection. This is used by the "link resolver"—aka anywhere in a Prismic document where you've added a link to another Prismic document, the URL for that link is resolved using this return value for the custom type.
 
 All right, with those options out of the way, on to the main event:
 
@@ -129,6 +129,7 @@ def self.process_prismic_document(doc)
     created_at        doc.first_publication_date
     date              doc["blog_post.optional_publish_datetime"]&.value&.localtime || created_at
 
+    layout            :post
     title             doc["blog_post.title"]          .as_text
     subtitle          doc["blog_post.subtitle"]       &.as_text
     author            doc["blog_post.author_name"]    &.as_text
@@ -141,7 +142,7 @@ end
 
 This where you create the 1:1 mappings between the Prismic fields and the "front matter" (aka data) + content of your model/resource. Any time you access the resource in templates by writing `resource.data.title` or `resource.content`, it will be pulling those values from these mappings.
 
-Within the `provide_data` block, you use a special Ruby DSL in a spreadsheet-like manner to set up the mappings. On the left-hand "column", you specify the name of the front matter variable (or content). In the middle column, you use Prismic's Ruby API to get a field value or metadata. On the right-hand column, you "coerce" the value into the type of data you'r looking for. Note that any field which the author hasn't filled in has a `nil` value, so you can see this is using Ruby's safe navigation operator `&` (whimsically known as the "lonely operator") most of the time so nil values won't crash the import process.
+Within the `provide_data` block, you use a special Ruby DSL in a spreadsheet-like manner to set up the mappings. On the left-hand "column", you specify the name of the front matter variable, as well as  `content` (optional but recommended). In the middle column, you use Prismic's Ruby API to get a field value or metadata. On the right-hand column, you "coerce" the value into the type of data you're looking for. Note that any field which the author hasn't filled in has a `nil` value, so you can see we're using Ruby's safe navigation operator `&` (whimsically known as the "lonely operator") most of the time so nil values won't crash the import process.
 
 You can [read more about Prismic's Ruby Document API here](https://prismic.io/docs/technologies/the-document-object-ruby) for information on when to use `value` or `as_text` or `url`, etc.
 
@@ -185,7 +186,7 @@ The Ruby DSL is pretty nifty, but you may occasionally run into a conflict betwe
 set :method, doc["page.method"].as_text
 ```
 
-Finally, if you decide to need to bail and want to provide a standard hash instead of using the Ruby DSL, you can do that too!
+Finally, if you decide to need to bail and want to provide a standard hash instead of using the Ruby DSL, you can do that too! It's not as flexible as the DSL because you can't arbitrarily insert multi-line statements of Ruby code within the data hash, but it's easy enough to understand:
 
 ```ruby
 def self.process_prismic_document(doc)
@@ -196,6 +197,7 @@ def self.process_prismic_document(doc)
     type:             doc.type,
     created_at:       doc.first_publication_date,
 
+    layout:           :post,
     title:            doc["test_page.title"]          .as_text,
 
     content:          doc["test_page.body"]           &.as_html(with_links),
@@ -205,6 +207,12 @@ end
 
 Just remember to put all your colons, commas, and parentheses in the right places! 😅
 
+### Mind your defaults!
+
+One gotcha to be aware of is that Prismic-sourced resources _will not pick up front matter defaults_ from any `_defaults.yml` files you may add to your `src` tree (for example in `src/_posts`). This is because `_defaults.yml` acts upon the file system directly, and resources originating from Prismic aren't part of the filesystem per se.
+
+However, you can definitely use the YAML-based front matter defaults which you add to `bridgetown.config.yml` to set defaults for any collection. In addition, you can put any "default" data directly in your model definitions (such as the `layout: post` example above).
+
 ### Trying Out Your Models
 
 The Bridgetown console is a good place to inspect your content. Just run `bin/bridgetown console` or `c` and then you can poke through your collections and see what's what.
@@ -236,7 +244,7 @@ Example for a Liquid layout:
 or an ERB layout:
 
 ```erb
-<% if site.data.prismic_preview_token %>
+<% if site.config.prismic_preview_token %>
   <p class="text-center" style="padding:7px; background:rgb(255, 230, 0); border-bottom:2px solid #333; margin:0; font-family:sans-serif; font-weight:bold; font-size:110%">
     PREVIEW
   </p>

data/bridgetown-prismic.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bridgetown", ">= 1.0.0.alpha8", "< 2.0"
   spec.add_dependency "prismic.io", ">= 1.8"
-  spec.add_dependency "async", ">= 1.30"
+  spec.add_dependency "async", ">= 1.30", "< 2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", ">= 13.0"

data/lib/bridgetown-prismic/api.rb

@@ -10,11 +10,22 @@ module BridgetownPrismic
         next "/preview/#{link.type}/#{link.id}" if site.config.prismic_preview_token
 
         if model_exists_for_prismic_type? link.type
-          model_for_prismic_type(link.type).prismic_url(link)
+          full_doc = Async do
+            Bridgetown::Current.site = site # ensure fiber has copy of the current site
+            site.config.prismic_api.getByID(link.id)
+          end.wait
+
+          model_for_prismic_type(link.type).prismic_url(full_doc)
         else
           "/"
         end
       end
+
+      Bridgetown::Model::Base.descendants.each do |klass|
+        next unless klass.respond_to?(:prismic_custom_type)
+
+        Bridgetown::Resource.register_extension klass
+      end
     end
 
     def query_prismic(custom_type, options = {})

data/lib/bridgetown-prismic/origin.rb

@@ -28,7 +28,6 @@ module BridgetownPrismic
         raise "Could not find a specialized model class for ID `#{id}'"
       end
 
-      Bridgetown::Resource.register_extension klass unless klass.extensions_have_been_registered
       @data = klass.prismic_data(self, @prismic_document)
       @data[:_id_] = id
       @data[:_origin_] = self

data/lib/bridgetown-prismic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownPrismic
-  VERSION = "0.2.0"
+  VERSION = "0.2.3"
 end

data/lib/bridgetown-prismic.rb

@@ -14,10 +14,6 @@ require_relative "bridgetown-prismic/origin"
 require_relative "bridgetown/utils/prismic_data"
 
 Bridgetown::Model::Base.class_eval do # rubocop:disable Metrics/BlockLength
-  class << self
-    attr_accessor :extensions_have_been_registered
-  end
-
   def self.import_prismic_document(doc) = new(BridgetownPrismic::Origin.import_document(doc))
 
   def self.with_links = Bridgetown::Current.site.config.prismic_link_resolver

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-prismic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -51,6 +51,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.30'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,6 +61,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.30'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A Prismic CMS integration plugin for Bridgetown