notion_ruby_mapping 0.6.2 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20cd62581513083b2b99d6fad57d3486fc855bf390f96ba01da263fa47e16029
-  data.tar.gz: da20deff5ce1e53cbbe7d2cda86550676eea088fe1fee890385490b07cfa55ad
+  metadata.gz: 1cd3d5401bef9a8567f2e316a14ae4e2833d55eb5f22456afe74714133a2b970
+  data.tar.gz: b795baa4b02b38080ecce9381efad566c304548bb3e90116d71fa687e371e7de
 SHA512:
-  metadata.gz: 68fd906fb46c5957d5eb48a41f41752c61a8fb40a7283dfa9ec3e4a95173c38401a966f24707893bdc1ded47ed76606990031488e2100eac234e4e53197de005
-  data.tar.gz: d79d601217f69788eee522185868e5ded0e44598a60e9a4e4173c98b4df96c262c7516893e8f3829ac5d202491cad6c1548bb4de53d1646a691dacc6e8d3a6c8
+  metadata.gz: 761538aea8d3bfce6e577c2f6681a84e1ec94cf1a3ef2ccc15b284867303f4d6235b7d90c1806ed0beb2292fa4e5391a62e3b8a6e7c27f1741eb6a7f7f3fd275
+  data.tar.gz: d9faffa54de1a2379f75ad4add80cd08d38b450553d2e7b0fad340ee718a7a73e02275b085f54c140810dbb3c5013e375407cae39ae500bc1f34963ba0c61638

data/README.md

@@ -75,14 +75,16 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 ### 2.3 Sample codes
 
 1. [Database and page access sample](https://www.notion.so/hkob/Database-and-page-access-sample-d30033e707194faf995741167eb2b6f8)
-1. [Append block children sample](https://www.notion.so/hkob/Append-block-children-sample-3867910a437340be931cf7f2c06443c6)
-1. [Update block sample](https://www.notion.so/hkob/update-block-sample-5568c1c36fe84f12b83edfe2dda83028)
+2. [Append block children sample](https://www.notion.so/hkob/Append-block-children-sample-3867910a437340be931cf7f2c06443c6)
+3. [Update block sample](https://www.notion.so/hkob/update-block-sample-5568c1c36fe84f12b83edfe2dda83028)
 
 ### 2.4. Another example code (Use case)
 
 1. [Set icon to all icon unsettled pages](examples/set_icon_to_all_icon_unsettled_pages.md)
-1. [Renumbering pages](examples/renumbering_pages.md)
-1. [Change title](examples/change_title.md)
+2. [Renumbering pages](examples/renumbering_pages.md)
+3. [Change title](examples/change_title.md)
+4. [Create ER Diagram from Notion database](https://www.notion.so/hkob/notionErDiagram-Sample-1720c2199c534ca08138cde38f31f710)
+5. [Create Sitemap from Notion pages](https://www.notion.so/hkob/NotionSitemap-sample-14e195c83d024c5382aab09210916c87)
 
 ### 2.5 API reference
 
@@ -90,6 +92,11 @@ NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 
 ## 3. ChangeLog
 
+- 2022/8/10 [v0.6.5] add notionSiteMap.rb, rename createErDiagram to notionErDiagram, and move them to exe directory
+- 2022/8/9 [v0.6.4] url can be entered instead of page_id, block_id and database_id
+- 2022/8/9 [v0.6.3] update createErDiagram.rb (Fixed a bug with non-ASCII database titles)
+- 2022/8/7 [v0.6.2] add comment_object support
+- 2022/7/28 [v0.6.1] added createErDiagram.rb
 - 2022/7/22 [v0.6.0] updates for Notion-Version 2022-06-28 (lazy retrieve property values, retrieve page/database/block parent, single_property/dual_property for RelationProperty)
 - 2022/6/24 [v0.5.5] add file_names= to FileProperty
 - 2022/6/23 [v0.5.4] add update 'is_inline' and 'description' for database object

data/exe/notionErDiagram.rb

@@ -0,0 +1,70 @@
+#! /usr/bin/env ruby
+
+require "notion_ruby_mapping"
+include NotionRubyMapping
+
+def append_database(text, db, db_titles)
+  base_title = db_title db
+  normalize_db_title(db, db_titles) if db_titles[db].nil?
+  text << "  #{db_titles[db]} {"
+  text << %(    Database title "#{base_title}") unless base_title == db_titles[db]
+  db.properties.reject { |p| p.is_a? RelationProperty }.each_with_index do |p, i|
+    class_name = p.class.name.split("::").last.sub /Property/, ""
+    text << %(    #{class_name} p#{i} "#{p.name}")
+  end
+  text << "  }\n"
+end
+
+def normalize_db_title(db, db_titles)
+  base_title = db_title db
+  db_titles[db] = base_title.gsub(/[\w\d\-_]+/, "").empty? ? base_title : "d#{db_titles.count}"
+end
+
+def db_title(db)
+  db.database_title.full_text.gsub " ", "_"
+end
+
+if ARGV.length < 2
+  print "Usage: notionErDiagram.rb top_database_id code_block_id"
+  exit
+end
+database_id, code_block_id = ARGV
+NotionCache.instance.create_client ENV["NOTION_API_KEY"]
+block = Block.find code_block_id
+unless block.is_a? CodeBlock
+  print "#{code_block_id} is not CodeBlock's id"
+  exit
+end
+dbs = [Database.find(database_id)]
+text = %w[erDiagram]
+
+finished = {}
+db_titles = {}
+until dbs.empty?
+  db = dbs.shift
+  finished[db] = true
+  append_database(text, db, db_titles)
+  db.properties.select { |pp| pp.is_a? RelationProperty }.each_with_index do |pp, i|
+    new_db = Database.find pp.relation_database_id
+    normalize_db_title(new_db, db_titles) if db_titles[new_db].nil?
+    text << "  #{db_titles[db]} |o--o{ #{db_titles[new_db]} : r#{i}"
+    dbs << new_db unless finished[new_db]
+  end
+  text << ""
+end
+
+text_objects = text.each_with_object([]) do |str, ans|
+  strn = "#{str}\n"
+  if (last = ans.last)
+    if last.length + strn.length > 1999
+      ans << strn
+    else
+      ans[-1] += strn
+    end
+  else
+    ans << strn
+  end
+end
+block.rich_text_array.rich_text_objects = text_objects
+block.language = "mermaid"
+block.save

data/exe/notionSitemap.rb

@@ -0,0 +1,130 @@
+#! /usr/bin/env ruby
+
+require "notion_ruby_mapping"
+include NotionRubyMapping
+
+# see https://zenn.dev/kinkinbeer135ml/articles/f08ce790091aca
+def escape_title(title)
+  title.gsub /[(){}\[\]！”＃＄％＆’（）＝＾〜｜￥１２３４５６７８９０＠｀「」｛｝；：＋＊＜＞、。・？＿]/, ""
+end
+
+class Sitemap
+  def initialize(top_page, orient, nolink)
+    @top_page = top_page
+    @code = {@top_page => "p0"}
+    @queue = [@top_page]
+    @finished = {}
+    @page_links = Hash.new { |h, k| h[k] = [] }
+    @text = ["flowchart #{orient}"]
+    @nolink = nolink
+  end
+  attr_reader :text
+
+  def dig_pages
+    until @queue.empty?
+      page = @queue.shift
+      @finished[page] = true
+      search_blocks(page)
+      @text << %(click #{@code[page]} "#{page["url"]}")
+    end
+  end
+
+  def code_with_title(page)
+    "#{@code[page]}(#{escape_title page.title})"
+  end
+
+  def search_blocks(page)
+    print "#{page.title}\n"
+    @children = []
+    @block_queue = page.children.to_a
+    search_block page, @block_queue.shift until @block_queue.empty?
+    unless @children.empty?
+      title = page == @top_page ? code_with_title(page) : @code[page]
+      @text << [title, @children.map { |p| code_with_title p }.join(" & ")].join(" --> ")
+    end
+    print "\n"
+  end
+
+  def search_block(page, block)
+    case block
+    when ChildPageBlock
+      add_child block.children.first.parent
+    when LinkToPageBlock
+      add_link page, block.page_id unless @nolink
+    else
+      @block_queue += block.children.to_a if block.has_children
+      search_link_in_rta(page, block.rich_text_array) if !@nolink && block.is_a?(TextSubBlockColorBaseBlock)
+    end
+  end
+
+  def add_child(child)
+    @queue << child
+    @children << child
+    set_code child
+    print "  --> #{child.title}\n"
+  end
+
+  def set_code(page)
+    @code[page] ||= "p#{@code.length}"
+  end
+
+  def add_link(page, link_page_id)
+    return unless link_page_id
+
+    begin
+      link_page = Page.find link_page_id
+    rescue
+      print "\n#{link_page_id} can not read by this integration\n"
+      return
+    end
+    set_code link_page
+    @page_links[page] << link_page
+    print "  -.-> #{link_page.title} "
+  end
+
+  def search_link_in_rta(page, rta)
+    rta.each { |to| add_link page, to.page_id if to.is_a?(MentionObject) && to.page_id }
+  end
+
+  def link_pages
+    @page_links.each do |org, array|
+      link_finished = {}
+      array.each do |lp|
+        link_finished[lp] = @finished[lp] ? @code[lp] : code_with_title(lp)
+      end
+      @text << [@code[org], link_finished.values.join(" & ")].join(" -.-> ")
+    end
+  end
+end
+
+if ARGV.length < 3
+  print "Usage: notionSitemap.rb top_page_id code_block_id orient(LR or TD) [--nolink]"
+  exit
+end
+top_page_id, code_block_id, orient, nolink = ARGV
+NotionCache.instance.create_client ENV["NOTION_API_KEY"]
+code_block = Block.find code_block_id
+unless code_block.is_a? CodeBlock
+  print "#{code_block_id} is not CodeBlock's id"
+  exit
+end
+
+top_page = Page.find top_page_id
+sm = Sitemap.new top_page, orient, nolink == "--nolink"
+sm.dig_pages
+sm.link_pages unless nolink
+text_objects = sm.text.each_with_object([]) do |str, ans|
+  strn = "#{str}\n"
+  if (last = ans.last)
+    if last.length + strn.length > 1999
+      ans << strn
+    else
+      ans[-1] += strn
+    end
+  else
+    ans << strn
+  end
+end
+code_block.rich_text_array.rich_text_objects = text_objects
+code_block.language = "mermaid"
+code_block.save

data/lib/notion_ruby_mapping/blocks/base.rb

@@ -25,7 +25,7 @@ module NotionRubyMapping
       assign.each_slice(2) { |(klass, key)| assign_property(klass, key) }
       @json ||= {}
     end
-    attr_reader :json, :id, :archived
+    attr_reader :json, :id, :archived, :has_children
 
     # @param [Hash, Notion::Messages] json
     # @return [NotionRubyMapping::Base]
@@ -44,6 +44,22 @@ module NotionRubyMapping
       end
     end
 
+    def self.block_id(str)
+      if /^http/.match str
+        /#([\da-f]{32})/.match(str)[1]
+      else
+        NotionCache.instance.hex_id str
+      end
+    end
+
+    def self.database_id(str)
+      if /^http/.match str
+        /([\da-f]{32})\?/.match(str)[1]
+      else
+        NotionCache.instance.hex_id str
+      end
+    end
+
     # @param [Object] method
     # @param [Object] path
     # @param [nil] json
@@ -58,21 +74,29 @@ module NotionRubyMapping
       shell.join(" \\\n")
     end
 
+    def self.page_id(str)
+      if /^http/.match str
+        /([\da-f]{32})$/.match(str)[1]
+      else
+        NotionCache.instance.hex_id str
+      end
+    end
+
     def comments(query = nil, dry_run: false)
-      if page? || block?
-        if dry_run
-          self.class.dry_run_script :get, @nc.retrieve_comments_path(@id)
-        else
-          ans = {}
-          List.new(comment_parent: self,
-                   json: @nc.retrieve_comments_request(@id, query),
-                   query: query).each do |comment|
-            dt_id = comment.discussion_id
-            dt = ans[dt_id] ||= DiscussionThread.new dt_id
-            dt.comments << comment
-          end
-          ans
+      return unless page? || block?
+
+      if dry_run
+        self.class.dry_run_script :get, @nc.retrieve_comments_path(@id)
+      else
+        ans = {}
+        List.new(comment_parent: self,
+                 json: @nc.retrieve_comments_request(@id, query),
+                 query: query).each do |comment|
+          dt_id = comment.discussion_id
+          dt = ans[dt_id] ||= DiscussionThread.new dt_id
+          dt.comments << comment
         end
+        ans
       end
     end
 

data/lib/notion_ruby_mapping/blocks/block.rb

@@ -67,10 +67,11 @@ module NotionRubyMapping
     # @return [NotionRubyMapping::Block]
     def self.find(id, dry_run: false)
       nc = NotionCache.instance
+      block_id = Base.block_id id
       if dry_run
-        Base.dry_run_script :get, nc.block_path(id)
+        Base.dry_run_script :get, nc.block_path(block_id)
       else
-        nc.block id
+        nc.block block_id
       end
     end
 

data/lib/notion_ruby_mapping/blocks/database.rb

@@ -10,10 +10,11 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#58ba9190fd544432a9e2a5823d6c33b7
     def self.find(id, dry_run: false)
       nc = NotionCache.instance
+      database_id = Base.database_id id
       if dry_run
-        dry_run_script :get, nc.database_path(id)
+        dry_run_script :get, nc.database_path(database_id)
       else
-        nc.database id
+        nc.database database_id
       end
     end
 

data/lib/notion_ruby_mapping/blocks/link_to_page_block.rb

@@ -25,9 +25,9 @@ module NotionRubyMapping
     def block_json(not_update: true)
       ans = super
       ans[type] = if @page_id
-                    {"type" => "page_id", "page_id" => @page_id}
+                    {"type" => "page_id", "page_id" => Base.page_id(@page_id)}
                   else
-                    {"type" => "database_id", "database_id" => @database_id}
+                    {"type" => "database_id", "database_id" => Base.database_id(@database_id)}
                   end
       ans
     end

data/lib/notion_ruby_mapping/blocks/page.rb

@@ -10,10 +10,11 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#7d868b8b81c3473082bbdc7370813a4a
     def self.find(id, dry_run: false)
       nc = NotionCache.instance
+      page_id = Base.page_id id
       if dry_run
-        Base.dry_run_script :get, nc.page_path(id)
+        Base.dry_run_script :get, nc.page_path(page_id)
       else
-        nc.page id
+        nc.page page_id
       end
     end
 

data/lib/notion_ruby_mapping/blocks/synced_block.rb

@@ -11,7 +11,7 @@ module NotionRubyMapping
         synced_from = @json[type]["synced_from"]
         @block_id = synced_from && @nc.hex_id(synced_from["block_id"])
       else
-        @block_id = block_id
+        @block_id = Base.block_id block_id
         add_sub_blocks sub_blocks
       end
       @can_have_children = @block_id.nil?

data/lib/notion_ruby_mapping/objects/equation_object.rb

@@ -31,6 +31,11 @@ module NotionRubyMapping
       @will_update = true
     end
 
+    # @return [String (frozen)]
+    def text
+      @expression
+    end
+
     protected
 
     # @return [Hash{String (frozen)->String}]

data/lib/notion_ruby_mapping/objects/mention_object.rb

@@ -12,6 +12,11 @@ module NotionRubyMapping
       @options["plain_text"] = url
     end
 
+    # @return [String, NilClass]
+    def page_id
+      @options["page_id"]
+    end
+
     # @return [String (frozen)]
     def text
       ""

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.6.2"
+  VERSION = "0.6.5"
   NOTION_VERSION = "2022-06-28"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.5
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-07 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -125,7 +125,9 @@ dependencies:
 description: Mapping tool from Notion Database/Page/Block to Ruby Objects.
 email:
 - hkob@metro-cit.ac.jp
-executables: []
+executables:
+- notionErDiagram.rb
+- notionSitemap.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -144,6 +146,8 @@ files:
 - examples/change_title.md
 - examples/renumbering_pages.md
 - examples/set_icon_to_all_icon_unsettled_pages.md
+- exe/notionErDiagram.rb
+- exe/notionSitemap.rb
 - images/post_set_icon.png
 - images/pre_set_icon.png
 - images/serial_number.png
@@ -234,7 +238,6 @@ files:
 - notion_ruby_mapping.gemspec
 - sig/notion_ruby_mapping.rbs
 - tools/an
-- tools/createErDiagram.rb
 homepage: https://github.com/hkob/notion_ruby_mapping.git
 licenses:
 - MIT

data/tools/createErDiagram.rb

@@ -1,46 +0,0 @@
-#! /usr/bin/env ruby
-
-require "notion_ruby_mapping"
-include NotionRubyMapping
-
-def append_database(text, db)
-  text << "#{db_title db} {"
-  db.properties.reject { |p| p.is_a? RelationProperty }.each_with_index do |p, i|
-    class_name = p.class.name.split("::").last.sub /Property/, ""
-    text << %Q[  #{class_name} p#{i} "#{p.name}"]
-  end
-  text << "}\n"
-end
-
-def db_title(db)
-  db.database_title.full_text.gsub " ", "_"
-end
-
-if ARGV.length < 2
-  print "Usage: createErDiagram.rb top_database_id code_block_id"
-  exit
-end
-database_id, code_block_id = ARGV
-NotionCache.instance.create_client ENV["NOTION_API_KEY"]
-block = Block.find code_block_id
-unless block.is_a? CodeBlock
-  print "#{code_block_id} is not CodeBlock's id"
-end
-dbs = [Database.find(database_id)]
-text = %w[erDiagram]
-
-finished = {}
-until dbs.empty?
-  db = dbs.shift
-  finished[db] = true
-  append_database(text, db)
-  db.properties.select { |p| p.is_a? RelationProperty }.each_with_index do |p, i|
-    new_db = Database.find p.relation_database_id
-    text << "#{db_title db} |o--o{ #{db_title new_db} : r#{i}"
-    dbs << new_db unless finished[new_db]
-  end
-  text << ""
-end
-block.rich_text_array.rich_text_objects = text.join("\n  ")
-block.language = "mermaid"
-block.save