notion_to_md 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f3d20369829f0cf5f2245eec32fcfc98a01b12edbf143451234922421ba2e1
-  data.tar.gz: eb3465f0295b9514fcf120efc1330d432d378c449ac5e1e279b19f0e6b8801f4
+  metadata.gz: d326983d99843871779f5331bab84d734bc01c21aa90b4da0cc76f1dd092c95e
+  data.tar.gz: 4b6a34aebbe07df627d956e9918606385e5d3952c56522ee66f3e331f8522d24
 SHA512:
-  metadata.gz: 927753e91887ac4d10b6a325f77f862e55676c607936c2b7a193eb6a5dd9bddf8dcc5824c7d02e714c90037a119921d114cec116e8989d1c789ff63993a2791d
-  data.tar.gz: b3a457117754849fff34035373385811260c0bf25093208747f3dda6800a0107acf7d1ae46328bb25583428975e8155960f03cb84a53f070afc4bd15d7836949
+  metadata.gz: 5e4990d98adf9eaff1dafc48285430b788de0bf4088b95ecd5f6c970fc850e015e9f148c79f0603647902b96b26465b01f88e9d86133472cc154a581c6f2e907
+  data.tar.gz: bb63c2a623265a153e7300ca9389bf1e75773373f8221eed41e4b7a11b33f801c26d8d033f3038ac93ead0586257e7874773c9a490de436a30ea79c4e5d5ca08

data/README.md

@@ -38,4 +38,62 @@ notion_converter = NotionToMd::Converter.new(page_id: 'b91d5...')
 md = notion_converter.convert
 ```
 
-And that's all. The `md` is a string variable containing the notion page formatted in markdown.
+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
+rspec
+```

data/lib/notion_to_md/block.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module NotionToMd
+  class Block
+    class << self
+      def paragraph(block)
+        convert_text(block)
+      end
+
+      def heading_1(block)
+        "# #{convert_text(block)}"
+      end
+
+      def heading_2(block)
+        "## #{convert_text(block)}"
+      end
+
+      def heading_3(block)
+        "### #{convert_text(block)}"
+      end
+
+      def callout(block)
+        icon = get_icon(block[:icon])
+        text = convert_text(block)
+        "#{icon} #{text}"
+      end
+
+      def quote(block)
+        "> #{convert_text(block)}"
+      end
+
+      def bulleted_list_item(block)
+        "- #{convert_text(block)}"
+      end
+
+      # TODO: numbered_list_item
+      def numbered_list_item(block)
+        Logger.info('numbered_list_item type not supported. Shown as bulleted_list_item.')
+        bulleted_list_item(block)
+      end
+
+      def to_do(block)
+        checked = block[:checked]
+        text = convert_text(block)
+
+        "- #{checked ? '[x]' : '[ ]'} #{text}"
+      end
+
+      def code(block)
+        language = block[:language]
+        text = convert_text(block)
+
+        "```#{language}\n\t#{text}\n```"
+      end
+
+      def embed(block)
+        url = block[:url]
+
+        "[#{url}](#{url})"
+      end
+
+      def image(block)
+        type = block[:type].to_sym
+        url = block.dig(type, :url)
+        caption = convert_caption(block)
+
+        "![](#{url})\n\n#{caption}"
+      end
+
+      def bookmark(block)
+        url = block[:url]
+        "[#{url}](#{url})"
+      end
+
+      def divider(_block)
+        '---'
+      end
+
+      def blank
+        '<br />'
+      end
+
+      def convert_text(block)
+        block[:text].map do |text|
+          content = Text.send(text[:type], text)
+          enrich_text_content(text, content)
+        end.join
+      end
+
+      def convert_caption(block)
+        convert_text(text: block[:caption])
+      end
+
+      def get_icon(block)
+        type = block[:type].to_sym
+        block[type]
+      end
+
+      def enrich_text_content(text, content)
+        enriched_content = add_link(text, content)
+        add_annotations(text, enriched_content)
+      end
+
+      def add_link(text, content)
+        href = text[:href]
+        return content if href.nil?
+
+        "[#{content}](#{href})"
+      end
+
+      def add_annotations(text, content)
+        annotations = text[:annotations].select { |_key, value| !!value }
+        annotations.keys.inject(content) do |enriched_content, annotation|
+          TextAnnotation.send(annotation.to_sym, enriched_content)
+        end
+      end
+    end
+  end
+end

data/lib/notion_to_md/converter.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'notion'
-require_relative './logger'
-require_relative './text_annotation'
-
 module NotionToMd
   class Converter
     attr_reader :page_id
@@ -13,139 +9,48 @@ module NotionToMd
       @page_id = page_id
     end
 
-    def convert
-      md = page_blocks[:results].map do |block|
-        next blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
-
-        block_type = block[:type].to_sym
-        send(block_type, block[block_type])
-      end
-      Logger.info("Notion page #{page_id} converted to markdown")
-      md.join("\n\n")
+    def convert(frontmatter: false)
+      <<~MD
+        #{parse_frontmatter if frontmatter}
+        #{parse_content}
+      MD
     end
 
     private
 
-    def page_blocks
-      @page_blocks ||= @notion.block_children(id: page_id)
-    end
-
-
-    def paragraph(block)
-      convert_text(block)
-    end
-
-    def heading_1(block)
-      "# #{convert_text(block)}"
-    end
-
-    def heading_2(block)
-      "## #{convert_text(block)}"
-    end
-
-    def heading_3(block)
-      "### #{convert_text(block)}"
-    end
-
-    def callout(block)
-      icon = get_icon(block[:icon])
-      text = convert_text(block)
-      "#{icon} #{text}"
-    end
-
-    def quote(block)
-      "> #{convert_text(block)}"
-    end
-
-    def bulleted_list_item(block)
-      "- #{convert_text(block)}"
-    end
-
-    # TODO: numbered_list_item
-    def numbered_list_item(block)
-      Logger.info('numbered_list_item type not supported. Shown as bulleted_list_item.')
-      bulleted_list_item(block)
-    end
-
-    def to_do(block)
-      checked = block[:checked]
-      text = convert_text(block)
-
-      "- #{checked ? '[x]' : '[ ]'} #{text}"
-    end
-
-    def code(block)
-      language = block[:language]
-      text = convert_text(block)
-
-      "```#{language}\n\t#{text}\n```"
-    end
-
-    def embed(block)
-      url = block[:url]
-
-      "[#{url}](#{url})"
-    end
-
-    def image(block)
-      type = block[:type].to_sym
-      url = block.dig(type, :url)
-      caption = convert_caption(block)
-
-      "![](#{url})\n\n#{caption}"
-    end
-
-    def bookmark(block)
-      url = block[:url]
-      "[#{url}](#{url})"
-    end
-
-    def divider(_block)
-      '---'
-    end
-
-    def equation(block)
-      equ = convert_text(block)
-      "$$ #{equ} $$"
-    end
-
-    def blank
-      '<br />'
-    end
-
-    def convert_text(block)
-      block[:text].map do |text|
-        content = text[:plain_text]
-        enrich_text_content(text, content)
-      end.join
-    end
+    def parse_content
+      md = page_blocks[:results].map do |block|
+        next Block.blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
 
-    def convert_caption(block)
-      convert_text(text: block[:caption])
-    end
+        block_type = block[:type].to_sym
 
-    def get_icon(block)
-      type = block[:type].to_sym
-      block[type]
+        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")
     end
 
-    def enrich_text_content(text, content)
-      enriched_content = add_link(text, content)
-      add_annotations(text, enriched_content)
+    def parse_frontmatter
+      notion_page = Page.new(page: page)
+      frontmatter = notion_page.props.to_a.map { |k, v| "#{k}: #{v}" }.join("\n")
+      <<~CONTENT
+        ---
+        #{frontmatter}
+        ---
+      CONTENT
     end
 
-    def add_link(text, content)
-      href = text[:href]
-      return content if href.nil?
-
-      "[#{content}](#{href})"
+    def page
+      @page ||= @notion.page(id: page_id)
     end
 
-    def add_annotations(text, content)
-      annotations = text[:annotations].select { |key, value| !!value }
-      annotations.keys.inject(content) do |enriched_content, annotation|
-        TextAnnotation.send(annotation.to_sym, enriched_content)
-      end
+    def page_blocks
+      @page_blocks ||= @notion.block_children(id: page_id)
     end
   end
 end

data/lib/notion_to_md/logger.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require 'logger'
-
 module NotionToMd
   class Logger
-    @logger = ::Logger.new(STDOUT)
+    @logger = ::Logger.new($stdout)
 
     class << self
       extend Forwardable
-      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal, :level, :level=
     end
   end
 end
-
-

data/lib/notion_to_md/page.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module NotionToMd
+  class Page
+    attr_reader :page
+
+    def initialize(page:)
+      @page = page
+    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 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)
+          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
+
+        def url(prop)
+          prop.url
+        end
+      end
+    end
+  end
+end

data/lib/notion_to_md/text.rb

@@ -0,0 +1,13 @@
+module NotionToMd
+  class Text
+    class << self
+      def text(text)
+        text[:plain_text]
+      end
+
+      def equation(text)
+        "$$ #{text[:plain_text]} $$"
+      end
+    end
+  end
+end

data/lib/notion_to_md/text_annotation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NotionToMd
   # Append the text type:
   # * italic: boolean,
@@ -9,19 +11,19 @@ module NotionToMd
   class TextAnnotation
     class << self
       def italic(text)
-        "_#{text}_"
+        "*#{text}*"
       end
 
       def bold(text)
         "**#{text}**"
       end
 
-      def striketrough(text)
+      def strikethrough(text)
         "~~#{text}~~"
       end
 
       def underline(text)
-        text
+        "<u>#{text}</u>"
       end
 
       def code(text)

data/lib/notion_to_md/version.rb

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

data/lib/notion_to_md.rb

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
+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.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-02-15 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
@@ -24,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Notion Markdown Exporter in Ruby
 email: emoriarty81@gmail.com
 executables: []
@@ -32,8 +88,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/notion_to_md.rb
+- 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
 homepage: https://github.com/emoriarty/notion_to_md