valkyrie 2.0.0 → 2.1.2

data/Rakefile

@@ -6,7 +6,6 @@ require 'config/database_connection'
 require 'active_record'
 require 'rubocop/rake_task'
 load 'tasks/dev.rake'
-load 'tasks/docker.rake'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -37,8 +36,12 @@ namespace :db do
 
   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
+    begin
+      database = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(@config)
+      database.create
+    rescue
+      puts "Database already exists."
+    end
     puts "Database created"
   end
 
@@ -51,25 +54,23 @@ namespace :db do
 
   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
-      if ActiveRecord::Migrator.respond_to?(:migrate)
-        ActiveRecord::Migrator.migrate(MIGRATIONS_DIR, version) do |migration|
-          scope.blank? || scope == migration.scope
-        end
-      else
-        ActiveRecord::Base.connection.migration_context.migrate(version) do |migration|
-          scope.blank? || scope == migration.scope
-        end
+    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
+    if ActiveRecord::Migrator.respond_to?(:migrate)
+      ActiveRecord::Migrator.migrate(MIGRATIONS_DIR, version) do |migration|
+        scope.blank? || scope == migration.scope
+      end
+    else
+      ActiveRecord::Base.connection.migration_context.migrate(version) do |migration|
+        scope.blank? || scope == migration.scope
       end
-      ActiveRecord::Base.clear_cache!
-    ensure
-      ActiveRecord::Migration.verbose = verbose_was
     end
+    ActiveRecord::Base.clear_cache!
+  ensure
+    ActiveRecord::Migration.verbose = verbose_was
   end
 
   namespace :schema do

data/db/config.yml

@@ -1,4 +1,3 @@
-<% local = File.exist?('/tmp/.s.PGSQL.5432') && File.stat('/tmp/.s.PGSQL.5432').socket? %>
 default: &default
   adapter: postgresql
   encoding: utf8
@@ -6,22 +5,16 @@ default: &default
   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 %>
+  username: postgres
+  password: 
 
 development:
   <<: *default
   database: Valkyrie_gem_development
-  <% unless local %>
   port: 5433
-  <% end %>
 
 test:
   <<: *default
   database: Valkyrie_gem_test
-  <% unless local %>
-  port: 5434
-  <% end %>
+  port: <%= ENV["POSTGRES_PORT"] || 5433 %>

data/db/schema.rb

@@ -15,18 +15,6 @@ ActiveRecord::Schema.define(version: 20170531004548) do
   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
@@ -34,32 +22,4 @@ ActiveRecord::Schema.define(version: 20170531004548) do
     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

data/gemfiles/activerecord_5_2.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source "https://rubygems.org"

data/gemfiles/{activerecord_5_1.gemfile → activerecord_6_0.gemfile}

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 5.1.0"
+gem "activerecord", "~> 6.0.0"
 gem "ldp"
 gem "pg"
 gem "rsolr"

data/lib/generators/valkyrie/resource_generator.rb

@@ -21,7 +21,7 @@ class Valkyrie::ResourceGenerator < Rails::Generators::NamedBase
 
   private
 
-    def rspec_installed?
-      defined?(RSpec) && defined?(RSpec::Rails)
-    end
+  def rspec_installed?
+    defined?(RSpec) && defined?(RSpec::Rails)
+  end
 end

data/lib/valkyrie.rb

@@ -14,6 +14,7 @@ require 'logger'
 require 'rdf/vocab'
 
 module Valkyrie
+  require 'valkyrie/logging'
   require 'valkyrie/id'
   require 'valkyrie/change_set'
   require 'valkyrie/value_mapper'
@@ -61,12 +62,16 @@ module Valkyrie
     end
   end
 
+  # @return [Valkyrie::Logging]
   def logger
-    @logger ||= Logger.new(STDOUT)
+    @logger ||= Valkyrie::Logging.new(logger: Logger.new(STDOUT))
   end
 
+  # Wraps the given logger in an instance of Valkyrie::Logging
+  #
+  # @param logger [Logger]
   def logger=(logger)
-    @logger = logger
+    @logger = Valkyrie::Logging.new(logger: logger)
   end
 
   class Config < OpenStruct
@@ -82,6 +87,19 @@ module Valkyrie
       Valkyrie::StorageAdapter.find(super.to_sym)
     end
 
+    # @api public
+    # Configure id_string_equality to be true in order to make Valkyrie::ID
+    # equal to the string value they contain. This will be the default behavior
+    # in v3.0.0.
+    #
+    # @return [Boolean] Whether `Valkyrie::ID` should be equal to their string counterpart.
+    def id_string_equality
+      super
+    end
+
+    # @!attribute [w] id_string_equality=
+    #   The setter for #id_string_equality; see it's implementation
+
     # @api public
     #
     # The returned anonymous method (e.g. responds to #call) has a signature of
@@ -101,19 +119,19 @@ module Valkyrie
 
     private
 
-      def defaults
-        {
-          resource_class_resolver: method(:default_resource_class_resolver)
-        }
-      end
-
-      # String constantize is a "by convention" factory. This works, but assumes
-      # the ruby class once used to persist is the model used to now reify.
-      #
-      # @param [String] class_name
-      def default_resource_class_resolver(class_name)
-        class_name.constantize
-      end
+    def defaults
+      {
+        resource_class_resolver: method(:default_resource_class_resolver)
+      }
+    end
+
+    # String constantize is a "by convention" factory. This works, but assumes
+    # the ruby class once used to persist is the model used to now reify.
+    #
+    # @param [String] class_name
+    def default_resource_class_resolver(class_name)
+      class_name.constantize
+    end
   end
 
   module_function :config, :logger, :logger=, :config_root_path, :environment, :config_file, :config_hash

data/lib/valkyrie/change_set.rb

@@ -104,8 +104,8 @@ module Valkyrie
 
     private
 
-      def field(field_name)
-        self.class.definitions.fetch(field_name.to_s)
-      end
+    def field(field_name)
+      self.class.definitions.fetch(field_name.to_s)
+    end
   end
 end

data/lib/valkyrie/id.rb

@@ -10,21 +10,44 @@ module Valkyrie
       @id = id.to_s
     end
 
+    ##
+    # @return [String]
     def to_s
+      to_str
+    end
+
+    ##
+    # @return [String]
+    def to_str
       id
     end
 
     delegate :hash, to: :state
 
     def eql?(other)
-      other.class == self.class && other.state == state
+      return string_equality(other) if Valkyrie.config.id_string_equality == true
+      default_equality(other)
     end
     alias == eql?
 
     protected
 
-      def state
-        [@id]
+    def default_equality(other)
+      output = (other.class == self.class && other.state == state)
+      return output if output == true
+      if output == false && string_equality(other) && Valkyrie.config.id_string_equality.nil?
+        warn "[DEPRECATION] Valkyrie::IDs will always be equal to their string counterparts in 3.0.0. " \
+          "To silence this message, please either compare IDs or set Valkyrie.config.id_string_equality = true."
       end
+      false
+    end
+
+    def string_equality(other)
+      other == to_str
+    end
+
+    def state
+      [@id]
+    end
   end
 end

data/lib/valkyrie/indexers/access_controls_indexer.rb

@@ -40,24 +40,24 @@ module Valkyrie::Indexers
 
     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
+    # 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

data/lib/valkyrie/logging.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+module Valkyrie
+  # A wrapper class for Valkyrie logging. This class attempts to provide
+  # tooling that helps improve the communication through-out the stack.
+  #
+  # In gem development there are several considerations regarding logging.
+  #
+  # 1) The development on the gem directly, in particular specs
+  # 2) The downstream development that leverages the gem, both when specs are
+  #    running and when running the downstream processes in a development
+  #    environment.
+  # 3) The downstream behaviors that are called in production environments.
+  #
+  # In each of these cases, different considerations regarding logging may be
+  # relevant.
+  #
+  # In the below example,
+  #
+  # @example
+  #   Valkyrie.logger.suppress_logging_for_contexts!("A Named Context") do
+  #     # The following will NOT be logged
+  #     Valkyrie.logger.warn('Hello', logging_context: "A Named Context")
+  #
+  #     # The following will be logged
+  #     Valkyrie.logger.warn('Hello')
+  #   end
+  #   # The following will be logged
+  #   Valkyrie.logger.warn('Hello', logging_context: "A Named Context")
+
+  class Logging < SimpleDelegator
+    # @param logger [Logger] the logger to which we'll delegate messages
+    def initialize(logger:)
+      @suppressions = {}
+      super(logger)
+    end
+
+    def warn(*args, logging_context: false, &block)
+      super(*args, *block) unless @suppressions.key?(logging_context)
+    end
+
+    def error(*args, logging_context: false, &block)
+      super(*args, *block) unless @suppressions.key?(logging_context)
+    end
+
+    def info(*args, logging_context: false, &block)
+      super(*args, *block) unless @suppressions.key?(logging_context)
+    end
+
+    def debug(*args, logging_context: false, &block)
+      super(*args, *block) unless @suppressions.key?(logging_context)
+    end
+
+    def fatal(*args, logging_context: false, &block)
+      super(*args, *block) unless @suppressions.key?(logging_context)
+    end
+
+    def suppress_logging_for_contexts!(*logging_contexts)
+      Array(logging_contexts).each do |logging_context|
+        @suppressions[logging_context] = true
+      end
+      return unless block_given?
+      yield
+      clear_suppressions!(*logging_contexts)
+    end
+
+    def clear_suppressions!(*logging_contexts)
+      Array(logging_contexts).each do |logging_context|
+        @suppressions.delete(logging_context)
+      end
+    end
+  end
+end

data/lib/valkyrie/persistence/composite_persister.rb

@@ -30,7 +30,7 @@ module Valkyrie::Persistence
       cached_resource = first.save(resource: resource)
       # Don't pass opt lock tokens to other persisters
       internal_resource = cached_resource.dup
-      internal_resource.send("#{Valkyrie::Persistence::Attributes::OPTIMISTIC_LOCK}=", []) if internal_resource.optimistic_locking_enabled?
+      internal_resource.clear_optimistic_lock_token!
       rest.inject(internal_resource) { |m, persister| persister.save(resource: m) }
       # return the one with the desired opt lock token
       cached_resource

data/lib/valkyrie/persistence/fedora.rb

@@ -19,5 +19,7 @@ module Valkyrie::Persistence
     require 'valkyrie/persistence/fedora/ordered_list'
     require 'valkyrie/persistence/fedora/ordered_reader'
     require 'valkyrie/persistence/fedora/list_node'
+
+    DEFAULT_FEDORA_VERSION = 5
   end
 end