valkyrie 0.1.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5895a08d879fc01c20f546804cb147bb6287f4e
-  data.tar.gz: a7934d10ee04ed79c752159001f883aa15a32149
+SHA256:
+  metadata.gz: 0bdf173346aa41d564f214c4e453e047a730ec7775edd7c7a0167e38fa2cd4e4
+  data.tar.gz: aef0b3c204da30a6241b3b217fea821504b806eb10e50ae8d3ad2d5547d0d19d
 SHA512:
-  metadata.gz: b8e7471ae686bd39aa04dc7e225dffa1348a06716faa4f824f9a11dd50df5e8e55cc8fd6a49fece559391b31840f62395090fa29f8a2a618b648152b1c840d02
-  data.tar.gz: da1d0422841bb1f24b902f839c95d754ade7b26b4767b22a22c4f33db9ed84090aab0c53b9d2cab88741d5741ad791a453db52a86cad671c727d454d92d51680
+  metadata.gz: f8610d09ec9088a811f80e84ad53eaa583f76bc28304266870e349ec940306871455885153cfd01ac5dce62e1bc36dbce7119ba719576da6bc86bab664e9a14a
+  data.tar.gz: 588b9c6d0bb1a94103a1b6c256b94cf1b26309602a984ad8094a438f7bb33a01802e3bc5602d2259c4a08b8b82430492517b1dcc2fa3d5e71ffe142cfb99c6af

data/.ctags

@@ -0,0 +1,2 @@
+--recurse=yes
+--exclude=vendor

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   bixby: bixby_default.yml
 AllCops:
@@ -13,6 +15,7 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'lib/valkyrie/specs/**/*'
+    - 'tasks/**/*'
     - 'db/schema.rb'
     - 'Rakefile'
     - '*.gemspec'
@@ -26,3 +29,5 @@ Style/PredicateName:
   Exclude:
     - "lib/valkyrie/resource.rb"
     - "lib/valkyrie/persistence/solr/queries/default_paginator.rb"
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true

data/.rubocop_todo.yml

@@ -0,0 +1,3 @@
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/valkyrie/persistence/postgres/query_service.rb'

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# v1.0.0.RC1 2018-03-02
+
+Initial Release
+
+## Changes Since Last Sprint
+
+* Added find_many_by_ids query.
+* Enforces only persisting arrays - no scalars.
+* Fixes casting edge cases for `Set` and `Array`.
+* Significantly improved documentation
+* Support `Booleans`
+* Support `RDF::Literal`
+* Fix support for `DateTime`.
+* Fix rake tasks leaking out of gem.
+* Extract derivatives/file characterization to
+    [valkyrie-derivatives](https://github.com/samvera-labs/valkyrie-derivatives)
+* ChangeSet shared spec
+* Allow strings as an argument for find_by.
+* Improve development documentation.
+* Throw error on `find_inverse_references_by` for unsaved `resource`.
+
+## Special Thanks to All Contributors:
+
+* [atz](https://github.com/atz)
+* [awead](https://github.com/awead)
+* [barmintor](https://github.com/barmintor)
+* [bmquinn](https://github.com/bmquinn)
+* [cam156](https://github.com/cam156)
+* [carrickr](https://github.com/carrickr)
+* [cbeer](https://github.com/cbeer)
+* [cjcolvar](https://github.com/cjcolvar)
+* [csyversen](https://github.com/csyversen)
+* [dlpierce](https://github.com/dlpierce)
+* [escowles](https://github.com/escowles)
+* [geekscruff](https://github.com/geekscruff)
+* [hackmastera](https://github.com/hackmastera)
+* [jcoyne](https://github.com/jcoyne)
+* [jeremyf](https://github.com/jeremyf)
+* [jgondron](https://github.com/jgondron)
+* [jrgriffiniii](https://github.com/jrgriffiniii)
+* [mbklein](https://github.com/mbklein)
+* [stkenny](https://github.com/stkenny)
+* [tpendragon](https://github.com/tpendragon)

data/Gemfile

@@ -3,7 +3,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in valkyrie.gemspec
 gemspec
-
-# Necessary for the --ignore-parent-exclusion feature. Remove when
-# https://github.com/bbatsov/rubocop/pull/4329 is merged.
-gem 'rubocop', github: 'nelsonjr/rubocop', ref: 'a5db18a49b9f318644ae7209c73452fb7bbcdc49'

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2017 Princeton University Library
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# Licensed 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.

data/README.md

@@ -1,7 +1,6 @@
 # Valkyrie
 
-Valkyrie is a gem for enabling multiple backends for storage of files and metadata in Samvera,
-currently developed in a subdirectory of the [proof-of-concept app of the same name](..).
+Valkyrie is a gem for enabling multiple backends for storage of files and metadata in Samvera.
 
 [![CircleCI](https://circleci.com/gh/samvera-labs/valkyrie.svg?style=svg)](https://circleci.com/gh/samvera-labs/valkyrie)
 [![Coverage Status](https://coveralls.io/repos/github/samvera-labs/valkyrie/badge.svg?branch=master)](https://coveralls.io/github/samvera-labs/valkyrie?branch=master)
@@ -125,13 +124,13 @@ To create a custom Valkyrie model in your application, you can use the Rails gen
 generate a model named `FooBar` with an unordered `title` field and an ordered `member_ids` field:
 
 ```
-rails generate valkyrie:model FooBar title member_ids:array
+rails generate valkyrie:resource FooBar title member_ids:array
 ```
 
 You can namespace your model class by including a slash in the model name:
 
 ```
-rails generate valkyrie:model Foo/Bar title member_ids:array
+rails generate valkyrie:resource Foo/Bar title member_ids:array
 ```
 
 ### Read and Write Data
@@ -154,10 +153,16 @@ Valkyrie.config.metadata_adapter.query_service.find_all_of_model(model: MyModel)
 
 ## Installing a Development environment
 
-See the parent app README for [instructions on setting up a development
-environment](../#installing-a-development-environment).  To run the test suite:
-1. Start Solr and Fedora servers for testing with `rake server:test` in the parent app
-1. Run the gem's RSpec test suite with `cd valkyrie && rspec spec`
+### 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
+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`
+1. Run the gem's RSpec test suite with `rspec spec` or `rake`
 
 
 ## License

data/Rakefile

@@ -4,10 +4,18 @@ require "rspec/core/rake_task"
 require 'yaml'
 require 'config/database_connection'
 require 'active_record'
-
+require 'rubocop/rake_task'
+load "tasks/dev.rake"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc 'Run RuboCop style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
+  task.fail_on_error = true
+end
+
 namespace :db do
   task :environment do
     path = File.join(File.dirname(__FILE__), './db/migrate')
@@ -56,6 +64,12 @@ namespace :db do
     end
   end
 
+  namespace :schema do
+    task :load do
+      Rake::Task["db:migrate"].invoke
+    end
+  end
+
   desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
   task rollback: :configure_connection do
     step = ENV['STEP'] ? ENV['STEP'].to_i : 1

data/bin/jetty_wait

@@ -0,0 +1,14 @@
+#!/usr/bin/env sh
+
+until $(curl --output /dev/null --silent --head --fail http://localhost:8984/solr); do
+    printf '.'
+    sleep 1
+done
+until $(curl --output /dev/null --silent --head --fail http://localhost:8985/solr); do
+    printf '.'
+    sleep 1
+done
+until $(curl --output /dev/null --silent --head --fail http://localhost:8988/rest); do
+    printf '.'
+    sleep 1
+done

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/browserslist

@@ -0,0 +1,3 @@
+Last 2 versions
+Explorer >= 11
+Android >= 4.4

data/circle.yml

@@ -0,0 +1,17 @@
+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

data/config/fedora.yml

@@ -0,0 +1,10 @@
+development:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://localhost:<%= ENV['FCREPO_DEVELOPMENT_PORT'] || 8986 %>/rest
+  base_path: /dev
+test:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://localhost:<%= ENV['FCREPO_TEST_PORT'] || 8988 %>/rest
+  base_path: /test

data/db/migrate/20161007101725_create_orm_resources.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 class CreateOrmResources < ActiveRecord::Migration[5.0]
+  def options
+    if ENV["VALKYRIE_ID_TYPE"] == "string"
+      { id: :text, default: -> { '(uuid_generate_v4())::text' } }
+    else
+      { id: :uuid }
+    end
+  end
+
   def change
-    create_table :orm_resources, id: :uuid do |t|
+    create_table :orm_resources, **options do |t|
       t.jsonb :metadata, null: false, default: {}
       t.timestamps
     end

data/db/migrate/20171011224121_create_path_gin_index.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class CreatePathGinIndex < ActiveRecord::Migration[5.1]
+  def change
+    add_index :orm_resources, 'metadata jsonb_path_ops', using: :gin
+  end
+end

data/db/migrate/20171204224121_create_internal_resource_index.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class CreateInternalResourceIndex < ActiveRecord::Migration[5.1]
+  def change
+    add_index :orm_resources, :internal_resource
+  end
+end

data/db/migrate/20180212092225_create_updated_at_index.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class CreateUpdatedAtIndex < ActiveRecord::Migration[5.1]
+  def change
+    add_index :orm_resources, :updated_at
+  end
+end

data/lib/generators/valkyrie/templates/resource_spec.rb.erb

@@ -4,7 +4,7 @@ require 'rails_helper'
 require 'valkyrie/specs/shared_specs'
 
 RSpec.describe <%= class_name %> do
-  let(:model_klass) { described_class }
+  let(:resource_class) { described_class }
   it_behaves_like "a Valkyrie::Resource"
 
   it "has tests" do

data/lib/valkyrie.rb

@@ -15,11 +15,9 @@ require 'json/ld'
 require 'logger'
 require 'active_triples'
 require 'rdf/vocab'
+require 'rails'
 require 'active_fedora'
-require 'hydra-access-controls'
-require 'ruby_tika_app'
 
-# frozen_string_literal: true
 module Valkyrie
   require 'valkyrie/id'
   require 'valkyrie/change_set'
@@ -27,13 +25,9 @@ module Valkyrie
   require 'valkyrie/persistence'
   require 'valkyrie/types'
   require 'valkyrie/resource'
-  require 'valkyrie/derivative_service'
   require 'valkyrie/storage_adapter'
   require 'valkyrie/metadata_adapter'
   require 'valkyrie/adapter_container'
-  require 'valkyrie/file_characterization_service'
-  require 'valkyrie/decorators/decorator_list'
-  require 'valkyrie/decorators/decorator_with_arguments'
   require 'valkyrie/resource/access_controls'
   require 'valkyrie/indexers/access_controls_indexer'
   require 'valkyrie/storage'

data/lib/valkyrie/change_set.rb

@@ -14,6 +14,8 @@ module Valkyrie
   #     property :title, multiple: false, required: true
   #   end
   class ChangeSet < Reform::Form
+    include Reform::Form::ORM
+    include Reform::Form::ModelReflections
     include Reform::Form::ActiveModel::Validations
     feature Coercion
     class_attribute :fields
@@ -28,17 +30,17 @@ module Valkyrie
     end
 
     # Returns whether or not a given field has multiple values.
-    # @param field [Symbol]
+    # @param field_name [Symbol]
     # @return [Boolean]
-    def multiple?(field)
-      self.class.definitions[field.to_s][:multiple] != false
+    def multiple?(field_name)
+      field(field_name)[:multiple] != false
     end
 
     # Returns whether or not a given field is required.
-    # @param field [Symbol]
+    # @param field_name [Symbol]
     # @return [Boolean]
-    def required?(field)
-      self.class.definitions[field.to_s][:required]
+    def required?(field_name)
+      field(field_name)[:required] == true
     end
 
     # Quick setter for fields that should be in a changeset. Defaults to multiple,
@@ -70,15 +72,27 @@ module Valkyrie
     # override of Reform::Form's method to allow for single-valued fields to
     # prepopulate appropriately.
     def prepopulate!(_options = {})
-      self.class.definitions.select { |_field, definition| definition[:multiple] == false }.each do |field, _definition|
+      self.class.definitions.select { |_field, definition| definition[:multiple] == false }.each_key do |field|
         value = Array.wrap(send(field.to_s)).first
         send("#{field}=", value)
       end
+      super
       self
     end
 
     def resource
       model
     end
+
+    def valid?
+      errors.clear
+      super
+    end
+
+    private
+
+      def field(field_name)
+        self.class.definitions.fetch(field_name.to_s)
+      end
   end
 end

data/lib/valkyrie/engine.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+
+require 'rails/engine'
 ##
 # This engine exists for the sole purpose of enabling the
 #   `valkyrie_engine:install:migrations` rake task from an including Rails

data/lib/valkyrie/id.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 module Valkyrie
+  # A simple ID class to keep IDs distinguished from strings
   class ID
     attr_reader :id
     delegate :empty?, to: :id

data/lib/valkyrie/indexers/access_controls_indexer.rb

@@ -1,19 +1,63 @@
 # frozen_string_literal: true
 module Valkyrie::Indexers
+  # Provides an optional interface consistent with Hydra::AccessControls
+  #   This allows for storing access control information into an index
+  #
+  # @note This is used primarily with Solr
+  #
+  # @example Use in Solr Adapter with a CompositeIndexer
+  #
+  #   # insert into config/initializers/valkyrie.rb
+  #   Valkyrie::MetadataAdapter.register(
+  #       Valkyrie::Persistence::Solr::MetadataAdapter.new(
+  #           connection: Blacklight.default_index.connection,
+  #           resource_indexer: Valkyrie::Persistence::Solr::CompositeIndexer.new(
+  #               Valkyrie::Indexers::AccessControlsIndexer,
+  #               Collection::TypeIndexer
+  #           )
+  #       ),
+  #       :index_solr
+  #   )
+  #
+  # @see https://github.com/pulibrary/figgy/blob/684a4fb71cad1c9592d8272416f36e2a4f4ae3c4/config/initializers/valkyrie.rb#L82
+  # @see lib/valkyrie/resource/access_controls.rb
   class AccessControlsIndexer
-    attr_reader :resource
-    def initialize(resource:)
+    attr_reader :resource, :config
+    def initialize(resource:, config: default_config)
       @resource = resource
+      @config = config
     end
 
     def to_solr
       return {} unless resource.respond_to?(:read_users)
       {
-        Hydra.config[:permissions][:read].group => resource.read_groups,
-        Hydra.config[:permissions][:read].individual => resource.read_users,
-        Hydra.config[:permissions][:edit].individual => resource.edit_users,
-        Hydra.config[:permissions][:edit].group => resource.edit_groups
+        config.fetch(:read_groups) => resource.read_groups,
+        config.fetch(:read_users) => resource.read_users,
+        config.fetch(:edit_users) => resource.edit_users,
+        config.fetch(:edit_groups) => resource.edit_groups
       }
     end
+
+    private
+
+      # rubocop:disable Metrics/MethodLength
+      def default_config
+        if defined?(Hydra) && Hydra.respond_to?(:config)
+          {
+            read_groups: Hydra.config[:permissions][:read].group,
+            read_users: Hydra.config[:permissions][:read].individual,
+            edit_groups: Hydra.config[:permissions][:edit].group,
+            edit_users: Hydra.config[:permissions][:edit].individual
+          }
+        else
+          {
+            read_groups: 'read_access_group_ssim',
+            read_users: 'read_access_person_ssim',
+            edit_groups: 'edit_access_group_ssim',
+            edit_users: 'edit_access_person_ssim'
+          }
+        end
+      end
+    # rubocop:enable Metrics/MethodLength
   end
 end