curation_concerns 0.12.0.pre1 → 0.12.0.pre2

data/app/actors/curation_concerns/file_set_actor.rb

@@ -0,0 +1,146 @@
+module CurationConcerns
+  # Actions are decoupled from controller logic so that they may be called from a controller or a background job.
+  class FileSetActor
+    include CurationConcerns::Lockable
+
+    attr_reader :file_set, :user, :attributes
+
+    def initialize(file_set, user)
+      @file_set = file_set
+      @user = user
+    end
+
+    # Adds the appropriate metadata, visibility and relationships to file_set
+    #
+    # *Note*: In past versions of Sufia this method did not perform a save because it is mainly used in conjunction with
+    # create_content, which also performs a save.  However, due to the relationship between Hydra::PCDM objects,
+    # we have to save both the parent work and the file_set in order to record the "metadata" relationship
+    # between them.
+    # @param [ActiveFedora::Base] work the parent work that will contain the file_set.
+    # @param [Hash] file_set specifying the visibility, lease and/or embargo of the file set.  If you don't provide at least one of visibility, embargo_release_date or lease_expiration_date, visibility will be copied from the parent.
+
+    def create_metadata(work, file_set_params = {})
+      file_set.apply_depositor_metadata(user)
+      now = CurationConcerns::TimeService.time_in_utc
+      file_set.date_uploaded = now
+      file_set.date_modified = now
+      file_set.creator = [user.user_key]
+
+      CurationConcern::ActorStack.new(file_set, user, [InterpretVisibilityActor]).create(file_set_params) if assign_visibility?(file_set_params)
+      attach_file_to_work(work, file_set, file_set_params) if work
+      yield(file_set) if block_given?
+    end
+
+    # @param [File, ActionDigest::HTTP::UploadedFile, Tempfile] file the file uploaded by the user.
+    # @param [String] relation ('original_file')
+    def create_content(file, relation = 'original_file')
+      # If the file set doesn't have a title or label assigned, set a default.
+      file_set.label ||= file.respond_to?(:original_filename) ? file.original_filename : ::File.basename(file)
+      file_set.title = [file_set.label] if file_set.title.blank?
+
+      # Need to save the file_set in order to get an id
+      return false unless file_set.save
+
+      file_actor_class.new(file_set, relation, user).ingest_file(file)
+      true
+    end
+
+    # @param [String] revision_id the revision to revert to
+    # @param [String] relation ('original_file')
+    def revert_content(revision_id, relation = 'original_file')
+      file_actor = file_actor_class.new(file_set, relation, user)
+      if file_actor.revert_to(revision_id)
+        CurationConcerns.config.callback.run(:after_revert_content, file_set, user, revision_id)
+        true
+      else
+        false
+      end
+    end
+
+    # @param [File, ActionDigest::HTTP::UploadedFile, Tempfile] file the file uploaded by the user.
+    # @param [String] relation ('original_file')
+    def update_content(file, relation = 'original_file')
+      file_actor_class.new(file_set, relation, user).ingest_file(file)
+      CurationConcerns.config.callback.run(:after_update_content, file_set, user)
+      true
+    end
+
+    def update_metadata(attributes)
+      stack = CurationConcern::ActorStack.new(file_set,
+                                              user,
+                                              [InterpretVisibilityActor, BaseActor])
+      if result = stack.update(attributes)
+        CurationConcerns.config.callback.run(:after_update_metadata, file_set, user)
+      end
+      result
+    end
+
+    def destroy
+      file_set.destroy
+      CurationConcerns.config.callback.run(:after_destroy, file_set.id, user)
+    end
+
+    def file_actor_class
+      CurationConcerns::FileActor
+    end
+
+    private
+
+      # Takes an optional block and executes the block if the save was successful.
+      # returns false if the save was unsuccessful
+      def save
+        save_tries = 0
+        begin
+          return false unless file_set.save
+        rescue RSolr::Error::Http => error
+          ActiveFedora::Base.logger.warn "CurationConcerns::FileSetActor#save Caught RSOLR error #{error.inspect}"
+          save_tries += 1
+          # fail for good if the tries is greater than 3
+          raise error if save_tries >= 3
+          sleep 0.01
+          retry
+        end
+        yield if block_given?
+        true
+      end
+
+      # Adds a FileSet to the work using ore:Aggregations.
+      # Locks to ensure that only one process is operating on
+      # the list at a time.
+      def attach_file_to_work(work, file_set, file_set_params)
+        acquire_lock_for(work.id) do
+          # Ensure we have an up-to-date copy of the members association, so
+          # that we append to the end of the list.
+          work.reload unless work.new_record?
+          unless assign_visibility?(file_set_params)
+            copy_visibility(work, file_set)
+          end
+          work.ordered_members << file_set
+          set_representative(work, file_set)
+          set_thumbnail(work, file_set)
+
+          # Save the work so the association between the work and the file_set is persisted (head_id)
+          work.save
+        end
+      end
+
+      def assign_visibility?(file_set_params = {})
+        !((file_set_params || {}).keys & %w(visibility embargo_release_date lease_expiration_date)).empty?
+      end
+
+      # copy visibility from source_concern to destination_concern
+      def copy_visibility(source_concern, destination_concern)
+        destination_concern.visibility =  source_concern.visibility
+      end
+
+      def set_representative(work, file_set)
+        return unless work.representative_id.blank?
+        work.representative = file_set
+      end
+
+      def set_thumbnail(work, file_set)
+        return unless work.thumbnail_id.blank?
+        work.thumbnail = file_set
+      end
+  end
+end

data/app/actors/curation_concerns/interpret_visibility_actor.rb

@@ -0,0 +1,123 @@
+module CurationConcerns
+  class InterpretVisibilityActor < AbstractActor
+    class Intention
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      # returns a copy of attributes with the necessary params removed
+      # If the lease or embargo is valid, or if they selected something besides lease
+      # or embargo, remove all the params.
+      def sanitize_params
+        if valid_lease?
+          @attributes.except(:visibility,
+                             :embargo_release_date,
+                             :visibility_during_embargo,
+                             :visibility_after_embargo)
+        elsif valid_embargo?
+          @attributes.except(:visibility,
+                             :lease_expiration_date,
+                             :visibility_during_lease,
+                             :visibility_after_lease)
+        elsif !wants_lease? && !wants_embargo?
+          @attributes.except(:lease_expiration_date,
+                             :visibility_during_lease,
+                             :visibility_after_lease,
+                             :embargo_release_date,
+                             :visibility_during_embargo,
+                             :visibility_after_embargo)
+        else
+          @attributes
+        end
+      end
+
+      def wants_lease?
+        visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_LEASE
+      end
+
+      def wants_embargo?
+        visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_EMBARGO
+      end
+
+      def valid_lease?
+        wants_lease? && @attributes[:lease_expiration_date].present?
+      end
+
+      def valid_embargo?
+        wants_embargo? && @attributes[:embargo_release_date].present?
+      end
+
+      def lease_params
+        [:lease_expiration_date,
+         :visibility_during_lease,
+         :visibility_after_lease].map { |key| @attributes[key] }
+      end
+
+      def embargo_params
+        [:embargo_release_date,
+         :visibility_during_embargo,
+         :visibility_after_embargo].map { |key| @attributes[key] }
+      end
+
+      private
+
+        def visibility
+          @attributes[:visibility]
+        end
+    end
+
+    def create(attributes)
+      @intention = Intention.new(attributes)
+      attributes = @intention.sanitize_params
+      validate && apply_visibility(attributes) && next_actor.create(attributes)
+    end
+
+    def update(attributes)
+      @intention = Intention.new(attributes)
+      attributes = @intention.sanitize_params
+      validate && apply_visibility(attributes) && next_actor.update(attributes)
+    end
+
+    private
+
+      def validate
+        validate_lease && validate_embargo
+      end
+
+      def apply_visibility(attributes)
+        result = apply_lease && apply_embargo
+        if attributes[:visibility]
+          curation_concern.visibility = attributes[:visibility]
+        end
+        result
+      end
+
+      def validate_lease
+        return true unless @intention.wants_lease? && !@intention.valid_lease?
+        curation_concern.errors.add(:visibility, 'When setting visibility to "lease" you must also specify lease expiration date.')
+        false
+      end
+
+      def validate_embargo
+        return true unless @intention.wants_embargo? && !@intention.valid_embargo?
+        curation_concern.errors.add(:visibility, 'When setting visibility to "embargo" you must also specify embargo release date.')
+        false
+      end
+
+      # If they want a lease, we can assume it's valid
+      def apply_lease
+        return true unless @intention.wants_lease?
+        curation_concern.apply_lease(*@intention.lease_params)
+        return unless curation_concern.lease
+        curation_concern.lease.save # see https://github.com/projecthydra/hydra-head/issues/226
+      end
+
+      # If they want an embargo, we can assume it's valid
+      def apply_embargo
+        return true unless @intention.wants_embargo?
+        curation_concern.apply_embargo(*@intention.embargo_params)
+        return unless curation_concern.embargo
+        curation_concern.embargo.save # see https://github.com/projecthydra/hydra-head/issues/226
+      end
+  end
+end

data/app/actors/curation_concerns/lease_actor.rb

@@ -0,0 +1,19 @@
+module CurationConcerns
+  class LeaseActor
+    attr_reader :work
+
+    # @param [Hydra::Works::Work] work
+    def initialize(work)
+      @work = work
+    end
+
+    # Update the visibility of the work to match the correct state of the lease, then clear the lease date, etc.
+    # Saves the lease and the work
+    def destroy
+      work.lease_visibility! # If the lease has lapsed, update the current visibility.
+      work.deactivate_lease!
+      work.lease.save!
+      work.save!
+    end
+  end
+end

data/app/actors/curation_concerns/root_actor.rb

@@ -0,0 +1,17 @@
+module CurationConcerns
+  class RootActor
+    attr_reader :curation_concern, :user, :cloud_resources
+    def initialize(curation_concern, user, _more_actors)
+      @curation_concern = curation_concern
+      @user = user
+    end
+
+    def create(_)
+      true
+    end
+
+    def update(_)
+      true
+    end
+  end
+end

data/app/actors/curation_concerns/work_actor_behavior.rb

@@ -0,0 +1,8 @@
+module CurationConcerns::WorkActorBehavior
+  extend ActiveSupport::Concern
+  extend Deprecation
+
+  included do
+    Deprecation.warn(CurationConcerns::WorkActorBehavior, "CurationConcerns::WorkActorBehavior is deprecated and will be removed in CurationConcerns 1.0")
+  end
+end

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

@@ -0,0 +1,42 @@
+Blacklight.onLoad(function () {
+
+  // add the batch ids to any submit of a batch update
+  var batch_ids = null;
+  $('input.updates-batches').on('click', function() {  
+    var form = $(this).closest("form"); 
+    var hash, id;
+
+    // pull the ids from the url
+    if (!batch_ids) {
+      batch_ids = [];
+      // pull the ids from the url
+      var q = document.URL.split('?')[1];
+      if(q != undefined){
+          q = q.split('&');
+          for(var i = 0; i < q.length; i++){
+              hash = q[i].split('=');
+              if (hash[0] == "batch_document_ids%5B%5D")
+                 batch_ids.push(unescape(hash[1]));
+          }
+       }
+    }
+
+    // push the ids in the form
+    for(var j = 0; j < batch_ids.length; j++){
+      if (form.children("input[value='"+batch_ids[j]+"']").length == 0)
+        form.append('<input type="hidden" multiple="multiple" name="batch_document_ids[]" value="'+batch_ids[j]+'" />');
+    }
+      
+  });
+  $('input.submits-batches').on('click', function() {  
+      var form = $(this).closest("form"); 
+      $.map( $(".batch_document_selector:checked"), function(document, i) {
+         var id = document.id.substring("batch_document_".length);
+         if (form.children("input[value='"+id+"']").length == 0)
+           form.append('<input type="hidden" multiple="multiple" name="batch_document_ids[]" value="'+id+'" />');
+      });
+  
+      
+  });
+
+});

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

@@ -0,0 +1,13 @@
+Blacklight.onLoad(function () {
+
+  // change the action based which collection is selected
+  $('input.updates-collection').on('click', function() {
+ 
+      var form = $(this).closest("form"); 
+      var collection_id = $(".collection-selector:checked")[0].value;      
+      form[0].action = form[0].action.replace("collection_replace_id",collection_id);
+      form.append('<input type="hidden" value="add" name="collection[members]"></input>');
+      
+  });
+
+});

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

@@ -7,6 +7,8 @@
 //= require curation_concerns/file_manager/sorting
 //= require curation_concerns/file_manager/save_manager
 //= require curation_concerns/file_manager/member
+//= require curation_concerns/batch_select
+//= require curation_concerns/collections
 
 
 // Initialize plugins and Bootstrap dropdowns on jQuery's ready event as well as

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

@@ -1,7 +1,4 @@
-@import 'bootstrap-sprockets';
-@import 'bootstrap';
 @import 'blacklight/facets';
-@import "curation_concerns/global-variables";
 @import "curation_concerns/positioning";
 @import "curation_concerns/modules";
 @import "curation_concerns/theme";

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

@@ -1,6 +1,5 @@
 @import 'modules/classify_work';
 @import 'modules/forms';
-@import 'modules/multi_value_fields';
 @import 'modules/search_results';
 @import 'modules/site_actions';
 @import 'modules/site_search';
@@ -8,3 +7,4 @@
 @import 'modules/embargoes';
 @import 'modules/icons';
 @import 'modules/file_manager';
+@import 'modules/collections';

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

@@ -1,9 +1,6 @@
-#brand-bar-wrapper, #title-bar-wrapper {
-  margin-left:-1em;
-  margin-right:-1em;
-  h2, h3 {
-    line-height: 40px;
-  }
+#brand-bar {
+  margin-bottom :0;
+  z-index: $zindex-navbar + 1;
 }
 
 .form-actions > form.button_to {

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

@@ -1,42 +1,3 @@
-#brand-bar-wrapper {
-  background-color: $blue-dark;
-  background-image: linear-gradient(#0d407b,#07366c 85%,#001834);
-  border-bottom:1px solid #001834;
-
-  h2 a, h3 a {
-    color:#FFF;
-  }
-
-  .division {
-    float:right;
-  }
-}
-
-#title-bar-wrapper {
-  background-color:$yellow;
-  background-image: linear-gradient(#f5e59e,#dcb439 98%,#9c7012);
-  border-top:1px solid #FFF;
-  margin-bottom:.3em;
-}
-
-#site-title {
-  h1 {
-    text-shadow: #fff 0 0 1px;
-  }
-
-  a,
-  a:hover,
-  a:visited {
-    color:$blue;
-  }
-}
-
-#main {
-  h1,h2,h3,h4,h5,h6 {
-    color:$blue;
-  }
-}
-
 #footer {
   color: $gray-light;
 

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

@@ -1,51 +1,8 @@
-@import 'global-variables';
-
-#banner {
-  h1,h2,h3 {
-    font-weight:normal;
-  }
-
-  a {
-    text-decoration:none;
-  }
-}
-
 #brand-bar-wrapper {
-  font-family: $font-family-serif;
-  letter-spacing:.2em;
-  padding:.15em 0;
-  text-transform:uppercase;
-
-  h2, h3 {
-    font-size:.95em;
-    margin:0;
-  }
-
-  .division {
-    text-align:right;
-  }
-
-  i {
-    letter-spacing:0;
-    padding:0 .2em;
-    text-transform:none;
-  }
-}
-
-#site-title h1 {
-  font-family: $font-family-serif;
-  font-size:2.4em;
-  line-height:1.2em;
-  text-align:center;
 }
 
 #main,
 .modal-header {
-  h1,h2,h3,h4,h5,h6 {
-    font-family:$headings-font-family;
-    font-weight:normal;
-    text-rendering: optimizeLegibility;
-  }
   h1 {
     .human_readable_type {
       font-size:.66em;
@@ -63,24 +20,12 @@ legend {
   }
 }
 
-.table-heading {
-  text-align:left;
-
-  h1,h2,h3,h4,h5,h6 {
-    padding-top:1em;
-  }
-}
-
 .nested-field-heading {
   font-family: $font-family-sans-serif;
   font-size: 14px;
   font-weight:normal;
 }
 
-.redacted {
-  font-family:'BLOKKNeue-Regular';
-}
-
 #footer {
   text-align:center;
 
@@ -89,16 +34,6 @@ legend {
   }
 }
 
-.centered {
-  text-align:center;
-}
-
-.doi {
-  font-size:200%;
-  margin:1em 0;
-  text-align:center;
-}
-
 .inline-item-actions {
   padding:0 .5em;
 
@@ -120,7 +55,3 @@ legend {
     }
   }
 }
-
-.center {
-  text-align:center;
-}

data/app/assets/stylesheets/curation_concerns/modules/classify_work.scss

@@ -1,5 +1,3 @@
-@import 'curation_concerns/global-variables';
-
 /* Aligning content types by leveraging text-align:justify
   http://www.barrelny.com/blog/text-align-justify-and-rwd/
 */

data/app/assets/stylesheets/curation_concerns/modules/collections.scss

@@ -0,0 +1,4 @@
+.collection-list {
+  max-height: 200px;
+  overflow-y: scroll;
+}

data/app/assets/stylesheets/curation_concerns/modules/forms.scss

@@ -31,10 +31,6 @@ legend small {
   color:$gray-dark;
 }
 
-.form-actions .btn-link {
-  color: $blue;
-}
-
 .form-actions {
   margin-top: 1em;
 }

data/app/assets/stylesheets/curation_concerns/modules/site_actions.scss

@@ -1,46 +1,33 @@
-#site-actions {
-  .dropdown-menu {
-    text-align:left;
-  }
-
-  // Overriding default boostrap behavior
-  .btn-group + .btn-group {
-    margin-left:0;
-  }
-}
-
 .dropdown-menu {
-  .item-with-options,
-  .item-option {
-    display:block;
+  .item-with-options {
+    display: block;
     padding:3px 20px;
-    line-height:20px;
-    color:#333;
+    line-height: $line-height-base;
+    color: $dropdown-link-color;
   }
 
   .item-options{
     margin:0;
     padding:0;
     list-style-type:none;
-  }
 
-  .item-option{
-    padding-left:30px;
+    // Links within the dropdown menu
+    > li > a {
+      display: block;
+      padding: 3px 20px 3px 30px;
+      clear: both;
+      font-weight: normal;
+      line-height: $line-height-base;
+      color: $dropdown-link-color;
+      white-space: nowrap; // prevent links from randomly breaking onto new lines
+    }
   }
 
-  /* TODO: convert this from compiled bootstrap styles to SASS mixins if available. */
   .item-option:hover,
   .item-option:focus {
     text-decoration: none;
-    color: white;
-    background-color: #0056b7;
-    background-image: -moz-linear-gradient(top, #005bc1, #004fa8);
-    background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#005bc1), to(#004fa8));
-    background-image: -webkit-linear-gradient(top, #005bc1, #004fa8);
-    background-image: -o-linear-gradient(top, #005bc1, #004fa8);
-    background-image: linear-gradient(to bottom, #005bc1, #004fa8);
-    background-repeat: repeat-x;
-    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FF005BC1', endColorstr='#FF004FA8', GradientType=0);
+    color: $dropdown-link-hover-color;
+    background-color: $dropdown-link-hover-bg;
   }
 
   .menu-heading {
@@ -51,3 +38,21 @@
     font-style:italic;
   }
 }
+
+@media (max-width: $grid-float-breakpoint-max) {
+  .navbar-inverse {
+    .item-with-options {
+      color: $navbar-inverse-link-color;
+    }
+    .item-options {
+      > li > a {
+        color: $navbar-inverse-link-color;
+        &:hover,
+        &:focus {
+          color: $navbar-inverse-link-hover-color;
+          background-color: $navbar-inverse-link-hover-bg;
+        }
+      }
+    }
+  }
+}