curation_concerns-models 0.1.0 → 0.2.0

data/app/actors/curation_concerns/generic_file_actor.rb

@@ -1,150 +0,0 @@
-module CurationConcerns
-  # Actions are decoupled from controller logic so that they may be called from a controller or a background job.
-  class GenericFileActor
-    include CurationConcerns::ManagesEmbargoesActor
-
-    attr_reader :generic_file, :user, :attributes, :curation_concern
-
-    def initialize(generic_file, user)
-      # we're setting attributes and curation_concern to bridge the difference
-      # between CurationConcerns::GenericFileActor and ManagesEmbargoesActor
-      @curation_concern = generic_file
-      @generic_file = generic_file
-      @user = user
-    end
-
-    # Adds the appropriate metadata, visibility and relationships to generic_file
-    #
-    # *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 generic_file in order to record the "metadata" relationship
-    # between them.
-    # @param [String] batch_id id of the batch that the file was uploaded within
-    # @param [String] work_id id of the parent work that will contain the generic_file.
-    # @param [Hash] generic_file_params specifying the visibility, lease and/or embargo of the generic file.  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(batch_id, work_id, generic_file_params={})
-      generic_file.apply_depositor_metadata(user)
-      time_in_utc = DateTime.now.new_offset(0)
-      generic_file.date_uploaded = time_in_utc
-      generic_file.date_modified = time_in_utc
-      generic_file.creator = [user.name]
-      # TODO: Remove this? see https://github.com/projecthydra-labs/curation_concerns/issues/27
-      if batch_id && generic_file.respond_to?(:batch_id=)
-        generic_file.batch_id = batch_id
-      else
-        ActiveFedora::Base.logger.warn "unable to find batch to attach to"
-      end
-
-      unless work_id.blank?
-        work = ActiveFedora::Base.find(work_id)
-
-        if !((generic_file_params || {}).keys  & ["visibility", "embargo_release_date", "lease_expiration_date"]).empty?
-          interpret_visibility generic_file_params
-        else
-          copy_visibility(work, generic_file)
-        end
-        work.generic_files << generic_file
-        # Save the work so the association between the work and the generic_file is persisted (head_id)
-        work.save
-      end
-      yield(generic_file) if block_given?
-    end
-
-    def create_content(file)
-      # Tell UploadFileToGenericFile service to skip versioning because versions will be minted by VersionCommitter (called by save_characterize_and_record_committer) when necessary
-      Hydra::Works::UploadFileToGenericFile.call(generic_file, file, versioning: false)
-      generic_file.label ||= file.original_filename
-      generic_file.title = [generic_file.label] if generic_file.title.blank?
-      save_characterize_and_record_committer do
-        if CurationConcerns.config.respond_to?(:after_create_content)
-          CurationConcerns.config.after_create_content.call(generic_file, user)
-        end
-      end
-    end
-
-    def revert_content(revision_id)
-      generic_file.original_file.restore_version(revision_id)
-      save_characterize_and_record_committer do
-        if CurationConcerns.config.respond_to?(:after_revert_content)
-          CurationConcerns.config.after_revert_content.call(generic_file, user, revision_id)
-        end
-      end
-    end
-
-    def update_content(file)
-      # Tell UploadFileToGenericFile service to skip versioning because versions will be minted by VersionCommitter (called by save_characterize_and_record_committer) when necessary
-      Hydra::Works::UploadFileToGenericFile.call(generic_file, file, versioning: false)
-      save_characterize_and_record_committer do
-        if CurationConcerns.config.respond_to?(:after_update_content)
-          CurationConcerns.config.after_update_content.call(generic_file, user)
-        end
-      end
-    end
-
-    def update_metadata(model_attributes, all_attributes)
-      update_visibility(all_attributes)
-      model_attributes.delete(:visibility)  # Applying this attribute is handled by update_visibility
-      generic_file.attributes = model_attributes
-      generic_file.date_modified = DateTime.now
-      save do
-        if CurationConcerns.config.respond_to?(:after_update_metadata)
-          CurationConcerns.config.after_update_metadata.call(generic_file, user)
-        end
-      end
-    end
-
-    def destroy
-      generic_file.destroy
-      if CurationConcerns.config.respond_to?(:after_destroy)
-        CurationConcerns.config.after_destroy.call(generic_file.id, user)
-      end
-    end
-
-    # Saves the generic file, queues a job to characterize it, and records the committer.
-    # Takes a block which is run if the save was successful.
-    def save_characterize_and_record_committer
-      save do
-        push_characterize_job
-        CurationConcerns::VersioningService.create(generic_file.original_file, user)
-        yield if block_given?
-      end
-    end
-
-    # 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 generic_file.save
-      rescue RSolr::Error::Http => error
-        ActiveFedora::Base.logger.warn "CurationConcerns::GenericFileActor#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
-
-    def push_characterize_job
-      CurationConcerns.queue.push(CharacterizeJob.new(@generic_file.id))
-    end
-
-    protected
-
-    # This method can be overridden in case there is a custom approach for visibility (e.g. embargo)
-    def update_visibility(attributes)
-      interpret_visibility(attributes)  # relies on CurationConcerns::ManagesEmbargoesActor to interpret and apply visibility
-    end
-
-    private
-
-    # copy visibility from source_concern to destination_concern
-    def copy_visibility(source_concern, destination_concern)
-      destination_concern.visibility =  source_concern.visibility
-    end
-  end
-end

data/app/jobs/active_fedora_pid_based_job.rb

@@ -1,6 +0,0 @@
-class ActiveFedoraPidBasedJob < ActiveFedoraIdBasedJob
-  extend Deprecation
-  def self.extended(document)
-    Deprecation.warn ActiveFedoraPidBasedJob, "ActiveFedoraPidBasedJob is deprecated; use ActiveFedoraIdBasedJob instead."
-  end
-end

data/app/jobs/copy_permissions_job.rb

@@ -1,24 +0,0 @@
-class CopyPermissionsJob
-  def queue_name
-    :permissions
-  end
-
-  attr_accessor :id
-
-  def initialize(id)
-    self.id = id
-  end
-
-  def run
-    # work = ActiveFedora::Base.load_instance_from_solr(id)
-    work = ActiveFedora::Base.find(id)  # Hydra::Works::GenericWork is not compatible with load_instance_from_solr.  Using (slower) ActiveFedora::Base.find instead.
-    if work.respond_to?(:generic_files)
-      work.generic_files.each do |file|
-
-        work.permissions.each {|perm| file.permissions << Hydra::AccessControls::Permission.new(perm.to_hash)}
-        new_permissions = file.permissions.uniq! { |item| item.to_hash}
-        file.permissions = new_permissions unless new_permissions.blank?
-      end
-    end
-  end
-end

data/app/models/concerns/curation_concerns/generic_file/characterization.rb

@@ -1,89 +0,0 @@
-module CurationConcerns
-  module GenericFile
-    module Characterization
-      extend ActiveSupport::Concern
-      included do
-        contains "characterization", class_name: 'FitsDatastream'
-        property :mime_type,         delegate_to: 'characterization', multiple: false do |index|
-          index.as :stored_searchable
-        end
-        property :format_label,      delegate_to: 'characterization'
-        property :file_size,         delegate_to: 'characterization'
-        property :last_modified,     delegate_to: 'characterization'
-        property :filename,          delegate_to: 'characterization'
-        property :original_checksum, delegate_to: 'characterization'
-        property :rights_basis,      delegate_to: 'characterization'
-        property :copyright_basis,   delegate_to: 'characterization'
-        property :copyright_note,    delegate_to: 'characterization'
-        property :well_formed,       delegate_to: 'characterization'
-        property :valid,             delegate_to: 'characterization'
-        property :status_message,    delegate_to: 'characterization'
-        property :file_title,        delegate_to: 'characterization'
-        property :file_author,       delegate_to: 'characterization'
-        property :page_count,        delegate_to: 'characterization'
-        property :file_language,     delegate_to: 'characterization'
-        property :word_count,        delegate_to: 'characterization'
-        property :character_count,   delegate_to: 'characterization'
-        property :paragraph_count,   delegate_to: 'characterization'
-        property :line_count,        delegate_to: 'characterization'
-        property :table_count,       delegate_to: 'characterization'
-        property :graphics_count,    delegate_to: 'characterization'
-        property :byte_order,        delegate_to: 'characterization'
-        property :compression,       delegate_to: 'characterization'
-        property :color_space,       delegate_to: 'characterization'
-        property :profile_name,      delegate_to: 'characterization'
-        property :profile_version,   delegate_to: 'characterization'
-        property :orientation,       delegate_to: 'characterization'
-        property :color_map,         delegate_to: 'characterization'
-        property :image_producer,    delegate_to: 'characterization'
-        property :capture_device,    delegate_to: 'characterization'
-        property :scanning_software, delegate_to: 'characterization'
-        property :exif_version,      delegate_to: 'characterization'
-        property :gps_timestamp,     delegate_to: 'characterization'
-        property :latitude,          delegate_to: 'characterization'
-        property :longitude,         delegate_to: 'characterization'
-        property :character_set,     delegate_to: 'characterization'
-        property :markup_basis,      delegate_to: 'characterization'
-        property :markup_language,   delegate_to: 'characterization'
-        property :bit_depth,         delegate_to: 'characterization'
-        property :channels,          delegate_to: 'characterization'
-        property :data_format,       delegate_to: 'characterization'
-        property :offset,            delegate_to: 'characterization'
-        property :frame_rate,        delegate_to: 'characterization'
-
-      end
-
-      def width
-        characterization.width.blank? ? characterization.video_width : characterization.width
-      end
-
-      def height
-        characterization.height.blank? ? characterization.video_height : characterization.height
-      end
-
-      def duration
-        characterization.duration.blank? ? characterization.video_duration : characterization.duration
-      end
-
-      def sample_rate
-        characterization.sample_rate.blank? ? characterization.video_sample_rate : characterization.sample_rate
-      end
-
-      def characterization_terms
-        h = {}
-        self.characterization.class.terminology.terms.each_pair do |k, v|
-          next unless v.respond_to? :proxied_term
-          term = v.proxied_term
-          begin
-            value = self.send(term.name)
-            h[term.name] = value unless value.empty?
-          rescue NoMethodError
-            next
-          end
-        end
-        h
-      end
-
-    end
-  end
-end

data/app/models/concerns/curation_concerns/generic_file/content.rb

@@ -1,8 +0,0 @@
-module CurationConcerns
-  module GenericFile
-    module Content
-      extend ActiveSupport::Concern
-
-    end
-  end
-end

data/app/models/concerns/curation_concerns/generic_file/export.rb

@@ -1,343 +0,0 @@
-module CurationConcerns
-  module GenericFile
-    module Export
-      # MIME: 'application/x-endnote-refer'
-      def export_as_endnote
-        end_note_format = {
-          '%T' => [:title, lambda { |x| x.first }],
-          '%Q' => [:title, lambda { |x| x.drop(1) }],
-          '%A' => [:creator],
-          '%C' => [:publication_place],
-          '%D' => [:date_created],
-          '%8' => [:date_uploaded],
-          '%E' => [:contributor],
-          '%I' => [:publisher],
-          '%J' => [:series_title],
-          '%@' => [:isbn],
-          '%U' => [:related_url],
-          '%7' => [:edition_statement],
-          '%R' => [:persistent_url],
-          '%X' => [:description],
-          '%G' => [:language],
-          '%[' => [:date_modified],
-          '%9' => [:resource_type],
-          '%~' => I18n.t('curation_concerns.product_name'),
-          '%W' => I18n.t('curation_concerns.institution_name')
-        }
-        text = []
-        text << "%0 GenericFile"
-        end_note_format.each do |endnote_key, mapping|
-          if mapping.is_a? String
-            values = [mapping]
-          else
-            values = self.send(mapping[0]) if self.respond_to? mapping[0]
-            values = mapping[1].call(values) if mapping.length == 2
-            values = Array(values)
-          end
-          next if values.empty? or values.first.nil?
-          spaced_values = values.join("; ")
-          text << "#{endnote_key} #{spaced_values}"
-        end
-        return text.join("\n")
-      end
-
-      def persistent_url
-        "#{CurationConcerns.config.persistent_hostpath}#{id}"
-      end
-
-      # MIME type: 'application/x-openurl-ctx-kev'
-      def export_as_openurl_ctx_kev
-        export_text = []
-        export_text << "url_ver=Z39.88-2004&ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fblacklight.rubyforge.org%3Agenerator"
-        field_map = {
-          title: 'title',
-          creator: 'creator',
-          subject: 'subject',
-          description: 'description',
-          publisher: 'publisher',
-          contributor: 'contributor',
-          date_created: 'date',
-          resource_type: 'format',
-          identifier: 'identifier',
-          language: 'language',
-          tag: 'relation',
-          based_near: 'coverage',
-          rights: 'rights'
-        }
-        field_map.each do |element, kev|
-          values = self.send(element)
-          next if values.empty? or values.first.nil?
-          values.each do |value|
-            export_text << "rft.#{kev}=#{CGI::escape(value.to_s)}"
-          end
-        end
-        export_text.join('&') unless export_text.blank?
-      end
-
-      def export_as_apa_citation
-        text = ''
-        authors_list = []
-        authors_list_final = []
-
-        #setup formatted author list
-        authors = get_author_list
-        authors.each do |author|
-          next if author.blank?
-          authors_list.push(abbreviate_name(author))
-        end
-        authors_list.each do |author|
-          if author == authors_list.first #first
-            authors_list_final.push(author.strip)
-          elsif author == authors_list.last #last
-            authors_list_final.push(", &amp; " + author.strip)
-          else #all others
-            authors_list_final.push(", " + author.strip)
-          end
-        end
-        text << authors_list_final.join
-        unless text.blank?
-          if text[-1,1] != "."
-            text << ". "
-          else
-            text << " "
-          end
-        end
-        # Get Pub Date
-        text << "(" + setup_pub_date + "). " unless setup_pub_date.nil?
-
-        # setup title info
-        title_info = setup_title_info
-        text << "<i>" + title_info + "</i> " unless title_info.nil?
-
-        # Publisher info
-        text << setup_pub_info unless setup_pub_info.nil?
-        unless text.blank?
-          if text[-1,1] != "."
-            text += "."
-          end
-        end
-        text.html_safe
-      end
-
-      def export_as_mla_citation
-        text = ''
-        authors_final = []
-
-        #setup formatted author list
-        authors = get_author_list
-
-        if authors.length < 4
-          authors.each do |author|
-            if author == authors.first #first
-              authors_final.push(author)
-            elsif author == authors.last #last
-              authors_final.push(", and " + name_reverse(author) + ".")
-            else #all others
-              authors_final.push(", " + name_reverse(author))
-            end
-          end
-          text << authors_final.join
-          unless text.blank?
-            if text[-1,1] != "."
-              text << ". "
-            else
-              text << " "
-            end
-          end
-        else
-          text << authors.first + ", et al. "
-        end
-        # setup title
-        title_info = setup_title_info
-        text << "<i>" + mla_citation_title(title_info) + "</i> " unless title.blank?
-
-        # Publication
-        text << setup_pub_info + ", " unless setup_pub_info.nil?
-
-        # Get Pub Date
-        text << setup_pub_date unless setup_pub_date.nil?
-        if text[-1,1] != "."
-          text << "." unless text.blank?
-        end
-        text.html_safe
-      end
-
-      def export_as_chicago_citation
-        author_text = ""
-        authors = get_all_authors
-        unless authors.blank?
-          if authors.length > 10
-            authors.each_with_index do |author, index|
-              if index < 7
-                if index == 0
-                  author_text << "#{author}"
-                  if author.ends_with?(",")
-                    author_text << " "
-                  else
-                    author_text << ", "
-                  end
-                else
-                  author_text << "#{name_reverse(author)}, "
-                end
-              end
-            end
-            author_text << " et al."
-          elsif authors.length > 1
-            authors.each_with_index do |author,index|
-              if index == 0
-                author_text << "#{author}"
-                if author.ends_with?(",")
-                  author_text << " "
-                else
-                  author_text << ", "
-                end
-              elsif index + 1 == authors.length
-                author_text << "and #{name_reverse(author)}."
-              else
-                author_text << "#{name_reverse(author)}, "
-              end
-            end
-          else
-            author_text << authors.first
-          end
-        end
-        title_info = ""
-        title_info << citation_title(clean_end_punctuation(CGI::escapeHTML(title.first)).strip) unless title.blank?
-
-        pub_info = ""
-        place = self.based_near.first
-        publisher = self.publisher.first
-        unless place.blank?
-          place = CGI::escapeHTML(place)
-          pub_info << place
-          pub_info << ": " unless publisher.blank?
-        end
-        unless publisher.blank?
-          publisher = CGI::escapeHTML(publisher)
-          pub_info << publisher
-          pub_info << ", " unless setup_pub_date.nil?
-        end
-        unless setup_pub_date.nil?
-          pub_info << setup_pub_date
-        end
-
-        citation = ""
-        citation << "#{author_text} " unless author_text.blank?
-        citation << "<i>#{title_info}.</i> " unless title_info.blank?
-        citation << "#{pub_info}." unless pub_info.blank?
-        citation.html_safe
-      end
-
-      private
-
-      def setup_pub_date
-        first_date = self.date_created.first
-        unless first_date.blank?
-          first_date = CGI::escapeHTML(first_date)
-          date_value = first_date.gsub(/[^0-9|n\.d\.]/, "")[0,4]
-          return nil if date_value.nil?
-        end
-        clean_end_punctuation(date_value) if date_value
-      end
-
-      def setup_pub_info
-        text = ''
-        place = self.based_near.first
-        publisher = self.publisher.first
-        unless place.blank?
-          place = CGI::escapeHTML(place)
-          text << place
-          text << ": " unless publisher.blank?
-        end
-        unless publisher.blank?
-          publisher = CGI::escapeHTML(publisher)
-          text << publisher
-        end
-        return nil if text.strip.blank?
-        clean_end_punctuation(text.strip)
-      end
-
-      def mla_citation_title(text)
-        no_upcase = ["a","an","and","but","by","for","it","of","the","to","with"]
-        new_text = []
-        word_parts = text.split(" ")
-        word_parts.each do |w|
-          if !no_upcase.include? w
-            new_text.push(w.capitalize)
-          else
-            new_text.push(w)
-          end
-        end
-        new_text.join(" ")
-      end
-
-      def citation_title(title_text)
-        prepositions = ["a","about","across","an","and","before","but","by","for","it","of","the","to","with","without"]
-        new_text = []
-        title_text.split(" ").each_with_index do |word,index|
-          if (index == 0 and word != word.upcase) or (word.length > 1 and word != word.upcase and !prepositions.include?(word))
-            # the split("-") will handle the capitalization of hyphenated words
-            new_text << word.split("-").map!{|w| w.capitalize }.join("-")
-          else
-            new_text << word
-          end
-        end
-        new_text.join(" ")
-      end
-
-      def setup_title_info
-        text = ''
-        title = self.title.first
-        unless title.blank?
-          title = CGI::escapeHTML(title)
-          title_info = clean_end_punctuation(title.strip)
-          text << title_info
-        end
-
-        return nil if text.strip.blank?
-        clean_end_punctuation(text.strip) + "."
-      end
-
-      def clean_end_punctuation(text)
-        if [".",",",":",";","/"].include? text[-1,1]
-          return text[0,text.length-1]
-        end
-        text
-      end
-
-      def get_author_list
-        self.creator.map { |author| clean_end_punctuation(CGI::escapeHTML(author)) }.uniq
-      end
-
-      def get_all_authors
-        authors = self.creator
-        return authors.empty? ? nil : authors.map { |author| CGI::escapeHTML(author) }
-      end
-
-      def abbreviate_name(name)
-        abbreviated_name = ''
-        name = name.join('') if name.is_a? Array
-        # make sure we handle "Cher" correctly
-        return name if !name.include?(' ') and !name.include?(',')
-        surnames_first = name.include?(',')
-        delimiter = surnames_first ? ', ' : ' '
-        name_segments = name.split(delimiter)
-        given_names = surnames_first ? name_segments.last.split(' ') : name_segments.first.split(' ')
-        surnames = surnames_first ? name_segments.first.split(' ') : name_segments.last.split(' ')
-        abbreviated_name << surnames.join(' ')
-        abbreviated_name << ', '
-        abbreviated_name << given_names.map { |n| "#{n[0]}." }.join if given_names.is_a? Array
-        abbreviated_name << "#{given_names[0]}." if given_names.is_a? String
-        abbreviated_name
-      end
-
-      def name_reverse(name)
-        name = clean_end_punctuation(name)
-        return name unless name =~ /,/
-        temp_name = name.split(", ")
-        return temp_name.last + " " + temp_name.first
-      end
-
-    end
-  end
-end