valkyrie 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06e5a897c18679418660d531ae88c69f4ed675289080ddf712a52d2efa700344
-  data.tar.gz: 78c96247bff42a505751b299f3314c4028240c2e68ac727d42cb71d1f92ab8af
+  metadata.gz: 67949cb5bed2cbcf96fa0919446f7e94288874371cca3f706fed156775b3c63f
+  data.tar.gz: febfd165c53533252232090bd427fb5f970b85053a314ff991f15d851bda078a
 SHA512:
-  metadata.gz: dcbf37ca3daa89d25bf7c28d0d1684c2959fb6d26eff6ba8ca427b64f6a4413774702dd588a19e797648266b26786f526eb3b6423a2aeb48d78e8a0d4c6603f5
-  data.tar.gz: 20dc3cc1aacd225b29eec0d2cdafe8bc42c7d46b0bdbd4ad81af75dae79017477fb116b00320c9d4be4bf5e7aa5fcd23b6a88c8d4b5c7ac7dbaeb436ebed8caa
+  metadata.gz: ba0e9e518bb437c93c1e27a21c851af5eaea423cbc863b7f68b555017a98a663ead92ea51bfcb5edcf5975b013b95f2179a5805aca9f988e269ff0beef85686a
+  data.tar.gz: ae2a939e6ab89a5e704a2a8234a7addc93d1f946a260aa9860d0beab87ef8eeb66d6d789a06e3fe40c2abd8d92f2ec25edd7f9889c4f23cdc8ea213cf29d1a4c

data/.circleci/config.yml

@@ -75,26 +75,14 @@ workflows:
           gemfile: "gemfiles/activerecord_5_2.gemfile"
           ruby: 2.6.3
           name: "Ruby2-6_Rails5-2"
-      - build:
-          gemfile: "gemfiles/activerecord_5_1.gemfile"
-          ruby: 2.6.3
-          name: "Ruby2-6_Rails5-1"
       - build:
           gemfile: "gemfiles/activerecord_5_2.gemfile"
           ruby: 2.5.5
           name: "Ruby2-5_Rails5-2"
-      - build:
-          gemfile: "gemfiles/activerecord_5_1.gemfile"
-          ruby: 2.5.5
-          name: "Ruby2-5_Rails5-1"
       - build:
           gemfile: "gemfiles/activerecord_5_2.gemfile"
           ruby: 2.4.6
           name: "Ruby2-4_Rails5-2"
-      - build:
-          gemfile: "gemfiles/activerecord_5_1.gemfile"
-          ruby: 2.4.6
-          name: "Ruby2-4_Rails5-1"
   nightly:
     triggers:
       - schedule:
@@ -112,23 +100,11 @@ workflows:
           gemfile: "gemfiles/activerecord_5_2.gemfile"
           ruby: 2.6.3
           name: "Ruby2-6_Rails5-2"
-      - build:
-          gemfile: "gemfiles/activerecord_5_1.gemfile"
-          ruby: 2.6.3
-          name: "Ruby2-6_Rails5-1"
       - build:
           gemfile: "gemfiles/activerecord_5_2.gemfile"
           ruby: 2.5.5
           name: "Ruby2-5_Rails5-2"
-      - build:
-          gemfile: "gemfiles/activerecord_5_1.gemfile"
-          ruby: 2.5.5
-          name: "Ruby2-5_Rails5-1"
       - build:
           gemfile: "gemfiles/activerecord_5_2.gemfile"
           ruby: 2.4.6
           name: "Ruby2-4_Rails5-2"
-      - build:
-          gemfile: "gemfiles/activerecord_5_1.gemfile"
-          ruby: 2.4.6
-          name: "Ruby2-4_Rails5-1"

data/Appraisals

@@ -6,7 +6,3 @@ end
 appraise "activerecord-5-2" do
   gem "activerecord", "~> 5.2.0"
 end
-
-appraise "activerecord-5-1" do
-  gem "activerecord", "~> 5.1.0"
-end

data/CHANGELOG.md

@@ -1,3 +1,68 @@
+# v2.1.0 2020-01-09
+
+## Changes since last release
+
+* Use `::` prefixed names for `JSON::LD` references.
+  [no-reply](https://github.com/no-reply)
+* Use SVG instead of PNG for version badge.
+  [hackmastera](https://github.com/hackmastera)
+* Fix Rubocop for latest Bixby.
+  [hackmastera](https://github.com/hackmastera)
+* Valkyrie IDs equal string equivalent of ID to String with config
+  [jlevnhv](https://github.com/jlevnhv)
+* Add optional model parameter to find_inverse_references_by and
+find_references_by
+  [elrayle](https://github.com/elrayle)
+  [laritakr](https://github.com/laritakr)
+* Add parity in schema.key lookup for `ordered_attribute?`
+  [jeremyf](https://github.com/jeremyf)
+* Order member_ids when using schema-style attributes method.
+  [no-reply](https://github.com/no-reply)
+* Use DEFAULT_FEDORA_VERSION constant for Fedora adapter.
+  [no-reply](https://github.com/no-reply)
+* Stop testing ActiveRecord 5.1
+  [scherztc](https://github.com/scherztc)
+* Rename ListNode#target_uri to ListNode#target
+  [mbklein](https://github.com/mbklein)
+* Document that Solr Persister is intended to be used as a secondary persister.
+  [hweng](https://github.com/hweng)
+* Remove unused database tables from schema.rb
+  [scherztc](https://github.com/scherztc)
+* Alternate Identifier documentation
+  [escowles](https://github.com/escowles)
+* Remove suggest component in example Solr Config
+  [hweng](https://github.com/hweng)
+* Remove unused db/seeds.rb
+  [scherztc](https://github.com/scherztc)
+* Replace YARD Doc for Solr adapter with references to Memory Adapter.
+  [afred](https://github.com/afred)
+* Refactor shadowed variable in buffered persister spec.
+  [jeremyf](https://github.com/jeremyf)
+* Use example.com instead of made-up URLs
+  [escowles](https://github.com/escowles)
+* Add count_all_of_model query
+  [christinach](https://github.com/christinach)
+  [blancoj](https://github.com/blancoj)
+* Raise an error when unable to find a StorageAdapter
+  [bkiahstroud](https://github.com/bkiahstroud)
+  [FCRodriguez7](https://github.com/FCRodriguez7)
+  [kcompsci](https://github.com/kcompsci)
+* Allow find_inverse_reference_by property to be either ordered or not.
+  [elrayle](https://github.com/elrayle)
+* Randomized spec order
+  [jeremyf](https://github.com/jeremyf)
+* Allow Valkyrie logging to be tagged with a context and suppressed.
+  [jeremyf](https://github.com/jeremyf)
+* Fix documentation for Valkyrie::Persister::Memory being disassociated.
+  [jeremyf](https://github.com/jeremyf)
+* Suppress Solr warnings in tests.
+  [jeremyf](https://github.com/jeremyf)
+* Add `Valkyrie::Types::Relation` and `Valkyrie::Types::OrderedRelation`
+  [luisgreg99](https://github.com/luisgreg99)
+  [lsat12357](https://github.com/lsat12357)
+  [foglabs](https://github.com/foglabs)
+  [dgcliff](https://github.com/dgcliff)
+
 # v2.0.2 2019-10-17
 
 ## Changes since last release

data/README.md

@@ -4,7 +4,7 @@ Valkyrie is a gem for enabling multiple backends for storage of files and metada
 
 ![Valkyrie Logo](valkyrie_logo.png)
 
-Code: [![Version](https://badge.fury.io/rb/valkyrie.png)](http://badge.fury.io/rb/valkyrie)
+Code: [![Gem Version](https://badge.fury.io/rb/valkyrie.svg)](https://badge.fury.io/rb/valkyrie)
 [![Build Status](https://circleci.com/gh/samvera/valkyrie.svg?style=svg)](https://circleci.com/gh/samvera/valkyrie)
 ![Coverage Status](https://img.shields.io/badge/Coverage-100-brightgreen.svg)
 
@@ -107,7 +107,7 @@ The initializer registers four `Valkyrie::MetadataAdapter` instances for storing
 * `:memory` which stores metadata in an in-memory cache (this cache is not persistent, so it is only
   appropriate for testing).
 * `:postgres` which stores metadata in a PostgreSQL database.
-* `:solr` which stores metadata in a Solr Index.
+* `:solr` which stores metadata in a Solr Index (Solr Persister issues a warning if it has to generate an ID for a new resource because it is intended to be used as a secondary persister).
 
 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

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_6_0.gemfile

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

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

data/lib/valkyrie/id.rb

@@ -17,12 +17,27 @@ module Valkyrie
     delegate :hash, to: :state
 
     def eql?(other)
-      other.class == self.class && other.state == state
+      return (default_equality(other) || string_equality(other)) if Valkyrie.config.id_string_equality == true
+      default_equality(other)
     end
     alias == eql?
 
     protected
 
+      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_s == to_s
+      end
+
       def state
         [@id]
       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

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

@@ -18,7 +18,6 @@ module Valkyrie::Persistence::Fedora
   class ListNode
     attr_reader :rdf_subject, :graph
     attr_writer :next, :prev
-    attr_accessor :target
     attr_writer :next_uri, :prev_uri
     attr_accessor :proxy_in, :proxy_for
     attr_reader :adapter
@@ -59,16 +58,15 @@ module Valkyrie::Persistence::Fedora
     def to_graph
       return RDF::Graph.new if target_id.blank?
       g = Resource.new(rdf_subject)
-      g.proxy_for = target_uri
+      g.proxy_for = target
       g.proxy_in = proxy_in.try(:uri)
       g.next = self.next.try(:rdf_subject)
       g.prev = prev.try(:rdf_subject)
       g.graph
     end
 
-    # Resolves the URI for the value of the list expression
-    # @return [RDF::URI]
-    def target_uri
+    # @return [RDF::URI] or [String]
+    def target
       if target_id.is_a?(Valkyrie::ID)
         adapter.id_to_uri(target_id.to_s)
       else
@@ -76,7 +74,6 @@ module Valkyrie::Persistence::Fedora
       end
     end
 
-    # Generates the string ID value for the value in the list expression
     # @return [String]
     def target_id
       if proxy_for.to_s.include?("/") && proxy_for.to_s.start_with?(adapter.connection_prefix)

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

@@ -6,7 +6,7 @@ module Valkyrie::Persistence::Fedora
   #   Valkyrie::Persistence::Fedora::MetadataAdapter.new(
   #     connection: ::Ldp::Client.new("http://localhost:8988/rest"),
   #     base_path: "test_fed",
-  #     schema: Valkyrie::Persistence::Fedora::PermissiveSchema.new(title: RDF::URI("http://bad.com/title"))
+  #     schema: Valkyrie::Persistence::Fedora::PermissiveSchema.new(title: RDF::URI("http://example.com/title"))
   #   )
   class MetadataAdapter
     attr_reader :connection, :base_path, :schema, :fedora_version
@@ -15,7 +15,7 @@ module Valkyrie::Persistence::Fedora
     # @param [String] base_path
     # @param [Valkyrie::Persistence::Fedora::PermissiveSchema] schema
     # @param [Integer] fedora_version
-    def initialize(connection:, base_path: "/", schema: Valkyrie::Persistence::Fedora::PermissiveSchema.new, fedora_version: 5)
+    def initialize(connection:, base_path: "/", schema: Valkyrie::Persistence::Fedora::PermissiveSchema.new, fedora_version: Valkyrie::Persistence::Fedora::DEFAULT_FEDORA_VERSION)
       @connection = connection
       @base_path = base_path
       @schema = schema