notion_to_md 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 924eafad078f99447e1a9d88403d48448e5011c87a9d2ae32b527a9e4a201f85
-  data.tar.gz: 791bf46ea8cfbb49958cc80862fe63047e1158f4845f21665ce21d20b37628ad
+  metadata.gz: 4e623e752d6bbe53643139220d1f47f17ca411298a985bb2889a69d6dc9070d3
+  data.tar.gz: 03631f5fb4b9d8a5e3faa4cce66d14bd89e65bc42bf62b22b90f267456b40f14
 SHA512:
-  metadata.gz: e50e6688db3930ecca7c808d357fe07799465dfa5274a6b0141d97de5adb204f361782240c35152c21165eb8e68cdbf44a04e696006cd345293948825a2a74da
-  data.tar.gz: 349e89d00109d05b7dfe24499a80dc0318cf6895524e527b025ef02325bc27f06775544f20a995166cef1229b62aacd6344c1331c2c7549eb01f3be5181198cb
+  metadata.gz: cd44a229e6e53a802008bde4e7791087c9fe92172d7ce30f575e1cc31d3a268c1f2b17ffb2502a2436ec815eea5e55bfecebb8dcf25dc9d03d783818a899e411
+  data.tar.gz: a7e89786e1e35a23d946c5ae877051259f9496997fd6ea8fe8b1bf32b6cefe0ce10e197c38d5dabc21951d6b3a54b249eeac63c9223c484939290dcde950736c

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/page#all-pages) 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)
@@ -81,14 +80,14 @@ module NotionToMd
       end
 
       def convert_text(block)
-        block[:text].map do |text|
+        block[:rich_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])
+        convert_text(rich_text: block[:caption])
       end
 
       def get_icon(block)

data/lib/notion_to_md/converter.rb

@@ -20,11 +20,11 @@ module NotionToMd
     private
 
     def page
-      @page ||= @notion.page(id: page_id)
+      @page ||= @notion.page(page_id: page_id)
     end
 
     def page_blocks
-      @page_blocks ||= @notion.block_children(id: page_id)
+      @page_blocks ||= @notion.block_children(block_id: page_id)
     end
   end
 end

data/lib/notion_to_md/page.rb

@@ -45,7 +45,7 @@ module NotionToMd
 
     def body
       @body ||= blocks[:results].map do |block|
-        next Block.blank if block[:type] == 'paragraph' && block.dig(:paragraph, :text).empty?
+        next Block.blank if block[:type] == 'paragraph' && block.dig(:paragraph, :rich_text).empty?
 
         block_type = block[:type].to_sym
 
@@ -140,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 = '1.0.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-06 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: notion-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement