remind-rb 6.2.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: daa0dd537d39ea7768f3848c86ba2aacf71617034da93137cbdc491b4f5d30da
+  data.tar.gz: d66fe872b309adfe25f2a775042803289ea2e7c9d320cd0b2eefc90daaed0b32
+SHA512:
+  metadata.gz: 1760a9fa1eb2f0ef87b9a3d55d3b2bc47511873330c68de293fd16f7130234fe88582367f0511e0006c113a41104a6280b43195866fa618f2afd895f65493150
+  data.tar.gz: 3e3adb0c825672c4773d8f3ffce07791d1ec7b3bbbfd7bc3b8565c9f5dd80d17e20fdf509bad90fe43148bc74893310773f0845060837dbd0d703ca7c3e7ad93

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/README.md

@@ -0,0 +1,141 @@
+# remind-rb
+
+Ruby bindings for [Remind](https://dianne.skoll.ca/projects/remind/), through
+Fiddle.
+
+```ruby
+require "remind"
+
+Remind.today = Date.new(2026, 8, 19)
+
+reminder = Remind.parse("REM Mon 13 SKIP OMIT Sat Sun MSG payday")
+reminder.summary                 # => "payday"
+reminder.occurrences.first(3)    # => Remind's own trigger dates
+reminder.weekdays                # => ["MO"]
+
+Remind.evaluate("moonphase(today())")   # => 46
+Remind.evaluate("trigger(today() + 7)") # => "26 August 2026"
+```
+
+## Why
+
+Remind's trigger language is bigger than it looks. `REM Mon 13` is not the
+second Monday of the month, it is the Monday of the week the 13th falls in.
+`REM Wed Thu 15` fires once, on whichever of those weekdays comes first on or
+after the 15th. Then there are `SKIP`, `BEFORE`, `AFTER`, `OMIT`, `SCANFROM`,
+`UNTIL`, `*n` repeats and back-counted deltas — the manual works through
+eighteen examples before it reaches the exceptions.
+
+Every program that has read reminder files with regular expressions has got
+part of it wrong. These bindings do not read it at all: `ParseRem` parses the
+trigger, `ComputeTrigger` says which dates it fires on, and `DoSubst` renders
+the message. What is on the Ruby side is a translation of names, and nothing
+about the language.
+
+## Layout
+
+| Path | What it is |
+| --- | --- |
+| `remind-v06.02.10/` | the Remind release these bindings bind, vendored unchanged |
+| `ext/remind/shim.c` | the only C in the gem: struct accessors, and the sequence in `DoRem` |
+| `lib/remind/builder.rb` | builds the sources into a shared library, with the flags `./configure` chose |
+| `lib/remind/native.rb` | the dlopen'd library: functions, globals, constants |
+| `lib/remind/runtime.rb` | the startup `InitRemind` does before it looks at argv |
+| `lib/remind/session.rb` | a live interpreter: `today =`, `evaluate` |
+| `lib/remind/reminder.rb` | one `REM` line: its fields, its message, its dates |
+| `lib/remind/source.rb` | a reminder file, with continuations joined and `INCLUDE`s followed |
+| `.github/workflows/` | `cross-compile.yml` builds the platform gems; `test.yaml` runs the suites |
+| `lib/rem2ics/`, `exe/rem2ics` | the converter — see [docs/rem2ics.md](docs/rem2ics.md) |
+| `lib/remlint/`, `exe/remlint` | RemLint, a style linter for reminder files — see [docs/remlint.md](docs/remlint.md) |
+
+Three gems share this `lib/`, the way ratalada's three share theirs:
+`remind-rb`, `rem2ics` and `remlint`, each with its own gemspec at the root and
+its own version, all developed from one bundle.
+
+## Installing
+
+```
+gem install remind-rb
+```
+
+That is an unpack, not a build. Remind is C, and compiling it means
+`./configure`, `make` and a toolchain — a packaging problem, solved once in CI
+rather than on every machine that installs the gem.
+`.github/workflows/cross-compile.yml` builds the shared library on each
+platform and packages a gem with the library already inside; RubyGems serves
+the one matching yours. The library is built without readline, so it asks the
+loader for nothing a plain system lacks.
+
+The source gem carries the vendored Remind sources and no library, for a
+platform CI does not cover: `gem install remind-rb --platform=ruby` then
+`rake compile`. `REMIND_LIBRARY` points the bindings at a library built
+anywhere else.
+
+## Working on it
+
+```
+bin/setup                  # bundle, compile, install git hooks
+rake compile               # ./configure + one -fPIC -shared compile
+bin/test                   # every suite in the repository
+rake native[x86_64-linux]  # package a precompiled gem for one platform
+```
+
+The compile reads the compiler, the flags, the feature macros and the
+libraries to link out of the `src/Makefile` that `./configure` generated, and
+adds `-fPIC -shared` and `ext/remind/shim.c`. It writes
+`lib/remind/libremind.so` — where a precompiled gem carries it, so a checkout
+and an installed gem look the same to everything above.
+
+## Versioning
+
+`6.2.10.0` is Remind `06.02.10`, packaged for the first time. The first three
+segments say which Remind is inside; the fourth is ours, bumped for changes on
+the Ruby side against that same release:
+
+```
+bin/increment-version            # 6.2.10.0 -> 6.2.10.1
+bin/increment-version 06.03.00   # track a newly vendored release -> 6.3.0.0
+```
+
+The second form refuses to name a release whose sources are not vendored, so
+the version cannot claim a Remind that is not there.
+
+## Releasing
+
+CI builds the platform gems and uploads them; publishing is deliberate:
+
+```
+bin/release-gem
+```
+
+It refuses to publish a version that is not ahead of what is on RubyGems,
+builds the source gem locally, downloads the precompiled gems from the latest
+green `cross-compile.yml` run, and pushes all of them — tolerating anything
+already published, so a half-finished release can simply be re-run.
+
+## The two things to know
+
+**Fiddle, not a C extension.** There is nothing to extend: Remind's sources
+compile into a shared library as they are, and everything worth calling is a
+plain function over ints and pointers. `ext/shim.c` exists for two things
+Fiddle cannot do — reading a 30-field struct without hard-coding byte offsets,
+and running the six-call sequence `DoRem` uses to parse a line — not because
+Fiddle needed help calling anything.
+
+**The state is process-wide.** Remind keeps "today" in a global, because a
+program that runs once and exits has no reason not to. `Remind.today =` moves
+the ground under every calculation, deliberately: a reminder that says `Mon`
+means a different date tomorrow than it does today, and pinning the date is
+what makes a conversion reproducible. Calls into the library are serialised
+behind one lock, whether they came from one `Session` or several.
+
+## Licence
+
+GPL-2.0-only — see [LICENSE](LICENSE).
+
+Not a choice so much as a consequence: this gem vendors Remind's complete
+source tree, compiles it, and ships the result, so what it publishes is a
+distribution of Remind. `ext/remind/shim.c` is written against Remind's own
+headers and links into one shared library with its objects. Remind is
+Copyright (C) 1992-2026 Dianne Skoll; the bindings around it are Copyright (C)
+2026 Nathan Kidd, under the same terms.