jekyll-notion 0.0.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72643f8e9760b1f45a30fd87a8448cf16b1f85a63bcec6c83b4d4b3dea8b4c21
-  data.tar.gz: 95b0c61bdfc5e7c6dc018798474dcd40e6ec0728c0836d552249b9b7da8213bf
+  metadata.gz: ea3659b155864441e1d6eb08111597ce11ffec1891011ed9f7c7724dcbc7d186
+  data.tar.gz: 2e6ecac50f3d6aaae6e3af587d362f5470054452552e2dc1691d25e1abead605
 SHA512:
-  metadata.gz: daf22fba12e6385aaa5842103c390ee6f58c093bf5ee1b199700c769a45d7736f04600f71cc0bcdedd77018a547024f8bdaf517a842cd88d58f13af4a77d57c9
-  data.tar.gz: 4d28a3d8319345e1a936ac3112009568a1d693cbd3314783fdea12d4c1cca38da33f701b25d870eb1cebf0fc11347f849979fcfee94a9d98173d33e376e50bec
+  metadata.gz: 5698ea2735469d130cbec72aee61facd213589f1e349dd7d29588214896f931d2d8c740a36f5d7d2f36d83ca9a9b5fd976806c3c135eca7e201eac13f4b98d97
+  data.tar.gz: 7cad325c6ce2cf4e3216f086693b40ead4cc7b176826c1f26efb33b98e342d92ee285d9ed22f9d84b6e4eced090a227ef88bbf5139dc662c2067c9bec79f08f0

data/README.md

@@ -40,7 +40,7 @@ notion:
     id: b91d5...
     collection: posts
     filter: { "property": "Published", "checkbox": { "equals": true } }
-    sort: { "propery": "Last ordered", "direction": "ascending" }
+    sort: { "property": "Last ordered", "direction": "ascending" }
     frontmatter:
       layout: post
 ```
@@ -61,13 +61,52 @@ Below, page notion default properties are set in each page frontmatter.
 
 ```
 ---
-id: id
-title: properties > Name > title > plain_text
-cover: cover > external > url
-date: created_time
+id: b2998...
+title: A title
+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.
+
+### 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.
+For example, two properties named `Multiple Options` and `Tags` will be transformed to `multiple_options` and `tags`, respectively.
+
+```
+---
+id: b2998...
+title: A title
+cover: https://img.bank.sh/an_image.jpg
+date: 2022-01-23T12:31:00.000Z
+icon: \U0001F4A5
+tags: tag1, tag2, tag3
+multiple_options: option1, option2
+---
+```
+
+The supported properties are:
+
+* `number`
+* `select`
+* `multi_select`
+* `date`
+* `people`
+* `files`
+* `checkbox`
+* `url`
+* `email`
+* `phone_number`
+
+`created_time`, `last_edited_time`, `created_by`, `last_edited_by`, `title`, `rich_text` as advanced types like `formula`, `relation` and `rollup` are not supported.
+
+Check notion documentation about [property values](https://developers.notion.com/reference/property-value-object#all-property-values).
+
 ## Page filename
 
 There are two kinds of collections: posts and others.

data/lib/jekyll-notion/generator.rb

@@ -36,19 +36,21 @@ module JekyllNotion
     end
 
     def make_frontmatter
+      data = Jekyll::Utils.deep_merge_hashes(config_frontmatter, page_frontmatter)
+      frontmatter = data.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
       <<~CONTENT
         ---
-        id: #{current_page.id}
-        title: #{current_page.title}
-        date: #{current_page.created_datetime}
-        cover: #{current_page.cover}
         #{frontmatter}
         ---
       CONTENT
     end
 
-    def frontmatter
-      config.dig("database", "frontmatter").to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
+    def page_frontmatter
+      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

data/lib/jekyll-notion/notion_page.rb

@@ -46,5 +46,71 @@ module JekyllNotion
     def url
       page[:url]
     end
+
+    def custom_props
+      @custom_props ||= page.properties.each_with_object({}) do |prop, memo|
+        name = prop.first
+        value = prop.last # Notion::Messages::Message
+        type = value.type
+
+        next memo unless CustomProperty.respond_to?(type.to_sym)
+
+        memo[name.parameterize.underscore] = CustomProperty.send(type, value)
+      end.reject { |_k, v| v.presence.nil? }
+    end
+
+    def default_props
+      @default_props ||= {
+        :id           => id,
+        :title        => title,
+        :date         => created_datetime,
+        :cover        => cover,
+        :icon         => icon,
+        :updated_date => updated_datetime,
+      }
+    end
+
+    class CustomProperty
+      class << self
+        def multi_select(prop)
+          prop.multi_select.map(&:name).join(", ")
+        end
+
+        def select(prop)
+          prop["select"].name
+        end
+
+        def people(prop)
+          prop.people.map(&:name).join(", ")
+        end
+
+        def files(prop)
+          prop.files.map { |f| f.file.url }.join(", ")
+        end
+
+        def phone_number(prop)
+          prop.phone_number
+        end
+
+        def number(prop)
+          prop.number
+        end
+
+        def email(prop)
+          prop.email
+        end
+
+        def checkbox(prop)
+          prop.checkbox.to_s
+        end
+
+        # date type properties not supported:
+        # - end
+        # - time_zone
+        def date(prop)
+          prop.date.start
+        end
+      end
+    end
   end
 end

data/lib/jekyll-notion/version.rb

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

data/lib/jekyll-notion.rb

@@ -5,6 +5,7 @@ require "notion"
 require "notion_to_md"
 require "logger"
 require "active_support/inflector"
+require "active_support/core_ext/object/blank"
 require "jekyll-notion/generator"
 
 NotionToMd::Logger.level = Logger::ERROR

metadata

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