hyrax 2.8.0 → 3.0.0.pre.rc2

data/lib/hyrax/controlled_vocabularies/location.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module ControlledVocabularies
     class Location < ActiveTriples::Resource

data/lib/hyrax/controlled_vocabulary/importer/downloader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ruby-progressbar'
 
 module Hyrax

data/lib/hyrax/controlled_vocabulary/importer/language.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require_relative 'downloader'
 require 'rdf/rdfxml'
 module Hyrax
   module ControlledVocabulary
     module Importer
       class Language
-        URL = 'http://www.lexvo.org/resources/lexvo_2013-02-09.rdf.gz'.freeze
+        URL = 'http://www.lexvo.org/resources/lexvo_2013-02-09.rdf.gz'
 
         def initialize
           stdout_logger = Logger.new(STDOUT)

data/lib/hyrax/controller_resource.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 module Hyrax
   # Overrides CanCan so that attributes are not automatically assigned
   # to loaded resources
   class ControllerResource < CanCan::ControllerResource
     private
 
-      # Override resource_params to make this a nop. Hyrax uses actors to assign attributes
-      def resource_params
-        {}
-      end
+    # Override resource_params to make this a nop. Hyrax uses actors to assign attributes
+    def resource_params
+      {}
+    end
   end
 end

data/lib/hyrax/engine.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
 module Hyrax
   class Engine < ::Rails::Engine
     isolate_namespace Hyrax
 
-    # These gems must be required outside of an initializer or they don't get loaded.
     require 'awesome_nested_set'
     require 'breadcrumbs_on_rails'
+    require 'draper'
+    require 'dry/struct'
+    require 'dry/equalizer'
+    require 'dry/events'
+    require 'dry/validation'
     require 'jquery-ui-rails'
     require 'flot-rails'
     require 'almond-rails'
@@ -13,7 +18,18 @@ module Hyrax
     require 'qa'
     require 'clipboard/rails'
     require 'legato'
-    require 'pul_uv_rails'
+    require 'valkyrie'
+
+    require 'hydra/derivatives'
+    require 'hyrax/controller_resource'
+    require 'hyrax/form_fields'
+    require 'hyrax/indexer'
+    require 'hyrax/model_decorator'
+    require 'hyrax/publisher'
+    require 'hyrax/schema'
+    require 'hyrax/search_state'
+    require 'hyrax/transactions'
+    require 'hyrax/errors'
 
     # Force these models to be added to Legato's registry in development mode
     config.eager_load_paths += %W[
@@ -22,8 +38,10 @@ module Hyrax
     ]
 
     config.action_dispatch.rescue_responses.merge!(
-      "ActiveFedora::ObjectNotFoundError" =>     :not_found, # We can remove this when we use ActiveFedora 11.2
-      "Blacklight::Exceptions::RecordNotFound" => :not_found
+      "ActiveFedora::ObjectNotFoundError" => :not_found, # We can remove this when we use ActiveFedora 11.2
+      "Blacklight::Exceptions::RecordNotFound" => :not_found,
+      "Valkyrie::Persistence::ObjectNotFoundError" => :not_found,
+      "Hyrax::ObjectNotFoundError" => :not_found
     )
 
     config.before_initialize do
@@ -41,16 +59,16 @@ module Hyrax
       can_connect = begin
         ActiveRecord::Base.connection
         true
-      rescue StandardError
-        false
+                    rescue StandardError
+                      false
       end
 
       can_persist = can_connect && begin
         Hyrax.config.persist_registered_roles!
         Rails.logger.info("Hyrax::Engine.after_initialize - persisting registered roles!")
         true
-      rescue ActiveRecord::StatementInvalid
-        false
+                                   rescue ActiveRecord::StatementInvalid
+                                     false
       end
 
       unless can_persist
@@ -62,14 +80,8 @@ module Hyrax
     end
 
     initializer 'requires' do
-      require 'hydra/derivatives'
-      require 'hyrax/controller_resource'
-      require 'hyrax/search_state'
-      require 'hyrax/errors'
       require 'power_converters'
-      require 'dry/struct'
-      require 'dry/equalizer'
-      require 'dry/validation'
+      require 'wings'
     end
 
     initializer 'routing' do

data/lib/hyrax/errors.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
 module Hyrax
+  require 'active_fedora/errors'
+
   # Generic Hyrax exception class.
   class HyraxError < StandardError; end
 
@@ -8,4 +11,6 @@ module Hyrax
   class WorkflowAuthorizationException < HyraxError; end
 
   class SingleUseError < HyraxError; end
+
+  class ObjectNotFoundError < ActiveFedora::ObjectNotFoundError; end
 end

data/lib/hyrax/event_store.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # @abstract
+  # The event store provides an interface to log numbered events into a storage
+  # system, e.g. a key-value store.
+  #
+  # At the class level, we provide a `.create` method for logging event data
+  # with incrementing ids. Events have an "action" (a string description of the
+  # event), and a (numeric) timestamp. Clients *SHOULD* provide a timestamp that
+  # represnts the current application time (i.e. via `Hyrax::TimeService`); see
+  # `Hyrax::Event.create_now`.
+  #
+  # At the instance level, events can be pushed by id onto a list of events for
+  # a given topic key, and fetched by the same topic. Initialize an instance
+  # with `.for('topic_key')` and use `#push(event_id)` to associate events with
+  # the topic.
+  #
+  # @see Hyrax::RedisEventStore for the default implementation
+  # @see Hyrax::Event
+  class EventStore
+    class << self
+      delegate :logger, to: Hyrax
+
+      ##
+      # @abstract
+      # @api public
+      #
+      # @note clients should consider using `Hyrax::Event` to manage events instead
+      #   of directly interfacing with this method.
+      #
+      # @param [String] action
+      # @param [Integer] timestamp  the time to log the event. usually now.
+      #
+      # @return [Integer] the id of the event
+      def create(_action, _timestamp)
+        raise NotImplementedError, 'EventStore.create should be provided by ' \
+                                   'a concrete implementation'
+      end
+
+      ##
+      # @api public
+      #
+      # @todo this is really just an initializer; deprecate in favor of `.new`?
+      #
+      # @param [String] key
+      def for(key)
+        new(key)
+      end
+    end
+
+    ##
+    # @api private
+    #
+    # @param [String] key
+    def initialize(key)
+      @key = key
+    end
+
+    ##
+    # @param [Integer] size
+    #
+    # @return [Enumerable<Hash<Symbol, String>>]
+    def fetch(_size)
+      raise NotImplementedError, 'EventStore#fetch should be provided by ' \
+                                 'a concrete implementation'
+    end
+
+    #
+    # Adds a value to the end of a list identified by key
+    #
+    # @param [Integer] value
+    #
+    # @return [void]
+    def push(_value)
+      raise NotImplementedError, 'EventStore#push should be provided by ' \
+                                 'a concrete implementation'
+    end
+  end
+end

data/lib/hyrax/form_fields.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # @api public
+  #
+  # @param [Symbol] schema_name
+  #
+  # @since 3.0.0
+  def self.FormFields(schema_name, **options)
+    Hyrax::FormFields.new(schema_name, **options)
+  end
+
+  ##
+  # @api private
+  #
+  # @see Hyrax.FormFields
+  class FormFields < Module
+    attr_reader :name
+
+    ##
+    # @api private
+    #
+    # @param [Symbol] schema_name
+    # @param [#form_definitions_for] definition_loader
+    #
+    # @note use Hyrax::FormFields(:my_schema) instead
+    def initialize(schema_name, definition_loader: SimpleSchemaLoader.new)
+      @name = schema_name
+      @definition_loader = definition_loader
+    end
+
+    ##
+    # @return [Hash{Symbol => Hash{Symbol => Object}}]
+    def form_field_definitions
+      @definition_loader.form_definitions_for(schema: name)
+    end
+
+    ##
+    # @return [String]
+    def inspect
+      "#{self.class}(#{@name})"
+    end
+
+    private
+
+    def included(descendant)
+      super
+
+      form_field_definitions.each do |field_name, options|
+        descendant.property field_name.to_sym, options.merge(display: true, default: [])
+      end
+    end
+  end
+end

data/lib/hyrax/health_checks.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'okcomputer'
+require 'hyrax/health_checks/solr_check'

data/lib/hyrax/health_checks/solr_check.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module HealthChecks
+    class SolrCheck < OkComputer::Check
+      def initialize(service: Hyrax::SolrService)
+        @service = service
+      end
+
+      def check
+        return if @service.ping
+
+        mark_message 'Solr connection failed'
+        mark_failure
+      rescue RSolr::Error::ConnectionRefused => err
+        mark_message "Solr connection refused: #{err.message}"
+        mark_failure
+      rescue RuntimeError => err
+        mark_message "Solr connection failed: #{err.message}"
+        mark_failure
+      end
+    end
+  end
+end

data/lib/hyrax/indexer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # @public
+  #
+  # @since 3.0.0
+  def self.Indexer(schema_name, index_loader: SimpleSchemaLoader.new)
+    Indexer.new(index_loader.index_rules_for(schema: schema_name))
+  end
+
+  ##
+  # @private
+  class Indexer < Module
+    ##
+    # @param [Symbol] schema
+    def initialize(rules)
+      define_method :to_solr do |*args|
+        super(*args).tap do |document|
+          rules.each do |index_key, method|
+            document[index_key] = resource.try(method)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/inflections.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ActiveSupport::Inflector.inflections(:en) do |inflect|
   inflect.acronym 'API'
 end

data/lib/hyrax/model_decorator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # Provides ActiveModel-safe decoration via `Draper`.
+  #
+  # This is needed to preserve Presenter, View, and URL
+  # helper behavior for decorated models.
+  #
+  # @example
+  #   class TitleDecorator < Hyrax::ModelDecorator
+  #     ##
+  #     # @return [String]
+  #     def title
+  #       Array(object.title).first.capitalize
+  #     end
+  #   end
+  #
+  #   my_model.title # => ['moomin']
+  #   decorated = TitleDecorator.decorate(my_model)
+  #
+  #   decorated.title # => 'Moomin'
+  #   url_helpers.download_url(decorated) == url_helpers.download_url(my_model) # => true
+  #
+  class ModelDecorator < Draper::Decorator
+    delegate_all
+
+    def to_model(*args)
+      object.to_model(*args)
+    end
+  end
+end

data/lib/hyrax/move_all_works_to_admin_set.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # If you want to move all your works to an admin set run this.
 class MoveAllWorksToAdminSet
   def self.run(admin_set)

data/lib/hyrax/name.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # A model name that provides routes that are namespaced to Hyrax,
   # without changing the param key.
@@ -14,7 +15,7 @@ module Hyrax
       super
       @route_key          = "hyrax_#{ActiveSupport::Inflector.pluralize(@param_key)}"
       @singular_route_key = ActiveSupport::Inflector.singularize(@route_key)
-      @route_key << "_index" if @plural == @singular
+      @route_key += "_index" if @plural == @singular
     end
   end
 end

data/lib/hyrax/publisher.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # This is an application-wide publisher for Hyrax's Pub/Sub interface.
+  #
+  # Hyrax publishes events on a variety of streams. The streams are namespaced
+  # using `dry-rb`'s dot notation idiom to help with organization. Namespaces
+  # reflect the kinds of resources the event applied to.
+  #
+  #   - `batch`: events related to the performance of `BatchCreateJob`
+  #   - `file_set`: events related to the lifecycle of Hydra Works FileSets
+  #   - `object`: events related to the lifecycle of all PCDM Objects
+  #
+  # Applications *SHOULD* publish events whenever the relevant actions are
+  # performed. While Hyrax provides certain out-of-the-box listeners to power
+  # (e.g.) notifications, event streams are useful for much more: implementing
+  # local logging or instrumentation, adding application-specific callback-like
+  # handlers, etc... Ensuring events are consistently published is key to their
+  # usefulness.
+  #
+  # @note this API replaces an older `Hyrax::Callbacks` interface, with added
+  #   thread safety and capacity for many listeners on a single publication
+  #   stream.
+  #
+  # @note we call this "Publisher" to differentiate from the `Hyrax::Event`
+  #   model. This class is a `Dry::Events` publisher.
+  #
+  # @todo audit Hyrax code (and dependencies!) for places where events should be
+  #   published, but are not.
+  #
+  # @example publishing an event
+  #   publisher = Hyrax::Publisher.instance
+  #
+  #   publisher.publish('object.deposited', object: deposited_object, user: depositing_user)
+  #
+  # @example use Hyrax.publisher
+  #   Hyrax.publisher.publish('object.deposited', object: deposited_object, user: depositing_user)
+  #
+  # @example subscribing to an event type/stream with a block handler
+  #   publisher = Hyrax::Publisher.instance
+  #
+  #   publisher.subscribe('object.deposited') do |event |
+  #     do_something(event[:object])
+  #   end
+  #
+  # @see https://dry-rb.org/gems/dry-events/0.2/
+  # @see Dry::Events::Publisher
+  class Publisher
+    include Singleton
+    include Dry::Events::Publisher[:hyrax]
+
+    register_event('batch.created')
+    register_event('file.set.audited')
+    register_event('file.set.attached')
+    register_event('file.set.url.imported')
+    register_event('file.set.restored')
+    register_event('object.deleted')
+    register_event('object.failed_deposit')
+    register_event('object.deposited')
+    register_event('object.acl.updated')
+    register_event('object.metadata.updated')
+  end
+end