notion_to_md 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb94bccdf9dca4374bfaeb42164cce77f3a1963048a96b83a53e238ff9768163
-  data.tar.gz: '039b7d197fc03a6a04ffaf1cb90f3f758dd597a7381a2002da677065d48f2d76'
+  metadata.gz: 4137f1edccac5aceec8f5195beb513019ec2ad84c52c5495a1d9842098dd2b4d
+  data.tar.gz: 51a57a1bf294d1c2cf3d0be1e24c693aa633c3c873fe864a9f2864fec6194ecb
 SHA512:
-  metadata.gz: ce0dd31c6a1eb871468b151e2374311799b802b0f58e6e450bcc24aaa76f586f9755ad63953f3b61b45e0102d1440fa3d8f66538c014dbc921fc8ecf01a69a6f
-  data.tar.gz: 1a008da641c3c449b401ede3e2d65608a47192cae908888bcebd96eba7162e70f7640e549a881c459e9010cd1703248c49fa8d65d3a516489601a80c48e0e87d
+  metadata.gz: 32e4a48a21d956bba91ba88d3aa3db0fdb6f7b0f54f55fcd44fdb07dd15842247ab6150b06f0f82a828ef8f0f632d158e746f54007afdd85357c41e75167b203
+  data.tar.gz: b9aa39eeb9b5cb105a8ebf48ca78fe4e88c0a9a7c013f63dc0057dc3adf0ffcfd0cbd2c72df87b83d5e5eafaaa9605e26a0c44f63852af4be9e87e37f752d6cc

data/README.md

@@ -1,6 +1,8 @@
 # notion_to_md
 Notion Markdown Exporter in Ruby.
 
+The generated document is compliant with the [GitHub Flavored Markdown specification](https://github.github.com/gfm/).
+
 ## Installation
 Use gem to install.
 ```bash
@@ -28,8 +30,6 @@ md = notion_converter.convert
 Since v2.3 you can also use the convenient `convert` method from the root module.
 
 ```ruby
-require 'notion_to_md'
-
 md = NotionToMd.convert(page_id: 'b91d5...', token: 'secret_...')
 ```
 
@@ -40,15 +40,27 @@ $ export NOTION_TOKEN=<secret_...>
 ```
 
 ```ruby
-require 'notion_to_md'
-
 notion_converter = NotionToMd::Converter.new(page_id: 'b91d5...')
 md = notion_converter.convert
 # or
 md = NotionToMd.convert(page_id: 'b91d5...')
 ```
 
-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 document formatted in markdown.
+
+### Callable
+
+From version 2.5.0, the `call` method is also available. It's an alias for `convert`.
+
+```ruby
+md = NotionToMd.call(page_id: 'b91d5...')
+```
+
+The `call` method also supports the passing of a block.
+
+```ruby
+NotionToMd.call(page_id: 'b91d5...') { puts _1 }
+```
 
 ## Blocks
 
@@ -69,6 +81,10 @@ Everything in a notion page body is a [block object](https://developers.notion.c
 * `table`
 * `embed`
 * `code`
+* `link_preview`
+* `file`
+* `pdf`
+* `video`
 
 ### Nested blocks
 

data/lib/notion_to_md/blocks/block.rb

@@ -2,7 +2,7 @@
 
 require 'forwardable'
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class Block
       extend Forwardable

data/lib/notion_to_md/blocks/builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class Builder
       ##

data/lib/notion_to_md/blocks/bulleted_list_block.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class BulletedListBlock < Block
       def initialize(children: [])

data/lib/notion_to_md/blocks/bulleted_list_item_block.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class BulletedListItemBlock < Block
       def newline

data/lib/notion_to_md/blocks/factory.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class Factory
       def self.build(block:, children: [])

data/lib/notion_to_md/blocks/normalizer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class Normalizer
       # === Parameters

data/lib/notion_to_md/blocks/numbered_list_block.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class NumberedListBlock < BulletedListBlock
       def type

data/lib/notion_to_md/blocks/numbered_list_item_block.rb

@@ -2,7 +2,7 @@
 
 require_relative './bulleted_list_item_block'
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class NumberedListItemBlock < BulletedListItemBlock
       # === Parameters:

data/lib/notion_to_md/blocks/table_block.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class TableBlock < Block
       def to_md

data/lib/notion_to_md/blocks/table_row_block.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class TableRowBlock < Block
       def newline

data/lib/notion_to_md/blocks/to_do_list_block.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class ToDoListBlock < BulletedListBlock
       def type

data/lib/notion_to_md/blocks/to_do_list_item_block.rb

@@ -2,7 +2,7 @@
 
 require_relative './bulleted_list_item_block'
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class ToDoListItemBlock < BulletedListItemBlock
       def newline

data/lib/notion_to_md/blocks/types.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   module Blocks
     class Types
       class << self
@@ -89,6 +89,28 @@ module NotionToMd
           "|#{block[:cells].map(&method(:convert_table_row)).join('|')}|"
         end
 
+        def link_preview(block)
+          url = block[:url]
+
+          "[#{url}](#{url})"
+        end
+
+        def file(block)
+          type = block[:type].to_sym
+          url = block.dig(type, :url)
+          caption = convert_caption(block)
+
+          "[#{url}](#{url})\n\n#{caption}"
+        end
+
+        def pdf(block)
+          file(block)
+        end
+
+        def video(block)
+          file(block)
+        end
+
         private
 
         def convert_table_row(cells)

data/lib/notion_to_md/blocks.rb

@@ -14,7 +14,7 @@ require_relative './blocks/numbered_list_item_block'
 require_relative './blocks/to_do_list_block'
 require_relative './blocks/to_do_list_item_block'
 
-module NotionToMd
+class NotionToMd
   module Blocks
     # === Parameters
     # block_id::

data/lib/notion_to_md/converter.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-module NotionToMd
-  ##
+class 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
+    include Callee
+
+    attr_reader :page_id, :frontmatter
 
     # === Parameters
     # page_id::
@@ -20,9 +20,10 @@ module NotionToMd
     # === Returns
     # A NotionToMd::Converter object.
     #
-    def initialize(page_id:, token: nil)
+    def initialize(page_id:, token: nil, frontmatter: false)
       @notion = Notion::Client.new(token: token || ENV['NOTION_TOKEN'])
       @page_id = page_id
+      @frontmatter = frontmatter
     end
 
     # === Parameters
@@ -40,6 +41,14 @@ module NotionToMd
       MD
     end
 
+    def call
+      md = convert frontmatter: frontmatter
+
+      yield md if block_given?
+
+      md
+    end
+
     private
 
     def page

data/lib/notion_to_md/helpers/yaml_sanitizer.rb

@@ -0,0 +1,17 @@
+class NotionToMd
+  module Helpers
+    module YamlSanitizer
+      # Escape the frontmatter value if it contains a colon or a dash followed by a space
+      # @param value [String] the value to escape
+      # @return [String] the escaped value
+      def escape_frontmatter_value(value)
+        if value.match?(/: |-\s/)
+          # Escape the double quotes inside the string
+          "\"#{value.gsub('"', '\"')}\""
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/notion_to_md/helpers.rb

@@ -0,0 +1 @@
+require_relative './helpers/yaml_sanitizer'

data/lib/notion_to_md/logger.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   class Logger
     @logger = ::Logger.new($stdout)
 

data/lib/notion_to_md/page.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   class Page
+    include Helpers::YamlSanitizer
+
     attr_reader :page, :blocks
 
     def initialize(page:, blocks:)
@@ -93,7 +95,7 @@ module NotionToMd
     def default_props
       @default_props ||= {
         'id' => id,
-        'title' => title.dump,
+        'title' => escape_frontmatter_value(title),
         'created_time' => created_time,
         'cover' => cover,
         'icon' => icon,

data/lib/notion_to_md/page_property.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   class PageProperty
     class << self
+      include Helpers::YamlSanitizer
+
       def file(prop)
         prop.dig(:file, :url)
       rescue NoMethodError
@@ -28,7 +30,7 @@ module NotionToMd
       end
 
       def select(prop)
-        prop.dig(:select, :name).dump
+        escape_frontmatter_value(prop.dig(:select, :name))
       rescue NoMethodError
         nil
       end
@@ -95,7 +97,7 @@ module NotionToMd
 
       def rich_text(prop)
         text = prop[:rich_text].map { |text| text[:plain_text] }.join
-        text.blank? ? nil : text.dump
+        text.blank? ? nil : escape_frontmatter_value(text)
       rescue NoMethodError
         nil
       end

data/lib/notion_to_md/text.rb

@@ -1,4 +1,4 @@
-module NotionToMd
+class NotionToMd
   class Text
     class << self
       def text(text)

data/lib/notion_to_md/text_annotation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NotionToMd
+class NotionToMd
   ##
   # Append the text type:
   # * italic: boolean,

data/lib/notion_to_md/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module NotionToMd
-  VERSION = '2.4.0'
+class NotionToMd
+  VERSION = '2.5.0'
 end

data/lib/notion_to_md.rb

@@ -4,6 +4,8 @@ require 'notion'
 require 'logger'
 require 'active_support/inflector'
 require 'active_support/core_ext/object/blank'
+require 'callee'
+require_relative './notion_to_md/helpers'
 require_relative './notion_to_md/version'
 require_relative './notion_to_md/converter'
 require_relative './notion_to_md/logger'
@@ -13,7 +15,18 @@ require_relative './notion_to_md/blocks'
 require_relative './notion_to_md/text'
 require_relative './notion_to_md/text_annotation'
 
-module NotionToMd
+# The NotionToMd class allows to transform notion pages to markdown documents.
+class NotionToMd
+  include Callee
+
+  attr_reader :page_id, :token, :frontmatter
+
+  def initialize(page_id:, token: nil, frontmatter: false)
+    @page_id = page_id
+    @token = token || ENV['NOTION_TOKEN']
+    @frontmatter = frontmatter
+  end
+
   # === Parameters
   # page_id::
   #   A string representing the notion page id.
@@ -28,4 +41,12 @@ module NotionToMd
   def self.convert(page_id:, token: nil, frontmatter: false)
     Converter.new(page_id: page_id, token: token).convert(frontmatter: frontmatter)
   end
+
+  def call
+    md = self.class.convert(page_id: page_id, token: token, frontmatter: frontmatter)
+
+    yield md if block_given?
+
+    md
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: callee
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
 - !ruby/object:Gem::Dependency
   name: notion-ruby-client
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,8 @@ files:
 - lib/notion_to_md/blocks/to_do_list_item_block.rb
 - lib/notion_to_md/blocks/types.rb
 - lib/notion_to_md/converter.rb
+- lib/notion_to_md/helpers.rb
+- lib/notion_to_md/helpers/yaml_sanitizer.rb
 - lib/notion_to_md/logger.rb
 - lib/notion_to_md/page.rb
 - lib/notion_to_md/page_property.rb