valkyrie 0.1.0 → 1.0.0.rc1

data/lib/valkyrie/storage.rb

@@ -1,5 +1,34 @@
 # frozen_string_literal: true
 module Valkyrie
+  # This is a namespacing module for storage adapters, which store binary content as per the DataMapper pattern
+  #  https://en.wikipedia.org/wiki/Data_mapper_pattern
+  #
+  # @note These storage adapters do not store metadata
+  #       See Valkyrie::Persistence for persisting metadata.
+  #
+  # @example Register storage adapters in an initializer using Valkyrie::StorageAdapter.register
+  #
+  #    # Store files on local disk
+  #    Valkyrie::StorageAdapter.register(
+  #      Valkyrie::Storage::Disk.new(base_path: '/path/to/files'),
+  #      :disk
+  #    )
+  #
+  # @example Retrieve a registered persister using Valkyrie::StorageAdapter.find
+  #
+  #   storage = Valkyrie.config.storage_adapter  # default
+  #   storage = Valkyrie::StorageAdapter.find(:disk)  # named
+  #
+  # @example Save/upload a file
+  #
+  #   file_set = FileSet.new title: 'page 1'
+  #   upload = ActionDispatch::Http::UploadedFile.new tempfile: File.new('/path/to/files/file1.tiff'), filename: 'file1.tiff', type: 'image/tiff'
+  #   file = storage.upload(file: upload, resource: file_set)
+  #   file_set.file_identifiers << file.id
+  #   persister.save(resource: file_set)
+  #
+  # @see https://github.com/samvera-labs/valkyrie/wiki/Storage-&-Files
+  # @see lib/valkyrie/specs/shared_specs/storage_adapter.rb
   module Storage
     require 'valkyrie/storage/disk'
     require 'valkyrie/storage/fedora'

data/lib/valkyrie/storage/disk.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 module Valkyrie::Storage
+  # Implements the DataMapper Pattern to store binary data on disk
   class Disk
     attr_reader :base_path, :path_generator, :file_mover
     def initialize(base_path:, path_generator: BucketedStorage, file_mover: FileUtils.method(:mv))
@@ -9,10 +10,11 @@ module Valkyrie::Storage
     end
 
     # @param file [IO]
+    # @param original_filename [String]
     # @param resource [Valkyrie::Resource]
     # @return [Valkyrie::StorageAdapter::File]
-    def upload(file:, resource: nil)
-      new_path = path_generator.generate(resource: resource, file: file)
+    def upload(file:, original_filename:, resource: nil)
+      new_path = path_generator.generate(resource: resource, file: file, original_filename: original_filename)
       FileUtils.mkdir_p(new_path.parent)
       file_mover.call(file.path, new_path)
       find_by(id: Valkyrie::ID.new("disk://#{new_path}"))
@@ -31,9 +33,18 @@ module Valkyrie::Storage
     # Return the file associated with the given identifier
     # @param id [Valkyrie::ID]
     # @return [Valkyrie::StorageAdapter::File]
+    # @raise Valkyrie::StorageAdapter::FileNotFound if nothing is found
     def find_by(id:)
-      return unless handles?(id: id)
       Valkyrie::StorageAdapter::File.new(id: Valkyrie::ID.new(id.to_s), io: ::File.open(file_path(id), 'rb'))
+    rescue Errno::ENOENT
+      raise Valkyrie::StorageAdapter::FileNotFound
+    end
+
+    # Delete the file on disk associated with the given identifier.
+    # @param id [Valkyrie::ID]
+    def delete(id:)
+      path = file_path(id)
+      FileUtils.rm_rf(path) if File.exist?(path)
     end
 
     class BucketedStorage
@@ -42,8 +53,9 @@ module Valkyrie::Storage
         @base_path = base_path
       end
 
-      def generate(resource:, file:)
-        Pathname.new(base_path).join(*bucketed_path(resource.id)).join(file.original_filename)
+      def generate(resource:, file:, original_filename:)
+        raise ArgumentError, "original_filename must be provided" unless original_filename
+        Pathname.new(base_path).join(*bucketed_path(resource.id)).join(original_filename)
       end
 
       def bucketed_path(id)

data/lib/valkyrie/storage/fedora.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 module Valkyrie::Storage
+  # Implements the DataMapper Pattern to store binary data in fedora
   class Fedora
     attr_reader :connection
     PROTOCOL = 'fedora://'
@@ -16,18 +17,23 @@ module Valkyrie::Storage
     # Return the file associated with the given identifier
     # @param id [Valkyrie::ID]
     # @return [Valkyrie::StorageAdapter::StreamFile]
+    # @raise Valkyrie::StorageAdapter::FileNotFound if nothing is found
     def find_by(id:)
       Valkyrie::StorageAdapter::StreamFile.new(id: id, io: response(id: id))
+    rescue ::Ldp::Gone
+      raise Valkyrie::StorageAdapter::FileNotFound
     end
 
     # @param file [IO]
+    # @param original_filename [String]
     # @param resource [Valkyrie::Resource]
     # @return [Valkyrie::StorageAdapter::StreamFile]
-    def upload(file:, resource:)
+    def upload(file:, original_filename:, resource:)
       # TODO: this is a very naive aproach. Change to PCDM
       identifier = resource.id.to_uri + '/original'
       ActiveFedora::File.new(identifier) do |af|
         af.content = file
+        af.original_name = original_filename
         af.save!
         af.metadata.set_value(:type, af.metadata.type + [::RDF::URI('http://pcdm.org/use#OriginalFile')])
         af.metadata.save
@@ -35,6 +41,12 @@ module Valkyrie::Storage
       find_by(id: Valkyrie::ID.new(identifier.to_s.sub(/^.+\/\//, PROTOCOL)))
     end
 
+    # Delete the file in Fedora associated with the given identifier.
+    # @param id [Valkyrie::ID]
+    def delete(id:)
+      ActiveFedora::File.new(active_fedora_identifier(id: id)).ldp_source.delete
+    end
+
     class IOProxy
       # @param response [Ldp::Resource::BinarySource]
       attr_reader :size
@@ -57,6 +69,7 @@ module Valkyrie::Storage
       # @return [IOProxy]
       def response(id:)
         af_file = ActiveFedora::File.new(active_fedora_identifier(id: id))
+        raise Valkyrie::StorageAdapter::FileNotFound if af_file.ldp_source.new?
         IOProxy.new(af_file.ldp_source, af_file.size)
       end
 

data/lib/valkyrie/storage/memory.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 module Valkyrie::Storage
+  # Implements the DataMapper Pattern to store binary data in memory
+  #
+  # @note this adapter is used primarily for testing, and is not recommended
+  #   in cases where you want to preserve real data
   class Memory
     attr_reader :cache
     def initialize
@@ -7,9 +11,10 @@ module Valkyrie::Storage
     end
 
     # @param file [IO]
+    # @param original_filename [String]
     # @param resource [Valkyrie::Resource]
     # @return [Valkyrie::StorageAdapter::StreamFile]
-    def upload(file:, resource: nil)
+    def upload(file:, original_filename:, resource: nil)
       identifier = Valkyrie::ID.new("memory://#{resource.id}")
       cache[identifier] = Valkyrie::StorageAdapter::StreamFile.new(id: identifier, io: file)
     end
@@ -17,8 +22,9 @@ module Valkyrie::Storage
     # Return the file associated with the given identifier
     # @param id [Valkyrie::ID]
     # @return [Valkyrie::StorageAdapter::StreamFile]
+    # @raise Valkyrie::StorageAdapter::FileNotFound if nothing is found
     def find_by(id:)
-      return unless handles?(id: id) && cache[id]
+      raise Valkyrie::StorageAdapter::FileNotFound unless cache[id]
       cache[id]
     end
 
@@ -27,5 +33,12 @@ module Valkyrie::Storage
     def handles?(id:)
       id.to_s.start_with?("memory://")
     end
+
+    # Delete the file on disk associated with the given identifier.
+    # @param id [Valkyrie::ID]
+    def delete(id:)
+      cache.delete(id)
+      nil
+    end
   end
 end

data/lib/valkyrie/storage_adapter.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 module Valkyrie
+  # StorageAdapter is the primary DataMapper object for binary content persistence.
+  #  Used to register and locate adapters for individual
+  #  storage backends (such as fedora, disk, etc)
   class StorageAdapter
+    class FileNotFound < StandardError; end
     class_attribute :storage_adapters
     self.storage_adapters = {}
     class << self
@@ -21,8 +25,11 @@ module Valkyrie
       # Find the adapter associated with the provided short name
       # @param short_name [Symbol]
       # @return [Valkyrie::StorageAdapter]
+      # @raise Valkyrie::StorageAdapter::AdapterNotFoundError when we are unable to find the named adapter
       def find(short_name)
-        storage_adapters[short_name]
+        storage_adapters.fetch(short_name)
+      rescue KeyError
+        raise "Unable to find #{self} with short_name of #{short_name.inspect}. Registered adapters are #{storage_adapters.keys.inspect}"
       end
 
       # Search through all registered storage adapters until it finds one that
@@ -30,10 +37,27 @@ module Valkyrie
       # with the given identifier.
       # @param id [Valkyrie::ID]
       # @return [Valkyrie::StorageAdapter::File]
+      # @raise Valkyrie::StorageAdapter::FileNotFound if nothing is found
       def find_by(id:)
+        adapter_for(id: id).find_by(id: id)
+      end
+
+      # Search through all registered storage adapters until it finds one that
+      # can handle the passed in identifier.  Then call delete on that adapter
+      # with the given identifier.
+      # @param id [Valkyrie::ID]
+      def delete(id:)
+        adapter_for(id: id).delete(id: id)
+      end
+
+      # Return the registered storage adapter which handles the given ID.
+      # @param id [Valkyrie::ID]
+      # @return [Valkyrie::StorageAdapter]
+      def adapter_for(id:)
+        # TODO: Determine the appropriate response when we have an unhandled :id
         storage_adapters.values.find do |storage_adapter|
           storage_adapter.handles?(id: id)
-        end.find_by(id: id)
+        end
       end
     end
 
@@ -49,7 +73,6 @@ module Valkyrie
         Pathname.new(io.path)
       end
 
-      # @param id [Valkyre::ID]
       # @param digests [Array<Digest>]
       # @return [Array<Digest>]
       def checksum(digests:)
@@ -61,7 +84,6 @@ module Valkyrie
         digests.map(&:to_s)
       end
 
-      # @param id [Valkyre::ID]
       # @param size [Integer]
       # @param digests [Array<Digest>]
       # @return [Boolean]

data/lib/valkyrie/types.rb

@@ -1,15 +1,43 @@
 # frozen_string_literal: true
 module Valkyrie
-  ##
   # Namespace for Dry::Types types.
+  #  Includes Dry::Types built-in types and defines custom Valkyrie types
+  #
+  # @example Use types in property definitions on a resource
+  #   class Book < Valkyrie::Resource
+  #     attribute :id, Valkyrie::Types::ID.optional
+  #     attribute :title, Valkyrie::Types::Set.optional  # default type if none is specified
+  #     attribute :member_ids, Valkyrie::Types::Array
+  #   end
+  #
+  # @note Not all Dry::Types built-in types are supported in Valkyrie
+  # @see https://github.com/samvera-labs/valkyrie/wiki/Supported-Data-Types List of types supported in Valkyrie
   module Types
     include Dry::Types.module
+
     # Valkyrie::ID
     ID = Dry::Types::Definition
          .new(Valkyrie::ID)
          .constructor do |input|
-           Valkyrie::ID.new(input)
-         end
+      if input.respond_to?(:each)
+        # Solr::ORMConverter tries to pass an array of Valkyrie::IDs
+        Valkyrie::ID.new(input.first)
+      else
+        Valkyrie::ID.new(input)
+      end
+    end
+
+    # Valkyrie::URI
+    URI = Dry::Types::Definition
+          .new(RDF::URI)
+          .constructor do |input|
+      if input.present?
+        RDF::URI.new(input.to_s)
+      else
+        input
+      end
+    end
+
     # Used for casting {Valkyrie::Resources} if possible.
     Anything = Valkyrie::Types::Any.constructor do |value|
       if value.respond_to?(:fetch) && value.fetch(:internal_resource, nil)
@@ -18,13 +46,43 @@ module Valkyrie
         value
       end
     end
+
+    Array = Dry::Types['array'].constructor do |value|
+      if value.is_a?(::Hash)
+        if value.empty?
+          []
+        else
+          [value]
+        end
+      else
+        ::Array.wrap(value)
+      end
+    end.default([].freeze)
+
     # Represents an array of unique values.
-    Set = Valkyrie::Types::Coercible::Array.constructor do |value|
-      value.select(&:present?).uniq.map do |val|
+    Set = Array.constructor do |value|
+      value = Array[value]
+      clean_values = value.reject do |val|
+        val == '' || (val.is_a?(Valkyrie::ID) && val.to_s == '')
+      end.reject(&:nil?).uniq
+
+      clean_values.map do |val|
         Anything[val]
       end
-    end.default([])
-    Array = Dry::Types['coercible.array'].default([])
+    end.default([].freeze)
+
+    module ArrayDefault
+      def of(type)
+        super.default([].freeze)
+      end
+
+      def member(type)
+        super.default([].freeze)
+      end
+    end
+    Array.singleton_class.include(ArrayDefault)
+    Set.singleton_class.include(ArrayDefault)
+
     # Used for when an input may be an array, but the output needs to be a
     # single string.
     SingleValuedString = Valkyrie::Types::String.constructor do |value|

data/lib/valkyrie/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Valkyrie
-  VERSION = "0.1.0"
+  VERSION = "1.0.0.rc1"
 end

data/solr/config/_rest_managed.json

@@ -0,0 +1,3 @@
+{
+  "initArgs":{},
+  "managedList":[]}

data/solr/config/admin-extra.html

@@ -0,0 +1,31 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- The content of this page will be statically included into the top
+of the admin page.  Uncomment this as an example to see there the content
+will show up.
+
+<hr>
+<i>This line will appear before the first table</i>
+<tr>
+<td colspan="2">
+This row will be appended to the end of the first table
+</td>
+</tr>
+<hr>
+
+-->

data/solr/config/elevate.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- If this file is found in the config directory, it will only be
+     loaded once at startup.  If it is found in Solr's data
+     directory, it will be re-loaded every commit.
+-->
+
+<elevate>
+ <query text="foo bar">
+  <doc id="1" />
+  <doc id="2" />
+  <doc id="3" />
+ </query>
+ 
+ <query text="ipod">
+   <doc id="MA147LL/A" />  <!-- put the actual ipod at the top -->
+   <doc id="IW-02" exclude="true" /> <!-- exclude this cable -->
+ </query>
+ 
+</elevate>

data/solr/config/mapping-ISOLatin1Accent.txt

@@ -0,0 +1,246 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Syntax:
+#   "source" => "target"
+#     "source".length() > 0 (source cannot be empty.)
+#     "target".length() >= 0 (target can be empty.)
+
+# example:
+#   "??" => "A"
+#   "\u00C0" => "A"
+#   "\u00C0" => "\u0041"
+#   "??" => "ss"
+#   "\t" => " "
+#   "\n" => ""
+
+# ?? => A
+"\u00C0" => "A"
+
+# ?? => A
+"\u00C1" => "A"
+
+# ?? => A
+"\u00C2" => "A"
+
+# ?? => A
+"\u00C3" => "A"
+
+# ?? => A
+"\u00C4" => "A"
+
+# ?? => A
+"\u00C5" => "A"
+
+# ?? => AE
+"\u00C6" => "AE"
+
+# ?? => C
+"\u00C7" => "C"
+
+# ?? => E
+"\u00C8" => "E"
+
+# ?? => E
+"\u00C9" => "E"
+
+# ?? => E
+"\u00CA" => "E"
+
+# ?? => E
+"\u00CB" => "E"
+
+# ?? => I
+"\u00CC" => "I"
+
+# ?? => I
+"\u00CD" => "I"
+
+# ?? => I
+"\u00CE" => "I"
+
+# ?? => I
+"\u00CF" => "I"
+
+# ?? => IJ
+"\u0132" => "IJ"
+
+# ?? => D
+"\u00D0" => "D"
+
+# ?? => N
+"\u00D1" => "N"
+
+# ?? => O
+"\u00D2" => "O"
+
+# ?? => O
+"\u00D3" => "O"
+
+# ?? => O
+"\u00D4" => "O"
+
+# ?? => O
+"\u00D5" => "O"
+
+# ?? => O
+"\u00D6" => "O"
+
+# ?? => O
+"\u00D8" => "O"
+
+# ?? => OE
+"\u0152" => "OE"
+
+# ??
+"\u00DE" => "TH"
+
+# ?? => U
+"\u00D9" => "U"
+
+# ?? => U
+"\u00DA" => "U"
+
+# ?? => U
+"\u00DB" => "U"
+
+# ?? => U
+"\u00DC" => "U"
+
+# ?? => Y
+"\u00DD" => "Y"
+
+# ?? => Y
+"\u0178" => "Y"
+
+# ?? => a
+"\u00E0" => "a"
+
+# ?? => a
+"\u00E1" => "a"
+
+# ?? => a
+"\u00E2" => "a"
+
+# ?? => a
+"\u00E3" => "a"
+
+# ?? => a
+"\u00E4" => "a"
+
+# ?? => a
+"\u00E5" => "a"
+
+# ?? => ae
+"\u00E6" => "ae"
+
+# ?? => c
+"\u00E7" => "c"
+
+# ?? => e
+"\u00E8" => "e"
+
+# ?? => e
+"\u00E9" => "e"
+
+# ?? => e
+"\u00EA" => "e"
+
+# ?? => e
+"\u00EB" => "e"
+
+# ?? => i
+"\u00EC" => "i"
+
+# ?? => i
+"\u00ED" => "i"
+
+# ?? => i
+"\u00EE" => "i"
+
+# ?? => i
+"\u00EF" => "i"
+
+# ?? => ij
+"\u0133" => "ij"
+
+# ?? => d
+"\u00F0" => "d"
+
+# ?? => n
+"\u00F1" => "n"
+
+# ?? => o
+"\u00F2" => "o"
+
+# ?? => o
+"\u00F3" => "o"
+
+# ?? => o
+"\u00F4" => "o"
+
+# ?? => o
+"\u00F5" => "o"
+
+# ?? => o
+"\u00F6" => "o"
+
+# ?? => o
+"\u00F8" => "o"
+
+# ?? => oe
+"\u0153" => "oe"
+
+# ?? => ss
+"\u00DF" => "ss"
+
+# ?? => th
+"\u00FE" => "th"
+
+# ?? => u
+"\u00F9" => "u"
+
+# ?? => u
+"\u00FA" => "u"
+
+# ?? => u
+"\u00FB" => "u"
+
+# ?? => u
+"\u00FC" => "u"
+
+# ?? => y
+"\u00FD" => "y"
+
+# ?? => y
+"\u00FF" => "y"
+
+# ??? => ff
+"\uFB00" => "ff"
+
+# ??? => fi
+"\uFB01" => "fi"
+
+# ??? => fl
+"\uFB02" => "fl"
+
+# ??? => ffi
+"\uFB03" => "ffi"
+
+# ??? => ffl
+"\uFB04" => "ffl"
+
+# ??? => ft
+"\uFB05" => "ft"
+
+# ??? => st
+"\uFB06" => "st"