notion_to_md 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ebe548eec487347104eabbac6911836cef0ec6e5ea350cb9a376ef8e07ce50
-  data.tar.gz: b2fd0700b53683daa6e59a729418139bbdee41da8184dad57eff0f2c17578dc7
+  metadata.gz: 924eafad078f99447e1a9d88403d48448e5011c87a9d2ae32b527a9e4a201f85
+  data.tar.gz: 791bf46ea8cfbb49958cc80862fe63047e1158f4845f21665ce21d20b37628ad
 SHA512:
-  metadata.gz: e7f09feec62553d76c72e670aa4fa05d02e98f19e74352237c8c42a255960570f77ae530b3196be24a054fa8a55f744f0b0b96dfbfb1c5e7d06f71b1423bcdf6
-  data.tar.gz: '09a041dab71e1fea3796ca9193c6a5fdf385de1d7fc212373f2e7cec086568935c72171ba900c90001907fdd4e1667e819b69c28740c2e5fa18a4b17821facb3'
+  metadata.gz: e50e6688db3930ecca7c808d357fe07799465dfa5274a6b0141d97de5adb204f361782240c35152c21165eb8e68cdbf44a04e696006cd345293948825a2a74da
+  data.tar.gz: 349e89d00109d05b7dfe24499a80dc0318cf6895524e527b025ef02325bc27f06775544f20a995166cef1229b62aacd6344c1331c2c7549eb01f3be5181198cb

data/README.md

@@ -40,7 +40,60 @@ md = notion_converter.convert
 
 And that's all. The `md` is a string variable containing the notion page formatted in markdown.
 
+
+### Front matter
+
+From version 0.2.0, notion_to_md supports front matter in markdown files.
+
+By default, the front matter section is not included to the document. To do so, provide the `:frontmatter` option set to `true` to `convert` method.
+
+```ruby
+NotionToMd::Converter.new(page_id: 'b91d5...').convert(frontmatter: tue)
+```
+
+Default notion properties are page `id`, `title`, `created_time`, `last_edited_time`, `icon`, `archived` and `cover`.
+
+```yml
+---
+id: e42383cd-4975-4897-b967-ce453760499f
+title: An amazing post
+cover: https://img.bank.sh/an_image.jpg
+created_time: 2022-01-23T12:31:00.000Z
+last_edited_time: 2022-01-23T12:31:00.000Z
+icon: 💥
+archived: false
+---
+```
+
+In addition to default properties, custom properties are also supported.
+Custom properties name is [parameterized](https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize) and [underscorized](https://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-underscore) before added to front matter.
+For example, two properties named `Multiple Options` and `Tags` will be transformed to `multiple_options` and `tags`, respectively.
+
+```yml
+---
+tags: tag1, tag2, tag3
+multiple_options: option1, option2
+---
+```
+
+The supported property types are:
+
+* `number`
+* `select`
+* `multi_select`
+* `date`
+* `people`
+* `files`
+* `checkbox`
+* `url`
+* `email`
+* `phone_number`
+
+`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) to know more.
+
 ## Test
 ```bash
-$ ruby -Ilib:test test/notion_to_md/converter_spec.rb
+rspec
 ```

data/lib/notion_to_md/converter.rb

@@ -9,25 +9,20 @@ module NotionToMd
       @page_id = page_id
     end
 
-    def convert
-      md = page_blocks[:results].map do |block|
-        next Block.blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
-
-        block_type = block[:type].to_sym
-
-        begin
-          Block.send(block_type, block[block_type])
-        rescue StandardError
-          Logger.info("Unsupported block type: #{block_type}")
-          next nil
-        end
-      end
-      Logger.info("Notion page #{page_id} converted to markdown")
-      md.compact.join("\n\n")
+    def convert(frontmatter: false)
+      md_page = Page.new(page: page, blocks: page_blocks)
+      <<~MD
+        #{md_page.frontmatter if frontmatter}
+        #{md_page.body}
+      MD
     end
 
     private
 
+    def page
+      @page ||= @notion.page(id: page_id)
+    end
+
     def page_blocks
       @page_blocks ||= @notion.block_children(id: page_id)
     end

data/lib/notion_to_md/page.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module NotionToMd
+  class Page
+    attr_reader :page, :blocks
+
+    def initialize(page:, blocks:)
+      @page = page
+      @blocks = blocks
+    end
+
+    def title
+      page.dig(:properties, :Name, :title).inject('') do |acc, slug|
+        acc + slug[:plain_text]
+      end
+    end
+
+    def cover
+      page.dig(:cover, :external, :url)
+    end
+
+    def icon
+      page.dig(:icon, :emoji)
+    end
+
+    def id
+      page[:id]
+    end
+
+    def created_time
+      DateTime.parse(page['created_time'])
+    end
+
+    def last_edited_time
+      DateTime.parse(page['last_edited_time'])
+    end
+
+    def url
+      page[:url]
+    end
+
+    def archived
+      page[:archived]
+    end
+
+    def body
+      @body ||= blocks[:results].map do |block|
+        next Block.blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
+
+        block_type = block[:type].to_sym
+
+        begin
+          Block.send(block_type, block[block_type])
+        rescue StandardError
+          Logger.info("Unsupported block type: #{block_type}")
+          next nil
+        end
+      end.compact.join("\n\n")
+    end
+
+    def frontmatter
+      @frontmatter ||= <<~CONTENT
+        ---
+        #{props.to_a.map do |k, v|
+          "#{k}: #{v}"
+        end.join("\n")}
+        ---
+      CONTENT
+    end
+
+    def props
+      @props ||= custom_props.deep_merge(default_props)
+    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,
+        'created_time' => created_time,
+        'cover' => cover,
+        'icon' => icon,
+        'last_edited_time' => last_edited_time,
+        'archived' => archived
+      }
+    end
+
+    class CustomProperty
+      class << self
+        def multi_select(prop)
+          prop.multi_select.map(&:name)
+        end
+
+        def select(prop)
+          prop['select'].name
+        end
+
+        def people(prop)
+          prop.people.map(&:name)
+        end
+
+        def files(prop)
+          prop.files.map { |f| f.file.url }
+        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
+
+        def url(prop)
+          prop.url
+        end
+      end
+    end
+  end
+end

data/lib/notion_to_md/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NotionToMd
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/notion_to_md.rb

@@ -2,9 +2,12 @@
 
 require 'notion'
 require 'logger'
+require 'active_support/inflector'
+require 'active_support/core_ext/object/blank'
 require_relative './notion_to_md/version'
 require_relative './notion_to_md/converter'
 require_relative './notion_to_md/logger'
+require_relative './notion_to_md/page'
 require_relative './notion_to_md/block'
 require_relative './notion_to_md/text'
 require_relative './notion_to_md/text_annotation'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: notion-ruby-client
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +91,7 @@ files:
 - lib/notion_to_md/block.rb
 - lib/notion_to_md/converter.rb
 - lib/notion_to_md/logger.rb
+- lib/notion_to_md/page.rb
 - lib/notion_to_md/text.rb
 - lib/notion_to_md/text_annotation.rb
 - lib/notion_to_md/version.rb