Contents

module ROCrate
  ##
  # A data entity that represents a single file.
  class File < DataEntity
    def self.format_local_id(id)
      super.chomp('/')
    end

    ##
    # Create a new ROCrate::File. PLEASE NOTE, the new file will not be added to the crate. To do this, call
    # Crate#add_data_entity, or just use Crate#add_file.
    #
    # @param crate [Crate] The RO-Crate that owns this file.
    # @param source [String, Pathname, ::File, URI, nil, #read] The source on the disk (or on the internet if a URI) where this file will be read.
    # @param crate_path [String] The relative path within the RO-Crate where this file will be written.
    # @param properties [Hash{String => Object}] A hash of JSON-LD properties to associate with this file.
    def initialize(crate, source, crate_path = nil, properties = {})
      super(crate, source, crate_path, properties)

      if @source.is_a?(URI) && @source.absolute?
        @entry = RemoteEntry.new(@source)
      else
        @entry = Entry.new(@source)
      end
    end

    ##
    # The "physical" source file that will be read.
    #
    # @return [Entry] An Entry pointing to the source.
    def source
      @entry
    end

    ##
    # The "payload". A map with a single key and value, of the relative filepath within the crate, to the source on disk
    # where the actual bytes of the file can be read. Blank if remote.
    #
    # (for compatibility with Directory#entries)
    #
    # @return [Hash{String => Entry}>] The key is the location within the crate, and the value is an Entry.
    def payload
      remote? ? {} : { filepath => source }
    end

    def remote?
      @entry.remote?
    end

    private

    def default_properties
      super.merge(
        '@id' => "#{SecureRandom.uuid}",
        '@type' => 'File'
      )
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ro-crate-0.5.3	lib/ro_crate/model/file.rb
ro-crate-0.5.2	lib/ro_crate/model/file.rb
ro-crate-0.5.1	lib/ro_crate/model/file.rb