notion_ruby_mapping 0.8.9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6b2157ccc35fd74afcb19e5c3a1f79a47fc85bbd37a40615244d7ab0e94dcc
-  data.tar.gz: 8a8b3a3a816159cf1759ffef5bc2a3c2a8cd4533fa0aa85591c6a0079fb8e8c7
+  metadata.gz: ac7180c69212c47d60456deee3790f5cdd2b7f2074f7c5e244ccf2aae102b371
+  data.tar.gz: d7c88e0ab4d4afdb30cf1d95d285ea2f4a533353886bd0d33c9a3eea5e19ea35
 SHA512:
-  metadata.gz: d39c8c323487e2cad1782dd3b19a9f3a02b6c843fe31a4d61dc4ddd23af7de1f81f22c4a29a085ffe510d76186738c99246f1bb2f7fd87c8b0085db8c74d3bed
-  data.tar.gz: 18d4e3bdc38409ff21a76e76129a1b208c28ab539d02f9fa17662b70d1d56dbab084bda4cd467fccafab421174b55b9fc8556f1e19f39e35a2953cffefe68f5f
+  metadata.gz: 2e5aec4c569a646464f20f57a96c6cb714425faacd96d3be8f1413f67531d4c887e2fc5f21f5bfabe95a2614fdc31abed5e638337b64269ad460b99c089ffd78
+  data.tar.gz: 54639e4104e52699c1b26b92e07b934f6902a74210ef7652f79ce2db420e611e91bc61bcd6dffef48aeda2360a0fda2c165d5b967638ca9816aed2e96f80f066

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   Enabled: true
@@ -26,6 +26,17 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+RSpec/NestedGroups:
+  Enabled: true
+  MaxNesting: 5
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: true
+  Max: 8
+
 Metrics/BlockLength:
   Exclude:
     - "Rakefile"

data/lib/notion_ruby_mapping/blocks/base.rb

@@ -90,7 +90,7 @@ module NotionRubyMapping
         self.class.dry_run_script :get, @nc.retrieve_comments_path(@id)
       else
         ans = {}
-        List.new(type: :comment_parent, value: self,
+        List.new(type: "comment_parent", value: self,
                  json: @nc.retrieve_comments_request(@id, query),
                  query: query).each do |comment|
           dt_id = comment.discussion_id
@@ -128,7 +128,7 @@ module NotionRubyMapping
 
       only_one = blocks.length == 1
       json = {
-        "children" => Array(blocks).map do |block|
+        children: Array(blocks).map do |block|
           assert_parent_children_pair block
           block.block_json
         end,
@@ -155,10 +155,10 @@ module NotionRubyMapping
       return if block.can_append
 
       bt = block.type
-      raise StandardError, "Internal file block can not append." if bt == "file"
+      raise StandardError, "Internal file block can not append." if bt == :file
 
-      raise StandardError, "Column block can only append column_list block" unless bt == "column" &&
-                                                                                   block? && type == "column_list"
+      raise StandardError, "Column block can only append column_list block" unless bt == :column &&
+                                                                                   block? && type == :column_list
     end
 
     # @param [NotionRubyMapping::Property] klass
@@ -166,12 +166,12 @@ module NotionRubyMapping
     # @return [NotionRubyMapping::Property] generated property
     def assign_property(klass, title)
       @property_cache ||= PropertyCache.new({},
-                                            base_type: database? ? :database : :page,
+                                            base_type: database? ? "database" : "page",
                                             page_id: page? ? @id : nil)
       property = if database?
-                   klass.new(title, will_update: new_record?, base_type: :database)
+                   klass.new(title, will_update: new_record?, base_type: "database")
                  else
-                   klass.new(title, will_update: true, base_type: :page, property_cache: @property_cache)
+                   klass.new(title, will_update: true, base_type: "page", property_cache: @property_cache)
                  end
       @property_cache.add_property property
       property
@@ -193,10 +193,15 @@ module NotionRubyMapping
         @children
       else
         response = @nc.block_children_request @id, query.query_string
-        @children = List.new json: response, type: :parent, value: self, query: query
+        @children = List.new json: response, type: "parent", value: self, query: query
       end
     end
 
+    # @return [Hash, nil] obtained Hash
+    def cover
+      self["cover"]
+    end
+
     # @return [NotionRubyMapping::CreatedTimeProperty]
     def created_time
       @created_time ||= CreatedTimeProperty.new("__timestamp__", json: self["created_time"])
@@ -275,7 +280,7 @@ module NotionRubyMapping
           reload
         end
         @property_cache = PropertyCache.new json_properties,
-                                            base_type: database? ? :database : :page,
+                                            base_type: database? ? "database" : "page",
                                             page_id: page? ? @id : nil
       end
       @property_cache
@@ -323,13 +328,22 @@ module NotionRubyMapping
       end
     end
 
-    # @param [String] emoji
-    # @param [String] url
+    # @param [String, nil] url
+    # @param [String, nil] file_upload_object
+    # @return [NotionRubyMapping::Base]
+    def set_cover(url: nil, file_upload_object: nil)
+      @payload.set_cover(url: url, file_upload_object: file_upload_object) if page? || database?
+      self
+    end
+
+    # @param [String, nil] emoji
+    # @param [String, nil] url
+    # @param [FileUploadObject, nil] file_upload_object
     # @return [NotionRubyMapping::Base]
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#62eea67af7824496820c6bb903503540
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#e13d526bd709451e9b06fd32e8d07fcd
-    def set_icon(emoji: nil, url: nil)
-      @payload.set_icon(emoji: emoji, url: url) if page? || database?
+    def set_icon(emoji: nil, url: nil, file_upload_object: nil)
+      @payload.set_icon(emoji: emoji, url: url, file_upload_object: file_upload_object) if page? || database?
       self
     end
 

data/lib/notion_ruby_mapping/blocks/block.rb

@@ -17,45 +17,45 @@ module NotionRubyMapping
     def self.type2class(type, has_children = false)
       @type2class ||= {
         false => {
-          "bookmark" => BookmarkBlock,
-          "breadcrumb" => BreadcrumbBlock,
-          "bulleted_list_item" => BulletedListItemBlock,
-          "callout" => CalloutBlock,
-          "child_database" => ChildDatabaseBlock,
-          "child_page" => ChildPageBlock,
-          "code" => CodeBlock,
-          "column" => ColumnBlock,
-          "column_list" => ColumnListBlock,
-          "divider" => DividerBlock,
-          "embed" => EmbedBlock,
-          "equation" => EquationBlock,
-          "file" => FileBlock,
-          "heading_1" => Heading1Block,
-          "heading_2" => Heading2Block,
-          "heading_3" => Heading3Block,
-          "image" => ImageBlock,
-          "link_preview" => LinkPreviewBlock,
-          "link_to_page" => LinkToPageBlock,
-          "numbered_list_item" => NumberedListItemBlock,
-          "paragraph" => ParagraphBlock,
-          "pdf" => PdfBlock,
-          "quote" => QuoteBlock,
-          "synced_block" => SyncedBlock,
-          "table" => TableBlock,
-          "table_row" => TableRowBlock,
-          "table_of_contents" => TableOfContentsBlock,
-          "template" => TemplateBlock,
-          "to_do" => ToDoBlock,
-          "toggle" => ToggleBlock,
-          "video" => VideoBlock,
+          bookmark: BookmarkBlock,
+          breadcrumb: BreadcrumbBlock,
+          bulleted_list_item: BulletedListItemBlock,
+          callout: CalloutBlock,
+          child_database: ChildDatabaseBlock,
+          child_page: ChildPageBlock,
+          code: CodeBlock,
+          column: ColumnBlock,
+          column_list: ColumnListBlock,
+          divider: DividerBlock,
+          embed: EmbedBlock,
+          equation: EquationBlock,
+          file: FileBlock,
+          heading_1: Heading1Block,
+          heading_2: Heading2Block,
+          heading_3: Heading3Block,
+          image: ImageBlock,
+          link_preview: LinkPreviewBlock,
+          link_to_page: LinkToPageBlock,
+          numbered_list_item: NumberedListItemBlock,
+          paragraph: ParagraphBlock,
+          pdf: PdfBlock,
+          quote: QuoteBlock,
+          synced_block: SyncedBlock,
+          table: TableBlock,
+          table_row: TableRowBlock,
+          table_of_contents: TableOfContentsBlock,
+          template: TemplateBlock,
+          to_do: ToDoBlock,
+          toggle: ToggleBlock,
+          video: VideoBlock,
         },
         true => {
-          "heading_1" => ToggleHeading1Block,
-          "heading_2" => ToggleHeading2Block,
-          "heading_3" => ToggleHeading3Block,
-        }
+          heading_1: ToggleHeading1Block,
+          heading_2: ToggleHeading2Block,
+          heading_3: ToggleHeading3Block,
+        },
       }
-      @klass = @type2class[has_children][type] || @type2class[false][type] || Block
+      @klass = @type2class[has_children][type.to_sym] || @type2class[false][type.to_sym] || Block
     end
 
     def self.decode_block(json)
@@ -65,7 +65,7 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/Block-689ad4cbff50404d8a1baf67b6d6d78d#298916c7c379424682f39ff09ee38544
     # @param [String] id
     # @param [Boolean] dry_run true if dry_run
-    # @return [NotionRubyMapping::Block]
+    # @return [String, NotionRubyMapping::Block]
     def self.find(id, dry_run: false)
       nc = NotionCache.instance
       block_id = Base.block_id id
@@ -80,7 +80,7 @@ module NotionRubyMapping
     # @return [NotionRubyMapping::Block, String]
     # @param [Array<Block>] blocks
     def append_after(*blocks, dry_run: false)
-      parent.append_block_children *blocks, after: id, dry_run: dry_run
+      parent.append_block_children(*blocks, after: id, dry_run: dry_run)
     end
 
     # @param [Boolean] not_update false when update
@@ -99,7 +99,7 @@ module NotionRubyMapping
 
     # @return [NotionRubyMapping::RichTextArray]
     def decode_block_caption
-      @caption = RichTextArray.new "caption", json: @json[type]["caption"]
+      @caption = RichTextArray.new "caption", json: @json[type]["caption"] if @json[type]["caption"]
     end
 
     # @return [String]
@@ -128,7 +128,8 @@ module NotionRubyMapping
       if dry_run
         dry_run_script :patch, @nc.block_path(@id), :update_block_json
       else
-        update_json @nc.update_block_request(@id, update_block_json)
+        @json = @nc.update_block_request(@id, update_block_json)
+        update_file_object_from_json(@json) if is_a? FileBaseBlock
       end
     end
 
@@ -144,7 +145,7 @@ module NotionRubyMapping
       @can_have_children = true
     end
 
-    # @param [String] type
+    # @param [String, Symbol] type
     # @param [String] color
     def rich_text_array_and_color(type, text_info, color = "default")
       @rich_text_array = RichTextArray.rich_text_array type, text_info

data/lib/notion_ruby_mapping/blocks/callout_block.rb

@@ -74,7 +74,7 @@ module NotionRubyMapping
       @payload.add_update_block_key "icon"
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "callout"
     end

data/lib/notion_ruby_mapping/blocks/child_database_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class ChildDatabaseBlock < ChildBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "child_database"
     end

data/lib/notion_ruby_mapping/blocks/child_page_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class ChildPageBlock < ChildBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "child_page"
     end

data/lib/notion_ruby_mapping/blocks/code_block.rb

@@ -42,7 +42,7 @@ module NotionRubyMapping
       @payload.add_update_block_key "language"
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "code"
     end

data/lib/notion_ruby_mapping/blocks/column_block.rb

@@ -12,7 +12,7 @@ module NotionRubyMapping
       @can_append = false
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "column"
     end

data/lib/notion_ruby_mapping/blocks/database.rb

@@ -107,7 +107,7 @@ module NotionRubyMapping
         Base.dry_run_script :post, @nc.query_database_path(@id), query.query_json
       else
         response = @nc.database_query_request @id, query
-        List.new json: response, type: :database, value: self, query: query
+        List.new json: response, type: "database", value: self, query: query
       end
     end
 

data/lib/notion_ruby_mapping/blocks/embed_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class EmbedBlock < UrlCaptionBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "embed"
     end

data/lib/notion_ruby_mapping/blocks/equation_block.rb

@@ -35,7 +35,7 @@ module NotionRubyMapping
       @payload.add_update_block_key "expression"
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "equation"
     end

data/lib/notion_ruby_mapping/blocks/file_base_block.rb

@@ -21,7 +21,7 @@ module NotionRubyMapping
 
     # @see https://www.notion.so/hkob/FileBlock-08f2aa6948364d00b92beacaac9a619c#158487a7e1644fae8778dcff59869356
     # @see https://www.notion.so/hkob/ImageBlock-806b3d2a9a2c4bf5a5aca6e3fbc8a7e2#19a4aa3e06514bbe84be9d3b8a45a20f
-    attr_reader :caption
+    attr_reader :caption, :file_object
 
     # @param [Boolean] not_update false when update
     # @return [Hash{String (frozen)->Hash}]
@@ -46,5 +46,17 @@ module NotionRubyMapping
       @file_object.url = url
       @payload.add_update_block_key "external"
     end
+
+    # @param [FileUploadObject] fuo
+    def file_upload_object=(fuo)
+      @file_object.file_upload_object = fuo
+      @payload.add_update_block_key "file_upload"
+    end
+
+    def update_file_object_from_json(json)
+      @file_object = FileObject.new json: json[type]
+      decode_block_caption
+      @can_append = @file_object.external?
+    end
   end
 end

data/lib/notion_ruby_mapping/blocks/file_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class FileBlock < FileBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "file"
     end

data/lib/notion_ruby_mapping/blocks/heading1_block.rb

@@ -10,13 +10,13 @@ module NotionRubyMapping
       @can_have_children = false
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "heading_1"
     end
 
     # @param [Boolean] not_update false when update
-    # @return [Hash{String (frozen)->Hash}]
+    # @return [Hash{Symbol->Hash}]
     def block_json(not_update: true)
       ans = super
       ans[type]["is_toggleable"] = false

data/lib/notion_ruby_mapping/blocks/heading3_block.rb

@@ -10,7 +10,7 @@ module NotionRubyMapping
       @can_have_children = false
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "heading_3"
     end

data/lib/notion_ruby_mapping/blocks/image_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class ImageBlock < FileBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "image"
     end

data/lib/notion_ruby_mapping/blocks/link_preview_block.rb

@@ -8,7 +8,7 @@ module NotionRubyMapping
       @can_append = false
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "link_preview"
     end

data/lib/notion_ruby_mapping/blocks/link_to_page_block.rb

@@ -32,7 +32,7 @@ module NotionRubyMapping
       ans
     end
 
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "link_to_page"
     end

data/lib/notion_ruby_mapping/blocks/list.rb

@@ -11,17 +11,17 @@ module NotionRubyMapping
       @load_all_contents = !@has_more
 
       case type
-      when :comment_parent
+      when "comment_parent"
         @comment_parent = value
-      when :database
+      when "database"
         @database = value
-      when :parent
+      when "parent"
         @parent = value
-      when :property
+      when "property"
         @property = value
-      when :user_object
-        @user_object = true
-      when :search
+      when "user_object"
+        @user_object = value
+      when "search"
         @search = value
       end
       @query = query
@@ -34,6 +34,7 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/List-9a0b32335e0d48849a785ce5e162c760#12e1c261a0944a4095776b7515bef4a1
     def each(&block)
       return enum_for(:each) if block.nil?
+
       if @parent
         each_sub base: @page,
                  query: -> { @parent.children @query },
@@ -46,12 +47,12 @@ module NotionRubyMapping
                  &block
       elsif @property
         each_sub base: @property,
-                 query: -> do
+                 query: lambda {
                    @nc.page_property_request @property.property_cache.page_id,
                                              @property.property_id,
                                              @query.query_json
-                 end,
-                 create_object: ->(json) do
+                 },
+                 create_object: lambda { |json|
                    case json["type"]
                    when "people"
                      UserObject.new json: json["people"]
@@ -64,7 +65,7 @@ module NotionRubyMapping
                    else
                      json
                    end
-                 end,
+                 },
                  &block
       elsif @comment_parent
         each_sub base: @comment_parent,

data/lib/notion_ruby_mapping/blocks/numbered_list_item_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class NumberedListItemBlock < TextSubBlockColorBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "numbered_list_item"
     end

data/lib/notion_ruby_mapping/blocks/page.rb

@@ -67,7 +67,7 @@ module NotionRubyMapping
     # @return [String] title
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#2ff7209055f346fbbda454cdbb40b1c8
     def title
-      tp = properties.select { |p| p.is_a?(TitleProperty) || (p.is_a?(Property) && p.property_id == "title") }
+      tp = properties.select { |p| p.is_a?(TitleProperty) || (p.is_a?(Property) && p.property_id == :title) }
       tp.map(&:full_text).join ""
     end
 
@@ -103,6 +103,5 @@ module NotionRubyMapping
         update_json @nc.update_page_request(@id, property_values_json)
       end
     end
-
   end
 end

data/lib/notion_ruby_mapping/blocks/paragraph_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class ParagraphBlock < TextSubBlockColorBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "paragraph"
     end

data/lib/notion_ruby_mapping/blocks/pdf_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class PdfBlock < FileBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "pdf"
     end

data/lib/notion_ruby_mapping/blocks/toggle_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class ToggleBlock < TextSubBlockColorBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "toggle"
     end

data/lib/notion_ruby_mapping/blocks/toggle_heading3_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class ToggleHeading3Block < TextSubBlockColorBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "heading_3"
     end

data/lib/notion_ruby_mapping/blocks/video_block.rb

@@ -3,7 +3,7 @@
 module NotionRubyMapping
   # Notion block
   class VideoBlock < FileBaseBlock
-    # @return [String (frozen)]
+    # @return [String]
     def type
       "video"
     end

data/lib/notion_ruby_mapping/controllers/discussion_thread.rb

@@ -16,7 +16,7 @@ module NotionRubyMapping
     def append_comment(text_objects, dry_run: false)
       rto = RichTextArray.new "rich_text", text_objects: text_objects, will_update: true
       nc = NotionCache.instance
-      json = rto.property_schema_json.merge({"discussion_id" => @discussion_id})
+      json = rto.property_schema_json.merge({discussion_id: @discussion_id})
       if dry_run
         Base.dry_run_script :post, nc.comments_path, json
       else

data/lib/notion_ruby_mapping/controllers/mermaid.rb

@@ -16,11 +16,10 @@ module NotionRubyMapping
       until @lines.empty?
         case @lines.shift
         when / *(\w+) *[|}][|o]--[o|][|{] *(\w+) *: *"(.*)" */
-          db_or_create(Regexp.last_match(1)).append_relation_queue db_or_create(Regexp.last_match(2)), Regexp.last_match(3)
+          db_or_create(Regexp.last_match(1)).append_relation_queue db_or_create(Regexp.last_match(2)),
+                                                                   Regexp.last_match(3)
         when / *(\w+) *{ */
           append_db_with_attributes Regexp.last_match(1)
-        else
-          nil
         end
       end
     end
@@ -41,8 +40,6 @@ module NotionRubyMapping
           db.add_property Regexp.last_match(1), Regexp.last_match(2)
         when /^ *([^ ]+) +([^ ]+) *$/
           db.add_property Regexp.last_match(1), Regexp.last_match(2)
-        else
-          nil
         end
       end
     end

data/lib/notion_ruby_mapping/controllers/mermaid_database.rb

@@ -1,6 +1,5 @@
 module NotionRubyMapping
   class MermaidDatabase
-
     def initialize(key)
       @key = key
       @name = key
@@ -157,14 +156,12 @@ module NotionRubyMapping
             end
           end
           @working << name
-        else
-          nil
         end
       end
-      while (array = @relation_queue.shift) do
+      while (array = @relation_queue.shift)
         value, relation_db = array
         db_id = relation_db.real_db.id
-        forward, reverse = value.split "|"
+        forward, reverse = value.split("|").map(&:to_s)
         property = ps.values_at(forward).first
         if property
           if reverse
@@ -243,4 +240,4 @@ module NotionRubyMapping
       @reverse_name_queue = {}
     end
   end
-end
+end