curation_concerns 0.1.0

data/curation_concerns-models/app/models/concerns/curation_concerns/generic_file/belongs_to_works.rb

@@ -0,0 +1,53 @@
+module CurationConcerns
+  module GenericFile
+    module BelongsToWorks
+      extend ActiveSupport::Concern
+
+      included do
+        before_destroy :remove_representative_relationship
+      end
+
+      def generic_works
+        self.parent_objects  # parent_objects is provided by Hydra::PCDM::ObjectBehavior
+      end
+
+      def generic_work_ids
+        generic_works.map { |work| work.id }
+      end
+
+      # Returns the first parent object
+      # This is a hack to handle things like GenericFiles inheriting access controls from their parent.  (see CurationConcerns::ParentContainer in app/controllers/concerns/curation_concers/parent_container.rb)
+      def parent
+        self.parent_objects.first
+      end
+
+      # Returns the id of first parent object
+      # This is a hack to handle things like GenericFiles inheriting access controls from their parent.  (see CurationConcerns::ParentContainer in app/controllers/concerns/curation_concers/parent_container.rb)
+      def parent_id
+        parent.id
+      end
+
+      # Files with sibling relationships
+      # Returns all GenericFiles aggregated by any of the GenericWorks that aggregate the current object
+      def related_files
+        generic_works = self.generic_works
+        return [] if generic_works.empty?
+        generic_works.flat_map {|work| work.generic_files.select {|generic_file| generic_file.id != self.id } }
+      end
+
+      # If any parent works are pointing at this object as their representative, remove that pointer.
+      def remove_representative_relationship
+        generic_works = self.generic_works
+        return if generic_works.empty?
+        generic_works.each do |work|
+          if work.representative == self.id
+            work.representative = nil
+            work.save
+          end
+        end
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,89 @@
+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/curation_concerns-models/app/models/concerns/curation_concerns/generic_file/content.rb

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

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

@@ -0,0 +1,343 @@
+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

data/curation_concerns-models/app/models/concerns/curation_concerns/generic_file/full_text_indexing.rb

@@ -0,0 +1,12 @@
+module CurationConcerns
+  module GenericFile
+    module FullTextIndexing
+      extend ActiveSupport::Concern
+
+      included do
+        contains 'full_text'
+      end
+
+    end
+  end
+end

data/curation_concerns-models/app/models/concerns/curation_concerns/generic_file/indexing.rb

@@ -0,0 +1,14 @@
+module CurationConcerns
+  module GenericFile
+    module Indexing
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # override the default indexing service
+        def indexer
+          CurationConcerns::GenericFileIndexingService
+        end
+      end
+    end
+  end
+end

data/curation_concerns-models/app/models/concerns/curation_concerns/generic_file/versions.rb

@@ -0,0 +1,16 @@
+module CurationConcerns
+  module GenericFile
+    module Versions
+      @@count = 0
+      def record_version_committer(user)
+        version = self.latest_version
+        # content datastream not (yet?) present
+        return if version.nil?
+        @@count += 1
+        # raise "Recording #{@@count} #{version.uri} for #{user.user_key}" if @@count == 3
+        VersionCommitter.create(version_id: version.uri, committer_login: user.user_key)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module CurationConcerns
+  # Base namespace for GenericFile Behavior modules
+  module GenericFile
+  end
+end

data/curation_concerns-models/app/models/concerns/curation_concerns/generic_file_behavior.rb

@@ -0,0 +1,44 @@
+module CurationConcerns
+  module GenericFileBehavior
+    extend ActiveSupport::Concern
+    include Hydra::Works::GenericFileBehavior
+    include Hydra::Works::GenericFile::VirusCheck
+    include Hydra::WithDepositor
+    include CurationConcerns::Serializers
+    include CurationConcerns::Noid
+    include CurationConcerns::Permissions
+    include CurationConcerns::GenericFile::Export
+    include CurationConcerns::GenericFile::Characterization
+    include CurationConcerns::BasicMetadata
+    include CurationConcerns::GenericFile::Content
+    include CurationConcerns::GenericFile::FullTextIndexing
+    include CurationConcerns::GenericFile::Indexing
+    include CurationConcerns::GenericFile::BelongsToWorks
+    include Hydra::AccessControls::Embargoable
+
+    included do
+      attr_accessor :file
+
+      # make filename single-value (CurationConcerns::GenericFile::Characterization makes it multivalue)
+      def filename
+        self[:filename].first
+      end
+    end
+
+    def human_readable_type
+      self.class.to_s.demodulize.titleize
+    end
+
+    def representative
+      to_param
+    end
+
+    def to_solr(solr_doc = {})
+      super(solr_doc).tap do |solr_doc|
+        # Enables Riiif to not have to recalculate this each time.
+        solr_doc['height_isi'] = Integer(height.first) if height.present?
+        solr_doc['width_isi'] = Integer(width.first) if width.present?
+      end
+    end
+  end
+end

data/curation_concerns-models/app/models/concerns/curation_concerns/generic_work_behavior.rb

@@ -0,0 +1,38 @@
+module CurationConcerns::GenericWorkBehavior
+  extend ActiveSupport::Concern
+
+  include Hydra::Works::GenericWorkBehavior
+  include ::CurationConcerns::HumanReadableType
+  include CurationConcerns::Noid
+  include CurationConcerns::Permissions
+  include CurationConcerns::Serializers
+  include Hydra::WithDepositor
+  include Solrizer::Common
+  include ::CurationConcerns::HasRepresentative
+  include ::CurationConcerns::WithGenericFiles
+  include Hydra::AccessControls::Embargoable
+
+  included do
+    property :owner, predicate: RDF::URI.new('http://opaquenamespace.org/ns/hydra/owner'), multiple: false
+    class_attribute :human_readable_short_description
+  end
+
+  module ClassMethods
+    def indexer
+      CurationConcerns::GenericWorkIndexingService
+    end
+  end
+
+  def to_s
+    title.join(', ')
+  end
+
+  # Returns a string identifying the path associated with the object. ActionPack uses this to find a suitable partial to represent the object.
+  def to_partial_path
+    "curation_concerns/#{super}"
+  end
+
+  def can_be_member_of_collection?(collection)
+    true
+  end
+end

data/curation_concerns-models/app/models/concerns/curation_concerns/has_representative.rb

@@ -0,0 +1,14 @@
+module CurationConcerns::HasRepresentative
+  extend ActiveSupport::Concern
+
+  included do
+    property :representative, predicate: RDF::URI.new('http://opaquenamespace.org/ns/hydra/representative'), multiple: false
+  end
+
+  def to_solr(solr_doc={})
+    super.tap do |solr_doc|
+      solr_doc[Solrizer.solr_name('representative', :stored_searchable)] = representative
+    end
+  end
+
+end

data/curation_concerns-models/app/models/concerns/curation_concerns/human_readable_type.rb

@@ -0,0 +1,23 @@
+module CurationConcerns
+   module HumanReadableType
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :human_readable_short_description, :human_readable_type
+      self.human_readable_type = name.demodulize.titleize
+    end
+
+    def human_readable_type
+      self.class.human_readable_type
+    end
+
+    def to_solr(solr_doc={})
+      super(solr_doc).tap do |solr_doc|
+        solr_doc[Solrizer.solr_name('human_readable_type',:facetable)] = human_readable_type
+        solr_doc[Solrizer.solr_name('human_readable_type', :stored_searchable)] = human_readable_type
+      end
+    end
+
+  end
+end
+

data/curation_concerns-models/app/models/concerns/curation_concerns/permissions/readable.rb

@@ -0,0 +1,19 @@
+module CurationConcerns
+  module Permissions
+    module Readable
+      extend ActiveSupport::Concern
+      def public?
+        read_groups.include?('public')
+      end
+
+      def registered?
+        read_groups.include?('registered')
+      end
+
+      def private?
+        !(public? || registered?)
+      end
+
+    end
+  end
+end