jekyll-notion 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47fd2ef3b63206ceb2e5ca1933daf4eb90bf283703371c4497c73f9beafd23f4
-  data.tar.gz: e44cf9e5a3b3b44a0e02b48334375df9e8afe779b7745bdbc146baff3e8de903
+  metadata.gz: cb54ec7b63c705b241d71a4f631e06ceeb423b3cb880154ff23c4d28b4dafb9c
+  data.tar.gz: 4de1c60b106d86fe042b1a05690c5095165ac173535a103493c85cac24961abf
 SHA512:
-  metadata.gz: 281ae8dca0453fb7a498a4457863b666ab7363bcca6e11d707843b35c9b81df91f5dfb6c7073a8af0c8f640560fbc9407c97e101495bef480dd8236c0f013f38
-  data.tar.gz: e915dc5d190bda6caae8b4942929fdc506ed4ae171e0a8cce126f0d2bee42d1ab5503205f970ee279f58a706c23e9684c0076a6c42e0d1eb856270e7effcad8c
+  metadata.gz: e2182b355e1732039b09838268c2decedf0498bf3ecb34db794267ad6c10455442f70c4de3219b07a777e2d0611628786b42a464e6fc914657694c5783f54410
+  data.tar.gz: ddbdb1b6caa7b1b19ecec525e9bc1e84df232db9ce1981dfa4daf87d4edc2302cd6bff92554c8f32f9a84567ce9b37d07be7fa4a213f3b6b31458fcd52a254ea

data/README.md

@@ -61,16 +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
-icon: icon > emoji
+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,23 +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,
-        :icon  => current_page.icon,
-      }
+    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,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.2"
+  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.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-23 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport