hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/services/hyrax/workflow/workflow_importer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for loading workflows from a data source.
@@ -19,7 +20,7 @@ module Hyrax
 
         private
 
-          attr_writer :load_errors
+        attr_writer :load_errors
       end
 
       # @api public
@@ -100,25 +101,25 @@ module Hyrax
 
       private
 
-        attr_reader :data, :logger
+      attr_reader :data, :logger
 
-        def data=(input)
-          @data = input.deep_symbolize_keys
-        end
+      def data=(input)
+        @data = input.deep_symbolize_keys
+      end
 
-        attr_accessor :validator, :permission_template, :schema
+      attr_accessor :validator, :permission_template, :schema
 
-        def default_validator
-          SchemaValidator.method(:call)
-        end
+      def default_validator
+        SchemaValidator.method(:call)
+      end
 
-        def default_schema
-          Hyrax::Workflow::WorkflowSchema
-        end
+      def default_schema
+        Hyrax::Workflow::WorkflowSchema.new
+      end
 
-        def validate!
-          validator.call(data: data, schema: schema, logger: logger)
-        end
+      def validate!
+        validator.call(data: data, schema: schema, logger: logger)
+      end
 
       public
 
@@ -142,39 +143,52 @@ module Hyrax
 
       private
 
-        def find_or_create_from(configuration:)
-          workflow = Sipity::Workflow.find_or_initialize_by(name: configuration.fetch(:name), permission_template: permission_template)
-          generate_state_diagram!(workflow: workflow, actions_configuration: configuration.fetch(:actions))
-
-          find_or_create_workflow_permissions!(
-            workflow: workflow, workflow_permissions_configuration: configuration.fetch(:workflow_permissions, [])
-          )
-          workflow.label = configuration.fetch(:label, nil)
-          workflow.description = configuration.fetch(:description, nil)
-          workflow.allows_access_grant = configuration.fetch(:allows_access_grant, nil)
-          workflow.save!
-          logger.info(%(Loaded Sipity::Workflow "#{workflow.name}" for #{permission_template.class} ID=#{permission_template.id}))
-          workflow
+      def find_or_create_from(configuration:)
+        workflow = Sipity::Workflow.find_or_initialize_by(name: configuration.fetch(:name), permission_template: permission_template)
+        generate_state_diagram!(workflow: workflow, actions_configuration: configuration.fetch(:actions))
+
+        find_or_create_workflow_permissions!(
+          workflow: workflow, workflow_permissions_configuration: configuration.fetch(:workflow_permissions, [])
+        )
+        workflow.label = configuration.fetch(:label, nil)
+        workflow.description = configuration.fetch(:description, nil)
+        workflow.allows_access_grant = configuration.fetch(:allows_access_grant, nil)
+        workflow.save!
+        logger.info(%(Loaded Sipity::Workflow "#{workflow.name}" for #{permission_template.class} ID=#{permission_template.id}))
+        workflow
+      end
+
+      extend Forwardable
+      def_delegator WorkflowPermissionsGenerator, :call, :find_or_create_workflow_permissions!
+      def_delegator SipityActionsGenerator, :call, :generate_state_diagram!
+
+      module SchemaValidator
+        # @param data [Hash]
+        # @param schema [#call]
+        #
+        # @return [Boolean] true if the data validates from the schema
+        # @raise [RuntimeError] if the data does not validate against the schema
+        def self.call(data:, schema:, logger:)
+          result = schema.call(data)
+          return true if result.success?
+          message = format_message(result)
+          logger.error(message)
+          raise message
         end
 
-        extend Forwardable
-        def_delegator WorkflowPermissionsGenerator, :call, :find_or_create_workflow_permissions!
-        def_delegator SipityActionsGenerator, :call, :generate_state_diagram!
-
-        module SchemaValidator
-          # @param data [Hash]
-          # @param schema [#call]
-          #
-          # @return true if the data validates from the schema
-          # @raise Exceptions::InvalidSchemaError if the data does not validate against the schema
-          def self.call(data:, schema:, logger:)
-            result = schema.call(data)
-            return true if result.success?
-            message = result.messages(full: true).inspect
-            logger.error(message)
-            raise message
+        ##
+        # @param result [Dry::Validation::Result]
+        #
+        # @return [String]
+        def self.format_message(result)
+          messages = result.errors(full: true).map do |msg|
+            "Error on workflow entry #{msg.path}\n\t#{msg.text}\n\tGot: #{msg.input || '[no entry]'}"
           end
+
+          messages << "Input was:\n\t#{result.to_h}"
+          messages.join("\n")
         end
+      end
     end
   end
 end

data/app/services/hyrax/workflow/workflow_permissions_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for creating database entries for the given workflow's permissions
@@ -20,12 +21,12 @@ module Hyrax
 
       private
 
-        attr_accessor :workflow
-        attr_reader :workflow_permissions_configuration
+      attr_accessor :workflow
+      attr_reader :workflow_permissions_configuration
 
-        def workflow_permissions_configuration=(input)
-          @workflow_permissions_configuration = Array.wrap(input)
-        end
+      def workflow_permissions_configuration=(input)
+        @workflow_permissions_configuration = Array.wrap(input)
+      end
 
       public
 
@@ -36,14 +37,14 @@ module Hyrax
 
       private
 
-        def find_or_create_workflow_permissions!
-          # In Sipity application, Agents were assigned in the configuration file.
-          # However this is something assigned via a UI component for a given role.
-          default_agents = []
-          workflow_permissions_configuration.each do |configuration|
-            PermissionGenerator.call(agents: default_agents, roles: configuration.fetch(:role), workflow: workflow)
-          end
+      def find_or_create_workflow_permissions!
+        # In Sipity application, Agents were assigned in the configuration file.
+        # However this is something assigned via a UI component for a given role.
+        default_agents = []
+        workflow_permissions_configuration.each do |configuration|
+          PermissionGenerator.call(agents: default_agents, roles: configuration.fetch(:role), workflow: workflow)
         end
+      end
     end
   end
 end

data/app/services/hyrax/workflow/workflow_schema.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Workflow
     # Responsible for describing the JSON schema for a Workflow.
@@ -14,108 +15,41 @@ module Hyrax
     # @see Sipity::Notification
     # @see Sipity::Method
     # @see ./lib/generators/hyrax/templates/workflow.json.erb
+    class WorkflowSchema < Dry::Validation::Contract
+      class Types
+        include Dry::Types()
 
-    # If using dry-validation < 1, create a Dry::Validation::Schema for backwards-compatibility.
-    # This schema should never ever change.  If you need to modify it, upgrade to dry-validation >= 1
-    # and use the Dry::Validation::Contract subclass below.
-    if defined? Dry::Validation::Schema
-      Deprecation.warn(self, 'The Dry::Validation::Schema implemenation of Hyrax::Workflow::WorkflowSchema is deprecated. ' \
-                       'Please upgrade to dry-validation >= 1 to use the Dry::Validation::Contract implementation which will be part of Hyrax 3.0')
-      WorkflowSchema = Dry::Validation.Schema do
-        configure do
-          def self.messages
-            Dry::Validation::Messages.default.merge(
-              en: { errors: { constant_name?: 'must be an initialized Ruby constant' } }
-            )
-          end
-
-          def constant_name?(value)
-            value.constantize
-            true
-          rescue NameError
-            false
-          end
-        end
-
-        required(:workflows).each do
-          required(:name).filled(:str?) # Sipity::Workflow#name
-          optional(:label).filled(:str?) # Sipity::Workflow#label
-          optional(:description).filled(:str?) # Sipity::Workflow#description
-          optional(:allows_access_grant).filled(:bool?) # Sipity::Workflow#allows_access_grant?
-          required(:actions).each do
-            schema do
-              required(:name).filled(:str?) # Sipity::WorkflowAction#name
-              required(:from_states).each do
-                schema do
-                  required(:names) { array? { each(:str?) } } # Sipity::WorkflowState#name
-                  required(:roles) { array? { each(:str?) } } # Sipity::Role#name
-                end
-              end
-              optional(:transition_to).filled(:str?) # Sipity::WorkflowState#name
-              optional(:notifications).each do
-                schema do
-                  required(:name).value(:constant_name?) # Sipity::Notification#name
-                  required(:notification_type).value(included_in?: Sipity::Notification.valid_notification_types)
-                  required(:to) { array? { each(:str?) } }
-                  optional(:cc) { array? { each(:str?) } }
-                  optional(:bcc) { array? { each(:str?) } }
-                end
-              end
-              optional(:methods) { array? { each(:str?) } } # See it_behaves_like "a Hyrax workflow method"
-            end
+        Constant = Types::Class.constructor do |v|
+          begin
+            v.constantize
+          rescue NameError => _err
+            v
           end
         end
       end
-    elsif defined? Dry::Validation::Contract
-      # For dry-validation >= 1
-      class WorkflowSchema < Dry::Validation::Contract
-        class Types
-          include Dry::Types()
 
-          Constant = Types::Class.constructor do |v|
-            begin
-              v.constantize
-            rescue NameError => _err
-              v
+      params do
+        required(:workflows).array(:hash) do
+          required(:name).filled(:string) # Sipity::Workflow#name
+          optional(:label).filled(:string) # Sipity::Workflow#label
+          optional(:description).filled(:string) # Sipity::Workflow#description
+          optional(:allows_access_grant).filled(:bool) # Sipity::Workflow#allows_access_grant?
+          required(:actions).array(:hash) do
+            required(:name).filled(:string) # Sipity::WorkflowAction#name
+            required(:from_states).array(:hash) do
+              required(:names) { array? { each(:string) } } # Sipity::WorkflowState#name
+              required(:roles) { array? { each(:string) } } # Sipity::Role#name
             end
-          end
-        end
-
-        # Wrap the result for backwards-compatibility. This will be removed in Hyrax 3.0.
-        class ResultWrapper < SimpleDelegator
-          def messages(opts = {})
-            errors(opts)
-          end
-        end
-
-        # Provide a class method for backwards-compatibility. This will be removed in Hyrax 3.0.
-        def self.call(data)
-          ResultWrapper.new(new.call(data))
-        end
-
-        params do
-          required(:workflows).array(:hash) do
-            required(:name).filled(:string) # Sipity::Workflow#name
-            optional(:label).filled(:string) # Sipity::Workflow#label
-            optional(:description).filled(:string) # Sipity::Workflow#description
-            optional(:allows_access_grant).filled(:bool) # Sipity::Workflow#allows_access_grant?
-            required(:actions).array(:hash) do
-              required(:name).filled(:string) # Sipity::WorkflowAction#name
-              required(:from_states).array(:hash) do
-                required(:names) { array? { each(:string) } } # Sipity::WorkflowState#name
-                required(:roles) { array? { each(:string) } } # Sipity::Role#name
-              end
-              optional(:transition_to).filled(:string) # Sipity::WorkflowState#name
-              optional(:notifications).array(:hash) do
-                required(:name).value(Types::Constant) # Sipity::Notification#name
-                required(:notification_type).value(included_in?: Sipity::Notification.valid_notification_types)
-                required(:to) { array? { each(:string) } }
-                optional(:cc) { array? { each(:string) } }
-                optional(:bcc) { array? { each(:string) } }
-              end
+            optional(:transition_to).filled(:string) # Sipity::WorkflowState#name
+            optional(:notifications).array(:hash) do
+              required(:name).value(Types::Constant) # Sipity::Notification#name
+              required(:notification_type).value(included_in?: Sipity::Notification.valid_notification_types)
+              required(:to) { array? { each(:string) } }
+              optional(:cc) { array? { each(:string) } }
+              optional(:bcc) { array? { each(:string) } }
             end
-            optional(:methods) { array? { each(:string) } } # See it_behaves_like "a Hyrax workflow method"
           end
+          optional(:methods) { array? { each(:string) } } # See it_behaves_like "a Hyrax workflow method"
         end
       end
     end

data/app/services/hyrax/working_directory.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # @deprecated Use JobIoWrapper instead
   class WorkingDirectory
@@ -19,7 +20,7 @@ module Hyrax
         copy_repository_resource_to_working_directory(repository_file, id)
       end
 
-      # @param [ActiveFedora::File] file the resource in the repo
+      # @param [#original_name, #id] file the resource in the repo
       # @param [String] id the identifier of the FileSet
       # @return [String] path of the working file
       def copy_repository_resource_to_working_directory(file, id)
@@ -30,22 +31,22 @@ module Hyrax
 
       private
 
-        # @param [String] id the identifier
-        # @param [String] name the file name
-        # @param [#read] stream the stream to copy to the working directory
-        # @return [String] path of the working file
-        def copy_stream_to_working_directory(id, name, stream)
-          working_path = full_filename(id, name)
-          Rails.logger.debug "Writing #{name} to the working directory at #{working_path}"
-          FileUtils.mkdir_p(File.dirname(working_path))
-          IO.copy_stream(stream, working_path)
-          working_path
-        end
+      # @param [String] id the identifier
+      # @param [String] name the file name
+      # @param [#read] stream the stream to copy to the working directory
+      # @return [String] path of the working file
+      def copy_stream_to_working_directory(id, name, stream)
+        working_path = full_filename(id, name)
+        Rails.logger.debug "Writing #{name} to the working directory at #{working_path}"
+        FileUtils.mkdir_p(File.dirname(working_path))
+        IO.copy_stream(stream, working_path)
+        working_path
+      end
 
-        def full_filename(id, original_name)
-          pair = id.scan(/..?/).first(4).push(id)
-          File.join(Hyrax.config.working_path, *pair, original_name)
-        end
+      def full_filename(id, original_name)
+        pair = id.scan(/..?/).first(4).push(id)
+        File.join(Hyrax.config.working_path, *pair, original_name)
+      end
     end
   end
 end

data/app/services/hyrax/works/managed_works_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Works
     module ManagedWorksService

data/app/services/hyrax/works/migration_service.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module Hyrax
+  module Works
+    class MigrationService
+      # @api public
+      #
+      # Migrate data stored in FCrepo from one predicate to another
+      #   The main use case is where the predicate used for a specific property is changed.
+      #   Data already stored in Fedora under the original predicate needs to be transfered
+      #   and the original data cleaned up.
+      def self.migrate_predicate(predicate_from, predicate_to, works_to_update = ActiveFedora::Base.all)
+        migrated = 0
+        Rails.logger.info "*** Migrating #{predicate_from} to #{predicate_to} in #{works_to_update.count} works"
+        works_to_update.each do |work|
+          next unless work.ldp_source.content.include?(predicate_from.to_s)
+          migrate_data(predicate_from, predicate_to, work)
+          migrated += 1
+        end
+        Rails.logger.info "--- Migration Complete (#{migrated} migrated)"
+      end
+
+      # @api private
+      #
+      # Migrate data
+      def self.migrate_data(predicate_from, predicate_to, work)
+        orm = Ldp::Orm.new(work.ldp_source)
+        orm.value(predicate_from).each { |val| orm.graph.insert([orm.resource.subject_uri, predicate_to, val.to_s]) }
+        orm.graph.delete([orm.resource.subject_uri, predicate_from, nil])
+        orm.save
+        Rails.logger.info " Data migrated from #{predicate_from} to #{predicate_to} - id: #{work.id}"
+      end
+    end
+  end
+end

data/app/strategies/hyrax/strategies/yaml_strategy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax::Strategies
   class YamlStrategy < Flipflop::Strategies::AbstractStrategy
     class << self
@@ -27,19 +28,19 @@ module Hyrax::Strategies
 
     private
 
-      def key_exists?(feature)
-        yaml_file[feature.to_s]&.key?("enabled")
-      end
+    def key_exists?(feature)
+      yaml_file[feature.to_s]&.key?("enabled")
+    end
 
-      def yaml_file
-        @yaml_file ||=
-          begin
-            if File.exist?(@config_file)
-              YAML.load_file(@config_file)
-            else
-              {}
-            end
+    def yaml_file
+      @yaml_file ||=
+        begin
+          if File.exist?(@config_file)
+            YAML.load_file(@config_file)
+          else
+            {}
           end
-      end
+        end
+    end
   end
 end