curation_concerns 0.12.0.pre1 → 0.12.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e539e04a127fef5b331cbc4b51495b386f473ab8
-  data.tar.gz: 2706ea39d092ae8ae4e7a969ec5f0d6ac40e8f75
+  metadata.gz: 127203132df29eed98a348c7ca741685e62793e0
+  data.tar.gz: 0e4704e41785f9eaf7a062f2ff5d7c8c34c9326b
 SHA512:
-  metadata.gz: 4cb327b7af8c5e54d1b42ce2fc0784541e8f1aaaea7b19b172cc77615bec6ea8f7ffd49fa059e38a8132d6f759dcac3aca1c220d72b2ae5aedb65abc55e78f47
-  data.tar.gz: 806dad8e1e5ed014956c1c9df81eaf3c7f43117081b9877a017e08509988ae5c2eeaf038dd5220fabc14c8e8a6e27ef8dd113a3025ab2c7f02791dbe19fd32b1
+  metadata.gz: abe17e8e0e63eb6b67adfd7606cef6e199d5b981d384a10615e59183764373dfd29f2b4655e6202e4d4bdcfca8db3e2dfa327a32213ee85e40c2f78955617bd1
+  data.tar.gz: 77bebf157e28c363c6025e2d35046a0e825de606e963dc7c22029f157c2a9c3703f1c09b9ebe413dff320c7dd072a678126db11748588cadaefa3bf409bfb0d5

data/.rubocop.yml

@@ -9,7 +9,7 @@ AllCops:
     - 'script/**/*'
     - 'vendor/**/*'
     - '.internal_test_app/**/*'
-    - 'curation_concerns-models/app/models/concerns/curation_concerns/file_set/export.rb'
+    - 'app/models/concerns/curation_concerns/file_set/export.rb'
 
 Rails:
   Enabled: true
@@ -18,15 +18,15 @@ Performance/RedundantBlockCall:
   # We can remove this exclusion when this commit is released:
   # https://github.com/bbatsov/rubocop/commit/7df382531db4f66cd9872a4f478bd486d6ce6712
   Exclude:
-    - 'curation_concerns-models/lib/curation_concerns/null_logger.rb'
+    - 'lib/curation_concerns/null_logger.rb'
 
 Performance/RedundantMerge:
   Enabled: false
 
 Lint/AssignmentInCondition:
   Exclude:
-    - 'curation_concerns-models/app/services/curation_concerns/persist_derivatives.rb'
-    - 'curation_concerns-models/app/actors/curation_concerns/file_set_actor.rb'
+    - 'app/services/curation_concerns/persist_derivatives.rb'
+    - 'app/actors/curation_concerns/file_set_actor.rb'
 
 Metrics/LineLength:
   Enabled: false
@@ -36,29 +36,29 @@ Metrics/AbcSize:
 
 Metrics/CyclomaticComplexity:
   Exclude:
-    - 'curation_concerns-models/app/services/curation_concerns/file_set_audit_service.rb'
+    - 'app/services/curation_concerns/file_set_audit_service.rb'
     - 'app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb'
     - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
     - 'app/helpers/curation_concerns/attribute_helper.rb'
-    - 'curation_concerns-models/app/actors/curation_concerns/file_set_actor.rb'
-    - 'curation_concerns-models/app/actors/curation_concerns/work_actor_behavior.rb'
+    - 'app/actors/curation_concerns/file_set_actor.rb'
+    - 'app/actors/curation_concerns/work_actor_behavior.rb'
 
 Metrics/PerceivedComplexity:
   Exclude:
-    - 'curation_concerns-models/app/services/curation_concerns/file_set_audit_service.rb'
+    - 'app/services/curation_concerns/file_set_audit_service.rb'
     - 'app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb'
     - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
     - 'app/helpers/curation_concerns/attribute_helper.rb'
-    - 'curation_concerns-models/app/actors/curation_concerns/file_set_actor.rb'
+    - 'app/actors/curation_concerns/file_set_actor.rb'
 
 Metrics/MethodLength:
   Enabled: false
 
 Metrics/ClassLength:
   Exclude:
-    - curation_concerns-models/lib/curation_concerns/configuration.rb
+    - lib/curation_concerns/configuration.rb
     - 'lib/generators/curation_concerns/templates/catalog_controller.rb'
-    - 'curation_concerns-models/app/actors/curation_concerns/file_set_actor.rb'
+    - 'app/actors/curation_concerns/file_set_actor.rb'
 
 Metrics/ModuleLength:
   Exclude:
@@ -67,7 +67,8 @@ Metrics/ModuleLength:
     - 'app/controllers/concerns/curation_concerns/catalog_controller.rb'
     - 'app/controllers/concerns/curation_concerns/file_sets_controller_behavior.rb'
     - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
-    - 'curation_concerns-models/app/models/concerns/curation_concerns/solr_document_behavior.rb'
+    - 'app/models/concerns/curation_concerns/solr_document_behavior.rb'
+    - 'app/controllers/concerns/curation_concerns/collections_controller_behavior.rb'
 
 Style/ZeroLengthPredicate:
   Enabled: false
@@ -131,6 +132,7 @@ Style/PredicateName:
     - 'app/helpers/curation_concerns/curation_concerns_helper_behavior.rb'
     - 'app/controllers/concerns/curation_concerns/controller.rb'
     - 'app/helpers/curation_concerns/collections_helper.rb'
+    - 'app/helpers/curation_concerns/collections_helper_behavior.rb'
 
 Style/GlobalVars:
   Exclude:
@@ -141,9 +143,9 @@ Style/SingleLineBlockParams:
 
 Style/ClassVars:
   Exclude:
-    - 'curation_concerns-models/lib/curation_concerns/models.rb'
-    - 'curation_concerns-models/lib/curation_concerns/models/engine.rb'
-    - 'curation_concerns-models/app/models/concerns/curation_concerns/file_set/versions.rb'
+    - 'lib/curation_concerns/models.rb'
+    - 'lib/curation_concerns/models/engine.rb'
+    - 'app/models/concerns/curation_concerns/file_set/versions.rb'
 
 Style/SignalException:
   Enabled: false
@@ -151,7 +153,7 @@ Style/SignalException:
 Rails/Output:
   Exclude:
     - 'lib/generators/**/*'
-    - 'curation_concerns-models/lib/generators/**/*'
+    - 'lib/generators/**/*'
 
 Rails/Date:
   Enabled: false
@@ -174,6 +176,12 @@ RSpec/FilePath:
 RSpec/InstanceVariable:
   Enabled: false
 
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/NotToNot:
+  Enabled: false
+
 RSpec/DescribeClass:
   Exclude:
     - 'spec/javascripts/jasmine_spec.rb'

data/Gemfile

@@ -3,11 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in curation_concerns.gemspec
 gemspec
 
-gem 'curation_concerns-models', path: './curation_concerns-models'
-
 group :development, :test do
-  gem 'rubocop', '~> 0.37.0', require: false
-  gem 'rubocop-rspec', '~> 1.3.1', require: false
   gem 'simplecov', '~> 0.9', require: false
   gem 'coveralls', require: false
   gem 'poltergeist'

data/README.md

@@ -40,6 +40,20 @@ Then run the install generator.  You will be prompted if you want to overwrite t
     $ rails generate curation_concerns:install
     $ rake db:migrate
 
+### FITS 0.6.2
+
+To install FITS:
+ * Go to http://projects.iq.harvard.edu/fits/downloads, download __fits-0.6.2.zip__, and unpack it somewhere on your machine. You can also install FITS on OSX with homebrew: `brew install fits` (you may also have to create a symlink from fits.sh -> fits in the next step).
+ * Mark fits.sh as executable (chmod a+x fits.sh)
+ * Run "fits.sh -h" from the command line and see a help message to ensure FITS is properly installed
+ * Give your app access to FITS by:
+     * Adding the full fits.sh path to your PATH (e.g., in your .bash_profile), OR
+     * Changing config/initializers/sufia.rb to point to your FITS location: config.fits_path = "/<your full path>/fits.sh"
+
+### Redis 2.6
+
+The redlock gem requires Redis >= 2.6.
+
 ## Usage
 
 ### Generator

data/RELEASING.md

@@ -1,3 +1,3 @@
-* Bump version number in `VERSION`
-* Release the gem to rubygems.org: `rake all:release`
+* Bump version number in `lib/curation_concerns/version.rb`
+* Release the gem to rubygems.org: `rake build` then `rake release`
 * `git push`

data/Rakefile

@@ -9,6 +9,8 @@ require 'active_fedora/rake_support'
 
 Dir.glob('tasks/*.rake').each { |r| import r }
 
+Bundler::GemHelper.install_tasks
+
 namespace :curation_concerns do
   desc 'Run style checker'
   RuboCop::RakeTask.new(:rubocop) do |task|

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

@@ -0,0 +1,28 @@
+module CurationConcerns
+  #  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
+  #     end
+  #
+  #     def update
+  #       interpret_visibility && super
+  #     end
+  #  end
+  #
+  module ManagesEmbargoesActor
+    extend ActiveSupport::Concern
+    extend Deprecation
+
+    included do
+      Deprecation.warn(ManagesEmbargoesActor, "ManagesEmbargoesActor is deprecated and will be removed in CurationConcerns 1.0")
+    end
+  end
+end

data/app/actors/curation_concerns/abstract_actor.rb

@@ -0,0 +1,28 @@
+module CurationConcerns
+  # The CurationConcern Abstract actor responds to two primary actions:
+  # * #create
+  # * #update
+  #
+  # and the following attributes
+  #
+  # * next_actor
+  # * curation_concern
+  # * user
+  #
+  # it must instantiate the next actor in the chain and instantiate it.
+  # it should respond to curation_concern, user and attributes.
+  # it ha to next_actor
+  class AbstractActor
+    attr_reader :next_actor
+
+    def initialize(_curation_concern, _user, next_actor)
+      @next_actor = next_actor
+    end
+
+    delegate :curation_concern, :user, to: :next_actor
+
+    delegate :create, to: :next_actor
+
+    delegate :update, to: :next_actor
+  end
+end

data/app/actors/curation_concerns/add_to_collection_actor.rb

@@ -0,0 +1,38 @@
+module CurationConcerns
+  class AddToCollectionActor < AbstractActor
+    def create(attributes)
+      collection_ids = attributes.delete(:collection_ids)
+      next_actor.create(attributes) && add_to_collections(collection_ids)
+    end
+
+    def update(attributes)
+      collection_ids = attributes.delete(:collection_ids)
+      add_to_collections(collection_ids) && next_actor.update(attributes)
+    end
+
+    private
+
+      # The default behavior of active_fedora's aggregates 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
+        # TODO: Implement in_collection_ids https://github.com/projecthydra-labs/hydra-pcdm/issues/157
+        (curation_concern.in_collections.map(&:id) - new_collection_ids).each do |old_id|
+          collection = ::Collection.find(old_id)
+          collection.members.delete(curation_concern)
+          collection.save
+        end
+
+        # add to new
+        new_collection_ids.each do |coll_id|
+          collection = ::Collection.find(coll_id)
+          collection.members << curation_concern
+          collection.save
+        end
+        true
+      end
+  end
+end

data/app/actors/curation_concerns/apply_order_actor.rb

@@ -0,0 +1,24 @@
+module CurationConcerns
+  class ApplyOrderActor < AbstractActor
+    def update(attributes)
+      ordered_member_ids = attributes.delete(:ordered_member_ids)
+      apply_order(ordered_member_ids) && next_actor.update(attributes)
+    end
+
+    private
+
+      def apply_order(new_order)
+        return true unless new_order
+        curation_concern.ordered_member_proxies.each_with_index do |proxy, index|
+          unless new_order[index]
+            proxy.prev.next = curation_concern.ordered_member_proxies.last.next
+            break
+          end
+          proxy.proxy_for = ActiveFedora::Base.id_to_uri(new_order[index])
+          proxy.target = nil
+        end
+        curation_concern.list_source.order_will_change!
+        true
+      end
+  end
+end

data/app/actors/curation_concerns/assign_identifier_actor.rb

@@ -0,0 +1,7 @@
+module CurationConcerns
+  class AssignIdentifierActor < AbstractActor
+    def create(attributes)
+      curation_concern.assign_id && next_actor.create(attributes)
+    end
+  end
+end

data/app/actors/curation_concerns/assign_representative_actor.rb

@@ -0,0 +1,18 @@
+module CurationConcerns
+  class AssignRepresentativeActor < AbstractActor
+    def create(attributes)
+      next_actor.create(attributes) && assign_representative
+    end
+
+    private
+
+      def assign_representative
+        unless curation_concern.representative_id
+          # TODO: Possible optimization here. Does this cause a fetch of ordered_members if they're already loaded?
+          representative = nil # curation_concern.ordered_members.association.reader.first.target
+          curation_concern.representative = representative if representative
+        end
+        curation_concern.save
+      end
+  end
+end

data/app/actors/curation_concerns/attach_files_actor.rb

@@ -0,0 +1,39 @@
+module CurationConcerns
+  class AttachFilesActor < AbstractActor
+    def create(attributes)
+      files = [attributes.delete(:files)].flatten.compact
+      attach_files(files, visibility_attributes(attributes)) &&
+        next_actor.create(attributes)
+    end
+
+    def update(attributes)
+      files = [attributes.delete(:files)].flatten.compact
+      next_actor.update(attributes) &&
+        attach_files(files, visibility_attributes(attributes))
+    end
+
+    private
+
+      def attach_files(files, visibility_attr)
+        files.all? do |file|
+          attach_file(file, visibility_attr)
+        end
+      end
+
+      def attach_file(file, visibility_attr)
+        file_set = ::FileSet.new
+        file_set_actor = CurationConcerns::FileSetActor.new(file_set, user)
+        file_set_actor.create_metadata(curation_concern, visibility_attr)
+        file_set_actor.create_content(file)
+      end
+
+      # The attributes used for visibility - used to send as initial params to
+      # created FileSets.
+      def visibility_attributes(attributes)
+        attributes.slice(:visibility, :visibility_during_lease,
+                         :visibility_after_lease, :lease_expiration_date,
+                         :embargo_release_date, :visibility_during_embargo,
+                         :visibility_after_embargo)
+      end
+  end
+end

data/app/actors/curation_concerns/base_actor.rb

@@ -0,0 +1,71 @@
+module CurationConcerns
+  # The CurationConcern base actor responds to two primary actions:
+  # * #create
+  # * #update
+  # it must instantiate the next actor in the chain and instantiate it.
+  # it should respond to curation_concern, user and attributes.
+  class BaseActor < AbstractActor
+    attr_reader :cloud_resources
+
+    def create(attributes)
+      @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
+    end
+
+    def update(attributes)
+      apply_update_data_to_curation_concern
+      apply_save_data_to_curation_concern(attributes)
+      next_actor.update(attributes) && 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 = CurationConcerns::TimeService.time_in_utc
+      end
+
+      def save
+        curation_concern.save
+      end
+
+      def apply_save_data_to_curation_concern(attributes)
+        attributes[:rights] = Array(attributes[:rights]) if attributes.key? :rights
+        remove_blank_attributes!(attributes)
+        curation_concern.attributes = attributes.symbolize_keys
+        curation_concern.date_modified = CurationConcerns::TimeService.time_in_utc
+      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!(attributes)
+        multivalued_form_attributes(attributes).each_with_object(attributes) do |(k, v), h|
+          h[k] = v.instance_of?(Array) ? v.select(&:present?) : v
+        end
+      end
+
+      # Return the hash of attributes that are multivalued and not uploaded files
+      def multivalued_form_attributes(attributes)
+        attributes.select { |_, v| v.respond_to?(:select) && !v.respond_to?(:read) }
+      end
+  end
+end

data/app/actors/curation_concerns/embargo_actor.rb

@@ -0,0 +1,19 @@
+module CurationConcerns
+  class EmbargoActor
+    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 embargo, then clear the embargo date, etc.
+    # Saves the embargo and the work
+    def destroy
+      work.embargo_visibility! # If the embargo has lapsed, update the current visibility.
+      work.deactivate_embargo!
+      work.embargo.save!
+      work.save!
+    end
+  end
+end

data/app/actors/curation_concerns/file_actor.rb

@@ -0,0 +1,79 @@
+module CurationConcerns
+  # actions for a file identified by file_set and relation (maps to use predicate)
+  class FileActor
+    attr_reader :file_set, :relation, :user
+
+    # @param [FileSet] file_set the parent FileSet
+    # @param [String] relation the type/use for the file.
+    # @param [User] user the user to record as the Agent acting upon the file
+    def initialize(file_set, relation, user)
+      @file_set = file_set
+      @relation = relation
+      @user = user
+    end
+
+    # Puts the uploaded content into a staging directory. Then kicks off a
+    # job to characterize and create derivatives with this on disk variant.
+    # Simultaneously moving a preservation copy to the repostiory.
+    # TODO: create a job to monitor this directory and prune old files that
+    # have made it to the repo
+    # @param [File, ActionDigest::HTTP::UploadedFile, Tempfile] file the file to save in the repository
+    def ingest_file(file)
+      working_file = copy_file_to_working_directory(file, file_set.id)
+      mime_type = file.respond_to?(:content_type) ? file.content_type : nil
+      IngestFileJob.perform_later(file_set, working_file, mime_type, user.user_key, relation)
+      make_derivative(file_set, working_file)
+      true
+    end
+
+    def revert_to(revision_id)
+      repository_file = file_set.send(relation.to_sym)
+      repository_file.restore_version(revision_id)
+
+      return false unless file_set.save
+
+      CurationConcerns::VersioningService.create(repository_file, user)
+
+      # Retrieve a copy of the orginal file from the repository
+      working_file = copy_repository_resource_to_working_directory(repository_file)
+      make_derivative(file_set, working_file)
+      true
+    end
+
+    private
+
+      def make_derivative(file_set, working_file)
+        CharacterizeJob.perform_later(file_set, working_file)
+      end
+
+      # @param [File, ActionDispatch::Http::UploadedFile] file
+      # @param [String] id the identifer of the FileSet
+      # @return [String] path of the working file
+      def copy_file_to_working_directory(file, id)
+        file_name = file.respond_to?(:original_filename) ? file.original_filename : ::File.basename(file)
+        copy_stream_to_working_directory(id, file_name, file)
+      end
+
+      # @param [ActiveFedora::File] file the resource in the repo
+      # @return [String] path of the working file
+      def copy_repository_resource_to_working_directory(file)
+        copy_stream_to_working_directory(file_set.id, file.original_name, StringIO.new(file.content))
+      end
+
+      # @param [String] id the identifer
+      # @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)
+        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)
+        File.join(CurationConcerns.config.working_path, *pair, original_name)
+      end
+  end
+end