valkyrie 0.1.0 → 1.0.0.rc1

data/lib/valkyrie/persistence/solr/persister.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr
   require 'valkyrie/persistence/solr/repository'
+  # Persister for Solr MetadataAdapter.
+  #
+  # Most methods are delegated to {Valkyrie::Persistence::Solr::Repository}
   class Persister
     attr_reader :adapter
     delegate :connection, :resource_factory, to: :adapter
@@ -11,6 +14,14 @@ module Valkyrie::Persistence::Solr
     end
 
     # (see Valkyrie::Persistence::Memory::Persister#save)
+    #
+    # @note Fields are saved using Solr's dynamic fields functionality.
+    #   If the text has length > 1000, it is stored as *_tsim
+    #   otherwise it's stored as *_tsim, *_ssim, and *_tesim
+    #   e.g., a field called 'title' would be stored as 3 solr fields:
+    #     'title_tsim'
+    #     'title_ssim'
+    #     'title_tesim'
     def save(resource:)
       repository([resource]).persist.first
     end
@@ -25,6 +36,11 @@ module Valkyrie::Persistence::Solr
       repository([resource]).delete.first
     end
 
+    def wipe!
+      connection.delete_by_query("*:*")
+      connection.commit
+    end
+
     def repository(resources)
       Valkyrie::Persistence::Solr::Repository.new(resources: resources, connection: connection, resource_factory: resource_factory)
     end

data/lib/valkyrie/persistence/solr/queries.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr
   module Queries
+    MEMBER_IDS = 'member_ids_ssim'
+    MODEL = 'internal_resource_ssim'
     require 'valkyrie/persistence/solr/queries/default_paginator'
     require 'valkyrie/persistence/solr/queries/find_all_query'
     require 'valkyrie/persistence/solr/queries/find_by_id_query'
+    require 'valkyrie/persistence/solr/queries/find_many_by_ids_query'
     require 'valkyrie/persistence/solr/queries/find_inverse_references_query'
     require 'valkyrie/persistence/solr/queries/find_members_query'
     require 'valkyrie/persistence/solr/queries/find_references_query'

data/lib/valkyrie/persistence/solr/queries/default_paginator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr::Queries
+  # Acts as a null object representing the default case for paginating over solr
+  # results. Often only used for the first iteration of a loop.
   class DefaultPaginator
     def next_page
       1

data/lib/valkyrie/persistence/solr/queries/find_all_query.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr::Queries
+  # Responsible for efficiently returning all objects in the solr repository as
+  # {Valkyrie::Resource}s
   class FindAllQuery
     attr_reader :connection, :resource_factory, :model
     def initialize(connection:, resource_factory:, model: nil)
@@ -26,7 +28,7 @@ module Valkyrie::Persistence::Solr::Queries
       if !model
         "*:*"
       else
-        "internal_resource_ssim:#{model}"
+        "#{Valkyrie::Persistence::Solr::Queries::MODEL}:#{model}"
       end
     end
   end

data/lib/valkyrie/persistence/solr/queries/find_by_id_query.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr::Queries
+  # Responsible for returning a single resource identified by an ID.
   class FindByIdQuery
-    attr_reader :id, :connection, :resource_factory
+    attr_reader :connection, :resource_factory
+    attr_writer :id
     def initialize(id, connection:, resource_factory:)
       @id = id
       @connection = connection
@@ -14,7 +16,7 @@ module Valkyrie::Persistence::Solr::Queries
     end
 
     def id
-      "id-#{@id}"
+      @id.to_s
     end
 
     def resource

data/lib/valkyrie/persistence/solr/queries/find_inverse_references_query.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr::Queries
+  # Responsible for efficiently returning all {Valkyrie::Resource}s which
+  # reference a {Valkyrie::Resource} in a given property.
   class FindInverseReferencesQuery
     attr_reader :resource, :property, :connection, :resource_factory
     def initialize(resource:, property:, connection:, resource_factory:)

data/lib/valkyrie/persistence/solr/queries/find_many_by_ids_query.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Valkyrie::Persistence::Solr::Queries
+  class FindManyByIdsQuery
+    attr_reader :connection, :resource_factory
+    attr_accessor :ids
+    def initialize(ids, connection:, resource_factory:)
+      @ids = ids
+      @connection = connection
+      @resource_factory = resource_factory
+    end
+
+    def run
+      resources.map { |solr_resource| resource_factory.to_resource(object: solr_resource) }
+    end
+
+    def resources
+      id_query = ids.map { |id| "\"#{id}\"" }.join(' OR ')
+      @resources ||= connection.get("select", params: { q: "id:(#{id_query})", fl: "*", defType: 'lucene', rows: 1_000_000_000 })["response"]["docs"]
+    end
+  end
+end

data/lib/valkyrie/persistence/solr/queries/find_members_query.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr::Queries
+  # Responsible for returning all members of a given resource as
+  # {Valkyrie::Resource}s
   class FindMembersQuery
-    attr_reader :resource, :connection, :resource_factory
-    def initialize(resource:, connection:, resource_factory:)
+    attr_reader :resource, :connection, :resource_factory, :model
+    def initialize(resource:, connection:, resource_factory:, model:)
       @resource = resource
       @connection = connection
       @resource_factory = resource_factory
+      @model = model
     end
 
     def run
@@ -13,6 +16,7 @@ module Valkyrie::Persistence::Solr::Queries
     end
 
     def each
+      return [] unless resource.id.present?
       unordered_members.sort_by { |x| member_ids.index(x.id) }.each do |member|
         yield member
       end
@@ -25,7 +29,11 @@ module Valkyrie::Persistence::Solr::Queries
     end
 
     def docs
-      connection.get("select", params: { q: query, rows: 1_000_000_000 })["response"]["docs"]
+      options = { q: query, rows: 1_000_000_000 }
+      options[:fq] = "{!raw f=internal_resource_ssim}#{model}" if model
+      options[:defType] = 'lucene'
+      result = connection.get("select", params: options)
+      result["response"]["docs"]
     end
 
     def member_ids
@@ -33,11 +41,11 @@ module Valkyrie::Persistence::Solr::Queries
     end
 
     def query
-      "{!join from=member_ids_ssim to=id}id:#{id}"
+      "{!join from=#{MEMBER_IDS} to=join_id_ssi}id:#{id}"
     end
 
     def id
-      "id-#{resource.id}"
+      resource.id.to_s
     end
   end
 end

data/lib/valkyrie/persistence/solr/queries/find_references_query.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr::Queries
+  # Responsible for efficently returning all {Valkyrie::Resource}s which are referenced in
+  # a given {Valkyrie::Resource}'s property.
   class FindReferencesQuery
     attr_reader :resource, :property, :connection, :resource_factory
     def initialize(resource:, property:, connection:, resource_factory:)
@@ -16,7 +18,9 @@ module Valkyrie::Persistence::Solr::Queries
     def each
       docs = DefaultPaginator.new
       while docs.has_next?
-        docs = connection.paginate(docs.next_page, docs.per_page, "select", params: { q: query })["response"]["docs"]
+        params = { q: query, defType: 'lucene' }
+        result = connection.paginate(docs.next_page, docs.per_page, 'select', params: params)
+        docs = result.fetch('response').fetch('docs')
         docs.each do |doc|
           yield resource_factory.to_resource(object: doc)
         end
@@ -24,11 +28,11 @@ module Valkyrie::Persistence::Solr::Queries
     end
 
     def query
-      "{!join from=#{property}_ssim to=id}id:#{id}"
+      "{!join from=#{property}_ssim to=join_id_ssi}id:#{id}"
     end
 
     def id
-      "id-#{resource.id}"
+      resource.id.to_s
     end
   end
 end

data/lib/valkyrie/persistence/solr/query_service.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr
   require 'valkyrie/persistence/solr/queries'
+  # Query Service for Solr MetadataAdapter.
   class QueryService
     attr_reader :connection, :resource_factory
     # @param connection [RSolr::Client]
@@ -12,9 +13,21 @@ module Valkyrie::Persistence::Solr
 
     # (see Valkyrie::Persistence::Memory::QueryService#find_by)
     def find_by(id:)
+      id = Valkyrie::ID.new(id.to_s) if id.is_a?(String)
+      validate_id(id)
       Valkyrie::Persistence::Solr::Queries::FindByIdQuery.new(id, connection: connection, resource_factory: resource_factory).run
     end
 
+    # (see Valkyrie::Persistence::Memory::QueryService#find_many_by_ids)
+    def find_many_by_ids(ids:)
+      ids.map! do |id|
+        id = Valkyrie::ID.new(id.to_s) if id.is_a?(String)
+        validate_id(id)
+        id
+      end
+      Valkyrie::Persistence::Solr::Queries::FindManyByIdsQuery.new(ids, connection: connection, resource_factory: resource_factory).run
+    end
+
     # (see Valkyrie::Persistence::Memory::QueryService#find_all)
     def find_all
       Valkyrie::Persistence::Solr::Queries::FindAllQuery.new(connection: connection, resource_factory: resource_factory).run
@@ -31,8 +44,8 @@ module Valkyrie::Persistence::Solr
     end
 
     # (see Valkyrie::Persistence::Memory::QueryService#find_members)
-    def find_members(resource:)
-      Valkyrie::Persistence::Solr::Queries::FindMembersQuery.new(resource: resource, connection: connection, resource_factory: resource_factory).run
+    def find_members(resource:, model: nil)
+      Valkyrie::Persistence::Solr::Queries::FindMembersQuery.new(resource: resource, model: model, connection: connection, resource_factory: resource_factory).run
     end
 
     # (see Valkyrie::Persistence::Memory::QueryService#find_references_by)
@@ -42,7 +55,22 @@ module Valkyrie::Persistence::Solr
 
     # (see Valkyrie::Persistence::Memory::QueryService#find_inverse_references_by)
     def find_inverse_references_by(resource:, property:)
+      ensure_persisted(resource)
       Valkyrie::Persistence::Solr::Queries::FindInverseReferencesQuery.new(resource: resource, property: property, connection: connection, resource_factory: resource_factory).run
     end
+
+    def custom_queries
+      @custom_queries ||= ::Valkyrie::Persistence::CustomQueryContainer.new(query_service: self)
+    end
+
+    private
+
+      def validate_id(id)
+        raise ArgumentError, 'id must be a Valkyrie::ID' unless id.is_a? Valkyrie::ID
+      end
+
+      def ensure_persisted(resource)
+        raise ArgumentError, 'resource is not saved' unless resource.persisted?
+      end
   end
 end

data/lib/valkyrie/persistence/solr/repository.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr
+  # Responsible for handling the logic for persisting or deleting multiple
+  # objects into or out of solr.
   class Repository
+    COMMIT_PARAMS = { softCommit: true }.freeze
+
     attr_reader :resources, :connection, :resource_factory
     def initialize(resources:, connection:, resource_factory:)
       @resources = resources
@@ -11,16 +15,17 @@ module Valkyrie::Persistence::Solr
     def persist
       documents = resources.map do |resource|
         generate_id(resource) if resource.id.blank?
+        ensure_multiple_values!(resource)
         solr_document(resource)
       end
-      connection.add documents, params: { softCommit: true }
+      connection.add documents, params: COMMIT_PARAMS
       documents.map do |document|
         resource_factory.to_resource(object: document.stringify_keys)
       end
     end
 
     def delete
-      connection.delete_by_id resources.map { |resource| "id-#{resource.id}" }, params: { softCommit: true }
+      connection.delete_by_id resources.map { |resource| resource.id.to_s }, params: COMMIT_PARAMS
       resources
     end
 
@@ -32,5 +37,12 @@ module Valkyrie::Persistence::Solr
       Valkyrie.logger.warn "The Solr adapter is not meant to persist new resources, but is now generating an ID."
       resource.id = SecureRandom.uuid
     end
+
+    def ensure_multiple_values!(resource)
+      bad_keys = resource.attributes.except(:internal_resource, :created_at, :updated_at, :new_record, :id).select do |_k, v|
+        !v.nil? && !v.is_a?(Array)
+      end
+      raise ::Valkyrie::Persistence::UnsupportedDatatype, "#{resource}: #{bad_keys.keys} have non-array values, which can not be persisted by Valkyrie. Cast to arrays." unless bad_keys.keys.empty?
+    end
   end
 end

data/lib/valkyrie/persistence/solr/resource_factory.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::Solr
+  # Provides access to generic methods for converting to/from
+  # {Valkyrie::Resource} and hashes for persistence into Solr.
   class ResourceFactory
     require 'valkyrie/persistence/solr/orm_converter'
     require 'valkyrie/persistence/solr/model_converter'
@@ -8,7 +10,7 @@ module Valkyrie::Persistence::Solr
       @resource_indexer = resource_indexer
     end
 
-    # @param solr_document [Hash] The solr document in a hash to convert to a
+    # @param object [Hash] The solr document in a hash to convert to a
     #   resource.
     # @return [Valkyrie::Resource]
     def to_resource(object:)

data/lib/valkyrie/resource.rb

@@ -8,6 +8,12 @@ module Valkyrie
   #     attribute :member_ids, Valkyrie::Types::Array
   #     attribute :author
   #   end
+  #
+  # @see https://github.com/samvera-labs/valkyrie/wiki/Persistence Resources are persisted by metadata persisters
+  # @see https://github.com/samvera-labs/valkyrie/wiki/Queries Resources are retrieved by query adapters
+  # @see https://github.com/samvera-labs/valkyrie/wiki/ChangeSets-and-Dirty-Tracking Validation and change tracking is provided by change sets
+  #
+  # @see lib/valkyrie/specs/shared_specs/resource.rb
   class Resource < Dry::Struct
     include Draper::Decoratable
     constructor_type :schema
@@ -15,16 +21,17 @@ module Valkyrie
     # Overridden to provide default attributes.
     # @note The current theory is that we should use this sparingly.
     def self.inherited(subclass)
-      ::Dry::Struct.inherited(subclass)
+      super(subclass)
       subclass.constructor_type :schema
       subclass.attribute :internal_resource, Valkyrie::Types::Any.default(subclass.to_s)
       subclass.attribute :created_at, Valkyrie::Types::DateTime.optional
       subclass.attribute :updated_at, Valkyrie::Types::DateTime.optional
+      subclass.attribute :new_record, Types::Bool.default(true)
     end
 
     # @return [Array<Symbol>] Array of fields defined for this class.
     def self.fields
-      schema.keys
+      schema.keys.without(:new_record)
     end
 
     # Define an attribute.
@@ -75,7 +82,7 @@ module Valkyrie
 
     # @return [Boolean]
     def persisted?
-      to_param.present?
+      @new_record == false
     end
 
     def to_key
@@ -83,7 +90,7 @@ module Valkyrie
     end
 
     def to_param
-      id
+      to_key.map(&:to_s).join('-')
     end
 
     # @note Added for ActiveModel compatibility

data/lib/valkyrie/resource/access_controls.rb

@@ -1,6 +1,19 @@
 # frozen_string_literal: true
 module Valkyrie
   class Resource
+    # Provides an optional interface consistent with Hydra::AccessControls
+    #
+    # @example
+    #     class CustomResource < Valkyrie::Resource
+    #       include Valkyrie::Resource::AccessControls
+    #       attribute :id, Valkyrie::Types::ID.optional
+    #       attribute :title
+    #       attribute :member_ids
+    #       attribute :nested_resource
+    #     end
+    #
+    # @see https://github.com/samvera/hydra-head/tree/master/hydra-access-controls
+    # @see lib/valkyrie/indexers/access_controls_indexer/rb
     module AccessControls
       def self.included(klass)
         klass.attribute :read_groups, Valkyrie::Types::Set

data/lib/valkyrie/specs/shared_specs.rb

@@ -4,7 +4,6 @@ require 'valkyrie/specs/shared_specs/queries.rb'
 require 'valkyrie/specs/shared_specs/metadata_adapter'
 require 'valkyrie/specs/shared_specs/resource.rb'
 require 'valkyrie/specs/shared_specs/storage_adapter.rb'
-require 'valkyrie/specs/shared_specs/derivative_service.rb'
-require 'valkyrie/specs/shared_specs/file_characterization_service.rb'
 require 'valkyrie/specs/shared_specs/change_set_persister.rb'
 require 'valkyrie/specs/shared_specs/file.rb'
+require 'valkyrie/specs/shared_specs/change_set.rb'

data/lib/valkyrie/specs/shared_specs/change_set.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+RSpec.shared_examples 'a Valkyrie::ChangeSet' do |*_flags|
+  before do
+    raise 'adapter must be set with `let(:change_set)`' unless defined? change_set
+    raise 'change_set must have at least one field' if change_set.fields.empty?
+  end
+
+  subject { change_set }
+
+  it { is_expected.to respond_to :append_id }
+  it { is_expected.to respond_to :fields }
+  it { is_expected.to respond_to :fields= }
+  it { is_expected.to respond_to :multiple? }
+  it { is_expected.to respond_to :prepopulate! }
+  it { is_expected.to respond_to :required? }
+  it { is_expected.to respond_to :validate }
+  it { is_expected.to respond_to :valid? }
+
+  it "can set an append_id" do
+    change_set.append_id = Valkyrie::ID.new("test")
+    expect(change_set.append_id).to eq Valkyrie::ID.new("test")
+    expect(change_set[:append_id]).to eq Valkyrie::ID.new("test")
+  end
+
+  describe "#fields" do
+    it "returns an hash" do
+      expect(change_set.fields).to be_a Hash
+    end
+  end
+
+  describe "#fields=" do
+    it "sets fields" do
+      change_set.fields = { "totally_a_field" => [] }
+      expect(change_set.fields).to eq("totally_a_field" => [])
+    end
+  end
+
+  describe "#multiple?" do
+    it "returns a boolean" do
+      expect(change_set.multiple?(change_set.fields.keys.first)).to be_in [true, false]
+    end
+  end
+
+  describe "#prepopulate!" do
+    it "doesn't make it look changed" do
+      expect(change_set).not_to be_changed
+      change_set.prepopulate!
+      expect(change_set).not_to be_changed
+    end
+  end
+
+  describe "#required?" do
+    it "returns a boolean" do
+      expect(change_set.required?(change_set.fields.keys.first)).to be_in [true, false]
+    end
+  end
+
+  describe "#valid?" do
+    it "returns a boolean" do
+      expect(change_set.valid?).to be_in [true, false]
+    end
+  end
+
+  describe "#validate" do
+    it "returns a change_set" do
+      expect(change_set.validate(change_set.fields)).to be_in [true, false]
+    end
+  end
+
+  describe ".validators_on" do
+    it "the class responds to validators_on" do
+      expect(described_class).to respond_to(:validators_on)
+    end
+  end
+end