notion_to_md 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4137f1edccac5aceec8f5195beb513019ec2ad84c52c5495a1d9842098dd2b4d
-  data.tar.gz: 51a57a1bf294d1c2cf3d0be1e24c693aa633c3c873fe864a9f2864fec6194ecb
+  metadata.gz: bb8852f9013936bcb404e0779e4930e84831e2db4235b2f0bca8268a9e4edaf0
+  data.tar.gz: d3b9fe50d279cfc14abf20d7f8468d1534b043b73e00ee8123248556c03b43bf
 SHA512:
-  metadata.gz: 32e4a48a21d956bba91ba88d3aa3db0fdb6f7b0f54f55fcd44fdb07dd15842247ab6150b06f0f82a828ef8f0f632d158e746f54007afdd85357c41e75167b203
-  data.tar.gz: b9aa39eeb9b5cb105a8ebf48ca78fe4e88c0a9a7c013f63dc0057dc3adf0ffcfd0cbd2c72df87b83d5e5eafaaa9605e26a0c44f63852af4be9e87e37f752d6cc
+  metadata.gz: e49f3a1d040fb7381e8369c774cff8a31a510909c3e7813c4ba8016085075d613d01808a23a8075d9d9246335eadd1e08347225d287c702c07753df44f3f3af7
+  data.tar.gz: 52806a867c8d24e96e993c4a07741ff13322d14151e0285351c341237a772579f7084913764112f703435e963d598754e326e0c047c29f2d74f4ce6b58f68951

data/README.md

@@ -85,6 +85,7 @@ Everything in a notion page body is a [block object](https://developers.notion.c
 * `file`
 * `pdf`
 * `video`
+* `equation`
 
 ### Nested blocks
 

data/lib/notion_to_md/blocks/block.rb

@@ -4,6 +4,9 @@ require 'forwardable'
 
 class NotionToMd
   module Blocks
+    # === NotionToMd::Blocks::Block
+    #
+    # This class is responsible for converting Notion blocks to markdown.
     class Block
       extend Forwardable
 

data/lib/notion_to_md/blocks/builder.rb

@@ -2,6 +2,9 @@
 
 class NotionToMd
   module Blocks
+    # === NotionToMd::Blocks::Builder
+    #
+    # This class is responsible for building a tree of blocks from the Notion API.
     class Builder
       ##
       # Array containing the block types allowed to have nested blocks (children).

data/lib/notion_to_md/blocks/factory.rb

@@ -2,7 +2,11 @@
 
 class NotionToMd
   module Blocks
+    # === NotionToMd::Blocks::Factory
+    #
+    # Factory class to create block instances based on the block type
     class Factory
+      # rubocop:disable Metrics/MethodLength
       def self.build(block:, children: [])
         case block.type.to_sym
         when :table
@@ -19,6 +23,7 @@ class NotionToMd
           Blocks::Block.new(block: block, children: children)
         end
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/notion_to_md/blocks/normalizer.rb

@@ -2,6 +2,9 @@
 
 class NotionToMd
   module Blocks
+    # === NotionToMd::Blocks::Normalizer
+    #
+    # This class is responsible for normalizing blocks of the same type
     class Normalizer
       # === Parameters
       # blocks::
@@ -27,27 +30,37 @@ class NotionToMd
         new_blocks = []
 
         normalized_blocks.each do |block|
-          if block.type.to_sym == type
+          if block_of_type?(block, type)
             blocks_to_normalize << block
           else
             # When we encounter a block that is not of the provided type,
             # we need to normalize the blocks we've collected so far.
             # Then we add the current block to the new blocks array.
-            # This is because we want to keep the order of the blocks.
-            new_blocks << new_block_and_reset_blocks_to_normalize(type) unless blocks_to_normalize.empty?
+            # This is to keep the order of the blocks as they are in the original array.
+            flush_blocks_to_normalize_into(new_blocks, type)
             new_blocks << block
           end
         end
 
         # If the last block is the provided type, it won't be added to the new blocks array.
         # So, we need to normalize the blocks we've collected so far.
-        new_blocks << new_block_and_reset_blocks_to_normalize(type) unless blocks_to_normalize.empty?
+        flush_blocks_to_normalize_into(new_blocks, type)
 
         normalized_blocks.replace(new_blocks)
       end
 
       private
 
+      def block_of_type?(block, type)
+        block.type.to_sym == type
+      end
+
+      def flush_blocks_to_normalize_into(new_blocks, type)
+        return if blocks_to_normalize.empty?
+
+        new_blocks << new_block_and_reset_blocks_to_normalize(type)
+      end
+
       def new_block_and_reset_blocks_to_normalize(type)
         new_block = new_block_for(type, blocks_to_normalize)
         @blocks_to_normalize = []

data/lib/notion_to_md/blocks/types.rb

@@ -111,6 +111,10 @@ class NotionToMd
           file(block)
         end
 
+        def equation(block)
+          "$$#{block['expression']}$$"
+        end
+
         private
 
         def convert_table_row(cells)

data/lib/notion_to_md/blocks.rb

@@ -15,6 +15,9 @@ require_relative './blocks/to_do_list_block'
 require_relative './blocks/to_do_list_item_block'
 
 class NotionToMd
+  # === NotionToMd::Blocks
+  #
+  # This module is responsible for building Notion blocks.
   module Blocks
     # === Parameters
     # block_id::

data/lib/notion_to_md/helpers/yaml_sanitizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class NotionToMd
   module Helpers
     module YamlSanitizer

data/lib/notion_to_md/helpers.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative './helpers/yaml_sanitizer'

data/lib/notion_to_md/page.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 class NotionToMd
+  # === NotionToMd::Page
+  #
+  # This class is responsible for representing a Notion page.
   class Page
     include Helpers::YamlSanitizer
 
@@ -81,17 +84,10 @@ class NotionToMd
     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? }
+      @custom_props ||= filtered_custom_properties
     end
 
+    # rubocop:disable Metrics/MethodLength
     def default_props
       @default_props ||= {
         'id' => id,
@@ -107,10 +103,35 @@ class NotionToMd
         'last_edited_by_id' => last_edited_by_id
       }
     end
+    # rubocop:enable Metrics/MethodLength
 
     # This class is kept for retro compatibility reasons.
     # Use instead the PageProperty class.
     class CustomProperty < PageProperty
     end
+
+    private
+
+    def filtered_custom_properties
+      build_custom_properties.reject { |_k, v| v.presence.nil? }
+    end
+
+    def build_custom_properties
+      page.properties.each_with_object({}) do |(name, value), memo|
+        type = value.type
+        next unless valid_custom_property_type?(type)
+
+        key = name.parameterize.underscore
+        memo[key] = build_custom_property(type, value)
+      end
+    end
+
+    def valid_custom_property_type?(type)
+      CustomProperty.respond_to?(type.to_sym)
+    end
+
+    def build_custom_property(type, value)
+      CustomProperty.send(type, value)
+    end
   end
 end

data/lib/notion_to_md/page_property.rb

@@ -66,7 +66,7 @@ class NotionToMd
       end
 
       def checkbox(prop)
-        prop[:checkbox].nil? ? nil : prop[:checkbox].to_s
+        prop[:checkbox]&.to_s
       rescue NoMethodError
         nil
       end

data/lib/notion_to_md/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class NotionToMd
   class Text
     class << self
@@ -6,7 +8,7 @@ class NotionToMd
       end
 
       def equation(text)
-        "$$ #{text[:plain_text]} $$"
+        "$`#{text[:plain_text]}`$"
       end
     end
   end

data/lib/notion_to_md/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2025-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport