rdf-ldp 0.7.0 → 0.8.0

data/lib/rdf/ldp/resource.rb

@@ -33,7 +33,7 @@ module RDF::LDP
   #   resource = RDF::LDP::Resource.new('http://example.org/moomin', repository)
   #   resource.exists? # => false
   #
-  #   resource.create('', 'text/plain')
+  #   resource.create(StringIO.new(''), 'text/plain')
   #
   #   resource.exists? # => true
   #   resource.metagraph.dump :ttl
@@ -56,8 +56,8 @@ module RDF::LDP
   #   resource.exists? # => true
   #   resource.destroyed? # => true
   #
-  # Rack (via `RDF::LDP::Rack`) uses the `#request` method to dispatch requests and
-  # interpret responses. Disallowed HTTP methods result in
+  # Rack (via `RDF::LDP::Rack`) uses the `#request` method to dispatch requests
+  # and interpret responses. Disallowed HTTP methods result in
   # `RDF::LDP::MethodNotAllowed`. Individual Resources populate `Link`, `Allow`,
   # `ETag`, `Last-Modified`, and `Accept-*` headers as required by LDP. All
   # subclasses (MUST) return `self` as the Body, and respond to `#each`/
@@ -80,10 +80,14 @@ module RDF::LDP
   #
   #   resource.request(:put, 200, {}, {}) # RDF::LDP::MethodNotAllowed: put
   #
-  # @see http://www.w3.org/TR/ldp/ for the Linked Data platform specification
-  # @see http://www.w3.org/TR/ldp/#dfn-linked-data-platform-resource for a
-  #   definition of 'Resource' in LDP
+  # @see http://www.w3.org/TR/ldp/ Linked Data platform Specification
+  # @see http://www.w3.org/TR/ldp/#dfn-linked-data-platform-resource Definition
+  #   of 'Resource' in LDP
   class Resource
+    CONTAINS_URI       = RDF::Vocab::LDP.contains.freeze
+    INVALIDATED_AT_URI = RDF::Vocab::PROV.invalidatedAtTime.freeze
+    MODIFIED_URI       = RDF::Vocab::DC.modified.freeze
+
     # @!attribute [r] subject_uri
     #   an rdf term identifying the `Resource`
     attr_reader :subject_uri
@@ -149,18 +153,19 @@ module RDF::LDP
       # @return [Class] a subclass of {RDF::LDP::Resource} matching the
       #   requested interaction model;
       def interaction_model(link_header)
-        models = LinkHeader.parse(link_header)
-                 .links.select { |link| link['rel'].downcase == 'type' }
-                 .map { |link| link.href }
+        models =
+          LinkHeader.parse(link_header)
+                    .links.select { |link| link['rel'].casecmp 'type' }
+                    .map { |link| link.href }
 
         return RDFSource if models.empty?
         match = INTERACTION_MODELS.keys.reverse.find { |u| models.include? u }
 
         if match == RDF::LDP::NonRDFSource.to_uri
           raise NotAcceptable if
-            models.include?(RDF::LDP::RDFSource.to_uri) ||
-            models.include?(RDF::LDP::Container.to_uri) ||
-            models.include?(RDF::LDP::DirectContainer.to_uri) ||
+            models.include?(RDF::LDP::RDFSource.to_uri)         ||
+            models.include?(RDF::LDP::Container.to_uri)         ||
+            models.include?(RDF::LDP::DirectContainer.to_uri)   ||
             models.include?(RDF::LDP::IndirectContainer.to_uri) ||
             models.include?(RDF::URI('http://www.w3.org/ns/ldp#BasicContainer'))
         end
@@ -217,7 +222,7 @@ module RDF::LDP
     # @raise [RDF::LDP::RequestError] when creation fails. May raise various
     #   subclasses for the appropriate response codes.
     # @raise [RDF::LDP::Conflict] when the resource exists
-    def create(input, content_type, &block)
+    def create(_input, _content_type)
       raise Conflict if exists?
 
       @data.transaction(mutable: true) do |transaction|
@@ -268,13 +273,13 @@ module RDF::LDP
     #
     # @todo Use of owl:Nothing is probably problematic. Define an internal
     # namespace and class represeting deletion status as a stateful property.
-    def destroy(&block)
+    def destroy
       @data.transaction(mutable: true) do |transaction|
         containers.each { |c| c.remove(self, transaction) if c.container? }
         transaction.insert RDF::Statement(subject_uri,
-                                      RDF::Vocab::PROV.invalidatedAtTime,
-                                      DateTime.now,
-                                      graph_name: metagraph_name)
+                                          INVALIDATED_AT_URI,
+                                          DateTime.now,
+                                          graph_name: metagraph_name)
         yield transaction if block_given?
       end
       self
@@ -294,8 +299,8 @@ module RDF::LDP
     ##
     # @return [Boolean] true if resource has been destroyed
     def destroyed?
-      times = @metagraph.query([subject_uri, RDF::Vocab::PROV.invalidatedAtTime, nil])
-      !(times.empty?)
+      times = @metagraph.query([subject_uri, INVALIDATED_AT_URI, nil])
+      !times.empty?
     end
 
     ##
@@ -303,13 +308,15 @@ module RDF::LDP
     #
     # @return [String] an HTTP Etag
     #
-    # @note these etags are strong if (and only if) all software that updates
-    #   the resource also updates the ETag
+    # @note these etags are weak, but we allow clients to use them in 
+    #   `If-Match` headers, and use weak comparison. This is in conflict with
+    #   https://tools.ietf.org/html/rfc7232#section-3.1. See: 
+    #   https://github.com/ruby-rdf/rdf-ldp/issues/68
     #
     # @see http://www.w3.org/TR/ldp#h-ldpr-gen-etags  LDP ETag clause for GET
     # @see http://www.w3.org/TR/ldp#h-ldpr-put-precond  LDP ETag clause for PUT
-    # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html#sec13.3.3
-    #   description of strong vs. weak validators
+    # @see https://tools.ietf.org/html/rfc7232#section-2.1
+    #   Weak vs. strong validators
     def etag
       return nil unless exists?
       "W/\"#{last_modified.new_offset(0).iso8601(9)}\""
@@ -382,7 +389,7 @@ module RDF::LDP
     ##
     # @return [Array<RDF::LDP::Resource>] the container for this resource
     def containers
-      @data.query([:s, RDF::Vocab::LDP.contains, subject_uri]).map do |st|
+      @data.query([:s, CONTAINS_URI, subject_uri]).map do |st|
         RDF::LDP::Resource.find(st.subject, @data)
       end
     end
@@ -392,11 +399,11 @@ module RDF::LDP
     # conforming to the Rack interfare.
     #
     # @see http://www.rubydoc.info/github/rack/rack/master/file/SPEC#The_Body
-    #   for Rack body documentation
+    #   Rack body documentation
     def to_response
       []
     end
-    alias_method :each, :to_response
+    alias each to_response
 
     ##
     # Build the response for the HTTP `method` given.
@@ -426,7 +433,7 @@ module RDF::LDP
       raise Gone if destroyed?
       begin
         send(method.to_sym.downcase, status, headers, env)
-      rescue NotImplementedError => e
+      rescue NotImplementedError
         raise MethodNotAllowed, method
       end
     end
@@ -436,27 +443,27 @@ module RDF::LDP
     ##
     # Generate response for GET requests. Returns existing status and headers,
     # with `self` as the body.
-    def get(status, headers, env)
+    def get(status, headers, _env)
       [status, update_headers(headers), self]
     end
 
     ##
     # Generate response for HEAD requsets. Adds appropriate headers and returns
     # an empty body.
-    def head(status, headers, env)
+    def head(status, headers, _env)
       [status, update_headers(headers), []]
     end
 
     ##
     # Generate response for OPTIONS requsets. Adds appropriate headers and
     # returns an empty body.
-    def options(status, headers, env)
+    def options(status, headers, _env)
       [status, update_headers(headers), []]
     end
 
     ##
     # Process & generate response for DELETE requests.
-    def delete(status, headers, env)
+    def delete(_status, headers, _env)
       destroy
       headers.delete('Content-Type')
       [204, headers, []]
@@ -503,7 +510,7 @@ module RDF::LDP
     # @return [Hash<String, String>] the updated headers
     def update_headers(headers)
       headers['Link'] =
-        ([headers['Link']] + link_headers).compact.join(",")
+        ([headers['Link']] + link_headers).compact.join(',')
 
       headers['Allow'] = allowed_methods.join(', ')
       headers['Accept-Post'] = accept_post   if respond_to?(:post, true)
@@ -561,18 +568,15 @@ module RDF::LDP
         # transactions do not support updates or pattern deletes, so we must
         # ask the Repository for the current last_modified to delete the statement
         # transactionally
-        modified = last_modified
-        transaction.delete RDF::Statement(subject_uri,
-                                          RDF::Vocab::DC.modified,
-                                          modified,
-                                          graph_name: metagraph_name) if modified
+        transaction
+          .delete RDF::Statement(subject_uri, MODIFIED_URI, last_modified,
+                                 graph_name: metagraph_name) if last_modified
 
-        transaction.insert RDF::Statement(subject_uri,
-                                          RDF::Vocab::DC.modified,
-                                          DateTime.now,
-                                          graph_name: metagraph_name)
+        transaction
+          .insert RDF::Statement(subject_uri, MODIFIED_URI, DateTime.now,
+                                 graph_name: metagraph_name)
       else
-        metagraph.update([subject_uri, RDF::Vocab::DC.modified, DateTime.now])
+        metagraph.update([subject_uri, MODIFIED_URI, DateTime.now])
       end
     end
 

data/lib/rdf/ldp/storage_adapters/file_storage_adapter.rb

@@ -0,0 +1,102 @@
+module RDF::LDP
+  class NonRDFSource < Resource
+    ##
+    # StorageAdapters bundle the logic for mapping a `NonRDFSource` to a
+    # specific IO stream. Implementations must conform to a minimal interface:
+    #
+    #  - `#initailize` must accept a `resource` parameter. The input should be
+    #     a `NonRDFSource` (LDP-NR).
+    #  - `#io` must yield and return a IO object in binary mode that represents
+    #    the current state of the LDP-NR.
+    #    - If a block is passed to `#io`, the implementation MUST allow return a
+    #      writable IO object and that anything written to the stream while
+    #      yielding is synced with the source in a thread-safe manner.
+    #    - Clients not passing a block to `#io` SHOULD call `#close` on the
+    #      object after reading it.
+    #    - If the `#io` object responds to `#to_path` it MUST give the location
+    #      of a file whose contents are identical the IO object's. This supports
+    #      Rack's response body interface.
+    #  - `#delete` remove the contents from the corresponding storage. This MAY
+    #      be a no-op if is undesirable or impossible to delete the contents
+    #      from the storage medium.
+    #
+    # @see http://www.rubydoc.info/github/rack/rack/master/file/SPEC#The_Body
+    #   for details about `#to_path` in Rack response bodies.
+    #
+    # @example reading from a `StorageAdapter`
+    #   storage = StorageAdapter.new(an_nr_source)
+    #   storage.io.read # => [string contents of `an_nr_source`]
+    #
+    # @example writing to a `StorageAdapter`
+    #   storage = StorageAdapter.new(an_nr_source)
+    #   storage.io { |io| io.write('moomin') }
+    #
+    # Beyond this interface, implementations are permitted to behave as desired.
+    # They may, for instance, reject undesirable content or alter the graph (or
+    # metagraph) of the resource. They should throw appropriate `RDF::LDP`
+    # errors when failing to allow the middleware to handle response codes and
+    # messages.
+    #
+    # The base storage adapter class provides a simple File storage
+    # implementation.
+    #
+    # @todo check thread saftey on write for base implementation
+    class FileStorageAdapter
+      STORAGE_PATH = '.storage'.freeze
+
+      ##
+      # Initializes the storage adapter.
+      #
+      # @param [NonRDFSource] resource
+      def initialize(resource)
+        @resource = resource
+      end
+
+      ##
+      # Gives an IO object which represents the current state of @resource.
+      # Opens the file for read-write (mode: r+), if it already exists;
+      # otherwise, creates the file and opens it for read-write (mode: w+).
+      #
+      # @yield [IO] yields a read-writable object conforming to the Ruby IO
+      #   interface for storage. The IO object will be closed when the block
+      #   ends.
+      #
+      # @return [IO] an object conforming to the Ruby IO interface
+      def io(&block)
+        FileUtils.mkdir_p(path_dir) unless Dir.exists?(path_dir)
+        FileUtils.touch(path) unless file_exists?
+
+        File.open(path, 'r+b', &block)
+      end
+
+      ##
+      # @return [Boolean] 1 if the file has been deleted, otherwise false
+      def delete
+        return false unless File.exists?(path)
+        File.delete(path)
+      end
+
+      private
+
+      ##
+      # @return [Boolean]
+      def file_exists?
+        File.exists?(path)
+      end
+
+      ##
+      # Build the path to the file on disk.
+      # @return [String]
+      def path
+        File.join(STORAGE_PATH, @resource.subject_uri.path)
+      end
+
+      ##
+      # Build the path to the file's directory on disk
+      # @return [String]
+      def path_dir
+        File.split(path).first
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdf-ldp
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Tom Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-26 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rdf-turtle
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: ld-patch
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json-ld
   requirement: !ruby/object:Gem::Requirement
@@ -363,10 +363,11 @@ files:
 - lib/rdf/ldp/non_rdf_source.rb
 - lib/rdf/ldp/rdf_source.rb
 - lib/rdf/ldp/resource.rb
+- lib/rdf/ldp/storage_adapters/file_storage_adapter.rb
 - lib/rdf/ldp/version.rb
 homepage: http://ruby-rdf.github.com/
 licenses:
-- Public Domain
+- Unlicense
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -377,7 +378,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -390,4 +391,3 @@ signing_key:
 specification_version: 4
 summary: A suite of LDP software and middleware for RDF.rb.
 test_files: []
-has_rdoc: false