rem2ics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbb257ef75bfa0156a8dfeda780f6c6bd5160e5d025f31506fa8f6c47f0e723f
+  data.tar.gz: fd1fb4f2a3491f1ebb1c3fc9f0bbafefa3cd471e805acb7e1db29489b98860f6
+SHA512:
+  metadata.gz: d7cee2cbe190a2def235f39629d2ca9e45d5ab3d1b3b523872ca4abef3bdbe36e4f08052eac90372546691380fbca3c1085e7284ab2fe8a689102f6d32249dfd
+  data.tar.gz: 8743f0042e255453a830e0b1c349b12ac4f350e2b5f28a0da3449cf7bd25387512325586b0a322daf22671dec095db032e77a01b3116c95606bbc4caf11090ad

data/LICENSE

@@ -0,0 +1,328 @@
+remind-rb and rem2ics are distributed under the GNU General Public License,
+Version 2 -- the licence of Remind, which they are built from and cannot be
+separated from.
+
+Why it is GPL-2.0-only and not something more permissive:
+
+  * remind-rb vendors the complete Remind source tree (remind-v*/), compiles
+    it, and distributes the result. A precompiled gem contains Remind's
+    object code; a source gem contains Remind's source. Either way what is
+    published is a distribution of Remind.
+
+  * ext/remind/shim.c is written against Remind's own headers and calls its
+    internal functions, and the shared library it is part of is one work with
+    Remind's objects.
+
+  * rem2ics depends on remind-rb and runs entirely through it.
+
+So the whole of this repository is offered under the same terms Remind is,
+and the GPL's conditions -- source availability, no additional restrictions,
+same licence for derivative works -- apply to all of it.
+
+Copyright:
+
+  Remind                Copyright (C) 1992-2026 Dianne Skoll,
+                        except where noted in individual files.
+                        See remind-v*/COPYRIGHT.
+
+  remind-rb, rem2ics    Copyright (C) 2026 Nathan Kidd.
+
+  The Ruby bindings, the shim, the converter and everything else outside
+  remind-v*/ are original work; Remind itself is redistributed unmodified.
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; version 2 of the License.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+The full text follows.
+
+----------------------------------------------------------------------------
+
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+--
+Dianne Skoll <dianne@skoll.ca>
+
+https://dianne.skoll.ca/projects/remind

data/docs/rem2ics.md

@@ -0,0 +1,83 @@
+# rem2ics
+
+Reminder files to iCalendar, built on the [remind-rb](../README.md) bindings.
+
+```
+$ rem2ics --date 2026-08-19 ~/.reminders > calendar.ics
+$ rem2ics --help
+Usage: rem2ics [options] [file...]
+    -d, --date DATE     Convert as of this date (default: today)
+    -n, --horizon COUNT How many occurrences to check a recurrence rule against
+    -o, --organizer ADDRESS
+```
+
+This is a port of Martin Michel's `remmy.pl`, and the interesting difference is
+not that it is Ruby.
+
+## The judgement it makes
+
+A recurring reminder should become one event with an `RRULE`, so the calendar
+repeats it for ever. The trouble is that Remind's trigger language and
+iCalendar's `RRULE` overlap without either containing the other. `REM 15` and
+`FREQ=MONTHLY;BYMONTHDAY=15` are the same thing. `REM 1 Mar SKIP OMIT Sat Sun`
+is not any `RRULE`: it means "1 March, unless that is a weekend, in which case
+not at all", and no `BY*` part says that.
+
+Previous converters guessed. This one guesses and then **checks**: the
+candidate rule is expanded with ice_cube and compared, occurrence by
+occurrence, against the dates Remind itself computes.
+
+- Where they agree, the event carries the rule, and recurs for ever, correctly.
+- Where they disagree, the event carries Remind's own dates as `RDATE`s:
+  finite, but not wrong anywhere.
+
+That check is the whole reason to build this on bindings. Without Remind in the
+process there is nothing to check against.
+
+```
+$ rem2ics --date 2019-01-20 examples/remmy-triggers.rem | grep -E 'SUMMARY|RRULE'
+SUMMARY:1st Monday after 15th of every month in 2020
+RRULE:FREQ=MONTHLY;UNTIL=20201231;BYDAY=MO;BYMONTHDAY=15,16,17,18,19,20,21
+```
+
+`remmy.pl` renders that same reminder as `BYDAY=+3MO` — the third Monday —
+which is a different day in any month whose 1st is a Monday. The window form
+above is what Remind actually means, and it is emitted only because expanding
+it matched.
+
+`examples/` at the repository root holds that comparison: `remmy-triggers.rem` is remmy's own test
+input, and `remmy-reference.ics` is what remmy makes of it.
+
+## What maps to what
+
+| Reminder | iCalendar |
+| --- | --- |
+| the trigger | `DTSTART`, and `RRULE` or `RDATE` |
+| `MSG`, rendered in Remind's CAL mode | `SUMMARY` — where a `%"…%"` title is honoured |
+| `MSG`, rendered normally | `DESCRIPTION` |
+| `AT` | the time on `DTSTART` |
+| `DURATION` | `DTEND` |
+| `+n` on the trigger | `VALARM`, n days before |
+| `+n` on `AT` | `VALARM`, n minutes before |
+| `RUN`, `CAL`, `PS`, `SATISFY` | nothing — they are not appointments |
+
+## Known limits
+
+- **It converts from a date forwards.** `DTSTART` is the first occurrence on or
+  after the day being converted, not the reminder's first ever occurrence. A
+  reminder with nothing left to fire — `REM Tue Aug 2018` read in 2019 — is
+  dropped.
+- **One message per event.** Remind expands `%b` and friends per occurrence;
+  an event has one `SUMMARY`. It is rendered as of the day the event starts.
+- **Zones are the reader's.** Times are local wall-clock, with no `TZID`, which
+  is what a reminder file says.
+- **`INCLUDECMD` is not followed.** It runs a shell command, and converting
+  somebody else's reminder file should not execute what is in it.
+
+## Licence
+
+GPL-2.0-only — see [LICENSE](../LICENSE).
+
+rem2ics runs entirely through remind-rb, which is Remind, so it carries
+Remind's licence. Copyright (C) 2026 Nathan Kidd; Remind itself is Copyright
+(C) 1992-2026 Dianne Skoll.

data/exe/rem2ics

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+
+require "rem2ics"
+
+exit(Rem2ics::CLI.new.call(ARGV))

data/lib/rem2ics/cli.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require "date"
+require "optparse"
+
+require_relative "converter"
+require_relative "recurrence"
+require_relative "version"
+
+module Rem2ics
+  # The `rem2ics` command.
+  #
+  # Streams are injected rather than assumed, so the whole command is testable
+  # without shelling out or capturing `$stdout`.
+  class CLI
+    EXIT_SUCCESS = 0
+    EXIT_FAILURE = 1
+    EXIT_USAGE = 2
+
+    # Remind reads standard input under this name; so does this.
+    STDIN = "-"
+
+    Options = Struct.new(
+      :paths,
+      :today,
+      :horizon,
+      :organizer,
+      keyword_init: true,
+    )
+
+    attr_reader :out, :err
+
+    def initialize(out: $stdout, err: $stderr)
+      @out = out
+      @err = err
+    end
+
+    def call(argv)
+      options = Options.new(
+        paths:     [],
+        today:     Date.today,
+        horizon:   Recurrence::DEFAULT_HORIZON,
+        organizer: nil,
+      )
+
+      dispatch(parse(argv, options), options)
+    rescue OptionParser::ParseError, Date::Error => error
+      err.puts(error.message)
+      EXIT_USAGE
+    end
+
+    private
+
+      def dispatch(action, options)
+        case action
+        when :version then print_version
+        when :help    then EXIT_SUCCESS
+        else convert(options)
+        end
+      end
+
+      def convert(options)
+        out.print(calendar(options).to_ical)
+
+        EXIT_SUCCESS
+      rescue Remind::LibraryMissing => error
+        err.puts(error.message)
+        EXIT_FAILURE
+      end
+
+      def calendar(options)
+        Converter.new(
+          horizon:   options.horizon,
+          organizer: options.organizer,
+          warnings:  err,
+        ).call(options.paths, today: options.today)
+      end
+
+      def parse(argv, options)
+        action = nil
+
+        parser(options) { |chosen| action = chosen }.parse!(argv)
+        options.paths = paths_from(argv)
+
+        action
+      end
+
+      # No files means standard input, the way `remind -` does.
+      def paths_from(argv)
+        if argv.empty?
+          [STDIN]
+        else
+          argv
+        end
+      end
+
+      def parser(options)
+        OptionParser.new do |parser|
+          parser.banner = "Usage: rem2ics [options] [file...]"
+
+          parser.on("-d", "--date DATE", "Convert as of this date (default: today)") do |date|
+            options.today = Date.parse(date)
+          end
+
+          parser.on(
+            "-n",
+            "--horizon COUNT",
+            Integer,
+            "How many occurrences to check a recurrence rule against (default: #{Recurrence::DEFAULT_HORIZON})",
+          ) do |count|
+            options.horizon = count
+          end
+
+          parser.on("-o", "--organizer ADDRESS", "ORGANIZER for every event") do |address|
+            options.organizer = address
+          end
+
+          parser.on("-v", "--version", "Print the version") { yield :version }
+
+          parser.on("-h", "--help", "Print this message") do
+            out.puts(parser.help)
+            yield :help
+          end
+        end
+      end
+
+      def print_version
+        out.puts("rem2ics #{VERSION} (Remind #{Remind.version})")
+
+        EXIT_SUCCESS
+      end
+  end
+end
+
+__END__
+
+require "stringio"
+require "tempfile"
+
+describe "Rem2ics::CLI" do
+  run = proc do |argv|
+    out = StringIO.new
+    err = StringIO.new
+    code = Rem2ics::CLI.new(out: out, err: err).call(argv)
+
+    [code, out.string, err.string]
+  end
+
+  file = proc do |text|
+    handle = Tempfile.new(["reminders", ".rem"])
+    handle.write(text)
+    handle.close
+    handle.path
+  end
+
+  it "converts the files it is given" do
+    code, output, = run.(["--date", "2026-08-19", file.("REM 25 Dec MSG christmas\n")])
+
+    code.should == 0
+    output.should.include "SUMMARY:christmas"
+  end
+
+  it "converts as of the date it is told" do
+    _, output, = run.(["--date", "2027-03-01", file.("REM Mon MSG gym\n")])
+
+    output.should.include "DTSTART;VALUE=DATE:20270301"
+  end
+
+  it "takes the organizer from the command line" do
+    _, output, = run.(["-o", "me@host", file.("REM 25 Dec MSG christmas\n")])
+
+    output.should.include "ORGANIZER:mailto:me@host"
+  end
+
+  it "prints the version of both itself and Remind" do
+    code, output, = run.(["--version"])
+
+    code.should == 0
+    output.should.include Rem2ics::VERSION
+    output.should.include Remind.version
+  end
+
+  it "prints help without converting anything" do
+    code, output, = run.(["--help"])
+
+    code.should == 0
+    output.should.include "Usage: rem2ics"
+    output.should.not.include "BEGIN:VCALENDAR"
+  end
+
+  it "rejects an option it does not know" do
+    code, _, errors = run.(["--nonsense"])
+
+    code.should == 2
+    errors.should.include "nonsense"
+  end
+
+  it "rejects a date it cannot read" do
+    run.(["--date", "not-a-date"]).first.should == 2
+  end
+end