sufia 4.0.0.beta3 → 4.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dc0a47a4d02bb4ce230928b4242bc02db1ae5db
-  data.tar.gz: e998ecb28e7c6b68074cc2ecf3a3ca4372fdf547
+  metadata.gz: d8143524ee97650ca264d7daf37e8daf09d3cb7d
+  data.tar.gz: b4714ff53d0ea22cb0f73df735e3133072daca9c
 SHA512:
-  metadata.gz: 973bb882c5efa1463f8ccc303bd3954e09f3f781249fe504dfac14c8b4e08491895c3d70485ca5c497e91ce9e8f1de8ab16604d5b0754c3f3b394a666231210b
-  data.tar.gz: 94cde82bad64900cda91fe6d84f9cb39e75e6c8443784ba14f319dc5e3f0931088fa1669933ce5fd9b5305ea95dfa91407ba9a4dd6d2c7f42dc18cff8b0c84d8
+  metadata.gz: aca36c15faed0587db40c7f4b528033b971d3083c14846eda85e1fd45478dd58daef919d688d322ba10eb3d3c9483f4dde6bbb3054010bf22027197525f75fd1
+  data.tar.gz: 7a76f154841c3cc1b464f9723bd12370a4836ef4ad7c297eae1c73156a84c23193a5299096f437abf90644afa9883abe80bcaf82995928d8e82221e2a637ee61

data/README.md

@@ -1,5 +1,12 @@
 # Sufia [![Version](https://badge.fury.io/rb/sufia.png)](http://badge.fury.io/rb/sufia) [![Build Status](https://travis-ci.org/projecthydra/sufia.png?branch=master)](https://travis-ci.org/projecthydra/sufia) [![Dependency Status](https://gemnasium.com/projecthydra/sufia.png)](https://gemnasium.com/projecthydra/sufia)
 
+# Please Note!
+Sufia is currently in transition to a new 4.0 release scheduled for late summer 2014.  If wish to use Sufia now,
+please ensure you using version 3.7.2, available from RubyGems.org.  For documentation specific to this version,
+please consult the [Sufia 3.7.2 documentation](http://rubydoc.info/gems/sufia/3.7.2/frames).
+
+If you have questions or need help, please email `hydra-tech@googlegroups.com`
+
 ## What is Sufia?
 Sufia is a component that adds self-deposit institutional repository features to a Rails app.
 Sufia is created with Ruby on Rails and builds on the Hydra Framework.

data/SUFIA_VERSION

@@ -1 +1 @@
-4.0.0.beta3
+4.0.0.beta4

data/app/assets/javascripts/sufia/search.js

@@ -5,7 +5,6 @@
     this.init = function() {
       this.$label = this.$element.find('[data-search-element="label"]');
       this.$items = this.$element.find('[data-search-option]');
-      this.$hidden = this.$element.find('input#owner[type="hidden"]');
       this.setDefault();
     }
 
@@ -26,12 +25,11 @@
 
     clicked: function($anchor) {
       this.setLabel($anchor.data('search-label'));
-      this.$hidden.val($anchor.data('search-option'));
+      this.setFormAction($anchor.data('search-option'));
     },
 
-    // Grab the "owner" value out of the hidden field 
-    getDefaultValue: function () {
-      return this.$hidden.val();
+    setFormAction: function(path) {
+      this.$element.attr('action', path);
     },
 
     getLabelForValue: function(value) {
@@ -40,7 +38,7 @@
     },
 
     setDefault: function() {
-      this.setLabel(this.getLabelForValue(this.getDefaultValue()));
+      this.setLabel(this.getLabelForValue(this.$element.attr('action')));
     },
 
     setLabel: function(label) {

data/app/assets/stylesheets/dashboard.css.scss

@@ -91,6 +91,32 @@ $gray-lighter: #eee;
   text-decoration: none;
 }
 
+.portal {
+  border: 1px solid $gray-lightish;
+  margin: 5px;
+  padding: 5px;
+  h3 {
+    margin-top: 10px;
+  }
+}
+
+.heading-tile {
+  border-right: 1px solid $gray-lightish;
+  margin-top: 10px;
+  margin-bottom: 10px;
+  text-align: center;
+  font-size: x-large;
+  font-weight: normal;
+  span {
+    display: block;
+  }
+}
+
+.heading-row {
+  border-bottom: 1px solid $gray-lightish;
+  //margin-left: 10px;
+}
+
 #collection-list-container {
   .collection-list {
     li {

data/app/assets/stylesheets/header.css.scss

@@ -17,6 +17,24 @@ $gray-lighter: #eee;
   background-image: linear-gradient(to bottom, #0071BC 0%, #003457 100%);
   min-height: 4em;
 
+  #logo span.glyphicon {
+    color: #FFF;
+    font-size: 4em;
+    margin: .25em 0 0 .25em;
+  }
+
+  .institution_name {
+    font-family: 'Lato', Verdana, Arial, Helvetica;
+    font-size: 4em;
+    font-weight: 300;
+    margin: 0 0 0 .25em;
+  }
+
+  .institution_name, .institution_name a:link, .institution_name a:visited {
+    color: #FFF;
+    text-decoration: none;
+  }
+
   .navbar {
     min-height: 0px;
     margin-bottom: 0.8em;
@@ -71,18 +89,6 @@ $gray-lighter: #eee;
   }
 }
 
-#logo span.glyphicon {
-  color: #FFF;
-  font-size: 4em;
-  margin: .25em 0 0 .25em;
-}
-.institution_name {
-  color: #FFF;
-  font-family: 'Lato', Verdana, Arial, Helvetica;
-  font-size: 4em;
-  font-weight: 300;
-  margin: 0 0 0 .25em;
-}
 
 .login_button {
   margin: 1.75em 3em 0 0;
@@ -90,4 +96,7 @@ $gray-lighter: #eee;
 
 #search-form-header {
   margin-top: 7px;
+}
+#search-submit-header {
+  margin-left: -15px;
 }

data/app/controllers/batch_controller.rb

@@ -1,6 +1,5 @@
 class BatchController < ApplicationController
   include Hydra::Controller::ControllerBehavior
-  include Sufia::Noid # for normalize_identifier method
   layout "sufia-one-column"
 
   before_filter :has_access?

data/app/controllers/collections_controller.rb

@@ -4,7 +4,6 @@ class CollectionsController < ApplicationController
   include Blacklight::Catalog::SearchContext
   include BlacklightAdvancedSearch::ParseBasicQ
   include BlacklightAdvancedSearch::Controller
-  include Sufia::Noid # for normalize_identifier method
   prepend_before_filter :normalize_identifier, except: [:index, :create, :new]
   before_filter :filter_docs_with_read_access!, except: :show
   before_filter :has_access?, except: :show

data/app/controllers/concerns/sufia/catalog.rb

@@ -15,14 +15,5 @@ module Sufia
         solr_parameters[:fq] << "#{Solrizer.solr_name("has_model", :symbol)}:\"info:fedora/afmodel:GenericFile\""
       end
 
-      # If they've selected "owner=mine" then restrict to files I have edit access to
-      def discovery_permissions
-        if params['owner'] == 'mine'
-          ["edit"]
-        else
-          super
-        end
-      end
-
   end
 end

data/app/controllers/concerns/sufia/controller.rb

@@ -12,6 +12,10 @@ module Sufia::Controller
     user_signed_in? ? current_user.ability : super
   end
 
+  def normalize_identifier
+    params[:id] = Sufia::Noid.namespaceize(params[:id])
+  end
+
   def render_404(exception)
     logger.error("Rendering 404 page due to exception: #{exception.inspect} - #{exception.backtrace if exception.respond_to? :backtrace}")
     render template: '/error/404', layout: "error", formats: [:html], status: 404

data/app/controllers/concerns/sufia/dashboard_controller_behavior.rb

@@ -1,103 +1,53 @@
-require 'blacklight/catalog'
-
 module Sufia
   module DashboardControllerBehavior
     extend ActiveSupport::Concern
-    include Hydra::BatchEditBehavior
-    include Blacklight::Catalog
-
-    include Hydra::Collections::SelectsCollections
-  
+    
     included do
-      include Blacklight::Configurable
       include ActionView::Helpers::DateHelper
 
-      self.copy_blacklight_config_from(CatalogController)
-
-      include BlacklightAdvancedSearch::ParseBasicQ
-      include BlacklightAdvancedSearch::Controller
-
       before_filter :authenticate_user!
-      before_filter :enforce_show_permissions, only: :show
-      before_filter :enforce_viewing_context_for_show_requests, only: :show
-
-      # not filtering further with a specific access level since the catalog controller already gets the colections with edit access
-      #  if we include other access levels in this controller we will need to modify this.
-      before_filter :find_collections, only: :index
 
-      # This applies appropriate access controls to all solr queries (the internal method of this is overidden bellow to only include edit files)
-      self.solr_search_params_logic += [:add_access_controls_to_solr_params]
-
-      layout 'sufia-dashboard'
+      layout "sufia-dashboard"
     end
 
+    # Render our dashboard page
     def index
-      (@response, @document_list) = get_search_results
-      @user = current_user
-      @events = @user.events(100)
-      @last_event_timestamp = @user.events.first[:timestamp].to_i || 0 rescue 0
-      @filters = params[:f] || []
-
+      gather_dashboard_information
       respond_to do |format|
         format.html { }
         format.rss  { render layout: false }
         format.atom { render layout: false }
       end
-
-      # set up some parameters for allowing the batch controls to show appropiately
-      @max_batch_size = 80
-      count_on_page = @document_list.count {|doc| batch.index(doc.id)}
-      @disable_select_all = @document_list.count > @max_batch_size
-      batch_size = batch.uniq.size
-      @result_set_size = @response.response["numFound"]
-      @empty_batch = batch.empty?
-      @all_checked = (count_on_page == @document_list.count)
-      @entire_result_set_selected = @response.response["numFound"] == batch_size
-      @batch_size_on_other_page = batch_size - count_on_page
-      @batch_part_on_other_page = (@batch_size_on_other_page) > 0
     end
 
+    # Returns a formated list of recent events in JSON for use with AJAX.
     def activity
-      # reverse events since we're prepending rows. without reverse, old events wind up first
-      events = current_user.events.reverse
-      # filter events to include only those that have occurred since params[:since]
-      events.select! { |event| event[:timestamp].to_i > params[:since].to_i } if params[:since]
-      # return the event, a formatted date string, and a numerical timestamp
-      render json: events.map { |event| [event[:action], "#{time_ago_in_words(Time.at(event[:timestamp].to_i))} ago", event[:timestamp].to_i] }
-    rescue
-      render json: []
-    end
-
-    # TODO: This can be removed after we upgrade to hydra-collections 2.0.1 or greater
-    def add_collection_filter(solr_parameters, user_parameters)
-      super(solr_parameters, user_parameters)
-      solr_parameters[:rows] = 100
-    end
-
-
-
-    def search_action_url *args
-      sufia.dashboard_index_path *args
+      render json: human_readable_user_activity
     end
 
     protected
-    # show only files with edit permissions in lib/hydra/access_controls_enforcement.rb apply_gated_discovery
-    def discovery_permissions
-      ["edit"]
+
+    # Gathers all the information that we'll display in the user's dashboard.
+    # Override this method if you want to exclude or gather additional data elements
+    # in your dashboard view.  You'll need to alter dashboard/index.html.erb accordingly.
+    def gather_dashboard_information
+      @user = current_user
+      @activity = get_user_activity
+      @notifications = current_user.mailbox.inbox
     end
 
-    def show_only_files_deposited_by_current_user(solr_parameters, user_parameters)
-      solr_parameters[:fq] ||= []
-      solr_parameters[:fq] += [
-        ActiveFedora::SolrService.construct_query_for_rel(depositor: current_user.user_key)
-      ]
+    # Returns the most recent activity in the last 24 hours, or since a given timestamp
+    # specified by params[:since]
+    def get_user_activity
+      since = params[:since] ? params[:since].to_i : (DateTime.now.to_i - 86400)
+      current_user.events.reverse.collect { |event| event if event[:timestamp].to_i > since }.compact
     end
 
-    def show_only_generic_files(solr_parameters, user_parameters)
-      solr_parameters[:fq] ||= []
-      solr_parameters[:fq] += [
-        ActiveFedora::SolrService.construct_query_for_rel(has_model: ::GenericFile.to_class_uri)
-      ]
+    # Formats the user's activities into human-readable strings used for rendering JSON
+    def human_readable_user_activity
+      get_user_activity.map do |event|
+        [event[:action], "#{time_ago_in_words(Time.at(event[:timestamp].to_i))} ago", event[:timestamp].to_i]
+      end
     end
 
   end

data/app/controllers/concerns/sufia/downloads_controller_behavior.rb

@@ -4,9 +4,6 @@ module Sufia
     include Hydra::Controller::DownloadBehavior
 
     included do
-      # module mixes in normalize_identifier method
-      include Sufia::Noid
-
       # moved check into the routine so we can handle the user with no access
       prepend_before_filter :normalize_identifier
     end

data/app/controllers/concerns/sufia/files_controller_behavior.rb

@@ -12,7 +12,6 @@ module Sufia
     included do
       include Hydra::Controller::ControllerBehavior
       include Blacklight::Configurable
-      include Sufia::Noid # for normalize_identifier method
       include Sufia::FilesController::BrowseEverything
       include Sufia::FilesController::LocalIngestBehavior
       extend Sufia::FilesController::UploadCompleteBehavior
@@ -60,9 +59,7 @@ module Sufia
 
     # routed to /files/:id (DELETE)
     def destroy
-      pid = @generic_file.noid
-      @generic_file.destroy
-      Sufia.queue.push(ContentDeleteEventJob.new(pid, current_user.user_key))
+      actor.destroy
       redirect_to self.class.destroy_complete_path(params), notice:
         render_to_string(partial: 'generic_files/asset_deleted_flash', locals: { generic_file: @generic_file })
     end
@@ -142,22 +139,16 @@ module Sufia
     end
 
     def update_version
-      if actor.revert_content(params[:revision], datastream_id)
-        Sufia.queue.push(ContentRestoredVersionEventJob.new(@generic_file.pid, current_user.user_key, params[:revision]))
-      end
+      actor.revert_content(params[:revision], datastream_id)
     end
 
     def update_file
-      if actor.update_content(params[:filedata], datastream_id)
-        Sufia.queue.push(ContentNewVersionEventJob.new(@generic_file.pid, current_user.user_key))
-      end
+      actor.update_content(params[:filedata], datastream_id)
     end
 
     # this is provided so that implementing application can override this behavior and map params to different attributes
     def update_metadata
-      if actor.update_metadata(params[:generic_file], params[:visibility])
-        Sufia.queue.push(ContentUpdateEventJob.new(@generic_file.pid, current_user.user_key))
-      end
+      actor.update_metadata(params[:generic_file], params[:visibility])
     end
 
     def json_error(error, name=nil, additional_arguments={})

data/app/controllers/concerns/sufia/my_controller_behavior.rb

@@ -0,0 +1,87 @@
+require 'blacklight/catalog'
+
+module Sufia
+  module MyControllerBehavior
+    extend ActiveSupport::Concern
+    include Blacklight::Catalog
+    include Hydra::BatchEditBehavior
+    include Hydra::Collections::SelectsCollections
+  
+    included do
+      include Blacklight::Configurable
+
+      self.copy_blacklight_config_from(CatalogController)
+
+      include BlacklightAdvancedSearch::ParseBasicQ
+      include BlacklightAdvancedSearch::Controller
+      
+      before_filter :authenticate_user!
+      before_filter :enforce_show_permissions, only: :show
+      before_filter :enforce_viewing_context_for_show_requests, only: :show
+      before_filter :find_collections, only: :index
+
+      # This applies appropriate access controls to all solr queries (the internal method of this is overidden bellow to only include edit files)
+      self.solr_search_params_logic += [:add_access_controls_to_solr_params]
+
+      layout 'sufia-dashboard'
+    end
+
+    # specify the controller_name here to specify where we should look for
+    # the batch_edit menu options (_batch_edits_actions.html.erb)
+    def controller_name
+      :my
+    end
+
+    def index
+      (@response, @document_list) = get_search_results
+      @user = current_user
+      @events = @user.events(100)
+      @last_event_timestamp = @user.events.first[:timestamp].to_i || 0 rescue 0
+      @filters = params[:f] || []
+
+      # set up some parameters for allowing the batch controls to show appropiately
+      @max_batch_size = 80
+      count_on_page = @document_list.count {|doc| batch.index(doc.id)}
+      @disable_select_all = @document_list.count > @max_batch_size
+      batch_size = batch.uniq.size
+      @result_set_size = @response.response["numFound"]
+      @empty_batch = batch.empty?
+      @all_checked = (count_on_page == @document_list.count)
+      @entire_result_set_selected = @response.response["numFound"] == batch_size
+      @batch_size_on_other_page = batch_size - count_on_page
+      @batch_part_on_other_page = (@batch_size_on_other_page) > 0
+
+      respond_to do |format|
+        format.html { }
+        format.rss  { render layout: false }
+        format.atom { render layout: false }
+      end
+    end
+
+    def search_action_url opts={}
+      sufia.url_for(opts)
+    end
+
+    protected
+    
+    # show only files with edit permissions in lib/hydra/access_controls_enforcement.rb apply_gated_discovery
+    def discovery_permissions
+      ["edit"]
+    end
+
+    def show_only_files_deposited_by_current_user solr_parameters, user_parameters
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] += [
+        ActiveFedora::SolrService.construct_query_for_rel(depositor: current_user.user_key)
+      ]
+    end
+
+    def show_only_generic_files solr_parameters, user_parameters
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] += [
+        ActiveFedora::SolrService.construct_query_for_rel(has_model: ::GenericFile.to_class_uri)
+      ]
+    end
+
+  end
+end