Class: NotionRubyMapping::RichTextObject

Inherits:
Object
  • Object
show all
Defined in:
lib/notion_ruby_mapping/objects/rich_text_object.rb

Overview

RichTextObject

Direct Known Subclasses

EquationObject, MentionObject, TextObject

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, options = {}) ⇒ TextObject

Parameters:

  • type (String) 


8
9
10
11
12
13
14
15
16
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 8

def initialize(type, options = {})
  if instance_of?(RichTextObject)
    raise StandardError,
          "RichTextObject is abstract class.  Please use TextObject."
  end

  @type = type
  @options = options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



17
18
19
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 17

def options
  @options
end

#will_update ⇒ Object (readonly)

Returns the value of attribute will_update.



17
18
19
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 17

def will_update
  @will_update
end

Class Method Details

.create_from_json(json) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 19

def self.create_from_json(json)
  type = json["type"]
  options = (json["annotations"] || {}).merge(json.slice("plain_text", "href"))
  case type
  when "text"
    TextObject.new json["plain_text"], options
  when "equation"
    EquationObject.new json["equation"]["expression"], options
  when "mention"
    mention = json["mention"]
    case mention["type"]
    when "user"
      MentionObject.new options.merge({"user_id" => mention["user"]["id"]})
    when "page"
      MentionObject.new options.merge({"page_id" => mention["page"]["id"]})
    when "database"
      MentionObject.new options.merge({"database_id" => mention["database"]["id"]})
    when "date"
      MentionObject.new options.merge(mention["date"].slice("start", "end", "time_zone"))
    when "template_mention"
      template_mention = mention["template_mention"]
      case template_mention["type"]
      when "template_mention_date"
        MentionObject.new options.merge({"template_mention" => template_mention["template_mention_date"]})
      else
        MentionObject.new options.merge({"template_mention" => template_mention["template_mention_user"]})
      end
    when "link_preview"
      MentionObject.new options.merge({"link_preview" => mention["link_preview"]["url"]})
    else
      raise StandardError, "Unknown mention type: #{mention["type"]}"
    end
  else
    raise StandardError, json
  end
end

.text_object(to) ⇒ NotionRubyMapping::RichTextObject

Returns RichTextObject.

Parameters:

Returns:



58
59
60
61
62
63
64
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 58

def self.text_object(to)
  if to.is_a? RichTextObject
    to
  else
    TextObject.new to
  end
end

Instance Method Details

#bold=(flag) ⇒ Boolean

Returns input flag.

Parameters:

  • flag (Boolean)

Returns:

  • (Boolean) —

    input flag



96
97
98
99
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 96

def bold=(flag)
  @will_update = true
  @options["bold"] = flag
end

#clear_will_update ⇒ FalseClass

Returns:

  • (FalseClass) 


77
78
79
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 77

def clear_will_update
  @will_update = false
end

#code=(flag) ⇒ Boolean

Returns input flag.

Parameters:

  • flag (Boolean)

Returns:

  • (Boolean) —

    input flag



124
125
126
127
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 124

def code=(flag)
  @will_update = true
  @options["code"] = flag
end

#color=(color) ⇒ String

Returns input color.

Parameters:

  • color (String)

Returns:

  • (String) —

    input color



131
132
133
134
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 131

def color=(color)
  @will_update = true
  @options["color"] = color
end

#href=(url) ⇒ String

Returns input text.

Parameters:

  • url (String)

Returns:

  • (String) —

    input text



83
84
85
86
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 83

def href=(url)
  @will_update = true
  @options["href"] = url
end

#italic=(flag) ⇒ Boolean

Returns input flag.

Parameters:

  • flag (Boolean)

Returns:

  • (Boolean) —

    input flag



103
104
105
106
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 103

def italic=(flag)
  @will_update = true
  @options["italic"] = flag
end

#plain_text=(value) ⇒ String

Returns input text.

Parameters:

Returns:

  • (String) —

    input text



90
91
92
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 90

def plain_text=(value)
  text(value)
end

#property_values_json ⇒ Hash{String (frozen)->Object

Returns ].

Returns:

  • (Hash{String (frozen)->Object) —

    ]



67
68
69
70
71
72
73
74
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 67

def property_values_json
  {
    "type" => @type,
    @type => partial_property_values_json,
    "plain_text" => @options["plain_text"],
    "href" => @options["href"],
  }.merge annotations_json
end

#strikethrough=(flag) ⇒ Boolean

Returns input flag.

Parameters:

  • flag (Boolean)

Returns:

  • (Boolean) —

    input flag



110
111
112
113
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 110

def strikethrough=(flag)
  @will_update = true
  @options["strikethrough"] = flag
end

#underline=(flag) ⇒ Boolean

Returns input flag.

Parameters:

  • flag (Boolean)

Returns:

  • (Boolean) —

    input flag



117
118
119
120
 
# File 'lib/notion_ruby_mapping/objects/rich_text_object.rb', line 117

def underline=(flag)
  @will_update = true
  @options["underline"] = flag
end