notion_to_md 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4876bb92641f8a6199b932404c609cf99a69bafd2f39eaded145f638edd98c39
-  data.tar.gz: f57fa933a7bfa0fc4e1b916cf022b64255da39142a2c546720e08d72b6915b44
+  metadata.gz: 7b301a14c22e1790633fc88c179d3882521f9c9632655b6fd9fc883cf128e9dc
+  data.tar.gz: 528414ba605c3e03bb3599ea70b7e998768cba3ba56429aaa23523f203b8de19
 SHA512:
-  metadata.gz: 86b7daa8a26780c4d6a091048144e05f9a5b48f28993d5a1fed8b53f10e844d3cb54d9b39bb4ffacb35945a1ef9e0128398dac36e68246476f8e3d3919189b87
-  data.tar.gz: 3689b48b6fd3a550be20091601a0b888d5656f51d03e0141b37c391934184a5b3e48456996d5bd42b0ed3188204a3be15292a354eaa28f6c4a61fac2de277a32
+  metadata.gz: df30fc42ab07586e39a73f6ca8ddd6742e8672c5701c78c67eb4059515403090f71466fe550c3f54617edd110b395843a366f647492da687a43cc3aedf61b27c
+  data.tar.gz: c102997be2946fab86cd2ba837119ec34cb51da23e9104662f8cb4006930ad9aa916067fa02a26c9de066c7ceb34dc33878c01e64f800c0160aeffb172efe5f2

data/README.md

@@ -57,6 +57,8 @@ Everything in a notion page body is a [block object](https://developers.notion.c
 * `quote`
 * `divider`
 
+**Note: children nested blocks are not supported.**
+
 ## Front matter
 
 From version 0.2.0, notion_to_md supports front matter in markdown files.

data/lib/notion_to_md/blocks/block.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module NotionToMd
+  module Blocks
+    class Block
+      extend Forwardable
+
+      attr_reader :block, :children
+
+      # === Parameters:
+      # block::
+      #   A {Notion::Messages::Message}[https://github.com/orbit-love/notion-ruby-client/blob/main/lib/notion/messages/message.rb] object.
+      # children::
+      #   An array of NotionToMd::Block::Block objects.
+      #
+      # === Returns
+      # A Block object.
+      #
+      def initialize(block:, children: [])
+        @block = block
+        @children = children
+      end
+
+      # === Parameters:
+      # tab_width::
+      #  The number of tabs used to indent the block.
+      #
+      # === Returns
+      # The current block (and its children) converted to a markdown string.
+      #
+      def to_md(tab_width: 0)
+        block_type = block.type.to_sym
+        md = Types.send(block_type, block[block_type])
+        md + build_nested_blocks(tab_width + 1)
+      rescue NoMethodError
+        Logger.info("Unsupported block type: #{block_type}")
+        nil
+      end
+
+      private
+
+      def build_nested_blocks(tab_width)
+        mds = markdownify_children(tab_width).compact
+        indent_children(mds, tab_width).join
+      end
+
+      def markdownify_children(tab_width)
+        children.map do |nested_block|
+          nested_block.to_md(tab_width: tab_width)
+        end
+      end
+
+      def indent_children(mds, tab_width)
+        mds.map do |md|
+          "\n\n#{"\t" * tab_width}#{md}"
+        end
+      end
+    end
+  end
+end

data/lib/notion_to_md/blocks/types.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module NotionToMd
+  module Blocks
+    class Types
+      class << self
+        def paragraph(block)
+          return blank if block.rich_text.empty?
+
+          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
+
+        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 = 'text' if language == 'plain text'
+
+          "```#{language}\n#{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
+
+        private
+
+        def convert_text(block)
+          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(rich_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
+end

data/lib/notion_to_md/blocks.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative './blocks/block'
+require_relative './blocks/types'
+
+module NotionToMd
+  module Blocks
+    ##
+    # Array containing the block types allowed to have nested blocks (children).
+    PERMITTED_CHILDREN = [
+      Types.method(:bulleted_list_item).name,
+      Types.method(:numbered_list_item).name
+    ].freeze
+
+    # === Parameters
+    # block::
+    #   A {Notion::Messages::Message}[https://github.com/orbit-love/notion-ruby-client/blob/main/lib/notion/messages/message.rb] object.
+    #
+    # === Returns
+    # A boolean indicating if the blocked passed in
+    # is permitted to have children based on its type.
+    #
+    def self.permitted_children?(block:)
+      PERMITTED_CHILDREN.include?(block.type.to_sym) && block.has_children
+    end
+
+    # === Parameters
+    # block_id::
+    #   A string representing a notion block id .
+    #
+    # === Returns
+    # An array of NotionToMd::Blocks::Block.
+    #
+    def self.build(block_id:, &fetch_blocks)
+      blocks = fetch_blocks.call(block_id)
+      blocks.results.map do |block|
+        children = if permitted_children?(block: block)
+                     build(block_id: block.id, &fetch_blocks)
+                   else
+                     []
+                   end
+        Blocks::Block.new(block: block, children: children)
+      end
+    end
+  end
+end

data/lib/notion_to_md/converter.rb

@@ -1,14 +1,37 @@
 # frozen_string_literal: true
 
 module NotionToMd
+  ##
+  # The Converter class allows to transform notion pages to markdown documents.
+  # Just create a new Converter instance by providing the page_id:
+  #   page_converter = NotionToMd::Converter.new(page_id: '9dc17c9c9d2e469dbbf0f9648f3288d3')
+  # Then, call for convert to obtain the markdown document:
+  #   page_converter.convert
+
   class Converter
     attr_reader :page_id
 
+    # === Parameters
+    # page_id::
+    #   A string representing the notion page id.
+    # token::
+    #   The notion API secret token. The token can replaced by the environment variable NOTION_TOKEN.
+    #
+    # === Returns
+    # A NotionToMd::Converter object.
+    #
     def initialize(page_id:, token: nil)
       @notion = Notion::Client.new(token: token || ENV['NOTION_TOKEN'])
       @page_id = page_id
     end
 
+    # === Parameters
+    # frontmatter::
+    #   A boolean value that indicates whether the front matter block is included in the markdown document.
+    #
+    # === Returns
+    # The string that represent the markdown document.
+    #
     def convert(frontmatter: false)
       md_page = Page.new(page: page, blocks: page_blocks)
       <<~MD
@@ -24,7 +47,17 @@ module NotionToMd
     end
 
     def page_blocks
-      @page_blocks ||= @notion.block_children(block_id: page_id)
+      @page_blocks ||= build_blocks(block_id: page_id)
+    end
+
+    def build_blocks(block_id:)
+      Blocks.build(block_id: block_id) do |nested_block_id|
+        fetch_blocks(block_id: nested_block_id)
+      end
+    end
+
+    def fetch_blocks(block_id:)
+      @notion.block_children(block_id: block_id)
     end
   end
 end

data/lib/notion_to_md/page.rb

@@ -44,18 +44,7 @@ module NotionToMd
     end
 
     def body
-      @body ||= blocks[:results].map do |block|
-        next Block.blank if block[:type] == 'paragraph' && block.dig(:paragraph, :rich_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")
+      @body ||= blocks.map(&:to_md).compact.join("\n\n")
     end
 
     def frontmatter

data/lib/notion_to_md/text_annotation.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module NotionToMd
+  ##
   # Append the text type:
   # * italic: boolean,
   # * bold: boolean,
@@ -8,6 +9,7 @@ module NotionToMd
   # * underline: boolean,
   # * code: boolean,
   # * color: string NOT_SUPPORTED
+
   class TextAnnotation
     class << self
       def italic(text)

data/lib/notion_to_md/version.rb

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

data/lib/notion_to_md.rb

@@ -8,6 +8,6 @@ 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/blocks'
 require_relative './notion_to_md/text'
 require_relative './notion_to_md/text_annotation'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,7 +102,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/notion_to_md.rb
-- lib/notion_to_md/block.rb
+- lib/notion_to_md/blocks.rb
+- lib/notion_to_md/blocks/block.rb
+- lib/notion_to_md/blocks/types.rb
 - lib/notion_to_md/converter.rb
 - lib/notion_to_md/logger.rb
 - lib/notion_to_md/page.rb

data/lib/notion_to_md/block.rb

@@ -1,120 +0,0 @@
-# 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
-
-      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 = 'text' if language == 'plain text'
-
-        "```#{language}\n#{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[: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(rich_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