jekyll-notion 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dadf92a4c00ce112ad5ca51e136b676a380b54fedfa75a9488ce5437d56a71d1
-  data.tar.gz: df4431eab3308f7502082196c9d8bb8518b340c94d7c76950f0430664769afa1
+  metadata.gz: a99d9e0d1e2b47634401803cdd361f608540db56b02d8599a1723da1d8be635d
+  data.tar.gz: eb0c99a5c4d9f90e54c2b1c5111d3ae916cc92775c550760e82f87765e31011f
 SHA512:
-  metadata.gz: 6d4aba49009378a8ca3e298d1de97d5285854bc5282c1aedb6e43ad7d6406a60baa0cfae614f33d027fa7a94353f2d03bd93405d6c8b60ac0ea72639a7f50f26
-  data.tar.gz: 79bc2b133cd57a4da85216433564963ac56a49120ac36ed15aa8bb585fce64b54751f8a635816c1c9fc6afd968ad6289e4cc1dea854cee85576753cfd22e1397
+  metadata.gz: 06f5e378e96a41cf66bdf21e751165be504fdec9d3263b6a1db6a6a30e7c082d3988310d74bab49b35f2f330a1db244e42ce9fc31308fa42ee4c41a88e09a023
+  data.tar.gz: 7c4c1f8f39d728d3a830d6b3aa7ebfb96483a4823f14756ec40b388d0b2e79b7aba68371c1f5ae9feea3070f8d1e8a8265ef526045b315d17370e7bbd2686237

data/README.md

@@ -24,9 +24,9 @@ plugins:
 
 ## Usage
 
-Before using the gem create an integration and generate a secret token. Check [notion getting started guide](https://developers.notion.com/docs/getting-started) to learn more.
+Before using the gem, create an integration and generate a secret token. For more in-depth instructions, refer to the Notion "Getting Started" [guide](https://developers.notion.com/docs/getting-started).
 
-Once you have youe secret, export it in an environment variable named `NOTION_TOKEN`.
+Once you have your secret token, make sure to export it into an environment variable named `NOTION_TOKEN`.
 
 ```bash
 $ export NOTION_TOKEN=<secret_...>
@@ -34,7 +34,7 @@ $ export NOTION_TOKEN=<secret_...>
 
 ### Databases
 
-Once the [notion database](https://www.notion.so/help/intro-to-databases) has been shared, specify the database `id` in the `_config.yml` file as follows.
+Once the [notion database](https://developers.notion.com/docs/working-with-databases) has been shared, specify the database `id` in the `_config.yml` file as follows.
 
 ```yml
 notion:
@@ -155,6 +155,42 @@ notion:
 
 And that's all. Each page in the notion database will be included in the selected collection.
 
+### Cache
+
+Starting from version 2.4.0, every request to Notion is cached locally. The cache enables the retrieval of Notion resources only during the first request. Subsequent requests are fetched from the cache, which can significantly reduce build times.
+
+The cache mechanism is based on the [vcr](https://github.com/vcr/vcr) gem, which records HTTP requests. Every Notion resource, whether it is a database or page, is stored in an independent file using the document ID as the filename. For example, a database ID e42383cd49754897b967ce453760499f will be stored in the following path:
+
+```bash
+.cache/jekyll-notion/vcr_cassetes/e42383cd49754897b967ce453760499f.yml
+```
+
+**Note: The `cache` option invalidates the fetch_on_watch feature.**
+
+#### Cache folder
+
+By default, the cache folder is `.cache/jekyll-notion/vcr_cassetes`, but you can change this folder by setting the `cache_dir` property in the `_config.yml` file as follows.
+
+```yaml
+notion:
+  cache_dir: another/folder
+```
+
+The path must be relative to the working folder.
+
+#### Cleaning cache
+
+To clear the cache, delete the cache folder. If you want to remove a specific cache file, locate the file that matches the Notion resource ID and delete it.
+
+#### Disabling cache
+
+If you're not interested in the cache or you just want to disable it, set the ˋcache` option to false.
+
+```yaml
+notion:
+  cache: false
+```
+
 ## Notion properties
 
 Notion page properties are set for each document in the front matter.

data/lib/jekyll-notion/abstract_notion_resource.rb

@@ -39,7 +39,7 @@ module JekyllNotion
     end
 
     def build_blocks(block_id)
-      NotionToMd::Blocks.build(block_id: block_id) do |nested_id|
+      NotionToMd::Blocks.build(:block_id => block_id) do |nested_id|
         @notion.block_children({ :block_id => nested_id })
       end
     end

data/lib/jekyll-notion/cacheable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+#
+
+module JekyllNotion
+  module Cacheable
+    def self.setup(cache_dir)
+      # Using VCR to record and playback Notion API responses for caching
+      VCR.configure do |config|
+        config.cassette_library_dir = cache_path(cache_dir)
+        config.hook_into :faraday # Faraday is used by notion-ruby-client gem
+        config.filter_sensitive_data("<NOTION_TOKEN>") { ENV["NOTION_TOKEN"] }
+        config.allow_http_connections_when_no_cassette = true
+        config.default_cassette_options = {
+          :allow_playback_repeats => true,
+          :record                 => :new_episodes,
+        }
+      end
+    end
+
+    def self.cache_path(path = nil)
+      if path.nil?
+        File.join(Dir.getwd, ".cache", "jekyll-notion", "vcr_cassettes")
+      else
+        File.join(Dir.getwd, path)
+      end
+    end
+
+    def database_query(*args)
+      VCR.use_cassette((args[0][:database_id]).to_s) { super(*args) }
+    end
+
+    def block_children(*args)
+      VCR.use_cassette((args[0][:block_id]).to_s) { super(*args) }
+    end
+
+    def page(*args)
+      VCR.use_cassette((args[0][:page_id]).to_s) { super(*args) }
+    end
+  end
+end

data/lib/jekyll-notion/generator.rb

@@ -9,6 +9,8 @@ module JekyllNotion
 
       return unless notion_token? && config?
 
+      setup
+
       if fetch_on_watch? || cache_empty?
         read_notion_databases
         read_notion_pages
@@ -78,7 +80,8 @@ module JekyllNotion
 
     def notion_token?
       if ENV["NOTION_TOKEN"].nil? || ENV["NOTION_TOKEN"].empty?
-        Jekyll.logger.warn("Jekyll Notion:", "NOTION_TOKEN not provided. Cannot read from Notion.")
+        Jekyll.logger.warn("Jekyll Notion:",
+                           "Cannot read from Notion becuase NOTION_TOKEN was not provided")
         return false
       end
       true
@@ -86,10 +89,24 @@ module JekyllNotion
 
     def config?
       if config.empty?
-        Jekyll.logger.warn("Jekyll Notion:", "No config provided.")
+        Jekyll.logger.warn("Jekyll Notion:", "No configuration provided")
         return false
       end
       true
     end
+
+    def setup
+      # Cache Notion API responses
+      if ENV["JEKYLL_ENV"] != "test" && cache?
+        JekyllNotion::Cacheable.setup(config["cache_dir"])
+        Notion::Client.prepend JekyllNotion::Cacheable
+      end
+    end
+
+    def cache?
+      return true if config["cache"].nil?
+
+      config["cache"] == true.to_s
+    end
   end
 end

data/lib/jekyll-notion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllNotion
-  VERSION = "2.3.2"
+  VERSION = "2.4.0"
 end

data/lib/jekyll-notion.rb

@@ -5,6 +5,7 @@ require "notion"
 require "notion_to_md"
 require "logger"
 require "jekyll-notion/generator"
+require "vcr"
 
 NotionToMd::Logger.level = Logger::ERROR
 
@@ -24,4 +25,5 @@ module JekyllNotion
   autoload :AbstractNotionResource, "jekyll-notion/abstract_notion_resource"
   autoload :NotionDatabase, "jekyll-notion/notion_database"
   autoload :NotionPage, "jekyll-notion/notion_page"
+  autoload :Cacheable, "jekyll-notion/cacheable"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-notion
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +139,7 @@ files:
 - README.md
 - lib/jekyll-notion.rb
 - lib/jekyll-notion/abstract_notion_resource.rb
+- lib/jekyll-notion/cacheable.rb
 - lib/jekyll-notion/document_without_a_file.rb
 - lib/jekyll-notion/factories/database_factory.rb
 - lib/jekyll-notion/factories/page_factory.rb