fcrepo_admin 0.3.5 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 037b085bbd970e56f0258962a525d716e7126de3
+  data.tar.gz: b5198489fc6a71de84f2ccd823d9f9b989aa4ea4
+SHA512:
+  metadata.gz: 58d1033182af3051b5115b6d812bcbf5f04a52ed082e2feb1f3deb47a1eaf9f14fd564bd0e4966aa2d0d6da40587d778cbe00341398edad8d596562a7fe5afe7
+  data.tar.gz: 0fa62de534dd7ce460a2dec042f3fd8e0c291443dc8a426d8c1c44fde9cc53195faea74c26cd2115a1e5db1d504d088c408d3d12adbe82e29458f5f36e9eaf80

data/HISTORY.rdoc

@@ -1,3 +1,9 @@
+=== 0.4.0
+
+* Feature: Display object's associations.
+* Require inclusion of CanCan action aliases in application's Ability class.
+* Tabbed object show view ("summary") replaced with separate views.
+
 === 0.3.5
 
 * Requires active-fedora 6.1.

data/README.rdoc

@@ -33,14 +33,27 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
 
   In config/routes.rb add this line:
 
-    mount FcrepoAdmin::Engine => '/admin', :as=> 'fcrepo_admin'
+    mount FcrepoAdmin::Engine => '/', :as=> 'fcrepo_admin'
 
-  You may replace <code>'/admin'</code> with any mount point (except perhaps <code>'/catalog'</code>), 
-  including <code>'/'</code>. All routes include <code>objects</code> as a subpath.
+  You may use any mount point (except perhaps <code>'/catalog'</code>).
+  All routes include <code>objects</code> as a subpath.
 
-* Add Javascript
+* Add CanCan action aliases (version >= 0.4.0)
+
+  In your Ability class (app/models/ability.rb) include the FcrepoAdmin::Ability module, for example:
+
+    class Ability
+      include Hydra::Ability
+      include Hydra::PolicyAwareAbility
+      include FcrepoAdmin::Ability
+    end
+
+  FcrepoAdmin::Ability defines action aliases for permissions which are enforced on (ActiveFedora::Base) objects.
+  If your application defines action aliases, please check FcrepoAdmin::Ability for conflicts as aliases are global.
+
+* Add Javascript (not required for version >= 0.4.0)
   
-  In app/assets/javascripts/application.js add this line: 
+  In app/assets/javascripts/application.js add:
 
     //= require bootstrap-tab
 
@@ -52,19 +65,23 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
     module BlacklightHelper
       include Blacklight::BlacklightHelperBehavior  # Default Blacklight behaviors
       include FcrepoAdmin::Helpers::BlacklightHelperBehavior # fcrepo_admin overrides
+      # additional customizations here, if any
     end
 
 * Add audit trail support (optional)
 
-  To enable access to the Fedora audit trail data through the fcrepo_admin UI, add your ActiveFedora models:
+  To enable access to the Fedora audit trail data through the fcrepo_admin UI, include the 
+  ActiveFedora::Auditable mixin in your ActiveFedora models:
 
     include ActiveFedora::Auditable
 
 === Overriding fcrepo_admin behaviors
 
-* Object views
+The following are examples of possible customizations.  This list is not necessarily exhaustive.
+
+* Helpers
 
-  Create app/helpers/fcrepo_admin/objects_helper.rb with this content:
+  Override objects helpers by creating app/helpers/fcrepo_admin/objects_helper.rb with this content:
 
     module FcrepoAdmin::ObjectsHelper
       include FcrepoAdmin::Helpers::ObjectsHelperBehavior
@@ -73,36 +90,32 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
 
   In particular you may want to override #object_title.
 
-  The contents of the object context navigation menu can be customized by overriding #object_context_nav_items.
-  It should return an array of [label, path] items suitable for use by link_to_unless_current:
-
-    <%= link_to_unless_current label, path %>
+  The contents of the object context navigation menu can be customized by overriding #object_context_nav_items, 
+  or by copying and modifying the partial fcrepo_admin/objects/context_nav_items.
 
-* Datastream views
-
-  The contents of the datastream context navigation menu can be customized by overriding #datastream_context_nav_items.
-  Create app/helpers/fcrepo_admin/datastreams_helper.rb with this content:
+  Override datastreams helpers by creating app/helpers/fcrepo_admin/datastreams_helper.rb with this content:
 
     module FcrepoAdmin::DatastreamsHelper
       include FcrepoAdmin::Helpers::DatastreamsHelperBehavior
       # override and/or add methods here
     end    
 
-  datastream_context_nav_items should return an array of [label, path] items suitable for use by link_to_unless_current:
-
-    <%= link_to_unless_current label, path %>
+  The contents of the datastream context navigation menu can be customized by overriding #datastream_context_nav_items,
+  or by copying and modifying the partial fcrepo_admin/datastreams/context_nav_items.
 
 * Controllers
 
   To override/extend the objects controller, create app/controllers/fcrepo_admin/objects_controller.rb:
 
     module FcrepoAdmin
-      class ObjectsController < ApplicationController
+      class ObjectsController < CatalogController
         include FcrepoAdmin::Controller::ObjectsControllerBehavior
         # add your customizations
       end
     end
 
+  NOTE: This controller subclasses CatalogController, not ApplicationController.
+
   To override/extend the datastreams controller, create app/controllers/fcrepo_admin/datastreams_controller.rb:
 
     module FcrepoAdmin
@@ -112,6 +125,15 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
       end
     end
 
+=== Contributing
+
+* Consider first posting to hydra-tech@googlegroups.com with a question or bug report, or submit an issue
+  to the Github issue tracker at https://github.com/projecthydra/fcrepo-admin/issues.
+* Fork the git repository, create a feature branch, make your changes, and submit a pull request.  
+  It is preferable for all changes to be made in one commit, if possible.
+
+Thanks!
+
 === License
 
 See the LICENSE file in the root directory of the project for copyright and license information.

data/app/controllers/fcrepo_admin/associations_controller.rb

@@ -0,0 +1,7 @@
+module FcrepoAdmin
+  # NOTE: This controller subclasses CatalogController, not ApplicationController
+  class AssociationsController < CatalogController
+    include FcrepoAdmin::Controller::CatalogControllerBehavior
+    include FcrepoAdmin::Controller::AssociationsControllerBehavior
+  end
+end

data/app/controllers/fcrepo_admin/objects_controller.rb

@@ -1,5 +1,6 @@
 module FcrepoAdmin
-  class ObjectsController < ApplicationController
+  class ObjectsController < CatalogController
+    include FcrepoAdmin::Controller::CatalogControllerBehavior
     include FcrepoAdmin::Controller::ObjectsControllerBehavior
   end
 end

data/app/helpers/fcrepo_admin/associations_helper.rb

@@ -0,0 +1,5 @@
+module FcrepoAdmin
+  module AssociationsHelper
+    include FcrepoAdmin::Helpers::AssociationsHelperBehavior
+  end
+end

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

@@ -0,0 +1,26 @@
+<h3><%= t("fcrepo_admin.object.associations.title") %></h3>
+<table class="table table-bordered table-condensed">
+  <thead>
+	<tr>
+	  <th scope="col"><%= t("fcrepo_admin.object.associations.header.macro") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.object.associations.header.name") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.object.associations.header.target") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.object.associations.header.class_name") %></th>
+	  <th scope="col"><%= t("fcrepo_admin.object.associations.header.property") %></th>
+	</tr>
+  </thead>
+  <tbody>
+	<% object.reflections.each_value do |association| %>
+	<tr>
+	  <td><%= association.macro %></td>
+	  <td><%= association.name %></td>
+	  <td><%= link_to_target association %></td>
+	  <td><%= association.class_name %></td>
+	  <td>
+		<%= association.options[:property] %><% if association.options[:inbound] %> (inbound)<% end %>
+	  </td>
+	</tr>
+	<% end %>
+  </tbody>
+</table>
+

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

@@ -0,0 +1 @@
+<%= render :partial => 'associations', :locals => {:object => @object} %>

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

@@ -0,0 +1,11 @@
+<h3><%= t("fcrepo_admin.object.associations.title") %>: <%= @association.name %></h3>
+
+<!-- <pre><%= @response %></pre> -->
+
+<% unless @documents.blank? %>
+  <%= render_document_index @documents %>
+<% else %>
+  <div class="alert">
+	No associated objects found.
+  </div>
+<% end %>

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

@@ -0,0 +1,6 @@
+<% # container for a single doc -%>
+<div class="document <%= render_document_class document %>">      
+  <%= render :partial => 'document_header', :locals => { :document => document, :document_counter => document_counter } %>
+  <%# main container for doc partial view -%>
+  <%= render_document_partial document, :index %>
+</div>

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

@@ -1,7 +1,8 @@
-<% if inline %>
+<h4>Content</h4>
+<% if ds_content_is_text? %>
   <pre class="prettyprint pre-scrollable"><%= datastream.content %></pre>
 <% else %>
-  <p>
+  <div class="alert">
     <%= t("fcrepo_admin.datastream.content_not_text") %>.
-  </p>
+  </div>
 <% end %>

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

@@ -0,0 +1,9 @@
+<div class="well">
+  <ul class="nav nav-list">
+	<li class="nav-header">
+      <%= datastream_context_nav_header %>
+	</li>
+	<%= datastream_context_nav_items %>
+  </ul>
+</div>
+

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

@@ -0,0 +1,21 @@
+<li>
+  <%= link_to_unless_current t("fcrepo_admin.datastream.nav.items.summary"), fcrepo_admin.object_datastream_path(object, datastream.dsid) %>
+</li>
+<% if ds_content_is_text? %>
+  <li>
+	<%= link_to_unless_current t("fcrepo_admin.datastream.nav.items.content"), fcrepo_admin.content_object_datastream_path(object, datastream.dsid) %>
+  </li>
+<% end %>
+<li>
+  <%= link_to_unless_current t("fcrepo_admin.datastream.nav.items.download"), fcrepo_admin.download_object_datastream_path(object, datastream.dsid) %>
+</li>
+<% if can_edit_datastream? && ds_content_is_editable? %>
+  <li>
+    <%= link_to_unless_current t("fcrepo_admin.datastream.nav.items.edit"), fcrepo_admin.edit_object_datastream_path(object, datastream.dsid) %>
+  </li>
+<% end %>
+<% if can_upload_datastream? %>
+  <li>
+	<%= link_to_unless_current t("fcrepo_admin.datastream.nav.items.upload"), fcrepo_admin.upload_object_datastream_path(object, datastream.dsid) %>
+  </li>
+<% end %>

data/app/views/fcrepo_admin/datastreams/{_datastreams.html → _datastreams.html.erb}

@@ -1,3 +1,4 @@
+<h3><%= t("fcrepo_admin.datastreams.title") %></h3>
 <table class="table table-bordered table-condensed">
   <thead>
     <tr>
@@ -8,12 +9,24 @@
     </tr>
   </thead>
   <tbody>
-    <% datastreams.reject { |dsid, ds| ds.profile.empty? }.each do |dsid, ds| %>
+    <% object.datastreams.each do |dsid, ds| %>
     <tr>
-	  <td><%= link_to dsid, fcrepo_admin.object_datastream_path(ds.pid, dsid) %></td>
+	  <td>
+		<%= 
+		   link_to_unless ds.profile.empty?, dsid, fcrepo_admin.object_datastream_path(ds.pid, dsid) do |name|
+		     name
+		   end
+		 %>
+      </td>
 	  <td><%= ds.profile["dsLabel"] %></td>
 	  <td><%= ds.profile["dsMIME"] %></td>
-	  <td><%= ds.profile["dsCreateDate"] %></td>
+	  <td>
+		<% unless ds.profile.empty? %>
+		  <%= ds.profile["dsCreateDate"] %>
+		<% else %>
+		  [<%= t("fcrepo_admin.datastreams.not_persisted") %>]
+		<% end %>
+	  </td>
     </tr>
     <% end %>
   </tbody>

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

@@ -1,10 +1,9 @@
-<div id="fcrepo-admin-dsprofile">
-  <table class="table table-bordered table-condensed table-striped">
-	<% datastream.profile.each do |key, value| %>
-	<tr>
-	  <th scope="row"><%= t("fcrepo_admin.datastream.profile.#{key}") %></th>
-	  <td><%= value.blank? ? " " : value %></td>
-	</tr>
-	<% end %>
-  </table>
-</div>
+<h4>Profile</h4>
+<table class="table table-condensed table-striped" style="width: auto">
+  <% datastream.profile.each do |key, value| %>
+  <tr>
+	<th scope="row"><%= t("fcrepo_admin.datastream.profile.#{key}") %></th>
+	<td><%= value.blank? ? " " : value %></td>
+  </tr>
+  <% end %>
+</table>

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

@@ -0,0 +1 @@
+<%= render :partial => 'content', :locals => {:datastream => @datastream} %>

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

@@ -1,4 +1 @@
-<h1><%= @object.pid %></h1>
-
-<h3><%= t("fcrepo_admin.datastreams.title") %></h3>
-<%= render :partial => 'datastreams', :locals => {:datastreams => @object.datastreams} %>
+<%= render :partial => 'datastreams', :locals => {:object => @object} %>

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

@@ -1,14 +1 @@
-<div class="tabbable">
-  <ul class="nav nav-tabs">
-    <li class="active"><a href="#tab1" data-toggle="tab"><%= t("fcrepo_admin.datastream.tabs.content") %></a></li>
-    <li><a href="#tab2" data-toggle="tab"><%= t("fcrepo_admin.datastream.tabs.profile") %></a></li>
-  </ul>
-  <div class="tab-content">
-    <div class="tab-pane active" id="tab1">
-	  <%= render :partial => 'content', :locals => {:datastream => @datastream, :inline => @inline} %>
-    </div>
-    <div class="tab-pane" id="tab2">
-	  <%= render :partial => 'profile', :locals => {:datastream => @datastream} %>
-    </div>
-  </div>
-</div>
+<%= render :partial => 'profile', :locals => {:datastream => @datastream} %>

data/app/views/fcrepo_admin/objects/_context_nav.html.erb

@@ -0,0 +1,9 @@
+<div class="well">
+  <ul class="nav nav-list">
+	<li class="nav-header">
+	  <%= object_context_nav_header %>
+	</li>
+	<%= object_context_nav_items %>
+  </ul>
+</div>
+

data/app/views/fcrepo_admin/objects/_context_nav_datastreams.html.erb

@@ -0,0 +1,13 @@
+<li class="dropdown">
+  <%= link_to fcrepo_admin.object_datastreams_path(object), :class => "dropdown-toggle", :id => "dLabel", :role => "button", :'data-toggle' => "dropdown", :'data-target' => "#" do %>
+	<%= t("fcrepo_admin.object.nav.items.datastreams") %>
+    <b class="caret"></b>
+  <% end %>
+  <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
+	<% object.datastreams.keys.each do |dsid| %>
+	<li>
+	  <%= link_to dsid, fcrepo_admin.object_datastream_path(object, dsid) %>
+	</li>
+	<% end %>
+  </ul>
+</li>

data/app/views/fcrepo_admin/objects/_context_nav_items.html.erb

@@ -0,0 +1,19 @@
+<li>
+  <%= link_to_unless_current t("fcrepo_admin.object.nav.items.summary"), fcrepo_admin.object_path(object) %>
+</li>
+<li>
+  <%= link_to_unless_current t("fcrepo_admin.object.nav.items.datastreams"), fcrepo_admin.object_datastreams_path(object) %>
+</li>
+<% if object_has_permissions? && can?(:permissions, object) %>
+  <li>
+    <%= link_to_unless_current t("fcrepo_admin.object.nav.items.permissions"), fcrepo_admin.permissions_object_path(object) %>
+  </li>
+<% end %>
+<li>
+  <%= link_to_unless_current t("fcrepo_admin.object.nav.items.associations"), fcrepo_admin.object_associations_path(object) %>
+</li>
+<% if object_is_auditable? && can?(:audit_trail, object) %>
+  <li>
+	<%= link_to_unless_current t("fcrepo_admin.object.nav.items.audit_trail"), fcrepo_admin.audit_trail_object_path(object) %>
+  </li>
+<% end %>

data/app/views/fcrepo_admin/objects/_direct_permissions.html.erb

@@ -0,0 +1,8 @@
+<h4><%= t("fcrepo_admin.object.permissions.direct") %></h4>
+<% if object_has_permissions? %>
+  <%= render :partial => 'permissions_list', :locals => {:permissions => object.permissions} %>
+<% else %>
+  <div class="alert">
+	<%= t("fcrepo_admin.object.permissions.not_supported") %>: <%= object_type %>.
+  </div>
+<% end %>

data/app/views/fcrepo_admin/objects/_inherited_permissions.html.erb

@@ -0,0 +1,23 @@
+<h4><%= t("fcrepo_admin.object.permissions.inherited") %></h4>
+<% unless admin_policy_enforcement_enabled? %>
+  <p class="alert">
+	<%= t("fcrepo_admin.object.apo.enforcement_disabled") %>.
+  </p>
+<% end %>
+<% if object_is_governable? %>
+  <div class="alert alert-info">
+	<% if object_is_governed_by %>
+	  <%= t("fcrepo_admin.object.apo.governed_by") %>: 
+	  <%= link_to object_is_governed_by.pid, fcrepo_admin.object_path(object_is_governed_by) %>
+	<% else %>
+	  <%= t("fcrepo_admin.object.apo.not_assigned") %>.
+    <% end %>
+  </div>
+  <% if object_is_governed_by %>
+    <%= render :partial => 'permissions_list', :locals => {:permissions => object_is_governed_by.default_permissions} %>
+  <% end %>
+<% else %>
+  <p class="alert alert-info">
+    <%= t("fcrepo_admin.object.apo.relationship_undefined") %>: <%= object_type %>.
+  </p>
+<% end %>

data/app/views/fcrepo_admin/objects/_permissions_list.html.erb

@@ -0,0 +1,18 @@
+<% if permissions.empty? %>
+  <div class="alert">
+	<%= t("fcrepo_admin.object.permissions.no_permissions") %>
+  </div>
+<% else %>
+  <table class="table table-bordered table-condensed table-autowidth" style="width: auto">
+	<thead>
+	  <tr>
+		<th scope="col"><%= t("fcrepo_admin.object.permissions.header.type") %></th>
+		<th scope="col"><%= t("fcrepo_admin.object.permissions.header.name") %></th>
+		<th scope="col"><%= t("fcrepo_admin.object.permissions.header.access") %></th>
+	  </tr>
+	</thead>
+	<tbody>
+	  <%= render :partial => "permissions_list_item", :collection => permissions, :as => :permission %>
+	</tbody>
+  </table>
+<% end %>