valkyrie 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f119c2f2075460bb5804d672fe7c017834f43474
-  data.tar.gz: f6669d732ea1c5fa50ca1105a3a763cb7771be0d
+  metadata.gz: a5895a08d879fc01c20f546804cb147bb6287f4e
+  data.tar.gz: a7934d10ee04ed79c752159001f883aa15a32149
 SHA512:
-  metadata.gz: 3b8c59471418f2fe4a55709b80590fb0497817bd5feb6425c0e03cff28e133dd199a0f91ecd316c7f76a5abdbc74066d9ea2ed89210e05f39dfdfa2154d0387b
-  data.tar.gz: 93a4886173a45f0023db0ffd84da915d36188257a7ad45822b2c9eb0331a8dc162c576cb1fc4008e1cda913f80e0935f7074f7ca09fdfa4f4e7539391091cf73
+  metadata.gz: b8e7471ae686bd39aa04dc7e225dffa1348a06716faa4f824f9a11dd50df5e8e55cc8fd6a49fece559391b31840f62395090fa29f8a2a618b648152b1c840d02
+  data.tar.gz: da1d0422841bb1f24b902f839c95d754ade7b26b4767b22a22c4f33db9ed84090aab0c53b9d2cab88741d5741ad791a453db52a86cad671c727d454d92d51680

data/.gitignore

@@ -7,6 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
+/vendor

data/.rubocop.yml

@@ -0,0 +1,28 @@
+inherit_gem:
+  bixby: bixby_default.yml
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/*'
+    - 'db/schema.rb'
+    - 'vendor/**/*'
+RSpec/ScatteredSetup:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/valkyrie/specs/**/*'
+    - 'db/schema.rb'
+    - 'Rakefile'
+    - '*.gemspec'
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+Rails/TimeZone:
+  Enabled: false
+Style/PredicateName:
+  Exclude:
+    - "lib/valkyrie/resource.rb"
+    - "lib/valkyrie/persistence/solr/queries/default_paginator.rb"

data/Gemfile

@@ -1,4 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+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/README.md

@@ -1,35 +1,170 @@
 # Valkyrie
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/valkyrie`. To experiment with that code, run `bin/console` for an interactive prompt.
+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](..).
+
+[![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)
+[![Stories in Ready](https://badge.waffle.io/samvera-labs/valkyrie.png?label=ready&title=Ready)](https://waffle.io/samvera-labs/valkyrie)
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'valkyrie'
+gem 'valkyrie', github: 'samvera-labs/valkyrie'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
 
-    $ gem install valkyrie
+## Configuration
+
+Valkyrie is configured in two places: an initializer that registers the persistence options and a YAML
+configuration file that sets which options are used by default in which environments.
+
+### Sample initializer: `config/initializers/valkyrie.rb`:
+
+Here is a sample initializer that registers a couple adapters and storage adapters, in each case linking an
+instance with a short name that can be used to refer to it in your application:
+
+```
+# frozen_string_literal: true
+require 'valkyrie'
+Rails.application.config.to_prepare do
+  Valkyrie::MetadataAdapter.register(
+    Valkyrie::Persistence::Postgres::MetadataAdapter,
+    :postgres
+  )
+
+  Valkyrie::MetadataAdapter.register(
+    Valkyrie::Persistence::Memory::MetadataAdapter.new,
+    :memory
+  )
+
+  Valkyrie::StorageAdapter.register(
+    Valkyrie::Storage::Disk.new(base_path: Rails.root.join("tmp", "files")),
+    :disk
+  )
+
+  Valkyrie::StorageAdapter.register(
+    Valkyrie::Storage::Fedora.new(connection: ActiveFedora.fedora.connection),
+    :fedora
+  )
+
+
+  Valkyrie::StorageAdapter.register(
+    Valkyrie::Storage::Memory.new,
+    :memory
+  )
+end
+```
+
+The initializer registers two `Valkyrie::MetadataAdapter` instances for storing metadata:
+* `:postgres` which stores metadata in a PostgreSQL database
+* `:memory` which stores metadata in an in-memory cache (this cache is not persistent, so it is only
+  appropriate for testing)
+
+Other adapter options include `Valkyrie::Persistence::BufferedPersister` for buffering in memory before bulk
+updating another persister, `Valkyrie::Persistence::CompositePersister` for storing in more than one adapter
+at once, and `Valkyrie::Persistence::Solr` for storing in Solr.
+
+The initializer also registers three `Valkyrie::StorageAdapter` instances for storing files:
+* `:disk` which stores files on disk
+* `:fedora` which stores files in Fedora
+* `:memory` which stores files in an in-memory cache (again, not persistent, so this is only appropriate for
+  testing)
+
+### Sample configuration: `config/valkyrie.yml`:
+
+A sample configuration file that configures your application to use different adapters:
+
+```
+development:
+  adapter: postgres
+  storage_adapter: disk
+
+test:
+  adapter: memory
+  storage_adapter: memory
+
+production:
+  adapter: postgres
+  storage_adapter: fedora
+```
+
+For each environment, you must set two values:
+* `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.
+
 
 ## Usage
 
-TODO: Write usage instructions here
+### Define a Custom Work
+
+Define a custom work class:
+
+```
+# frozen_string_literal: true
+class MyModel < Valkyrie::Resource
+  include Valkyrie::Resource::AccessControls
+  attribute :id, Valkyrie::Types::ID.optional  # Optional to allow auto-generation of IDs
+  attribute :title, Valkyrie::Types::Set       # Sets are unordered
+  attribute :authors, Valkyrie::Types::Array   # Arrays are ordered
+end
+```
+
+#### Work Types Generator
+
+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:
+
+```
+rails generate valkyrie:model 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
+```
+
+### Read and Write Data
+
+```
+# create an object
+object1 = MyModel.new title: 'My Cool Object', authors: ['Jones, Alice', 'Smith, Bob']
+object1 = Persister.save(model: object1)
+
+# load an object from the database
+object2 = QueryService.find_by(id: object1.id)
+
+# load all objects
+objects = QueryService.find_all
+
+# load all MyModel objects
+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`
+
 
-## Development
+## License
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Valkyrie is available under [the Apache 2.0 license](../LICENSE).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/valkyrie.
+Bug reports and pull requests are welcome on GitHub at https://github.com/samvera-labs/valkyrie/.

data/Rakefile

@@ -1,6 +1,64 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'yaml'
+require 'config/database_connection'
+require 'active_record'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
+namespace :db do
+  task :environment do
+    path = File.join(File.dirname(__FILE__), './db/migrate')
+    migrations_paths = [path]
+    DATABASE_ENV = ENV['RACK_ENV'] || 'test'
+    MIGRATIONS_DIR = ENV['MIGRATIONS_DIR'] || migrations_paths
+  end
+
+  task configuration: :environment do
+    @config = YAML.safe_load(ERB.new(File.read("db/config.yml")).result)[DATABASE_ENV]
+  end
+
+  task configure_connection: :configuration do
+    DatabaseConnection.connect!(DATABASE_ENV)
+    ActiveRecord::Base.logger = Logger.new STDOUT if @config['logger']
+  end
+
+  desc 'Create the database from db/config.yml for the current DATABASE_ENV'
+  task create: :configure_connection do
+    database = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(@config)
+    database.create
+    puts "Database created"
+  end
+
+  desc 'Drops the database for the current DATABASE_ENV'
+  task drop: :configure_connection do
+    database = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(@config)
+    database.drop
+    puts "Database dropped"
+  end
+
+  desc 'Migrate the database (options: VERSION=x, VERBOSE=false).'
+  task migrate: :configure_connection do
+    begin
+      verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+      version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+      scope   = ENV['SCOPE']
+      verbose_was = ActiveRecord::Migration.verbose
+      ActiveRecord::Migration.verbose = verbose
+      ActiveRecord::Migrator.migrate(MIGRATIONS_DIR, version) do |migration|
+        scope.blank? || scope == migration.scope
+      end
+      ActiveRecord::Base.clear_cache!
+    ensure
+      ActiveRecord::Migration.verbose = verbose_was
+    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
+    ActiveRecord::Migrator.rollback(MIGRATIONS_DIR, step)
+  end
+end

data/bin/console

@@ -11,4 +11,4 @@ require "valkyrie"
 # Pry.start
 
 require "irb"
-IRB.start(__FILE__)
+IRB.start

data/config/valkyrie.yml

@@ -0,0 +1,8 @@
+---
+test:
+  metadata_adapter: test
+  storage_adapter: test
+development:
+  metadata_adapter: test
+  storage_adapter: test
+production:

data/db/config.yml

@@ -0,0 +1,17 @@
+development: &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
+
+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
+  database: Valkyrie_gem_test

data/db/migrate/20160111215816_enable_uuid_extension.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class EnableUuidExtension < ActiveRecord::Migration[5.0]
+  def change
+    enable_extension 'uuid-ossp'
+  end
+end

data/db/migrate/20161007101725_create_orm_resources.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+class CreateOrmResources < ActiveRecord::Migration[5.0]
+  def change
+    create_table :orm_resources, id: :uuid do |t|
+      t.jsonb :metadata, null: false, default: {}
+      t.timestamps
+    end
+    add_index :orm_resources, :metadata, using: :gin
+  end
+end

data/db/migrate/20170124135846_add_model_type_to_orm_resources.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class AddModelTypeToOrmResources < ActiveRecord::Migration[5.0]
+  def change
+    add_column :orm_resources, :resource_type, :string
+  end
+end

data/db/migrate/20170531004548_change_model_type_to_internal_model.rb

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

data/db/schema.rb

@@ -0,0 +1,65 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20170531004548) do
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+  enable_extension "uuid-ossp"
+
+  create_table "bookmarks", id: :serial, force: :cascade do |t|
+    t.integer "user_id", null: false
+    t.string "user_type"
+    t.string "document_id"
+    t.string "document_type"
+    t.binary "title"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["document_id"], name: "index_bookmarks_on_document_id"
+    t.index ["user_id"], name: "index_bookmarks_on_user_id"
+  end
+
+  create_table "orm_resources", id: :uuid, default: -> { "uuid_generate_v4()" }, force: :cascade do |t|
+    t.jsonb "metadata", default: {}, null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.string "internal_resource"
+    t.index ["metadata"], name: "index_orm_resources_on_metadata", using: :gin
+  end
+
+  create_table "searches", id: :serial, force: :cascade do |t|
+    t.binary "query_params"
+    t.integer "user_id"
+    t.string "user_type"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["user_id"], name: "index_searches_on_user_id"
+  end
+
+  create_table "users", id: :serial, force: :cascade do |t|
+    t.string "email", default: "", null: false
+    t.string "encrypted_password", default: "", null: false
+    t.string "reset_password_token"
+    t.datetime "reset_password_sent_at"
+    t.datetime "remember_created_at"
+    t.integer "sign_in_count", default: 0, null: false
+    t.datetime "current_sign_in_at"
+    t.datetime "last_sign_in_at"
+    t.inet "current_sign_in_ip"
+    t.inet "last_sign_in_ip"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.boolean "guest", default: false
+    t.index ["email"], name: "index_users_on_email", unique: true
+    t.index ["reset_password_token"], name: "index_users_on_reset_password_token", unique: true
+  end
+
+end