notion_ruby_mapping 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00e3fdb4888f3e3c321215b91e3bb281e2b7683be35109f258b653febca4b697
-  data.tar.gz: 90ffb01da47b66c38b6bf0300b7e53f0302e7ce194ec35dba140a807b38e5239
+  metadata.gz: ab8de3fcc36d0cc0d489fdf31b50845e5c86aea51891067f4412733f605ac76e
+  data.tar.gz: 454a657be8a1acea1d14444bb811704c6183fb8e1fb624ad656fdbf403671031
 SHA512:
-  metadata.gz: 41ba458e34fc7f322c470e2a3a3a2b47cc091811267ed014066fc3eea5a9f29d99e48ce6d3e8e3a166cda06682612bd9429b42f2dea70c9072404fa66a76c311
-  data.tar.gz: 5f4205dd334fc5d31bf1e56f2e5ca4cc769feff7f3d5310e9b56c1b93658d837341786936eb1641f5f84cb3fc903c342a3a019cd340d39c837370be6e54d6a04
+  metadata.gz: d3a86a3ee7cfd53eb58127b1a462a9f7b9ea97c57c6b0b1a7e0ea9ec72d1dde34ebd7759a18ad10c5f540be0cbdaa81c517924923fb502a9be68c62bcb587020
+  data.tar.gz: '009d50cc385fc9e462b1f475f647d93792501887db955f67a205a6d8a5397cb5f21752e0bcd0789e01d81c51374495135ad1dd101573d8dca4735c176e78cac1'

data/README.md

@@ -6,12 +6,7 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
 
 ## Table of Contents
 
-
-<!-- @import "[TOC]" {cmd="toc" depthFrom=1 depthTo=6 orderedList=false} -->
-
-<!-- code_chunk_output -->
-
-- [notion\_ruby\_mapping](#notion_ruby_mapping)
+- [notion_ruby_mapping](#notion_ruby_mapping)
   - [Table of Contents](#table-of-contents)
   - [1. Installation](#1-installation)
   - [2. Example code](#2-example-code)
@@ -29,12 +24,13 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
       - [4.1.2 Update page properties](#412-update-page-properties)
       - [4.1.3 Update other page information](#413-update-other-page-information)
       - [4.1.4 other methods](#414-other-methods)
-    - [4.2 Page](#42-page)
+    - [4.2 Database](#42-database)
       - [4.2.1 Retrieve a database](#421-retrieve-a-database)
       - [4.2.2 Query a database](#422-query-a-database)
         - [4.2.2.1 Complex conditions](#4221-complex-conditions)
         - [4.2.2.2 Sort criteria](#4222-sort-criteria)
-      - [4.2.3 Update database](#423-update-database)
+      - [4.2.3 Create child page](#423-create-child-page)
+      - [4.2.4 Update database](#424-update-database)
     - [4.3 List class](#43-list-class)
     - [4.4 Block class](#44-block-class)
     - [4.5 Property classes](#45-property-classes)
@@ -54,14 +50,16 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
         - [4.5.3.10 EmailProperty](#45310-emailproperty)
         - [4.5.3.11 FilesProperty](#45311-filesproperty)
         - [4.5.3.12 RelationProperty](#45312-relationproperty)
+  - [5. XXXObjects](#5-xxxobjects)
+    - [5.1 RichTextObject](#51-richtextobject)
+    - [5.2 TextObject](#52-textobject)
+    - [5.3 MentionObject](#53-mentionobject)
+    - [5.4 UserObject](#54-userobject)
   - [6. ChangeLog](#6-changelog)
-  - [6. Contributing](#6-contributing)
-  - [7. License](#7-license)
-  - [8. Code of Conduct](#8-code-of-conduct)
-  - [9. Acknowledgements](#9-acknowledgements)
-
-<!-- /code_chunk_output -->
-
+  - [7. Contributing](#7-contributing)
+  - [8. License](#8-license)
+  - [9. Code of Conduct](#9-code-of-conduct)
+  - [10. Acknowledgements](#10-acknowledgements)
 
 ## 1. Installation
 
@@ -548,9 +546,12 @@ query13 = tp.filter_starts_with("A").ascending(tp)
 #### 4.2.3 Create child page
 
 `create_child_page` creates a child page object of the database.
+After setting some properties, please call `page.save` to send page information to Notion.
 
 ```Ruby
 page = db.create_child_page TitleProperty, "Name"
+page.properties["Name"] << "New Page"
+page.save
 ```
 
 #### 4.2.4 Update database
@@ -843,6 +844,7 @@ p tp.property_values_json
 ```
 
 `<<` method appends a new TextObject or a String.
+
 ```Ruby
 to = TextObject.new "DEF"
 to.bold = true
@@ -857,6 +859,7 @@ p tp.property_values_json
 ```
 
 `delete_at(index)` method remove a TextObject at index.
+
 ```Ruby
 tp.delete_at 1
 tp << "GHI"
@@ -867,6 +870,7 @@ p tp.property_values_json
 ##### 4.5.3.9 CheckboxProperty
 
 PeopleProperty can set a boolean value by `.checkbox=`.
+
 ```Ruby
 cp = page.properties["CheckboxTitle"]
 cp.checkbox = true
@@ -877,6 +881,7 @@ p cp.property_values_json
 ##### 4.5.3.10 EmailProperty
 
 EmailProperty can set an email address by `.email=`.
+
 ```Ruby
 ep = page.properties["MailTitle"]
 ep.email = "hkobhkob@gmail.com"
@@ -914,9 +919,61 @@ p rp.property_values_json
 # Result => {"rp"=>{"type"=>"relation", "relation"=>[{"id"=>"R2"}, {"id"=>"R3"}]}}
 ```
 
+## 5. XXXObjects
+
+### 5.1 RichTextObject
+
+RichTextObject is an abstract class for TextObject and MentionObject.
+It can store a link and some annotations.
+
+There are common instance methods for its subclass objects.
+
+- plain_text=(value)
+- bold=(flag)
+- italic=(flag)
+- strikethrough=(flag)
+- underline=(flag)
+- code=(flag)
+- color=(color)
+
+### 5.2 TextObject
+
+TextObject is a class for texts.
+`TextObject.new(text)` creates a TextObject.
+After creating or retrieving TextObject, `to.text=` replaces including text.
+
+```Ruby
+to = TextObject.new "first text"
+to.text = "replaced text"
+```
+
+### 5.3 MentionObject
+
+MentionObject is a class for mentions for user, page, database, date and template_mention.
+
+```Ruby
+mention_user = MentionObject.new user_id: "user_id", plain_text: "m_user"
+mention_page = MentionObject.new page_id: "page_id", plain_text: "m_page"
+mention_db = MentionObject.new database_id: "database_id", plain_text: "m_db"
+mention_date = MentionObject.new start: "2022-03-17", plain_text: "m_date"
+mention_today = MentionObject.new mention_template: "today"
+mention_now = MentionObject.new mention_template: "now"
+mention_user = MentionObject.new mention_template: "user"
+```
+
+### 5.4 UserObject
+
+UserObject is a class for users.
+
+```Ruby
+u = User.new id: "user_id"
+```
 
 ## 6. ChangeLog
 
+- 2022/3/17 added template_mention objects, tools/an command
+- 2022/3/16 added database.create_child_page and base.save instead of base.update/create
+- 2022/3/15 Fixed not to reload from API when all contents are loaded
 - 2022/3/14 Exclude notion-ruby-client, update Property values, update for Notion-Version 2022-02-22
 - 2022/2/25 add_property_for_update -> assign_property, update README.md
 - 2022/2/20 add support for MultiSelectProperty
@@ -928,18 +985,18 @@ p rp.property_values_json
 - 2022/2/13 added Page#set_icon
 - 2022/2/13 First commit
 
-## 6. Contributing
+## 7. Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/hkob/notion_ruby_mapping>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
 
-## 7. License
+## 8. License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## 8. Code of Conduct
+## 9. Code of Conduct
 
 Everyone interacting in the NotionRubyMapping project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/notion_ruby_mapping/blob/main/CODE_OF_CONDUCT.md).
 
-## 9. Acknowledgements
+## 10. Acknowledgements
 
 The code depends on [notion-ruby-client](https://github.com/orbit-love/notion-ruby-client).

data/lib/notion_ruby_mapping/mention_object.rb

@@ -41,8 +41,33 @@ module NotionRubyMapping
           "type" => "date",
           "date" => @options.slice("start", "end", "time_zone"),
         }
+      elsif @options.key? "template_mention"
+        sub = case @options["template_mention"]
+              when "today"
+                @options["plain_text"] = "@Today"
+                {
+                  "type" => "template_mention_date",
+                  "template_mention_date" => "today",
+                }
+              when "now"
+                @options["plain_text"] = "@Now"
+                {
+                  "type" => "template_mention_date",
+                  "template_mention_date" => "now",
+                }
+              else
+                @options["plain_text"] = "@Me"
+                {
+                  "type" => "template_mention_user",
+                  "template_mention_user" => "me",
+                }
+              end
+        {
+          "type" => "template_mention",
+          "template_mention" => sub,
+        }
       else
-        raise StandardError, "Irregular mention type"
+        raise StandardError, "Irregular mention type: #{@options.keys}"
       end
     end
   end

data/lib/notion_ruby_mapping/rich_text_object.rb

@@ -32,8 +32,16 @@ module NotionRubyMapping
           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
         else
-          raise StandardError, json
+          raise StandardError, "Unknown mention type: #{mention["type"]}"
         end
       else
         raise StandardError, json
@@ -60,6 +68,54 @@ module NotionRubyMapping
       }.merge annotations_json
     end
 
+    # @param [String, RichTextObject] value
+    # @return [String] input text
+    def plain_text=(value)
+      text(value)
+    end
+
+    # @param [Boolean] flag
+    # @return [Boolean] input flag
+    def bold=(flag)
+      @will_update = true
+      @options["bold"] = flag
+    end
+
+    # @param [Boolean] flag
+    # @return [Boolean] input flag
+    def italic=(flag)
+      @will_update = true
+      @options["italic"] = flag
+    end
+
+    # @param [Boolean] flag
+    # @return [Boolean] input flag
+    def strikethrough=(flag)
+      @will_update = true
+      @options["strikethrough"] = flag
+    end
+
+    # @param [Boolean] flag
+    # @return [Boolean] input flag
+    def underline=(flag)
+      @will_update = true
+      @options["underline"] = flag
+    end
+
+    # @param [Boolean] flag
+    # @return [Boolean] input flag
+    def code=(flag)
+      @will_update = true
+      @options["code"] = flag
+    end
+
+    # @param [String] color
+    # @return [String] input color
+    def color=(color)
+      @will_update = true
+      @options["color"] = color
+    end
+
     protected
 
     # @return [Hash] options

data/lib/notion_ruby_mapping/text_object.rb

@@ -21,61 +21,12 @@ module NotionRubyMapping
         @options = value.options
         @text = value.text
       else
-        p value
         @text = value
         @options["plain_text"] = value
       end
       self
     end
 
-    # @param [String, RichTextObject] value
-    # @return [String] input text
-    def plain_text=(value)
-      text(value)
-    end
-
-    # @param [Boolean] flag
-    # @return [Boolean] input flag
-    def bold=(flag)
-      @will_update = true
-      @options["bold"] = flag
-    end
-
-    # @param [Boolean] flag
-    # @return [Boolean] input flag
-    def italic=(flag)
-      @will_update = true
-      @options["italic"] = flag
-    end
-
-    # @param [Boolean] flag
-    # @return [Boolean] input flag
-    def strikethrough=(flag)
-      @will_update = true
-      @options["strikethrough"] = flag
-    end
-
-    # @param [Boolean] flag
-    # @return [Boolean] input flag
-    def underline=(flag)
-      @will_update = true
-      @options["underline"] = flag
-    end
-
-    # @param [Boolean] flag
-    # @return [Boolean] input flag
-    def code=(flag)
-      @will_update = true
-      @options["code"] = flag
-    end
-
-    # @param [String] color
-    # @return [String] input color
-    def color=(color)
-      @will_update = true
-      @options["color"] = color
-    end
-
     protected
 
     def partial_property_values_json

data/lib/notion_ruby_mapping/version.rb

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

data/tools/an

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "date"
+require "notion_ruby_mapping"
+
+module NotionRubyMapping
+  # you Notion API token
+  NOTION_API_TOKEN = "secret_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx"
+  # your task Database id
+  DATABASE_ID = "0123456789abcdef0123456789abcdef"
+  # your Title name
+  TITLE_NAME = "タスク名"
+  # your DateProperty name
+  DATE_NAME = "日付"
+  # your time_zone
+  TIME_ZONE = "Asia/Tokyo"
+  # set true if you want to open the created page in the Notion.app
+  OPEN_AS_APP = true
+
+  # print usage and exit
+  def usage
+    print [
+      "Usage:",
+      "\tan task-name",
+      "\t\tCreate a today task as 'task-name'",
+      "\tan task-name hh:mm",
+      "\t\tCreate a today 'task-name' task at 'hh:mm'",
+      "\tan task-name MM/DD",
+      "\t\tInput a 'task-name' task at 'MM/DD'",
+      "\tan task-name YYYY/MM/DD",
+      "\t\tInput a 'task-name' task at 'YYYY/MM/DD'",
+      "\tan task-name MM/DD hh:mm",
+      "\t\tInput a 'task-name' task at 'MM/DD hh:mm",
+      "\tan task-name MM/DD h1:m1 h2:m2",
+      "\t\tInput a 'task-name' task at 'MM/DD h1:m1 - h2:m2'",
+      "\tan task-name YYYY/MM/DD hh:mm",
+      "\t\tInput a 'task-name' task at 'YYYY/MM/DD hh:mm",
+      "\tan task-name YYYY/MM/DD h1:m1 h2:m2",
+      "\t\tInput a 'task-name' task at 'YYYY/MM/DD h1:m1 - h2:m2'",
+    ].join("\n")
+    exit 1
+  end
+
+  if ARGV.empty?
+    usage
+  else
+    date_str = nil
+    end_time = nil
+    start_time = nil
+
+    # check start_time and end_time
+    end_time = ARGV.pop if ARGV[-1] =~ /\d+:\d+/
+    if end_time
+      start_time = ARGV.pop if ARGV[-1] =~ /\d+:\d+/
+      unless start_time
+        start_time = end_time
+        end_time = nil
+      end
+    end
+
+    # set date from date string or today
+    begin
+      date = Date.parse ARGV[-1]
+      # If the above Date.parse was success, the last parameter will remove.
+      date_str = ARGV.pop
+    rescue StandardError
+      date = nil
+    end
+    date ||= Date.today
+
+    # if task name does not exist, print usage and exit
+    if ARGV.empty?
+      print "`task-name' is required!!!"
+      usage
+    end
+
+    NotionCache.instance.create_client NOTION_API_TOKEN
+
+    # create database object without API call and create a child page
+    db = Database.new id: DATABASE_ID
+    page = db.create_child_page TitleProperty, TITLE_NAME, DateProperty, DATE_NAME
+
+    # obtain title and date properties and set values
+    tp, dp = page.properties.values_at TITLE_NAME, DATE_NAME
+    tp << ARGV.join(" ")
+    if end_time
+      dp.start_date = DateTime.parse "#{date_str} #{start_time}"
+      dp.end_date = DateTime.parse "#{date_str} #{end_time}"
+      dp.time_zone = TIME_ZONE
+    elsif start_time
+      dp.start_date = DateTime.parse "#{date_str} #{start_time}"
+      dp.time_zone = TIME_ZONE
+    else
+      dp.start_date = date
+    end
+
+    # Notion API call
+    page.save
+    url = "#{OPEN_AS_APP ? "notion" : "https"}://notion.so/#{page.id}"
+    system("open #{url}")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,6 +184,7 @@ files:
 - lib/notion_ruby_mapping/version.rb
 - notion_ruby_mapping.gemspec
 - sig/notion_ruby_mapping.rbs
+- tools/an
 homepage: https://github.com/hkob/notion_ruby_mapping.git
 licenses:
 - MIT