notion_ruby_mapping 0.2.3 → 0.3.0

data/lib/notion_ruby_mapping/relation_property.rb

@@ -5,41 +5,94 @@ module NotionRubyMapping
   class RelationProperty < MultiProperty
     TYPE = "relation"
 
-    # @param [String] name
-    # @param [Hash] json
-    # @param [String, Array<String>] relation
-    def initialize(name, will_update: false, json: nil, relation: nil)
-      super name, will_update: will_update
-      @relation = if relation
-                    Array(relation)
-                  elsif json
-                    json.map { |r| r["id"] }
-                  else
-                    []
-                  end
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [Hash, Array]
+    def relation
+      @json
     end
 
-    # @param [String, Array<String>] relation a id or Array of id
-    # @return [Array<String>] settled relation Array
-    def relation=(relation)
+    ## Database property only methods
+
+    # @return [String] relation database_id
+    def relation_database_id
+      assert_database_property __method__
+      @json["database_id"]
+    end
+
+    # @param [String] database_id
+    # @param [String] synced_property_name
+    def replace_relation_database(database_id: nil, synced_property_name: nil)
+      assert_database_property __method__
       @will_update = true
-      @relation = Array(relation)
+      @json["database_id"] = database_id if database_id
+      @json["synced_property_name"] = synced_property_name if synced_property_name
+      @json
     end
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      @relation = json["relation"].map { |r| r["id"] }
+    ### Not public announced methods
+
+    ## Common methods
+
+    # @param [String] name
+    # @param [Hash, Array] json
+    # @param [String, Array] relation
+    def initialize(name, will_update: false, json: nil, relation: nil, base_type: :page)
+      super name, will_update: will_update, base_type: base_type
+      @json = if database?
+                json || {}
+              elsif relation
+                Array(relation).map { |r| {"id" => r} }
+              elsif json
+                json
+              else
+                []
+              end
+    end
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def update_property_schema_json
+      assert_database_property __method__
+      ans = super
+      return ans if ans != {} || !@will_update
+
+      ans[@name] ||= {}
+      ans[@name]["relation"] = @json
+      ans
+    end
+
+    ## Page property only methods
+
+    # @param [String, Array<String>] relation a id or Array of id
+    # @return [Array] settled relation Array
+    def relation=(page_ids)
+      assert_page_property __method__
+      @will_update = true
+      @json = Array(page_ids).map { |r| {"id" => r} }
     end
 
     # @return [Hash] created json
     def property_values_json
+      assert_page_property __method__
       {
         @name => {
           "type" => "relation",
-          "relation" => @relation.map { |rid| {"id" => rid} },
+          "relation" => @json,
         },
       }
     end
+
+    protected
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def property_schema_json_sub
+      {"database_id" => relation_database_id}
+    end
   end
 end

data/lib/notion_ruby_mapping/rich_text_array.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # RichTextObject
+  class RichTextArray
+    include Enumerable
+
+    # @param [Array] json
+    def initialize(key, json: nil, text_objects: nil, will_update: false)
+      @key = key
+      @rich_text_objects = if json
+                             create_from_json(json)
+                           elsif text_objects
+                             Array(text_objects).map do |to|
+                               RichTextObject.text_object to
+                             end
+                           else
+                             []
+                           end
+      @will_update = will_update
+    end
+
+    # @param [Array] json
+    # @return [Array] RichTextArray
+    def create_from_json(json = [])
+      json.map { |rt_json| RichTextObject.create_from_json rt_json }
+    end
+
+    # @param [Numeric] index
+    # @return [NotionRubyMapping::RichTextObject] removed RichTextObject
+    def delete_at(index)
+      @will_update = true
+      @rich_text_objects.delete_at index
+    end
+
+    # @param [Proc] block
+    # @return [Enumerator]
+    def each(&block)
+      return enum_for(:each) unless block
+
+      @rich_text_objects.each(&block)
+    end
+
+    # @return [String]
+    def full_text
+      map(&:text).join ""
+    end
+
+    def property_values_json
+      will_update ? @rich_text_objects.map(&:property_values_json) : []
+    end
+
+    def property_schema_json
+      will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
+    end
+
+    def update_property_schema_json
+      will_update ? {@key => @rich_text_objects.map(&:property_values_json)} : {}
+    end
+
+    # @return [TrueClass, FalseClass] true if it will update
+    def will_update
+      @will_update || @rich_text_objects.map(&:will_update).any?
+    end
+
+    # @param [String, RichTextObject] to
+    # @return [NotionRubyMapping::RichTextObject] added RichTextObject
+    def <<(to)
+      @will_update = true
+      rto = RichTextObject.text_object(to)
+      @rich_text_objects << rto
+      rto
+    end
+
+    # @param [Numeric] index index number
+    # @return [RichTextObject] selected RichTextObject
+    def [](index)
+      @rich_text_objects[index]
+    end
+  end
+end

data/lib/notion_ruby_mapping/rich_text_object.rb

@@ -14,6 +14,7 @@ module NotionRubyMapping
       @type = type
       @options = options
     end
+    attr_reader :will_update
 
     def self.create_from_json(json)
       type = json["type"]

data/lib/notion_ruby_mapping/rich_text_property.rb

@@ -5,14 +5,25 @@ module NotionRubyMapping
   class RichTextProperty < TextProperty
     TYPE = "rich_text"
 
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [Hash] json
     def update_from_json(json)
       @will_update = false
-      @text_objects = json["rich_text"].map { |to| RichTextObject.create_from_json to }
+      if database?
+        @json = json["rich_text"] || {}
+      else
+        @text_objects = RichTextArray.new "rich_text", json: json["rich_text"]
+      end
     end
 
+    ## Page property only methods
+
     # @return [Hash] created json
     def property_values_json
+      assert_page_property __method__
       text_json = @text_objects.map(&:property_values_json)
       {
         @name => {

data/lib/notion_ruby_mapping/rollup_property.rb

@@ -8,22 +8,94 @@ module NotionRubyMapping
     include GreaterThanLessThan
     TYPE = "rollup"
 
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [Hash]
+    def rollup
+      @json
+    end
+
+    ## Database property only methods
+
+    # @return [String] new or settled function
+    def function
+      assert_database_property __method__
+      @json["function"]
+    end
+
+    # @param [String] func
+    def function=(func)
+      assert_database_property __method__
+      @will_update = true
+      @json["function"] = func
+    end
+
+    # @return [String] new or settled relation_property_name
+    def relation_property_name
+      assert_database_property __method__
+      @json["relation_property_name"]
+    end
+
+    # @param [String] rpn
+    def relation_property_name=(rpn)
+      assert_database_property __method__
+      @will_update = true
+      @json["relation_property_name"] = rpn
+    end
+
+    # @return [String] new or settled rollup_property_name
+    def rollup_property_name
+      assert_database_property __method__
+      @json["rollup_property_name"]
+    end
+
+    # @param [String] rpn
+    def rollup_property_name=(rpn)
+      assert_database_property __method__
+      @will_update = true
+      @json["rollup_property_name"] = rpn
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name
     # @param [Hash] json
-    def initialize(name, json: nil)
-      super name, will_update: false
-      @json = json
+    def initialize(name, will_update: false, json: nil, base_type: :page)
+      super name, will_update: will_update, base_type: base_type
+      @json = json || {}
     end
 
-    # @return [Hash] {} created_time cannot be updated
-    def property_values_json
-      {}
+    ## Database property only methods
+
+    # @return [Hash]
+    def update_property_schema_json
+      assert_database_property __method__
+      ans = super
+      return ans if ans != {} || !@will_update
+
+      ans[@name] ||= {}
+      ans[@name]["rollup"] ||= {}
+      ans[@name]["rollup"]["function"] = function
+      ans[@name]["rollup"]["relation_property_name"] = relation_property_name
+      ans[@name]["rollup"]["rollup_property_name"] = rollup_property_name
+      ans
     end
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      @json = json["rollup"]
+    protected
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def property_schema_json_sub
+      {
+        "function" => function,
+        "relation_property_name" => relation_property_name,
+        "rollup_property_name" => rollup_property_name,
+      }
     end
   end
 end

data/lib/notion_ruby_mapping/select_property.rb

@@ -7,30 +7,105 @@ module NotionRubyMapping
     include IsEmptyIsNotEmpty
     TYPE = "select"
 
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [Hash]
+    def select
+      @json
+    end
+
+    ## Page property only methods
+
+    # @return [String]
+    def select_name
+      assert_page_property __method__
+      @json["name"]
+    end
+
+    ## Database property only methods
+
+    # @param [String] name
+    # @param [String] color
+    # @return [Array] added array
+    def add_select_options(name:, color:)
+      edit_select_options << {"name" => name, "color" => color}
+    end
+
+    # @return [Array] copyed multi select options
+    def edit_select_options
+      assert_database_property __method__
+      @will_update = true
+      @json["options"] ||= []
+    end
+
+    # @return [Array]
+    def select_options
+      assert_database_property __method__
+      @json["options"] || []
+    end
+
+    # @return [String]
+    def select_names
+      assert_database_property __method__
+      @json["options"].map { |s| s["name"] }
+    end
+
+    ## Page property only methods
+
+    # @param [String] select
+    # @return [Hash] settled value
+    def select=(select)
+      @will_update = true
+      @json = {"name" => select}
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name Property name
     # @param [Hash] json
     # @param [String] select String value (optional)
-    def initialize(name, will_update: false, json: nil, select: nil)
-      super name, will_update: will_update
-      @select = select || json && json["name"]
+    def initialize(name, will_update: false, base_type: :page, json: nil, select: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = if database?
+                json || {"options" => []}
+              else
+                json || {"name" => select}
+              end
     end
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      @select = json["select"]["name"]
+    ## Database property only methods
+
+    # @return [Hash]
+    def update_property_schema_json
+      assert_database_property __method__
+      ans = super
+      return ans if ans != {} || !@will_update
+
+      ans[@name] ||= {}
+      ans[@name]["select"] ||= {}
+      ans[@name]["select"]["options"] = @json["options"]
+      ans
     end
 
+    ## Page property only methods
+
     # @return [Hash]
     def property_values_json
-      {@name => {"type" => "select", "select" => (@select ? {"name" => @select} : @json)}}
+      assert_page_property __method__
+      {@name => {"type" => "select", "select" => @json}}
     end
 
-    # @param [String] select
-    # @return [String] settled value
-    def select=(select)
-      @will_update = true
-      @select = select
+    protected
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def property_schema_json_sub
+      {"options" => edit_select_options}
     end
   end
 end

data/lib/notion_ruby_mapping/text_object.rb

@@ -14,7 +14,6 @@ module NotionRubyMapping
     attr_reader :text, :will_update
 
     # @param [String, RichTextObject] value
-    # @return [RichTextObject] self
     def text=(value)
       @will_update = true
       if value.is_a? RichTextObject
@@ -24,7 +23,6 @@ module NotionRubyMapping
         @text = value
         @options["plain_text"] = value
       end
-      self
     end
 
     protected

data/lib/notion_ruby_mapping/text_property.rb

@@ -12,61 +12,35 @@ module NotionRubyMapping
     include StartsWithEndsWith
     include IsEmptyIsNotEmpty
 
+    ### Public announced methods
+
+    ## Page property only methods
+
+    attr_reader :text_objects
+
+    def_delegators :@text_objects, :[], :<<, :each, :full_text, :delete_at
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name
-    # @param [Hash] json
+    # @param [Hash, Array] json
     # @param [Array<RichTextObject>] text_objects
-    def initialize(name, will_update: false, json: nil, text_objects: nil)
+    def initialize(name, will_update: false, base_type: :page, json: nil, text_objects: nil)
       raise StandardError, "TextObject is abstract class.  Please use RichTextProperty." if instance_of? TextProperty
 
-      super name, will_update: will_update
-      @text_objects = if text_objects
-                        text_objects.map { |to_s| RichTextObject.text_object to_s }
-                      elsif json
-                        json.map { |to| RichTextObject.create_from_json to }
+      super name, will_update: will_update, base_type: base_type
+      @text_objects = if database?
+                        json || {}
                       else
-                        []
+                        RichTextArray.new "title", json: json, text_objects: text_objects
                       end
     end
-    attr_reader :text_objects
 
     # @return [TrueClass, FalseClass] will update?
     def will_update
-      @will_update || @text_objects.map(&:will_update).any?
-    end
-
-    # @param [Proc] block
-    # @return [Enumerator]
-    def each(&block)
-      return enum_for(:each) unless block
-
-      @text_objects.each(&block)
-    end
-
-    # @param [String, RichTextObject] to
-    # @return [NotionRubyMapping::RichTextObject] added RichTextObject
-    def <<(to)
-      @will_update = true
-      rto = RichTextObject.text_object(to)
-      @text_objects << rto
-      rto
-    end
-
-    # @param [Numeric] index index number
-    # @return [RichTextObject] selected RichTextObject
-    def [](index)
-      @text_objects[index]
-    end
-
-    # @param [Numeric] index
-    # @return [NotionRubyMapping::RichTextObject] removed RichTextObject
-    def delete_at(index)
-      @will_update = true
-      @text_objects[index]
-    end
-
-    # @return [String] full_text
-    def full_text
-      map(&:text).join ""
+      @will_update || page? && @text_objects.will_update
     end
   end
 end

data/lib/notion_ruby_mapping/title_property.rb

@@ -5,14 +5,25 @@ module NotionRubyMapping
   class TitleProperty < TextProperty
     TYPE = "title"
 
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [Hash] json
     def update_from_json(json)
       @will_update = false
-      @text_objects = json["title"].map { |to| RichTextObject.create_from_json to }
+      if database?
+        @json = json || {}
+      else
+        @text_objects = RichTextArray.new "rich_text", json: json["title"]
+      end
     end
 
+    ## Page property only methods
+
     # @return [Hash] created json
     def property_values_json
+      assert_page_property __method__
       text_json = map(&:property_values_json)
       {
         @name => {

data/lib/notion_ruby_mapping/url_property.rb

@@ -9,28 +9,39 @@ module NotionRubyMapping
     include IsEmptyIsNotEmpty
     TYPE = "url"
 
+    ### Public announced methods
+
+    ## Common methods
+
+    # @return [String, Hash, nil] url (Page), {} (Database)
+    def url
+      @json
+    end
+
+    ## Page property only methods
+
+    def url=(url)
+      @will_update = true
+      @json = url
+    end
+
+    ### Not public announced methods
+
+    ## Common methods
+
     # @param [String] name Property name
     # @param [String] url url value (optional)
-    def initialize(name, will_update: false, url: nil)
-      super name, will_update: will_update
-      @url = url
+    def initialize(name, will_update: false, base_type: :page, json: nil)
+      super name, will_update: will_update, base_type: base_type
+      @json = json || (database? ? {} : nil)
     end
-    attr_reader :url
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      @url = json["url"]
-    end
+    ## Page property only methods
 
     # @return [Hash]
     def property_values_json
-      {@name => {"url" => @url, "type" => "url"}}
-    end
-
-    def url=(url)
-      @will_update = true
-      @url = url
+      assert_page_property __method__
+      {@name => {"url" => @json, "type" => "url"}}
     end
   end
 end

data/lib/notion_ruby_mapping/user_object.rb

@@ -14,11 +14,11 @@ module NotionRubyMapping
 
     # @param [UserObject, String] uo
     # @return [UserObject] self or created UserObject
-    def self.user_object(uo)
-      if uo.is_a? UserObject
-        uo
+    def self.user_object(user_id_or_user)
+      if user_id_or_user.is_a? UserObject
+        user_id_or_user
       else
-        UserObject.new user_id: uo
+        UserObject.new user_id: user_id_or_user
       end
     end
 

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
   NOTION_VERSION = "2022-02-22"
 end

data/lib/notion_ruby_mapping.rb

@@ -6,6 +6,7 @@ require "yaml"
    url_property email_property phone_number_property number_property checkbox_property select_property multi_property
    multi_select_property date_base_property date_property created_time_property last_edited_time_property
    people_property created_by_property last_edited_by_property files_property relation_property formula_property
-   rollup_property query payload property_cache rich_text_object text_object mention_object user_object].each do |k|
+   rollup_property query payload property_cache rich_text_object text_object mention_object user_object
+   rich_text_array].each do |k|
   require_relative "notion_ruby_mapping/#{k}"
 end