active-fedora 9.1.2 → 9.2.0.rc1

data/lib/active_fedora/file.rb

@@ -1,31 +1,42 @@
 require 'deprecation'
 
 module ActiveFedora
-
-  #This class represents a Fedora datastream
+  # An LDP NonRDFSource. The base class for a bytestream stored in the repository.
   class File
-    include AttributeMethods # allows 'content' to be tracked
-    include ActiveModel::Dirty
-    extend Deprecation
+    extend ActiveModel::Callbacks
+    extend ActiveSupport::Autoload
     extend ActiveTriples::Properties
+    extend Deprecation
+    extend Querying
+
+    autoload :Streaming
+    autoload :Attributes
+
+    include ActiveFedora::File::Attributes
+    include ActiveFedora::File::Streaming
+    include ActiveFedora::Persistence
+    include ActiveFedora::Versionable
+    include ActiveModel::Dirty
+    include AttributeMethods # allows 'content' to be tracked
+    include Identifiable
+    include Scoping
+
     generate_method 'content'
 
-    extend ActiveModel::Callbacks
     define_model_callbacks :save, :create, :destroy
     define_model_callbacks :initialize, only: :after
 
-    # @param parent_or_url_or_hash [ActiveFedora::Base, String, Hash, NilClass] the parent resource or the URI of this resource
+    # @param parent_or_url_or_hash [ActiveFedora::Base, RDF::URI, String, Hash, NilClass] the parent resource or the URI of this resource
     # @param path [String] the path partial relative to the resource
     # @param options [Hash]
-    def initialize(parent_or_url_or_hash = nil, path=nil, options={})
+    # @yield [self] Yields self
+    # @yieldparam [File] self the newly created file
+    def initialize(parent_or_url_or_hash = nil, path=nil, options={}, &block)
       case parent_or_url_or_hash
       when Hash
-        content = ''
-        @ldp_source = Ldp::Resource::BinarySource.new(ldp_connection, nil, content, ActiveFedora.fedora.host + ActiveFedora.fedora.base_path)
-      when nil, String
-      #TODO this is similar to Core#build_ldp_resource
-        content = ''
-        @ldp_source = Ldp::Resource::BinarySource.new(ldp_connection, parent_or_url_or_hash, content, ActiveFedora.fedora.host + ActiveFedora.fedora.base_path)
+        @ldp_source = build_ldp_resource_via_uri
+      when nil, String, ::RDF::URI
+        @ldp_source = build_ldp_resource_via_uri parent_or_url_or_hash
       when ActiveFedora::Base
         Deprecation.warn File, "Initializing a file by passing a container is deprecated. Initialize with a uri instead. This capability will be removed in active-fedora 10.0"
         uri = if parent_or_url_or_hash.uri.kind_of?(::RDF::URI) && parent_or_url_or_hash.uri.value.empty?
@@ -33,13 +44,23 @@ module ActiveFedora
         else
           "#{parent_or_url_or_hash.uri}/#{path}"
         end
-        @ldp_source = Ldp::Resource::BinarySource.new(ldp_connection, uri, nil, ActiveFedora.fedora.host + ActiveFedora.fedora.base_path)
+        @ldp_source = build_ldp_resource_via_uri(uri, nil)
 
       else
-        raise "The first argument to #{self} must be a String or an ActiveFedora::Base. You provided a #{parent_or_url.class}"
+        raise "The first argument to #{self} must be a String or an ActiveFedora::Base. You provided a #{parent_or_url_or_hash.class}"
       end
 
       @attributes = {}.with_indifferent_access
+      yield self if block_given?
+    end
+
+    # @return [true, false] true if the objects are equal or when the objects have uris
+    #   and the uris are equal
+    def ==(comparison_object)
+      super ||
+        comparison_object.instance_of?(self.class) &&
+        uri.value.present? &&
+        comparison_object.uri == uri
     end
 
     def ldp_source
@@ -55,19 +76,14 @@ module ActiveFedora
       ActiveFedora.fedora.connection
     end
 
-    # TODO this is like FedoraAttributes#uri
-    def uri
-      ldp_source.subject
-    end
-
-    # If this file have a parent with ldp#contains, we know it is not new.
+    # If this file has a parent with ldp#contains, we know it is not new.
     # By tracking exists we prevent an unnecessary HEAD request.
     def new_record?
       !@exists && ldp_source.new?
     end
 
     def uri= uri
-      @ldp_source = Ldp::Resource::BinarySource.new(ldp_connection, uri, '', ActiveFedora.fedora.host + ActiveFedora.fedora.base_path)
+      @ldp_source = build_ldp_resource_via_uri(uri)
     end
 
     # If we know the record to exist (parent has LDP:contains), we can avoid unnecessary HEAD requests
@@ -78,15 +94,16 @@ module ActiveFedora
     # When restoring from previous versions, we need to reload certain attributes from Fedora
     def reload
       return if new_record?
-      reset
+      refresh
     end
 
-    def reset
-      @ldp_source = Ldp::Resource::BinarySource.new(ldp_connection, uri)
+    def refresh
+      @ldp_source = build_ldp_resource_via_uri(uri)
       @original_name = nil
       @mime_type = nil
       @content = nil
       @metadata = nil
+      changed_attributes.clear
     end
 
     def check_fixity
@@ -110,45 +127,10 @@ module ActiveFedora
       @ds_content ||= retrieve_content
     end
 
-    attr_writer :mime_type
-    def mime_type
-      @mime_type ||= fetch_mime_type unless new_record?
-      @mime_type || default_mime_type
-    end
-
     def metadata
       @metadata ||= ActiveFedora::WithMetadata::MetadataNode.new(self)
     end
 
-    def original_name
-      @original_name ||= fetch_original_name_from_headers
-    end
-
-    def digest
-      response = metadata.ldp_source.graph.query(predicate: ActiveFedora::RDF::Fcrepo4.digest)
-      response.map(&:object)
-    end
-
-    def persisted_size
-      ldp_source.head.headers['Content-Length'].to_i unless new_record?
-    end
-
-    def dirty_size
-      content.size if changed? && content.respond_to?(:size)
-    end
-
-    def size
-      dirty_size || persisted_size
-    end
-
-    def has_content?
-      size && size > 0
-    end
-
-    def empty?
-      !has_content?
-    end
-
     def content_changed?
       return true if new_record? and !local_or_remote_content(false).blank?
       local_or_remote_content(false) != @ds_content
@@ -158,10 +140,6 @@ module ActiveFedora
       super || content_changed?
     end
 
-    def original_name= name
-      @original_name = name
-    end
-
     def inspect
       "#<#{self.class} uri=\"#{uri}\" >"
     end
@@ -189,75 +167,73 @@ module ActiveFedora
       solr_doc
     end
 
-    protected
-
-    def default_mime_type
-      'text/plain'
+    def content= string_or_io
+      content_will_change! unless @content == string_or_io
+      @content = string_or_io
     end
 
-    # The string to prefix all solr fields with. Override this method if you want
-    # a prefix other than the default
-    def prefix(path)
-      path ? "#{path.underscore}__" : ''
-    end
-
-    def fetch_original_name_from_headers
-      return if new_record?
-      m = ldp_source.head.headers['Content-Disposition'].match(/filename="(?<filename>[^"]*)";/)
-      URI.decode(m[:filename])
+    def content
+      local_or_remote_content(true)
     end
 
-    def fetch_mime_type
-      ldp_source.head.headers['Content-Type']
+    def readonly?
+      false
     end
 
-    private
+    protected
 
-    def links
-      @links ||= Ldp::Response.links(ldp_source.head)
-    end
+      # The string to prefix all solr fields with. Override this method if you want
+      # a prefix other than the default
+      def prefix(path)
+        path ? "#{path.underscore}__" : ''
+      end
 
+    private
 
-    # Rack::Test::UploadedFile is often set via content=, however it's not an IO, though it wraps an io object.
-    def behaves_like_io?(obj)
-      [IO, Tempfile, StringIO].any? { |klass| obj.kind_of? klass } || (defined?(Rack) && obj.is_a?(Rack::Test::UploadedFile))
-    end
+      def self.relation
+        FileRelation.new(self)
+      end
 
-    # Persistence is an included module, so that we can include other modules which override these methods
-    module Persistence
-      def content= string_or_io
-        content_will_change! unless @content == string_or_io
-        @content = string_or_io
+      # Rack::Test::UploadedFile is often set via content=, however it's not an IO, though it wraps an io object.
+      def behaves_like_io?(obj)
+        [IO, Tempfile, StringIO].any? { |klass| obj.kind_of? klass } || (defined?(Rack) && obj.is_a?(Rack::Test::UploadedFile))
       end
 
-      def content
-        local_or_remote_content(true)
+      def retrieve_content
+        ldp_source.get.body
       end
 
-      def save(*)
-        return true unless content_changed?
+      def ldp_headers
         headers = { 'Content-Type'.freeze => mime_type, 'Content-Length'.freeze => content.size.to_s }
         headers['Content-Disposition'.freeze] = "attachment; filename=\"#{URI.encode(@original_name)}\"" if @original_name
+        headers
+      end
 
+      def create_record(options = {})
+        return false if content.nil?
         ldp_source.content = content
-        if new_record?
-          ldp_source.create do |req|
-            req.headers.merge!(headers)
-          end
-        else
-          ldp_source.update do |req|
-            req.headers.merge!(headers)
-          end
+        ldp_source.create do |req|
+          req.headers.merge!(ldp_headers)
         end
-        reset
-        changed_attributes.clear
+        refresh
       end
 
-      def retrieve_content
-        ldp_source.get.body
+      def update_record(options = {})
+        return true unless content_changed?
+        ldp_source.content = content
+        ldp_source.update do |req|
+          req.headers.merge!(ldp_headers)
+        end
+        refresh
       end
 
-      private
+      def build_ldp_resource(id)
+        build_ldp_resource_via_uri self.class.id_to_uri(id)
+      end
+
+      def build_ldp_resource_via_uri(uri=nil, content='')
+        Ldp::Resource::BinarySource.new(ldp_connection, uri, content, ActiveFedora.fedora.host + ActiveFedora.fedora.base_path)
+      end
 
       def uploaded_file?(payload)
         defined?(ActionDispatch::Http::UploadedFile) and payload.instance_of?(ActionDispatch::Http::UploadedFile)
@@ -280,55 +256,7 @@ module ActiveFedora
         end
         @content
       end
-    end
-
-    module Streaming
-      # @param range [String] the Range HTTP header
-      # @return [Stream] an object that responds to each
-      def stream(range = nil)
-        uri = URI.parse(self.uri)
-        FileBody.new(uri, headers(range, authorization_key))
-      end
-
-      # @return [String] current authorization token from Ldp::Client
-      def authorization_key
-        self.ldp_source.client.http.headers.fetch("Authorization", nil)
-      end
-
-      # @param range [String] from #stream
-      # @param key [String] from #authorization_key
-      # @return [Hash]
-      def headers(range, key, result = Hash.new)
-        result["Range"] = range if range
-        result["Authorization"] = key if key
-        result
-      end
 
-      class FileBody
-        attr_reader :uri, :headers
-        def initialize(uri, headers)
-          @uri = uri
-          @headers = headers
-        end
-
-        def each
-          Net::HTTP.start(uri.host, uri.port) do |http|
-            request = Net::HTTP::Get.new uri, headers
-            http.request request do |response|
-
-              raise "Couldn't get data from Fedora (#{uri}). Response: #{response.code}" unless response.is_a?(Net::HTTPSuccess)
-              response.read_body do |chunk|
-                yield chunk
-              end
-            end
-          end
-        end
-      end
-    end
-
-    include ActiveFedora::File::Persistence
-    include ActiveFedora::File::Streaming
-    include ActiveFedora::Versionable
   end
 
 end

data/lib/active_fedora/file/attributes.rb

@@ -0,0 +1,63 @@
+module ActiveFedora::File::Attributes
+
+  attr_writer :mime_type
+
+  def mime_type
+    @mime_type ||= fetch_mime_type
+  end
+
+  def original_name
+    @original_name ||= fetch_original_name
+  end
+
+  def original_name= name
+    @original_name = name
+  end
+
+  def digest
+    response = metadata.ldp_source.graph.query(predicate: ActiveFedora::RDF::Fcrepo4.digest)
+    response.map(&:object)
+  end
+
+  def persisted_size
+    ldp_source.head.headers['Content-Length'].to_i unless new_record?
+  end
+
+  def dirty_size
+    content.size if changed? && content.respond_to?(:size)
+  end
+
+  def size
+    dirty_size || persisted_size
+  end
+
+  def has_content?
+    size && size > 0
+  end
+
+  def empty?
+    !has_content?
+  end
+
+  private
+
+    def links
+      @links ||= Ldp::Response.links(ldp_source.head)
+    end
+
+    def default_mime_type
+      'text/plain'
+    end
+
+    def fetch_mime_type
+      return default_mime_type if new_record?
+      ldp_source.head.headers['Content-Type']
+    end
+
+    def fetch_original_name
+      return if new_record?
+      m = ldp_source.head.headers['Content-Disposition'].match(/filename="(?<filename>[^"]*)";/)
+      URI.decode(m[:filename])
+    end
+
+end

data/lib/active_fedora/file/streaming.rb

@@ -0,0 +1,46 @@
+module ActiveFedora::File::Streaming
+  # @param range [String] the Range HTTP header
+  # @return [Stream] an object that responds to each
+  def stream(range = nil)
+    uri = URI.parse(self.uri)
+    FileBody.new(uri, headers(range, authorization_key))
+  end
+
+  # @param range [String] from #stream
+  # @param key [String] from #authorization_key
+  # @return [Hash]
+  def headers(range, key, result = Hash.new)
+    result["Range"] = range if range
+    result["Authorization"] = key if key
+    result
+  end
+
+  class FileBody
+    attr_reader :uri, :headers
+    def initialize(uri, headers)
+      @uri = uri
+      @headers = headers
+    end
+
+    def each
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        request = Net::HTTP::Get.new uri, headers
+        http.request request do |response|
+
+          raise "Couldn't get data from Fedora (#{uri}). Response: #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+          response.read_body do |chunk|
+            yield chunk
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+    # @return [String] current authorization token from Ldp::Client
+    def authorization_key
+      self.ldp_source.client.http.headers.fetch("Authorization", nil)
+    end
+
+end