worthwhile-models 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e40a4356445e489fdd44804236d674d99cd7f29
-  data.tar.gz: 426954c2064b078d0a811069528a96642cb4fdfb
+  metadata.gz: 58f35d866b0060f648dfa182e9f9ad547e1c68b9
+  data.tar.gz: f8aabad35e8d3e43edb296f8aea2f1e1987071b3
 SHA512:
-  metadata.gz: dd3b23367115d00157ecd7c21b38c8dc0a279f328f4a7d1fe5bfbca99b08518c8512c43056a689b4f8a4d343d6c0db0b302e505e33298052a3b5bdc63b8f358f
-  data.tar.gz: c36133602cc143df28212470c1c0d43588703c2cc9d3840e4525de1f05170ea9c27dc80597f147038aeef302fd2abb3ad5f1832f0c1a54c20aea7194cb63462f
+  metadata.gz: 41f4d8bffd869208af3c9b2164b758b6e08d055f14bdb8bf86e48cf5ae7b2663e75a9e5ee1375c2d2a4f5cda09c5940e709b3e48dbc5e0d243bdf0b5c6492bfb
+  data.tar.gz: 8922c9bce4a1b64bc7b10d8524b6851a2730c5b01f12de63e4c22ecc40104b98a8b4560ab042fdd6c7b7da3494369ebd99e2a81d93941b5e603c53d581dc5580

data/app/actors/concerns/worthwhile/manages_embargoes_actor.rb

@@ -0,0 +1,79 @@
+module Worthwhile
+  #  To use this module, include it in your Actor class
+  #  and then add its interpreters wherever you want them to run.
+  #  They should be called _before_ apply_attributes is called because
+  #  they intercept values in the attributes Hash.
+  #
+  #  @example
+  #  class MyActorClass < BaseActor
+  #     include Worthwile::ManagesEmbargoesActor
+  #
+  #     def create
+  #       interpret_visibility && super && copy_visibility
+  #     end
+  #
+  #     def update
+  #       interpret_visibility && super && copy_visibility
+  #     end
+  #  end
+  #
+  module ManagesEmbargoesActor
+    extend ActiveSupport::Concern
+
+    # Interprets embargo & lease visibility if necessary
+    # returns false if there are any errors
+    def interpret_visibility
+      interpret_embargo_visibility && interpret_lease_visibility
+    end
+
+    # If user has set visibility to embargo, interprets the relevant information and applies it
+    # Returns false if there are any errors and sets an error on the curation_concern
+    def interpret_embargo_visibility
+      if attributes[:visibility] != Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_EMBARGO
+        # clear embargo_release_date even if it isn't being used. Otherwise it sets the embargo_date
+        # even though they didn't select embargo on the form.
+        attributes.delete(:visibility_during_embargo)
+        attributes.delete(:visibility_after_embargo)
+        attributes.delete(:embargo_release_date)
+        true
+      elsif !attributes[:embargo_release_date]
+        curation_concern.errors.add(:visibility, 'When setting visibility to "embargo" you must also specify embargo release date.')
+        false
+      else
+        attributes.delete(:visibility)
+        curation_concern.apply_embargo(attributes[:embargo_release_date], attributes.delete(:visibility_during_embargo),
+                                       attributes.delete(:visibility_after_embargo))
+        @needs_to_copy_visibility = true
+        true
+      end
+    end
+
+    # If user has set visibility to lease, interprets the relevant information and applies it
+    # Returns false if there are any errors and sets an error on the curation_concern
+    def interpret_lease_visibility
+      if attributes[:visibility] != Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_LEASE
+        # clear lease_expiration_date even if it isn't being used. Otherwise it sets the lease_expiration
+        # even though they didn't select lease on the form.
+        attributes.delete(:visibility_during_lease)
+        attributes.delete(:visibility_after_lease)
+        attributes.delete(:lease_expiration_date)
+        true
+      elsif !attributes[:lease_expiration_date]
+        curation_concern.errors.add(:visibility, 'When setting visibility to "lease" you must also specify lease expiration date.')
+        false
+      else
+        curation_concern.apply_lease(attributes[:lease_expiration_date], attributes.delete(:visibility_during_lease),
+                                       attributes.delete(:visibility_after_lease))
+        @needs_to_copy_visibility = true
+        attributes.delete(:visibility)
+        true
+      end
+    end
+
+
+    def copy_visibility
+      Sufia.queue.push(VisibilityCopyWorker.new(curation_concern.id)) if @needs_to_copy_visibility
+      true
+    end
+  end
+end

data/app/actors/curation_concern/base_actor.rb

@@ -0,0 +1,86 @@
+
+module CurationConcern
+  # The CurationConcern base actor should respond to three primary actions:
+  # * #create
+  # * #update
+  # * #delete
+  class BaseActor
+    attr_reader :curation_concern, :user, :attributes, :cloud_resources
+    def initialize(curation_concern, user, input_attributes)
+      @curation_concern = curation_concern
+      @user = user
+      @attributes = input_attributes.dup.with_indifferent_access
+      @visibility = attributes[:visibility]
+      @cloud_resources= attributes.delete(:cloud_resources.to_s)
+    end
+
+    attr_reader :visibility
+    protected :visibility
+
+    delegate :visibility_changed?, to: :curation_concern
+
+    def create
+      apply_creation_data_to_curation_concern
+      apply_save_data_to_curation_concern
+      save
+    end
+
+    def update
+      apply_update_data_to_curation_concern
+      apply_save_data_to_curation_concern
+      save
+    end
+
+    protected
+    def apply_creation_data_to_curation_concern
+      apply_depositor_metadata
+      apply_deposit_date
+    end
+
+    def apply_update_data_to_curation_concern
+      true
+    end
+
+    def apply_depositor_metadata
+      curation_concern.apply_depositor_metadata(user.user_key)
+      curation_concern.edit_users += [user.user_key]
+    end
+
+    def apply_deposit_date
+      curation_concern.date_uploaded = Date.today
+    end
+
+    def save
+      curation_concern.save
+    end
+
+    def apply_save_data_to_curation_concern
+      attributes[:rights] = Array(attributes[:rights]) if attributes.key? :rights
+      remove_blank_attributes!
+      curation_concern.attributes = attributes
+      curation_concern.date_modified = Date.today
+    end
+
+    def attach_file(generic_file, file_to_attach)
+      ActiveSupport::Deprecation.warn("removing #{self.class}#attach_file, use CurationConcern.attach_file instead")
+      CurationConcern.attach_file(generic_file, user, file_to_attach)
+    end
+
+    # If any attributes are blank remove them
+    # e.g.:
+    #   self.attributes = { 'title' => ['first', 'second', ''] }
+    #   remove_blank_attributes!
+    #   self.attributes
+    # => { 'title' => ['first', 'second'] }
+    def remove_blank_attributes!
+      multivalued_form_attributes.each_with_object(attributes) do |(k, v), h|
+        h[k] = v.select(&:present?)
+      end
+    end
+
+    # Return the hash of attributes that are multivalued and not uploaded files
+    def multivalued_form_attributes
+      attributes.select {|_, v| v.respond_to?(:select) && !v.respond_to?(:read) }
+    end
+  end
+end

data/app/actors/curation_concern/generic_file_actor.rb

@@ -0,0 +1,40 @@
+module CurationConcern
+  class GenericFileActor < Sufia::GenericFile::Actor
+    include Worthwhile::ManagesEmbargoesActor
+
+    attr_reader :attributes, :curation_concern
+
+    def initialize(generic_file, user, attributes)
+      super(generic_file, user)
+      # we're setting attributes and curation_concern to bridge the difference
+      # between Sufia::GenericFile::Actor and ManagesEmbargoesActor
+      @curation_concern = generic_file
+      @attributes = attributes
+    end
+
+    # we can trim this down a bit when Sufia 7.1 is released (adds update_visibility)
+    def update_metadata(_, _)
+      interpret_visibility
+      generic_file.visibility = attributes[:visibility] if attributes.key?(:visibility)
+      generic_file.attributes = generic_file.sanitize_attributes(attributes)
+      generic_file.date_modified = DateTime.now
+      remove_from_feature_works if generic_file.visibility_changed? && !generic_file.public?
+      save_and_record_committer do
+        if Sufia.config.respond_to?(:after_update_metadata)
+          Sufia.config.after_update_metadata.call(generic_file, user)
+        end
+      end
+    end
+
+    def create_metadata(batch_id)
+      if batch_id
+        generic_file.visibility = load_parent(batch_id).visibility
+      end
+      super
+    end
+
+    def load_parent(batch_id)
+      @parent ||= GenericWork.find(batch_id)
+    end
+  end
+end

data/app/actors/curation_concern/generic_work_actor.rb

@@ -0,0 +1,92 @@
+
+module CurationConcern
+  class GenericWorkActor < CurationConcern::BaseActor
+    include Worthwhile::ManagesEmbargoesActor
+
+    def create
+      assign_pid && interpret_visibility && super && attach_files && create_linked_resources && assign_representative && copy_visibility
+    end
+
+    def update
+      add_to_collections(attributes.delete(:collection_ids)) && interpret_visibility  &&
+        super && attach_files && create_linked_resources && copy_visibility
+    end
+
+    delegate :visibility_changed?, to: :curation_concern
+
+    protected
+
+    def assign_pid
+      curation_concern.inner_object.pid ||= Worthwhile::CurationConcern.mint_a_pid
+    end
+
+    def files
+      return @files if defined?(@files)
+      @files = [attributes[:files]].flatten.compact
+    end
+
+    def attach_files
+      files.all? do |file|
+        attach_file(file)
+      end
+    end
+
+    # The default behavior of active_fedora's has_and_belongs_to_many association,
+    # when assigning the id accessor (e.g. collection_ids = ['foo:1']) is to add
+    # to new collections, but not remove from old collections.
+    # This method ensures it's removed from the old collections.
+    def add_to_collections(new_collection_ids)
+      return true unless new_collection_ids
+      #remove from old collections
+      (curation_concern.collection_ids - new_collection_ids).each do |old_id|
+        Collection.find(old_id).members.delete(curation_concern)
+      end
+
+      #add to new
+      curation_concern.collection_ids = new_collection_ids
+      true
+    end
+
+    def linked_resource_urls
+      @linked_resource_urls ||= Array(attributes[:linked_resource_urls]).flatten.compact
+    end
+
+    def create_linked_resources
+      linked_resource_urls.all? do |link_resource_url|
+        create_linked_resource(link_resource_url)
+      end
+    end
+
+    def create_linked_resource(link_resource_url)
+      return true unless link_resource_url.present?
+      resource = Worthwhile::LinkedResource.new.tap do |link|
+        link.url = link_resource_url
+        link.batch = curation_concern
+        link.label = curation_concern.human_readable_type
+      end
+      Sufia::GenericFile::Actor.new(resource, user).create_metadata(curation_concern.pid)
+      resource.save
+    end
+
+    def assign_representative
+      curation_concern.representative = curation_concern.generic_file_ids.first
+      curation_concern.save
+    end
+
+    private
+    def attach_file(file)
+      generic_file = Worthwhile::GenericFile.new
+      generic_file.file = file
+      generic_file.batch = curation_concern
+      Sufia::GenericFile::Actor.new(generic_file, user).create_metadata(curation_concern.pid)
+      generic_file.embargo_release_date = curation_concern.embargo_release_date
+      generic_file.visibility = visibility
+      Worthwhile::CurationConcern.attach_file(generic_file, user, file)
+    end
+
+
+    def valid_file?(file_path)
+      return file_path.present? && File.exists?(file_path) && !File.zero?(file_path)
+    end
+  end
+end

data/app/actors/curation_concern/linked_resource_actor.rb

@@ -0,0 +1,4 @@
+module CurationConcern
+  class LinkedResourceActor < CurationConcern::BaseActor
+  end
+end

data/app/models/concerns/curation_concern/versioned_content.rb

@@ -0,0 +1,17 @@
+module CurationConcern
+  module VersionedContent
+    def versions
+      return [] unless persisted?
+      @versions ||= content.versions.collect {|version| Worthwhile::ContentVersion.new(content, version)}
+    end
+
+    def latest_version
+      versions.first || Worthwhile::ContentVersion::Null.new(content)
+    end
+
+    def current_version_id
+      latest_version.version_id
+    end
+  end
+end
+

data/app/models/concerns/worthwhile/generic_file_base.rb

@@ -12,7 +12,7 @@ module Worthwhile
     include Sufia::GenericFile::Metadata
     include Sufia::GenericFile::Versions
     include Sufia::Permissions::Readable
-    include Worthwhile::GenericFile::VersionedContent
+    include CurationConcern::VersionedContent
 
     included do
       belongs_to :batch, property: :is_part_of, class_name: 'ActiveFedora::Base'

data/lib/worthwhile/models/engine.rb

@@ -2,9 +2,9 @@ require 'sufia/models'
 module Worthwhile
   module Models
     class Engine < ::Rails::Engine
-      # config.autoload_paths += %W(
-      #   #{config.root}/app/models/datastreams
-      # )
+      config.autoload_paths += %W(
+       #{config.root}/app/actors/concerns
+      )
     end
   end
 end

data/lib/worthwhile/models/version.rb

@@ -1,5 +1,5 @@
 module Worthwhile
   module Models
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worthwhile-models
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-08 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hydra-head
@@ -102,17 +102,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/actors/concerns/worthwhile/manages_embargoes_actor.rb
+- app/actors/curation_concern/base_actor.rb
+- app/actors/curation_concern/generic_file_actor.rb
+- app/actors/curation_concern/generic_work_actor.rb
+- app/actors/curation_concern/linked_resource_actor.rb
 - app/models/concerns/curation_concern/collection_model.rb
 - app/models/concerns/curation_concern/curatable.rb
 - app/models/concerns/curation_concern/has_representative.rb
 - app/models/concerns/curation_concern/human_readable_type.rb
+- app/models/concerns/curation_concern/versioned_content.rb
 - app/models/concerns/curation_concern/with_basic_metadata.rb
 - app/models/concerns/curation_concern/with_editors.rb
 - app/models/concerns/curation_concern/with_generic_files.rb
 - app/models/concerns/curation_concern/with_linked_resources.rb
 - app/models/concerns/curation_concern/work.rb
 - app/models/concerns/worthwhile/ability.rb
-- app/models/concerns/worthwhile/generic_file/versioned_content.rb
 - app/models/concerns/worthwhile/generic_file_base.rb
 - app/models/concerns/worthwhile/solr_document_behavior.rb
 - app/models/generic_work.rb

data/app/models/concerns/worthwhile/generic_file/versioned_content.rb

@@ -1,18 +0,0 @@
-module Worthwhile
-  class GenericFile
-    module VersionedContent
-      def versions
-        return [] unless persisted?
-        @versions ||= content.versions.collect {|version| Worthwhile::ContentVersion.new(content, version)}
-      end
-
-      def latest_version
-        versions.first || Worthwhile::ContentVersion::Null.new(content)
-      end
-
-      def current_version_id
-        latest_version.version_id
-      end
-    end
-  end
-end