valkyrie 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d6a78cd9f5ae0e854c54e19e046d8fd0ff01b43d3049ea58b904ba09d758fce
-  data.tar.gz: 54175934841fe91f264fb106a4d62a95600078b97311950f81a878527b1d2bf5
+  metadata.gz: fe10f5866474217fe3edb3acce93747447fe6de5c8ad582d0be617f0dd93c040
+  data.tar.gz: e2210174bf001c9115b14266e388cc2999d0a74c560d8872b554e5c04973eb52
 SHA512:
-  metadata.gz: 4d31c229dc71fe0b0be099d624adbb4d72a11d7212144f0b815ff4348be9e73b13e2f6c41b9decf7e90dece3578bcce566deb2c2fcee06f2e4ff2e7174088814
-  data.tar.gz: cc1b647fcb551eccc4fe0ce670bf1ecea2fbe3d328d5c304f7cffd217191309374272f24f0687609b78ba96db7276c69b24688ef46addfc993e43b94979f864f
+  metadata.gz: 72d2fedc30bf650bd3794ab34687a47b071ab41fe1c8b29ebaef582b80616eed7f86aa549bc723976f0655fe9d0e302714294ecfb1a1a2461fb2428f00f4cd7c
+  data.tar.gz: 76bc7d38aa82f6e6bcc57e6e1d8bb7f762cc0f62d2f571f8e96d6a0a0fb76efab8f73327c86e239dfd65dc43fbe2d1d0798695b0008a3240bef0f7d08edd6c2d

data/.circleci/config.yml

@@ -0,0 +1,46 @@
+---
+version: 2
+jobs:
+  build:
+    machine: true
+    steps:
+      - checkout
+      - run:
+          name: Install Docker Compose
+          command: |
+            curl -L https://github.com/docker/compose/releases/download/1.19.0/docker-compose-`uname -s`-`uname -m` > ~/docker-compose
+            chmod +x ~/docker-compose
+            sudo mv ~/docker-compose /usr/local/bin/docker-compose
+      - restore_cache:
+         keys:
+           - bundle-{{ checksum "Gemfile" }}-{{ checksum "valkyrie.gemspec" }}
+           - bundle- # used if checksum fails
+      - run: sudo apt-get update && sudo apt-get install -y libpq-dev
+      - run:
+          name: Install dependencies
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs 4 --retry 3
+      - save_cache:
+          key: bundle-{{ checksum "Gemfile" }}-{{ checksum "valkyrie.gemspec" }}
+          paths:
+            - "vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rake rubocop
+      - run:
+          name: Run Specs
+          command: bundle exec rake docker:spec
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - build

data/.docker-stack/valkyrie-development/docker-compose.yml

@@ -0,0 +1,68 @@
+---
+version: '3.4'
+volumes:
+  fedora:
+  db:
+  solr_repo:
+  solr_index:
+services:
+  fedora:
+    image: nulib/fcrepo4
+    volumes:
+    - fedora:/data
+    ports:
+    - 8986:8080
+  db:
+    image: healthcheck/postgres:alpine
+    volumes:
+    - db:/data
+    environment:
+    - PGDATA=/data
+    - POSTGRES_USER=docker
+    - POSTGRES_PASSWORD=d0ck3r
+    ports:
+    - 5433:5432
+  solr_repo:
+    image: solr:7.2-alpine
+    ports:
+    - 8983:8983
+    volumes:
+    - solr_repo:/opt/solr/server/solr/mycores
+    - "../../solr:/solr_config"
+    entrypoint:
+    - docker-entrypoint.sh
+    - solr-precreate
+    - blacklight-core
+    - "/solr_config/config"
+    healthcheck:
+      test:
+      - CMD
+      - wget
+      - "-O"
+      - "/dev/null"
+      - http://localhost:8983/solr/
+      interval: 30s
+      timeout: 5s
+      retries: 3
+  solr_index:
+    image: solr:7.2-alpine
+    ports:
+    - 8987:8983
+    volumes:
+    - solr_index:/opt/solr/server/solr/mycores
+    - "../../solr:/solr_config"
+    entrypoint:
+    - docker-entrypoint.sh
+    - solr-precreate
+    - hydra-dev
+    - "/solr_config/config"
+    healthcheck:
+      test:
+      - CMD
+      - wget
+      - "-O"
+      - "/dev/null"
+      - http://localhost:8983/solr/
+      interval: 30s
+      timeout: 5s
+      retries: 3

data/.docker-stack/valkyrie-test/docker-compose.yml

@@ -0,0 +1,68 @@
+---
+version: '3.4'
+volumes:
+  fedora:
+  db:
+  solr_repo:
+  solr_index:
+services:
+  fedora:
+    image: nulib/fcrepo4
+    volumes:
+    - fedora:/data
+    ports:
+    - 8988:8080
+  db:
+    image: healthcheck/postgres:alpine
+    volumes:
+    - db:/data
+    environment:
+    - PGDATA=/data
+    - POSTGRES_USER=docker
+    - POSTGRES_PASSWORD=d0ck3r
+    ports:
+    - 5434:5432
+  solr_repo:
+    image: solr:7.2-alpine
+    ports:
+    - 8984:8983
+    volumes:
+    - solr_repo:/opt/solr/server/solr/mycores
+    - "../../solr:/solr_config"
+    entrypoint:
+    - docker-entrypoint.sh
+    - solr-precreate
+    - blacklight-core-test
+    - "/solr_config/config"
+    healthcheck:
+      test:
+      - CMD
+      - wget
+      - "-O"
+      - "/dev/null"
+      - http://localhost:8983/solr/
+      interval: 30s
+      timeout: 5s
+      retries: 3
+  solr_index:
+    image: solr:7.2-alpine
+    ports:
+    - 8985:8983
+    volumes:
+    - solr_index:/opt/solr/server/solr/mycores
+    - "../../solr:/solr_config"
+    entrypoint:
+    - docker-entrypoint.sh
+    - solr-precreate
+    - hydra-test
+    - "/solr_config/config"
+    healthcheck:
+      test:
+      - CMD
+      - wget
+      - "-O"
+      - "/dev/null"
+      - http://localhost:8983/solr/
+      interval: 30s
+      timeout: 5s
+      retries: 3

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v1.1.0 2018-05-08
+
+## Changes since last release
+
+* Added `find_by_alternate_identifier` query.
+    [stkenny](https://github.com/stkenny)
+* Added Docker environment for development.
+    [mbklein](https://github.com/mbklein)
+* Fixed README documentation.
+    [revgum](https://github.com/revgum)
+* Deprecated `Valkyrie::Persistence::Fedora::PermissiveSchema.references`
+* Deprecated `Valkyrie::Persistence::Fedora::PermissiveSchema.alternate_ids`
+
 # v1.0.0 2018-03-23
 
 ## Changes since last release

data/README.md

@@ -35,7 +35,7 @@ instance with a short name that can be used to refer to it in your application:
 require 'valkyrie'
 Rails.application.config.to_prepare do
   Valkyrie::MetadataAdapter.register(
-    Valkyrie::Persistence::Postgres::MetadataAdapter,
+    Valkyrie::Persistence::Postgres::MetadataAdapter.new,
     :postgres
   )
 
@@ -83,20 +83,20 @@ A sample configuration file that configures your application to use different ad
 
 ```
 development:
-  adapter: postgres
+  metadata_adapter: postgres
   storage_adapter: disk
 
 test:
-  adapter: memory
+  metadata_adapter: memory
   storage_adapter: memory
 
 production:
-  adapter: postgres
+  metadata_adapter: postgres
   storage_adapter: fedora
 ```
 
 For each environment, you must set two values:
-* `adapter` is the store where Valkyrie will put the metadata
+* `metadata_adapter` is the store where Valkyrie will put the metadata
 * `storage_adapter` is the store where Valkyrie will put the files
 
 The values are the short names used in your initializer.
@@ -120,7 +120,7 @@ end
 
 #### Work Types Generator
 
-To create a custom Valkyrie model in your application, you can use the Rails generator.  For example, to 
+To create a custom Valkyrie model in your application, you can use the Rails generator.  For example, to
 generate a model named `FooBar` with an unordered `title` field and an ordered `member_ids` field:
 
 ```
@@ -136,15 +136,18 @@ rails generate valkyrie:resource Foo/Bar title member_ids:array
 ### Read and Write Data
 
 ```
+# initialize a metadata adapter
+adapter = Valkyrie::MetadataAdapter.find(:postgres)
+
 # create an object
 object1 = MyModel.new title: 'My Cool Object', authors: ['Jones, Alice', 'Smith, Bob']
-object1 = Persister.save(model: object1)
+object1 = adapter.persister.save(resource: object1)
 
 # load an object from the database
-object2 = QueryService.find_by(id: object1.id)
+object2 = adapter.query_service.find_by(id: object1.id)
 
 # load all objects
-objects = QueryService.find_all
+objects = adapter.query_service.find_all
 
 # load all MyModel objects
 Valkyrie.config.metadata_adapter.query_service.find_all_of_model(model: MyModel)
@@ -153,17 +156,53 @@ Valkyrie.config.metadata_adapter.query_service.find_all_of_model(model: MyModel)
 
 ## Installing a Development environment
 
-### External Requirements
+### Without Docker
+
+#### External Requirements
 * PostgreSQL with the uuid-ossp extension.
   * Note: Enabling uuid-ossp requires database superuser privileges.
     * From `psql`: `alter user [username] with superuser;`
 
-### To run the test suite
+#### To run the test suite
 1. Start Solr and Fedora servers for testing with `rake server:test`
 1. Run `rake db:create` (First time only)
 1. Run `rake db:migrate`
+
+### With Docker
+
+#### External Requirements
+* [Docker](https://store.docker.com/search?offering=community&type=edition) version >= 17.09.0
+*
+### Dependency Setup (Mac OSX)
+
+1. `brew install docker`
+1. `brew install docker-machine`
+1. `brew install docker-compose`
+
+### Starting Docker (Mac OSX)
+
+1. `docker-machine create default`
+1. `docker-machine start default`
+1. `eval "$(docker-machine env)"
+
+#### Starting the development mode dependencies
+1. Start Solr, Fedora, and PostgreSQL with `rake docker:dev:daemon` (or `rake docker:dev:up` in a separate shell to run them in the foreground)
+1. Run `rake db:create db:migrate` to initialize the database
+1. Develop!
+1. Run `rake docker:dev:down` to stop the server stack
+   * Development servers maintain data between runs. To clean them out, run `rake docker:dev:clean`
+
+#### To run the test suite with all dependencies in one go
+1. `rake docker:spec`
+
+#### To run the test suite manually
+1. Start Solr, Fedora, and PostgreSQL with `rake docker:test:daemon` (or `rake docker:test:up` in a separate shell to run them in the foreground)
+1. Run `rake db:create db:migrate` to initialize the database
 1. Run the gem's RSpec test suite with `rspec spec` or `rake`
+1. Run `rake docker:test:down` to stop the server stack
+   * The test stack cleans up after itself on exit.
 
+The development and test stacks use fully contained virtual volumes and bind all services to different ports, so they can be running at the same time without issue.
 
 ## License
 

data/Rakefile

@@ -5,7 +5,9 @@ require 'yaml'
 require 'config/database_connection'
 require 'active_record'
 require 'rubocop/rake_task'
-load "tasks/dev.rake"
+load 'tasks/dev.rake'
+load 'tasks/docker.rake'
+
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
@@ -25,7 +27,7 @@ namespace :db do
   end
 
   task configuration: :environment do
-    @config = YAML.safe_load(ERB.new(File.read("db/config.yml")).result)[DATABASE_ENV]
+    @config = YAML.safe_load(ERB.new(File.read("db/config.yml")).result, [], [], true)[DATABASE_ENV]
   end
 
   task configure_connection: :configuration do

data/db/config.yml

@@ -1,17 +1,27 @@
-development: &default
+<% local = File.exist?('/tmp/.s.PGSQL.5432') && File.stat('/tmp/.s.PGSQL.5432').socket? %>
+default: &default
   adapter: postgresql
-  database: Valkyrie_gem_development
   encoding: utf8
   min_messages: warning
   pool: <%= Integer(ENV.fetch("DB_POOL", 5)) %>
   reaping_frequency: <%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
   timeout: 5000
+  <% unless local %>
+  host: localhost
+  username: docker
+  password: d0ck3r
+  <% end %>
+
+development:
+  <<: *default
+  database: Valkyrie_gem_development
+  <% unless local %>
+  port: 5433
+  <% end %>
 
 test:
-  adapter: postgresql
-  encoding: utf8
-  min_messages: warning
-  pool: <%= Integer(ENV.fetch("DB_POOL", 5)) %>
-  reaping_frequency: <%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
-  timeout: 5000
+  <<: *default
   database: Valkyrie_gem_test
+  <% unless local %>
+  port: 5434
+  <% end %>

data/lib/config/database_connection.rb

@@ -7,7 +7,7 @@ module DatabaseConnection
     # Ref https://github.com/puma/puma#clustered-mode
     ActiveSupport.on_load(:active_record) do
       ::ActiveRecord::Base.connection_pool.disconnect! if ::ActiveRecord::Base.connected?
-      ::ActiveRecord::Base.configurations = YAML.safe_load(ERB.new(File.read("db/config.yml")).result) || {}
+      ::ActiveRecord::Base.configurations = YAML.safe_load(ERB.new(File.read("db/config.yml")).result, [], [], true) || {}
       config = ::ActiveRecord::Base.configurations[env.to_s]
       ::ActiveRecord::Base.establish_connection(config)
     end

data/lib/valkyrie/persistence/fedora/permissive_schema.rb

@@ -22,11 +22,27 @@ module Valkyrie::Persistence::Fedora
       uri_for(:id)
     end
 
+    # @deprecated Please use {.uri_for} instead
+    def self.alternate_ids
+      warn "[DEPRECATION] `alternate_ids` is deprecated and will be removed in the next major release. " \
+           "It was never used internally - please use `uri_for(:alternate_ids)` " \
+           "Called from #{Gem.location_of_caller.join(':')}"
+      uri_for(:alternate_ids)
+    end
+
     # @return [RDF::URI]
     def self.member_ids
       uri_for(:member_ids)
     end
 
+    # @deprecated Please use {.uri_for} instead
+    def self.references
+      warn "[DEPRECATION] `references` is deprecated and will be removed in the next major release. " \
+           "It was never used internally - please use `uri_for(:references)` " \
+           "Called from #{Gem.location_of_caller.join(':')}"
+      uri_for(:references)
+    end
+
     # @return [RDF::URI]
     def self.valkyrie_bool
       uri_for(:valkyrie_bool)

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

@@ -3,6 +3,7 @@ module Valkyrie::Persistence::Fedora
   # Persister for Fedora MetadataAdapter.
   class Persister
     require 'valkyrie/persistence/fedora/persister/resource_factory'
+    require 'valkyrie/persistence/fedora/persister/alternate_identifier'
     attr_reader :adapter
     delegate :connection, :base_path, :resource_factory, to: :adapter
     def initialize(adapter:)
@@ -16,14 +17,17 @@ module Valkyrie::Persistence::Fedora
       resource.updated_at ||= Time.current
       ensure_multiple_values!(resource)
       orm = resource_factory.from_resource(resource: resource)
+      alternate_resources = find_or_create_alternate_ids(resource)
+
       if !orm.new? || resource.id
-        orm.update do |req|
-          req.headers["Prefer"] = "handling=lenient; received=\"minimal\""
-        end
+        cleanup_alternate_resources(resource) if alternate_resources
+        orm.update { |req| req.headers["Prefer"] = "handling=lenient; received=\"minimal\"" }
       else
         orm.create
       end
-      resource_factory.to_resource(object: orm)
+      persisted_resource = resource_factory.to_resource(object: orm)
+
+      alternate_resources ? save_reference_to_resource(persisted_resource, alternate_resources) : persisted_resource
     end
 
     # (see Valkyrie::Persistence::Memory::Persister#save_all)
@@ -35,8 +39,15 @@ module Valkyrie::Persistence::Fedora
 
     # (see Valkyrie::Persistence::Memory::Persister#delete)
     def delete(resource:)
+      if resource.try(:alternate_ids)
+        resource.alternate_ids.each do |alternate_identifier|
+          adapter.persister.delete(resource: adapter.query_service.find_by(id: alternate_identifier))
+        end
+      end
+
       orm = resource_factory.from_resource(resource: resource)
       orm.delete
+
       resource
     end
 
@@ -60,10 +71,41 @@ module Valkyrie::Persistence::Fedora
     private
 
       def ensure_multiple_values!(resource)
-        bad_keys = resource.attributes.except(:internal_resource, :created_at, :updated_at, :new_record, :id).select do |_k, v|
+        bad_keys = resource.attributes.except(:internal_resource, :created_at, :updated_at, :new_record, :id, :references).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
+
+      def find_or_create_alternate_ids(resource)
+        return nil unless resource.try(:alternate_ids)
+
+        resource.alternate_ids.map do |alternate_identifier|
+          begin
+            adapter.query_service.find_by(id: alternate_identifier)
+          rescue ::Valkyrie::Persistence::ObjectNotFoundError
+            alternate_resource = ::Valkyrie::Persistence::Fedora::AlternateIdentifier.new(id: alternate_identifier)
+            adapter.persister.save(resource: alternate_resource)
+          end
+        end
+      end
+
+      def cleanup_alternate_resources(updated_resource)
+        persisted_resource = adapter.query_service.find_by(id: updated_resource.id)
+        removed_identifiers = persisted_resource.alternate_ids - updated_resource.alternate_ids
+
+        removed_identifiers.each do |removed_id|
+          adapter.persister.delete(resource: adapter.query_service.find_by(id: removed_id))
+        end
+      end
+
+      def save_reference_to_resource(resource, alternate_resources)
+        alternate_resources.each do |alternate_resource|
+          alternate_resource.references = resource.id
+          adapter.persister.save(resource: alternate_resource)
+        end
+
+        resource
+      end
   end
 end

data/lib/valkyrie/persistence/fedora/persister/alternate_identifier.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'valkyrie/resource'
+require 'valkyrie/types'
+
+module Valkyrie::Persistence::Fedora
+  class AlternateIdentifier < ::Valkyrie::Resource
+    attribute :id, ::Valkyrie::Types::ID.optional
+    attribute :references, ::Valkyrie::Types::ID.optional
+  end
+end

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

@@ -10,15 +10,19 @@ module Valkyrie::Persistence::Fedora
 
     # (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)
       uri = adapter.id_to_uri(id)
-      begin
-        resource = Ldp::Resource.for(connection, uri, connection.get(uri))
-        resource_factory.to_resource(object: resource)
-      rescue ::Ldp::Gone, ::Ldp::NotFound
-        raise ::Valkyrie::Persistence::ObjectNotFoundError
-      end
+
+      resource_from_uri(uri)
+    end
+
+    # (see Valkyrie::Persistence::Memory::QueryService#find_by_alternate_identifier)
+    def find_by_alternate_identifier(alternate_identifier:)
+      validate_id(alternate_identifier)
+      uri = adapter.id_to_uri(alternate_identifier)
+      alternate_id = resource_from_uri(uri).references
+
+      find_by(id: alternate_id)
     end
 
     # (see Valkyrie::Persistence::Memory::QueryService#find_many_by_ids)
@@ -113,9 +117,17 @@ module Valkyrie::Persistence::Fedora
     private
 
       def validate_id(id)
+        id = Valkyrie::ID.new(id.to_s) if id.is_a?(String)
         raise ArgumentError, 'id must be a Valkyrie::ID' unless id.is_a? Valkyrie::ID
       end
 
+      def resource_from_uri(uri)
+        resource = Ldp::Resource.for(connection, uri, connection.get(uri))
+        resource_factory.to_resource(object: resource)
+      rescue ::Ldp::Gone, ::Ldp::NotFound
+        raise ::Valkyrie::Persistence::ObjectNotFoundError
+      end
+
       def ensure_persisted(resource)
         raise ArgumentError, 'resource is not saved' unless resource.persisted?
       end

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

@@ -24,6 +24,17 @@ module Valkyrie::Persistence::Memory
       cache[id] || raise(::Valkyrie::Persistence::ObjectNotFoundError)
     end
 
+    # @param alternate_identifier [Valkyrie::ID] The alternate identifier to query for.
+    # @raise [Valkyrie::Persistence::ObjectNotFoundError] Raised when the alternate identifier
+    #   isn't in the persistence backend.
+    # @raise [ArgumentError] Raised when alternate identifier is not a String or a Valkyrie::ID
+    # @return [Valkyrie::Resource] The object being searched for.
+    def find_by_alternate_identifier(alternate_identifier:)
+      alternate_identifier = Valkyrie::ID.new(alternate_identifier.to_s) if alternate_identifier.is_a?(String)
+      validate_id(alternate_identifier)
+      cache.select { |_key, resource| resource['alternate_ids'].include?(alternate_identifier) }.values.first || raise(::Valkyrie::Persistence::ObjectNotFoundError)
+    end
+
     # @param ids [Array<Valkyrie::ID, String>] The IDs to query for.
     # @raise [ArgumentError] Raised when any ID is not a String or a Valkyrie::ID
     # @return [Array<Valkyrie::Resource>] All requested objects that were found

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

@@ -37,6 +37,14 @@ module Valkyrie::Persistence::Postgres
       raise Valkyrie::Persistence::ObjectNotFoundError
     end
 
+    # (see Valkyrie::Persistence::Memory::QueryService#find_by_alternate_identifier)
+    def find_by_alternate_identifier(alternate_identifier:)
+      alternate_identifier = Valkyrie::ID.new(alternate_identifier.to_s) if alternate_identifier.is_a?(String)
+      validate_id(alternate_identifier)
+      internal_array = "{\"alternate_ids\": [{\"id\": \"#{alternate_identifier}\"}]}"
+      run_query(find_inverse_references_query, internal_array).first || raise(Valkyrie::Persistence::ObjectNotFoundError)
+    end
+
     # (see Valkyrie::Persistence::Memory::QueryService#find_many_by_ids)
     def find_many_by_ids(ids:)
       ids.map! do |id|
@@ -48,8 +56,6 @@ module Valkyrie::Persistence::Postgres
       orm_class.where(id: ids).map do |orm_resource|
         resource_factory.to_resource(object: orm_resource)
       end
-    rescue ActiveRecord::RecordNotFound
-      raise Valkyrie::Persistence::ObjectNotFoundError
     end
 
     # (see Valkyrie::Persistence::Memory::QueryService#find_members)

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

@@ -6,6 +6,7 @@ module Valkyrie::Persistence::Solr
     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_by_alternate_identifier_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'

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Valkyrie::Persistence::Solr::Queries
+  # Responsible for returning a single resource identified by an ID.
+  class FindByAlternateIdentifierQuery
+    attr_reader :connection, :resource_factory
+    attr_writer :alternate_identifier
+    def initialize(alternate_identifier, connection:, resource_factory:)
+      @alternate_identifier = alternate_identifier
+      @connection = connection
+      @resource_factory = resource_factory
+    end
+
+    def run
+      raise ::Valkyrie::Persistence::ObjectNotFoundError unless resource
+      resource_factory.to_resource(object: resource)
+    end
+
+    def alternate_identifier
+      @alternate_identifier.to_s
+    end
+
+    def resource
+      connection.get("select", params: { q: "alternate_ids_ssim:\"id-#{alternate_identifier}\"", fl: "*", rows: 1 })["response"]["docs"].first
+    end
+  end
+end

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

@@ -18,6 +18,13 @@ module Valkyrie::Persistence::Solr
       Valkyrie::Persistence::Solr::Queries::FindByIdQuery.new(id, connection: connection, resource_factory: resource_factory).run
     end
 
+    # (see Valkyrie::Persistence::Memory::QueryService#find_by_alternate_identifier)
+    def find_by_alternate_identifier(alternate_identifier:)
+      alternate_identifier = Valkyrie::ID.new(alternate_identifier.to_s) if alternate_identifier.is_a?(String)
+      validate_id(alternate_identifier)
+      Valkyrie::Persistence::Solr::Queries::FindByAlternateIdentifierQuery.new(alternate_identifier, 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|

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

@@ -39,7 +39,7 @@ module Valkyrie::Persistence::Solr
     end
 
     def ensure_multiple_values!(resource)
-      bad_keys = resource.attributes.except(:internal_resource, :created_at, :updated_at, :new_record, :id).select do |_k, v|
+      bad_keys = resource.attributes.except(:internal_resource, :alternate_ids, :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?

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

@@ -5,6 +5,7 @@ RSpec.shared_examples 'a Valkyrie query provider' do
       defined? adapter
     class CustomResource < Valkyrie::Resource
       attribute :id, Valkyrie::Types::ID.optional
+      attribute :alternate_ids, Valkyrie::Types::Array
       attribute :title
       attribute :member_ids, Valkyrie::Types::Array
       attribute :a_member_of
@@ -25,6 +26,7 @@ RSpec.shared_examples 'a Valkyrie query provider' do
   it { is_expected.to respond_to(:find_all).with(0).arguments }
   it { is_expected.to respond_to(:find_all_of_model).with_keywords(:model) }
   it { is_expected.to respond_to(:find_by).with_keywords(:id) }
+  it { is_expected.to respond_to(:find_by_alternate_identifier).with_keywords(:alternate_identifier) }
   it { is_expected.to respond_to(:find_many_by_ids).with_keywords(:ids) }
   it { is_expected.to respond_to(:find_members).with_keywords(:resource, :model) }
   it { is_expected.to respond_to(:find_references_by).with_keywords(:resource, :property) }
@@ -74,6 +76,44 @@ RSpec.shared_examples 'a Valkyrie query provider' do
     end
   end
 
+  describe ".find_by_alternate_identifier" do
+    it "returns a resource by alternate identifier or string representation of an alternate identifier" do
+      resource = resource_class.new
+      resource.alternate_ids = [Valkyrie::ID.new('p9s0xfj')]
+      resource = persister.save(resource: resource)
+
+      found = query_service.find_by_alternate_identifier(alternate_identifier: resource.alternate_ids.first)
+      expect(found.id).to eq resource.id
+      expect(found).to be_persisted
+
+      found = query_service.find_by_alternate_identifier(alternate_identifier: resource.alternate_ids.first.to_s)
+      expect(found.id).to eq resource.id
+      expect(found).to be_persisted
+    end
+
+    it "returns a Valkyrie::Persistence::ObjectNotFoundError for a non-found alternate identifier" do
+      expect { query_service.find_by_alternate_identifier(alternate_identifier: Valkyrie::ID.new("123123123")) }.to raise_error ::Valkyrie::Persistence::ObjectNotFoundError
+    end
+
+    it 'raises an error if the alternate identifier is not a Valkyrie::ID or a string' do
+      expect { query_service.find_by_alternate_identifier(alternate_identifier: 123) }.to raise_error ArgumentError
+    end
+
+    it 'can have multiple alternate identifiers' do
+      resource = resource_class.new
+      resource.alternate_ids = [Valkyrie::ID.new('p9s0xfj'), Valkyrie::ID.new('jks0xfj')]
+      resource = persister.save(resource: resource)
+
+      found = query_service.find_by_alternate_identifier(alternate_identifier: resource.alternate_ids.first)
+      expect(found.id).to eq resource.id
+      expect(found).to be_persisted
+
+      found = query_service.find_by_alternate_identifier(alternate_identifier: resource.alternate_ids.last)
+      expect(found.id).to eq resource.id
+      expect(found).to be_persisted
+    end
+  end
+
   describe ".find_many_by_ids" do
     let!(:resource) { persister.save(resource: resource_class.new) }
     let!(:resource2) { persister.save(resource: resource_class.new) }

data/lib/valkyrie/version.rb

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

data/tasks/docker.rake

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'valkyrie'
+
+if Rails.env.development? || Rails.env.test?
+  begin
+    require 'docker/stack/rake_task'
+
+    def get_named_task(task_name)
+      Rake::Task[task_name]
+    rescue RuntimeError
+      nil
+    end
+
+    namespace :docker do
+      namespace(:dev)  { Docker::Stack::RakeTask.load_tasks }
+      namespace(:test) { Docker::Stack::RakeTask.load_tasks(force_env: 'test', cleanup: true) }
+
+      desc 'Spin up test stack and run specs'
+      task :spec do
+        Rails.env = 'test'
+        Docker::Stack::Controller.new(project: 'valkyrie', cleanup: true).with_containers do
+          Rake::Task['db:create'].invoke
+          Rake::Task['db:migrate'].invoke
+          Rake::Task['spec'].invoke
+        end
+      end
+    end
+  rescue LoadError
+    Rails.logger.warn 'Docker rake tasks not loaded.'
+  end
+end

data/valkyrie.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-struct'
   spec.add_dependency 'draper'
   spec.add_dependency 'activemodel'
-  spec.add_dependency 'dry-types'
+  spec.add_dependency 'dry-types', '~> 0.12.0'
   spec.add_dependency 'rdf'
   spec.add_dependency 'active-fedora'
   spec.add_dependency 'activesupport'
@@ -49,4 +49,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'solr_wrapper'
   spec.add_development_dependency 'fcrepo_wrapper'
+  spec.add_development_dependency 'docker-stack', '~> 0.2.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valkyrie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Trey Pendragon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -56,16 +56,16 @@ dependencies:
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rdf
   requirement: !ruby/object:Gem::Requirement
@@ -388,6 +388,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: docker-stack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
 description: 
 email:
 - tpendragon@princeton.edu
@@ -395,7 +409,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".ctags"
+- ".docker-stack/valkyrie-development/docker-compose.yml"
+- ".docker-stack/valkyrie-test/docker-compose.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -410,7 +427,6 @@ files:
 - bin/rspec
 - bin/setup
 - browserslist
-- circle.yml
 - config/fedora.yml
 - config/valkyrie.yml
 - db/config.yml
@@ -446,6 +462,7 @@ files:
 - lib/valkyrie/persistence/fedora/ordered_reader.rb
 - lib/valkyrie/persistence/fedora/permissive_schema.rb
 - lib/valkyrie/persistence/fedora/persister.rb
+- lib/valkyrie/persistence/fedora/persister/alternate_identifier.rb
 - lib/valkyrie/persistence/fedora/persister/model_converter.rb
 - lib/valkyrie/persistence/fedora/persister/orm_converter.rb
 - lib/valkyrie/persistence/fedora/persister/resource_factory.rb
@@ -472,6 +489,7 @@ files:
 - lib/valkyrie/persistence/solr/queries.rb
 - lib/valkyrie/persistence/solr/queries/default_paginator.rb
 - lib/valkyrie/persistence/solr/queries/find_all_query.rb
+- lib/valkyrie/persistence/solr/queries/find_by_alternate_identifier_query.rb
 - lib/valkyrie/persistence/solr/queries/find_by_id_query.rb
 - lib/valkyrie/persistence/solr/queries/find_inverse_references_query.rb
 - lib/valkyrie/persistence/solr/queries/find_many_by_ids_query.rb
@@ -519,6 +537,7 @@ files:
 - solr/config/xslt/luke.xsl
 - solr/solr.xml
 - tasks/dev.rake
+- tasks/docker.rake
 - valkyrie.gemspec
 homepage: 
 licenses: []

data/circle.yml

@@ -1,17 +0,0 @@
-machine:
-  ruby:
-    version: 2.3.1
-  services:
-    - redis
-general:
-  artifacts:
-    - "tmp/capybara"
-dependencies:
-  post:
-    - bundle exec rake rubocop
-    - bundle exec rake server:test:
-        background: true
-    - bin/jetty_wait
-notify:
-  webhooks:
-    - url: https://coveralls.io/webhook?repo_token=c3AnaQOFVYYTitAR1w6ySNScXSIfLQwN4