rdf-ldp 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6984fe1fabab30524697db0471c39721f68fb54
-  data.tar.gz: fc3b6d95051b4c82b02cb9d474a379b15e5584d0
+  metadata.gz: 663f6cdf86d6e9ead88bd25c120ca190bb6e5b6a
+  data.tar.gz: 3dee66e41f42baff2923e2ba8977b54673d31220
 SHA512:
-  metadata.gz: 0243e142e3b59232c19360ad4b507dda9e32ea9643e794318fb5227fe653261b64a61b82e655620976a05fec535f35193c5c7fccb225ed65669ff07192875693
-  data.tar.gz: 7256e7bb1c2c2a59c16e64def71c9101e5cd1b071d6f2432564d1dfb3d8feb559732b85821a3e0a71773f15f69cab5d8ee1da9e36af3dc1d4ee3b29793d89811
+  metadata.gz: ba4698c28103ce63f83eeb8992116e5258529cd04eac8fa5e5dfae223cb1843e4e465645023b28ba6ed37ccad386c2aa55ec9de984d6b1879c484bf2db44dcbe
+  data.tar.gz: 6a4c62830de24ffc8428373db0ba5d3badbb9fbce6f66c6e1d45a9de827f9bc5259c54df44cc1ebac61acd49a460c9c2e5e14cb00282dfabf0c8533caa9f1a92

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.8.0
+-----
+ - Deletes on NonRDFSources now leave the file on disk if deleting the
+ metadata fails, making deletes atomic from the client's perspective.
+ - Changes the NonRDFSource interface to allow configuration of storage
+ adapters via dependency injection.
+ - Ends support for Ruby versions earlier than 2.2.2.
+   
 0.7.0
 -----
  - Changes handling of input streams to be compliant with Rack. Allows

data/README.md

@@ -82,7 +82,7 @@ use Rack::LDP::Requests
 #
 repository = RDF::Repository.new 
 RDF::LDP::Container.new(RDF::URI('http://localhost:9292/'), repository)
-  .create('', 'text/plain') if repository.empty?
+  .create(StringIO.new(''), 'text/plain') if repository.empty?
 
 app = proc do |env|
   # Return a Rack response, giving an `RDF::LDP::Resource`-like object as the body.

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/lib/rdf/ldp.rb

@@ -13,15 +13,15 @@ require 'rdf/ldp/indirect_container'
 module RDF
   ##
   # This module implements a basic domain model for Linked Data Platform (LDP).
-  # Its classes allow CRUD operations on LDP RDFSources, NonRDFSources and 
-  # Containers, while presenting an interface appropriate for consumption by 
+  # Its classes allow CRUD operations on LDP RDFSources, NonRDFSources and
+  # Containers, while presenting an interface appropriate for consumption by
   # Rack servers.
-  #   
+  #
   # @see RDF::LDP::Resource
   # @see http://www.w3.org/TR/ldp/ for the Linked Data platform specification
   module LDP
     ##
-    # Interaction models are in reverse order of preference for POST/PUT 
+    # Interaction models are in reverse order of preference for POST/PUT
     # requests; e.g. if a client sends a request with Resource, RDFSource, and
     # BasicContainer headers, the server gives a basic container.
     INTERACTION_MODELS = {
@@ -34,20 +34,20 @@ module RDF
       RDF::LDP::NonRDFSource.to_uri => RDF::LDP::NonRDFSource
     }.freeze
 
-    CONTAINER_CLASSES = { 
-      basic:    RDF::Vocab::LDP.BasicContainer,
-      direct:   RDF::LDP::DirectContainer.to_uri,
-      indirect: RDF::LDP::IndirectContainer.to_uri
-    }
+    CONTAINER_CLASSES = {
+      basic:    RDF::Vocab::LDP.BasicContainer.freeze,
+      direct:   RDF::LDP::DirectContainer.to_uri.freeze,
+      indirect: RDF::LDP::IndirectContainer.to_uri.freeze
+    }.freeze
 
-    CONSTRAINED_BY = RDF::Vocab::LDP.constrainedBy
+    CONSTRAINED_BY = RDF::Vocab::LDP.constrainedBy.freeze
 
     ##
     # A base class for HTTP request errors.
     #
     # This and its subclasses are caught and handled by Rack::LDP middleware.
     # When a `RequestError` is caught by server middleware, its `#status` can be
-    # used as a response code and `#headers` may be added to (or replace) the 
+    # used as a response code and `#headers` may be added to (or replace) the
     # existing HTTP headers.
     class RequestError < RuntimeError
       STATUS = 500
@@ -57,7 +57,7 @@ module RDF
       end
 
       def headers
-        uri = 
+        uri =
           'https://github.com/no-reply/rdf-ldp/blob/master/CONSTRAINED_BY.md'
         { 'Link' => "<#{uri}>;rel=\"#{CONSTRAINED_BY}\"" }
       end

data/lib/rdf/ldp/container.rb

@@ -1,11 +1,11 @@
 module RDF::LDP
   ##
-  # An LDP Basic Container. This also serves as a base class for other 
+  # An LDP Basic Container. This also serves as a base class for other
   # container types. Containers are implemented as `RDF::LDP::RDFSources` with
   # the ability to contain other resources.
   #
   # Containers respond to `#post`, allowing new resources to be added to them.
-  # On the public interface (not running through HTTP/`#request`), this is 
+  # On the public interface (not running through HTTP/`#request`), this is
   # supported by `#add` and `#remove`.
   #
   # Containers will throw errors when attempting to edit them in conflict with
@@ -15,7 +15,7 @@ module RDF::LDP
   #   of LDP Container
   class Container < RDFSource
     ##
-    # @return [RDF::URI] uri with lexical representation 
+    # @return [RDF::URI] uri with lexical representation
     #   'http://www.w3.org/ns/ldp#Container'
     def self.to_uri
       RDF::Vocab::LDP.Container
@@ -36,25 +36,25 @@ module RDF::LDP
     ##
     # Create with validation as required for the LDP container.
     #
-    # @raise [RDF::LDP::Conflict] if the create inserts triples that are not 
+    # @raise [RDF::LDP::Conflict] if the create inserts triples that are not
     #   allowed by LDP for the container type
     # @see RDFSource#create
     def create(input, content_type, &block)
-      super do |transaction| 
+      super do |transaction|
         validate_triples!(transaction)
         yield transaction if block_given?
       end
       self
     end
-    
+
     ##
     # Updates with validation as required for the LDP container.
     #
-    # @raise [RDF::LDP::Conflict] if the update edits triples that are not 
+    # @raise [RDF::LDP::Conflict] if the update edits triples that are not
     #   allowed by LDP for the container type
     # @see RDFSource#update
     def update(input, content_type, &block)
-      super do |transaction| 
+      super do |transaction|
         validate_triples!(transaction)
         yield transaction if block_given?
       end
@@ -62,12 +62,12 @@ module RDF::LDP
     end
 
     ##
-    # Adds a member `resource` to the container. Handles containment and 
+    # Adds a member `resource` to the container. Handles containment and
     # membership triples as appropriate for the container type.
     #
-    # If a transaction is passed as the second argument, the additon of the 
-    # containment triple is completed when the transaction closes; otherwise it is 
-    # handled atomically.
+    # If a transaction is passed as the second argument, the additon of the
+    # containment triple is completed when the transaction closes; otherwise it
+    # is handled atomically.
     #
     # @param [RDF::Term] a new member for this container
     # @param transaction [RDF::Transaction] an active transaction as context for
@@ -81,8 +81,8 @@ module RDF::LDP
     # Removes a member `resource` from the container. Handles containment and
     # membership triples as appropriate for the container type.
     #
-    # If a transaction is passed as the second argument, the removal of the 
-    # containment triple is completed when the transaction closes; otherwise it is 
+    # If a transaction is passed as the second argument, the removal of the
+    # containment triple is completed when the transaction closes; otherwise it is
     # handled atomically.
     #
     # @param [RDF::Term] a new member for this container
@@ -96,9 +96,7 @@ module RDF::LDP
     ##
     # @return [RDF::Query::Enumerator] the containment triples
     def containment_triples
-      graph.query([subject_uri, 
-                   RDF::Vocab::LDP.contains, 
-                   nil]).statements
+      graph.query([subject_uri, CONTAINS_URI, nil]).statements
     end
 
     ##
@@ -106,7 +104,7 @@ module RDF::LDP
     #
     # @return [Boolean] true if the containment triple exists
     def has_containment_triple?(statement)
-      !(containment_triples.find { |t| statement == t }.nil?)
+      !containment_triples.find { |t| statement == t }.nil?
     end
 
     ##
@@ -116,7 +114,7 @@ module RDF::LDP
     # the transaction's inserts; otherwise it is added directly to `#graph`.
     #
     # @param resource [RDF::Term] a new member for this container
-    # @param transaction [RDF::Transaction] 
+    # @param transaction [RDF::Transaction]
     # @return [Container] self
     def add_containment_triple(resource, transaction = nil)
       target = transaction || graph
@@ -132,7 +130,7 @@ module RDF::LDP
     # the transaction's deletes; otherwise it is deleted directly from `#graph`.
     #
     # @param resource [RDF::Term] a member to remove from this container
-    # @param transaction [RDF::Transaction] 
+    # @param transaction [RDF::Transaction]
     # @return [Container] self
     def remove_containment_triple(resource, transaction = nil)
       target = transaction || graph
@@ -144,16 +142,16 @@ module RDF::LDP
     ##
     # @param [RDF::Term] a member to be represented in the containment triple
     #
-    # @return [RDF::URI] the containment triple, with a graph_name pointing 
+    # @return [RDF::URI] the containment triple, with a graph_name pointing
     #   to `#graph`
     def make_containment_triple(resource)
-      RDF::Statement(subject_uri, RDF::Vocab::LDP.contains, resource, 
+      RDF::Statement(subject_uri, CONTAINS_URI, resource,
                      graph_name: subject_uri)
     end
 
     private
 
-    def patch(status, headers, env)
+    def patch(_status, headers, env)
       check_precondition!(env)
       method = patch_types[env['CONTENT_TYPE']]
 
@@ -177,58 +175,57 @@ module RDF::LDP
     #
     # @raise [RDF::LDP::RequestError] when creation fails
     #
-    # @return [Array<Fixnum, Hash<String, String>, #each] a new Rack response 
+    # @return [Array<Fixnum, Hash<String, String>, #each] a new Rack response
     #   array.
-    def post(status, headers, env)
+    def post(_status, headers, env)
       klass = self.class.interaction_model(env.fetch('HTTP_LINK', ''))
       slug = env['HTTP_SLUG']
       slug = klass.gen_id if slug.nil? || slug.empty?
-      raise NotAcceptable.new('Refusing to create resource with `#` in Slug') if 
+      raise(NotAcceptable, 'Refusing to create resource with `#` in Slug') if
         slug.include? '#'
 
       id = (subject_uri / slug).canonicalize
 
       created = klass.new(id, @data)
-                          
+
       created.create(env['rack.input'], env['CONTENT_TYPE']) do |transaction|
         add(created, transaction)
       end
-      
+
       headers['Location'] = created.subject_uri.to_s
       [201, created.send(:update_headers, headers), created]
     end
 
     def validate_triples!(transaction)
       existing_triples = containment_triples.to_a
-      
-      tx_containment = transaction.query(subject: subject_uri, 
-                                         predicate: RDF::Vocab::LDP.contains)
+
+      tx_containment = transaction.query(subject: subject_uri,
+                                         predicate: CONTAINS_URI)
 
       tx_containment.each do |statement|
-        raise Conflict.new('Attempted to write unacceptable LDP ' \
-                           "containment-triple: #{statement}") unless
-          existing_triples.include?(statement) 
+        raise(Conflict, 'Attempted to write unacceptable LDP ' \
+                        "containment-triple: #{statement}") unless
+          existing_triples.include?(statement)
       end
 
       deletes = existing_triples.reject { |st| tx_containment.include?(st) }
-      raise Conflict.new('Cannot remove containment triples in updates. ' \
-                         "Attepted to remove #{deletes}") unless deletes.empty?
+      raise(Conflict, 'Cannot remove containment triples in updates. ' \
+                      "Attepted to remove #{deletes}") unless deletes.empty?
     end
 
     ##
     # supports Patch.
     def validate_statements!(statements)
       existing_triples = containment_triples.to_a
-      statements.query(subject: subject_uri, 
-                       predicate: RDF::Vocab::LDP.contains) do |statement|
-        existing_triples.delete(statement) do 
-          raise Conflict.new('Attempted to write unacceptable LDP ' \
-                             "containment-triple: #{statement}") 
+      statements.query(subject: subject_uri, predicate: CONTAINS_URI) do |st|
+        existing_triples.delete(st) do
+          raise(Conflict, 'Attempted to write unacceptable LDP ' \
+                          "containment-triple: #{st}")
         end
       end
-      raise Conflict.new('Cannot remove containment triples in updates. ' \
-                         "Attepted to remove #{existing_triples}") unless
-        existing_triples.empty?
+      raise(Conflict, 'Cannot remove containment triples in updates. ' \
+                      "Attepted to remove #{existing_triples}") unless
+                existing_triples.empty?
     end
   end
 end

data/lib/rdf/ldp/direct_container.rb

@@ -1,30 +1,33 @@
 module RDF::LDP
   ##
-  # An extension of `RDF::LDP::Container` implementing direct containment. 
-  # This adds the concepts of a membership resource, predicate, and triples to 
+  # An extension of `RDF::LDP::Container` implementing direct containment.
+  # This adds the concepts of a membership resource, predicate, and triples to
   # the Basic Container's containment triples.
   #
-  # When the membership resource is an `RDFSource`, the membership triple is 
+  # When the membership resource is an `RDFSource`, the membership triple is
   # added/removed from its graph when the resource created/deleted within the
-  # container. When the membership resource is a `NonRDFSource`, the triple is 
+  # container. When the membership resource is a `NonRDFSource`, the triple is
   # added/removed on its description's graph instead.
   #
   # A membership constant URI and membership predicate MUST be specified as
   # described in LDP--exactly one of each. If none is given, we default to
   # the container itself as a membership resource and `ldp:member` as predicate.
-  # If more than one of either is given, all `#add/#remove` (POST/DELETE) 
+  # If more than one of either is given, all `#add/#remove` (POST/DELETE)
   # requests will fail.
   #
   # @see http://www.w3.org/TR/ldp/#dfn-linked-data-platform-direct-container
   #   definition of LDP Direct Container
   class DirectContainer < Container
+    MEMBER_URI              = RDF::Vocab::LDP.member.freeze
+    MEMBERSHIP_RESOURCE_URI = RDF::Vocab::LDP.membershipResource.freeze
+
+    RELATION_TERMS = [RDF::Vocab::LDP.hasMemberRelation.freeze,
+                      RDF::Vocab::LDP.isMemberOfRelation.freeze].freeze
+
     def self.to_uri
       RDF::Vocab::LDP.DirectContainer
     end
 
-    RELATION_TERMS = [RDF::Vocab::LDP.hasMemberRelation,
-                      RDF::Vocab::LDP.isMemberOfRelation]
-
     ##
     # @return [RDF::URI] a URI representing the container type
     def container_class
@@ -34,16 +37,16 @@ module RDF::LDP
     ##
     # Creates and inserts default relation triples if none are given.
     #
-    # @note the addition of default triples is handled in a separate 
+    # @note the addition of default triples is handled in a separate
     #   transaction. It is possible for the second transaction to fail, causing
     #   the resource to persist in an invalid state. It is also possible for a
     #   read to occur between the two transactions.
-    # @todo Make atomic. Consider just raising an error instead of adding 
-    #   triples. There's a need to handle this issue for repositories with 
+    # @todo Make atomic. Consider just raising an error instead of adding
+    #   triples. There's a need to handle this issue for repositories with
     #   snapshot reads, as well as those without.
     #
     # @see Container#create
-    def create(input, content_type, &block)
+    def create(input, content_type)
       super
 
       graph.transaction(mutable: true) do |tx|
@@ -63,8 +66,8 @@ module RDF::LDP
     # @see RDF::LDP::Container#add
     def add(resource, transaction = nil)
       target = transaction || graph
-      process_membership_resource(resource) do |membership, quad, resource|
-        super(resource, transaction)
+      process_membership_resource(resource) do |membership, quad, subject|
+        super(subject, transaction)
         target = transaction || membership.graph
         target.insert(quad)
       end
@@ -72,13 +75,13 @@ module RDF::LDP
     end
 
     ##
-    # Removes a member `resource` to the container. Handles containment and 
+    # Removes a member `resource` to the container. Handles containment and
     # removes membership triple to the memebership resource.
     #
     # @see RDF::LDP::Container#remove
     def remove(resource, transaction = nil)
-      process_membership_resource(resource) do |membership, quad, resource|
-        super(resource, transaction)
+      process_membership_resource(resource) do |membership, quad, subject|
+        super(subject, transaction)
         target = transaction || membership.graph
         target.delete(quad)
       end
@@ -86,24 +89,25 @@ module RDF::LDP
     end
 
     ##
-    # Gives the membership constant URI. If none is present in the container 
+    # Gives the membership constant URI. If none is present in the container
     # state, we add the current resource as a membership constant.
     #
     # @return [RDF::URI] the membership constant uri for the container
     #
-    # @raise [RDF::LDP::NotAcceptable] if multiple membership constant uris exist
+    # @raise [RDF::LDP::NotAcceptable] if multiple membership constant uris
+    #   exist
     #
     # @see http://www.w3.org/TR/ldp/#dfn-membership-triples
     def membership_constant_uri
       statements = membership_resource_statements
       return statements.first.object if statements.count == 1
 
-      raise NotAcceptable.new('An LDP-DC MUST have exactly one membership ' \
-                              "resource; found #{statements.count}.")
+      raise(NotAcceptable, 'An LDP-DC MUST have exactly one membership ' \
+                           "resource; found #{statements.count}.")
     end
 
     ##
-    # Gives the membership predicate. If none is present in the container 
+    # Gives the membership predicate. If none is present in the container
     # state, we add the current resource as a membership constant.
     #
     # @return [RDF::URI] the membership predicate
@@ -115,8 +119,8 @@ module RDF::LDP
       statements = member_relation_statements
       return statements.first.object if statements.count == 1
 
-      raise NotAcceptable.new('An LDP-DC MUST have exactly one member ' \
-                              "relation triple; found #{statements.count}.")
+      raise(NotAcceptable, 'An LDP-DC MUST have exactly one member ' \
+                           "relation triple; found #{statements.count}.")
     end
 
     ##
@@ -134,9 +138,9 @@ module RDF::LDP
     end
 
     private
-    
+
     def membership_resource_statements
-      graph.query([subject_uri, RDF::Vocab::LDP.membershipResource, :o])
+      graph.query([subject_uri, MEMBERSHIP_RESOURCE_URI, :o])
     end
 
     def member_relation_statements
@@ -153,28 +157,24 @@ module RDF::LDP
       resource
     end
 
-    def process_membership_resource(resource, &block)
+    def process_membership_resource(resource)
       statement = make_membership_triple(resource.to_uri)
 
-      begin
-        membership_rs = membership_resource
-      rescue NotFound => e
-        raise NotAcceptable.new('Membership resource ' \
-                                "#{membership_constant_uri} does not exist")
-      end
+      membership_rs = membership_resource
 
       statement.graph_name = membership_rs.subject_uri
       yield(membership_rs, statement, resource) if block_given?
+    rescue NotFound
+      raise(NotAcceptable, 'Membership resource ' \
+                           "#{membership_constant_uri} does not exist")
     end
 
     def default_membership_resource_statement
-      RDF::Statement(subject_uri, 
-                     RDF::Vocab::LDP.membershipResource, 
-                     subject_uri)
+      RDF::Statement(subject_uri, MEMBERSHIP_RESOURCE_URI, subject_uri)
     end
-    
+
     def default_member_relation_statement
-      RDF::Statement(subject_uri, RELATION_TERMS.first, RDF::Vocab::LDP.member)
+      RDF::Statement(subject_uri, RELATION_TERMS.first, MEMBER_URI)
     end
   end
 end