curation_concerns 1.6.3 → 1.7.0.beta1

data/app/services/curation_concerns/workflow/workflow_action_service.rb

@@ -0,0 +1,56 @@
+module CurationConcerns
+  module Workflow
+    class WorkflowActionService
+      def self.run(subject:, action:, comment: nil)
+        new(subject: subject, action: action, comment: comment).run
+      end
+
+      def initialize(subject:, action:, comment:)
+        @subject = subject
+        @action = action
+        @comment_text = comment
+      end
+
+      attr_reader :subject, :action, :comment_text
+
+      def run
+        update_sipity_workflow_state
+        comment = create_sipity_comment
+        handle_sipity_notifications(comment: comment)
+        handle_additional_sipity_workflow_action_processing(comment: comment)
+        subject.work.update_index # So that the new actions and state are written into solr.
+      end
+
+      protected
+
+        def update_sipity_workflow_state
+          return true unless action.resulting_workflow_state_id.present?
+          subject.entity.update_attribute(:workflow_state_id, action.resulting_workflow_state_id)
+        end
+
+        def create_sipity_comment
+          return true unless comment_text.present?
+          Sipity::Comment.create!(entity: subject.entity, agent: subject.agent, comment: comment_text)
+        end
+
+        def handle_sipity_notifications(comment:)
+          CurationConcerns::Workflow::NotificationService.deliver_on_action_taken(
+            entity: subject.entity,
+            comment: comment,
+            action: action,
+            user: subject.user
+          )
+        end
+
+        # Run any configured custom methods
+        def handle_additional_sipity_workflow_action_processing(comment:)
+          CurationConcerns::Workflow::ActionTakenService.handle_action_taken(
+            entity: subject.entity,
+            comment: comment,
+            action: action,
+            user: subject.user
+          )
+        end
+    end
+  end
+end

data/app/services/curation_concerns/workflow/workflow_by_model_name_strategy.rb

@@ -0,0 +1,14 @@
+module CurationConcerns
+  module Workflow
+    class WorkflowByModelNameStrategy
+      def initialize(work, _attributes)
+        @work = work
+      end
+
+      # @return [String] The name of the workflow to use
+      def workflow_name
+        'default'
+      end
+    end
+  end
+end

data/app/services/curation_concerns/workflow/workflow_factory.rb

@@ -0,0 +1,64 @@
+module CurationConcerns
+  module Workflow
+    class WorkflowFactory
+      class_attribute :workflow_strategy
+      self.workflow_strategy = DefaultWorkflowStrategy
+
+      # @param work [#to_global_id]
+      # @param attributes [Hash]
+      # @param strategy [#name] strategy for finding which workflow to use. Defaults to an instance of WorkflowByModelNameStrategy
+      # @return [TrueClass]
+      def self.create(work, attributes, user, strategy = nil)
+        strategy ||= workflow_strategy.new(work, attributes)
+        new(work, attributes, user, strategy).create
+      end
+
+      # @param work [#to_global_id]
+      # @param attributes [Hash]
+      # @param strategy [#name] strategy for finding which workflow to use
+      def initialize(work, attributes, user, strategy)
+        @work = work
+        @attributes = attributes
+        @user = user
+        @strategy = strategy
+      end
+
+      attr_reader :work, :attributes, :user, :strategy
+      private :work, :attributes, :strategy
+
+      # Creates a Sipity::Entity for the work.
+      # The Sipity::Entity acts as a proxy to a work within a workflow
+      # @return [TrueClass]
+      def create
+        Sipity::Entity.create!(proxy_for_global_id: work.to_global_id.to_s,
+                               workflow: workflow,
+                               workflow_state: nil)
+
+        subject = WorkflowActionInfo.new(work, user)
+        Workflow::WorkflowActionService.run(subject: subject,
+                                            action: find_deposit_action)
+        true
+      end
+
+      # This tells us which workflow to use. If no workflow is found with the expected name
+      # then load the workflows in config/workflows/*.json and try again.
+      # @return [Sipity::Workflow]
+      def workflow
+        @workflow ||= Sipity::Workflow.find_by(name: workflow_name) ||
+                      (CurationConcerns::Workflow::WorkflowImporter.load_workflows &&
+                       Sipity::Workflow.find_by!(name: workflow_name))
+      end
+
+      delegate :workflow_name, to: :strategy
+
+      # Find an action that has no starting state. This is the deposit action.
+      # # @return [Sipity::WorkflowAction]
+      def find_deposit_action
+        actions_that_lead_to_states = Sipity::WorkflowStateAction.all.pluck(:workflow_action_id)
+        relation = Sipity::WorkflowAction.where(workflow: workflow)
+        relation = relation.where('id NOT IN (?)', actions_that_lead_to_states) if actions_that_lead_to_states.any?
+        relation.first!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+module CurationConcerns
+  module Workflow
+    class WorkflowImporter
+      # @api public
+      #
+      # Load all the workflows in config/workflows/*.json
+      # @return [TrueClass]
+      def self.load_workflows
+        Dir.glob(Rails.root + "config/workflows/*.json") do |config|
+          Rails.logger.info "Loading workflow: #{config}"
+          generate_from_json_file(path: config)
+        end
+        true
+      end
+
+      # @api public
+      #
+      # Responsible for generating the work type and corresponding processing entries based on given pathname or JSON document.
+      #
+      # @return [Array<Sipity::Workflow>]
+      def self.generate_from_json_file(path:, **keywords)
+        contents = path.respond_to?(:read) ? path.read : File.read(path)
+        data = JSON.parse(contents)
+        new(data: data, **keywords).call
+      end
+
+      # @param data [#deep_symbolize_keys] the configuration information from which we will generate all the data entries
+      # @param schema [#call] The schema in which you will validate the data
+      # @param validator [#call] The validation service for the given data and schema
+      def initialize(data:, schema: default_schema, validator: default_validator)
+        self.data = data
+        self.schema = schema
+        self.validator = validator
+        validate!
+      end
+
+      private
+
+        attr_reader :data
+
+        def data=(input)
+          @data = input.deep_symbolize_keys
+        end
+
+        attr_accessor :validator
+
+        def default_validator
+          SchemaValidator.method(:call)
+        end
+
+        attr_accessor :schema
+
+        def default_schema
+          CurationConcerns::Workflow::WorkflowSchema
+        end
+
+        def validate!
+          validator.call(data: data, schema: schema)
+        end
+
+      public
+
+      def call
+        Array.wrap(data.fetch(:workflows)).map do |configuration|
+          find_or_create_from(configuration: configuration)
+        end
+      end
+
+      private
+
+        def find_or_create_from(configuration:)
+          workflow = Sipity::Workflow.find_or_initialize_by(name: configuration.fetch(:name)) do |wf|
+            wf.label = configuration.fetch(:label, nil)
+            wf.description = configuration.fetch(:description, nil)
+            wf.save!
+          end
+
+          find_or_create_workflow_permissions!(
+            workflow: workflow, workflow_permissions_configuration: configuration.fetch(:workflow_permissions, [])
+          )
+          generate_state_diagram(workflow: workflow, actions_configuration: configuration.fetch(:actions))
+          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 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:)
+            validation = schema.call(data)
+            return true unless validation.messages.present?
+            raise validation.messages.inspect
+          end
+        end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module CurationConcerns
+  module Workflow
+    # Responsible for creating database entries for the given workflow's permissions
+    class WorkflowPermissionsGenerator
+      # @api public
+      #
+      # Responsible for creating database entries for the given workflow's permissions
+      #
+      # @param workflow [Sipity::Workflow]
+      # @param workflow_permissions_configuration [Hash] as defined in CurationConcerns::Workflow::WorkflowSchema
+      # @return [Sipity::Workflow]
+      def self.call(workflow:, workflow_permissions_configuration:)
+        new(workflow: workflow, workflow_permissions_configuration: workflow_permissions_configuration).call
+      end
+
+      def initialize(workflow:, workflow_permissions_configuration:)
+        self.workflow = workflow
+        self.workflow_permissions_configuration = workflow_permissions_configuration
+      end
+
+      private
+
+        attr_accessor :workflow
+        attr_reader :workflow_permissions_configuration
+
+        def workflow_permissions_configuration=(input)
+          @workflow_permissions_configuration = Array.wrap(input)
+        end
+
+      public
+
+      def call
+        find_or_create_workflow_permissions!
+        workflow
+      end
+
+      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
+        end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module CurationConcerns
+  module Workflow
+    # Responsible for describing the JSON schema for a Workflow.
+    #
+    # The `workflows name` defines the name of the Sipity::Workflow.
+    # The `workflows actions` defines the actions that can be taken in the given states (e.g. :from_states) by the given :roles.
+    # The `workflows actions transition_to` defines the state to which we transition when the action is taken.
+    # The `workflows actions notifications` defines the notifications that should be sent when the action is taken.
+    #
+    # @see Sipity::Workflow
+    # @see Sipity::WorkflowAction
+    # @see Sipity::WorkflowState
+    # @see Sipity::Role
+    # @see Sipity::Notification
+    # @see Sipity::Method
+    # @see ./lib/generators/curation_concerns/work/templates/workflow.json.erb
+    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
+        required(:actions).each do
+          required(:name).filled(:str?) # Sipity::WorkflowAction#name
+          required(:from_states).each do
+            required(:names) { array? { each(:str?) } } # Sipity::WorkflowState#name
+            required(:roles) { array? { each(:str?) } } # Sipity::Role#name
+          end
+          optional(:transition_to).filled(:str?) # Sipity::WorkflowState#name
+          optional(:notifications).each 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
+          optional(:methods) { array? { each(:str?) } }
+        end
+      end
+    end
+  end
+end

data/app/services/rights_service.rb

@@ -9,7 +9,7 @@ module RightsService
   end
 
   def self.select_all_options
-    Deprecation.warn(RightsService, "RightsService is deprecated. Use CurationConcerns::LicenseService instead. This will be removed in curation_concerns 2.0")
+    Deprecation.warn(RightsService, "RightsService is deprecated. Use CurationConcerns.config.license_service_class instead. This will be removed in curation_concerns 2.0")
     authority.all.map do |element|
       [element[:label], element[:id]]
     end

data/app/services/sipity.rb

@@ -0,0 +1,2 @@
+module Sipity
+end

data/app/sources/curation_concerns/resource_statistics_source.rb

@@ -0,0 +1,101 @@
+module CurationConcerns
+  class ResourceStatisticsSource
+    attr_accessor :search_builder, :repository
+    def initialize(search_builder: ::CurationConcerns::AdminController.new.search_builder, repository: ::CurationConcerns::AdminController.new.repository)
+      # Remove gated discovery.
+      @search_builder = search_builder.except(:add_access_controls_to_solr_params)
+      @repository = repository
+      solr_arguments[:fq] ||= []
+      solr_arguments[:rows] = 0
+    end
+
+    def open_concerns_count
+      results_count(public_read_group)
+    end
+
+    def authenticated_concerns_count
+      results_count(registered_read_group)
+    end
+
+    def restricted_concerns_count
+      results_count([not_registered_read_group, not_public_read_group])
+    end
+
+    def expired_embargo_now_authenticated_concerns_count
+      results_count([registered_read_group, embargo_history_query])
+    end
+
+    def expired_embargo_now_open_concerns_count
+      results_count([public_read_group, embargo_history_query])
+    end
+
+    def active_embargo_now_authenticated_concerns_count
+      results_count([registered_read_group, active_embargo])
+    end
+
+    def active_embargo_now_restricted_concerns_count
+      results_count([not_registered_read_group, not_public_read_group, active_embargo])
+    end
+
+    def expired_lease_now_authenticated_concerns_count
+      results_count([registered_read_group, lease_history_query])
+    end
+
+    def expired_lease_now_restricted_concerns_count
+      results_count([not_registered_read_group, not_public_read_group, lease_history_query])
+    end
+
+    def active_lease_now_authenticated_concerns_count
+      results_count([registered_read_group, active_lease])
+    end
+
+    def active_lease_now_open_concerns_count
+      results_count([public_read_group, active_lease])
+    end
+
+    private
+
+      def solr_arguments
+        @solr_arguments ||= search_builder.to_h
+      end
+
+      def results_count(query)
+        q = { fq: Array.wrap(query) }
+        repository.search(solr_arguments.merge(q) do |_key, v1, v2|
+          v1 + v2
+        end)["response"]["numFound"]
+      end
+
+      def active_lease
+        "lease_expiration_date_dtsi:[NOW TO *]"
+      end
+
+      def active_embargo
+        "embargo_release_date_dtsi:[NOW TO *]"
+      end
+
+      def lease_history_query
+        "lease_history_ssim:*"
+      end
+
+      def embargo_history_query
+        "embargo_history_ssim:*"
+      end
+
+      def registered_read_group
+        "#{Hydra.config.permissions.read.group}:registered"
+      end
+
+      def not_registered_read_group
+        "-#{registered_read_group}"
+      end
+
+      def public_read_group
+        "#{Hydra.config.permissions.read.group}:public"
+      end
+
+      def not_public_read_group
+        "-#{public_read_group}"
+      end
+  end
+end

data/app/values/curation_concerns/chart_data.rb

@@ -0,0 +1,61 @@
+module CurationConcerns
+  class ChartData
+    attr_reader :data
+    def initialize(data)
+      @data = data
+    end
+
+    def drilldown
+      data.each_with_object([]) do |(k, v), arr|
+        arr << Value.new(k, v).drilldown_value
+      end.compact
+    end
+
+    def series
+      data.each_with_object([]) do |(k, v), arr|
+        arr << Value.new(k, v).series_value
+      end
+    end
+
+    class Value
+      def initialize(key, value)
+        @key = key
+        @value = value
+      end
+
+      def series_value
+        if @value.is_a?(Hash)
+          drilldown_hash
+        else
+          series_hash
+        end
+      end
+
+      def drilldown_value
+        return nil unless @value.is_a?(Hash)
+        {
+          name: @key,
+          id: @key,
+          data: @value.to_a
+        }
+      end
+
+      private
+
+        def drilldown_hash
+          {
+            name: @key,
+            y: @value.values.inject(&:+),
+            drilldown: @key
+          }
+        end
+
+        def series_hash
+          {
+            name: @key,
+            y: @value
+          }
+        end
+    end
+  end
+end

data/app/views/curation_concerns/admin/_admin_menu.html.erb

@@ -0,0 +1,5 @@
+<% configuration[:menu].each do |key, config| %>
+  <%= content_tag :li, class: (action_name == key ? 'active' : '') do %>
+    <%= link_to t("curation_concerns.dashboard.menu.#{key}"), polymorphic_path([curation_concerns, :admin, key])%>
+  <% end %>
+<% end %>

data/app/views/curation_concerns/admin/_resource_stats.html.erb

@@ -0,0 +1,43 @@
+<div class="panel-heading">
+  <h4 class="panel-title">Totals by Visibility</h4>
+</div>
+
+<table class="table table-striped">
+  <tr>
+    <th>Visibility</th>
+    <th>Count</th>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.open.text") %></td><td><span class="count"><%= resource_stats.open_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.authenticated.text") %></td><td><span class="count"><%= resource_stats.authenticated_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.restricted.text") %></td><td><span class="count"><%= resource_stats.restricted_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.embargo.expired.authenticated.text") %></td><td><span class="count"><%= resource_stats.expired_embargo_now_authenticated_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.embargo.expired.open.text") %></td><td><span class="count"><%= resource_stats.expired_embargo_now_open_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.embargo.active.authenticated.text") %></td><td><span class="count"><%= resource_stats.active_embargo_now_authenticated_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.embargo.active.restricted.text") %></td><td><span class="count"><%= resource_stats.active_embargo_now_restricted_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.lease.expired.restricted.text") %></td><td><span class="count"><%= resource_stats.expired_lease_now_restricted_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.lease.expired.authenticated.text") %></td><td><span class="count"><%= resource_stats.expired_lease_now_authenticated_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.lease.active.authenticated.text") %></td><td><span class="count"><%= resource_stats.active_lease_now_authenticated_concerns_count %></span></td>
+  </tr>
+  <tr>
+    <td><%= t("curation_concerns.visibility.lease.active.open.text") %></td><td><span class="count"><%= resource_stats.active_lease_now_open_concerns_count %></span></td>
+  </tr>
+</table>

data/app/views/curation_concerns/admin/_sidebar.html.erb

@@ -0,0 +1,3 @@
+                <ul class="nav nav-pills nav-stacked">
+                  <%= render "/curation_concerns/admin/admin_menu", configuration: @configuration %>
+                </ul>

data/app/views/curation_concerns/admin/_total_embargo_visibility.html.erb

@@ -0,0 +1,21 @@
+<div class="panel-heading">
+  <h4 class="panel-title">Embargos &amp; Leases</h4>
+</div>
+
+<div class="panel-body">
+      <%= render "curation_concerns/admin/widgets/pie", label: "embargo",
+        data: {
+        t("curation_concerns.visibility.embargo.text") => {
+          t("curation_concerns.visibility.embargo.expired.authenticated.text") => @resource_statistics.expired_embargo_now_authenticated_concerns_count,
+          t("curation_concerns.visibility.embargo.expired.open.text") => @resource_statistics.expired_embargo_now_open_concerns_count,
+          t("curation_concerns.visibility.embargo.active.authenticated.text") => @resource_statistics.active_embargo_now_authenticated_concerns_count,
+          t("curation_concerns.visibility.embargo.active.restricted.text") => @resource_statistics.active_embargo_now_restricted_concerns_count
+        },
+        t("curation_concerns.visibility.lease.text") => {
+          t("curation_concerns.visibility.lease.active.authenticated.text") => @resource_statistics.active_lease_now_authenticated_concerns_count,
+          t("curation_concerns.visibility.lease.expired.restricted.text") => @resource_statistics.expired_lease_now_restricted_concerns_count,
+          t("curation_concerns.visibility.lease.expired.authenticated.text") => @resource_statistics.expired_lease_now_authenticated_concerns_count,
+          t("curation_concerns.visibility.lease.active.open.text") => @resource_statistics.active_lease_now_open_concerns_count,
+        }
+      }  %>
+</div>

data/app/views/curation_concerns/admin/_total_objects.html.erb

@@ -0,0 +1 @@
+<%= render "resource_stats", resource_stats: @resource_statistics %>

data/app/views/curation_concerns/admin/_total_objects_charts.html.erb

@@ -0,0 +1,12 @@
+<div class="panel-heading">
+  <h4 class="panel-title">Visibility</h4>
+</div>
+
+<div class="panel-body">
+      <%= render "curation_concerns/admin/widgets/pie", label: "visibility",
+              data: {
+                  t("curation_concerns.visibility.open.text") => @resource_statistics.open_concerns_count,
+                  t("curation_concerns.visibility.authenticated.text") => @resource_statistics.authenticated_concerns_count,
+                  t("curation_concerns.visibility.restricted.text") =>  @resource_statistics.restricted_concerns_count
+              } %>
+</div>

data/app/views/curation_concerns/admin/index.html.erb

@@ -0,0 +1,11 @@
+<div class="<%= "dashboard-#{action_name}" %>">
+  <div class="wrapper">
+    <% @configuration[:actions][action_name][:partials].each do |partial_name| %>
+      <div class="<%= "partial-#{partial_name}" %>">
+        <div class="partial-wrapper">
+          <%= render partial_name %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/curation_concerns/admin/widgets/_pie.html.erb

@@ -0,0 +1 @@
+<%= content_tag :div, '', id: "#{label}-stats-pie", class: "stats-pie", data: { label: "#{label}_data", series: hash_to_chart(data) }, style: "height: 300px;" %>

data/app/views/curation_concerns/admin/workflow.html.erb

@@ -0,0 +1,31 @@
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h3 class="panel-title">Review and comment</h3>
+  </div>
+  <div class="panel-body panel-body-table">
+
+    <div class="table-responsive">
+      <table class="table table-condensed table-bordered table-striped">
+        <thead>
+          <tr>
+            <th width="60%">Title</th>
+            <th width="20%">Status</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @status_list.each do |document| %>
+            <tr>
+              <td>
+                <%= link_to document, [main_app, document] %>
+              </td>
+              <td>
+                <span class="state state-pending"><%= document.workflow_state %></span>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+
+  </div>
+</div>