jekyll-notion 0.0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d1ccb2f2f5451b3eaf6d80dd8f8fed62cd2d5fd582d1cce09fbf10a494b54ac
-  data.tar.gz: f651dd2f6e3c5404b33af0abdb11274eacc34296c6301e9d79d76f38ccb8f1e6
+  metadata.gz: ad5bd5565352088d6d5d4048155a6abfb38bb0136437159ed7fdfd7d0aaf27a1
+  data.tar.gz: 57d4da4ceec1869150d33c9bdc10825a636de18409798725bf1ae891d1459b50
 SHA512:
-  metadata.gz: f87ce41674b28e289e7b69a0d4a40ac64fc0c9e9384ce5fdfb9b82312ba439ba60c5b7bab2a8ead2d1075adffd4a852bbae7534acc67d5317221c5fe236b52bf
-  data.tar.gz: 9ac472cd2c48b0affd89825b8d08a11fb8e562ac8da05193111bcc85f219196352345f4c6ebd6ff0b9721c847f00e30fc0820190fa8dd6950758355b24aafbd5
+  metadata.gz: 5749b831d1884f5d88b344d92ff924dc474813098b05dedfc0862a38dceada9ac8e31c9fd5a80ff418a3974d8ff61fd8879a2c7522dfb1bff2c02b133e82d83f
+  data.tar.gz: c10de414ceb372b5e2c2a29ba06878f69aaa6f01cc7d37b0a1a8f50078a55b92d4d63a2709e963f2da625ac73878008ae33a0c74c375ecf06f67b5b08c02a0cc

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
 ```
@@ -59,17 +59,56 @@ And that's all. Each page in the notion database will be included in the selecte
 
 Below, page notion default properties are set in each page frontmatter.
 
+Default properties include  `title`, created_time`, `last_edited_time`, `icon` and `cover.
+
 ```
 ---
-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_by`, `last_edited_by`, `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,22 +36,17 @@ module JekyllNotion
     end
 
     def make_frontmatter
-      data = Jekyll::Utils.deep_merge_hashes(config_frontmatter, notion_frontmatter)
-      page_frontmatter = data.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
+      data = Jekyll::Utils.deep_merge_hashes(config_frontmatter, page_frontmatter)
+      frontmatter = data.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
       <<~CONTENT
         ---
-        #{page_frontmatter}
+        #{frontmatter}
         ---
       CONTENT
     end
 
-    def notion_frontmatter
-      {
-        :id    => current_page.id,
-        :title => current_page.title,
-        :date  => current_page.created_datetime,
-        :cover => current_page.cover,
-      }
+    def page_frontmatter
+      Jekyll::Utils.deep_merge_hashes(current_page.custom_props, current_page.default_props)
     end
 
     def config_frontmatter

data/lib/jekyll-notion/notion_page.rb

@@ -46,5 +46,74 @@ 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)
+          multi_select = prop.multi_select.map(&:name).join(", ")
+          "[#{multi_select}]"
+        end
+
+        def select(prop)
+          prop["select"].name
+        end
+
+        def people(prop)
+          people = prop.people.map(&:name).join(", ")
+          "[#{people}]"
+        end
+
+        def files(prop)
+          files = prop.files.map { |f| f.file.url }.join(", ")
+          "[#{files}]"
+        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.1"
+  VERSION = "0.1.2"
 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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport