Merge pull request #1012 from sul-dlss/simpler-meta-format

Simpler meta format

README.md

@@ -65,8 +65,11 @@ The RuboCop style enforcement can be run without running the tests
 
 Deployment is handled automatically via Jenkins when a release is published to GitHub.
 
+## Data
+Purl data is stored in a pair-tree structure starting at `Settings.document_cache_root`.  In each pair-tree is a file called `cocina.json` which is the public representation of the current version of the object.  There is also a `meta.json` file that holds information about where this object is released to.  The `meta.json` is not versionable data.  Additionally there is an XML file called `public` which has a representation of the object that was derived from `cocina.json`.
+
 ## Search engine indexing
 
-Only items with "PURL sitemap" release tag are included in the sitemap and all other items have a "noindex" meta tag.
+Only items with "PURL sitemap" release tag (in `meta.json`) are included in the sitemap and all other items have a "noindex" meta tag.
 
-Structured metadata in the form of schema.org markup is generated to enhance discoverability of datasets and videos. [More info about schema.org markup](https://docs.google.com/document/d/1BO10k_zSTqqT1YmlCg5oE4tOsGXiqmHzQyb6itZypwo). 
+Structured metadata in the form of schema.org markup is generated to enhance discoverability of datasets and videos. [More info about schema.org markup](https://docs.google.com/document/d/1BO10k_zSTqqT1YmlCg5oE4tOsGXiqmHzQyb6itZypwo).

app/models/purl_resource.rb

@@ -78,14 +78,23 @@ def containing_purl_collections
 
   # Can be crawled / indexed by a crawler, e.g. Googlebot
   def crawlable?
+    return meta_json['sitemap'] if meta_json.key?('sitemap')
+
+    # This is for handling the older format of meta.json
     true_targets.include?('PURL sitemap')
   end
 
   def released_to_searchworks?
+    return meta_json['searchworks'] if meta_json.key?('searchworks')
+
+    # This is for handling the older format of meta.json
     true_targets.include?('Searchworks')
   end
 
   def released_to_earthworks?
+    return meta_json['earthworks'] if meta_json.key?('earthworks')
+
+    # This is for handling the older format of meta.json
     true_targets.include?('Earthworks')
   end
 

spec/fixtures/document_cache/bb/000/br/0025/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/bb/051/dp/0564/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/bb/157/hs/6068/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/bb/631/ry/3167/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/bb/737/zp/0787/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/bd/786/fy/6312/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/bh/502/xm/3351/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/cd/027/gx/5097/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/cp/088/pb/1682/meta.json

@@ -1 +1 @@
-{ "true_targets": ["Searchworks"] }
+{ "searchworks": true, "earthworks": false, "sitemap": true }

spec/fixtures/document_cache/cz/128/vq/0535/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/gx/074/xz/5520/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/nd/387/jf/5675/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/py/305/sy/7961/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/qf/794/pv/6287/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/rs/276/tc/2764/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/ss/099/gb/5528/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/tx/027/jv/4938/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/wm/135/gp/2721/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/wp/335/yr/5649/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/document_cache/yk/677/wc/8843/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/bb/000/br/0025/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/bb/051/dp/0564/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/bb/157/hs/6068/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/bb/631/ry/3167/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/bb/737/zp/0787/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/bd/786/fy/6312/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/bh/502/xm/3351/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/cd/027/gx/5097/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/cp/088/pb/1682/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": ["Searchworks"] }
+{ "searchworks": true, "earthworks": false, "sitemap": true }

spec/fixtures/ocfl/cz/128/vq/0535/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/gx/074/xz/5520/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/nd/387/jf/5675/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/py/305/sy/7961/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/qf/794/pv/6287/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/rs/276/tc/2764/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/ss/099/gb/5528/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/tx/027/jv/4938/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/wm/135/gp/2721/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/wp/335/yr/5649/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }

spec/fixtures/ocfl/yk/677/wc/8843/extensions/sidecar-metadata/meta.json

@@ -1 +1 @@
-{ "true_targets": [] }
+{ "searchworks": false, "earthworks": false, "sitemap": false }