emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/triples 5e8abd2989 01/19: Initial commit of triples mod


From: ELPA Syncer
Subject: [elpa] externals/triples 5e8abd2989 01/19: Initial commit of triples module.
Date: Sat, 5 Nov 2022 11:58:15 -0400 (EDT)

branch: externals/triples
commit 5e8abd2989f4f9fb3e93e99269b95a51367e1e78
Author: Andrew Hyatt <ahyatt@gmail.com>
Commit: Andrew Hyatt <ahyatt@gmail.com>

    Initial commit of triples module.
---
 .gitignore      |   1 +
 COPYING         | 339 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.org      |  79 +++++++++++++
 triples-test.el | 193 ++++++++++++++++++++++++++++++++
 triples.el      | 330 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 942 insertions(+)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000..016d3b1692
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+*.elc
\ No newline at end of file
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000000..ecbc059373
--- /dev/null
+++ b/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.
\ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..214e4f663f
--- /dev/null
+++ b/README.org
@@ -0,0 +1,79 @@
+#+TITLE: Triples
+
+The =triples= module is a standard database module designed for use in other 
emacs modules.  It works with the =sqlite= module, and provides a simple way of 
storing entities and their associated schema.  The triples module is well 
suited to graph-like applications, where links between entities are important.  
The module has wrappers for most common operations, but it is anticipated that 
occasionally client modules would need to make their own =sqlite= calls.  Many 
database can be handled [...]
+
+* Maturity
+This module is very new should be considered alpha quality.
+
+While it has basic functionality, there are significant parts, such as a 
querying language, that are missing.  Whether anyone needs such parts will 
determine the priority in which they get built.
+
+* Types and Schema
+=triples= employs a design in which each entity can be a member of many 
/types/, and each /type/ has multiple /properties/.  The properties that a type 
has is defined by /schema/.  Let's take an example:
+
+#+begin_src emacs-lisp
+;; We assume a database called db has already been set up.
+(triples-add-schema db 'person
+       '(name :base/unique t :base/type string)
+       '(age :base/unique t :base/type integer))
+(triples-add-schema db 'employee
+       '(id :base/unique t :base/type integer)
+       '(manager :base/unique t)
+       '(reportees :base/virtual-reversed employee/manager))
+#+end_src
+
+This adds a type called =person=, which can be set on any entity.  There's 
another type called =employee=, which can also be set, independently of other 
types.  This schema is stored in the database itself, so the database can 
function properly regardless on what elisp has been loaded.  The schema can be 
redefined multiple times without any issues.
+
+The =person= has 2 properties, =name=, and =age=.  They are both marked as 
unique, so they take a single value, not a list.  If =:base/unique= was not 
true, the value would be a list.  We also specify what type it is, which can be 
any elisp type.  =employee= is similarly constructed, but has an interesting 
property, =reportees=, which is a =base/virtual-reversed= property, meaning 
that it is supplied with values, but rather can get them from the reversed 
relation of =employee/manager=.
+
+We'll explore how these types are used can be used in the section after next.
+* The triples concept
+A triple is a unit of data consisting of a /subject/, a /predicate/, an 
/object/, and, optionally, internal metadata about the unit.  The triple can be 
thought of as a link between the subject and object via the predicate.
+
+Let's say that, as in the example above, we want to store someone's name.  The 
triples would be a /subject/ that uniquely identifies the person, a /predicate/ 
that indicates the link between subject and object is about a name, and the 
object, which is the name value.
+
+The object can become the subject, and this explains how the 
=base/virtual-reversed= predicate works.   If Bob is the manager of Alice, then 
there could be a triple with Alice as the subject, =manager= as the predicate, 
and Bob as the object.  But we can also find the reversed links, and ask who 
all are all the people that Bob manages.  In this case, Bob is the subject, and 
Alice is the object.  However, we don't actually need to store this information 
and try to keep it in sync, we can  [...]
+* Setting and retrieving
+A subject can be set all at once (everything about the subject), or dealt with 
per-type.  For example, the following are equivalent:
+
+#+begin_src emacs-lisp
+(triples-delete-subject db "alice")
+(triples-set-type db "alice" 'person :name "Alice Aardvark" :age 41)
+(triples-set-type db "alice" 'employee :id 1901 :manager "bob")
+#+end_src
+
+#+begin_src emacs-lisp
+(triples-set-subject db "alice" '(person :name "Alice Aardvark" :age 41)
+                     '(employee :id 1901 :manager "bob"))
+#+end_src
+
+In the second, the setting of the entire subject implies deleting everything 
previously associated with it.
+
+Here is how the data is retrieved:
+
+#+begin_src emacs-lisp
+(triples-get-subject db "alice")
+#+end_src
+Which returns, assuming we have "catherine" and "dennis" who have "alice" as 
their =employee/manager=: 
+#+begin_src emacs-lisp
+'(:person/name "Alice Aardvark" :person/age 41 :employee/id 1901 
:employee/manager "bob" :employee/reportees '("catherine" "dennis"))
+#+end_src
+
+Or,
+#+begin_src emacs-lisp
+(triples-get-type db "alice" 'employee)
+#+end_src
+Which returns
+#+begin_src emacs-lisp
+'(:manager "bob" :reportees '("catherine" "dennis"))
+#+end_src
+
+There are other useful functions, including:
+- =triples-get-types=, which gets all the types a subject has,
+- =triples-delete-subject=, which deletes all data associated with a subject,
+- =triples-with-predicate=, gets all triples that is about a specific property,
+- =triples-with-predicate-object=, get all subjects whose predicate is equal 
to /object/,
+- =triples-subjects-of-type=, get all subjects which have a particular type.
+* Preciate, with type and without
+Sometimes the triples library will require predicates that are without type, 
and sometimes with type, or "combined predicates".  The rule is that if the 
type is already specified in the function, it does not need to be respecified.  
If the type is not specified, it is included in the combined predicate.
+
+When returning data, if data is from just one type, the type is not returned 
in the returned predicates.  If the data is from multiple types, the type is 
returned as combined predicates.
diff --git a/triples-test.el b/triples-test.el
new file mode 100644
index 0000000000..9689a9e65e
--- /dev/null
+++ b/triples-test.el
@@ -0,0 +1,193 @@
+;;; triples-test.el --- Tests for triples module.
+(require 'triples)
+(require 'seq)
+
+;;; Code:
+
+(defvar triples-test-db-file nil
+  "The database file used in a test. This is defined so we can
+easily debug into it.")
+
+(defmacro triples-test-with-temp-db (&rest body)
+  (declare (indent 0) (debug t))
+  `(let ((db-file (make-temp-file "triples-test")))
+     (unwind-protect
+         (progn 
+           (let ((db (triples-connect db-file)))
+             (setq triples-test-db-file db-file)
+             ,@body))
+       (delete-file db-file))))
+
+(defun triples-test-connect-db ()
+  (interactive)
+  (defvar sql-database)
+  (let ((sql-database triples-test-db-file))
+    (sql-sqlite (format "*schema test db SQL %s*" triples-test-db-file))))
+
+(defun triples-test-op-equals (result target)
+  (and (equal (car result) (car target))
+       (seq-set-equal-p (cdr result) (cdr target) #'equal)))
+
+(ert-deftest triples-add-schema-op ()
+  (should (triples-test-op-equals
+           (triples--add-schema-op
+            'named
+            '(name :base/unique t)
+            '(locale :base/unique t)
+            'alternate-names
+            '(nicknames :base/unique nil))
+           '(replace-subject
+             .
+             ((named base/type schema)
+              (named schema/property name)
+              (named/name base/unique t)
+              (named schema/property locale)
+              (named/locale base/unique t)
+              (named schema/property alternate-names)
+              (named schema/property nicknames))))))
+
+(ert-deftest triples-schema-crud ()
+  (triples-test-with-temp-db
+    (triples-add-schema db 'named
+                        '(name :base/unique t) 'alternate-names)
+    (should (equal '(:base/unique t)
+           (triples-properties-for-predicate db 'named/name)))
+    (should (equal
+             '(name alternate-names)
+             (triples-predicates-for-type db 'named)))))
+
+(ert-deftest triples-properties-for-predicate ()
+  (triples-test-with-temp-db
+    (triples-add-schema db 'named
+                        '(name :base/unique t)
+                        'alternate-names)
+    (should (equal '(:base/unique t)
+                    (triples-properties-for-predicate db 'named/name)))
+    (should-not (triples-properties-for-predicate db 'foo/bar))))
+
+(ert-deftest triples-set-type ()
+  (should (triples-test-op-equals
+           (triples--set-type-op "Bert" 'named
+                                 '(:name "Bertholomew The Second"
+                                         :alias ("Bert" "Berty")))
+           '(replace-subject-type
+             .
+             (("Bert" base/type named)
+              ("Bert" named/name "Bertholomew The Second")
+              ("Bert" named/alias "Bert" (:index 0))
+              ("Bert" named/alias "Berty" (:index 1)))))))
+
+(ert-deftest triples-schema-compliant ()
+  (triples-test-with-temp-db
+    (triples-add-schema db 'named
+                        '(name :base/unique t :base/type string)
+                        'alternate-names)
+    (triples-set-type db "foo" 'named :name "name")
+    (should (triples-verify-schema-compliant db '(("foo" named/name "bar"))))
+    (should-error (triples-verify-schema-compliant db '(("foo" named/name 5))))
+    (should-error (triples-verify-schema-compliant db '(("foo" named/name 
"bar" (:index 0)))))
+    (should (triples-verify-schema-compliant db '(("foo" named/alternate-names 
"bar" (:index 0)))))))
+
+(ert-deftest triples-crud ()
+  (triples-test-with-temp-db
+   (triples-add-schema db 'named
+                       '(name :unique t)
+                       'alias)
+   (triples-set-type db "foo" 'named :name "Name" :alias '("alias1" "alias2"))
+   (should (equal '(:name "Name" :alias ("alias1" "alias2"))
+                  (triples-get-type db "foo" 'named)))
+   (should (equal (triples-get-types db "foo") '(named)))
+   (should-not (triples-get-type db "bar" 'named))
+   (should-not (triples-get-types db "bar"))
+   (should (equal '(named) (triples-get-types db "foo")))
+   (triples-remove-type db "foo" 'named)
+   (should-not (triples-get-types db "foo"))))
+
+(ert-deftest triples-crud-all ()
+  (triples-test-with-temp-db
+    (triples-add-schema db 'named
+                        '(name :unique t))
+    (triples-add-schema db 'positioned '(position :unique t))
+    (should-not (triples-get-subject db "foo"))
+    (triples-set-subject db "foo"
+                         '(named :name "bar")
+                         '(positioned :position "right behind you"))
+    (should (equal '(:named/name "bar" :positioned/position "right behind you")
+                   (triples-get-subject db "foo")))
+    (triples-delete-subject db "foo")
+    (should-not (triples-get-subject db "foo"))))
+
+(ert-deftest triples-reversed ()
+  (triples-test-with-temp-db
+   (triples-add-schema db 'named
+                       '(name :unique t)
+                       '(locale :unique t))
+   (triples-add-schema db 'locale
+                       '(used-in-name :base/virtual-reversed named/locale))
+   (triples-set-type db "en/US" 'locale nil)
+   (should-not (triples-get-type db "en/US" 'locale))
+   (triples-set-type db "foo" 'named :name "foo" :locale "en/US")
+   (should (equal '(:used-in-name ("foo"))
+                  (triples-get-type db "en/US" 'locale)))
+   (should-error (triples-set-type db "en/US" 'locale :used-in-name 
'("bar")))))
+
+(ert-deftest triples-with-preciate-object ()
+  (triples-test-with-temp-db
+   (triples-add-schema db 'named '(name))
+   (should-not (triples-search db 'named/name "Fred"))
+   (triples-set-type db "foo" 'named :name "My Name Is Fred Foo")
+   (triples-set-type db "bar" 'named :name "My Name Is Betty Bar")
+   (should (equal
+            '(("foo" named/name "My Name Is Fred Foo" nil))
+            (triples-search db 'named/name "Fred")))))
+
+(ert-deftest triples-with-predicate ()
+  (triples-test-with-temp-db
+   (triples-add-schema db 'named '(name))
+   (should-not (triples-with-predicate db :named/name))
+   (triples-set-type db "foo" 'named :name "My Name Is Fred Foo")
+   (triples-set-type db "bar" 'named :name "My Name Is Betty Bar")
+   (should (equal
+            '(("bar" named/name "My Name Is Betty Bar" nil)
+              ("foo" named/name "My Name Is Fred Foo" nil))
+            (sort (triples-with-predicate db :named/name)
+                  (lambda (a b)
+                    (string< (car a) (car b))))))))
+
+(ert-deftest triples-subjects-of-type ()
+  (triples-test-with-temp-db
+   (triples-add-schema db 'named '(name))
+   (should-not (triples-subjects-of-type db 'named))
+   (triples-set-type db "foo" 'named :name "My Name Is Fred Foo")
+   (triples-set-type db "bar" 'named :name "My Name Is Betty Bar")
+   (should (seq-set-equal-p '("foo" "bar")
+                            (triples-subjects-of-type db 'named)))))
+
+(ert-deftest triples-readme ()
+  (triples-test-with-temp-db
+   (triples-add-schema db 'person
+       '(name :base/unique t :base/type string)
+       '(age :base/unique t :base/type integer))
+   (triples-add-schema db 'employee
+       '(id :base/unique t :base/type integer)
+       '(manager :base/unique t)
+       '(reportees :base/virtual-reversed employee/manager))
+   ;; Set up catherine and dennis
+  (triples-set-type db "catherine" 'employee :manager "alice")
+  (triples-set-type db "dennis" 'employee :manager "alice")
+  (triples-delete-subject db "alice")
+  (triples-set-type db "alice" 'person :name "Alice Aardvark" :age 41)
+  (triples-set-type db "alice" 'employee :id 1901 :manager "bob")
+  (should (equal (triples-get-subject db "alice")
+                 '(:person/name "Alice Aardvark" :person/age 41 :employee/id 
1901
+                                :employee/manager "bob" :employee/reportees 
("catherine" "dennis"))))
+  (triples-set-subject db "alice" '(person :name "Alice Aardvark" :age 41)
+                       '(employee :id 1901 :manager "bob"))
+  (should (equal (triples-get-subject db "alice")
+                 '(:person/name "Alice Aardvark" :person/age 41 :employee/id 
1901
+                                :employee/manager "bob" :employee/reportees 
("catherine" "dennis"))))))
+
+
+(provide 'triples-test)
+
+;;; triples-test.el ends here
diff --git a/triples.el b/triples.el
new file mode 100644
index 0000000000..e8c95dd75e
--- /dev/null
+++ b/triples.el
@@ -0,0 +1,330 @@
+;;; triples.el --- This package provides a triple-based database, as well as
+;;; functions to store, retrieve, and modify the information it contains.
+
+;; Copyright (c) 2022  Free Software Foundation, Inc.
+
+;; Author: Andrew Hyatt <ahyatt@gmail.com>
+;; Homepage: https://github.com/ahyatt/triples
+;; Keywords: triples, kg
+;; Version: 0.0
+;; 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 GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;; Triples is a library implementing a data storage based on the idea of
+;; triples: subject, predicate, objects, plus some extra metadata. This data
+;; structure provides a way to store data according to an extensible schema, 
and
+;; provide an API offering two-way links between all information stored.
+
+(require 'cl-macs)
+(require 'emacsql)
+(require 'seq)
+
+(defun triples-connect (file)
+  "Connect to the database and make sure it is populated."
+  (let* ((db (emacsql-sqlite3 file))
+         (triple-table-exists
+          (emacsql db [:select name
+                       :from sqlite_master
+                       :where (= type table) :and (= name 'triples)])))
+    (unless triple-table-exists
+      (emacsql db [:create-table triples ([(subject text :not-null)
+                                               (predicate text :not-null)
+                                               (object :not-null)
+                                               (properties)])])
+      (emacsql db [:create-index subject_idx :on triples [subject]])
+      (emacsql db [:create-index subject_predicate_idx :on triples [subject 
predicate]])
+      (emacsql db [:create-index predicate_object_idx :on triples [predicate 
object]]))
+    db))
+
+(defun triples--ensure-property-val (vec)
+  "Return a VEC has 4 elements."
+  (if (= (length vec) 4)
+      vec
+    (vconcat vec '(nil))))
+
+(defun triples--subjects (triples)
+  "Return all unique subjects in TRIPLES."
+  (seq-uniq (mapcar #'car triples)))
+
+(defun triples--group-by-subjects (triples)
+  "Return an alist of subject to TRIPLES with that subject."
+  (let ((subj-to-triples (make-hash-table :test #'equal)))
+    (dolist (triple triples)
+      (puthash (car triple)
+               (cons triple (gethash (car triple) subj-to-triples))
+               subj-to-triples))
+    (cl-loop for k being the hash-keys of subj-to-triples using (hash-values v)
+             collect (cons k v))))
+
+(defun triples--decolon (sym)
+  "Remove colon from SYM."
+  (intern (string-replace ":" "" (format "%s" sym))))
+
+(defun triples--encolon (sym)
+  "Add a colon to SYM."
+  (intern (format ":%s" sym)))
+
+(defun triples--add (db op)
+  "Perform OP on DB."
+  (pcase (car op)
+      ('replace-subject
+       (mapc
+        (lambda (sub)
+          (emacsql db [:delete :from triples :where (= subject $s1)] sub))
+        (triples--subjects (cdr op))))
+      ('replace-subject-type
+       (mapc (lambda (sub-triples)
+               (mapc (lambda (type)
+                       ;; We have to ignore base, which keeps type information 
in general.
+                       (unless (eq type 'base)
+                         (emacsql db [:delete :from triples :where (= subject 
$s1)
+                                      :and (like predicate $r2)]
+                                  (car sub-triples) (format "%s/%%" type))))
+                     (seq-uniq
+                      (mapcar #'car (mapcar 
#'triples--combined-to-type-and-prop
+                                                     (mapcar #'cl-second (cdr 
sub-triples)))))))
+             (triples--group-by-subjects (cdr op)))))
+    (mapc (lambda (triple)
+            (emacsql db [:insert :into triples
+                         :values $v1] (triples--ensure-property-val
+                                       (apply #'vector triple))))
+          (cdr op)))
+
+(defun triples-properties-for-predicate (db cpred)
+  "Return the properties for combined predicate CPRED as a plist."
+  (mapcan (lambda (row)
+            (list (intern (format ":%s" (nth 1 row))) (nth 2 row)))
+          (emacsql db [:select * :from triples :where (= subject $s1)] cpred)))
+
+(defun triples-predicates-for-type (db type)
+  "Return all predicates defined for TYPE in DB."
+  (mapcar #'car
+          (emacsql db [:select object :from triples :where (= subject $s1)
+                       :and (= predicate 'schema/property)] type)))
+
+(defun triples-verify-schema-compliant (db triples)
+  "Error if TRIPLES is not compliant with schema in DB."
+  (mapc (lambda (triple)
+          (pcase-let ((`(,type . ,prop) (triples--combined-to-type-and-prop 
(nth 1 triple))))
+            (unless (or (eq type 'base) 
+                        (emacsql db [:select * :from triples :where (= subject 
$s1)
+                                     :and (= predicate 'schema/property) :and 
(= object $s2)]
+                                 type prop))
+              (error "Property %s not found in schema." (nth 1 triple)))))
+        triples)
+  (mapc (lambda (triple)
+          (triples--plist-mapc (lambda (pred-prop val)
+                                 (let ((f (intern (format 
"triples-verify-%s-compliant"
+                                                          (triples--decolon 
pred-prop)))))
+                                 (if (fboundp f)
+                                     (funcall f val triple))))
+                             (triples-properties-for-predicate db (nth 1 
triple)))) triples))
+
+(defun triples-add-schema (db type &rest props)
+  "Add schema for TYPE and its PROPS to DB."
+  (triples--add db (apply #'triples--add-schema-op type props)))
+
+(defun triples--add-schema-op (type &rest props)
+  "Return the operation store schema for TYPE, with PROPS.
+PROPS is a list of either property symbols, or lists of
+properties of the type and the meta-properties associated with
+them."
+  (cons 'replace-subject
+        (cons `(,type base/type schema)
+              (cl-loop for p in props
+                       nconc
+                       (let* ((pname (if (symbolp p) p (car p)))
+                              (pprops (when (listp p) (cdr p)))
+                              (pcombined (intern (format "%s/%s" type pname))))
+                         (cons (list type 'schema/property pname)
+                               (seq-filter #'identity
+                                (triples--plist-mapcar
+                                   (lambda (k v)
+                                     ;; If V is nil, that's the default, so 
don't
+                                     ;; store anything.
+                                     (when v
+                                       (list pcombined (triples--decolon k) 
v)))
+                                   pprops))))))))
+
+(defun triples-set-type (db subject type &rest properties)
+  "Create operation to replace PROPERTIES for TYPE for SUBJECT in DB.
+PROPERTIES is a plist of properties, without TYPE prefixes."
+  (let ((op (triples--set-type-op subject type properties)))
+    (triples-verify-schema-compliant db (cdr op))
+    (triples--add db op)))
+
+(defun triples--set-type-op (subject type properties)
+  "Create operation to replace PROPERTIES for TYPE for SUBJECT.
+PROPERTIES is a plist of properties, without TYPE prefixes."
+  (cons 'replace-subject-type
+        (cons (list subject 'base/type type)
+              (triples--plist-mapcan
+               (lambda (prop v)
+                 (if (listp v)
+                     (cl-loop for e in v for i from 0
+                              collect
+                              (list subject
+                                    (triples--type-and-prop-to-combined type 
prop)
+                                    e
+                                    (list :index i)))
+                   (list (list subject (triples--type-and-prop-to-combined 
type prop) v))))
+               properties))))
+
+(defun triples-get-type (db subject type)
+  "From DB get data associated with TYPE for SUBJECT."
+  (let ((preds (make-hash-table :test #'equal)))
+    (mapc (lambda (db-triple)
+            (puthash (nth 1 db-triple)
+                     (cons (cons (nth 2 db-triple) (nth 3 db-triple))
+                           (gethash (nth 1 db-triple) preds))
+                     preds)) 
+          (emacsql db [:select * :from triples :where (= subject $s1)
+                       :and (like predicate $r2)] subject (format "%s/%%" 
type)))
+    (append
+     (cl-loop for k being the hash-keys of preds using (hash-values v)
+              nconc (list (triples--encolon (cdr 
(triples--combined-to-type-and-prop k)))
+                          (if (and (cdr v)
+                                   (plist-get (cdar v) :index))
+                              (mapcar #'car (sort v (lambda (a b)
+                                                      (< (plist-get (cdr a) 
:index)
+                                                         (plist-get (cdr b) 
:index)))))
+                            (caar v))))
+     (cl-loop for pred in (triples-predicates-for-type db type)
+              nconc
+              (let ((reversed-prop (plist-get
+                                    (triples-properties-for-predicate
+                                     db (triples--type-and-prop-to-combined 
type pred))
+                                    :base/virtual-reversed)))
+                (when reversed-prop
+                  (let ((result (emacsql db [:select subject :from triples 
:where (= object $s1)
+                                             :and (= predicate $s2)] subject 
reversed-prop)))
+                    (when result (cons (triples--encolon pred) (list (mapcar 
#'car result)))))))))))
+
+(defun triples-remove-type (db subject type)
+  "Remove TYPE for SUBJECT in DB, and all associated data."
+  (emacsql-with-transaction db
+    (emacsql db [:delete :from triples :where (= subject $s1)
+                 :and (= predicate 'base/type)] subject)
+    (emacsql db [:delete :from triples :where (= subject $s1)
+                 :and (like $r2)] subject (format "%s/%%" type))))
+
+(defun triples-get-types (db subject)
+  "From DB, get all types for SUBJECT."
+  (mapcar #'car (emacsql db [:select object :from triples :where (= subject 
$s1)
+                             :and (= predicate 'base/type)]
+                         subject)))
+
+(defun triples-get-subject (db subject)
+  "From DB return all properties for SUBJECT as a single plist."
+  (mapcan (lambda (type)
+            (triples--plist-mapcan
+             (lambda (k v)
+               (list (intern (format ":%s/%s" type (triples--decolon k))) v))
+             (triples-get-type db subject type)))
+          (triples-get-types db subject)))
+
+(defun triples-set-subject (db subject &rest type-vals-cons)
+  "From DB set properties of SUBJECT to TYPE-VALS-CONS data.
+TYPE-VALS-CONS is a list of conses, combining a type and a plist of values."
+  (emacsql-with-transaction db
+    (triples-delete-subject db subject)
+    (mapc (lambda (cons)
+            (apply #'triples-set-type db subject cons))
+          type-vals-cons)))
+
+(defun triples-delete-subject (db subject)
+  "Delete all data with DB as the subject."
+  (emacsql-with-transaction db
+    (emacsql db [:delete :from triples :where (= subject $s1)] subject)))
+
+(defun triples-search (db cpred text)
+  "Search DB for instances of combined property CPRED with TEXT."
+  (emacsql db [:select * :from triples :where (= predicate $i1)
+               :and (like object $r2)] (triples--decolon cpred)
+                       (format "%%%s%%" text)))
+
+(defun triples-with-predicate (db cpred)
+  "Return all triples in DB with CPRED as its combined predicate."
+  (emacsql db [:select * :from triples :where (= predicate $i1)] 
(triples--decolon cpred)))
+
+(defun triples-subjects-with-predicate-object (db cpred obj)
+  "Return all subjects in DB with CPRED equal to OBJ."
+  (emacsql db [:select subject :from triples :where (= predicate $i1) :and (= 
object $s2)]
+           (triples--decolon cpred) obj))
+
+(defun triples-subjects-of-type (db type)
+  "Return a list of all subjects with a particular TYPE in DB."
+  (mapcar #'car (triples-subjects-with-predicate-object db 'base/type type)))
+
+(defun triples--combined-to-type-and-prop (combined)
+  "Return cons of type and prop that form the COMBINED normal representation.
+This is something of form `:type/prop'."
+  (let ((s (split-string (format "%s" combined) "/")))
+    (cons (triples--decolon (nth 0 s)) (intern (nth 1 s)))))
+
+(defun triples--type-and-prop-to-combined (type prop)
+  (intern (format "%s/%s" (triples--decolon type) (triples--decolon prop))))
+
+(defun triples--plist-mapc (fn plist)
+  "Map FN over PLIST, for only side effects.
+FN must take two arguments: the key and the value."
+  (let ((plist-index plist))
+    (while plist-index
+      (let ((key (pop plist-index)))
+        (funcall fn key (pop plist-index))))))
+
+(defun triples--plist-mapcar (fn plist)
+  "Map FN over PLIST, returning an element for every property.
+FN must take two arguments: the key and the value."
+  (let ((plist-index plist)
+        (result))
+    (while plist-index
+      (let ((key (pop plist-index)))
+        (push (funcall fn key (pop plist-index)) result)))
+    (nreverse result)))
+
+(defun triples--plist-mapcan (fn plist)
+  "Map FN over PLIST, nconcing elements together.
+FN must take two arguments: the key and the value."
+  (let ((plist-index plist)
+        (result))
+    (while plist-index
+      (let ((key (pop plist-index)))
+        (setq result (nconc result (funcall fn key (pop plist-index))))))
+    result))
+
+;; Standard properties
+
+(defun triples-verify-base/unique-compliant (uniquep triple)
+  "Verify that TRIPLE has an index or not, based on UNIQUEP."
+  (if uniquep
+      (when (member :index (nth 3 triple))
+        (error "Invalid triple found: %s, violates base/unique, should be just 
one value" triple))
+    (unless (member :index (nth 3 triple))
+      (error "Invalid triple found: %s, violates base/unique, should be a list 
of values" triple))))
+
+(defun triples-verify-base/type-compliant (type triple)
+  "Verify that TRIPLE's object is of TYPE."
+  (unless (eq (type-of (nth 2 triple)) type)
+    (error "Triple %s has an object with the wrong type: expected type of %s 
but was %s"
+           triple type (type-of (nth 2 triple)))))
+
+(defun triples-verify-base/virtual-reversed-compliant (_ triple)
+  "Virtual reversed properties shouldn't be set manually, so are never 
compliant."
+  (error "Invalid triple found: %s, should not be setting a 
`base/virtual-reversed' property."
+         triple))
+
+(provide 'triples)
+
+;;; triples.el ends here



reply via email to

[Prev in Thread] Current Thread [Next in Thread]