rdf-sak 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22c5b1146b7e9f8a8faadf0879004710b851215b3cb2ec66e034a76176168eca
+  data.tar.gz: db752c349d0a7ef006f751237a3051a3a78f65346a503e671f737f5d34698ad7
+SHA512:
+  metadata.gz: 7e1a4253e9c51f61a7c5a12ab6967423aaaef3d2ec903cc52e816cadc0732fbffe6e4ac31cb2ebecdde0d77314fb489015f73da8e3f62aaf02c725f85ea752ff
+  data.tar.gz: 2b8a17e57555be58d93d7774daad0c020140e609f93d9b6180b567d647e650d443c48e54f0622eee73fab9683e0d9158ed866a44322d27548fc15abb2e96571e

data/.gitignore

@@ -0,0 +1,16 @@
+syntax: glob
+\#*\#
+.\#*
+._*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+sample.conf
+.byebug_history
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rdf-sak.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,268 @@
+# RDF::SAK — Swiss Army Knife for Semantic Web Content
+
+This library can be understood as something of a workbench for the
+development of a set of patterns and protocols for Web content—a
+[content management
+_meta-system_](https://doriantaylor.com/content-management-meta-system).
+The proximate goals of this implementation are as follows:
+
+* Durable addresses with fine-grained addressability of content,
+* Adherence to declarative content models mediated by open standards,
+* Easy content re-use, i.e., _transclusion_,
+* Rich embedded metadata for search, social media, and other purposes.
+
+`RDF::SAK` is also intended to serve as a substrate for:
+
+* The maturation of a [content inventory
+  ontology](https://privatealpha.com/ontology/content-inventory/1#),
+* The use of semantic metadata [for manipulating content
+  presentation](https://github.com/doriantaylor/rdfa-xslt),
+* Development of a deterministic, standards-compliant, [client-side
+  transclusion mechanism](https://github.com/doriantaylor/xslt-transclusion).
+ 
+Finally, this library is also intended to establish a set of hard
+requirements for the kind of RDF and Linked Data infrastructure that
+would be necessary to replicate its behaviour in a more comprehensive
+content management system.
+
+The only public website currently generated by `RDF::SAK` is [my own
+personal site](https://doriantaylor.com/), which I use as a test
+corpus. However, this library draws together a number of techniques
+which have been in use with employers and clients for well over a decade.
+
+## Future Directions
+
+Ultimately, this implementation is disposable. What matter are the
+patterns laid down in the program output. If these patterns can be
+sufficiently normalized, then the behaviour ought to at least be
+replicable in other content management systems. Failing that, the
+patterns will serve as a set of requirements for future systems. The
+ideal is that adherence to existing open standards plus a modest set
+of additional constraints could, at least from the perspective of the
+audience, make the CMS infrastructure disappear.
+
+As for the texture and topology of the content itself, squaring away
+the mundane problems of stable addressing, transclusion, and the
+product-agnostic separation of content from presentation, the emphasis
+on the _page_ as the basic unit of content can be subjected to further
+scrutiny. The long-term goal of this project is a structure with
+smaller nodes and many more links between them, something I am calling
+_dense hypermedia_.
+
+## How it Works
+
+Because the focus of `RDF::SAK` is a corpus of interrelated Web
+resources marked up just so, rather than presenting as an on-line Web
+application, it instead both consumes and emits a set of static
+files. It currently expects a directory of (X)HTML and/or Markdown as
+its document source, along with one or more serialized RDF graphs
+which house the metadata.
+
+### Inputs
+
+The files in the source tree can be named in any way, however, in the
+metadata, they are expected to be primarily associated with UUIDs,
+like the following (complete) entry:
+
+```turtle
+@prefix owl:  <http://www.w3.org/2002/07/owl#> .
+@prefix xsd:  <http://www.w3.org/2001/XMLSchema#> .
+@prefix xhv:  <http://www.w3.org/1999/xhtml/vocab#> .
+@prefix dct:  <http://purl.org/dc/terms/> .
+@prefix foaf: <http://xmlns.com/foaf/0.1/> .
+@prefix bibo: <http://purl.org/ontology/bibo/> .
+@prefix bs:   <http://purl.org/ontology/bibo/status/> .
+@prefix ci:   <https://privatealpha.com/ontology/content-inventory/1#> .
+
+<urn:uuid:b5c16511-6904-4130-b4e4-dd553f31bdd8>
+    dct:abstract "Yet another slapdash about-me page."@en ;
+    dct:created "2019-03-11T08:14:10+00:00"^^xsd:dateTime ;
+    dct:creator <urn:uuid:ca637d4b-c11b-4152-be98-bde602e7abd4> ;
+    dct:hasPart <https://www.youtube.com/embed/eV84dXJUvY8> ;
+    dct:modified "2019-05-17T05:08:42+00:00"^^xsd:dateTime,
+        "2019-05-17T18:37:37+00:00"^^xsd:dateTime ;
+    dct:references <urn:uuid:01a1ad7d-8af0-4ad7-a8ec-ffaaa06bb6f1>,
+        <urn:uuid:0d97c820-8929-42a1-8aca-f9e165d8085e>,
+        <urn:uuid:1ae2942f-4ba6-4552-818d-0e6b91a4abee>,
+        <urn:uuid:97bd312d-267d-433b-afc7-c0e9ab3311ed>,
+        <urn:uuid:99cc7d73-4779-4a7c-82de-b9f08af85cf8>,
+        <urn:uuid:a03bf9b5-56e6-42c7-bcd9-37ea6ad6a3d1>,
+        <urn:uuid:afe5a68a-a224-4be9-9fec-071ab55aa70d>,
+        <urn:uuid:d74d7e24-a6d6-4f49-94e8-e905d317c988>,
+        <urn:uuid:ef4587cd-d8c6-4b3d-aa01-d07ab49eda4f> ;
+    dct:replaces <urn:uuid:1944f86f-cafb-42f7-bca3-ad518f9b6ec7>,
+        <urn:uuid:d30a49d7-71ed-4355-bc44-4bbe3d90e000> ;
+    dct:title "Hello, Internet"@en ;
+    bibo:status bs:published ;
+    a bibo:Note ;
+    xhv:alternate <urn:uuid:4a13ab5a-67a5-4e1a-970f-3425df7035bb>,
+        <urn:uuid:c2f57107-9f79-4f13-a83c-4c73448c1c0b> ;
+    xhv:bookmark <urn:uuid:c2f57107-9f79-4f13-a83c-4c73448c1c0b> ;
+    xhv:index <urn:uuid:4a13ab5a-67a5-4e1a-970f-3425df7035bb> ;
+    xhv:meta <urn:uuid:47d52b80-50df-4ac4-a3f3-941c95c1aa14> ;
+    owl:sameAs <https://doriantaylor.com/breaking-my-silence-on-twitter>,
+        <https://doriantaylor.com/person/dorian-taylor>,
+        <https://doriantaylor.com/what-i-do>,
+        <https://doriantaylor.com/what-i-do-for-money> ;
+    foaf:depiction <https://doriantaylor.com/file/form-content-masked;desaturate;scale=800,700> ;
+    ci:canonical <https://doriantaylor.com/hello-internet> ;
+    ci:canonical-slug "hello-internet"^^xsd:token ;
+    ci:indexed false .
+```
+
+> Another program generates these entries from version-controlled
+> source trees. It was written over a decade ago in Python, intended
+> to handle the Mercurial version control system. Eventually it will
+> be switched to Git, rewritten in Ruby, and made part of `RDF::SAK`.
+
+### Outputs
+
+The library has methods to generate the following kinds of file:
+
+* (X)HTML documents, where file inputs are married with metadata
+* Special indexes, generated completely from metadata
+* Atom feeds, with various partitioning criteria
+* Google site maps,
+* Apache rewrite maps.
+
+All files are generated in the target directory as their canonical
+UUID and a representative extension,
+e.g. `b5c16511-6904-4130-b4e4-dd553f31bdd8.xml`. Human-readable URIs
+are then overlaid onto these canonical addresses using rewrite
+maps. This enables the system to retain a memory of address-to-UUID
+assignments over time, with the eventual goal to eliminate 404 errors.
+
+Documents themselves are traversed and embedded with metadata.
+Wherever possible, links are given titles and semantic relations, and
+a list of backlinks from all other resources is constructed. There are
+modules for generating various elements in the `<head>` to accommodate
+the various search and social media platforms. The strategy is to hold
+the master data in the most appropriate RDF vocabularies, and then
+subsequently map those properties to their proprietary counterparts,
+e.g., Facebook OGP, Schema.org (Google), and Twitter Cards.
+
+> The latter representations tend to cut corners with various
+> datatypes and properties; it's much easier to go from strict RDF to
+> a platform-specific schema than it is to go the other way around.
+
+#### Private content
+
+While a fine-grained access control subsystem is decidedly out of
+scope, `RDF::SAK` has a rudimentary concept of _private_ resources. A
+resource is assumed to be "private" unless its `bibo:status` is set to
+`bibo:status/published`. A document may therefore have both a public
+and private version, as the private version may have links to and from
+other documents which themselves are not published. Links to private
+documents get pruned from published ones, so as not to leak their
+existence.
+
+### Running
+
+I endeavour to create a command-line interface but the _library_
+interface is currently not stable enough to warrant it. The best way
+to use `RDF::SAK` for now is within an interactive `pry` session:
+
+```bash
+~$ cd rdf-sak
+~/rdf-sak$ pry -Ilib
+[1] pry(main)> require 'rdf/sak'
+=> true
+[2] pry(main)> ctx = RDF::SAK::Context.new config: '~/my.conf'
+=> <RDF::SAK::Context ...>
+[3] pry(main)> doc = ctx.visit 'some-uri'
+=> <RDF::SAK::Context::Document ...>
+[4] pry(main)> doc.write_to_target
+```
+
+A YAML configuration file can be supplied in lieu of individual
+parameters to the constructor:
+
+```yaml
+base: https://doriantaylor.com/
+graph: # RDF graphs
+  - ~/projects/active/doriantaylor.com/content-inventory.ttl
+  - ~/projects/active/doriantaylor.com/concept-scheme.ttl
+source: ~/projects/active/doriantaylor.com/source
+target: ~/projects/active/doriantaylor.com/target
+private: .private     # private content, relative to target
+transform: /transform # XSLT stylesheet attached to all documents
+```
+
+### Deployment
+
+Deploying the content can be done with `rsync`, although it requires
+certain configuration changes on the server in order to work properly.
+
+In Apache in particular, rewrite maps need to be defined in the main
+server configuration:
+
+```apache
+# one need not place these in the document root but it's handy for rsync
+RewriteEngine On
+RewriteMap rewrite  ${DOCUMENT_ROOT}/.rewrite.map
+RewriteMap redirect ${DOCUMENT_ROOT}/.redirect.map
+RewriteMap gone     ${DOCUMENT_ROOT}/.gone.map
+
+# then we just add something like this to prevent access to them
+<Files ".*.map">
+Require all denied
+</Files>
+```
+
+The rest of the configuration can go in an `.htaccess`:
+
+```apache
+# this redirects to canonical slugs
+RewriteCond "%{ENV:REDIRECT_SCRIPT_URL}" ^$
+RewriteCond %{REQUEST_URI} "^/*(.*?)(\.xml)?$"
+RewriteCond ${redirect:%1} ^.+$
+RewriteRule ^/*(.*?)(\.xml)?$ ${redirect:$1} [L,NS,R=308]
+
+# this takes care of terminated URIs
+RewriteCond %{REQUEST_URI} ^/*(.*?)(\..+?)?$
+RewriteCond ${gone:%1} ^.+$
+RewriteRule .* - [L,NS,G]
+
+# this internally rewrites slugs to UUIDs
+RewriteCond "%{ENV:REDIRECT_SCRIPT_URL}" ^$
+RewriteCond %{REQUEST_URI} ^/*(.*?)(\..+?)?$
+RewriteCond ${rewrite:%1} ^.+$
+RewriteRule ^/*(.*?)(\..+?)?$ /${rewrite:$1} [NS,PT]
+
+# we can do something perhaps more elaborate to route private content
+SetEnvIf Remote_Addr "31\.3\.3\.7" PRIVATE
+
+# this splices in the private content if it is present
+RewriteCond %{ENV:PRIVATE} !^$
+RewriteCond %{DOCUMENT_ROOT}/.private%{REQUEST_URI} -F
+RewriteRule ^/*(.*) /.private/$1 [NS,PT]
+```
+
+Configurations for other platforms can be figured out on request.
+
+## Documentation
+
+API documentation, for what it's worth at the moment, can be found [in
+the usual place](https://rubydoc.info/github/doriantaylor/rb-rdf-sak/master).
+
+## Installation
+
+For now I recommend just running the library out of its source tree:
+
+```bash
+~$ git clone git@github.com/doriantaylor/rb-rdf-sak.git
+~$ cd rb-rdf-sak
+~/rb-rdf-sak$ bundle install
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at
+[the GitHub repository](https://github.com/doriantaylor/rb-rdf-sak).
+
+## Copyright & License
+
+©2018 [Dorian Taylor](https://doriantaylor.com/)
+
+This software is provided under
+the [Apache License, 2.0](https://www.apache.org/licenses/LICENSE-2.0).