thingamajig 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 898bf68717745f4122521d3dc8833c6f454daa4b
-  data.tar.gz: ea4f2300f8d45ffb57cee09e447ab34dd95833d4
+SHA256:
+  metadata.gz: b7a05d7b894dc4289c7b38a376b145b2935617697c5f3d7f0242b133604dbd90
+  data.tar.gz: 576194daa2c5e3b431ae642e8a1eb68f483c39d06025d3232fa142d977802c31
 SHA512:
-  metadata.gz: e1499faabf11f4643d1ca7f7f06560a3078aeb16002c5859c49007a404ae1f69c288bc0e7567e6566622e8905ddd1061e8a3d85a59dad495343c107ca28c551d
-  data.tar.gz: c4f790028bb56dfdb0c111b2880f689af4c133032e1d708093bb2378f2d87bc5764c8c916a75cbf544236ce07e5fdec29e0b468846ae920048634ae329509843
+  metadata.gz: 36f28972b740fe22abac00189f7a6d9918d64f60bd64104bc916fd2b500e55b6a15109bca18e38cfa35619c369193ea51bd084e024768ececc73f32010dcf124
+  data.tar.gz: fc8a87b362eea6ac557d8977de079243c8e56b36584d4cdf605c2eb3edd908e5c4234e05d74e0f4fa4d23f6e894d252f4781afba3fb29895446e72b79404fc10

data/README.md

@@ -46,6 +46,8 @@ This README is severaly lacking in instructions. Here's some sample code that mi
   end
 ```
 
+### Naming
+
 If you're tired of typing "Thingamajig" out in full, feel free to alias it:
 
 ```ruby
@@ -70,6 +72,17 @@ Or install it yourself as:
 
     $ gem install thingamajig
 
+## Example Usage
+
+I use Thingamajig extensively in my personal automated workflows. You can find the source code here: https://github.com/dv/dotworkflows
+
+## Research
+
+A lot of this was done through trial-and-error. Helpful resources:
+
+- [The official documentation by Cultured Code](https://culturedcode.com/things/download/Things3AppleScriptGuide.pdf) (beware, it's full of mistakes).
+- Example of connecting to the underlying SQLite3 database: https://github.com/lucbeaulieu/KanbanView
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/thingamajig/area.rb

@@ -1,41 +1,13 @@
 class Thingamajig
   class Area < OsaObject
+    include Container
+
     def self.find_by(name:)
       Thingamajig::Area.new(Thingamajig.new.osa_object.areas[name])
     end
 
-    # an Area's To Do list actually contains Projects & Todos, that's
-    # why we need some extra filtering
-    def todos(filter = nil)
-      query = todos_query
-      query = query.and(filter) if filter
-
-      osa_object.to_dos[query].get.map do |osa_todo|
-        Thingamajig::Todo.new osa_todo
-      end
-    end
-
-    def projects(filter = nil)
-      query = projects_query
-      query = query.and(filter) if filter
-
-      osa_object.to_dos[query].get.map do |osa_project|
-        Thingamajig::Project.new osa_project
-      end
-    end
-
     def inspect
       "#<Thingamajig::Area '#{name}'>"
     end
-
-    private
-
-    def projects_query
-      Appscript.its.class_.eq(:project)
-    end
-
-    def todos_query
-      Appscript.its.class_.ne(:project)
-    end
   end
 end

data/lib/thingamajig/list.rb

@@ -0,0 +1,50 @@
+class Thingamajig
+  class List < OsaObject
+    include Container
+
+    class << self
+      def find_by(name:)
+        Thingamajig::List.new(Thingamajig.new.osa_object.lists[name])
+      end
+
+      def inbox
+        find_by(name: "Inbox")
+      end
+
+      def today
+        find_by(name: "Today")
+      end
+
+      def anytime
+        find_by(name: "Anytime")
+      end
+
+      def upcoming
+        find_by(name: "Upcoming")
+      end
+
+      def someday
+        find_by(name: "Someday")
+      end
+
+      def logbook
+        find_by(name: "Logbook")
+      end
+
+      def trash
+        find_by(name: "Trash")
+      end
+
+      # Projects scheduled for the future, not in an area ("later projects") in sidebar
+      def later_projects
+        Thingamajig::List.new(Thingamajig.new.osa_object.lists.ID("THMLonelyLaterProjectsListSource"))
+      end
+    end
+
+    def inspect
+      "#<Thingamajig::List '#{name}'>"
+    end
+  end
+end
+
+

data/lib/thingamajig/modules/container.rb

@@ -0,0 +1,62 @@
+module Thingamajig::Container
+  # Some containers have todos and projects in one list
+  def items(filter = nil)
+    result_reference =
+      if filter
+        osa_object.to_dos[filter]
+      else
+        osa_object.to_dos
+      end
+
+    results = result_reference.get
+
+    wrap_collection(results)
+  end
+
+  def todos(filter = nil)
+    query = todos_query
+    query = query.and(filter) if filter
+
+    items(query)
+  end
+
+  def projects(filter = nil)
+    query = projects_query
+    query = query.and(filter) if filter
+
+    items(query)
+  end
+
+  private
+
+  def wrap_item(item)
+    item_class = item.class_.get
+
+    case item_class
+    when :to_do, :selected_to_do
+      Thingamajig::Todo.new(item)
+    when :project
+      Thingamajig::Project.new(item)
+    when :area
+      Thingamajig::Area.new(item)
+    when :list
+      Thingamajig::List.new(item)
+    else
+      raise "Don't know what #{item_class} is."
+    end
+  end
+
+  def wrap_collection(collection)
+    collection.map do |item|
+      wrap_item(item)
+    end
+  end
+
+  def projects_query
+    Appscript.its.class_.eq(:project)
+  end
+
+  def todos_query
+    Appscript.its.class_.ne(:project)
+  end
+end

data/lib/thingamajig/project.rb

@@ -1,20 +1,15 @@
 class Thingamajig
-  class Project < OsaObject
+  class Project < Todo
+    include Container
+
     def self.find_by(name:)
       Thingamajig::Project.new(Thingamajig.new.osa_object.projects[name])
     end
 
-    def todos(filter = nil)
-      osa_todos = osa_object.to_dos
-      osa_todos = osa_todos[filter] if filter
-
-      osa_todos.get.map do |osa_todo|
-        Thingamajig::Todo.new osa_todo
-      end
-    end
-
     def create_todo!(name, notes)
-      Thingamajig::Todo.new @osa_object.make(new: :to_do, with_properties: {name: name, notes: notes})
+      new_osa_object = osa_object.make(new: :to_do, with_properties: {name: name, notes: notes})
+
+      Thingamajig::Todo.new(new_osa_object)
     end
 
     def inspect

data/lib/thingamajig/todo.rb

@@ -20,12 +20,47 @@ class Thingamajig
       activation_date && activation_date <= Date.today.to_time
     end
 
+    # Use `activate!` to move to Today with today's date as the activation
+    # date. This moving to Today list means it will also pop up at the top
+    # of the Today list in the UI.
+    #
+    # This is different from using the `schedule` command which retains the
+    # position in Today list from earlier.
+    def activate!
+      osa_object.move(to: Thingamajig::List.today.osa_object)
+    end
+
+    def deactivate!
+      osa_object.move(to: Thingamajig::List.anytime.osa_object)
+    end
+
     def activation_date=(new_activation_date)
       if completed? || canceled?
         self.completion_date = nil
       end
 
-      osa_object.schedule(for: new_activation_date)
+      if new_activation_date.present?
+        osa_object.schedule(for: new_activation_date)
+      else
+        deactivate!
+      end
+    end
+
+    # Adds a todo to the bottom of the project
+    def project=(new_project)
+      if new_project
+        super(new_project.osa_object)
+      else
+        osa_object.project.delete
+      end
+    end
+
+    def area=(new_area)
+      if new_area
+        super(new_area.osa_object)
+      else
+        osa_object.area.delete
+      end
     end
 
     def inspect

data/lib/thingamajig/version.rb

@@ -1,3 +1,3 @@
 class Thingamajig
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/thingamajig.rb

@@ -1,9 +1,13 @@
 require "rb-scpt"
 require "thingamajig/version"
 require "thingamajig/osa_object"
+require "thingamajig/modules/container"
+
 require "thingamajig/area"
-require "thingamajig/project"
+require "thingamajig/list"
 require "thingamajig/todo"
+require "thingamajig/project"
+
 
 class Thingamajig
   attr :app
@@ -21,4 +25,10 @@ class Thingamajig
       Thingamajig::Project.new(osa_project)
     end
   end
+
+  def todos
+    app.to_dos.get.map do |osa_todo|
+      Thingamajig::Todo.new(osa_todo)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thingamajig
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Verhasselt
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-06-16 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,8 @@ files:
 - bin/setup
 - lib/thingamajig.rb
 - lib/thingamajig/area.rb
+- lib/thingamajig/list.rb
+- lib/thingamajig/modules/container.rb
 - lib/thingamajig/osa_object.rb
 - lib/thingamajig/project.rb
 - lib/thingamajig/todo.rb
@@ -80,7 +82,7 @@ homepage: https://github.com/dv/thingamajig
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,9 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A library providing an OOPy API for a local Things 3 Mac app
 test_files: []