rdf-ldp 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 608eab3122c07390b9ea22a578ab0744fe18fe02
-  data.tar.gz: ddcd8b00538a683ef78f4cbda395573cebacdc23
+  metadata.gz: 5a633f094bb28ab5b2fc03dec3fbfdf5e0735a0c
+  data.tar.gz: 61979520bcc04f1966a46eb9ee41f250e7c80128
 SHA512:
-  metadata.gz: 29b2ba9c4f2f3baab28bc2d554f5e782cc3756fad291e277486c393e54166a11ccd3ce331c1de11c46849da36548df9ba3a092abbd8424989ee98e9bfb77a57d
-  data.tar.gz: 2e52d0ea153620570b1be88497ff0edb1be04ac860715280e69c9389d01361614c8a39b7d26337007985a8b13d97f546a4d4384fa90f7eb850c5c3e49100aa55
+  metadata.gz: c9e086f88098b88693e86f90ccef8b1e35c123c2b4122cf4f4cc1a3d14db744ae77fe5bf7d6ad8f3bfadec3e026723bf60b488cc91fb64cb7bc586bfc1a3d0aa
+  data.tar.gz: e245c4c5bf3d764dfb5c67e9cef1d9e0820adecec5c93c461a73c923c9ddee690ed99cb4c7ffd5a25c8fd5046bd1ff7102e00911a02bee1855256c52bc473022

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.9.3
+-----
+  - Expose shared examples for LDP interaction models in
+  `lib/rdf/ldp/spec`.
+
 0.9.2
 -----
   - Reduce memory allocation for URIs by using `RDF::URI#intern`.

data/README.md

@@ -103,6 +103,40 @@ And run your server with:
 $ rackup
 ```
 
+Testing
+-------
+
+RSpec shared examples for the required behaviors of LDP resource and container
+types are included in `rdf/ldp/spec` for use in customized implementations.
+Running these example sets will help ensure LDP compliance for specialized
+resource behaviors.
+
+This test suite is provided provisionally and may be incomplete or overly
+strict. Please [report issues](https://github.com/ruby-rdf/rdf-ldp/issues)
+encountered during its use.
+
+```ruby
+require 'rdf/ldp/spec'
+
+describe MyResource do
+  it_behaves_like 'a Resource'
+end
+
+describe MyRDFSource do
+  it_behaves_like 'an RDFSource'
+end
+
+# ...
+
+describe MyIndirectContainer do
+  it_behaves_like 'an IndirectContainer'
+end
+```
+
+We recommend running the official
+[LDP testsuite](https://github.com/cbeer/ldp_testsuite_wrapper), as integration
+tests in addition to the above examples.
+
 Compliance
 ----------
 

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.3

data/app/lamprey.rb

@@ -1,54 +1,133 @@
 require 'rack/ldp'
 require 'sinatra/base'
 
-class RDF::Lamprey < Sinatra::Base
-  use Rack::Lint
-  use Rack::LDP::ContentNegotiation
-  use Rack::LDP::Errors
-  use Rack::LDP::Responses
-  use Rack::ConditionalGet
-  use Rack::LDP::Requests
-  
-  # Set defaults in case user has not configured values
-  configure do
-    set :repository, RDF::Repository.new
-  end
+module RDF
+  ##
+  # A basic implementation of an LDP Server.
+  class Lamprey < Sinatra::Base
+    use Rack::Lint
+    use Rack::LDP::ContentNegotiation
+    use Rack::LDP::Errors
+    use Rack::LDP::Responses
+    use Rack::ConditionalGet
+    use Rack::LDP::Requests
 
-  get '/*' do
-    RDF::LDP::Container.new(RDF::URI(request.url), settings.repository)
-      .create(StringIO.new, 'text/turtle') if settings.repository.empty?    
-    RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
-  end
+    get '/*' do
+      if settings.repository.empty?
+        RDF::LDP::Container
+          .new(RDF::URI(request.url), settings.repository)
+          .create(StringIO.new, 'text/turtle')
+      end
 
-  patch '/*' do
-    RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
-  end
+      RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
+    end
 
-  post '/*' do
-    RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
-  end
+    patch '/*' do
+      RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
+    end
 
-  put '/*' do
-    begin
+    post '/*' do
       RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
-    rescue RDF::LDP::NotFound
-      model = request.env.fetch('HTTP_LINK', '')
-      RDF::LDP::Resource.interaction_model(model)
-        .new(RDF::URI(request.url), settings.repository)
     end
-  end
 
-  options '/*' do
-    RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
-  end
+    put '/*' do
+      begin
+        RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
+      rescue RDF::LDP::NotFound
+        model = request.env.fetch('HTTP_LINK', '')
 
-  head '/*' do
-    RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
-  end
+        RDF::LDP::Resource
+          .interaction_model(model)
+          .new(RDF::URI(request.url), settings.repository)
+      end
+    end
 
-  delete '/*' do
-    RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
-  end
+    options '/*' do
+      RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
+    end
+
+    head '/*' do
+      RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
+    end
+
+    delete '/*' do
+      RDF::LDP::Resource.find(RDF::URI(request.url), settings.repository)
+    end
+
+    ##
+    # @example Configuring Lamprey server
+    #   Lamprey::Config
+    #     .register_repository!(:my_repo, RDF::Repository)
+    #
+    #   Lamprey::Config.configure!(repository: :my_repo)
+    class Config
+      ##
+      # @see #new
+      # @see #configure!
+      def self.configure!(**options)
+        new(**options).configure!
+      end
+
+      ##
+      # Registers a repository for use with the {#build_repository} method.
+      #
+      # @example Registering a custom repository
+      #   MyRepository = Class.new(RDF::Repository)
+      #
+      #   Lamprey::Config.register_repository!(:my_repo, MyRepository)
+      #
+      # @param name  [Symbol]
+      # @param klass [Class]
+      # @return [void]
+      def self.register_repository!(name, klass)
+        @@repositories[name] = klass
+      end
+
+      ##
+      # @!attribute [rw] options
+      attr_accessor :options
 
-  run! if app_file == $0
+      @@repositories = { default: RDF::Repository }
+
+      ##
+      # @param repository [RDF::Repository]
+      def initialize(repository: :default)
+        @options = {}
+        @options[:repository] = repository
+      end
+
+      ##
+      # Builds the repository as given in the configuration.
+      #
+      # @return [RDF::Repository] a repository instance
+      def build_repository
+        @@repositories.fetch(options[:repository]) do
+          warn "#{options[:repository]} is not a configured repository. Use "\
+               '`Lamprey::Config.register_repository!` to register it before '\
+               'configuration. Falling back on the default: ' \
+               "#{@@repositories[:default]}."
+          @@repositories[:default]
+        end.new
+      end
+
+      ##
+      # Configures {RDF::Lamprey} with {#options}.
+      #
+      # @return [void]
+      def configure!
+        repository = build_repository
+        unless repository.persistent?
+          warn "#{repository} is not a persistent repository. "\
+               'Data will be lost on server shutdown.'
+        end
+
+        RDF::Lamprey.configure { |config| config.set :repository, repository }
+      end
+    end
+
+    # Set defaults in case user does not configure values
+    Config.configure!
+
+    run! if app_file == $PROGRAM_NAME
+  end
 end

data/bin/lamprey

@@ -1,5 +1,19 @@
 #!/usr/bin/env ruby
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'app')))
+$LOAD_PATH
+  .unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'app')))
 require 'lamprey'
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: lamprey [options]'
+
+  opts.on('-rREPO', '--repository=REPO', 'Set the repository') do |repo|
+    options[:repository] = repo.to_sym
+  end
+end.parse!
+
+RDF::Lamprey::Config.configure!(**options)
 
 RDF::Lamprey.run!

data/lib/rack/ldp.rb

@@ -14,15 +14,15 @@ module Rack
   # Provides Rack middleware for handling Linked Data Platform requirements
   # when passed {RDF::LDP::Resource} and its subclasses as response objects.
   #
-  # Response objects that are not an {RDF::LDP::Resource} are passed over 
+  # Response objects that are not an {RDF::LDP::Resource} are passed over
   # without alteration, allowing server implementers to mix LDP interaction
   # patterns with others on the same server.
   #
-  # The suite can be mix-and-matched as needed. This allows easy swap in of 
+  # The suite can be mix-and-matched as needed. This allows easy swap in of
   # custom handlers for parts of the behavior. It is recommended that you use
   # {Rack::LDP::ContentNegotiation}, {Rack::LDP::Errors}, {Rack::LDP::Responses}
-  # and {Rack::LDP::Reousets} as the outer middleware layers. With these in 
-  # place, you can handle requests as needed in your application, giving 
+  # and {Rack::LDP::Reousets} as the outer middleware layers. With these in
+  # place, you can handle requests as needed in your application, giving
   # responses conforming to the core {RDF::LDP::Resource} interface.
   #
   # @example
@@ -33,7 +33,7 @@ module Rack
   #     use Rack::LDP::Requests
   #     # ...
   #   end
-  # 
+  #
   # @see http://www.w3.org/TR/ldp/ the LDP specification
   module LDP
     ##
@@ -46,17 +46,15 @@ module Rack
       end
 
       ##
-      # Catches {RDF::LDP::RequestError} and its various subclasses, building an 
-      # appropriate response 
+      # Catches {RDF::LDP::RequestError} and its various subclasses, building an
+      # appropriate response
       #
       # @param [Array] env  a rack env array
       # @return [Array]  a rack env array with added headers
       def call(env)
-        begin
-          @app.call(env)
-        rescue RDF::LDP::RequestError => err
-          return [err.status, err.headers, [err.message]]
-        end
+        @app.call(env)
+      rescue RDF::LDP::RequestError => err
+        return [err.status, err.headers, [err.message]]
       end
     end
 
@@ -94,7 +92,7 @@ module Rack
       end
 
       ##
-      # Handles a Rack protocol request. Sends appropriate request to the 
+      # Handles a Rack protocol request. Sends appropriate request to the
       # object, alters response accordingly.
       #
       # @param [Array] env  a rack env array
@@ -103,19 +101,19 @@ module Rack
         status, headers, response = @app.call(env)
         return [status, headers, response] unless
           response.is_a? RDF::LDP::Resource
-        
+
         response
           .send(:request, env['REQUEST_METHOD'].to_sym, status, headers, env)
       end
     end
 
     ##
-    # Specializes {Rack::LinkedData::ContentNegotiation}, making the default 
+    # Specializes {Rack::LinkedData::ContentNegotiation}, making the default
     # return type 'text/turtle'.
     #
     # @see Rack::LinkedData::ContentNegotiation}, making
     class ContentNegotiation < Rack::LinkedData::ContentNegotiation
-      DEFAULT_PREFIXES = 
+      DEFAULT_PREFIXES =
         Hash[*RDF::Vocabulary.map { |v| [v.__prefix__, v.to_uri] }.flatten]
         .freeze
 
@@ -126,13 +124,13 @@ module Rack
       end
 
       ##
-      # The default LinkedData Conneg doesn't support wildcard operators. We 
-      # patch in support for 'text/*' manually, giving Turtle. This should be 
+      # The default LinkedData Conneg doesn't support wildcard operators. We
+      # patch in support for 'text/*' manually, giving Turtle. This should be
       # considered helpful by LDP clients.
-      # 
+      #
       # @see Rack::LinkedData::ContentNegotiation#find_writer_for_content_type
       def find_writer_for_content_type(content_type)
-        return [RDF::Writer.for(:ttl), 'text/turtle'] if 
+        return [RDF::Writer.for(:ttl), 'text/turtle'] if
           content_type == 'text/*'
         super
       end

data/lib/rdf/ldp.rb

@@ -22,11 +22,12 @@ module RDF
   # @see http://www.w3.org/TR/ldp/ for the Linked Data platform specification
   module LDP
     InteractionModel.register(RDF::LDP::RDFSource, default: true)
-    InteractionModel.register(RDF::LDP::Container, for: RDF::Vocab::LDP.BasicContainer)
+    InteractionModel.register(RDF::LDP::Container,
+                              for: RDF::Vocab::LDP.BasicContainer)
     InteractionModel.register(RDF::LDP::DirectContainer)
     InteractionModel.register(RDF::LDP::IndirectContainer)
     InteractionModel.register(RDF::LDP::NonRDFSource)
-    
+
     CONTAINER_CLASSES = {
       basic:    RDF::Vocab::LDP.BasicContainer.freeze,
       direct:   RDF::LDP::DirectContainer.to_uri.freeze,

data/lib/rdf/ldp/container.rb

@@ -82,8 +82,8 @@ module RDF::LDP
     # 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
-    # handled atomically.
+    # 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
@@ -157,7 +157,7 @@ module RDF::LDP
 
       raise UnsupportedMediaType unless method
 
-      temp_data = RDF::Repository.new << graph.statements
+      temp_data  = RDF::Repository.new << graph.statements
       temp_graph = RDF::Graph.new(graph_name: graph.name, data: temp_data)
       send(method, env['rack.input'], temp_graph)
 
@@ -204,14 +204,18 @@ module RDF::LDP
                                          predicate: CONTAINS_URI)
 
       tx_containment.each do |statement|
-        raise(Conflict, 'Attempted to write unacceptable LDP ' \
-                        "containment-triple: #{statement}") unless
-          existing_triples.include?(statement)
+        unless existing_triples.include?(statement)
+          raise(Conflict, 'Attempted to write unacceptable LDP ' \
+                          "containment-triple: #{statement}")
+        end
       end
 
       deletes = existing_triples.reject { |st| tx_containment.include?(st) }
+
+      return if deletes.empty?
+
       raise(Conflict, 'Cannot remove containment triples in updates. ' \
-                      "Attepted to remove #{deletes}") unless deletes.empty?
+                      "Attepted to remove #{deletes}")
     end
 
     ##
@@ -224,9 +228,11 @@ module RDF::LDP
                           "containment-triple: #{st}")
         end
       end
+
+      return if existing_triples.empty?
+
       raise(Conflict, 'Cannot remove containment triples in updates. ' \
-                      "Attepted to remove #{existing_triples}") unless
-                existing_triples.empty?
+                      "Attepted to remove #{existing_triples}")
     end
   end
 end

data/lib/rdf/ldp/direct_container.rb

@@ -65,7 +65,8 @@ module RDF::LDP
     #
     # @see RDF::LDP::Container#add
     def add(resource, transaction = nil)
-      process_membership_resource(resource, transaction) do |container, quad, subject|
+      process_membership_resource(resource,
+                                  transaction) do |container, quad, subject|
         super(subject, transaction) # super handles nil transaction case
         target = transaction || container.graph
         target.insert(quad)
@@ -79,7 +80,8 @@ module RDF::LDP
     #
     # @see RDF::LDP::Container#remove
     def remove(resource, transaction = nil)
-      process_membership_resource(resource, transaction) do |container, quad, subject|
+      process_membership_resource(resource,
+                                  transaction) do |container, quad, subject|
         super(subject, transaction) # super handles nil transaction case
         target = transaction || container.graph
         target.delete(quad)
@@ -156,7 +158,7 @@ module RDF::LDP
       resource
     end
 
-    def process_membership_resource(resource, transaction = nil, member = nil)
+    def process_membership_resource(resource, _transaction = nil, member = nil)
       membership_triple = make_membership_triple((member || resource).to_uri)
 
       membership_triple.graph_name = subject_uri