active-fedora 9.12.0 → 9.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02fb3ee9bf393052113ffdd4082e741bc155266c
-  data.tar.gz: 674c9e4a7a00220c1bb2011414dfdaf841b76100
+  metadata.gz: de64ddd51b632d51f1f4dc511ff09f362ef0f780
+  data.tar.gz: d92cd808d81b5f883bfe354ec500ddb0b876cf45
 SHA512:
-  metadata.gz: 8e8c4e554a899aa3109de27b30dfb1a64b0c3954cf2ad4c2e7c255413ed27bf8242ed8bd951f8364c18a92d49f346f800ffed9e52abc7af507143eff1e5631e2
-  data.tar.gz: e5d93de8c674af3aa2f27dc18a52c06bf35afd3a0e9ab0b4ad01522664015e86e8e83faa4938ec5dda2ee16df5f76bec22229f9c3c8557e6f89fcf7f41b87a58
+  metadata.gz: 74614aefd969cdbc977b7c793a8c2f09f434200ae28407d75af925112fcd85b3da3f14fc112fa3d704573762909c25d03111c509b172452574183ccc3836b749
+  data.tar.gz: 60a60f1c17d835d44423bb1a4fa24bcec477ff9854bfb0b33791220de4edfd2b273942a9fbce8b486aa6ba4f5fec397efc87b38687ff8e6058a46778f2938788

data/.rubocop.yml

@@ -12,7 +12,7 @@ Lint/HandleExceptions:
     - 'spec/unit/**/*'
     - 'spec/integration/**/*'
     - 'lib/active_fedora/cleaner.rb'
-    - 'lib/active_fedora/associations/builder/contains.rb'
+    - 'lib/active_fedora/associations/builder/has_subresource.rb'
 
 Lint/AssignmentInCondition:
   Enabled: false

data/active-fedora.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency "deprecation"
   s.add_dependency "ldp", '~> 0.5.0'
 
+  s.add_development_dependency "rails"
   s.add_development_dependency "rdoc"
   s.add_development_dependency "yard"
   # Pin rake to 10.0 due to https://github.com/lsegal/yard/issues/947

data/lib/active_fedora.rb

@@ -86,6 +86,7 @@ module ActiveFedora #:nodoc:
     autoload :InheritableAccessors
     autoload :Inheritance
     autoload :InboundRelationConnection
+    autoload :InitializingConnection
     autoload :LdpCache
     autoload :LdpResource
     autoload :LdpResourceService

data/lib/active_fedora/associations.rb

@@ -25,6 +25,7 @@ module ActiveFedora
     autoload :BelongsToAssociation
     autoload :HasAndBelongsToManyAssociation
     autoload :BasicContainsAssociation
+    autoload :HasSubresourceAssociation
     autoload :DirectlyContainsAssociation
     autoload :DirectlyContainsOneAssociation
     autoload :IndirectlyContainsAssociation
@@ -45,7 +46,8 @@ module ActiveFedora
       autoload :BelongsTo,           'active_fedora/associations/builder/belongs_to'
       autoload :HasMany,             'active_fedora/associations/builder/has_many'
       autoload :HasAndBelongsToMany, 'active_fedora/associations/builder/has_and_belongs_to_many'
-      autoload :Contains,            'active_fedora/associations/builder/contains'
+      autoload :BasicContains,       'active_fedora/associations/builder/basic_contains'
+      autoload :HasSubresource,      'active_fedora/associations/builder/has_subresource'
       autoload :DirectlyContains,    'active_fedora/associations/builder/directly_contains'
       autoload :DirectlyContainsOne, 'active_fedora/associations/builder/directly_contains_one'
       autoload :IndirectlyContains,  'active_fedora/associations/builder/indirectly_contains'
@@ -104,6 +106,23 @@ module ActiveFedora
       end
 
       module ClassMethods
+        # This method is used to declare this resource acts like an LDP BasicContainer
+        #
+        # @param [Hash] options
+        # @option options [String] :class_name ('ActiveFedora::File') The name of the
+        #   class that will represent the contained resources
+        #
+        # example:
+        #   class FooHistory < ActiveFedora::Base
+        #     is_a_container class_name: 'Thing'
+        #   end
+        #
+        def is_a_container(options = {})
+          defaults = { class_name: 'ActiveFedora::File',
+                       predicate: ::RDF::Vocab::LDP.contains }
+          Builder::BasicContains.build(self, :contains, defaults.merge(options))
+        end
+
         # This method is used to declare an ldp:DirectContainer on a resource
         # you must specify an is_member_of_relation or a has_member_relation
         #
@@ -176,9 +195,25 @@ module ActiveFedora
         # @option options [Boolean] :autocreate Always create this resource on new objects
         # @yield block executed by some types of child resources
         def contains(name, options = {}, &block)
+          Deprecation.warn(Associations, "contains is deprecated. Use has_subresource instead. This will be removed in ActiveFedora 10")
+          has_subresource(name, options, &block)
+        end
+
+        # This method is used to specify the details of a contained resource.
+        # Pass the name as the first argument and a hash of options as the second argument
+        # Note that this method doesn't actually execute the block, but stores it, to be executed
+        # by any the implementation of the resource(specified as :class_name)
+        #
+        # @param [String] name the handle to refer to this child as
+        # @param [Hash] options
+        # @option options [Class] :class_name The class that will represent this child, should extend ``ActiveFedora::File'' or ``ActiveFedora::Base''
+        # @option options [String] :url
+        # @option options [Boolean] :autocreate Always create this resource on new objects
+        # @yield block executed by some types of child resources
+        def has_subresource(name, options = {}, &block)
           options[:block] = block if block
-          raise ArgumentError, "You must provide a name (dsid) for the datastream" unless name
-          Associations::Builder::Contains.build(self, name.to_sym, options)
+          raise ArgumentError, "You must provide a path name (f.k.a. dsid) for the resource" unless name
+          Associations::Builder::HasSubresource.build(self, name.to_sym, options)
         end
 
         # Specifies a one-to-one association with another class. This method should only be used

data/lib/active_fedora/associations/basic_contains_association.rb

@@ -1,61 +1,22 @@
 module ActiveFedora
   module Associations
-    class BasicContainsAssociation < SingularAssociation #:nodoc:
-      # Implements the reader method, e.g. foo.bar for Foo.has_one :bar
-      def reader(force_reload = false)
-        super || build
-      end
-
+    class BasicContainsAssociation < ContainsAssociation #:nodoc:
       def find_target
-        find_or_initialize_target do |record|
-          configure_datastream(record) if reflection.options[:block]
-        end
-      end
+        uris = owner.resource.query(predicate: options[:predicate])
+                    .map { |r| r.object.to_s }
 
-      def target_uri
-        "#{owner.id}/#{reflection.name}"
+        uris.map { |object_uri| klass.find(klass.uri_to_id(object_uri)) }
       end
 
-      private
-
-        def raise_on_type_mismatch!(record)
-          return if record.is_a? LoadableFromJson::SolrBackedMetadataFile
-          super
-        end
-
-        def find_or_initialize_target(&block)
-          if reflection.klass < ActiveFedora::File
-            reflection.build_association(target_uri, &block)
-          else
-            reflection.klass.find(target_uri)
-          end
-        rescue ActiveFedora::ObjectNotFoundError
-          reflection.build_association(target_uri, &block)
-        end
-
-        def replace(record)
-          if record
-            raise_on_type_mismatch!(record)
-            @updated = true
-          end
-
-          self.target = record
-        end
-
-        def new_record(method, attributes)
-          record = super
-          configure_datastream(record)
-          record
-        end
+      def insert_record(record, force = true, validate = true)
+        record.base_path_for_resource = owner.uri.to_s
+        super
+      end
 
-        def configure_datastream(record)
-          # If you called has_metadata with a block, pass the block into the File class
-          if reflection.options[:block].class == Proc
-            reflection.options[:block].call(record)
-          end
-          return unless record.new_record? && reflection.options[:autocreate]
-          record.datastream_will_change!
-        end
+      def add_to_target(record, skip_callbacks = false)
+        record.base_path_for_resource = owner.uri.to_s
+        super
+      end
     end
   end
 end

data/lib/active_fedora/associations/builder/aggregation.rb

@@ -6,7 +6,7 @@ module ActiveFedora::Associations::Builder
 
     def self.build(model, name, options)
       model.indirectly_contains name, { has_member_relation: has_member_relation(options), through: proxy_class, foreign_key: proxy_foreign_key, inserted_content_relation: inserted_content_relation }.merge(indirect_options(options))
-      model.contains contains_key(options), class_name: list_source_class
+      model.has_subresource contains_key(options), class_name: list_source_class
       model.orders name, through: contains_key(options)
     end
 

data/lib/active_fedora/associations/builder/basic_contains.rb

@@ -0,0 +1,7 @@
+module ActiveFedora::Associations::Builder
+  class BasicContains < CollectionAssociation #:nodoc:
+    def self.macro
+      :is_a_container
+    end
+  end
+end

data/lib/active_fedora/associations/builder/{contains.rb → has_subresource.rb}

@@ -1,7 +1,7 @@
 module ActiveFedora::Associations::Builder
-  class Contains < SingularAssociation #:nodoc:
+  class HasSubresource < SingularAssociation #:nodoc:
     def self.macro
-      :contains
+      :has_subresource
     end
 
     def self.valid_options(options)

data/lib/active_fedora/associations/contains_association.rb

@@ -1,7 +1,15 @@
-# This is the parent class of DirectlyContainsAssociation and IndirectlyContainsAssociation
+# This is the parent class of BasicContainsAssociation, DirectlyContainsAssociation and IndirectlyContainsAssociation
 module ActiveFedora
   module Associations
     class ContainsAssociation < CollectionAssociation #:nodoc:
+      def insert_record(record, force = true, validate = true)
+        if force
+          record.save!
+        else
+          record.save(validate: validate)
+        end
+      end
+
       def reader
         @records ||= ContainerProxy.new(self)
       end
@@ -27,6 +35,16 @@ module ActiveFedora
           raise "Can't get uri. Owner isn't saved" if @owner.new_record?
           "#{@owner.uri}/#{@reflection.name}"
         end
+
+      private
+
+        def delete_records(records, method)
+          if method == :destroy
+            records.each(&:destroy)
+          else
+            records.each(&:delete)
+          end
+        end
     end
   end
 end

data/lib/active_fedora/associations/directly_contains_association.rb

@@ -3,11 +3,7 @@ module ActiveFedora
     class DirectlyContainsAssociation < ContainsAssociation #:nodoc:
       def insert_record(record, force = true, validate = true)
         container.save!
-        if force
-          record.save!
-        else
-          record.save(validate: validate)
-        end
+        super
       end
 
       def find_target
@@ -39,16 +35,6 @@ module ActiveFedora
           record.uri = ActiveFedora::Base.id_to_uri(container.mint_id)
           set_inverse_instance(record)
         end
-
-      private
-
-        def delete_records(records, method)
-          if method == :destroy
-            records.each(&:destroy)
-          else
-            records.each(&:delete)
-          end
-        end
     end
   end
 end

data/lib/active_fedora/associations/has_subresource_association.rb

@@ -0,0 +1,61 @@
+module ActiveFedora
+  module Associations
+    class HasSubresourceAssociation < SingularAssociation #:nodoc:
+      # Implements the reader method, e.g. foo.bar for Foo.has_one :bar
+      def reader(force_reload = false)
+        super || build
+      end
+
+      def find_target
+        find_or_initialize_target do |record|
+          configure_datastream(record) if reflection.options[:block]
+        end
+      end
+
+      def target_uri
+        "#{owner.id}/#{reflection.name}"
+      end
+
+      private
+
+        def raise_on_type_mismatch!(record)
+          return if record.is_a? LoadableFromJson::SolrBackedMetadataFile
+          super
+        end
+
+        def find_or_initialize_target(&block)
+          if reflection.klass < ActiveFedora::File
+            reflection.build_association(target_uri, &block)
+          else
+            reflection.klass.find(target_uri)
+          end
+        rescue ActiveFedora::ObjectNotFoundError
+          reflection.build_association(target_uri, &block)
+        end
+
+        def replace(record)
+          if record
+            raise_on_type_mismatch!(record)
+            @updated = true
+          end
+
+          self.target = record
+        end
+
+        def new_record(method, attributes)
+          record = super
+          configure_datastream(record)
+          record
+        end
+
+        def configure_datastream(record)
+          # If you called has_metadata with a block, pass the block into the File class
+          if reflection.options[:block].class == Proc
+            reflection.options[:block].call(record)
+          end
+          return unless record.new_record? && reflection.options[:autocreate]
+          record.datastream_will_change!
+        end
+    end
+  end
+end

data/lib/active_fedora/attached_files.rb

@@ -132,7 +132,7 @@ module ActiveFedora
       def create_singleton_association(file_path)
         undeclared_files << file_path.to_sym
 
-        association = Associations::BasicContainsAssociation.new(self, Reflection::ContainsReflection.new(file_path, nil, { class_name: 'ActiveFedora::File' }, self.class))
+        association = Associations::HasSubresourceAssociation.new(self, Reflection::HasSubresourceReflection.new(file_path, nil, { class_name: 'ActiveFedora::File' }, self.class))
         @association_cache[file_path.to_sym] = association
 
         singleton_class.send :define_method, accessor_name(file_path) do
@@ -156,13 +156,10 @@ module ActiveFedora
       end
 
       module ClassMethods
-        extend Deprecation
-        self.deprecation_horizon = 'active-fedora version 10.0'
-
         def ds_specs
+          Deprecation.warn(self, "ds_specs is deprecated and will be removed in ActiveFedora 10.0")
           child_resource_reflections
         end
-        deprecation_deprecate :ds_specs
 
         # This method is used to specify the details of a datastream.
         # You can pass the name as the first argument and a hash of options as the second argument
@@ -177,6 +174,7 @@ module ActiveFedora
         # @option args [Boolean] :autocreate Always create this datastream on new objects
         # @yield block executed by some kinds of datastreams
         def has_metadata(*args, &block)
+          Deprecation.warn(self, "has_metadata is deprecated and will be removed in ActiveFedora 10.0. Use has_subresource instead.")
           if args.first.is_a? String
             name = args.first
             args = args[1] || {}
@@ -187,9 +185,8 @@ module ActiveFedora
           name = args.delete(:name)
           raise ArgumentError, "You must provide a :type property for the datastream '#{name}'" unless args[:type]
           args[:class_name] = args.delete(:type).to_s
-          contains(name, args, &block)
+          has_subresource(name, args, &block)
         end
-        deprecation_deprecate :has_metadata
 
         # @overload has_file_datastream(name, args)
         #   Declares a file datastream exists for objects of this type
@@ -204,6 +201,7 @@ module ActiveFedora
         #     @option args :type (ActiveFedora::File) The class the datastream should have
         #     @option args [Boolean] :autocreate Always create this datastream on new objects
         def has_file_datastream(*args)
+          Deprecation.warn(self, "has_file_datastream is deprecated and will be removed in ActiveFedora 10.0. Use has_subresource instead.")
           if args.first.is_a? String
             name = args.first
             args = args[1] || {}
@@ -213,9 +211,8 @@ module ActiveFedora
           end
           name = args.delete(:name)
           args[:class_name] = args.delete(:type).to_s
-          contains(name, args)
+          has_subresource(name, args)
         end
-        deprecation_deprecate :has_file_datastream
       end
   end
 end

data/lib/active_fedora/autosave_association.rb

@@ -75,7 +75,7 @@ module ActiveFedora
   module AutosaveAssociation
     extend ActiveSupport::Concern
 
-    ASSOCIATION_TYPES = [:has_many, :belongs_to, :has_and_belongs_to_many, :directly_contains, :indirectly_contains].freeze
+    ASSOCIATION_TYPES = [:has_many, :belongs_to, :has_and_belongs_to_many, :directly_contains, :indirectly_contains, :is_a_container].freeze
 
     module AssociationBuilderExtension #:nodoc:
       def self.valid_options

data/lib/active_fedora/base.rb

@@ -50,7 +50,6 @@ module ActiveFedora
     include Versionable
     include LoadableFromJson
     include Schema
-    include Pathing
     include Aggregation::BaseExtension
   end
 

data/lib/active_fedora/common.rb

@@ -1,6 +1,7 @@
 module ActiveFedora
   module Common
     extend ActiveSupport::Concern
+    include Pathing
 
     module ClassMethods
       def initialize_generated_modules # :nodoc:

data/lib/active_fedora/fedora.rb

@@ -18,6 +18,8 @@ module ActiveFedora
 
     def initialize(config)
       @config = config
+
+      validate_options
     end
 
     def host
@@ -42,7 +44,6 @@ module ActiveFedora
 
     def connection
       @connection ||= begin
-        init_base_path
         build_connection
       end
     end
@@ -51,6 +52,10 @@ module ActiveFedora
       @clean_connection ||= CleanConnection.new(connection)
     end
 
+    def caching_connection(options = {})
+      CachingConnection.new(authorized_connection, options)
+    end
+
     def ldp_resource_service
       @service ||= LdpResourceService.new(connection)
     end
@@ -58,22 +63,6 @@ module ActiveFedora
     SLASH = '/'.freeze
     BLANK = ''.freeze
 
-    # Call this to create a Container Resource to act as the base path for this connection
-    def init_base_path
-      return if @initialized
-      connection = build_connection
-
-      connection.head(root_resource_path)
-      ActiveFedora::Base.logger.info "Attempted to init base path `#{root_resource_path}`, but it already exists" if ActiveFedora::Base.logger
-      @initialized = true
-      false
-    rescue Ldp::NotFound
-      unless host.downcase.end_with?("/rest")
-        ActiveFedora::Base.logger.warn "Fedora URL (#{host}) does not end with /rest. This could be a problem. Check your fedora.yml config"
-      end
-      @initialized = connection.put(root_resource_path, BLANK).success?
-    end
-
     # Remove a leading slash from the base_path
     def root_resource_path
       @root_resource_path ||= base_path.sub(SLASH, BLANK)
@@ -83,8 +72,8 @@ module ActiveFedora
       # The InboundRelationConnection does provide more data, useful for
       # things like ldp:IndirectContainers, but it's imposes a significant
       # performance penalty on every request
-      #   @connection ||= InboundRelationConnection.new(CachingConnection.new(authorized_connection))
-      CachingConnection.new(authorized_connection, omit_ldpr_interaction_model: true)
+      #   @connection ||= InboundRelationConnection.new(caching_connection(omit_ldpr_interaction_model: true))
+      InitializingConnection.new(caching_connection(omit_ldpr_interaction_model: true), root_resource_path)
     end
 
     def authorized_connection
@@ -94,5 +83,11 @@ module ActiveFedora
       connection.basic_auth(user, password)
       connection
     end
+
+    def validate_options
+      unless host.downcase.end_with?("/rest")
+        ActiveFedora::Base.logger.warn "Fedora URL (#{host}) does not end with /rest. This could be a problem. Check your fedora.yml config"
+      end
+    end
   end
 end