fcrepo_admin 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e26f1848c179673df8ef4efefa687c718365bcb
-  data.tar.gz: ba0010feb90c17d3853f647f0f9a0cd1b2ea8e30
+  metadata.gz: 846f4e519831674baf94f1db10f8c40196136d58
+  data.tar.gz: 643de27ff77646f00ab3fde0b5d73e3a79da4157
 SHA512:
-  metadata.gz: 7a47b722727bc7eb6f4518a425fc050752585b9ec1493901ef7ee84db04a9c7fc9f30d715841180a53aa4163dc7c20d7864f95b9748b337ef8db5e2a881b88f1
-  data.tar.gz: 3c5218ad09ed98edae213f2fa179b7b92f1c09c9c25e106d4f83b2a83b137923318ab35886929dc0c53a42c9834da8703bf010c32ac6bc0cdc3eab3f9e6428f4
+  metadata.gz: c2f5c11df23df0a4fc79ee771e95fa1a3537189d7c6532cc32feb11554524815b191a484ff0bb5e5b252a7ae3e61c3fc4531553d7cdf8e0890e26cbdf24b6b06
+  data.tar.gz: 045a7e428c0932f767175815aea618456879a57dbd7453894bf3c6e60bca27b041bf0f0a7ecd83e600c5618a597a9ff338995a1c0f71c66c3432e6126188969a

data/HISTORY.md

@@ -1,18 +1,23 @@
+#### 0.5.4 (2013-05-24)
+
+* Changed config setting `associated_objects_sort_param` (v0.5.3) to `association_collection_query_sort_param`.
+* Changed config setting `associated_objects_per_page` (v0.5.1) to `association_show_docs_per_page`.
+
 #### 0.5.3 (2013-05-23)
 
-* Added configuration setting `associated_object_sort_param` to specify Solr query sort clause for retrieving associated objects. Default is `nil`, meaning that no sort clause is used.
+* Added configuration setting `associated_objects_sort_param` to specify Solr query sort clause for retrieving associated objects. Default is `nil`, meaning that no sort clause is used.
 
 #### 0.5.2 (2013-05-22)
 
 * Fixed association show view pagination by working around Kaminari.
 * Object XML (FOXML) accessible from object context nav.
-* Catalog show fields and show document actions displayed in object show view (summary).
+* Catalog show document actions displayed in object show view (summary).
 
 #### 0.5.1 (2013-05-21)
 
 * Association show view paginated (Fixes #18). 
 * Association show view uses blacklight document list rendering.
-* Object show view loads Solr document for object and incorporates Blacklight document show fields.
+* Object show action loads Solr document for object and show view incorporates Blacklight document show fields.
 
 ### 0.5.0 (2013-05-17)
 

data/README.md

@@ -65,10 +65,12 @@ instead of the catalog show view, create `app/helpers/blacklight_helper.rb` with
 module BlacklightHelper
   include Blacklight::BlacklightHelperBehavior  # Default Blacklight behaviors
   include FcrepoAdmin::Helpers::BlacklightHelperBehavior # fcrepo_admin overrides
-  # additional customizations here, if any
 end
 ```
 
+If you have an existing custom blacklight helper module, simply include `FcrepoAdmin::Helpers::BlacklightHelperBehavior`
+*after* `Blacklight::BlacklightHelperBehavior`.
+
 **Add audit trail support** (optional)
 
 To enable access to the Fedora audit trail data through the fcrepo_admin UI, include the 
@@ -178,6 +180,22 @@ class Ability
 end
 ```  
 
+#### Associations
+
+Due to issues with Rails partials and relative paths, in order to use Blacklight's default document index view behavior
+on the associations show page and avoid missing template errors, fcrepo_admin provides a custom document partial at 
+`fcrepo_admin/catalog/document` that renders the partial at `catalog/document`, for which Blacklight provides a default.
+If you have a custom document partial at a different path that you want to use for the document list on the associations 
+show page, you *may* be able to simply copy it to `app/views/fcrepo_admin/catalog/document`, or you might try putting 
+this content in that file:
+
+```
+<%= render :partial => 'path/to/my/document', :locals => { :document => document, :document_counter => document_counter } %>
+```
+
+replacing the partial path as appropriate.  If anyone has a better solution or knows of a way to avoid providing the 
+document partial in fcrepo_admin admin, please submit a pull request.
+
 #### Read-only mode
 
 To suppress mutating behaviors (i.e, routes, nav items, etc.) regardless of user permissions, 
@@ -192,6 +210,34 @@ FcrepoAdmin.read_only = true
 An effort has been made to support i18n on headings, menus, etc.  See https://github.com/projecthydra/fcrepo-admin/blob/master/config/locales/fcrepo_admin.en.yml
 for the keys and consult the Rails documentation on how to provide your own translations or alternate text values.
 
+### Known Issues
+
+#### Pagination
+
+Kaminari as of version 0.14.1 does not support namespace-prefixed routes, which causes a routing error in Blacklight's 
+`paginate_rsolr_response` helper when called from within fcrepo_admin.  In place of `paginate_rsolr_response` fcrepo_admin
+use its own helper `safe_paginate_rsolr_response` which provides a basic set of pagination links without using Kaminari.  
+
+There is (as of 2013-05-24) an outstanding Kaminari pull request which resolves the routing issue (https://github.com/amatsuda/kaminari/pull/322).
+You can implement this solution by adding to your application's Gemfile:
+
+```
+gem 'kaminari', github: 'harai/kaminari', branch: 'route_prefix_prototype'
+```
+
+and then override the `safe_paginate_rsolr_response` helper with something like:
+
+```ruby
+def safe_paginate_rsolr_response(response)
+  paginate_rsolr_response response, :outer_window => 2, :theme => 'blacklight', :route_set => fcrepo_admin
+end
+```
+
+the key part being the `:route_set` option -- note that the value is not a string -- with gets passed through to Kaminari.
+
+If Kaminari is suitably patched in the future, we will likely remove `safe_paginate_rsolr_response` in favor of
+`paginate_rsolr_response`.
+
 ### Contributing
 
 * Consider first posting to hydra-tech@googlegroups.com with a question or bug report, or submit an issue

data/app/controllers/fcrepo_admin/associations_controller.rb

@@ -15,7 +15,7 @@ module FcrepoAdmin
       if @association.nil?
         render :text => "Association not found", :status => 404
       elsif @association.collection?
-        get_collection_from_solr
+        @response, @documents = get_collection_from_solr
       else 
         # This shouldn't normally happen b/c UI links directly to target object view in this case
         # but we'll handle it gracefully anyway.
@@ -31,8 +31,8 @@ module FcrepoAdmin
     protected
 
     def get_collection_from_solr
-      @response = solr_response_for_raw_result(get_collection_query_result)
-      @documents = solr_documents_for_response(@response)
+      solr_response = solr_response_for_raw_result(get_collection_query_result)
+      [solr_response, solr_documents_for_response(solr_response)]
     end
 
     def get_collection_query_result
@@ -41,11 +41,11 @@ module FcrepoAdmin
 
     def collection_query_args
       page = params[:page].blank? ? 1 : params[:page].to_i
-      rows = FcrepoAdmin.associated_objects_per_page
+      rows = FcrepoAdmin.association_show_docs_per_page
       start = (page - 1) * rows
       args = {raw: true, start: start, rows: rows}
-      if FcrepoAdmin.associated_objects_sort_param
-        args[:sort] = FcrepoAdmin.associated_objects_sort_param
+      if FcrepoAdmin.association_collection_query_sort_param
+        args[:sort] = FcrepoAdmin.association_collection_query_sort_param
       end
       apply_gated_discovery(args, nil) # add args to enforce Hydra access controls
       args

data/app/views/fcrepo_admin/associations/show.html.erb

@@ -1,17 +1,13 @@
 <h3><%= t("fcrepo_admin.object.associations.title") %>: <%= @association.name %></h3>
 
 <% if @response.total > 0 %>
-  <% if @response.total > associated_objects_per_page %>
-    <div class="pagination">
-	  <%= render_pagination_info @response %>
-	</div>
-  <% end %>
-  <%= render :partial => 'catalog/document_list', :locals => {:documents => @documents} %>
-  <% if @response.total > associated_objects_per_page %>
-    <div class="pagination">
-      <%= render :partial => 'pagination', :locals => {:pagination_info => paginate_params(@response)} %>
-    </div>
-  <% end %>
+  <div class="pagination">
+	<%= render_pagination_info @response %>
+  </div>
+  <%= render_document_index @documents %>
+  <div class="pagination">
+	<%= safe_paginate_rsolr_response @response %>
+  </div>
 <% else %>
   <div class="alert">
 	No associated objects found.

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

@@ -1,4 +1 @@
-<div class="document <%= render_document_class document %>">
-  <%= render :partial => 'catalog/document_header', :locals => { :document => document, :document_counter => document_counter } %>
-  <%= render :partial => 'catalog/index_default', :locals => {:document => document} %>
-</div>
+<%= render :partial => 'catalog/document', :locals => { :document => document, :document_counter => document_counter } %>

data/app/views/fcrepo_admin/datastreams/history.html.erb

@@ -2,9 +2,9 @@
 <table class="table table-condensed table-bordered" style="width: auto">
   <thead>
 	<tr>
-	  <th scope="col"><%= t("fcrepo_admin.datastream.profile.dsVersionID") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.datastream.profile.keys.dsVersionID") %></th>
 	  <% datastream_history_columns.each do |col| %>
-	  <th scope="col"><%= t("fcrepo_admin.datastream.profile.#{col}") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.datastream.profile.keys.#{col}") %></th>
 	  <% end %>
 	</tr>
   </thead>

data/app/views/fcrepo_admin/pagination/_links.html.erb

@@ -0,0 +1,10 @@
+<% pagination_info = paginate_params(response) %>
+<div class="pagination">
+  <ul>
+	<li class="<% if pagination_info.current_page == 1 %>disabled<% end %>"><a href="?page=<%= pagination_info.current_page - 1 %>">&laquo;</a></li>
+	<% (1..pagination_info.num_pages).each do |n| %>
+    <li class="<% if n == pagination_info.current_page %>active<% end %>"><a href="?page=<%= n %>"><%= n %></a></li>
+	<% end %>
+	<li class="<% if pagination_info.current_page == pagination_info.num_pages %>disabled<% end %>"><a href="?page=<%= pagination_info.current_page + 1 %>">&raquo;</a></li>
+  </ul>
+</div>

data/lib/fcrepo_admin/configurable.rb

@@ -47,13 +47,13 @@ module FcrepoAdmin::Configurable
     mattr_accessor :object_properties
     self.object_properties = [:label, :state, :create_date, :modified_date, :owner_id]
     
-    # Number of objects to display per page on associations show view
-    mattr_accessor :associated_objects_per_page
-    self.associated_objects_per_page = 10
+    # Number of documents to display per page on associations show view
+    mattr_accessor :association_show_docs_per_page
+    self.association_show_docs_per_page = 10
 
-    # Solr sort param added to association collection query
-    mattr_accessor :associated_objects_sort_param
-    self.associated_objects_sort_param = nil
+    # Solr sort param added to query for association target documents when target is a collection
+    mattr_accessor :association_collection_query_sort_param
+    self.association_collection_query_sort_param = nil
   end
 
 end

data/lib/fcrepo_admin/helpers/associations_helper_behavior.rb

@@ -4,7 +4,8 @@ module FcrepoAdmin::Helpers
     def link_to_association_target(association)
       target = @object.send(association.name)
       if association.collection?
-        link_to_unless target.size == 0, "#{association.class_name} (#{target.size})", fcrepo_admin.object_association_path(@object, association.name) do |text|
+        size = target.size
+        link_to_unless size == 0, "#{association.class_name} (#{size})", fcrepo_admin.object_association_path(@object, association.name) do |text|
           text
         end
       else # not a collection
@@ -16,8 +17,12 @@ module FcrepoAdmin::Helpers
       end
     end
 
-    def associated_objects_per_page
-      FcrepoAdmin.associated_objects_per_page
+    # We attempt to use Blacklight's #paginate_rsolr_response, but it causes a routing error 
+    # b/c Kaminari as of version 0.14.1 cannot handle namespace-prefixed routes.
+    # The fallback rendering bypasses Kaminari, but doesn't look so good on a large page set.
+    # See https://github.com/amatsuda/kaminari/pull/322.
+    def safe_paginate_rsolr_response(response)
+      render :partial => "fcrepo_admin/pagination/links", :locals => {:response => response}
     end
 
   end

data/lib/fcrepo_admin/version.rb

@@ -1,3 +1,3 @@
 module FcrepoAdmin
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fcrepo_admin
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - David Chandek-Stark
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hydra-head
@@ -250,11 +250,9 @@ files:
 - app/mailers/.gitkeep
 - app/models/.gitkeep
 - app/views/fcrepo_admin/associations/_associations.html.erb
-- app/views/fcrepo_admin/associations/_pagination.html.erb
 - app/views/fcrepo_admin/associations/index.html.erb
 - app/views/fcrepo_admin/associations/show.html.erb
 - app/views/fcrepo_admin/catalog/_document.html.erb
-- app/views/fcrepo_admin/catalog/_document_header.html.erb
 - app/views/fcrepo_admin/datastreams/_active_fedora.html.erb
 - app/views/fcrepo_admin/datastreams/_alert.html.erb
 - app/views/fcrepo_admin/datastreams/_content.html.erb
@@ -277,6 +275,7 @@ files:
 - app/views/fcrepo_admin/objects/audit_trail.html.erb
 - app/views/fcrepo_admin/objects/permissions.html.erb
 - app/views/fcrepo_admin/objects/show.html.erb
+- app/views/fcrepo_admin/pagination/_links.html.erb
 - app/views/fcrepo_admin/shared/_context_nav.html.erb
 - app/views/layouts/fcrepo_admin/datastreams.html.erb
 - app/views/layouts/fcrepo_admin/default.html.erb

data/app/views/fcrepo_admin/associations/_pagination.html.erb

@@ -1,7 +0,0 @@
-<ul>
-  <li class="<% if pagination_info.current_page == 1 %>disabled<% end %>"><a href="?page=<%= pagination_info.current_page - 1 %>">&laquo;</a></li>
-  <% (1..pagination_info.num_pages).each do |n| %>
-    <li class="<% if n == pagination_info.current_page %>active<% end %>"><a href="?page=<%= n %>"><%= n %></a></li>
-  <% end %>
-  <li class="<% if pagination_info.current_page == pagination_info.num_pages %>disabled<% end %>"><a href="?page=<%= pagination_info.current_page + 1 %>">&raquo;</a></li>
-</ul>

data/app/views/fcrepo_admin/catalog/_document_header.html.erb

@@ -1,7 +0,0 @@
-<% # header bar for doc items in index view -%>
-<div class="documentHeader clearfix">        
-  <% # main title container for doc partial view -%>
-  <h5 class="index_title"><%= t('blacklight.search.documents.counter', :counter => (document_counter + 1 + @response.params[:start].to_i)) %><%= link_to_document document, :label=>document_show_link_field(document), :counter => (document_counter + 1 + @response.params[:start].to_i) %></h5>
-  <% # bookmark functions for items/docs -%>
-  <%= render_index_doc_actions document, :wrapping_class => "documentFunctions span2" %>
-</div>