sufia 4.0.0.beta2 → 4.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4baf3c7ef78c95068b9500f21bb77a5c78642033
-  data.tar.gz: 4fb2354488ee0d6e346367b9a04ae66c5265601b
+  metadata.gz: 8dc0a47a4d02bb4ce230928b4242bc02db1ae5db
+  data.tar.gz: e998ecb28e7c6b68074cc2ecf3a3ca4372fdf547
 SHA512:
-  metadata.gz: 5a429f4c4860946d64964377f9f3dbea21989ab5a03408f71c08ddb5f970bffedcba9ea3be20fd53373836652c57ab6e9a555e18d1a89539c44b6cab028dd5f1
-  data.tar.gz: 20a76d0c69aefb60a389f25c461d81bca3138b6bc6249cf27bd579beeaed7b468eadcd89490fac54568c692600e47f7e3d2b6ab0f70b6e232fca39e85fc908b4
+  metadata.gz: 973bb882c5efa1463f8ccc303bd3954e09f3f781249fe504dfac14c8b4e08491895c3d70485ca5c497e91ce9e8f1de8ab16604d5b0754c3f3b394a666231210b
+  data.tar.gz: 94cde82bad64900cda91fe6d84f9cb39e75e6c8443784ba14f319dc5e3f0931088fa1669933ce5fd9b5305ea95dfa91407ba9a4dd6d2c7f42dc18cff8b0c84d8

data/Gemfile

@@ -15,6 +15,7 @@ group :development, :test do
   gem 'launchy' unless ENV['TRAVIS']
   gem 'byebug' unless ENV['TRAVIS']
   gem 'capybara'
+  gem 'poltergeist'
   gem "jettywrapper"
   gem "factory_girl_rails"
   gem "devise"
@@ -22,4 +23,6 @@ group :development, :test do
   gem 'turbolinks'
   gem "bootstrap-sass"
   gem "simplecov", :require => false
+  gem "spring"
+  gem 'database_cleaner'
 end # (leave this comment here to catch a stray line inserted by blacklight!)

data/README.md

@@ -24,7 +24,7 @@ Sufia has the following features:
 * Activity streams
 * Background jobs
 * Single-use links
-* Usage statistics
+* Analytics
 
 ## Sufia needs the following software to work:
 1. Solr
@@ -91,7 +91,7 @@ Add this line:
 
 Turbolinks does not mix well with Blacklight.
 
-### Usage statistics
+### Analytics
 
 Sufia provides support for capturing usage information via Google Analytics and for displaying usage stats in the UI.
 
@@ -101,7 +101,7 @@ To enable the Google Analytics javascript snippet, make sure that `config.google
 
 #### Displaying usage
 
-To display usage statistics in the UI, first head to the Google Developers Console and create a new project:
+To display data from Google Analytics in the UI, first head to the Google Developers Console and create a new project:
 
 https://console.developers.google.com/project
 
@@ -129,7 +129,9 @@ The generator will create a configuration file at _config/analytics.yml_.  Edit
 * An application name (you can make this up)
 * An application version (you can make this up)
 
-Finally, you will need to set `config.usage_statistics = true` in _config/initializers/sufia.rb_.
+Lastly, you will need to set `config.analytics = true` in _config/initializers/sufia.rb_ and ensure that the OAuth client email
+has the proper access within your Google Analyics account.  To do so, go to the _Admin_ tab for your Google Analytics account.
+Click on _User Management_, in the _Account_ column, and add "Read & Analyze" permissions for the OAuth client email address.
 
 ### To use browse-everything
 

data/SUFIA_VERSION

@@ -1 +1 @@
-4.0.0.beta2
+4.0.0.beta3

data/app/assets/javascripts/sufia.js

@@ -27,6 +27,8 @@
 
 //= require batch_edit
 //= require terms_of_service
+//
+//= require sufia/app
 //= require sufia/fileupload
 //= require sufia/permissions
 //= require sufia/trophy
@@ -36,8 +38,11 @@
 //= require sufia/edit_metadata
 //= require sufia/single_use_link
 //= require sufia/audio
+//= require sufia/search
 //= require sufia/editor
+//= require sufia/ga_events
 //= require hydra/batch_select
+//= require sufia/dashboard_actions
 //= require hydra_collections
 //= require browse_everything
 //= require jquery.blacklightTagCloud

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

@@ -0,0 +1 @@
+Sufia = {};

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

@@ -60,8 +60,7 @@
     check_all_page();  
   }
 
-$(document).ready(function() { 
-
+Blacklight.onLoad(function() {
   // check the select all page cog menu item and select the entire page
   $("[data-behavior='batch-edit-select-page']").bind('click', function(e) {
     e.preventDefault();

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

@@ -0,0 +1,13 @@
+Blacklight.onLoad(function() {
+    // toggle button on or off based on boxes being clicked
+    $(".batch_document_selector, .batch_document_selector_all").bind('click', function(e) {
+        var n = $(".batch_document_selector:checked").length;
+        if (n>0 || $('input#check_all')[0].checked) {
+            $('.sort-toggle').hide();
+        } else {
+            $('.sort-toggle').show();
+        }
+
+    });
+});
+

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

@@ -1,6 +1,6 @@
 Blacklight.onLoad(function() {
   // hide the editor initially
-  $($('[data-behavior="reveal-editor"]').data('target')).hide();
+  $('[data-behavior="reveal-editor"]').each(function(){$($(this).data('target')).hide();});
 
   // Show the form, hide the preview
   $('[data-behavior="reveal-editor"]').on('click', function(evt) {

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

@@ -0,0 +1,10 @@
+// Callbacks for tracking events using Google Analytics
+
+// Note: there is absence of testing here.  I'm not sure how or to what extent we can test what's getting
+// sent to Google Analytics.
+
+$(document).on('click', '#file_download', function(e) {
+  _gaq.push(['_trackEvent', 'Files', 'Downloaded', $(this).data('label')]);
+    
+});
+

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

@@ -0,0 +1,67 @@
+(function($){
+  Sufia.Search = function (element) {
+    this.$element = $(element);
+
+    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();
+    }
+
+    this.init();
+    this.attachEvents();
+  }
+
+
+  Sufia.Search.prototype = {
+    attachEvents: function() {
+
+      _this = this;
+      this.$items.on('click', function(event) {
+        event.preventDefault();
+        _this.clicked($(this))
+      });
+    },
+
+    clicked: function($anchor) {
+      this.setLabel($anchor.data('search-label'));
+      this.$hidden.val($anchor.data('search-option'));
+    },
+
+    // Grab the "owner" value out of the hidden field 
+    getDefaultValue: function () {
+      return this.$hidden.val();
+    },
+
+    getLabelForValue: function(value) {
+      selected = this.$element.find('[data-search-option="'+ value +'"]');
+      return selected.data('search-label');
+    },
+
+    setDefault: function() {
+      this.setLabel(this.getLabelForValue(this.getDefaultValue()));
+    },
+
+    setLabel: function(label) {
+      this.$label.html(label);
+    }
+
+  }
+
+  $.fn.search = function(option) {
+    return this.each(function() {
+      var $this = $(this);
+      var data  = $this.data('search');
+
+      if (!data) $this.data('search', (data = new Sufia.Search(this)));
+    })
+  }
+
+})(jQuery);
+
+
+Blacklight.onLoad(function() {
+  $('#search-form-header').search();
+});
+

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

@@ -89,4 +89,18 @@ $gray-lighter: #eee;
 
 .visibility-link:hover {
   text-decoration: none;
-}
+}
+
+#collection-list-container {
+  .collection-list {
+    li {
+      list-style: none;
+    }
+  }
+  .modal-footer {
+    div, form {
+      display: inline;
+    }
+  }
+}
+

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

@@ -14,8 +14,20 @@
  *= require nestable
 */
 
+@import 'bootstrap';
+
+@import 'blacklight/blacklight';
 @import "browse_everything";
+
 #browse-everything {
   top:10%;
   background-color: initial;
 }
+
+/* use if a label should be hidden from view but available to screen readers */
+/* we could switch to .sr-only instead */
+.accessible-hidden {
+  position: absolute !important;
+  clip: rect(1px 1px 1px 1px); /* IE6, IE7 */
+  clip: rect(1px, 1px, 1px, 1px);
+}

data/app/controllers/authorities_controller.rb

@@ -4,11 +4,11 @@ require 'cgi'
 class AuthoritiesController < ApplicationController
   def query
     s = params.fetch("q", "")
-    if (params[:term]=="location")
-      hits = GeoNamesResource.find_location(s)
+    hits = if params[:term] == "location"
+      GeoNamesResource.find_location(s)
     else
-      hits = LocalAuthority.entries_by_term(params[:model], params[:term], s) rescue []
+      LocalAuthority.entries_by_term(params[:model], params[:term], s) rescue []
     end
-    render :json=>hits
+    render json: hits
   end
 end

data/app/controllers/batch_controller.rb

@@ -4,24 +4,24 @@ class BatchController < ApplicationController
   layout "sufia-one-column"
 
   before_filter :has_access?
-  prepend_before_filter :normalize_identifier, :only=>[:edit, :show, :update, :destroy]
+  prepend_before_filter :normalize_identifier, only: [:edit, :show, :update, :destroy]
 
   def edit
     @batch =  Batch.find_or_create(params[:id])
     @generic_file = GenericFile.new
     @generic_file.creator = current_user.name
-    @generic_file.title =  @batch.generic_files.map(&:label)
+    @generic_file.title = @batch.generic_files.map(&:label)
     @generic_file.initialize_fields
   end
 
   def update
     authenticate_user!
-    @batch =  Batch.find_or_create(params[:id])
+    @batch = Batch.find_or_create(params[:id])
     @batch.status="processing"
     @batch.save
     Sufia.queue.push(BatchUpdateJob.new(current_user.user_key, params))
     flash[:notice] = 'Your files are being processed by ' + t('sufia.product_name') + ' in the background. The metadata and access controls you specified are being applied. Files will be marked <span class="label label-important" title="Private">Private</span> until this process is complete (shouldn\'t take too long, hang in there!). You may need to refresh your dashboard to see these updates.'
-    redirect_to sufia.dashboard_index_path
+    redirect_to sufia.dashboard_files_path
   end
 
   protected

data/app/controllers/collections_controller.rb

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+class CollectionsController < ApplicationController
+  include Hydra::CollectionsControllerBehavior
+  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
+  before_filter :initialize_fields_for_edit, only: [:edit, :new]
+  CollectionsController.solr_search_params_logic += [:add_access_controls_to_solr_params]
+
+  layout "sufia-one-column"
+
+  protected 
+
+  def query_collection_members
+    flash[:notice]=nil if flash[:notice] == "Select something first"
+    query = params[:cq]
+
+    #merge in the user parameters and the attach the collection query
+    solr_params =  (params.symbolize_keys).merge(q: query)
+
+    # run the solr query to find the collections
+    (@response, @member_docs) = get_search_results(solr_params)
+  end
+
+  def after_destroy(id)
+    respond_to do |format|
+      format.html { redirect_to sufia.dashboard_collections_path, notice: 'Collection was successfully deleted.' }
+      format.json { render json: {id: id}, status: :destroyed, location: @collection }
+    end
+  end
+  
+  def initialize_fields_for_edit
+    @collection.initialize_fields
+  end
+
+  def _prefixes
+    @_prefixes ||= super + ['catalog']
+  end
+
+end

data/{lib → app/controllers/concerns}/sufia/batch_edits_controller_behavior.rb

@@ -40,7 +40,7 @@ module Sufia
     end
 
     def after_update
-      redirect_to sufia.dashboard_index_path unless request.xhr?
+      redirect_to sufia.dashboard_files_path unless request.xhr?
     end
 
     def update_document(obj)

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

@@ -5,52 +5,7 @@ module Sufia
       self.solr_search_params_logic += [:only_generic_files]
     end
 
-    def index
-      setup_front_page unless has_search_parameters? 
-      super
-    end
-
     protected
-      def setup_front_page
-        @featured_researcher = ContentBlock.find_or_create_by(name: 'featured_researcher')
-        @featured_work_list = FeaturedWorkList.new
-        recent
-        recent_me # also grab my recent docs too
-      end
-
-      def recent
-        if user_signed_in?
-          # grab other people's documents
-          (_, @recent_documents) = get_search_results(:q =>filter_not_mine,
-                                            :sort=>sort_field, :rows=>4)
-        else
-          # grab any documents we do not know who you are
-          (_, @recent_documents) = get_search_results(:q =>'', :sort=>sort_field, :rows=>4)
-        end
-      end
-
-      def recent_me
-        if user_signed_in?
-          (_, @recent_user_documents) = get_search_results(:q =>filter_mine,
-                                            :sort=>sort_field, :rows=>4)
-        end
-      end
-
-      def filter_not_mine
-        "{!lucene q.op=AND df=#{depositor}}-#{current_user.user_key}"
-      end
-
-      def filter_mine
-        "{!lucene q.op=AND df=#{depositor}}#{current_user.user_key}"
-      end
-
-      def depositor
-        Solrizer.solr_name('depositor', :stored_searchable, type: :string)
-      end
-
-      def sort_field
-        "#{Solrizer.solr_name('system_create', :sortable)} desc"
-      end
 
       # Limits search results just to GenericFiles
       # @param solr_parameters the current solr parameters
@@ -60,5 +15,14 @@ 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/{lib → app/controllers/concerns}/sufia/controller.rb

@@ -1,7 +1,7 @@
 module Sufia::Controller
   extend ActiveSupport::Concern
 
-  included do 
+  included do
     # Adds Hydra behaviors into the application controller
     include Hydra::Controller::ControllerBehavior
 
@@ -14,40 +14,31 @@ module Sufia::Controller
 
   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
+    render template: '/error/404', layout: "error", formats: [:html], status: 404
   end
 
   def render_500(exception)
     logger.error("Rendering 500 page due to exception: #{exception.inspect} - #{exception.backtrace if exception.respond_to? :backtrace}")
-    render :template => '/error/500', :layout => "error", :formats => [:html], :status => 500
+    render template: '/error/500', layout: "error", formats: [:html], status: 500
   end
 
   def render_single_use_error(exception)
     logger.error("Rendering PAGE due to exception: #{exception.inspect} - #{exception.backtrace if exception.respond_to? :backtrace}")
-    render :template => '/error/single_use_error', :layout => "error", :formats => [:html], :status => 404
+    render template: '/error/single_use_error', layout: "error", formats: [:html], status: 404
   end
 
   def notifications_number
-    @notify_number=0
-    @batches=[]
+    @notify_number = 0
+    @batches = []
     return if action_name == "index" && controller_name == "mailbox"
-    if user_signed_in? 
-      @notify_number= current_user.mailbox.inbox(:unread => true).count
-      @batches=current_user.mailbox.inbox.map {|msg| msg.last_message.body[/<span class="batchid ui-helper-hidden">(.*)<\/span>The file(.*)/,1]}.select{|val| !val.blank?}
+    if user_signed_in?
+      @notify_number = current_user.mailbox.inbox(unread: true).count
+      @batches = current_user.mailbox.inbox.map { |msg| msg.last_message.body[/<span class="batchid ui-helper-hidden">(.*)<\/span>The file(.*)/,1] }.select{ |val| !val.blank? }
     end
   end
-  
+
   def search_layout
-    if has_search_parameters? 
-      "sufia-two-column"
-    else
-      "homepage"
-    end
-  end
-  
-  # This repeats has_search_parameters? method from Blacklight::CatalogHelperBehavior 
-  def has_search_parameters?
-    !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
+    "sufia-two-column"
   end
 
   protected
@@ -56,5 +47,4 @@ module Sufia::Controller
   def has_access?
     true
   end
-
 end