msgthr 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a571597f50c7ec04abef8c956d811854d727bcc
+  data.tar.gz: 07f8634e7f6bd758206ad6e8170acd5048af2b07
+SHA512:
+  metadata.gz: 1e13bda13b30d4548955d306570848c8bf5f0993575617b81822a4fc684085182eb7200f5e0cadfc56c38215c166d06d8fa07853cbbad784c21665b13e9355ee
+  data.tar.gz: 7217b572b347c32ef5a01d0b95c805dfc37e28bd54ad078d4bd38f8b7c5396ba0806d052c2194b078fac78770c72cb449cb485f2ec8af1f8fdff68b528fd3db6

data/.document

@@ -0,0 +1 @@
+lib

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.gz
+.manifest
+pkg/
+/LATEST
+/NEWS
+/NEWS.atom.xml
+/doc
+/www

data/.olddoc.yml

@@ -0,0 +1,6 @@
+---
+cgit_url: https://80x24.org/msgthr.git
+git_url: git://80x24.org/msgthr.git
+rdoc_url: https://80x24.org/msgthr/rdoc/
+ml_url: https://80x24.org/msgthr-public/
+public_email: msgthr-public@80x24.org

data/COPYING

@@ -0,0 +1,339 @@
+                    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 Lesser 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
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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; either version 2 of the License, or
+    (at your option) any later version.
+
+    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.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/GNUmakefile

@@ -0,0 +1,76 @@
+# Copyright (C) 2016 all contributors <msgthr-public@80x24.org>
+# License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
+all::
+pkg = msgthr
+RUBY = ruby
+lib := lib
+VERSION := 1.0.1
+RSYNC_DEST := 80x24.org:/srv/80x24/msgthr/
+
+RSYNC = rsync
+OLDDOC = olddoc
+RDOC = rdoc
+
+all:: test
+test_units := $(wildcard test/test_*.rb)
+test: $(test_units)
+$(test_units):
+	$(RUBY) -w -I $(lib) $@ -v
+
+check-warnings:
+	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \
+	  do $(RUBY) -d -W2 -c $$i; done) | grep -v '^Syntax OK$$' || :
+
+check: test
+
+pkggem := pkg/$(pkg)-$(VERSION).gem
+
+fix-perms:
+	git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
+
+gem: $(pkggem)
+
+install-gem: $(pkggem)
+	gem install --local $(CURDIR)/$<
+
+$(pkggem): .manifest
+	VERSION=$(VERSION) gem build $(pkg).gemspec
+	mkdir -p pkg
+	mv $(@F) $@
+
+pkg_extra :=
+
+.manifest: fix-perms
+	git ls-files | LC_ALL=C sort >$@+
+	cmp $@+ $@ || mv $@+ $@; rm -f $@+
+
+package: $(pkggem)
+
+NEWS: .olddoc.yml
+	$(OLDDOC) prepare
+LATEST: NEWS
+
+doc:: .document .olddoc.yml
+	-find lib -type f -name '*.rbc' -exec rm -f '{}' ';'
+	$(RM) -r doc
+	$(RDOC) -f oldweb
+
+# this requires GNU coreutils variants
+ifneq ($(RSYNC_DEST),)
+publish_doc:
+	-git set-file-times
+	$(MAKE) doc
+	mkdir -p www
+	$(RM) -r www/rdoc
+	mv doc www/rdoc
+	install -m644 README www/README
+	install -m644 NEWS www/NEWS
+	install -m644 NEWS.atom.xml www/NEWS.atom.xml
+	for i in $$(find www -type f ! -regex '^.*\.gz$$'); do \
+	  gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
+	$(RSYNC) -av www/ $(RSYNC_DEST)
+	git ls-files | xargs touch
+endif
+
+.PHONY: all test $(test_units)
+.PHONY: check-warnings fix-perms

data/README

@@ -0,0 +1,102 @@
+msgthr - container-agnostic, non-recursive message threading
+------------------------------------------------------------
+
+Pure Ruby message threading based on the algorithm described by
+JWZ in <https://www.jwz.org/doc/threading.html> and used in
+countless mail and news readers; but with some features removed
+and improved flexibility:
+
+* Message format-agnostic, not limited to email or NNTP;
+  but even appropriate for forums, blog comments, IM, etc.
+  For mail and NNTP messages, that means you must extract
+  the Message-ID and parse the References and In-Reply-To
+  headers into an array yourself.
+
+* No recursion; all algorithms are non-recursive to avoid
+  SystemStackError exceptions in deep message threads.
+  Memory usage is bound by the number of lightweight containers
+  needed to represent a thread.
+
+* No pruning of non-leaf ghosts.  Readers are not shielded
+  from deleted or lost messages.  Equivalent to setting
+  "hide_missing" to "no" in mutt.
+
+* No grouping by subject[1].  This makes things ideal for short
+  messages such as chat and status updates.  For email, this
+  encourages the use of proper client which set In-Reply-To
+  or References headers.  Equivalent to setting "strict_threads"
+  to "yes" in mutt.
+
+  [1] - Instead, messages with the same Subject can be grouped
+        by a search engine.  For email, this would be done using
+        a mail search engine like notmuch or mairix.
+
+Source code
+-----------
+
+Our Ruby 1.9.3+ compatible code is available via git,
+no C compiler or other dependencies are required:
+
+	git clone git://80x24.org/msgthr
+	git clone https://80x24.org/msgthr.git
+
+Releases may be downloaded via RubyGems:
+
+	gem fetch [-v VERSION] msgthr
+
+The code used in this Ruby library was originally derived from
+the Mail::Thread module for Perl 5.x:
+
+	https://metacpan.org/release/Mail-Thread
+
+Contact
+-------
+
+Feedback is welcome via plain-text mail (no HTML, images, etc).
+Please send comments, user/dev discussion, patches, bug reports,
+and pull requests to the open-to-all mailing list at:
+
+	msgthr-public@80x24.org
+
+No subscription will ever be required to post.  Please Cc: all
+recipients as subscription will never be necessary.
+
+Mailing list archives are available via HTTPS and NNTP:
+
+	https://80x24.org/msgthr-public/
+	nntp://news.public-inbox.org/inbox.comp.lang.ruby.msgthr
+
+You may optionally subscribe, but will never be required to:
+
+	msgthr-public+subscribe@80x24.org
+
+This README is our homepage, we would rather be working on cool
+stuff day than worrying about the next browser vulnerability
+because CSS/JS/images are all too complicated for us.
+
+RDoc API documentation in simple HTML is available at:
+
+	https://80x24.org/msgthr/rdoc/
+
+Copyright
+---------
+
+Copyright 2016-2017, all contributors (see git repo).
+License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
+
+msgthr is copyrighted Free Software by all contributors, see logs in
+revision control for names and email addresses of all of them.
+
+msgthr 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; either version 2 of
+the License, or (at your option) any later version.
+
+msgthr 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.
+
+You should have received a copy of the GNU General Public
+License along with this program; if not, see
+https://www.gnu.org/licenses/gpl-2.0.txt

data/lib/msgthr/container.rb

@@ -0,0 +1,91 @@
+# Copyright (C) 2016 all contributors <msgthr-public@80x24.org>
+# License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
+
+# An internal container class, this is exposed for Msgthr#order!
+# and Msgthr#walk_thread APIs.  They should should not be initialized
+# in your own code.
+#
+# One container object will exist for every message you call Msgthr#add! on,
+# so there can potentially be many of these objects for large sets of
+# messages.
+class Msgthr::Container
+
+  # Unique message identifier, typically the Message-Id header for mail
+  # and news messages.  This may be any hashable object, Integer values
+  # are allowed and will not be coerced to string values.
+  attr_reader :mid
+
+  # Opaque data pointer, may be used by the user for any purpose.
+  # This is +nil+ to denote missing (aka "ghost") messages.
+  attr_accessor :msg
+
+  # You probably do not need to use this.
+  # It is only safe to access this after Msgthr#order!
+  # This contains an Array of Msgthr::Container objects which have the
+  # +parent+ field pointing to us
+  attr_accessor :children
+
+  # You probably do not need to use this; and you should only use
+  # this after Msgthr#order!  This points to the +parent+ of the
+  # message if one exists, and +nil+ if a message has no parent.
+  # This will only be accurate once all messages are added to
+  # a Msgthr set via Msgthr#add
+  attr_accessor :parent # :nodoc:
+
+  def initialize(mid) # :nodoc:
+    @mid = mid
+    @children = {} # becomes an Array after order!
+    @parent = nil
+    @msg = nil # opaque pointer supplied by user
+  end
+
+  # Returns the topmost message container with an opaque message pointer
+  # in it.  This may be +nil+ if no message is available.
+  # This is preferable to using the container yielded by Msgthr#order!
+  # directly when handling incomplete message sets.
+  def topmost
+    q = [ self ]
+    while cont = q.shift
+      return cont if cont.msg
+      q.concat(cont.children.values)
+    end
+    nil
+  end
+
+  def add_child(child) # :nodoc:
+    raise 'cannot become child of self' if child == self
+    cid = child.mid
+
+    # reparenting:
+    parent = child.parent and parent.children.delete(cid)
+
+    @children[cid] = child
+    child.parent = self
+  end
+
+  def has_descendent(child) # :nodoc:
+    seen = Hash.new(0)
+    while child
+      return true if self == child || (seen[child] += 1) != 0
+      child = child.parent
+    end
+    false
+  end
+
+  # only called by Msgthr#order!
+  def order! # :nodoc:
+    seen = { @mid => true }
+    q = [ self ]
+    while cur = q.shift
+      c = []
+      cur.children.each do |cmid, cont|
+        next if seen[cmid]
+        c << cont
+        seen[cmid] = true
+      end.clear
+      yield(c) if c.size > 1
+      cur.children = c
+      q.concat(c)
+    end
+  end
+end

data/lib/msgthr.rb

@@ -0,0 +1,155 @@
+# Copyright (C) 2016 all contributors <msgthr-public@80x24.org>
+# License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
+
+# Non-recursive, container-agnostic message threading.
+#
+# Usage is typically:
+#
+# * use Msgthr.new to create a new object
+# * use Msgthr#add! for every message you have
+# * use Msgthr#thread! to perform threading operations
+# * optionally, use Msgthr#order! to sort messages
+# * use Msgthr#walk_thread to iterate through the threaded tree
+#
+# See https://80x24.org/msgthr/README for more info
+# You may email us publically at mailto:msgthr-public@80x24.org
+# Archives are at https://80x24.org/msgthr-public/
+class Msgthr
+
+  # an Array of root (parent-less) messages, only populated after
+  # calling Msgthr#thread!
+  attr_reader :rootset
+
+  # Initialize a Msgthr object
+  def initialize
+    @id_table = {}
+    @rootset = []
+  end
+
+  # Clear internal data structures to save memory and prepare for reuse
+  def clear
+    @rootset.clear
+    @id_table.clear
+  end
+
+  # Performs threading on the messages and returns the rootset
+  # (set of message containers without parents).
+  #
+  # Call this after all #add operations are complete.
+  # This does not sort, use #order! if sorting is necessary.
+  def thread!
+    ret = @rootset
+    @id_table.each_value { |cont| ret << cont if cont.parent.nil? }.clear
+    ret
+  end
+
+  # Performs an in-place sort on messages after thread!
+  # This is optional and intended to be called this only after #thread!
+  #
+  # This takes a block which yields an array of Msgthr::Container
+  # objects for sorting.
+  #
+  # To sort by unique +mid+ identifiers for each container:
+  #
+  #   msgthr.order! { |ary| ary.sort_by!(&:mid) }
+  #
+  # If your opaque message pointer contains a +time+ accessor which gives
+  # a Time object:
+  #
+  #   msgthr.order! do |ary|
+  #     ary.sort_by! do |cont| # Msgthr::Container
+  #       cur = cont.topmost
+  #       cur ? cur.msg.time : Time.at(0)
+  #     end
+  #   end
+  #
+  # Note, using Msgthr::Container#topmost is NOT necessary when accessing
+  # Msgthr::Container#mid, as any known missing messages (ghosts)
+  # will still have a +mid+.  However, Msgthr::Container#topmost is
+  # necessary if accessing Msgthr::Container#msg.
+  def order!
+    yield @rootset
+    @rootset.each do |cont|
+      # this calls Msgthr::Container#order!, which is non-recursive
+      cont.order! { |children| yield(children) }
+    end
+  end
+
+  # non-recursively walk a set of messages after #thread!
+  # (and optionally, #order!)
+  #
+  # This takes a block and yields 3 elements to it: +|level, container, index|+
+  # for each message container.
+  #
+  # * +level+ is the current depth within the walk (non-negative Integer)
+  # * +container+ is the Msgthr::Container object
+  # * +index+ is the offset of the container within its level (starting at 0)
+  #
+  # To display the subject of each message with indentation,
+  # assuming your +msg+ pointer has a +subject+ field:
+  #
+  #   msgthr.walk_thread do |level, container, index|
+  #     msg = container.msg
+  #     subject = msg ? msg.subject : "[missing: <#{container.mid}>]"
+  #     indent = '  ' * level
+  #     printf("#{indent} % 3d. %s\n", index, subject)
+  #   end
+  def walk_thread
+    i = -1
+    q = @rootset.map { |cont| [ 0, cont, i += 1 ] }
+    while tmp = q.shift
+      level, cont, idx = tmp
+      yield(level, cont, idx)
+      level += 1
+      i = -1
+      q = cont.children.map { |cld| [ level, cld, i += 1 ] }.concat(q)
+    end
+  end
+
+  # Adds a message to prepare a Msgthr object for threading.
+  #
+  # * +mid+ is a unique identifier for the message in a given thread.
+  #   It is typically a String or Integer, but may be anything usable
+  #   as a Hash key in Ruby.
+  #
+  # * +refs+ should be an Array of unique identifiers belonging
+  #   to ancestors of the current message.
+  #   For mail and news messages, this is usually the parsed result
+  #   of the "References:" header.  Order should be oldest to newest
+  #   in terms of ancestry, with the last element being the
+  #   immediate parent of the given message.
+  #
+  #   This is +nil+ for messages with no parent (root messages).
+  #
+  # * +msg+ is an opaque object which typically contains a
+  #   Mail or Tmail object for handling mail.
+  #
+  # If +mid+ is a String, it is recommended to freeze the string before
+  # calling this method to avoid wasting memory on hash keys.  Likewise
+  # is true for any String objects in +refs+.
+  def add(mid, refs, msg)
+    cur = @id_table[mid] ||= Msgthr::Container.new(mid)
+    cur.msg = msg
+    refs or return
+
+    # n.b. centralized messaging systems (e.g. forums) do not need
+    # multiple References:, only decentralized systems need it to
+    # tolerate missing messages
+    prev = nil
+    refs.each do |ref|
+      cont = @id_table[ref] ||= Msgthr::Container.new(ref)
+
+      # link refs together in order implied,
+      # but do not change existing links or loop
+      if prev && !cont.parent && !cont.has_descendent(prev)
+        prev.add_child(cont)
+      end
+      prev = cont
+    end
+
+    # set parent of this message to be the last element in refs
+    prev.add_child(cur) if prev
+  end
+end
+
+require_relative 'msgthr/container'

data/msgthr.gemspec

@@ -0,0 +1,17 @@
+# Copyright (C) 2016 all contributors <msgthr-public@80x24.org>
+# License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
+
+Gem::Specification.new do |s|
+  manifest = File.read('.manifest').split(/\n/)
+  s.name = %q{msgthr}
+  s.version = ENV['VERSION'] || '1.0.1'
+  s.authors = ['msgthr hackers']
+  s.summary = 'container-agnostic, non-recursive message threading'
+  s.description = File.read('README').split(/\n\n/)[1].strip
+  s.email = %q{msgthr-public@80x24.org}
+  s.homepage = 'https://80x24.org/msgthr/'
+  s.executables = []
+  s.files = manifest
+  s.licenses = 'GPL-2.0+'
+  s.required_ruby_version = '>= 1.9.3'
+end

data/test/test_msgthr.rb

@@ -0,0 +1,36 @@
+# Copyright (C) 2016 all contributors <msgthr-public@80x24.org>
+# License: GPL-2.0+ <https://www.gnu.org/licenses/gpl-2.0.txt>
+require 'test/unit'
+require 'msgthr'
+
+class TestMsgthr < Test::Unit::TestCase
+  def test_msgthr
+    thr = Msgthr.new
+    thr.add('a', %w(c b), 'abc')
+    thr.add('b', %w(c), 'B')
+    thr.add('c', nil, 'c')
+    thr.add('D', nil, 'D')
+    thr.add('d', %w(missing), 'd')
+    thr.thread!
+    rootset = thr.order! { |c| c.sort_by!(&:mid) }
+    assert_equal %w(D c missing), rootset.map(&:mid)
+    assert_equal 'D', rootset[0].msg
+    assert_equal %w(b), rootset[1].children.map(&:mid)
+    out = ''.b
+    thr.walk_thread do |level, container, index|
+      msg = container.msg
+      summary = msg ? msg : "[missing: <#{container.mid}>]"
+      indent = '  ' * level
+      out << sprintf("#{indent} % 3d. %s\n", index, summary)
+    end
+    exp = <<EOF.b
+   0. D
+   1. c
+     0. B
+       0. abc
+   2. [missing: <missing>]
+     0. d
+EOF
+    assert_equal exp, out
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: msgthr
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- msgthr hackers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-08 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Pure Ruby message threading based on the algorithm described by
+  JWZ in <https://www.jwz.org/doc/threading.html> and used in
+  countless mail and news readers; but with some features removed
+  and improved flexibility:
+email: msgthr-public@80x24.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".olddoc.yml"
+- COPYING
+- GNUmakefile
+- README
+- lib/msgthr.rb
+- lib/msgthr/container.rb
+- msgthr.gemspec
+- test/test_msgthr.rb
+homepage: https://80x24.org/msgthr/
+licenses:
+- GPL-2.0+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: container-agnostic, non-recursive message threading
+test_files: []