notion_ruby_mapping 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc53f7256d1ce820695e6f2dc28149ef945dd0ddf765fd933b90882212335d0c
-  data.tar.gz: 625c42250124c4e66d8016812c8a8bd53d02cef88c0061320fdd2ea8c996cd28
+  metadata.gz: f757b8eab76be0d30120c595afffc53dba4cde99a872c53eae58334d6d1ecd73
+  data.tar.gz: d342baef240aaf0cbabc1b9fe298eb99216367e72eeb9c0ed49f15bc58ffc930
 SHA512:
-  metadata.gz: 573470cad7c6c10bb683417cb0ae62ed33819cb3471db31f3eb9b10d5718204c801fd7e42a063a69c1753dd7739f80777fa265fee073d5bd1abd1f17b29320ff
-  data.tar.gz: 2b76551f53c23564645aff1c027fe8521d13f0451e6cb43bbd7f66551e784a35bbcc0b1aa0ca4d12df5f35aa5d277570ae12415963a8c51de098574d67c66804
+  metadata.gz: 4e043303f49438475ef9ef87b2e7d91af74105bf2069286986d9727622e4056c8e9ab6921b3c06c55f24a3c10ad6ecb9b103fec88ddb3f90fde482fad6fc90dd
+  data.tar.gz: 30934684ec64206c5fcb6123dea99fdaa6fd3721ecb3ace0a1574980e2c93eb4ee4d2574f09c9eefb98a5b01fce761b2c4c09e5ab7a8b46f36d9bd3714615cee

data/README.md

@@ -119,6 +119,7 @@ NotionRubyMapping.configuration { |c| c.notion_token = ENV["NOTION_API_TOKEN"] }
 4. [Create ER Diagram from Notion database / Notion データベースの ER 図を作成](https://hkob.notion.site/notionErDiagram-Sample-1720c2199c534ca08138cde38f31f710)
 5. [Create Sitemap from Notion pages / Notion page からサイトマップを作成](https://hkob.notion.site/notionSitemap-sample-14e195c83d024c5382aab09210916c87)
 6. [Create Notion databases from ER Diagram / ER 図から Notion データベースを作成](https://hkob.notion.site/erdToNotionDb-sample-87e5e52a6b9f46abbdeebcb3c902a516)
+6. [NotionTimeRecorder & GTD template](https://hkob.notion.site/NotionTimeRecorder-GTD-template-8c4b5813dbbe4774a517314c9b20bafa)
 
 ### 2.5 API reference / API リファレンス
 
@@ -126,6 +127,7 @@ NotionRubyMapping.configuration { |c| c.notion_token = ENV["NOTION_API_TOKEN"] }
 
 ## 3. ChangeLog
 
+- 2023/3/8 [v0.7.5] add notionTimeRecorder.rb
 - 2023/2/9 [v0.7.4] bug fix for rollup property of erdToNotionRb.rb script
 - 2023/1/26 [v0.7.3] release beta version of erdToNotionRb.rb script
 - 2023/1/25 [v0.7.2] bug fix for creating relation property / add erdToNotionRb.rb script

data/exe/notionTimeRecorder.rb

@@ -0,0 +1,284 @@
+#! /usr/bin/env ruby
+
+require "tk"
+require "notion_ruby_mapping"
+require "yaml"
+require "time"
+include Tk
+include NotionRubyMapping
+
+CONF_FILE_NAME = "#{ENV["HOME"]}/.notionTimeRecorder.yml"
+
+class TaskConf
+  KEY_TO_METHOD = {
+    api_key: "NOTION_API_KEY",
+    db_id: "TASK_DB_ID",
+    tpn: "TITLE_PROPERTY_NAME",
+    dpn: "DATE_PROPERTY_NAME",
+    fpn: "FINISH_PROPERTY_NAME",
+    fpt: "FINISH_PROPERTY_TYPE",
+    ipv: "IN_PROGRESS_PROPERTY_VALUE",
+    fpv: "FINISH_PROPERTY_VALUE",
+    bln: "BLOCKING_PROPERTY_NAME",
+    bbn: "BLOCKED_BY_PROPERTY_NAME",
+    ppd: "PERCENT_PREVIOUS_DONE_FUNC_NAME",
+  }
+
+  # @param [Boolean] force_setup
+  def initialize(yaml_name, force_setup = false)
+    @yaml_name = yaml_name
+    @config = {}
+    setup(force_setup) if force_setup || !File.exist?(@yaml_name)
+    load_conf
+  end
+
+  # @param [Boolean] force_setup
+  def setup(force_setup)
+    load_conf if force_setup
+    @variables = {}
+    @conf_frame = TkLabelFrame.new(nil, text: "Configuration").pack(padx: 10, pady: 10)
+    KEY_TO_METHOD.each do |method, key|
+      @variables[method] = TkVariable.new @config[key]&.to_s
+      label_frame = TkLabelFrame.new(@conf_frame, text: key).pack(padx: 10, pady: 5)
+      if method == :fpt
+        TkRadioButton.new(label_frame, text: "status", variable: @variables[method], value: "status").pack
+        TkRadioButton.new(label_frame, text: "checkbox", variable: @variables[method], value: "checkbox").pack
+      else
+        TkEntry.new(label_frame, textvariable: @variables[method]).pack
+      end
+    end
+    cmd_frame = TkFrame.new(@conf_frame).pack
+    TkButton.new(cmd_frame, text: "Quit", command: ->{ exit }).pack(side: :left)
+    TkButton.new(cmd_frame, text: "Save", command: ->{ save }).pack(side: :right)
+    Tk.mainloop
+  end
+
+  def load_conf
+    @config = YAML.load_file @yaml_name
+    KEY_TO_METHOD.each do |method, key|
+      self.class.define_method(method) { @config[key] }
+    end
+  end
+  
+  def save
+    KEY_TO_METHOD.each do |method, key|
+      @config[key] = @variables[method].value.chomp
+    end
+    @config["FINISH_PROPERTY_VALUE"] = true if @config["FINISH_PROPERTY_VALUE"] == "true"
+    File.open(@yaml_name, "w") do |f|
+      YAML.dump @config, f
+    end
+    load_conf
+    @conf_frame.destroy
+    @task_cache = TaskCache.new self
+  end
+end
+
+class Task
+  # @param [NotionRubyMapping::Page] page
+  # @param [TaskCache] tc
+  def initialize(page, tc)
+    @page = page
+    @tc = tc
+    @conf = tc.conf
+    @date_property = @page.properties[@conf.dpn]
+    @finish_property = @page.properties[@conf.fpn]
+    @finish = (@conf.fpt == "status" ? @finish_property.status_name : @finish_property.checkbox) == @conf.fpv
+    @start_date = @date_property.start_date_obj
+    @end_date = @date_property.end_date_obj
+  end
+
+  def save
+    @page.save
+    @start_date = @date_property.start_date_obj
+    @end_date = @date_property.end_date_obj
+    @finish = (@conf.fpt == "status" ? @finish_property.status_name : @finish_property.checkbox) == @conf.fpv
+  end
+
+  def start_time_str
+    @start_date.nil? || @start_date.is_a?(Date) ? "-" : @start_date.strftime("%H:%M")
+  end
+
+  def end_time_str
+    @end_date.nil? || @end_date.is_a?(Date) ? "-" : @end_date.strftime("%H:%M")
+  end
+
+  def state
+    @finish ? "disabled" : "normal"
+  end
+
+  def time_recording(force_set_date = false)
+    if @start_date.nil? || force_set_date
+      @date_property.start_date = Date.today
+      @date_property.end_date = nil
+      save
+      @tc.move_to_today self
+    elsif @start_date.is_a?(Date)
+      @date_property.start_date = Time.now
+      @finish_property.send("#{@conf.fpt}=", @conf.ipv) unless @conf.ipv.empty?
+      @date_property.end_date = nil
+      save
+      @tc.update_today_tasks
+    else
+      @date_property.start_date = @date_property.start_date_obj
+      @date_property.end_date = Time.now
+      @finish_property.send("#{@conf.fpt}=", @conf.fpv)
+      save
+      if blocking_count&.positive?
+        @tc.reload_someday
+        @tc.update_today_tasks
+      else
+        @tc.update_today_tasks
+      end
+    end
+  end
+
+  def blocking_count
+    @conf.bln.empty? ? nil : @page.properties[@conf.bln].relation.count
+  end
+
+  def view_task(frame, index, today_task = true)
+    TkButton.new(frame, text: @page.title, state: state, command: -> { time_recording }).grid(row: index, column: 0)
+    if today_task
+      TkLabel.new(frame, text: start_time_str).grid(row: index, column: 1)
+      TkLabel.new(frame, text: end_time_str).grid(row: index, column: 2)
+    elsif (bcnt = blocking_count)
+      TkLabel.new(frame, text: "+#{bcnt}").grid(row: index, column: 1)
+    end
+  end
+end
+
+class TaskCache
+  # @param [TaskConf] conf
+  def initialize(conf)
+    @conf = conf
+    NotionRubyMapping.configure do |c|
+      c.notion_token = @conf.api_key
+    end
+
+    @db = Database.find conf.db_id
+    @db_date_property, @db_finish_property = @db.properties.values_at @conf.dpn, @conf.fpn
+    @today_tasks = []
+    @someday_tasks = []
+    @unfinished_tasks = []
+    @new_today_task_val = TkVariable.new
+    create_view
+  end
+  attr_reader :conf
+
+  def create_view
+    @today_outer_frame = TkLabelFrame.new(nil, text: "Today's tasks").pack(padx: 10, pady: 5)
+    @today_inner_frame = nil
+    @someday_outer_frame = TkLabelFrame.new(nil, text: "Someday").pack(padx: 10, pady: 5)
+    @someday_inner_frame = nil
+    @new_frame = TkLabelFrame.new(nil, text: "New task").pack(padx: 10, pady: 5)
+    entry = TkEntry.new(@new_frame, textvariable: @new_today_task_val).pack(side: :left)
+    entry.focus
+    entry.bind("Return", -> { add_someday_task })
+    TkButton.new(@new_frame, text: "Add", command: -> { add_someday_task }).pack(side: :right)
+
+    cmd_frame = TkFrame.new(nil).pack(pady: 5)
+    TkButton.new(cmd_frame, text: "Reload", command: ->{ reload }).pack(side: :left)
+    TkButton.new(cmd_frame, text: "Quit", command: ->{ exit }).pack(side: :right)
+    reload
+  end
+
+  def reload
+    NotionCache.instance.clear_object_hash
+    load_today_tasks
+    load_unfinished_tasks
+    update_today_tasks
+    load_someday_tasks
+    update_someday_tasks
+  end
+
+  def reload_someday
+    NotionCache.instance.clear_object_hash
+    load_someday_tasks
+    update_someday_tasks
+  end
+
+  def load_unfinished_tasks
+    now = Time.now
+    end_of_day = Time.local(now.year, now.month, now.mday, 23, 59, 59) - 86400
+    query = @db_date_property.filter_before(end_of_day)
+                             .and(@db_finish_property.filter_does_not_equal(@conf.fpv))
+    @unfinished_tasks = @db.query_database(query).map { |tp| Task.new tp, self }
+  end
+
+  def load_today_tasks
+    query = @db_date_property.filter_equals(Date.today)
+                             .ascending(@db_date_property)
+    @today_tasks = @db.query_database(query).map { |tp| Task.new tp, self }
+  end
+
+  def update_today_tasks
+    @today_inner_frame&.destroy
+    @today_inner_frame = TkFrame.new(@today_outer_frame).pack
+    @today_tasks.sort! { |a, b| a.start_time_str <=> b.start_time_str }
+    @today_tasks.each_with_index { |task, i| task.view_task @today_inner_frame, i }
+    uc = @unfinished_tasks.count
+    TkButton.new(@today_inner_frame, text: "Add unfinished #{uc} tasks", command: -> { add_unfinished_tasks })
+            .grid(row: @today_tasks.count, column: 0) if uc.positive?
+  end
+
+  def load_someday_tasks
+    query = @db_date_property.filter_is_empty
+                             .and(@db_finish_property.filter_does_not_equal(@conf.fpv))
+    unless @conf.ppd.empty?
+      ppd_p = @db.properties[@conf.ppd]
+      query_is_empty = ppd_p.filter_is_empty another_type: "number"
+      query_equals_1 = ppd_p.filter_equals 1, another_type: "number"
+      query.and(query_is_empty.or(query_equals_1))
+    end
+    @someday_tasks = @db.query_database(query).map { |tp| Task.new tp, self }
+  end
+
+  def update_someday_tasks
+    @someday_inner_frame&.destroy
+    @someday_inner_frame = TkFrame.new(@someday_outer_frame).pack
+    @someday_tasks.each_with_index { |task, i| task.view_task @someday_inner_frame, i, false }
+  end
+
+  def add_someday_task
+    task_name = @new_today_task_val.value
+    if !@conf.bbn.empty? && task_name.include?("|")
+      previous_id = nil
+      task_name.split("|").each do |title|
+        page = @db.create_child_page do |_, pp|
+          pp[@conf.tpn] << title
+          pp[@conf.bbn].relation = previous_id if previous_id
+        end
+        previous_id = page.id
+      end
+      @new_today_task_val.value = ""
+      reload
+    else
+      tp = @db.create_child_page do |_, pp|
+        pp[@conf.tpn] << task_name
+      end
+      @new_today_task_val.value = ""
+      @someday_tasks << Task.new(tp, self)
+      update_someday_tasks
+    end
+  end
+
+  def add_unfinished_tasks
+    @unfinished_tasks.each do |task|
+      task.time_recording true
+    end
+    @unfinished_tasks = []
+    update_today_tasks
+  end
+
+  def move_to_today(task)
+    @someday_tasks.delete task
+    @today_tasks << task
+    update_today_tasks
+    update_someday_tasks
+  end
+end
+
+@task_conf = TaskConf.new CONF_FILE_NAME, ARGV.first == "-c"
+@task_cache = TaskCache.new @task_conf
+Tk.mainloop

data/lib/notion_ruby_mapping/controllers/notion_cache.rb

@@ -22,10 +22,11 @@ module NotionRubyMapping
       @notion_token = nil
       @wait = 0.3333
       @debug = false
+      @use_cache = true
     end
     attr_reader :object_hash
     attr_writer :client # for test only
-    attr_accessor :notion_token, :wait, :debug
+    attr_accessor :notion_token, :wait, :debug, :use_cache
 
     # @param [String] block_id
     # @return [String (frozen)] block_path
@@ -175,10 +176,12 @@ module NotionRubyMapping
     # @return [NotionRubyMapping::Base]
     def object_for_key(id)
       key = hex_id(id)
-      return @object_hash[key] if @object_hash.key? key
+      return @object_hash[key] if @use_cache && @object_hash.key?(key)
 
       json = yield(@client)
-      @object_hash[key] = Base.create_from_json json
+      ans = Base.create_from_json json
+      @object_hash[key] = ans if @use_cache
+      ans
     end
 
     # @param [String] id page_id (with or without "-")

data/lib/notion_ruby_mapping/properties/date_property.rb

@@ -24,6 +24,17 @@ module NotionRubyMapping
       @json["end"]
     end
 
+    def end_date_obj
+      assert_page_property __method__
+      jet = @json["end"]
+      case jet
+      when String
+        jet.include?("T") ? Time.parse(jet) : Date.parse(jet)
+      else
+        jet
+      end
+    end
+
     # @param [Date, Time, DateTime, String] edt
     # @see https://www.notion.so/hkob/DateProperty-c6e815c060cb430889dbb33b697f00c6#944c02096101429084527c22155683bf
     def end_date=(edt)
@@ -41,6 +52,17 @@ module NotionRubyMapping
       @json["start"]
     end
 
+    def start_date_obj
+      assert_page_property __method__
+      jst = @json["start"]
+      case jst
+      when String
+        jst.include?("T") ? Time.parse(jst) : Date.parse(jst)
+      else
+        jst
+      end
+    end
+
     # @param [Date, Time, DateTime, String] sdt
     # @see https://www.notion.so/hkob/DateProperty-c6e815c060cb430889dbb33b697f00c6#4f5931f1588a43f7857af8ab2d73df74
     def start_date=(sdt)

data/lib/notion_ruby_mapping/properties/property.rb

@@ -24,7 +24,7 @@ module NotionRubyMapping
                    :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=
+                   :url=, :start_date_obj, :end_date_obj
 
     ## Database property only methods
 

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
   NOTION_VERSION = "2022-06-28"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -143,6 +143,7 @@ executables:
 - erdToNotionDb.rb
 - notionErDiagram.rb
 - notionSitemap.rb
+- notionTimeRecorder.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -164,6 +165,7 @@ files:
 - exe/erdToNotionDb.rb
 - exe/notionErDiagram.rb
 - exe/notionSitemap.rb
+- exe/notionTimeRecorder.rb
 - images/post_set_icon.png
 - images/pre_set_icon.png
 - images/serial_number.png
@@ -276,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Notion Ruby mapping tool