taskwarrior-calendar 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4381f3210f9a478f0b1ad0453d7e84c42f3dd8b2b55a5afc17d0ce8c21fdf938
+  data.tar.gz: 6609c61b9c93d0a0fd8d2fdffcc11d3334ec55297c0ee5004d9e18e64a0e0a1e
+SHA512:
+  metadata.gz: 80f387b7fae053e80079eee0e7d36f17bb6260f9de2d55dde84cd010a9e72aacd8c2193cf67a0e4c46a6063b836c75c7f91fa54238826f37d194eb28bcf2b7bc
+  data.tar.gz: 785ff03b8ce423694a906964a07a97d0dac57f79961cd9ee4cdc48021d5a5a4780383911d9d1b2e89d65d5e6368a7855d9d7608ed5f730e93dba85352f263e33

data/bin/task-ical

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'taskwarrior/calendar/app'
+
+Taskwarrior::Calendar::App::Command.run

data/lib/taskwarrior/calendar/app/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'clamp'
+require 'pastel'
+require 'tty-pager'
+
+require_relative '../version'
+require_relative '../../calendar'
+
+class Taskwarrior
+  class Calendar
+    module App
+      class BaseCommand < Clamp::Command
+        option ['-m', '--man'], :flag, 'show manpage' do
+          manpage = <<~MANPAGE
+            Name:
+              task-ical - Taskwarrior tasks to ical converter
+
+            #{help}
+            Description:
+              The due timestamp, optionally scheduled timestamp and
+              description of a task are used to create a calendar event.
+
+            Authors:
+                Tobias Schäfer <github@blackox.org>
+
+            Copyright and License
+                This software is copyright (c) 2022 by Tobias Schäfer.
+
+                This package is free software; you can redistribute it and/or
+                modify it under the terms of the "MIT License".
+          MANPAGE
+          TTY::Pager.page(manpage)
+
+          exit 0
+        end
+
+        option ['-v', '--version'], :flag, 'show version' do
+          puts "task-ical #{Taskwarrior::Calendar::VERSION}"
+          exit 0
+        end
+
+        def bailout(message)
+          puts Pastel.new.red.bold(message)
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/taskwarrior/calendar/app/convert.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+class Taskwarrior
+  class Calendar
+    module App
+      class ConvertCommand < Taskwarrior::Calendar::App::BaseCommand
+        option '--[no-]alarm', :flag, 'add alarm to event', default: true
+        option '--filter', 'FILTER', 'tasks filter', default: 'status:pending'
+        option '--filename', 'FILE', 'ics output file'
+
+        def execute
+          calendar = Taskwarrior::Calendar.new(filter:, alarm: alarm?)
+          return calendar.publish(filename:) if !filename.nil?
+
+          puts calendar.to_ical
+        rescue StandardError => e
+          bailout(e.cause || e.message)
+        end
+      end
+    end
+  end
+end

data/lib/taskwarrior/calendar/app.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'app/base'
+require_relative 'app/convert'
+
+class Taskwarrior
+  class Calendar
+    module App
+      class Command < Taskwarrior::Calendar::App::BaseCommand
+        self.default_subcommand = 'convert'
+
+        subcommand 'convert', 'Convert tasks to events', Taskwarrior::Calendar::App::ConvertCommand
+      end
+    end
+  end
+end

data/lib/taskwarrior/calendar/event.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'icalendar'
+require 'icalendar/tzinfo'
+
+class Taskwarrior
+  class Calendar
+    module Event
+      def add_event(event, task, type, alarm)
+        date = Icalendar::Values::DateTime.new(
+          tz_info.utc_to_local(DateTime.parse(task[type])),
+          'tzid' => tz_name
+        )
+        event.dtstart = event.dtend = date
+
+        event.summary = "#{type.capitalize}: #{task['description']}"
+        event.ip_class = 'PRIVATE'
+
+        add_event_alarm(event, task, type) if alarm
+      end
+
+      private
+
+      def add_event_alarm(event, task, type)
+        event.alarm do |a|
+          a.action = 'DISPLAY'
+          a.summary = "#{type.capitalize}: #{task['description']}"
+          a.trigger = '-PT15M'
+        end
+      end
+    end
+  end
+end

data/lib/taskwarrior/calendar/timezone.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'tzinfo'
+
+class Taskwarrior
+  class Calendar
+    module Timezone
+      def tz_name
+        @tz_name ||= ENV['TZ'] || begin
+          File.read('/etc/timezone').strip
+        rescue Errno::ENOENT
+          'UTC'
+        end
+      end
+
+      def tz_info
+        @tz_info ||= TZInfo::Timezone.get(tz_name)
+      end
+    end
+  end
+end

data/lib/taskwarrior/calendar/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Taskwarrior
+  class Calendar
+    VERSION = '1.0.1'
+  end
+end

data/lib/taskwarrior/calendar.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'icalendar'
+require 'icalendar/tzinfo'
+require 'json'
+require 'open3'
+
+require_relative 'calendar/timezone'
+require_relative 'calendar/event'
+
+class Taskwarrior
+  ##
+  # Convert taskwarrior tasks to calendar events.
+  #
+  #     calendar = Taskwarrior::Calendar.new(filter: 'status:pending', alarm: false)
+  #     calendar.publish(filename: '~/tasks.ics')
+  #
+  # Task *due* and optional *scheduled* dates if available are exported as
+  # calendar events.
+  #
+  # By default tasks are filtered by +status:pending+ and all events are
+  # appointed with an alarm *15* *minutes* *before* the event date. This can be
+  # configured with the filter and alarm options. For further filter details see
+  # https://taskwarrior.org/docs/filter. All events are exported in the
+  # timezone of the system. This can be configured with the +TZ+ environment
+  # variable.
+  class Calendar
+    include Timezone
+    include Event
+
+    ##
+    # Initialize a new taskwarrior calendar object. Tasks are filtered by
+    # +status:pending+ and all calendar events are appointed with an alarm.
+    # This can be configured with the +filter+ and +alarm+ options.
+    #
+    # On failure an error is raised.
+    def initialize(filter: 'status:pending', alarm: true)
+      tasks(filter:)
+      calendar(alarm:)
+    end
+
+    ##
+    # Return the Icalendar::Calendar object.
+    def to_object
+      @calendar
+    end
+
+    ##
+    # Return the calendar as ICS string.
+    def to_ical
+      @calendar.to_ical
+    end
+
+    ##
+    # Publish calendar ICS to a file, default +taskwarrior.ics+. This can be
+    # configured with the +filename+ option.
+    def publish(filename: 'taskwarrior.ics')
+      File.write(filename, to_ical)
+    end
+
+    private
+
+    def tasks(filter:)
+      @tasks = Open3.popen3("task #{filter} export") do |_, stdout, stderr, process|
+        raise IOError, "taskwarrior: #{stderr.read}" if process.value.exitstatus != 0
+
+        JSON.parse(stdout.read)
+      end
+    end
+
+    def calendar(alarm:)
+      @calendar = Icalendar::Calendar.new
+      @calendar.add_timezone(tz_info.ical_timezone(DateTime.now))
+
+      @tasks.each do |task|
+        %w[due scheduled].each do |type|
+          next if !task.key?(type) || task[type].empty?
+
+          @calendar.event do |event|
+            add_event(event, task, type, alarm)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: taskwarrior-calendar
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Tobias Schäfer
+bindir: bin
+cert_chain: []
+date: 2025-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  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'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: logger
+  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'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  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'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: tty-pager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.6
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2023.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2023.3
+description: |
+  Convert taskwarrior tasks to calendar events.
+
+  The due timestamp, optionally scheduled timestamp and description of a
+  task are used to create a calendar event.
+email:
+- github@blackox.org
+executables:
+- task-ical
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/task-ical
+- lib/taskwarrior/calendar.rb
+- lib/taskwarrior/calendar/app.rb
+- lib/taskwarrior/calendar/app/base.rb
+- lib/taskwarrior/calendar/app/convert.rb
+- lib/taskwarrior/calendar/event.rb
+- lib/taskwarrior/calendar/timezone.rb
+- lib/taskwarrior/calendar/version.rb
+homepage: https://github.com/tschaefer/taskwarrior-calendar
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/tschaefer/taskwarrior-calendar
+  bug_tracker_uri: https://github.com/tschaefer/taskwarrior-calendar/issues
+post_install_message: All your tasks are belong to us!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Convert taskwarrior tasks to calendar events.
+test_files: []