sufia 7.0.0.beta1 → 7.0.0.beta2

data/app/services/sufia/statistics/system_stats.rb

@@ -0,0 +1,61 @@
+module Sufia
+  module Statistics
+    # A class that retrieves system level statistics about the system
+    # TODO: this class could be refactored into several classes.
+    #
+    # @attr_reader [Integer] limit      limits the results returned from top_depositors and top_formats
+    #                             Default is 5, maximum is 20, minimum is 5
+    # @attr_reader [Time] start_date Filters the statistics returned by the class to after the start date
+    #                             nil means no filter
+    # @attr_reader [Time] end_date   Filters the statistics returned by the class to before end date
+    #                             nil means today
+    class SystemStats
+      attr_reader :limit, :start_date, :end_date
+
+      # @param [Fixnum] limit_records limits the results returned from top_depositors and top_formats. Maximum is 20, minimum is 5
+      # @param [Time] start_date Filters the statistics returned by the class to after this date. nil means no filter
+      # @param [Time] end_date Filters the statistics returned by the class to before this date. nil means today
+      def initialize(limit_records = 5, start_date = nil, end_date = nil)
+        @limit = validate_limit(limit_records)
+        @start_date = start_date
+        @end_date = end_date
+      end
+
+      # returns a list (of size limit) of system users (depositors) that have the most deposits in the system
+      # @return [Hash] a hash with the user name as the key and the number of deposits as the value
+      #    { 'cam156' => 25, 'hjc14' => 24 ... }
+      def top_depositors
+        TermQuery.new(limit).results(depositor_field)
+      end
+
+      delegate :depositor_field, to: DepositSearchBuilder
+
+      # returns [Array<user>] a list (of size limit) of users most recently registered with the system
+      #
+      def recent_users
+        # no dates return the top few based on limit
+        return ::User.order('created_at DESC').limit(limit) if start_date.blank?
+
+        ::User.recent_users start_date, end_date
+      end
+
+      # returns [Number] the number of currently registered users
+      #
+      def users_count
+        ::User.count
+      end
+
+      private
+
+        def validate_limit(count)
+          if count.blank? || count < 5
+            5
+          elsif count > 20
+            20
+          else
+            count
+          end
+        end
+    end
+  end
+end

data/app/services/sufia/statistics/term_query.rb

@@ -0,0 +1,65 @@
+module Sufia
+  module Statistics
+    # An abstract class for running a query against the Solr terms component
+    # you must implement `index_key` in the concrete class.
+    #
+    # WARNING: you must use a term that isn't parsed (i.e. use _sim instead of _tesim)
+    class TermQuery
+      def initialize(limit = 5)
+        @limit = limit
+      end
+
+      def query
+        term = index_key
+        # Grab JSON response (looks like {"terms": {"depositor_tesim": {"mjg36": 3}}} for depositor)
+        json = solr_connection.get 'terms', params: { 'terms.fl' => term,
+                                                      'terms.sort' => 'count',
+                                                      'terms.limit' => @limit,
+                                                      wt: 'json',
+                                                      'json.nl' => 'map',
+                                                      omitHeader: 'true' }
+        unless json
+          Rails.logger.error "Unable to reach TermsComponent via Solr connection. Is it enabled in your solr config?"
+          return []
+        end
+
+        Result.build(json['terms'][term])
+      end
+
+      class Result
+        # @param [Array<Array>] rows list of of tuples (label, value)
+        def self.build(rows)
+          rows.map { |row| Result.new(*row) }
+        end
+
+        def initialize(label, value)
+          @data = { label: label, data: value }
+        end
+
+        def label
+          @data[:label]
+        end
+
+        def value
+          @data[:data]
+        end
+
+        # This enables hash equivalence
+        def ==(other)
+          other == @data
+        end
+
+        # Allows us to create a Flot charts pie-graph
+        def as_json(opts)
+          @data.as_json(opts)
+        end
+      end
+
+      private
+
+        def solr_connection
+          ActiveFedora::SolrService.instance.conn
+        end
+    end
+  end
+end

data/app/services/sufia/statistics/works/by_depositor.rb

@@ -0,0 +1,13 @@
+module Sufia
+  module Statistics
+    module Works
+      class ByDepositor < Statistics::TermQuery
+        private
+
+          def index_key
+            DepositSearchBuilder.depositor_field
+          end
+      end
+    end
+  end
+end

data/app/services/sufia/statistics/works/by_resource_type.rb

@@ -0,0 +1,13 @@
+module Sufia
+  module Statistics
+    module Works
+      class ByResourceType < Statistics::TermQuery
+        private
+
+          def index_key
+            Solrizer.solr_name("resource_type", :facetable)
+          end
+      end
+    end
+  end
+end

data/app/services/sufia/statistics/works/count.rb

@@ -0,0 +1,49 @@
+module Sufia
+  module Statistics
+    module Works
+      class Count
+        attr_reader :start_date, :end_date
+
+        # @param [Time] start_date Filters the statistics returned by the class to after this date. nil means no filter
+        # @param [Time] end_date Filters the statistics returned by the class to before this date. nil means today
+        def initialize(start_date = nil, end_date = nil)
+          @start_date = start_date
+          @end_date = end_date
+        end
+
+        # Retrieves the count of works in the system filtered by the start_date and end_date if present
+        #
+        # @return [Hash] A hash with the total files by permission for the system
+        # @option [Number] :total Total number of files without regard to permissions
+        # @option [Number] :public Total number of files that have public permissions
+        # @option [Number] :registered Total number of files that have registered (logged in) permissions
+        # @option [Number] :private Total number of files that have private permissions
+        def by_permission
+          return by_date_and_permission if start_date
+
+          works_count = {}
+          works_count[:total] = query_service.count
+          works_count[:public] = query_service.where_public.count
+          works_count[:registered] = query_service.where_registered.count
+          works_count[:private] = works_count[:total] - (works_count[:registered] + works_count[:public])
+          works_count
+        end
+
+        private
+
+          def query_service
+            @query_service ||= Sufia::QueryService.new
+          end
+
+          def by_date_and_permission
+            works_count = {}
+            works_count[:total] = query_service.find_by_date_created(start_date, end_date).count
+            works_count[:public] = query_service.find_public_in_date_range(start_date, end_date).count
+            works_count[:registered] = query_service.find_registered_in_date_range(start_date, end_date).count
+            works_count[:private] = works_count[:total] - (works_count[:registered] + works_count[:public])
+            works_count
+          end
+      end
+    end
+  end
+end

data/app/services/sufia/statistics/works/over_time.rb

@@ -0,0 +1,13 @@
+module Sufia
+  module Statistics
+    module Works
+      class OverTime < Statistics::OverTime
+        private
+
+          def relation
+            CurationConcerns::WorkRelation.new
+          end
+      end
+    end
+  end
+end

data/app/views/admin/stats/_stats_by_date.html.erb

@@ -3,6 +3,6 @@
   The data is unfiltered unless the date form has been filled in. Start date is required and the default end is now.
 </p>
 <%= render "admin/stats/date_form" %>
-<%= render "admin/stats/files" %>
+<%= render "admin/stats/works" %>
 <%= render "admin/stats/new_users" %>
 <%= render "admin/stats/deposits" %>

data/app/views/admin/stats/_top_data.html.erb

@@ -8,17 +8,17 @@
 
 <h3>Top File Formats (top <%= @presenter.top_formats.count %>)</h3>
 <ul>
-  <% @presenter.top_formats.each do |k, v| %>
-    <li><%= k %> <span class="count">(<%= v %>)</span></li>
+  <% @presenter.top_formats.each do |fmt| %>
+    <li><%= fmt.label %> <span class="count">(<%= fmt.value %>)</span></li>
   <% end %>
 </ul>
 
 <br/>
 <h3>Most Active Users (top <%= @presenter.active_users.count %>)</h3>
 <ul>
-  <% @presenter.active_users.each do |k, v| %>
+  <% @presenter.active_users.each do |user| %>
     <li>
-      <%= link_to_profile(k) %> <span class="count">(<%= v %>)</span>
+      <%= link_to_profile(user.label) %> <span class="count">(<%= user.value %>)</span>
     </li>
   <% end %>
 </ul>

data/app/views/admin/stats/_works.html.erb

@@ -0,0 +1,8 @@
+<h3>Work Statistics (<%= @presenter.date_filter_string %>)</h3>
+<h4>Total Works: <%= @presenter.works_count[:total] %> </h4>
+<h4>Totals by Visibility</h4>
+<ul>
+  <li>Open Access <span class="count">(<%= @presenter.works_count[:public] %>)</span></li>
+  <li><%= t("sufia.admin.stats.registered") %> <span class="count">(<%= @presenter.works_count[:registered] %>)</span></li>
+  <li>Private <span class="count">(<%= @presenter.works_count[:private] %>)</span></li>
+</ul>

data/app/views/collections/_form.html.erb

@@ -1,6 +1,6 @@
 <%= simple_form_for @form, html: { class: 'editor' } do |f| %>
   <div id="descriptions_display">
-    <h2 class="non lower">Descriptions <small class="pull-right"><span class="error">*</span> indicates required fields</small> </h2>
+    <h2 class="non lower">Descriptions</h2>
     <% f.object.rendered_terms.each do |term| %>
       <%= render_edit_field_partial term, f: f %>
     <% end %>

data/app/views/curation_concerns/base/_attribute_rows.html.erb

@@ -1,11 +1,11 @@
-<%= presenter.attribute_to_html(:creator, catalog_search_link: true ) %>
-<%= presenter.attribute_to_html(:contributor, label: 'Contributors', catalog_search_link: true) %>
-<%= presenter.attribute_to_html(:subject, catalog_search_link: true) %>
-<%= presenter.attribute_to_html(:publisher) %>
-<%= presenter.attribute_to_html(:language) %>
-<%= presenter.attribute_to_html(:identifier) %>
-<%= presenter.attribute_to_html(:keyword) %>
-<%= presenter.attribute_to_html(:date_created) %>
-<%= presenter.attribute_to_html(:based_near) %>
+<%= presenter.attribute_to_html(:creator, render_as: :faceted ) %>
+<%= presenter.attribute_to_html(:contributor, label: 'Contributors', render_as: :faceted) %>
+<%= presenter.attribute_to_html(:subject, render_as: :faceted ) %>
+<%= presenter.attribute_to_html(:publisher, render_as: :faceted ) %>
+<%= presenter.attribute_to_html(:language, render_as: :faceted ) %>
+<%= presenter.attribute_to_html(:identifier, render_as: :linked, search_field: 'identifier_tesim') %>
+<%= presenter.attribute_to_html(:keyword, render_as: :faceted ) %>
+<%= presenter.attribute_to_html(:date_created, render_as: :linked, search_field: 'date_created_tesim' ) %>
+<%= presenter.attribute_to_html(:based_near, render_as: :faceted ) %>
 <%= presenter.attribute_to_html(:related_url) %>
-<%= presenter.attribute_to_html(:resource_type) %>
+<%= presenter.attribute_to_html(:resource_type, render_as: :faceted ) %>

data/app/views/curation_concerns/base/_metadata.html.erb

@@ -7,6 +7,6 @@
     <%= render 'attribute_rows', presenter: presenter %>
     <%= presenter.attribute_to_html(:embargo_release_date) %>
     <%= presenter.attribute_to_html(:lease_expiration_date) %>
-    <%= presenter.attribute_to_html(:rights) %>
+    <%= presenter.attribute_to_html(:rights, render_as: :rights) %>
   </tbody>
 </table>

data/app/views/curation_concerns/base/_relationships.html.erb

@@ -11,7 +11,7 @@
             <% collection_presenters.each do |collection| %>
               <ul class="tabular">
                 <li class='attribute title'>
-                  <%= link_to collection.title, main_app.collection_path(collection) %>
+                  <%= link_to collection.to_s, main_app.collection_path(collection) %>
                 </li>
               </ul>
             <% end %>

data/app/views/curation_concerns/file_sets/_descriptions.html.erb

@@ -1,7 +1,7 @@
 <div id="descriptions_display" class="tab-pane active">
   <%= simple_form_for [sufia, @form], html: { multipart: true } do |f| %>
     <%= hidden_field_tag('redirect_tab', 'descriptions') %>
-    <h1>Descriptions <span class="pull-right required"><abbr title="required">*</abbr> indicates required fields</span></h1>
+    <h1>Description</h1>
       <% f.object.terms.each do |term| %>
         <%= render_edit_field_partial(term, f: f) %>
       <% end %>

data/app/views/error/404.html.erb

@@ -1,19 +1,8 @@
-<!DOCTYPE html>
-<html lang="<%= t("sufia.document_language") %>">
-  <head>
-    <title>Not found</title>
-  </head>
-  <body>
-    <div class="columns two-a">
-      <div class="column second">
-        <h1>Not found</h1>
-        <p>
-          <%= application_name %> could not locate the requested resource.  We
-          apologize for the inconvenience. You might be interested in using
-          <a href="/contact/">the contact form</a> to report the
-          error, or <a href="/help/">the help page</a> for looking up
-          solutions.
-        </p>
-      </div>
-  </body>
-</html>
+<h1>Not found</h1>
+<p>
+  <%= application_name %> could not locate the requested resource.  We
+  apologize for the inconvenience. You might be interested in using
+  <a href="/contact/">the contact form</a> to report the
+  error, or <a href="/help/">the help page</a> for looking up
+  solutions.
+</p>

data/app/views/layouts/error.html.erb

@@ -10,11 +10,11 @@
     <!-- application js -->
     <%= javascript_include_tag 'application' %>
 
-    <%= render partial: '/ga', formats: [:html] %>
+    <%= render '/ga' %>
   </head>
 
 <body>
-  <%= render '/masthead', formats: [:html] %>
+  <%= render '/masthead' %>
   <div id="content-wrapper" class="container-fluid">
     <div class="row">
         <div class="col-sm-8 col-md-8 col-lg-8">
@@ -22,6 +22,6 @@
         </div>
     </div><!-- /.row -->
   </div><!-- /#content-wrapper -->
-  <%= render '/footer' %>
+  <%= render 'shared/footer' %>
 </body>
 </html>

data/app/views/layouts/homepage.html.erb

@@ -11,7 +11,7 @@
 <div id="content-wrapper" class="container-fluid">
   <%= yield %>
 </div><!-- /#content-wrapper -->
-<%= render partial: '/footer' %>
+<%= render 'shared/footer' %>
 <%= render 'shared/ajax_modal' %>
 </body>
 </html>

data/app/views/layouts/sufia-dashboard.html.erb

@@ -28,7 +28,7 @@
   </div>
 </div>
 
-<%= render '/footer' %>
+<%= render 'shared/footer' %>
 <%= render 'shared/ajax_modal' %>
 </body>
 </html>

data/app/views/layouts/sufia-one-column.html.erb

@@ -26,7 +26,7 @@
     </div>
   </div><!-- /.row -->
 </div><!-- /#content-wrapper -->
-<%= render '/footer' %>
+<%= render 'shared/footer' %>
 <%= render 'shared/ajax_modal' %>
 </body>
 </html>

data/app/views/{_footer.html.erb → shared/_footer.html.erb}

@@ -1,4 +1,4 @@
-<footer id="footer" class="navbar navbar-inverse">
+<footer class="navbar navbar-inverse">
   <div class="container-fluid">
     <div class="navbar-text text-left">
         <p>A service of <a href="http://projecthydra.org/" class="navbar-link" target="_blank">Project Hydra</a>.</p>

data/app/views/stats/file.html.erb

@@ -1,5 +1,4 @@
 <!-- Adapted from jquery-flot examples https://github.com/flot/flot/blob/master/examples/visitors/index.html -->
-<!--[if lte IE 8]><%= javascript_include_tag 'excanvas' %><![endif]-->
 <%= javascript_tag do %>
   var stats = <%= @stats.to_flot.to_json.html_safe %>;
 <% end %>

data/app/views/stats/work.html.erb

@@ -1,6 +1,4 @@
 <!-- Adapted from jquery-flot examples https://github.com/flot/flot/blob/master/examples/visitors/index.html -->
-<!--[if lte IE 8]><%= javascript_include_tag 'excanvas' %><![endif]-->
-
 <%= javascript_tag do %>
   var stats = <%= @stats.to_flot.to_json.html_safe %>;
 <% end %>

data/lib/generators/sufia/install_generator.rb

@@ -103,6 +103,12 @@ module Sufia
       generate "sufia:proxies"
     end
 
+    def solr_config
+      say_status("info", "GENERATING SUFIA FULL-TEXT", :blue)
+      source = File.expand_path("../../../../solr/config/solrconfig.xml", __FILE__)
+      copy_file source, 'solr/conf/solrconfig.xml', force: true
+    end
+
     # Sets up cached usage stats
     def cached_stats
       generate 'sufia:cached_stats'

data/lib/sufia/engine.rb

@@ -5,6 +5,7 @@ module Sufia
     # These gems must be required outside of an initializer or it doesn't get loaded.
     require 'breadcrumbs_on_rails'
     require 'jquery-ui-rails'
+    require 'flot-rails'
     require 'zeroclipboard-rails'
 
     config.autoload_paths += %W(