jekyll-notion 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e49bed0932098925103231f77ac375ff0d86562ffb762c058c41b4db5e6ca091
-  data.tar.gz: 22e172d0c20d1b4dd9bbd4c926010a06492be08f247abe18f99795182ce1f319
+  metadata.gz: '051289989a623c954ef76ca1299a79a4499649dea4b94dfe49ac75f9a67d4bbc'
+  data.tar.gz: 5de9f6860672c7eb8cdc355b5c5af3257fdc476cba3a5d20b4a420f330189f7e
 SHA512:
-  metadata.gz: 8f9a68ae342fb7c23c24b9b744afc1c562a7f33bd270207bb8b4b0cd52306d393c95ed4b4e9571605437dd3c1d4bc2a44f0ec029889158dd54fbe4932aaea9d7
-  data.tar.gz: eb5e8580bbd76add336f6fb0f2ee68efe3c4a807ddfbf3657054088288ebd787803babb3d7e00b0a392eb2feee14aca6629071924352a4e378672b52547409d6
+  metadata.gz: 211bcfcf58c3d5e0d1e9d684a7a8483e31882e9b2d81df5e8770a24a62ed7c82334d9481a9138dc6c3285fa3e0585facca6f2f68bcbb1b6d769595c5d9051774
+  data.tar.gz: 3d5d03c0223c1e891f5ba1102defb082638b67bd9e07cbfc56e2beeadc93e650ed8b2b758543a0a8afe6f8c36a2ad6ca33dd300955fbbc009b7260e509a7e21d

data/README.md

@@ -32,12 +32,44 @@ Export the notion secret token in an environment variable named `NOTION_TOKEN`.
 $ export NOTION_TOKEN=<secret_...>
 ```
 
-Once your notion database has been shared, specify the `id` in your `_config.yml` as follows.
+Once your notion database has been shared, specify the  database `id` in your `_config.yml` as follows.
 
 ```yml
 notion:
   database:
-    id: b91d5...
+    id: e42383cd-4975-4897-b967-ce453760499f
+```
+
+### Mutiple dabatases
+
+You can also define multiple databases as follows.
+
+```yml
+notion:
+  databases:
+    - id: b0e688e1-99af-4295-ae80-b67eb52f2e2f
+    - id: 2190450d-4cb3-4739-a5c8-340c4110fe21
+      collection: recipes
+    - id: e42383cd-4975-4897-b967-ce453760499f 
+      collection: films
+```
+
+When no collection is defined, the `posts` collection is used by default.
+
+### Database options
+
+Each dabatase support the following options.
+
+* `id`: the notion database unique identifier,
+* `collection`: the collection each page belongs to (posts by default),
+* `filter`: the database query filter,
+* `sort`: the database query sort,
+* `frontmatter`: additional front matter to append to each page in the collection.
+
+```yml
+notion:
+  database:
+    id: e42383cd-4975-4897-b967-ce453760499f
     collection: posts
     filter: { "property": "Published", "checkbox": { "equals": true } }
     sort: { "property": "Last ordered", "direction": "ascending" }
@@ -45,44 +77,51 @@ notion:
       layout: post
 ```
 
-The other properties are:
-* `collection`: the collection each page belongs to (posts by default),
-* `filter`: the database query filter,
-* `sort`: the database query sort,
-* `frontmatter`: additional frontmatter to append to each page in the collection.
+Note that you can also use [front matter defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) to declare common key value pairs per collection.
+
+### Watch
 
-Note: Only one database is available.
+By default, databases are only requested during the first build. Subsequent builds use the results from the cache.
+
+Set `fetch_on_watch` to true to allow request on each rebuild.
+
+```yml
+notion:
+  fetch_on_watch: true
+  database:
+    id: e42383cd-4975-4897-b967-ce453760499f
+```
 
 And that's all. Each page in the notion database will be included in the selected collection.
 
 ## Notion properties
 
-Below, page notion default properties are set in each page frontmatter.
+Below, default properties per notion page are set for each document front matter.
 
-Default properties include  `title`, created_time`, `last_edited_time`, `icon` and `cover.
+Notion properties include page `id`, `title`, `created_time`, `last_edited_time`, `icon` and `cover`.
 
 ```
 ---
-id: b2998...
-title: A title
+id: e42383cd-4975-4897-b967-ce453760499f
+title: An amazing post
 cover: https://img.bank.sh/an_image.jpg
 date: 2022-01-23T12:31:00.000Z
 icon: \U0001F4A5
 ---
 ```
 
-Any property provided in the frontmatter config that matches a default property will be overwritten by the default value.
+Default properties prevail over custom properties declared in the front matter config.
 
 ### Custom properties
 
 In addition to default properties, custom properties are also supported.
 
-Custom properties are appended to page frontmatter by default. Every property name is snake-cased.
+Custom properties are appended to the page frontmatter by default. Every property name are downcased and snake-cased.
 For example, two properties named `Multiple Options` and `Tags` will be transformed to `multiple_options` and `tags`, respectively.
 
 ```
 ---
-id: b2998...
+id: 2190450d-4cb3-4739-a5c8-340c4110fe21
 title: A title
 cover: https://img.bank.sh/an_image.jpg
 date: 2022-01-23T12:31:00.000Z
@@ -92,7 +131,7 @@ multiple_options: option1, option2
 ---
 ```
 
-The supported properties are:
+The supported property types are:
 
 * `number`
 * `select`

data/lib/jekyll-notion/generator.rb

@@ -2,29 +2,47 @@
 
 module JekyllNotion
   class Generator < Jekyll::Generator
-    attr_reader :current_page
+    attr_reader :current_page, :current_db
 
     def generate(site)
       @site = site
 
       return unless notion_token? && config?
 
-      read_notion_database
+      if fetch_on_watch? || collections.empty?
+        read_notion_database
+      else
+        collections.each_pair { |key, val| @site.collections[key] = val }
+      end
     end
 
+    protected
+
     def read_notion_database
-      @db = NotionDatabase.new(:config => config)
-      @db.pages.each do |page|
-        @current_page = page
-        collection.docs << make_page
-        Jekyll.logger.info("Jekyll Notion:", "New notion page at #{collection.docs.last.path}")
+      databases.each do |db_config|
+        @current_db = NotionDatabase.new(:config => db_config)
+        @current_db.pages.each do |page|
+          @current_page = page
+          current_collection.docs << make_page
+          log_new_page
+        end
+        # Store current collection
+        collections[current_db.collection] = current_collection
       end
     end
 
+    def databases
+      config["databases"] || [config["database"]]
+    end
+
+    def collections
+      @collections ||= {}
+    end
+
     def make_page
       new_post = DocumentWithoutAFile.new(
-        "#{Dir.pwd}/_#{collection_name}/#{make_filename}",
-        { :site => @site, :collection => collection }
+        "#{Dir.pwd}/_#{current_db.collection}/#{make_filename}",
+        { :site => @site, :collection => current_collection }
       )
       new_post.content = "#{make_frontmatter}\n\n#{make_md}"
       new_post.read
@@ -36,7 +54,7 @@ module JekyllNotion
     end
 
     def make_frontmatter
-      data = Jekyll::Utils.deep_merge_hashes(config_frontmatter, page_frontmatter)
+      data = Jekyll::Utils.deep_merge_hashes(current_db.frontmatter, page_frontmatter)
       frontmatter = data.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
       <<~CONTENT
         ---
@@ -49,30 +67,27 @@ module JekyllNotion
       Jekyll::Utils.deep_merge_hashes(current_page.custom_props, current_page.default_props)
     end
 
-    def config_frontmatter
-      config.dig("database", "frontmatter") || {}
-    end
-
     def make_filename
-      if collection_name == "posts"
-        "#{current_page.created_date}-#{current_page.title.downcase.parameterize}.md"
+      if current_db.collection == "posts"
+        "#{current_page.created_date}-#{Jekyll::Utils.slugify(current_page.title,
+                                                              :mode => "latin")}.md"
       else
         "#{current_page.title.downcase.parameterize}.md"
       end
     end
 
-    def collection_name
-      config.dig("database", "collection") || "posts"
-    end
-
-    def collection
-      @site.collections[collection_name]
+    def current_collection
+      @site.collections[current_db.collection]
     end
 
     def config
       @config ||= @site.config["notion"] || {}
     end
 
+    def fetch_on_watch?
+      config["fetch_on_watch"].present?
+    end
+
     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.")
@@ -88,5 +103,16 @@ module JekyllNotion
       end
       true
     end
+
+    def log_new_page
+      Jekyll.logger.info("Jekyll Notion:", "Page => #{current_page.title}")
+      if @site.config.dig(
+        "collections", current_db.collection, "output"
+      )
+        Jekyll.logger.info("",
+                           "Path => #{current_collection.docs.last.path}")
+      end
+      Jekyll.logger.debug("", "Props => #{page_frontmatter.keys.inspect}")
+    end
   end
 end

data/lib/jekyll-notion/notion_database.rb

@@ -11,28 +11,40 @@ module JekyllNotion
       return [] unless id?
 
       @pages ||= @notion.database_query(query)[:results].map do |page|
-        NotionPage.new(:page => page, :layout => config["layout"])
+        NotionPage.new(:page => page, :layout => layout)
       end
     end
 
-    private
-
     def config
-      @config["database"]
+      @config || {}
     end
 
     def filter
-      @config.dig("database", "filter")
+      config["filter"]
     end
 
     def sort
-      @config.dig("database", "sort")
+      config["sort"]
     end
 
     def id
-      @config.dig("database", "id")
+      config["id"]
+    end
+
+    def frontmatter
+      config["frontmatter"] || {}
+    end
+
+    def collection
+      config["collection"] || "posts"
+    end
+
+    def layout
+      config["layout"]
     end
 
+    private
+
     def id?
       if id.nil? || id.empty?
         Jekyll.logger.warn("Jekyll Notion:",
@@ -43,7 +55,7 @@ module JekyllNotion
     end
 
     def query
-      { :id => id, :filter => filter, :sort => sort }
+      { :id => id, :filter => filter, :sort => sort }.compact
     end
   end
 end

data/lib/jekyll-notion/notion_page.rb

@@ -61,12 +61,12 @@ module JekyllNotion
 
     def default_props
       @default_props ||= {
-        :id           => id,
-        :title        => title,
-        :date         => created_datetime,
-        :cover        => cover,
-        :icon         => icon,
-        :updated_date => updated_datetime,
+        "id"           => id,
+        "title"        => title,
+        "date"         => created_datetime,
+        "cover"        => cover,
+        "icon"         => icon,
+        "updated_date" => updated_datetime,
       }
     end
 
@@ -113,6 +113,10 @@ module JekyllNotion
         def date(prop)
           prop.date.start
         end
+
+        def url(prop)
+          prop.url
+        end
       end
     end
   end

data/lib/jekyll-notion/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-notion
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-30 00:00:00.000000000 Z
+date: 2022-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport