worthwhile 0.0.1.alpha → 0.0.1

data/app/models/generic_work.rb

@@ -0,0 +1,5 @@
+# Override this file locally if you want to define your own GenericWork class
+class GenericWork < ActiveFedora::Base
+  include ::CurationConcern::Work
+  include ::CurationConcern::WithBasicMetadata
+end

data/app/models/worthwhile/classify_concern.rb

@@ -0,0 +1,47 @@
+require 'active_attr'
+module Worthwhile
+  class ClassifyConcern
+    include ActiveAttr::Model
+    attribute :curation_concern_type
+
+    validates(
+      :curation_concern_type,
+      presence: true,
+      inclusion: { in: lambda { |record| record.registered_curation_concern_types } }
+    )
+
+    def all_curation_concern_classes
+      registered_curation_concern_types.sort.map { |c| self.class.to_class(c) }
+    end
+
+    def registered_curation_concern_types
+      Worthwhile.configuration.registered_curation_concern_types
+    end
+
+    def possible_curation_concern_types
+      registered_curation_concern_types.collect do |concern|
+        [self.class.to_class(concern).human_readable_type, concern]
+      end
+    end
+
+    def curation_concern_class
+      if possible_curation_concern_types.detect{|name, class_name|
+          class_name == curation_concern_type
+        }
+        self.class.to_class(curation_concern_type)
+      else
+        raise RuntimeError, "Invalid :curation_concern_type"
+      end
+    end
+
+    def self.to_class(type)
+      # TODO we may want to allow a different (or nil) namespace
+      type.camelize.constantize
+      # begin
+      #   "::#{type.camelize}".constantize
+      # rescue NameError
+      #   "Worthwhile::#{type}".constantize
+      # end
+    end
+  end
+end

data/app/models/worthwhile/content_version.rb

@@ -0,0 +1,23 @@
+module Worthwhile
+  class ContentVersion
+    class Null
+      def initialize(content)
+      end
+      def created_on; 'unknown'; end
+      def committer_name; 'unknown'; end
+      def formatted_created_on(*args); 'unknown'; end
+      def version_id; 'unknown'; end
+    end
+
+    attr_reader :version_id, :created_on, :committer_name
+    def initialize(content, version_structure)
+      @created_on = version_structure.dsCreateDate
+      @version_id = version_structure.versionID
+      @committer_name = content.version_committer(version_structure)
+    end
+
+    def formatted_created_on(format = :long_ordinal )
+      created_on.localtime.to_formatted_s(format)
+    end
+  end
+end

data/app/models/worthwhile/contributor_agreement.rb

@@ -0,0 +1,23 @@
+module Worthwhile
+  class ContributorAgreement
+    attr_reader :curation_concern, :user
+    def initialize(curation_concern, user, params)
+      @curation_concern = curation_concern
+      @user = user
+      @param_value = params[param_key.to_sym] || params[param_key.to_s]
+    end
+
+    def acceptance_value
+      'accept'
+    end
+
+    def param_key
+      :accept_contributor_agreement
+    end
+    attr_reader :param_value
+
+    def is_being_accepted?
+      param_value == acceptance_value
+    end
+  end
+end

data/app/models/worthwhile/generic_file.rb

@@ -0,0 +1,5 @@
+module Worthwhile
+  class GenericFile < ActiveFedora::Base
+    include Worthwhile::GenericFileBase
+  end
+end

data/app/models/worthwhile/linked_resource.rb

@@ -0,0 +1,41 @@
+module Worthwhile
+  class LinkedResource < ActiveFedora::Base
+    include ::CurationConcern::Work
+
+    has_file_datastream "content", control_group: 'E'
+    has_metadata "descMetadata", type: GenericFileRdfDatastream
+    
+    belongs_to :batch, property: :is_part_of, class_name: 'ActiveFedora::Base'
+
+    validates :url, presence: true
+
+    self.human_readable_short_description = "An arbitrary URL reference."
+    include ActionView::Helpers::SanitizeHelper
+    
+    has_attributes :date_uploaded, :date_modified, :title, :description, datastream: :descMetadata, multiple: false
+
+    # Creator is multiple to match Sufia::GenericFile#creator
+    has_attributes :creator, datastream: :descMetadata, multiple: true
+
+    def url=(url)
+      u = URI::Parser.new.parse(url)
+      return unless [URI::HTTP, URI::HTTPS, URI::FTP].include?(u.class)
+      content.dsLocation = u.to_s
+    end
+
+    def url
+      content.dsLocation
+    end
+
+    def to_s
+      url
+    end
+
+    def to_solr(solr_doc={}, opts={})
+      super
+      Solrizer.set_field(solr_doc, 'url', url, :stored_searchable)
+      solr_doc
+    end
+  end
+end
+

data/app/models/worthwhile/quick_classification_query.rb

@@ -0,0 +1,31 @@
+module Worthwhile
+  class QuickClassificationQuery
+
+    def self.each_for_context(*args, &block)
+      new(*args).all.each(&block)
+    end
+
+    attr_reader :user
+
+    def initialize(user, options = {})
+      @user = user
+      @concern_name_normalizer = options.fetch(:concern_name_normalizer, ClassifyConcern.method(:to_class))
+      @registered_curation_concern_names = options.fetch(:registered_curation_concern_names, Worthwhile.configuration.registered_curation_concern_types)
+    end
+
+    def all
+      ActiveFedora::Base.logger.debug "User is #{user}"
+      ActiveFedora::Base.logger.debug "try is #{normalized_curation_concern_names.first}"
+      ActiveFedora::Base.logger.debug "can is  #{user.can?(:create, normalized_curation_concern_names.first)}"
+      normalized_curation_concern_names.select {|klass| user.can?(:create, klass)}
+    end
+
+    private
+
+    attr_reader :concern_name_normalizer, :registered_curation_concern_names
+
+    def normalized_curation_concern_names
+      registered_curation_concern_names.collect{|name| concern_name_normalizer.call(name) }
+    end
+  end
+end

data/app/services/worthwhile/curation_concern.rb

@@ -0,0 +1,21 @@
+module Worthwhile
+  module CurationConcern
+
+    module_function
+    
+    def mint_a_pid
+      Sufia::Noid.namespaceize(Sufia::Noid.noidify(Sufia::IdService.mint))
+    end  
+
+    def actor(curation_concern, *args)
+      actor_identifier = curation_concern.class.to_s.split('::').last
+      klass = "CurationConcern::#{actor_identifier}Actor".constantize
+      klass.new(curation_concern, *args)
+    end
+    
+    def attach_file(generic_file, user, file_to_attach)
+      Sufia::GenericFile::Actor.new(generic_file, user).create_content(file_to_attach, file_to_attach.original_filename, 'content')
+    end
+    
+  end
+end

data/app/services/worthwhile/embargo_service.rb

@@ -0,0 +1,26 @@
+module Worthwhile
+  module EmbargoService
+    class << self
+      #
+      # Methods for Querying Repository to find Embargoed Objects
+      #
+
+      # Returns all assets with embargo release date set to a date in the past
+      def assets_with_expired_embargoes
+        ActiveFedora::Base.where('embargo_release_date_dtsi:[* TO NOW]')
+      end
+
+      # Returns all assets with embargo release date set
+      #   (assumes that when lease visibility is applied to assets
+      #    whose leases have expired, the lease expiration date will be removed from its metadata)
+      def assets_under_embargo
+        ActiveFedora::Base.where('embargo_release_date_dtsi:*')
+      end
+
+      # Returns all assets that have had embargoes deactivated in the past.
+      def assets_with_deactivated_embargoes
+        ActiveFedora::Base.where('embargo_history_ssim:*')
+      end
+    end
+  end
+end

data/app/services/worthwhile/lease_service.rb

@@ -0,0 +1,23 @@
+module Worthwhile
+  module LeaseService
+    class << self
+      # Returns all assets with lease expiration date set to a date in the past
+      def assets_with_expired_leases
+        ActiveFedora::Base.where('lease_expiration_date_dtsi:[* TO NOW]')
+      end
+
+      # Returns all assets with lease expiration date set
+      #   (assumes that when lease visibility is applied to assets
+      #    whose leases have expired, the lease expiration date will be removed from its metadata)
+      def assets_under_lease
+        ActiveFedora::Base.where('lease_expiration_date_dtsi:*')
+      end
+
+      # Returns all assets that have had embargoes deactivated in the past.
+      def assets_with_deactivated_leases
+        ActiveFedora::Base.where('lease_history_ssim:*')
+      end
+    end
+  end
+end
+

data/app/views/catalog/_action_menu_partials/_collection.html.erb

@@ -0,0 +1,27 @@
+<div class="btn-group">
+  <button class="btn btn-default btn-small dropdown-toggle" data-toggle="dropdown" href="#">Select an action <span class="caret"></span></button>
+  <ul class="dropdown-menu">
+    <% if can? :edit, document %>
+      <li>
+        <%= link_to [collections, :edit, document], class: 'itemicon itemedit' do %><i class="glyphicon glyphicon-pencil"></i> Edit <%= document.human_readable_type %>
+        <% end %>
+      </li>
+      <li>
+        <% if @collection # We're on the view page for @collection. -%>
+          <%= button_for_remove_from_collection(document) %>
+        <% else %>
+          <%= link_to [collections, document], class: 'itemicon itemtrash', title: 'Delete Collection', method: :delete, data: {
+                          confirm: "Deleting a collection from #{t('sufia.product_name')} is permanent. Click OK to delete this collection from #{t('sufia.product_name')}, or Cancel to cancel this operation" } do %>
+                          <i class="glyphicon glyphicon-trash"></i> Delete <%= document.human_readable_type %>
+          <% end %>
+        <% end %>
+      </li>
+    <% end %>
+    <% if can? :collect, document %>
+      <li>
+        <%= link_to_select_collection document %>
+      </li>
+    <% end %>
+  </ul>
+  <%= render 'curate/collections/add_to_collection_modal', collectible: document if can? :collect, document %>
+</div>

data/app/views/catalog/_action_menu_partials/_default.html.erb

@@ -0,0 +1,27 @@
+<div class="btn-group">
+  <button class="btn btn-default btn-small dropdown-toggle" data-toggle="dropdown" href="#">Select an action <span class="caret"></span></button>
+  <ul class="dropdown-menu">
+    <% if can? :edit, document %>
+      <li>
+        <%= link_to [:edit, :curation_concern, document], class: 'itemicon itemedit' do %><i class="glyphicon glyphicon-pencil"></i> Edit <%= document.human_readable_type %>
+        <% end %>
+      </li>
+      <li>
+        <% if @collection # We're on the view page for @collection. -%>
+          <%= button_for_remove_from_collection(document) %>
+        <% else %>
+          <%= link_to [:curation_concern, document], class: 'itemicon itemtrash', title: 'Delete Collection', method: :delete, data: {
+                          confirm: "Deleting a collection from #{t('sufia.product_name')} is permanent. Click OK to delete this collection from #{t('sufia.product_name')}, or Cancel to cancel this operation" } do %>
+                          <i class="glyphicon glyphicon-trash"></i> Delete <%= document.human_readable_type %>
+          <% end %>
+        <% end %>
+      </li>
+    <% end %>
+    <% if can? :collect, document %>
+      <li>
+        <%= link_to_select_collection document %>
+      </li>
+    <% end %>
+  </ul>
+  <%= render 'curate/collections/add_to_collection_modal', collectible: document if can? :collect, document %>
+</div>

data/app/views/catalog/_document.html.erb

@@ -0,0 +1,3 @@
+<li id="document_<%= document.to_param %>" class="document <%= render_document_class document %>" itemscope itemtype="<%= document.itemtype %>">
+  <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, document_counter: document_counter %>
+</li>

data/app/views/catalog/_document_list.html.erb

@@ -0,0 +1,5 @@
+<h3 id="document-list-heading" class="accessible-hidden">List of files deposited in <%= t('sufia.product_name') %> that match your search criteria</h3>
+<ol id="documents" class="container-fluid search-results-list" start="<%= document_counter_with_offset(0) %>" aria-labeled-by="document-list-heading">
+  <%= render documents, as: :document %>
+</ul>
+

data/app/views/catalog/_home_text.html.erb

@@ -0,0 +1,8 @@
+<p>
+  <%=t('sufia.product_name') %> is a secure repository service enabling the
+  <%=t('sufia.institution_name') %> community to share its research and scholarly
+  work with a worldwide audience. Faculty, staff, and students can use
+  <%=t('sufia.product_name') %> to collect their work in one location and create a
+  durable and citeable record of their papers, presentations, publications, data
+  sets, or other scholarly creations.
+</p>

data/app/views/catalog/_index_default.html.erb

@@ -0,0 +1,17 @@
+<div class="row">
+  <%= render_document_partial document, 'thumbnail', document_counter: document_counter %>
+  <dl class="document-metadata dl-invert dl-horizontal">
+    
+    <% index_fields(document).each do |solr_fname, field| -%>
+      <% if should_render_index_field? document, field %>
+        <dt class="blacklight-<%= solr_fname.parameterize %>"><%= render_index_field_label document, :field => solr_fname %></dt>
+        <dd class="blacklight-<%= solr_fname.parameterize %>"><%= render_index_field_value document, :field => solr_fname %></dd>
+      <% end -%>
+    <% end -%>
+
+  </dl>
+
+  <div class="search-result-actions">
+    <%= render_document_partial document, 'action_menu' %>
+  </div>
+</div>

data/app/views/catalog/_index_header_list_default.html.erb

@@ -0,0 +1,17 @@
+     
+      <% # header bar for doc items in index view -%>
+      <div class="documentHeader">
+        
+        <%# main title container for doc partial view 
+            How many bootstrap columns need to be reserved
+            for bookmarks control depends on size. 
+        -%>
+        
+        <h4 class="index_title">
+          <% counter = document_counter_with_offset(document_counter) %>
+          <%= link_to_document document, label: document_show_link_field(document), counter: counter %>
+        </h4>
+
+      </div>
+      
+

data/app/views/catalog/_navbar.html.erb

@@ -0,0 +1,12 @@
+<nav class="navbar navbar-default" role="navigation">
+  <div class="container-fluid">
+    <div class="collapse navbar-collapse" id="type-tabs">
+      <ul class="nav navbar-nav">
+        <%= all_type_tab %>
+        <%= type_tab 'Works', 'Work' %>
+        <%= type_tab 'Collections', 'Collection' %>
+      </ul>
+    </div>
+  </div>
+</nav>
+

data/app/views/catalog/_show_partials/_default.html.erb

@@ -0,0 +1,22 @@
+<%# default partial to display solr document fields in catalog show view -%>
+
+
+<div class="document_viewer" id="cover_container">
+  <dl class="defList">
+    <dt>ID: </dt>
+    <dd><%= render_document_show_field_value(:document=>document, :field=>"id") %></dd>
+    <dt>Download:</dt>
+    <dd id="downloads">
+    <ul>
+        <% %>
+      </ul>
+    </dd>
+    <dt>Copyright: </dt>
+    <dd><%= render_document_show_field_value(:document=>document, :field=>"rights_t") %></dd>
+  </dl>
+</div>
+<div class="<%= params[:action]%>_details">
+  <%= render :partial => "#{params[:controller]}/_#{params[:action]}_partials/default_details", :locals => {:document => document}%>
+</div>
+
+<%= async_load_tag(hydra_asset_downloads_path(params[:id]), 'downloads') %>

data/app/views/catalog/_show_partials/_default_details.html.erb

@@ -0,0 +1,15 @@
+<%# default partial to display solr document fields in catalog show view -%>
+<div>
+  <dl class="defList">
+    <dt>Date: </dt>
+    <dd><%= render_document_show_field_value(:document=>document, :field=>"date_t") %></dd>
+    <dt>Title: </dt>
+    <dd><%= render_document_show_field_value(:document=>document, :field=>"title_t") %></dd>
+    <dt>Document Type: </dt>
+    <dd><%= render_document_show_field_value(:document=>document, :field=>"medium_t") %></dd>
+    <dt>Location: </dt>
+    <dd><%= render_document_show_field_value(:document=>document, :field=>"location_t") %></dd>
+    <dt>Date: </dt>
+    <dd><%= render_document_show_field_value(:document=>document, :field=>"date_t") %></dd>
+  </dl>
+</div>

data/app/views/catalog/_show_partials/_facets.html.erb

@@ -0,0 +1,52 @@
+<% facets_display_heading ||=  "" %>
+<% # main container for facets/limits menu -%>
+<div id="facets">
+  <h2><%=h facets_display_heading %></h2>
+  <% facet_field_names.each do |solr_fname| %>
+    <div>
+      <% display_facet = @response.facets.detect {|f| f.name == solr_fname} -%>
+      <%#- raise solr_fname.inspect unless display_facet -%>
+      <% if display_facet && display_facet.items.length > 0 %>
+        <h3 class="facet_selected"><%= facet_field_labels[solr_fname] -%></h3>
+        <ul>
+        <% item_counter = 0 %>
+          <% display_facet.items.each do |item| -%>
+            <% if item.hits > 0 %>
+              <% facet_count_for_value = facet_value_hits(@facet_lookup, solr_fname, item.value) %>
+              <% if facet_in_params? solr_fname, item.value %>
+                <li>
+                  <span class="selected"><%= h(item.value) %> (<%= format_num facet_count_for_value %>)</span>
+                  <% link_options = remove_facet_params(solr_fname, item.value, params).merge!Hash["controller" => "catalog", :action=> "index"] %>
+                  [<%= link_to 'remove', url_for(link_options), :class=>'remove' %>]
+                </li>
+                <% else %>
+        <%- if item_counter > Blacklight.config[:facet_more_num]-1 -%>
+                  <li class="more">
+        <%- else -%>
+          <li>
+        <%- end -%>
+                  <% link_options = add_facet_params(solr_fname, item.value).merge!Hash["controller" => "catalog", :action=> "index"] %>
+                  <%= link_to h(item.value), url_for(link_options) %> (<%= format_num facet_count_for_value %>)
+                </li>
+              <% end -%>
+            <% end -%>
+      <% item_counter += 1 %>
+          <% end %>
+          <%= display_facet.items.length > Blacklight.config[:facet_more_num] ? "<li class='more_li'><a href='' class='more_link' title='more #{pluralize(2, facet_field_labels[solr_fname])[2..-1].downcase}'>more<span class='off_screen'> #{pluralize(2, facet_field_labels[solr_fname])[2..-1].downcase}</span></a></li>" : "" %>
+          <%= display_facet.items.length > Blacklight.config[:facet_more_num] ? "<li class='less_li' style='display:none;'><a href='' class='more_link' title='less #{pluralize(2, facet_field_labels[solr_fname])[2..-1].downcase}'>less<span class='off_screen'> #{pluralize(2, facet_field_labels[solr_fname])[2..-1].downcase}</span></a></li>" : "" %>
+        </ul>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+<script type="text/javascript">
+  $(".more").toggle();
+  $('.more_link').each(function(){
+    $(this).click(function(){
+      $(this).parent().parent().children("li.more").toggle();
+      $(this).parent().parent().children("li.more_li").toggle();
+      $(this).parent().parent().children("li.less_li").toggle();
+      return false;
+    });
+  });
+</script>