notion_to_md 0.2.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce6b39ba9cc39e1428bc8a654532d16b9ea99054e3fbd96cf30edd56cbed28a8
-  data.tar.gz: 6e38131568bb150a9ca7904f383fd8ade5721ccc5affe2949672b597b948ffe3
+  metadata.gz: b11e8415fbf22af0f2a346cdb5e5ed5fd79cf3736f37d2d047d8d11bf1b4e362
+  data.tar.gz: 57b5b92fb1a01faa5334c85926742e50682553d44c5ef3d96c5b7278ca27a70f
 SHA512:
-  metadata.gz: 3ccfa65a6877fd1bcdc9a36f72094cc8374934a2713abfc10441b23348b919818539c286469afad699f69594dc854a12f884299d2c335ff6cd9bc17d920bbcb6
-  data.tar.gz: fd638c9a53e8c6f6cf644e2e471fc7ecf8150bb1ef371d9f6f41215e4d1bd953d1929113c25dc703dd66647165adf84bbf9f7bddcb6494d8b0bcea5bd06f2741
+  metadata.gz: 501c58bec83d950a0f7a1c69da2ff542d00745704c3557aea0b159fd87a587702def108b174915ec6beabb5b67509fbc790491493644e4be9859079fcd5ffb99
+  data.tar.gz: fc5cf12e22528194b2a877333b73c0d28ed1d76f19a49e204a002bff0ceee60654935009d09155b57b391e463e792522cf29e027d5e565326ae46c3f8bb7f966

data/README.md

@@ -40,8 +40,24 @@ md = notion_converter.convert
 
 And that's all. The `md` is a string variable containing the notion page formatted in markdown.
 
+## Blocks
 
-### Front matter
+Everything in a notion page body is a [block object](https://developers.notion.com/reference/block#block-object-keys). Therefore, not every type can be mapped to Markdown. Below there's a list of current supported blocks types.
+
+* `paragraph`
+* `heading_1`
+* `heading_2`
+* `heading_3`
+* `bulleted_list_item`
+* `numbered_list_item` as `bulleted_list_item`
+* `to_do`
+* `image`
+* `bookmark`
+* `callout`
+* `quote`
+* `divider`
+
+## Front matter
 
 From version 0.2.0, notion_to_md supports front matter in markdown files.
 
@@ -51,7 +67,7 @@ By default, the front matter section is not included to the document. To do so,
 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`.
+Default notion [properties](https://developers.notion.com/reference/property-object) are page `id`, `title`, `created_time`, `last_edited_time`, `icon`, `archived` and `cover`.
 
 ```yml
 ---
@@ -88,8 +104,9 @@ The supported property types are:
 * `url`
 * `email`
 * `phone_number`
+* `rich_text`, supported but in plain text
 
-`rich_text` as advanced types like `formula`, `relation` and `rollup` are not supported.
+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.
 

data/lib/notion_to_md/block.rb

@@ -33,7 +33,6 @@ module NotionToMd
         "- #{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)
@@ -50,7 +49,7 @@ module NotionToMd
         language = block[:language]
         text = convert_text(block)
 
-        "```#{language}\n\t#{text}\n```"
+        "```#{language}\n#{text}\n```"
       end
 
       def embed(block)

data/lib/notion_to_md/converter.rb

@@ -10,43 +10,15 @@ module NotionToMd
     end
 
     def convert(frontmatter: false)
+      md_page = Page.new(page: page, blocks: page_blocks)
       <<~MD
-        #{parse_frontmatter if frontmatter}
-        #{parse_content}
+        #{md_page.frontmatter if frontmatter}
+        #{md_page.body}
       MD
     end
 
     private
 
-    def parse_content
-      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")
-    end
-
-    def parse_frontmatter
-      notion_page = Page.new(page: page)
-      frontmatter = notion_page.props.to_a.map do |k, v|
-        "#{k}: #{v}"
-      end.join("\n")
-      <<~CONTENT
-        ---
-        #{frontmatter}
-        ---
-      CONTENT
-    end
-
     def page
       @page ||= @notion.page(id: page_id)
     end

data/lib/notion_to_md/page.rb

@@ -2,10 +2,11 @@
 
 module NotionToMd
   class Page
-    attr_reader :page
+    attr_reader :page, :blocks
 
-    def initialize(page:)
+    def initialize(page:, blocks:)
       @page = page
+      @blocks = blocks
     end
 
     def title
@@ -42,6 +43,31 @@ module NotionToMd
       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
@@ -114,6 +140,10 @@ module NotionToMd
         def url(prop)
           prop.url
         end
+
+        def rich_text(prop)
+          prop.rich_text.map(&:plain_text).join
+        end
       end
     end
   end

data/lib/notion_to_md/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-26 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport