thingamajig 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 898bf68717745f4122521d3dc8833c6f454daa4b
+  data.tar.gz: ea4f2300f8d45ffb57cee09e447ab34dd95833d4
+SHA512:
+  metadata.gz: e1499faabf11f4643d1ca7f7f06560a3078aeb16002c5859c49007a404ae1f69c288bc0e7567e6566622e8905ddd1061e8a3d85a59dad495343c107ca28c551d
+  data.tar.gz: c4f790028bb56dfdb0c111b2880f689af4c133032e1d708093bb2378f2d87bc5764c8c916a75cbf544236ce07e5fdec29e0b468846ae920048634ae329509843

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thingamajig.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Verhasselt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# Thingamajig
+
+Thingamajig offers an OOPy API to interact with a local [Things 3 Mac app](https://culturedcode.com/things/) instance. Use it to create and manipulate todos and more.
+
+## Usage
+
+This README is severaly lacking in instructions. Here's some sample code that might give you an intuitive feel of how to use it:
+
+```ruby
+  # List all projects
+  Thingamajig.new.projects.each do |project|
+    puts "Found project #{project.name} with #{project.todos.count} todos"
+  end
+
+  # Find a project
+  project = Thingamajig::Project.find_by(name: "Home")
+
+  # List all todos (that have not been logged yet)
+  project.todos.each do |todo|
+    puts "Todo: #{todo.name}"
+    puts todo.notes
+  end
+
+  # List all "active" todos (i.e. showing up in Today)
+  project.todos(Thingamajig::Todo.predicate_active).each do |todo|
+    # Reschedule them to tomorrow
+    todo.activation_date = 1.day.from_now
+  end
+
+  # Create new Todo with a name and some notes
+  todo = project.create_todo!("Fix drainage", "Is it just clogged, or should we replace the plumbing?")
+
+  # Schedule it for a future date
+  todo.activation_date = 5.days.from_now
+
+  # Show it in the GUI
+  todo.show
+
+  # Or complete it
+  todo.complete!
+
+  # List all projects under the Area named "Work"
+  Thingamajig::Area.find_by(name: "Work").projects.flat_map do |project|
+    # For each project, get the todos that are active and have status "open" (not completed or cancelled)
+    project.todos(Thingamajig::Todo.predicate_active.and(Thingamajig::Todo.predicate_open))
+  end
+```
+
+If you're tired of typing "Thingamajig" out in full, feel free to alias it:
+
+```ruby
+Things = Thingamajig
+```
+
+I do. Sadly RubyGems is littered with Things-related gems that haven't been updated in 8 years and don't work with Things 2, let alone Things 3, but they're still hogging all the best names. `things`, `thingies`, `things-client`, `things-rb`, ... even `thingamabob` is taken.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thingamajig'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thingamajig
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/dv/thingamajig/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "thingamajig"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/thingamajig.rb

@@ -0,0 +1,24 @@
+require "rb-scpt"
+require "thingamajig/version"
+require "thingamajig/osa_object"
+require "thingamajig/area"
+require "thingamajig/project"
+require "thingamajig/todo"
+
+class Thingamajig
+  attr :app
+
+  def osa_object
+    app
+  end
+
+  def initialize
+    @app ||= Appscript.app("Things3")
+  end
+
+  def projects
+    app.projects.get.map do |osa_project|
+      Thingamajig::Project.new(osa_project)
+    end
+  end
+end

data/lib/thingamajig/area.rb

@@ -0,0 +1,41 @@
+class Thingamajig
+  class Area < OsaObject
+    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/osa_object.rb

@@ -0,0 +1,64 @@
+class Thingamajig
+  class OsaObject
+    attr :osa_object
+
+    def initialize(osa_object)
+      @osa_object = osa_object
+    end
+
+    # Open in GUI
+    def show
+      osa_object.show
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      valid_property, getter_or_setter, property =
+        parse_method_name(method_name)
+
+      if valid_property
+        if getter_or_setter == :getter
+          get_and_parse(osa_object.public_send(property))
+        else
+          osa_object.public_send(property).set(arguments.first)
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      parse_method_name(method_name).first || super
+    end
+
+    def to_h
+      osa_object.properties_.get
+    end
+    alias_method :properties, :to_h
+
+    private
+
+    def parse_method_name(method_name)
+      method_name = String(method_name)
+
+      getter_or_setter, property =
+        if method_name.end_with?("=")
+          [:setter, method_name[0..-2]]
+        else
+          [:getter, method_name]
+        end
+
+      [properties.keys.include?(property.to_sym), getter_or_setter, property]
+    end
+
+    # OSA returns `:missing_value` for empty fields
+    def get_and_parse(osa_object)
+      result = osa_object.get
+
+      if result == :missing_value
+        nil
+      else
+        result
+      end
+    end
+  end
+end

data/lib/thingamajig/project.rb

@@ -0,0 +1,24 @@
+class Thingamajig
+  class Project < OsaObject
+    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})
+    end
+
+    def inspect
+      "#<Thingamajig::Project '#{name}'>"
+    end
+  end
+end

data/lib/thingamajig/todo.rb

@@ -0,0 +1,71 @@
+class Thingamajig
+  class Todo < OsaObject
+    def complete!
+      self.status = :completed
+    end
+
+    def completed?
+      self.status == :completed
+    end
+
+    def cancel!
+      self.status = :canceled
+    end
+
+    def canceled?
+      self.status == :canceled
+    end
+
+    def active? # meaning in "Today"
+      activation_date && activation_date <= Date.today.to_time
+    end
+
+    def activation_date=(new_activation_date)
+      if completed? || canceled?
+        self.completion_date = nil
+      end
+
+      osa_object.schedule(for: new_activation_date)
+    end
+
+    def inspect
+      "#<Thingamajig::Todo '#{name}'>"
+    end
+
+    class << self
+      def predicate_complete
+        Appscript.its.status.eq(:completed)
+      end
+
+      def predicate_incomplete
+        Appscript.its.status.ne(:completed)
+      end
+
+      def predicate_open
+        Appscript.its.status.eq(:open)
+      end
+
+      def predicate_active
+        Appscript.its.activation_date.le(Date.today)
+      end
+
+      def predicate_upcoming
+        Appscript.its.activation_date.gt(Date.today)
+      end
+
+      def predicate_anytime
+        Appscript.its.activation_date.eq(nil)
+      end
+
+      def completion_query(completion)
+        raise "Cannot have `nil` completion, use either false or true" if completion.nil?
+
+        if completion
+          predicate_complete
+        else
+          predicate_incomplete
+        end
+      end
+    end
+  end
+end

data/lib/thingamajig/version.rb

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

data/thingamajig.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thingamajig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thingamajig"
+  spec.version       = Thingamajig::VERSION
+  spec.authors       = ["David Verhasselt"]
+  spec.email         = ["david@crowdway.com"]
+
+  spec.summary       = %q{A library providing an OOPy API for a local Things 3 Mac app}
+  spec.description   = %q{A library providing an OOPy API for a local Things 3 Mac app, allowing you to manipulate Projects, Areas, Todos, etc}
+  spec.homepage      = "https://github.com/dv/thingamajig"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "rb-scpt"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: thingamajig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Verhasselt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rb-scpt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library providing an OOPy API for a local Things 3 Mac app, allowing
+  you to manipulate Projects, Areas, Todos, etc
+email:
+- david@crowdway.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/thingamajig.rb
+- lib/thingamajig/area.rb
+- lib/thingamajig/osa_object.rb
+- lib/thingamajig/project.rb
+- lib/thingamajig/todo.rb
+- lib/thingamajig/version.rb
+- thingamajig.gemspec
+homepage: https://github.com/dv/thingamajig
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A library providing an OOPy API for a local Things 3 Mac app
+test_files: []