hyrax 3.0.0.pre.beta1 → 3.0.0.pre.beta2

data/lib/generators/hyrax/templates/catalog_controller.rb

@@ -161,7 +161,7 @@ class CatalogController < ApplicationController
     end
 
     config.add_search_field('description') do |field|
-      field.label = "Abstract or Summary"
+      field.label = "Description"
       solr_name = solr_name("description", :stored_searchable)
       field.solr_local_parameters = {
         qf: solr_name,

data/lib/generators/hyrax/templates/config/locales/hyrax.pt-BR.yml

@@ -5,7 +5,7 @@ pt-BR:
       fields:
         facet:
           based_near_label_sim: Localização
-          creator_sim: O Criador
+          creator_sim: Criador
           file_format_sim: Formato
           generic_type_sim: Tipo
           keyword_sim: Palavra-chave
@@ -16,9 +16,9 @@ pt-BR:
           based_near_tesim: Localização
           contributor_tesim: Contribuinte
           creator_tesim: O Criador
-          date_created_tesim: Data Criada
-          date_modified_dtsi: Data modificada
-          date_uploaded_dtsi: Data carregada
+          date_created_tesim: Data de Criação
+          date_modified_dtsi: Data de Modificação
+          date_uploaded_dtsi: Data de Carga
           description_tesim: Descrição
           file_format_tesim: Formato de arquivo
           identifier_tesim: Identificador
@@ -30,11 +30,11 @@ pt-BR:
           subject_tesim: Sujeito
         show:
           based_near_tesim: Localização
-          contributor_tesim: Contribuinte
-          creator_tesim: O Criador
-          date_created_tesim: Data Criada
-          date_modified_dtsi: Data modificada
-          date_uploaded_dtsi: Data carregada
+          contributor_tesim: Colaborador
+          creator_tesim: Criador
+          date_created_tesim: Data de Criação
+          date_modified_dtsi: Data de Modificação
+          date_uploaded_dtsi: Data de Carga
           description_tesim: Descrição
           file_format_tesim: Formato de arquivo
           identifier_tesim: Identificador
@@ -50,7 +50,7 @@ pt-BR:
     directory:
       suffix: "@ Example.org"
     footer:
-      copyright_html: "<strong>Copyright © 2017 Samvera Licenciado</strong> sob a Licença Apache, Versão 2.0"
+      copyright_html: "<strong>Copyright © 2018 Samvera </strong> Licenciado sob a Licença Apache, Versão 2.0"
       service_html: Um serviço de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a> .
     institution_name: Instituição
     institution_name_full: O Nome da Instituição

data/lib/generators/hyrax/work/templates/locale.pt-BR.yml.erb

@@ -4,5 +4,5 @@ pt-BR:
       <%= file_name %>:     'fa fa-file-text-o'
     select_type:
       <%= file_name %>:
-        description:        "<%= human_name %> trabalhos"
+        description:        "<%= human_name %> obras"
         name:               "<%= human_name.titleize %>"

data/lib/hyrax/configuration.rb

@@ -222,6 +222,24 @@ module Hyrax
       registered_curation_concern_types.map(&:constantize)
     end
 
+    # The MetadataAdapter to use when persisting resources with Valkyrie
+    #
+    # @see lib/wings
+    # @see https://github.com/samvera-labs/valkyrie
+    def valkyrie_metadata_adapter
+      @valkyrie_metadata_adapter ||= :wings_adapter
+    end
+    attr_writer :valkyrie_metadata_adapter
+
+    # The StorageAdapter to use when persisting resources with Valkyrie
+    #
+    # @see lib/wings
+    # @see https://github.com/samvera-labs/valkyrie
+    def valkyrie_storage_adapter
+      @valkyrie_storage_adapter ||= :fedora
+    end
+    attr_writer :valkyrie_storage_adapter
+
     # A configuration point for changing the behavior of the license service.
     #
     # @!attribute [w] license_service_class

data/lib/hyrax/engine.rb

@@ -70,6 +70,14 @@ module Hyrax
       require 'dry/struct'
       require 'dry/equalizer'
       require 'dry/validation'
+      begin
+        require 'valkyrie'
+      rescue LoadError
+        message  = "Hyrax::Engine.initializer did not load Valkyrie. We are in the process\n"
+        message += "\tof adding Valkyrie to Hyrax; For now you need do nothing. However,\n"
+        message += "\tstay tuned for release notes on what are the steps for incorporating Valkyrie."
+        Rails.logger.info(message)
+      end
     end
 
     initializer 'routing' do

data/lib/hyrax/transactions/container.rb

@@ -19,7 +19,9 @@ module Hyrax
     # @see https://dry-rb.org/gems/dry-container/
     class Container
       require 'hyrax/transactions/create_work'
+      require 'hyrax/transactions/destroy_work'
       require 'hyrax/transactions/steps/apply_permission_template'
+      require 'hyrax/transactions/steps/destroy_work'
       require 'hyrax/transactions/steps/ensure_admin_set'
       require 'hyrax/transactions/steps/ensure_permission_template'
       require 'hyrax/transactions/steps/save_work'
@@ -34,6 +36,10 @@ module Hyrax
           Steps::ApplyPermissionTemplate.new
         end
 
+        ops.register 'destroy_work' do
+          Steps::DestroyWork.new
+        end
+
         ops.register 'ensure_admin_set' do
           Steps::EnsureAdminSet.new
         end

data/lib/hyrax/transactions/destroy_work.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    ##
+    # A transaction for destroying a Hyrax Work.
+    #
+    # @note This is an experimental replacement for the actor stack's `#destroy`
+    #   stack. In time, we hope this will have feature parity with that stack,
+    #   along with improved architecture, error handling, readability, and
+    #   customizability. While this develops, please provide feedback.
+    #
+    # @since 3.0.0
+    #
+    # @see https://dry-rb.org/gems/dry-transaction/
+    class DestroyWork
+      include Dry::Transaction(container: Hyrax::Transactions::Container)
+
+      step :destroy_work, with: 'work.destroy_work'
+    end
+  end
+end

data/lib/hyrax/transactions/steps/destroy_work.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transcation` step that destroys a Work.
+      #
+      # @since 3.0.0
+      class DestroyWork
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        #
+        # @return [Dry::Monads::Result]
+        def call(work)
+          work.destroy! && Success(work)
+        rescue => err
+          Failure(err)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/version.rb

@@ -1,3 +1,3 @@
 module Hyrax
-  VERSION = '3.0.0-beta1'.freeze
+  VERSION = '3.0.0-beta2'.freeze
 end

data/lib/wings.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+##
+# Wings is a toolkit integrating Valkyrie into Hyrax as a bridge away from the
+# hard dependency on ActiveFedora.
+#
+# Requiring this module with `require 'wings'` injects a variety of behavior
+# supporting a gradual transition from existing `ActiveFedora` models and
+# persistence middleware to Valkyrie.
+#
+# `Wings` is primarily an isolating namespace for code intended to be removed
+# after a full transition to `Valkyrie` as the persistence middleware for Hyrax.
+# Applications may find it useful to depend directly on this code to facilitate
+# a smooth code migration, much in the way it is being used in this engine.
+# However, these dependencies should be considered temprorary: this code will
+# be deprecated for removal in a future release.
+#
+# @see https://wiki.duraspace.org/display/samvera/Hyrax-Valkyrie+Development+Working+Group
+#      for further context regarding the approach
+module Wings; end
+
+require 'valkyrie'
+require 'wings/model_transformer'
+require 'wings/resource_factory'
+require 'wings/valkyrizable'
+require 'wings/valkyrie/metadata_adapter'
+require 'wings/valkyrie/resource_factory'
+require 'wings/valkyrie/persister'
+require 'wings/valkyrie/query_service'
+
+ActiveFedora::Base.include Wings::Valkyrizable
+
+Valkyrie.config.resource_class_resolver = lambda do |_klass_name|
+  Wings::ModelTransformer.convert_class_name_to_valkyrie_resource_class(internal_resource)
+end
+
+Valkyrie::MetadataAdapter.register(
+  Wings::Valkyrie::MetadataAdapter.new, :wings_adapter
+)
+
+Valkyrie::StorageAdapter.register(
+  Valkyrie::Storage::Fedora
+    .new(connection: Ldp::Client.new(ActiveFedora.fedora.host)),
+  :fedora
+)

data/lib/wings/active_fedora_converter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Wings
+  ##
+  # Converts `ValkyrieResource` objects to legacy `ActiveFedora::Base` objects.
+  #
+  # @example
+  #   work     = GenericWork.new(title: ['Comet in Moominland'])
+  #   resource = GenericWork.valkyrie_resource
+  #
+  #   ActiveFedoraConverter.new(resource: resource).convert == work # => true
+  #
+  # @note the `Valkyrie::Resource` object passed to this class **must** have an
+  #   `#internal_resource` mapping it to an `ActiveFedora::Base` class.
+  class ActiveFedoraConverter
+    ##
+    # @!attribute [rw] resource
+    #   @return [Valkyrie::Resource]
+    attr_accessor :resource
+
+    ##
+    # @param [Valkyrie::Resource]
+    def initialize(resource:)
+      @resource = resource
+    end
+
+    ##
+    # @return [Hash<Symbol, Object>]
+    def attributes
+      attrs = resource.attributes
+
+      # avoid reflections for now; `*_ids` can't be passed as attributes.
+      # handling for reflections needs to happen in future work
+      attrs = attrs.reject { |k, _| k.to_s.end_with? '_ids' }
+
+      attrs.delete(:internal_resource)
+      attrs.delete(:new_record)
+      attrs.delete(:id)
+      attrs.delete(:alternate_ids)
+
+      attrs.compact
+    end
+
+    ##
+    # @return [ActiveFedora::Base]
+    def convert
+      resource.internal_resource.new(attributes).tap { |obj| obj.id = id unless id.empty? }
+    end
+
+    ##
+    # @return [String]
+    def id
+      resource.alternate_ids.first.to_s
+    end
+  end
+end

data/lib/wings/model_transformer.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require 'wings/value_mapper'
+
+module Wings
+  #
+  # This class is responsible for coordinating the transformation of a PCDM
+  # Model (be it the class or an instance of the class) to a [Valkyrie::Resource](https://github.com/samvera-labs/valkyrie/blob/master/lib/valkyrie/resource.rb).
+  # for the given PCDM model.
+  #
+  # @example getting a valkyrie resource
+  #   work     = GenericWork.new(id: 'an_identifier')
+  #   resource = Wings::ModelTransformer.for(pcdm_object: work)
+  #
+  #   resource.alternate_ids # => [#<Valkyrie::ID:0x... id: 'an_identifier'>]
+  #
+  class ModelTransformer
+    ##
+    # Caches dynamically generated `Valkyrie::Resource` subclasses mapped from
+    # legacy `ActiveFedora` model classes.
+    #
+    # @example
+    #   cache = ResourceClassCache.new
+    #
+    #   klass = cache.fetch(GenericWork) do
+    #     # logic mapping GenericWork to a Valkyrie::Resource subclass
+    #   end
+    #
+    class ResourceClassCache
+      ##
+      # @!attribute [r] cache
+      #   @return [Hash<Class, Class>]
+      attr_reader :cache
+
+      def initialize
+        @cache = {}
+      end
+
+      ##
+      # @param key [Class] the ActiveFedora class to map
+      #
+      # @return [Class]
+      def fetch(key)
+        @cache.fetch(key) do
+          @cache[key] = yield
+        end
+      end
+    end
+
+    # we really want a class var here. maybe we could use a singleton instead?
+    # rubocop:disable Style/ClassVars
+    @@resource_class_cache = ResourceClassCache.new
+
+    ##
+    # @!attribute [rw] pcdm_object
+    #   @return [ActiveFedora::Base]
+    attr_accessor :pcdm_object
+
+    ##
+    # @note The method signature is to conform to Valkyrie's method signature
+    #   for ::Valkyrie.config.resource_class_resolver
+    #
+    # @param class_name [String] a string representation of an `ActiveFedora`
+    #   model
+    #
+    # @return [Class] a dynamically generated `Valkyrie::Resource` subclass
+    #   mirroring the provided class name
+    #
+    def self.convert_class_name_to_valkyrie_resource_class(class_name)
+      klass = class_name.constantize
+      to_valkyrie_resource_class(klass: klass)
+    end
+
+    ##
+    # @param klass [String] an `ActiveFedora` model
+    #
+    # @return [Class] a dyamically generated `Valkyrie::Resource` subclass
+    #   mirroring the provided `ActiveFedora` model
+    #
+    # rubocop:disable Metrics/MethodLength because metaprogramming a class
+    #   results in long methods
+    def self.to_valkyrie_resource_class(klass:)
+      Class.new(ActiveFedoraResource) do
+        # Based on Valkyrie implementation, we call Class.to_s to define
+        # the internal resource.
+        @internal_resource = klass
+
+        class << self
+          attr_reader :internal_resource
+        end
+
+        def self.to_s
+          internal_resource.to_s
+        end
+
+        klass.properties.each_key do |property_name|
+          attribute property_name.to_sym, ::Valkyrie::Types::String
+        end
+        relationship_keys = klass.reflections.keys.reject { |k| k.to_s.include?('id') }.map { |k| k.to_s.singularize + '_ids' }
+        relationship_keys.each do |linked_property_name|
+          attribute linked_property_name.to_sym, ::Valkyrie::Types::Set.of(::Valkyrie::Types::ID)
+        end
+
+        # Defined after properties in case we have an `internal_resource` property.
+        # This may not be ideal, but based on my understanding of the `internal_resource`
+        # usage in Valkyrie, I'd rather keep synchronized the instance_method and class_method value for
+        # `internal_resource`
+        def internal_resource
+          self.class.internal_resource
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    ##
+    # @param pcdm_object [ActiveFedora::Base]
+    def initialize(pcdm_object:)
+      self.pcdm_object = pcdm_object
+    end
+
+    ##
+    # @param pcdm_object [ActiveFedora::Base]
+    #
+    # @return [::Valkyrie::Resource] a resource mirroiring `pcdm_object`
+    def self.for(pcdm_object)
+      new(pcdm_object: pcdm_object).build
+    end
+
+    ##
+    # Builds a `Valkyrie::Resource` equivalent to the `pcdm_object`
+    #
+    # @return [::Valkyrie::Resource] a resource mirroiring `pcdm_object`
+    def build
+      klass = @@resource_class_cache.fetch(pcdm_object) do
+        self.class.to_valkyrie_resource_class(klass: pcdm_object.class)
+      end
+      klass.new(alternate_ids: [::Valkyrie::ID.new(pcdm_object.id)], **attributes)
+    end
+
+    class ActiveFedoraResource < ::Valkyrie::Resource
+      attribute :alternate_ids, ::Valkyrie::Types::Array
+    end
+
+    private
+
+      def attributes
+        relationship_keys = pcdm_object.reflections.keys.reject { |k| k.to_s.include?('id') }.map { |k| k.to_s.singularize + '_ids' }
+
+        attrs_with_relationships = pcdm_object.attributes.keys + relationship_keys
+
+        attrs_with_relationships.each_with_object({}) do |attr_name, mem|
+          next unless pcdm_object.respond_to? attr_name
+          mem[attr_name.to_sym] = ValueMapper.for(pcdm_object.public_send(attr_name)).result
+        end
+      end
+  end
+  # rubocop:enable Style/ClassVars
+end

data/lib/wings/resource_factory.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Wings
+  # Preserving the old class for short-standing compliance
+  # with other Wings development. This can go away as part of the
+  # end of the Penn State 2019 winter developer sprint.
+  class ResourceFactory < ModelTransformer; end
+end