notion_ruby_mapping 4.0.2 → 4.2.0

data/lib/notion_ruby_mapping/properties/property.rb

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
-require "forwardable"
-
 module NotionRubyMapping
   # abstract class for property
   class Property
-    extend Forwardable
-
     ### Public announced methods
 
     ## Common methods
@@ -14,18 +10,6 @@ module NotionRubyMapping
     attr_reader :name, :will_update, :property_id
     attr_accessor :property_cache
 
-    def_delegators :retrieve_page_property, :<<, :[], :add_person, :add_relation, :checkbox, :checkbox=, :created_by,
-                   :created_time, :date, :each, :email, :email=, :end_date, :end_date=, :files, :files=, :filter_after,
-                   :filter_before, :filter_contains, :filter_does_not_contain, :filter_does_not_equal,
-                   :filter_ends_with, :filter_equals, :filter_greater_than, :filter_greater_than_or_equal_to,
-                   :filter_is_empty, :filter_is_not_empty, :filter_less_than, :filter_less_than_or_equal_to,
-                   :filter_next_month, :filter_next_week, :filter_next_year, :filter_on_or_after, :filter_on_or_before,
-                   :filter_past_month, :filter_past_week, :filter_past_year, :filter_starts_with, :formula, :full_text,
-                   :last_edited_by, :last_edited_time, :multi_select, :multi_select=, :multi_select_names, :number,
-                   :number=, :people, :people=, :phone_number, :phone_number=, :property_values_json, :relation=,
-                   :rollup, :start_date, :start_date=, :time_zone, :time_zone=, :select, :select=, :select_name, :url,
-                   :url=, :start_date_obj, :end_date_obj
-
     ## Database property only methods
 
     # @param [String] new_name
@@ -72,12 +56,13 @@ module NotionRubyMapping
 
       type = input_json["type"]
       if type.nil?
-        new name, property_id: input_json["id"], base_type: base_type, property_cache: property_cache, query: query
+        raise StandardError, "Property value is not returned: #{name}"
       elsif type == "property_item"
         tmp = new name, property_id: input_json["property_item"]["id"], base_type: base_type,
                         property_cache: property_cache, query: query
         objects = List.new(json: input_json, type: "property", value: tmp, query: query).to_a
-        case input_json["property_item"]["type"]
+        input_type = input_json["property_item"]["type"]
+        case input_type
         when "people"
           PeopleProperty.new name, people: objects, base_type: base_type,
                                    property_cache: property_cache, query: query
@@ -94,7 +79,7 @@ module NotionRubyMapping
           TitleProperty.new name, text_objects: objects, base_type: base_type,
                                   property_cache: property_cache, query: query
         else
-          raise StandardError, "Irregular property type: #{input_json["property_item"]["type"]}"
+          raise StandardError, "Unsupported property type: #{input_type} (#{name}). Please update notion_ruby_mapping."
         end
       else
         klass = {
@@ -123,7 +108,10 @@ module NotionRubyMapping
           url: UrlProperty,
           verification: VerificationProperty,
         }[type.to_sym]
-        raise StandardError, "Irregular property type: #{type}" unless klass
+        unless klass
+          raise StandardError,
+                "Unsupported property type: #{type} (#{name}). Please update notion_ruby_mapping."
+        end
 
         answer = klass.new name, property_id: input_json["id"], json: input_json[type], base_type: base_type,
                                  property_cache: property_cache
@@ -152,11 +140,6 @@ module NotionRubyMapping
       %w[database data_source].include? @base_type
     end
 
-    # @return [TrueClass, FalseClass] true if it has Property contents
-    def contents?
-      !instance_of? Property
-    end
-
     # @param [String] key query parameter
     # @param [Object] value query value
     # @return [NotionRubyMapping::Query] generated Query object
@@ -180,26 +163,21 @@ module NotionRubyMapping
     # @param [Hash] json
     def update_from_json(json)
       @will_update = false
-      return unless contents?
+      return unless json.key?(type)
 
-      @json = json[type] if json[type] && json[type] != "property_item"
+      @json = json[type]
     end
 
-    # @return [Symbol] property type
+    # @return [String] property type
     def type
       self.class::TYPE
     end
 
     ## Database property only methods
 
-    # @param [Symbol, nil] method
-    def assert_database_property(method)
-      raise StandardError, "#{method} can execute only Database property." unless database?
-    end
-
     # @param [Symbol, nil] method
     def assert_database_or_data_source_property(method)
-      raise StandardError, "#{method} can execute only Database property." if page?
+      raise StandardError, "#{method} can execute only Database or DataSource property." unless database_or_data_source?
     end
 
     # @return [Hash]
@@ -209,6 +187,7 @@ module NotionRubyMapping
     end
 
     ## DataSource property only methods
+    # @param [Symbol, nil] method
     def assert_data_source_property(method)
       raise StandardError, "#{method} can execute only DataSource property." unless data_source?
     end
@@ -229,7 +208,7 @@ module NotionRubyMapping
 
     # @param [Symbol, nil] method
     def assert_page_property(method)
-      raise StandardError, "#{method} can execute only Page property." if database? || data_source?
+      raise StandardError, "#{method} can execute only Page property." unless page?
     end
 
     # @return [NotionRubyMapping::Property, Array<UserObject>, nil]

data/lib/notion_ruby_mapping/properties/relation_property.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  # MultiSelect property
+  # Relation property
   class RelationProperty < MultiProperty
     TYPE = "relation"
+    RELATION_PROPERTY_TYPES = %w[dual_property single_property].freeze
 
     ### Public announced methods
 
     ## Common methods
 
-    # @return [Hash, Array, nil]
+    # @return [Array<Hash>, Hash, nil] relation value or relation schema
     # @see https://www.notion.so/hkob/RelationProperty-f608ab41a1f0476b98456620346fba03#6c14207b2d1340d2bbc08d17eee2cb22
     def relation
       @json
@@ -35,6 +36,7 @@ module NotionRubyMapping
     def relation=(page_ids_or_jsons)
       assert_page_property __method__
       @will_update = true
+      page_ids_or_jsons = [] if page_ids_or_jsons.nil?
       page_ids_or_jsons = [page_ids_or_jsons] unless page_ids_or_jsons.is_a? Array
 
       @json = page_ids_or_jsons.map do |page_id_or_json|
@@ -47,7 +49,7 @@ module NotionRubyMapping
     # @return [String] relation data_source_id
     # @see https://www.notion.so/hkob/RelationProperty-f608ab41a1f0476b98456620346fba03#eb40f1a2ad5c4e368d343870a7e529f9
     def relation_data_source_id
-      assert_data_source_property __method__
+      assert_database_or_data_source_property __method__
       @json["data_source_id"]
     end
 
@@ -56,6 +58,8 @@ module NotionRubyMapping
     # @see https://www.notion.so/hkob/RelationProperty-f608ab41a1f0476b98456620346fba03#7f5029fb7f6e4c009f22888b233e6f64
     def replace_relation_data_source(data_source_id: nil, type: "dual_property")
       assert_database_or_data_source_property __method__
+      raise ArgumentError, "type must be dual_property or single_property" unless RELATION_PROPERTY_TYPES.include? type
+
       @will_update = true
       @json["data_source_id"] = data_source_id if data_source_id
       @json["type"] = type
@@ -97,10 +101,6 @@ module NotionRubyMapping
       ans
     end
 
-    def data_source_id
-      @json["data_source_id"]
-    end
-
     # @return [TrueClass, FalseClass] true if dual_property
     def dual_property?
       assert_database_or_data_source_property __method__

data/lib/notion_ruby_mapping/properties/rich_text_property.rb

@@ -9,28 +9,6 @@ module NotionRubyMapping
 
     ## Common methods
 
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      if database_or_data_source?
-        @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 => {
-          "type" => "rich_text",
-          "rich_text" => text_json.empty? ? (@json || []) : text_json,
-        },
-      }
-    end
   end
 end

data/lib/notion_ruby_mapping/properties/select_property.rb

@@ -11,7 +11,7 @@ module NotionRubyMapping
 
     ## Common methods
 
-    # @return [Hash]
+    # @return [Hash] raw select object for page property, or select schema object for database/data_source property
     # @see https://www.notion.so/hkob/SelectProperty-6d6a0defa70d4b26af0fdbdcfbf99f28#7ad3734ac42c43068f1e04633bab400b
     def select
       @json
@@ -19,7 +19,7 @@ module NotionRubyMapping
 
     ## Page property only methods
 
-    # @return [String]
+    # @return [String, nil]
     # @see https://www.notion.so/hkob/SelectProperty-6d6a0defa70d4b26af0fdbdcfbf99f28#27a05e52715a4acd9156b5f146653e51
     def select_name
       assert_page_property __method__
@@ -30,27 +30,27 @@ module NotionRubyMapping
 
     # @param [String] name
     # @param [String] color
-    # @return [Array] added array
+    # @return [Array<Hash>] updated select options
     # @see https://www.notion.so/hkob/SelectProperty-6d6a0defa70d4b26af0fdbdcfbf99f28#3e1c7dbda7fb455f94ee93d9653b7880
     def add_select_option(name:, color:)
       edit_select_options << {"name" => name, "color" => color}
     end
 
-    # @return [Array] copyed multi select options
+    # @return [Array<Hash>] editable select options
     def edit_select_options
       assert_database_or_data_source_property __method__
       @will_update = true
       @json["options"] ||= []
     end
 
-    # @return [Array]
+    # @return [Array<Hash>]
     # @see https://www.notion.so/hkob/SelectProperty-6d6a0defa70d4b26af0fdbdcfbf99f28#790a297f2c1b4ba5a4d86074d4c70a89
     def select_options
       assert_database_or_data_source_property __method__
       @json["options"] || []
     end
 
-    # @return [String]
+    # @return [Array<String>]
     # @see https://www.notion.so/hkob/SelectProperty-6d6a0defa70d4b26af0fdbdcfbf99f28#72da1632793c4a5296f3bc89de2df413
     def select_names
       assert_database_or_data_source_property __method__
@@ -59,12 +59,12 @@ module NotionRubyMapping
 
     ## Page property only methods
 
-    # @param [String] select
+    # @param [String, nil] name
     # @see https://www.notion.so/hkob/SelectProperty-6d6a0defa70d4b26af0fdbdcfbf99f28#3bd195bf5c0a498ebf850409f7deb67a
-    def select=(select)
+    def select=(name)
       assert_page_property __method__
       @will_update = true
-      @json = {"name" => select}
+      @json = {"name" => name}
     end
 
     ### Not public announced methods
@@ -72,8 +72,8 @@ module NotionRubyMapping
     ## Common methods
 
     # @param [String, Symbol] name Property name
-    # @param [Hash] json
-    # @param [String] select String value (optional)
+    # @param [Hash, nil] json
+    # @param [String, nil] select select option name (optional)
     def initialize(name, will_update: false, base_type: "page", json: nil, select: nil, property_id: nil,
                    property_cache: nil)
       super name, will_update: will_update, base_type: base_type, property_id: property_id,

data/lib/notion_ruby_mapping/properties/status_property.rb

@@ -25,8 +25,6 @@ module NotionRubyMapping
       @json["name"]
     end
 
-    ## Page property only methods
-
     # @param [String] status
     # @see https://www.notion.so/hkob/StatusProperty-c8b2c83019bc42edbc1527386c7ef453#b3fba1b6322140f28308de3ba70a8b7b
     def status=(status)
@@ -35,6 +33,35 @@ module NotionRubyMapping
       @json = {"name" => status}
     end
 
+    ## Database or DataSource property only methods
+    # @param [String] name
+    # @param [String] color
+    # @return [Array<Hash>] updated status options
+    def add_status_option(name:, color:, group: nil)
+      hash = {"name" => name, "color" => color}
+      hash["group"] = group if group
+      edit_status_options << hash
+    end
+
+    # @return [Array<Hash>] editable status options
+    def edit_status_options
+      assert_database_or_data_source_property __method__
+      @will_update = true
+      @json["edit_options"] ||= []
+    end
+
+    # @return [Array<Hash>] status options
+    def status_options
+      assert_database_or_data_source_property __method__
+      @json["options"] || []
+    end
+
+    # @return [Array<String>] status option names
+    def status_names
+      assert_database_or_data_source_property __method__
+      status_options.map { |s| s["name"] }
+    end
+
     ### Not public announced methods
 
     ## Common methods
@@ -54,5 +81,26 @@ module NotionRubyMapping
       assert_page_property __method__
       {@name => {"status" => @json, "type" => "status"}}
     end
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def update_property_schema_json
+      assert_database_or_data_source_property __method__
+      ans = super
+      return ans if ans != {} || !@will_update
+
+      ans[@name] ||= {}
+      ans[@name]["status"] ||= {}
+      ans[@name]["status"]["options"] = @json["edit_options"]
+      ans
+    end
+
+    ## Database property only methods
+
+    # @return [Hash]
+    def property_schema_json_sub
+      @json["edit_options"] ? {"options" => @json["edit_options"]} : {}
+    end
   end
 end

data/lib/notion_ruby_mapping/properties/text_property.rb

@@ -5,6 +5,7 @@ require "forwardable"
 module NotionRubyMapping
   # Text property
   class TextProperty < Property
+    TYPE = "text"
     extend Forwardable
     include Enumerable
     include EqualsDoesNotEqual
@@ -36,10 +37,67 @@ module NotionRubyMapping
       @text_objects = if database_or_data_source?
                         json || {}
                       else
-                        RichTextArray.new "title", json: json, text_objects: text_objects
+                        RichTextArray.new self.class::TYPE, json: json, text_objects: text_objects
                       end
     end
 
+    def self.rich_text_array_from_json(json)
+      if json["object"] == "list"
+        rich_text_objects = List.new(json: json, type: "property", value: self).select { true }
+        RichTextArray.rich_text_array self::TYPE, rich_text_objects
+      else
+        RichTextArray.new self::TYPE, json: json[self::TYPE]
+      end
+    end
+
+    # @return [Hash] created json
+    def property_values_json
+      assert_page_property __method__
+      text_json = @text_objects.map(&:property_values_json)
+      {
+        @name => {
+          "type" => self.class::TYPE,
+          self.class::TYPE => text_json.empty? ? (@json || []) : text_json,
+        },
+      }
+    end
+
+    # Replaces all rich text objects with a single plain text object.
+    #
+    # This method does not preserve annotations, links, mentions, or equations.
+    #
+    # @param [String] text
+    # @raise [ArgumentError] if text is nil
+    def plain_text=(text)
+      assert_page_property __method__
+      raise ArgumentError if text.nil?
+
+      @text_objects = RichTextArray.new(
+        self.class::TYPE,
+        text_objects: text,
+      )
+      @will_update = true
+    end
+
+    # @param [Hash] json
+    def update_from_json(json)
+      @will_update = false
+      if database_or_data_source?
+        @json = json[self.class::TYPE] || {}
+      else
+        @text_objects = self.class.rich_text_array_from_json json
+      end
+    end
+
+    # Removes all rich text objects.
+    #
+    # This method makes the property value an empty rich text array.
+    def clear
+      assert_page_property __method__
+      @text_objects.clear
+      @will_update = true
+    end
+
     # @return [FalseClass]
     def clear_will_update
       super

data/lib/notion_ruby_mapping/properties/title_property.rb

@@ -9,44 +9,6 @@ module NotionRubyMapping
 
     ## Common methods
 
-    def self.rich_text_array_from_json(json)
-      if json["object"] == "list"
-        rich_text_objects = List.new(json: json, type: "property", value: self).select { true }
-        RichTextArray.rich_text_array "title", rich_text_objects
-      else
-        RichTextArray.new "title", json: json["title"]
-      end
-    end
-
-    # @param [Hash] json
-    def update_from_json(json)
-      @will_update = false
-      if database_or_data_source?
-        @json = json || {}
-      else
-        @text_objects = TitleProperty.rich_text_array_from_json json
-      end
-    end
-
     ## Page property only methods
-
-    # @return [FalseClass]
-    def clear_will_update
-      super
-      @text_objects.clear_will_update
-      false
-    end
-
-    # @return [Hash] created json
-    def property_values_json
-      assert_page_property __method__
-      text_json = map(&:property_values_json)
-      {
-        @name => {
-          "type" => "title",
-          "title" => text_json.empty? ? @json : text_json,
-        },
-      }
-    end
   end
 end

data/lib/notion_ruby_mapping/properties/unique_id_property.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  # Number property
+  # Unique ID property
   class UniqueIdProperty < Property
     include EqualsDoesNotEqual
     include GreaterThanLessThan
@@ -17,8 +17,26 @@ module NotionRubyMapping
       @json
     end
 
+    # @return [String, nil]
+    def prefix
+      @json && @json["prefix"]
+    end
+
+    # @return [Integer, nil]
+    def number
+      @json && @json["number"]
+    end
+
     ## Database property only methods
 
+    # @param [String, nil] prefix
+    # @return [String, nil]
+    def prefix=(prefix)
+      assert_database_or_data_source_property __method__
+      @will_update = true
+      @json["prefix"] = prefix
+    end
+
     ## Page property only methods
 
     ### Not public announced methods
@@ -26,7 +44,7 @@ module NotionRubyMapping
     ## Common methods
 
     # @param [String] name Property name
-    # @param [Float, Integer, Hash] json Number value or format Hash
+    # @param [Hash, nil] json unique_id Hash
     def initialize(name, will_update: false, base_type: "page", json: nil, property_id: nil, property_cache: nil)
       super name, will_update: will_update, base_type: base_type, property_id: property_id, property_cache: property_cache
       @json = json
@@ -34,7 +52,7 @@ module NotionRubyMapping
     end
 
     # @param [Hash] json
-    # @return [NotionRubyMapping::NumberProperty]
+    # @return [NotionRubyMapping::UniqueIdProperty]
     def update_from_json(json)
       @will_update = false
       @json = json["unique_id"]
@@ -43,6 +61,17 @@ module NotionRubyMapping
 
     ## Database property only methods
 
+    # @return [Hash]
+    def update_property_schema_json
+      assert_database_or_data_source_property __method__
+      ans = super
+      return ans if ans != {} || !@will_update
+
+      ans[@name] ||= {}
+      ans[@name]["unique_id"] = @json
+      ans
+    end
+
     ## Page property only methods
 
     # @return [Hash]
@@ -51,6 +80,13 @@ module NotionRubyMapping
       {@name => {"unique_id" => @json, "type" => "unique_id"}}
     end
 
+    protected
+
     ## Database property only methods
+
+    # @return [Hash]
+    def property_schema_json_sub
+      {"prefix" => prefix}
+    end
   end
 end

data/lib/notion_ruby_mapping/properties/url_property.rb

@@ -13,7 +13,7 @@ module NotionRubyMapping
 
     ## Common methods
 
-    # @return [String, Hash, nil] url (Page), {} (Database)
+    # @return [String, Hash, nil] URL for page properties, empty hash for database/data source properties
     # @see https://www.notion.so/hkob/UrlProperty-8a0094fdf6494151983cb4694f6626cc#8342eef7df3c43eaad10c48d4757b4ae
     def url
       @json
@@ -21,7 +21,7 @@ module NotionRubyMapping
 
     ## Page property only methods
 
-    # @param [String] url
+    # @param [String, nil] url
     # @see https://www.notion.so/hkob/UrlProperty-8a0094fdf6494151983cb4694f6626cc#cfa5463a121b4002b250b38d7d0a0d34
     def url=(url)
       assert_page_property __method__
@@ -37,7 +37,7 @@ module NotionRubyMapping
     def initialize(name, will_update: false, base_type: "page", json: nil, property_id: nil, property_cache: nil)
       super name, will_update: will_update, base_type: base_type, property_id: property_id,
                   property_cache: property_cache
-      @json = json || (database_or_data_source? ? {} : nil)
+      @json = database_or_data_source? ? {} : json
     end
 
     ## Page property only methods

data/lib/notion_ruby_mapping/properties/verification_property.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  # Status property
+  # Verification property
   class VerificationProperty < Property
     TYPE = "verification"
 
@@ -9,21 +9,16 @@ module NotionRubyMapping
 
     ## Common methods
 
-    # @see https://www.notion.so/hkob/StatusProperty-c8b2c83019bc42edbc1527386c7ef453#bdb34c0aeaa74729887da087d0bd8022
     def verification
       @json
     end
 
-    ## Page property only methods
-
-    ## Page property only methods
-
     ### Not public announced methods
 
     ## Common methods
 
     # @param [String, Symbol] name Property name
-    # @param [Boolean, Hash] json
+    # @param [Hash] json
     def initialize(name, will_update: false, base_type: "page", property_id: nil, property_cache: nil, json: {})
       super name, will_update: will_update, base_type: base_type, property_id: property_id,
                   property_cache: property_cache
@@ -32,11 +27,12 @@ module NotionRubyMapping
 
     ## DataSource only methods
 
-    # @param [String, Number] value Query value
-    # @param [String] condition rollup Rollup name
-    # @param [String] another_type rollup_type Rollup type
-    # @return [NotionRubyMapping::Query] generated Query object
-    # @see https://www.notion.so/hkob/CheckboxProperty-ac1edbdb8e264af5ad1432b522b429fd#5f07c4ebc4744986bfc99a43827349fc
+    # Creates a filter query for the verification status.
+    #
+    # @param [String] value Verification status. Expected values are "verified", "expired", and "none".
+    # @param [String, nil] condition Rollup condition name.
+    # @param [String, nil] another_type Rollup target type.
+    # @return [NotionRubyMapping::Query] Generated Query object.
     def filter_status(value, condition: nil, another_type: nil)
       make_filter_query "status", value, condition: condition, another_type: another_type
     end

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "4.0.2"
+  VERSION = "4.2.0"
   NOTION_VERSION = "2026-03-11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
@@ -349,7 +349,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Notion Ruby mapping tool
 test_files: []