curation_concerns 1.6.3 → 1.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 172fab1ebafb8c3dd0f68ce83a797cd58a8189b2
-  data.tar.gz: 90c86d467af21617a3bd2a9cdb806f2ee5b3f8df
+  metadata.gz: 976d4594c0d89e8f8fc0fb3eb2e3fda2bc0de0e7
+  data.tar.gz: 0bba18a25f0eb32c5998c071544accdd09bcebd0
 SHA512:
-  metadata.gz: c63887d9ff1971c2bf495ce9264247e145265789d8fb68ec77b98c987467f8a1e6ea045f7c2cca84ab335479aba5f079795f54f014e7229a715d814fb6218cb2
-  data.tar.gz: 358867ae2f068736ae5daf0bc474f657dd22132218071b4e9e3b85432007710491901782716118cef08bb9c6ae6da4e00f682143c23880d5d1da59c470bf2570
+  metadata.gz: 2edb7a435f0b294fa1018bca41904327219d0b75ddc8ed736b20851b5d57bce7142085241e9d73e2d4df6c2784fad14fbe8851ff4f8302040af7e1cd2fb4472b
+  data.tar.gz: 1b31bc0aefd9067b0874e1dd0ab3e383a2a4c5f8b6190a2d977892d17b78edc9acdea5f7a8b3795d087f75cbc23d6ec1b0810da1851ab6bee974c28463bbd5eb

data/.rubocop.yml

@@ -1,6 +1,7 @@
 require: rubocop-rspec
 AllCops:
   DisplayCopNames: true
+  TargetRubyVersion: 2.1
   Include:
     - '**/Rakefile'
     - '**/config.ru'
@@ -47,6 +48,8 @@ Metrics/ModuleLength:
     - 'app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb'
     - 'app/models/concerns/curation_concerns/solr_document_behavior.rb'
     - 'app/controllers/concerns/curation_concerns/collections_controller_behavior.rb'
+    - 'app/services/curation_concerns/workflow/permission_query.rb'
+    - 'spec/services/curation_concerns/workflow/permission_query_spec.rb'
 
 Style/ZeroLengthPredicate:
   Enabled: false
@@ -165,6 +168,7 @@ RSpec/DescribeClass:
     - 'spec/views/**/*'
     - 'spec/routing/**/*'
     - 'spec/inputs/**/*'
+    - 'spec/conversions/**/*'
 
 RSpec/DescribedClass:
   Exclude:

data/.travis.yml

@@ -7,15 +7,9 @@ env:
   global:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
   matrix:
-    - RAILS_VERSION=4.2.7
+    - RAILS_VERSION=4.2.7.1
       RDF_VERSION=1.99.1
-    - RAILS_VERSION=5.0.0
+    - RAILS_VERSION=5.0.0.1
       RDF_VERSION=2.1.0
-notifications:
-  irc:
-    channels:
-      - "irc.freenode.org#projecthydra"
-    template:
-      - "%{repository}//%{branch}@%{commit} by %{author}: %{message} - %{build_url}"
 before_script:
   - jdk_switcher use oraclejdk8

data/README.md

@@ -11,7 +11,6 @@ Docs: [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.sv
 
 Join in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack.projecthydra.org/) [![Ready](https://badge.waffle.io/projecthydra/curation_concerns.svg?label=ready&title=Ready)](http://waffle.io/projecthydra/curation_concerns)
 
-
 A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) objects (based on [Hydra::Works](http://github.com/projecthydra/hydra-works)) and providing a generator for defining object types with custom workflows, views, access controls, etc.
 
 ## Prerequisites
@@ -109,6 +108,33 @@ rake engine_cart:generate
 rake curation_concerns:spec
 ```
 
+### Workflow
+
+Load the workflows, workflow states, transitions and user roles:
+
+```
+$ rails curation_concerns:workflow:load
+```
+
+Now that the Roles are loaded, grant the appropriate roles to the users by visiting the "Workflow Roles" section of the admin dashboard
+
+[Further documentation](https://github.com/projecthydra/curation_concerns/wiki/Defining-a-Workflow) for defining and customizing workflows.
+
+_Something about notification should go here._
+
+### Adding Sample Data to Test Application
+
+Sometimes when working with the test application, it can be helpful to have a repository populated with some number of objects. Rather than having to create them all through the user interface, which can be timely, the test application bundled with CurationConcerns provides a rake task that automatically creates 24 objects in the test application repository with different titles, levels of visibility, embargoes, and leases:
+
+``` bash
+cd .internal_test_app
+rake db:seed
+```
+
+### Configuring the Administration Panel
+
+To configure the Administration Pane see [Admin Menu Guide](https://github.com/projecthydra/curation_concerns/wiki/Admin-Menu)
+
 ## Help
 
 If you have questions or need help, please email the [Hydra community tech list](mailto:hydra-tech@googlegroups.com) or stop by the [Hydra community IRC channel](irc://irc.freenode.net/projecthydra).

data/app/actors/curation_concerns/actors/base_actor.rb

@@ -12,7 +12,7 @@ module CurationConcerns
         @cloud_resources = attributes.delete(:cloud_resources.to_s)
         apply_creation_data_to_curation_concern
         apply_save_data_to_curation_concern(attributes)
-        next_actor.create(attributes) && save && run_callbacks(:after_create_concern)
+        save && next_actor.create(attributes) && run_callbacks(:after_create_concern)
       end
 
       def update(attributes)
@@ -38,8 +38,7 @@ module CurationConcerns
         end
 
         def apply_depositor_metadata
-          curation_concern.apply_depositor_metadata(user.user_key)
-          curation_concern.edit_users += [user.user_key]
+          curation_concern.depositor = user.user_key
         end
 
         def apply_deposit_date

data/app/actors/curation_concerns/actors/file_set_actor.rb

@@ -125,7 +125,7 @@ module CurationConcerns
         end
 
         def assign_visibility?(file_set_params = {})
-          !((file_set_params || {}).keys & %w(visibility embargo_release_date lease_expiration_date)).empty?
+          !((file_set_params || {}).keys.map(&:to_s) & %w(visibility embargo_release_date lease_expiration_date)).empty?
         end
 
         # copy visibility from source_concern to destination_concern

data/app/actors/curation_concerns/actors/grant_edit_to_depositor_actor.rb

@@ -0,0 +1,19 @@
+module CurationConcerns
+  module Actors
+    # Grants edit access to the depositor.  This is implemented as a separate actor,
+    # so that it can be removed from the stack in cases where the depositor should not
+    # have edit access (e.g. mediated deposit)
+    class GrantEditToDepositorActor < AbstractActor
+      def create(attributes)
+        grant_edit_access
+        next_actor.create(attributes)
+      end
+
+      private
+
+        def grant_edit_access
+          curation_concern.edit_users += [user.user_key]
+        end
+    end
+  end
+end

data/app/actors/curation_concerns/actors/initialize_workflow_actor.rb

@@ -0,0 +1,19 @@
+module CurationConcerns
+  module Actors
+    class InitializeWorkflowActor < AbstractActor
+      class_attribute :workflow_factory
+      self.workflow_factory = ::CurationConcerns::Workflow::WorkflowFactory
+
+      def create(attributes)
+        next_actor.create(attributes) && create_workflow(attributes)
+      end
+
+      private
+
+        # @return [TrueClass]
+        def create_workflow(attributes)
+          workflow_factory.create(curation_concern, attributes, user)
+        end
+    end
+  end
+end

data/app/assets/javascripts/curation_concerns/charts.js

@@ -0,0 +1,47 @@
+//= require highcharts
+//= require highcharts/highcharts-more
+//= require highcharts/modules/drilldown
+
+(function( $ ){
+  $.fn.pie_chart = function(title, data) {
+    // Create the chart
+    $(this).highcharts({
+        chart: {
+            type: 'pie'
+        },
+        plotOptions: {
+            series: {
+                dataLabels: {
+                    enabled: true,
+                    format: '{point.name}: {point.y}'
+                }
+            }
+        },
+
+        credits: {
+          enabled: false
+        },
+
+        tooltip: {
+            headerFormat: '<span style="font-size:11px">{series.name}</span><br>',
+            pointFormat: '<span style="color:{point.color}">{point.name}</span>: <b>{point.percentage:.2f}%</b> of total<br/>'
+        },
+        series: [{
+            name: title,
+            colorByPoint: true,
+            data: data.series
+        }],
+        title: null,
+        drilldown: data.drilldown
+    });
+  };
+})( jQuery );
+
+Blacklight.onLoad(function () {
+    $('.stats-pie').each (function () {
+      series = $(this).data('series');
+      title = $(this).data('title');
+      drilldown = $(this).data('drilldown');
+      $(this).pie_chart(title, series, drilldown);
+    });
+});

data/app/assets/javascripts/curation_concerns/curation_concerns.js

@@ -10,7 +10,9 @@
 //= require curation_concerns/collections
 //= require curation_concerns/file_manager
 //= require curation_concerns/boot
+//= require curation_concerns/charts
 //= require babel/polyfill
+//= require curation_concerns/workflow_actions_affix
 
 // Initialize plugins and Bootstrap dropdowns on jQuery's ready event as well as
 // Turbolinks's page change event.

data/app/assets/javascripts/curation_concerns/workflow_actions_affix.js

@@ -0,0 +1,11 @@
+Blacklight.ready(function() {
+  $(document).on('scroll', function() {
+    var workflowDiv = $('#workflow_controls');
+    if($(window).scrollTop() + $(window).height() == $(document).height()){
+      workflowDiv.removeClass('workflow-affix');
+    } 
+    if($(window).scrollTop() + $(window).height() < $('.form-actions').position().top) {
+      workflowDiv.addClass('workflow-affix');
+    }
+  });
+});

data/app/assets/stylesheets/curation_concerns/_admin.scss

@@ -0,0 +1,18 @@
+@mixin widget-partial($col: 12) {
+  @include make-sm-column(12);
+  @include make-md-column($col);
+  .partial-wrapper {
+    @extend .panel;
+    @extend .panel-default;
+  }
+}
+
+.partial-total_objects {
+  @include widget-partial;
+}
+.partial-total_objects_charts {
+  @include widget-partial(6);
+}
+.partial-total_embargo_visibility {
+  @include widget-partial(6);
+}

data/app/assets/stylesheets/curation_concerns/_curation_concerns.scss

@@ -5,3 +5,4 @@
 @import "curation_concerns/typography";
 @import 'hydra-editor/multi_value_fields';
 @import 'curation_concerns/fileupload';
+@import 'curation_concerns/admin';

data/app/assets/stylesheets/curation_concerns/_positioning.scss

@@ -138,3 +138,14 @@ legend + .form-group {
   display: block;
   padding: 0.5em 0;
 }
+
+.workflow-affix {
+  position: fixed;
+  bottom: 0;
+  background: #FFF;
+  z-index: 2;
+  left: 0;
+  right: 0;
+  max-width: 1140px;
+  margin: 0 auto;
+}

data/app/controllers/concerns/curation_concerns/act_as_admin_controller.rb

@@ -0,0 +1,25 @@
+module CurationConcerns
+  # Behavior to allow any controller to be displayed within
+  # the administrative dashboard
+  #
+  # Example useage:
+  #
+  #    module CurationConcerns
+  #      class Admin::MyController < ApplicationController
+  #        include CurationConcerns::ActAsAdminController
+  #
+  #        # do my stuff ...
+  #      end
+  #    end
+  #
+  module ActAsAdminController
+    extend ActiveSupport::Concern
+    included do
+      before_action :load_configuration
+      layout 'admin'
+    end
+    def load_configuration
+      @configuration = CurationConcerns::AdminController.configuration
+    end
+  end
+end

data/app/controllers/concerns/curation_concerns/admin_controller_behavior.rb

@@ -0,0 +1,38 @@
+module CurationConcerns
+  module AdminControllerBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      include AdminPage
+      before_action :require_permissions
+    end
+
+    def index
+      @resource_statistics = @configuration.fetch(:data_sources).fetch(:resource_stats).new
+      render 'index'
+    end
+
+    def search_builder
+      @search_builder ||= ::CatalogController.new.search_builder
+    end
+
+    def repository
+      @repository ||= ::CatalogController.new.repository
+    end
+
+    def workflow
+      @status_list = CurationConcerns::Workflow::StatusListService.new(current_user)
+    end
+
+    private
+
+      def require_permissions
+        authorize! :read, :admin_dashboard
+      end
+
+      # Loads the index action if it's only defined in the configuration.
+      def action_missing(action)
+        index if @configuration[:actions].include?(action)
+      end
+  end
+end

data/app/controllers/concerns/curation_concerns/admin_page.rb

@@ -0,0 +1,18 @@
+module CurationConcerns
+  module AdminPage
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :configuration
+      self.configuration = CurationConcerns.config.dashboard_configuration
+      before_action :load_configuration
+      layout "admin"
+    end
+
+    private
+
+      def load_configuration
+        @configuration = self.class.configuration.with_indifferent_access
+      end
+  end
+end

data/app/controllers/concerns/curation_concerns/collections_controller_behavior.rb

@@ -17,7 +17,7 @@ module CurationConcerns
       # Catch permission errors
       rescue_from Hydra::AccessDenied, CanCan::AccessDenied do |exception|
         if exception.action == :edit
-          redirect_to(collections.url_for(action: 'show'), alert: 'You do not have sufficient privileges to edit this document')
+          redirect_to(url_for(action: 'show'), alert: 'You do not have sufficient privileges to edit this document')
         elsif current_user && current_user.persisted?
           redirect_to root_url, alert: exception.message
         else
@@ -273,7 +273,8 @@ module CurationConcerns
         end
       end
 
-      # Include 'catalog' and 'curation_concerns/base' in the search path for views
+      # Include 'catalog' and 'curation_concerns/base' in the search path for views, while prefering
+      # our local paths. Thus we are unable to just override `self.local_prefixes`
       def _prefixes
         @_prefixes ||= super + ['catalog', 'curation_concerns/base']
       end