jekyll-notion 0.0.0.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6adb6c98a4e57b71ac16f6e2266c71b6063beedfd960ba022d74783c0c2e6e3
-  data.tar.gz: 3db8e7873189c0fcd1644d051f0e099f0498eca922158c1bac9f34bbb2a84b9d
+  metadata.gz: cb54ec7b63c705b241d71a4f631e06ceeb423b3cb880154ff23c4d28b4dafb9c
+  data.tar.gz: 4de1c60b106d86fe042b1a05690c5095165ac173535a103493c85cac24961abf
 SHA512:
-  metadata.gz: f9352dfc312103e5c846fe58b4053fa99cf93fedda66af3f037d21f6ccaba794b4589ec78b2b318a619d139d2025e0bedef0d03e364f0244a23d7ad835ae0d11
-  data.tar.gz: c88d36f84bbca91e46f892b64371fcf87baf2d06fa77ce41101841a7741ae90b5af79d8a756eb24c102b5843ad5fe00ed2638cdd7d0f843ee745b3172c06babb
+  metadata.gz: e2182b355e1732039b09838268c2decedf0498bf3ecb34db794267ad6c10455442f70c4de3219b07a777e2d0611628786b42a464e6fc914657694c5783f54410
+  data.tar.gz: ddbdb1b6caa7b1b19ecec525e9bc1e84df232db9ce1981dfa4daf87d4edc2302cd6bff92554c8f32f9a84567ce9b37d07be7fa4a213f3b6b31458fcd52a254ea

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.pre"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-notion
 version: !ruby/object:Gem::Version
-  version: 0.0.0.pre
+  version: 0.1.0
 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
@@ -144,9 +144,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project:
 rubygems_version: 2.7.3