atlas_rb 1.29.1 → 1.29.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66d1cdefb1c1d3935fa8cd3721438b8b81b3bd89509317a11beefac39b55c9c9
-  data.tar.gz: d8b9bcea27ca0cb9ed3a40b64b31a944c0e6c22ba82aca5f32aa8f293cd16e6a
+  metadata.gz: db0cdca29eb7e27fab3995adff0e6f7b33aba897aa46fd164c2f11de02eb2d96
+  data.tar.gz: 3f2b9746c5f4384dd3e9cacc8d50eed2d1d2c60ea92c3cf2130142b2d48c6bf2
 SHA512:
-  metadata.gz: 4bf52d38cef2068881ee863d6f41fcd0d0149eab2714c1cec8d942f0f3f2ef422faeb52b92528579820e88149a5bf9613739e65091f9727df8f1151cdefd543f
-  data.tar.gz: dd88d74e36f72f186cbb5a0473b046cef6266b2fb5b45b48b2101db77e643df3d33cefa61048390134962fbbfadf537cb26759d964b1bbd9bf7ee97f84205721
+  metadata.gz: 649e9ccbd07ca7bfa9bd507aeea9e0973edc1f524bf00cae8b1dd6d00464cc2ce71dfd761121ee1aae7321be80e5b6e35534e8eabf0251e5738303e1c29ec481
+  data.tar.gz: d765582a2a7c0fbf187b45019c3934c2215aeac396fe568b5bd56b509d89694dd75eda0a46849b84ba6434e4863ba8a2b0bcfa24e95b4421a1016af85bc3f113

data/.version

@@ -1 +1 @@
-1.29.1
+1.29.2

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.29.2
+
+### Changed — `TombstonedError#work_retracted?` is now `work_suppressed?`
+
+"Suppressed" is the staff-facing name for a tombstone, the term library
+catalogues use for a reversible removal. The method is renamed with no alias,
+so a caller of `work_retracted?` must switch to `work_suppressed?`. The YARD
+text that called a tombstoned Work "retracted" says "suppressed" too.
+`Work.disassociate` keeps "retract": withdrawing a relationship claim is
+not a suppression.
+
 ## 1.29.1
 
 Needs an Atlas that withholds the files beneath a tombstone (0.6.245 or later).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    atlas_rb (1.29.1)
+    atlas_rb (1.29.2)
       faraday (~> 2.7)
       faraday-follow_redirects (~> 0.3.0)
       faraday-multipart (~> 1)

data/README.md

@@ -757,7 +757,7 @@ begin
   AtlasRb::Blob.content(blob_id) { |chunk| response.stream.write(chunk) }
 rescue AtlasRb::TombstonedError => e
   e.tombstoned_resource_type  # => "FileSet" (one file removed) or "Work"
-  e.work_retracted?           # => true when the whole Work is tombstoned
+  e.work_suppressed?          # => true when the whole Work is tombstoned
 end
 ```
 

data/lib/atlas_rb/blob.rb

@@ -32,7 +32,7 @@ module AtlasRb
     #
     #   `"tombstoned_in_effect"` is true when the Blob, its FileSet or its Work
     #   is tombstoned, and `"tombstoned_resource_type"` says which (`"FileSet"`
-    #   for a removed file, `"Work"` for a retracted Work). Atlas answers such a
+    #   for a removed file, `"Work"` for a suppressed Work). Atlas answers such a
     #   Blob `410` with this body, which is returned, so a host can refuse a
     #   download before it calls {.content}. Atlas 0.6.245 or later.
     # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410` (e.g. an

data/lib/atlas_rb/errors.rb

@@ -384,11 +384,11 @@ module AtlasRb
   # A tombstone does not cascade, so the resource that carries it can be an
   # ancestor of the one requested. A Blob is withheld when its FileSet is
   # tombstoned (one file removed) or when its Work is (the whole Work
-  # retracted). {#tombstoned_resource_type} tells the two apart, so a host can
+  # suppressed). {#tombstoned_resource_type} tells the two apart, so a host can
   # show "file not found" for the first and its "Removed" page for the second.
   #
   #   rescue AtlasRb::TombstonedError => e
-  #     e.work_retracted? ? render("errors/gone", status: :gone) : head(:not_found)
+  #     e.work_suppressed? ? render("errors/gone", status: :gone) : head(:not_found)
   #
   # Admins and the devolved-admin tier are still served, so they never see
   # this. A `410` from a single-resource read such as {Work.find} is not this:
@@ -418,7 +418,7 @@ module AtlasRb
     end
 
     # @return [Boolean] true when the whole Work is tombstoned.
-    def work_retracted?
+    def work_suppressed?
       tombstoned_resource_type == "Work"
     end
 

data/lib/atlas_rb/resource_writes.rb

@@ -200,7 +200,7 @@ module AtlasRb
     # Restore is the operator's counterpart and lives in
     # {AtlasRb::Admin::Resource}, where the namespace is the marker.
     #
-    # Tombstone a resource: retract it from discovery, reversibly.
+    # Tombstone a resource: suppress it from discovery, reversibly.
     #
     # Returns the **raw response** rather than raising, because Atlas refuses a
     # container that still holds live children with a `422` carrying

data/lib/atlas_rb/work.rb

@@ -468,7 +468,7 @@ module AtlasRb
     #   misconfigured `ATLAS_URL`, the route is not Atlas's at all.
     # @raise [AtlasRb::TombstonedError] when the Work is tombstoned and the
     #   caller is below the admin and devolved-admin tiers (Atlas 0.6.245 or
-    #   later), so a retracted Work's files are never listed.
+    #   later), so a suppressed Work's files are never listed.
     # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410`
     #   (an auth or validation envelope, a `5xx`, a proxy's `503`), carrying
     #   Atlas's status and body so the failure is attributable at the boundary.
@@ -548,7 +548,7 @@ module AtlasRb
     #   `ATLAS_URL`, the route is not Atlas's at all.
     # @raise [AtlasRb::TombstonedError] when the Work is tombstoned and the
     #   caller is below the admin and devolved-admin tiers (Atlas 0.6.245 or
-    #   later), so a retracted Work's files are never listed.
+    #   later), so a suppressed Work's files are never listed.
     # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410`
     #   (a `403` for a caller who cannot read the Work, a `5xx`, a proxy's
     #   `503`), carrying Atlas's status and body so the failure is attributable
@@ -633,7 +633,7 @@ module AtlasRb
     #   misconfigured `ATLAS_URL`, the route is not Atlas's at all.
     # @raise [AtlasRb::TombstonedError] when the Work is tombstoned and the
     #   caller is below the admin and devolved-admin tiers (Atlas 0.6.245 or
-    #   later), so a retracted Work's files are never listed.
+    #   later), so a suppressed Work's files are never listed.
     # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410`
     #   (an auth or validation envelope, a `5xx`, a proxy's `503`), carrying
     #   Atlas's status and body so the failure is attributable at the boundary.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atlas_rb
 version: !ruby/object:Gem::Version
-  version: 1.29.1
+  version: 1.29.2
 platform: ruby
 authors:
 - David Cliff