bridgetown-prismic 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 228039775ada1cab1c61c74eed29302e9795b11ba594e14b31c77d3ba3478831
+  data.tar.gz: 2bfec49e77bddd821d6cb720b49bb4d2f4bb29c111ed155c7025657fbfe48704
+SHA512:
+  metadata.gz: 65717df7f3d68ae012027defb84dd4fb7becb3f19448dd8d0766bb0fe9a70408e126d8921608958a21bb9c674da44772924ff00fa5c5ed882f5f7fc12cdf52e8
+  data.tar.gz: 89f7e077090f5021cba067c8eb46a3a73c83f55ee71acbafea1234099e5d51015c326d62ce7a1092f2b2ee898c028981ed39ff2c1e1a3dcd16e5a97ee28f2d49

data/.gitignore

@@ -0,0 +1,38 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - vendor/**/*
+    - test/fixtures/**/*

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+...
+
+## 0.1.1
+
+- Fix bugs and test link resolvers
+- Better error handling and Roda preview assistance
+- Enforce `.html` for relative path
+
+## 0.1.0 (unreleased)
+
+- First version

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "shoulda"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Sample plugin for Bridgetown
+
+_NOTE: This isn't a real plugin! Copy this sample code and use it to create your own Ruby gem! [Help guide here…](https://www.bridgetownrb.com/docs/plugins)_ 😃
+
+_Starting with Bridgetown v0.15, you can run_ `bridgetown plugins new` _to easily set up a customized verison of this starter repo._
+
+A Bridgetown plugin to [fill in the blank]…
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add my-awesome-plugin -g bridgetown_plugins
+```
+
+Or if there's a `bridgetown.automation.rb` automation script, you can run that instead for guided setup:
+
+```ruby
+$ bundle exec bridgetown apply https://github.com/username/my-awesome-plugin
+```
+
+## Usage
+
+The plugin will…
+
+### Optional configuration options
+
+The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+
+…
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+----
+
+## Releasing (you can delete this section in your own plugin repo)
+
+To release a new version of the plugin, simply bump up the version number in both `version.rb` and
+`package.json`, and then run `script/release`. This will require you to have a registered account
+with both the [RubyGems.org](https://rubygems.org) and [NPM](https://www.npmjs.com) registries.
+You can optionally remove the `package.json` and `frontend` folder if you don't need to package frontend
+assets for Webpack.
+
+If you run into any problems or need further guidance, please check out our [Bridgetown community resources](https://www.bridgetownrb.com/docs/community)
+where friendly folks are standing by to help you build and release your plugin or theme.
+
+**NOTE:** make sure you add the `bridgetown-plugin` [topic](https://github.com/topics/bridgetown-plugin) to your
+plugin's GitHub repo so the plugin or theme will show up on [Bridgetown's official Plugin Directory](https://www.bridgetownrb.com/plugins)! (There may be a day or so delay before you see it appear.)

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown-prismic.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-prismic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-prismic"
+  spec.version       = BridgetownPrismic::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Sample code for creating new Bridgetown plugins"
+  spec.homepage      = "https://github.com/username/bridgetown-prismic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.0"
+
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+end

data/bridgetown.automation.rb

@@ -0,0 +1,14 @@
+add_bridgetown_plugin("bridgetown-prismic")
+
+append_to_file "bridgetown.config.yml" do
+  <<~YAML
+
+    # Prismic config:
+    prismic_repository: repo_name_here
+    autoload_paths:
+      - path: models
+        eager: true
+  YAML
+end
+
+create_file "models/post.rb", File.read(File.join(__dir__, "test", "fixtures", "models", "post.rb")

data/lib/bridgetown/utils/prismic_data.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Utils
+    class PrismicData < RubyFrontMatter
+      def with_links = Bridgetown::Current.site.config.prismic_link_resolver
+
+      def provide_data(&block)
+        if @provided_called
+          return PrismicData.new(scope: @scope).tap { |fm| fm.instance_exec(&block) }.to_h
+        end
+
+        @provided_called = true
+        instance_exec(&block)
+
+        nil
+      end
+
+      def reset_stack
+        @provided_called = false
+      end
+    end
+  end
+end

data/lib/bridgetown-prismic/api.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module BridgetownPrismic
+  module API
+    def configure_prismic # rubocop:disable Metrics/AbcSize
+      Bridgetown.logger.info "Prismic API:",
+                             "Connecting to #{site.config.prismic_repository.yellow}..."
+      site.config.prismic_api = Prismic.api("https://#{site.config.prismic_repository}.cdn.prismic.io/api")
+      site.config.prismic_link_resolver ||= Prismic::LinkResolver.new(nil) do |link|
+        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)
+        else
+          "/"
+        end
+      end
+    end
+
+    def query_prismic(custom_type, options = {})
+      Bridgetown.logger.info "Prismic API:", "Loading #{custom_type.to_s.green}..."
+
+      BridgetownPrismic
+        .api
+        .query(Prismic::Predicates.at("document.type", custom_type.to_s), options)
+        .results
+    end
+
+    def query_prismic_and_generate_resources_for(klass)
+      query_options = {}
+
+      query_prismic(klass.prismic_custom_type, query_options)
+        .map { |doc| klass.import_prismic_document(doc) }
+        .each(&:as_resource_in_collection)
+    end
+
+    def model_for_prismic_type(type)
+      Bridgetown::Model::Base.descendants.find do |klass|
+        klass.respond_to?(:prismic_custom_type) && klass.prismic_custom_type == type.to_sym
+      end
+    end
+
+    def prismic_types
+      Bridgetown::Model::Base.descendants.filter_map do |klass|
+        klass.respond_to?(:prismic_custom_type) ? klass.prismic_custom_type : nil
+      end
+    end
+
+    def model_exists_for_prismic_type?(type)
+      prismic_types.include? type.to_sym
+    end
+  end
+end

data/lib/bridgetown-prismic/builder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BridgetownPrismic
+  class Builder < Bridgetown::Builder
+    include BridgetownPrismic::API
+
+    def build
+      configure_prismic # in API module
+
+      return if site.ssr?
+
+      load_prismic_documents
+    end
+
+    def load_prismic_documents
+      batches = []
+      Async do |task|
+        prismic_types.map do |type|
+          task.async do
+            Bridgetown::Current.site = site # ensure fiber has copy of the current site
+            klass = model_for_prismic_type(type)
+            batches.push [klass, query_prismic(klass.prismic_custom_type, {})]
+          end
+        end
+      end
+
+      batches.each do |batch|
+        klass, docs = batch
+        docs.map { |doc| klass.import_prismic_document(doc) }.each(&:as_resource_in_collection)
+      end
+    end
+  end
+end
+
+BridgetownPrismic::Builder.register

data/lib/bridgetown-prismic/origin.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module BridgetownPrismic
+  class Origin < Bridgetown::Model::Origin
+    # @return [Pathname]
+    attr_reader :relative_path
+
+    attr_reader :prismic_document
+
+    def self.handle_scheme?(scheme) = scheme == "prismic"
+
+    def self.import_document(document) = new("prismic://#{document.type}/#{document.id}",
+                                             document).read
+
+    def initialize(id, prismic_document = nil)
+      super(id)
+      @relative_path = Pathname.new("#{id.delete_prefix("prismic://")}.html")
+      @prismic_document = prismic_document # could be nil, so model should load preview instance
+    end
+
+    def verify_model?(klass)
+      klass.prismic_custom_type.to_s == URI.parse(id).host
+    end
+
+    def read
+      klass = Bridgetown::Model::Base.klass_for_id(id)
+      if klass.name == "Bridgetown::Model::Base"
+        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
+    end
+
+    def exists?
+      false
+    end
+  end
+end

data/lib/bridgetown-prismic/roda/previews.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BridgetownPrismic
+  module Roda
+    module Previews
+      def prismic_preview_token
+        request.params["token"] || request.cookies[Prismic::PREVIEW_COOKIE]
+      end
+
+      def save_prismic_preview_token
+        bridgetown_site.config.prismic_preview_token = prismic_preview_token
+      end
+
+      def prismic_preview_redirect_url
+        save_prismic_preview_token
+        response.set_cookie Prismic::PREVIEW_COOKIE, bridgetown_site.config.prismic_preview_token
+        BridgetownPrismic.api.preview_session(
+          bridgetown_site.config.prismic_preview_token,
+          bridgetown_site.config.prismic_link_resolver,
+          "/"
+        )
+      end
+
+      def prismic_token_error_msg
+        "A valid Prismic preview token was not provided."
+      end
+    end
+  end
+end

data/lib/bridgetown-prismic/version.rb

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

data/lib/bridgetown-prismic.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "prismic"
+require "async"
+
+module BridgetownPrismic
+  def self.api = Bridgetown::Current.site.config.prismic_api
+end
+
+require_relative "bridgetown-prismic/api"
+require_relative "bridgetown-prismic/builder"
+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
+
+  def self.provide_data(&block)
+    @prismic_data.provide_data(&block)
+  end
+
+  def self.prismic_data(origin, doc = nil) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+    site = Bridgetown::Current.site
+    @prismic_data = Bridgetown::Utils::PrismicData.new(scope: self)
+
+    unless doc
+      prismic_id = origin.id.split("/").last
+      # NOTE: if site.config.prismic_preview_token isn't set, it will default to
+      # master (published) ref
+      doc = site.config.prismic_api.getByID(prismic_id, { ref: site.config.prismic_preview_token })
+    end
+
+    @prismic_data = @prismic_data.tap do
+      process_prismic_document(doc)
+    rescue StandardError => e
+      doc_title = doc["#{doc.type}.title"] ? ", Title: #{doc["#{doc.type}.title"].as_text}" : ""
+      Bridgetown.logger.error "Prismic API:", "Error while importing `#{doc.type}':"
+      Bridgetown.logger.error "Prismic API:", "Slug: #{doc.slug}#{doc_title}"
+      raise e
+    end.to_h
+
+    if @prismic_data[:content]
+      @prismic_data[:_content_] = @prismic_data[:content]
+      @prismic_data.delete :content
+    end
+    @prismic_data[:_collection_] = Bridgetown::Current.site.collections[collection_name]
+    @prismic_data[:prismic_doc] = doc if Bridgetown.env.development? # good for debugging
+
+    @prismic_data.tap do # return data while setting the ivar to nil
+      @prismic_data = nil
+    end
+  end
+
+  def prismic_document
+    return nil unless origin.is_a?(BridgetownPrismic::Origin)
+
+    origin.prismic_document
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-prismic
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: prismic.io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.30'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-prismic.gemspec
+- bridgetown.automation.rb
+- lib/bridgetown-prismic.rb
+- lib/bridgetown-prismic/api.rb
+- lib/bridgetown-prismic/builder.rb
+- lib/bridgetown-prismic/origin.rb
+- lib/bridgetown-prismic/roda/previews.rb
+- lib/bridgetown-prismic/version.rb
+- lib/bridgetown/utils/prismic_data.rb
+homepage: https://github.com/username/bridgetown-prismic
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Sample code for creating new Bridgetown plugins
+test_files: []