notion_ruby_mapping 0.8.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6b2157ccc35fd74afcb19e5c3a1f79a47fc85bbd37a40615244d7ab0e94dcc
-  data.tar.gz: 8a8b3a3a816159cf1759ffef5bc2a3c2a8cd4533fa0aa85591c6a0079fb8e8c7
+  metadata.gz: 0d1066cd6c3332c90c8370e13f4cc52e9e729b29df0726ebad6279825d56f2a6
+  data.tar.gz: 85a67ad41b4ffb73578568e804c395b9fd0fb0f69ac6b535c3ddef0f8927e6e5
 SHA512:
-  metadata.gz: d39c8c323487e2cad1782dd3b19a9f3a02b6c843fe31a4d61dc4ddd23af7de1f81f22c4a29a085ffe510d76186738c99246f1bb2f7fd87c8b0085db8c74d3bed
-  data.tar.gz: 18d4e3bdc38409ff21a76e76129a1b208c28ab539d02f9fa17662b70d1d56dbab084bda4cd467fccafab421174b55b9fc8556f1e19f39e35a2953cffefe68f5f
+  metadata.gz: 3356a1466bae782aee4e51f6b14849e7c7a429b692bc0f6cb1108190d42f12231ca48975e3cd17cb271ac015d38f68d7aafd22edf9b6688e0e4ecd3ab7d59c8d
+  data.tar.gz: 4272a59512daad50200fb919483a2b36044fa5dd875c20289b90871a0e276b0771b3f6235eae94df09421afbf862f1fb8f8726a6efb0b11f79b0ade0dfbdab04

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

@@ -10,13 +10,13 @@ module NotionRubyMapping
     def initialize(json: nil, id: nil, assign: [], parent: nil)
       @nc = NotionCache.instance
       @json = json
-      @id = @nc.hex_id(id || @json && @json["id"])
-      @archived = @json && @json["archived"]
-      @has_children = @json && @json["has_children"]
+      @id = @nc.hex_id(id || @json && @json[:id])
+      @archived = @json && @json[:archived]
+      @has_children = @json && @json[:has_children]
       @new_record = true unless parent.nil?
       raise StandardError, "Unknown id" if !is_a?(List) && !is_a?(Block) && @id.nil? && parent.nil?
 
-      @payload = Payload.new(!is_a?(Block) && parent && {"parent" => parent})
+      @payload = Payload.new(!is_a?(Block) && parent && {parent: parent})
       @property_cache = nil
       @created_time = nil
       @last_edited_time = nil
@@ -30,14 +30,14 @@ module NotionRubyMapping
     # @param [Hash, Notion::Messages] json
     # @return [NotionRubyMapping::Base]
     def self.create_from_json(json)
-      case json["object"]
-      when "page"
+      case json[:object]&.to_sym
+      when :page
         Page.new json: json
-      when "database"
+      when :database
         Database.new json: json
-      when "list"
+      when :list
         List.new json: json
-      when "block"
+      when :block
         Block.decode_block json
       else
         raise StandardError, json.inspect
@@ -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
@@ -110,7 +110,7 @@ module NotionRubyMapping
         reload
       end
       case key
-      when "properties"
+      when :properties
         properties
       else
         @json[key]
@@ -128,20 +128,20 @@ 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,
       }
-      json["after"] = after if after
+      json[:after] = after if after
       if dry_run
         path = @nc.append_block_children_page_path(id)
         self.class.dry_run_script :patch, path, json
       else
         response = @nc.append_block_children_request @id, json
-        raise StandardError, response unless response["results"]
+        raise StandardError, response unless response[:results]
 
-        answers = response["results"].map { |sub_json| Block.create_from_json sub_json }
+        answers = response[:results].map { |sub_json| Block.create_from_json sub_json }
         only_one ? answers.first : answers
       end
     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
@@ -199,7 +199,7 @@ module NotionRubyMapping
 
     # @return [NotionRubyMapping::CreatedTimeProperty]
     def created_time
-      @created_time ||= CreatedTimeProperty.new("__timestamp__", json: self["created_time"])
+      @created_time ||= CreatedTimeProperty.new("__timestamp__", json: self[:created_time])
     end
 
     # @return [TrueClass, FalseClass] true if Database object
@@ -210,7 +210,7 @@ module NotionRubyMapping
     # @return [Hash, nil] obtained Hash
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#e13d526bd709451e9b06fd32e8d07fcd
     def icon
-      self["icon"]
+      self[:icon]
     end
 
     # @return [String (frozen)]
@@ -220,12 +220,12 @@ module NotionRubyMapping
 
     # @return [Hash] json properties
     def json_properties
-      @json && @json["properties"]
+      @json && @json[:properties]
     end
 
     # @return [NotionRubyMapping::LastEditedTimeProperty]
     def last_edited_time
-      @last_edited_time ||= LastEditedTimeProperty.new("__timestamp__", json: self["last_edited_time"])
+      @last_edited_time ||= LastEditedTimeProperty.new("__timestamp__", json: self[:last_edited_time])
     end
 
     # @return [Boolean] true if new record
@@ -241,16 +241,16 @@ module NotionRubyMapping
 
     # @param [Boolean] dry_run true if dry_run
     def parent(dry_run: false)
-      parent_json = @json && @json["parent"]
+      parent_json = @json && @json[:parent]
       raise StandardError, "Unknown parent" if parent_json.nil?
 
-      type = parent_json["type"]
+      type = parent_json[:type]&.to_sym
       klass = case type
-              when "database_id"
+              when :database_id
                 Database
-              when "page_id"
+              when :page_id
                 Page
-              when "block_id"
+              when :block_id
                 Block
               else
                 raise StandardError, "List does not have any parent"
@@ -259,10 +259,10 @@ module NotionRubyMapping
     end
 
     def parent_id
-      parent_json = @json && @json["parent"]
+      parent_json = @json && @json[:parent]
       raise StandardError, "Unknown parent" if parent_json.nil?
 
-      parent_json[parent_json["type"]]
+      parent_json[parent_json[:type]]
     end
 
     # @return [NotionRubyMapping::PropertyCache] get or created PropertyCache object
@@ -294,13 +294,13 @@ module NotionRubyMapping
 
     # @return [NotionRubyMapping::Base]
     def restore_from_json
-      return if (ps = @json["properties"]).nil?
+      return if (ps = @json[:properties]).nil?
 
       properties.json = json_properties
       return unless is_a?(Page) || is_a?(Database)
 
       ps.each do |key, json|
-        if json["type"]
+        if json[:type]
           properties[key].update_from_json json
         else
           properties[key]&.clear_will_update
@@ -341,13 +341,13 @@ module NotionRubyMapping
     # @param [Hash] json
     # @return [NotionRubyMapping::Base]
     def update_json(json)
-      unless json["object"] != "error" && (@json.nil? || @json["type"] == json["type"])
+      unless json[:object] != "error" && (@json.nil? || @json[:type] == json[:type])
         raise StandardError,
               json.inspect
       end
 
       @json = json
-      @id = @nc.hex_id(@json["id"])
+      @id = @nc.hex_id(@json[:id])
       restore_from_json
       self
     end

data/lib/notion_ruby_mapping/blocks/block.rb

@@ -15,51 +15,52 @@ module NotionRubyMapping
     attr_reader :can_have_children, :can_append, :type, :rich_text_array, :url, :caption, :color, :language
 
     def self.type2class(type, has_children = false)
+      type_sym = type.to_sym
       @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_sym] || @type2class[false][type_sym] || Block
     end
 
     def self.decode_block(json)
-      type2class(json["type"], json["has_children"]).new json: json
+      type2class(json[:type], json[:has_children]).new json: json
     end
 
     # @see https://www.notion.so/hkob/Block-689ad4cbff50404d8a1baf67b6d6d78d#298916c7c379424682f39ff09ee38544
@@ -80,36 +81,36 @@ 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
     # @return [Hash{String (frozen)->Hash}]
     def block_json(not_update: true)
-      ans = {"type" => type}
-      ans["object"] = "block"
-      ans["archived"] = true if @archived
+      ans = {type: type.to_s}
+      ans[:object] = "block"
+      ans[:archived] = true if @archived
       ans
     end
 
     # @return [Hash{String (frozen)->Array<Hash{String (frozen)->Hash}>}]
     def children_block_json
-      {"children" => [block_json]}
+      {children: [block_json]}
     end
 
     # @return [NotionRubyMapping::RichTextArray]
     def decode_block_caption
-      @caption = RichTextArray.new "caption", json: @json[type]["caption"]
+      @caption = RichTextArray.new :caption, json: @json[type][:caption]
     end
 
     # @return [String]
     def decode_color
-      @color = @json[type]["color"]
+      @color = @json[type][:color]
     end
 
     # @return [NotionRubyMapping::RichTextArray]
     def decode_block_rich_text_array
-      @rich_text_array = RichTextArray.new "rich_text", json: @json[type]["rich_text"]
+      @rich_text_array = RichTextArray.new :rich_text, json: @json[type][:rich_text]
     end
 
     # @param [Boolean] dry_run true if dry_run
@@ -144,10 +145,10 @@ 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
+      @rich_text_array = RichTextArray.rich_text_array type.to_sym, text_info
       @color = color
       self
     end

data/lib/notion_ruby_mapping/blocks/bookmark_block.rb

@@ -5,7 +5,7 @@ module NotionRubyMapping
   class BookmarkBlock < UrlCaptionBaseBlock
     # @return [String (frozen)]
     def type
-      "bookmark"
+      :bookmark
     end
   end
 end

data/lib/notion_ruby_mapping/blocks/breadcrumb_block.rb

@@ -5,7 +5,7 @@ module NotionRubyMapping
   class BreadcrumbBlock < Block
     # @return [String (frozen)]
     def type
-      "breadcrumb"
+      :breadcrumb
     end
 
     # @param [Boolean] not_update false when update

data/lib/notion_ruby_mapping/blocks/bulleted_list_item_block.rb

@@ -5,7 +5,7 @@ module NotionRubyMapping
   class BulletedListItemBlock < TextSubBlockColorBaseBlock
     # @return [String (frozen)]
     def type
-      "bulleted_list_item"
+      :bulleted_list_item
     end
   end
 end

data/lib/notion_ruby_mapping/blocks/callout_block.rb

@@ -15,7 +15,7 @@ module NotionRubyMapping
         decode_block_rich_text_array
         decode_color
       else
-        rich_text_array_and_color "rich_text", text_info, color
+        rich_text_array_and_color :rich_text, text_info, color
         @emoji = EmojiObject.emoji_object emoji if emoji
         @file_object = FileObject.file_object file_url if file_url
         add_sub_blocks sub_blocks
@@ -32,10 +32,10 @@ module NotionRubyMapping
     def block_json(not_update: true)
       ans = super
       ans[type] = @rich_text_array.update_property_schema_json not_update
-      ans[type]["color"] = @color
-      ans[type]["icon"] = @emoji.property_values_json if @emoji
-      ans[type]["icon"] = @file_object.property_values_json if @file_object
-      ans[type]["children"] = @sub_blocks.map(&:block_json) if @sub_blocks
+      ans[type][:color] = @color
+      ans[type][:icon] = @emoji.property_values_json if @emoji
+      ans[type][:icon] = @file_object.property_values_json if @file_object
+      ans[type][:children] = @sub_blocks.map(&:block_json) if @sub_blocks
       ans
     end
 
@@ -43,7 +43,7 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/CalloutBlock-0eb8b64bea664bc89fad706a866a6e26#b3598e385c2d4a23ada506441a7f0f32
     def color=(new_color)
       @color = new_color
-      @payload.add_update_block_key "color"
+      @payload.add_update_block_key :color
     end
 
     # @return [String, nil]
@@ -57,7 +57,7 @@ module NotionRubyMapping
     def emoji=(emoji)
       @emoji = EmojiObject.emoji_object emoji
       @file_object = nil
-      @payload.add_update_block_key "icon"
+      @payload.add_update_block_key :icon
     end
 
     # @return [String]
@@ -71,12 +71,12 @@ module NotionRubyMapping
     def file_url=(url)
       @file_object = FileObject.file_object url
       @emoji = nil
-      @payload.add_update_block_key "icon"
+      @payload.add_update_block_key :icon
     end
 
-    # @return [String (frozen)]
+    # @return [Symbol]
     def type
-      "callout"
+      :callout
     end
   end
 end

data/lib/notion_ruby_mapping/blocks/child_base_block.rb

@@ -5,7 +5,7 @@ module NotionRubyMapping
   class ChildBaseBlock < Block
     def initialize(json: nil, id: nil, parent: nil)
       super
-      @title = @json[type]["title"]
+      @title = @json[type][:title]
       @can_append = false
       @can_append = false
     end
@@ -14,7 +14,7 @@ module NotionRubyMapping
     # @return [Hash{String (frozen)->Hash}]
     def block_json(not_update: true)
       ans = super
-      ans[type] = {"title" => @title}
+      ans[type] = {title: @title}
       ans
     end
   end

data/lib/notion_ruby_mapping/blocks/child_database_block.rb

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

data/lib/notion_ruby_mapping/blocks/child_page_block.rb

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

data/lib/notion_ruby_mapping/blocks/code_block.rb

@@ -12,10 +12,10 @@ module NotionRubyMapping
       if @json
         decode_block_rich_text_array
         decode_block_caption
-        @language = json[type]["language"] || "shell"
+        @language = json[type][:language] || "shell"
       else
-        rich_text_array_and_color "rich_text", text_info
-        @caption = RichTextArray.rich_text_array "caption", caption
+        rich_text_array_and_color :rich_text, text_info
+        @caption = RichTextArray.rich_text_array :caption, caption
         @language = language
       end
     end
@@ -32,19 +32,19 @@ module NotionRubyMapping
       ans[type] = @rich_text_array.update_property_schema_json(not_update).merge(
         @caption.update_property_schema_json(not_update),
       )
-      ans[type]["language"] = @language
+      ans[type][:language] = @language
       ans
     end
 
     # @param [String] new_language
     def language=(new_language)
       @language = new_language
-      @payload.add_update_block_key "language"
+      @payload.add_update_block_key :language
     end
 
-    # @return [String (frozen)]
+    # @return [Symbol]
     def type
-      "code"
+      :code
     end
   end
 end

data/lib/notion_ruby_mapping/blocks/column_block.rb

@@ -12,9 +12,9 @@ module NotionRubyMapping
       @can_append = false
     end
 
-    # @return [String (frozen)]
+    # @return [Symbol]
     def type
-      "column"
+      :column
     end
 
     # @param [Boolean] not_update false when update
@@ -22,7 +22,7 @@ module NotionRubyMapping
     def block_json(not_update: true)
       ans = super
       ans[type] = {}
-      ans[type]["children"] = @sub_blocks.map(&:block_json) if @sub_blocks
+      ans[type][:children] = @sub_blocks.map(&:block_json) if @sub_blocks
       ans
     end
   end

data/lib/notion_ruby_mapping/blocks/column_list_block.rb

@@ -18,7 +18,7 @@ module NotionRubyMapping
 
     # @return [String (frozen)]
     def type
-      "column_list"
+      :column_list
     end
 
     # @param [Boolean] not_update false when update
@@ -26,7 +26,7 @@ module NotionRubyMapping
     def block_json(not_update: true)
       ans = super
       ans[type] = {}
-      ans[type]["children"] = @columns.map(&:block_json) if @columns
+      ans[type][:children] = @columns.map(&:block_json) if @columns
       ans
     end
   end

data/lib/notion_ruby_mapping/blocks/database.rb

@@ -42,7 +42,7 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#c217ce78020a4de79b720790fce3092d
     def build_child_page(*assign)
       assign = properties.map { |p| [p.class, p.name] }.flatten if assign.empty?
-      page = Page.new assign: assign, parent: {"database_id" => @id}
+      page = Page.new assign: assign, parent: {database_id: @id}
       pp = page.properties
       pp.clear_will_update
       yield page, pp if block_given?
@@ -55,7 +55,7 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#c217ce78020a4de79b720790fce3092d
     def create_child_page(*assign, dry_run: false)
       assign = properties.map { |p| [p.class, p.name] }.flatten if assign.empty?
-      page = Page.new assign: assign, parent: {"database_id" => @id}
+      page = Page.new assign: assign, parent: {database_id: @id}
       pp = page.properties
       pp.clear_will_update
       yield page, pp if block_given?
@@ -65,12 +65,12 @@ module NotionRubyMapping
     # @return [NotionRubyMapping::RichTextArray]
     # @see https://www.notion.so/hkob/Database-1462b24502424539a4231bedc07dc2f5#217a7d988c404d68b270c4874a9117b4
     def database_title
-      @database_title ||= RichTextArray.new "title", json: (self["title"]), will_update: new_record?
+      @database_title ||= RichTextArray.new :title, json: (self[:title]), will_update: new_record?
     end
 
     # @return [NotionRubyMapping::RichTextArray]
     def description
-      RichTextArray.new "description", json: self["description"]
+      RichTextArray.new :description, json: self[:description]
     end
 
     # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
@@ -80,7 +80,7 @@ module NotionRubyMapping
 
     # @return [Boolean]
     def is_inline
-      self["is_inline"]
+      self[:is_inline]
     end
 
     # @param [Boolean] flag
@@ -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/divider_block.rb

@@ -13,7 +13,7 @@ module NotionRubyMapping
 
     # @return [String (frozen)]
     def type
-      "divider"
+      :divider
     end
   end
 end