fcrepo_admin 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 305ef9978b750b747db1086587bf2d1728a59db9
-  data.tar.gz: 6c1b3182517d5540696c72f69a8eb5eb8e360925
+  metadata.gz: 9b41a170f6b9f8ad2296559c6ff76f85c1b325c2
+  data.tar.gz: ce970e804c3e9fec32d7ac493bdb001e775f765d
 SHA512:
-  metadata.gz: b2c10fdd7964b34923d6486be2fb8b1c05215e9430d0f8cf75e04007f80ab658660f83220502b9469a94f1467d49a364a80714b209ddad2efc726d0fed71e887
-  data.tar.gz: 277b2fc6f1dd3a411ace6984eec531d60cd2e5d4ac9b906e9774f9064d283c84d82e6abf8630dc0110328de7803cf95e79d460a641f704e4c1b80a149a6e5af1
+  metadata.gz: 13935a3cdf2cc95bd0048caf3a25c3e1442b4229b2f874ad93c0eb47bb4bbc2164a9f78da5acbef5dec5ca39e949d7db46b4fa1b167d821d16e88b8308ecff08
+  data.tar.gz: bd682bf0c49d2f06dd2aef3c630d4da5ed723c2efc6e1d1005a3801f40d25f7df096a4267f9e63566481556b691213915fcb6c4ffb969b04397477a584688d53

data/HISTORY.rdoc

@@ -1,6 +1,14 @@
+=== 0.5.0 (2013-05-17)
+
+* Feature: Configurable settings.
+* Context navigation menus refactored: customizations now done through helpers and configuration settings, not by overriding partials.
+* ActiveFedora::Base and ActiveFedora::Datastream classes extended by decorators.
+* Tests added.
+
 ==== 0.4.1 (2013-05-14)
 
-* Feature: Datastream history view
+* Feature: Datastream history view.
+* Feature: Support for asOfDateTime parameter added to datastream read views to display content and profile information for datastream versions.
 
 === 0.4.0 (2013-05-03)
 
@@ -16,7 +24,7 @@
 
 * Moved FcrepoAdmin::BlacklightHelperBehavior to FcrepoAdmin::Helpers::BlacklightHelperBehavior.
 * FcrepoAdmin::ObjectsHelper methods can now be easily overridden.
-* DatastreamsHelper module added.
+* FcrepoAdmin::DatastreamsHelper module added.
 * Shared helper methods in new module FcrepoAdmin::Helpers::FcrepoAdminHelperBehavior.
 * Objects and datastreams controller behaviors are now easily overrideable.
 * Refactored object and datastream context navs for greater reusability.

data/README.rdoc

@@ -1,18 +1,18 @@
-= Hydra Administrative Tool for a Fedora Repository
+== Hydra Administrative Tool for a Fedora Repository
 
 A Rails engine providing an administrative interface to a Fedora Commons repository built on the Hydra project framework.
 
-== Status
+=== Status
 
 This project should be considered *experimental* and not ready for production deployment.
 Versions earlier than 1.0 may change API and/or UI without notice or regard for backward compatibility.
 
-== Requirements
+=== Requirements
 
 fcrepo_admin is designed for installation on hydra-head 6.0 or higher (requires active-fedora 6.1 or higher).
 See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
 
-== Installation
+=== Installation
 
 (In the future, we hope to automate some of these tasks with a generator.)
 
@@ -38,7 +38,7 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
   You may use any mount point (except perhaps <code>'/catalog'</code>).
   All routes include <code>objects</code> as a subpath.
 
-* Add CanCan action aliases (version >= 0.4.0)
+* Add CanCan action aliases (fcrepo_admin >= 0.4.0)
 
   In your Ability class (app/models/ability.rb) include the FcrepoAdmin::Ability module, for example:
 
@@ -51,7 +51,7 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
   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)
+* Add Javascript (fcrepo_admin < 0.4.0)
   
   In app/assets/javascripts/application.js add:
 
@@ -75,11 +75,28 @@ See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
 
     include ActiveFedora::Auditable
 
-== Overriding fcrepo_admin behaviors
+=== Overriding fcrepo_admin behaviors
 
-The following are examples of possible customizations.  This list is not necessarily exhaustive.
+==== Configurable settings (fcrepo_admin >= 0.5.0)
 
-=== Helpers
+To override default configurable settings for fcrepo_admin, create an initializer at config/initializers/fcrepo_admin.rb. 
+You should start with this content:
+
+    module YourApp
+      class Application < Rails::Application
+        config.before_initialize do
+          # Customized settings will go here
+        end
+      end
+    end
+
+Refer to the default configuration settings at https://github.com/projecthydra/fcrepo-admin/blob/master/lib/fcrepo_admin.rb.
+
+All configuration options are set by module methods prefixed by FcrepoAdmin, for example:
+
+    FcrepoAdmin.read_only = true
+
+==== Helpers
 
 Override objects helpers by creating app/helpers/fcrepo_admin/objects_helper.rb with this content:
 
@@ -97,7 +114,28 @@ Override datastreams helpers by creating app/helpers/fcrepo_admin/datastreams_he
       # override methods here
     end    
 
-=== Context Navigation Menus
+==== Context Navigation Menus
+
+===== fcrepo_admin >= 0.5.0
+
+The configuration settings that control the items on the context menus are:
+
+  FcrepoAdmin.object_nav_items = [:pid, :summary, :datastreams, :permissions, :associations, :audit_trail]
+  FcrepoAdmin.datastream_nav_items = [:dsid, :version, :current_version, :summary, :content, :download, :edit, :upload, :history]
+
+Each setting takes an array of symbols representing the items.  You can start by copying the default values shown above.
+If you simply want to rearrange or remove items, then just modify the default arrays.
+
+To add a custom navigation item, start by adding your own symbol to the approriate array setting.  Then override the 
+appropriate helper method (see section above on overriding fcrepo_admin helpers) -- for object context nav, override 
+#custom_object_nav_item in ObjectsHelper; for datastream context nav, override #custom_datastream_nav_item
+in DatastreamsHelper.
+
+Each method takes a single symbol argument and should return either nil (meaning no menu item is to be added) or the *content*
+of a menu item.  Do not include the <li></li> wrapper.  You may want to use link_to_unless_current and/or put a condition on
+the menu item (i.e., so that nil is returned if the condition is not met).
+
+===== fcrepo_admin < 0.5.0
 
 The contents of the object context navigation menu can be customized by overriding the #object_context_nav_items
 helper method, or by copying and modifying the partial fcrepo_admin/objects/context_nav_items.
@@ -105,7 +143,7 @@ helper method, or by copying and modifying the partial fcrepo_admin/objects/cont
 The contents of the datastream context navigation menu can be customized by overriding the 
 #datastream_context_nav_items helper method, or by copying and modifying the partial fcrepo_admin/datastreams/context_nav_items.
 
-=== Controllers
+==== Controllers
 
 To override or extend controller behaviors, please consult Rails engine documentation and guides, such as 
 http://edgeguides.rubyonrails.org/engines.html.
@@ -124,12 +162,19 @@ to your Ability class.  For this, you can use Hydra's #custom_permissions callba
 
     end  
 
-== Internationalization (i18n)
+==== Read-only mode
+
+To suppress mutating behaviors (i.e, routes, nav items, etc.) regardless of user permissions, 
+add this configuration setting:
+
+  FcrepoAdmin.read_only = true
+
+=== Internationalization (i18n)
 
 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.
 
-== Contributing
+=== 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.
@@ -138,7 +183,7 @@ for the keys and consult the Rails documentation on how to provide your own tran
 
 Thanks!
 
-== License
+=== License
 
 See the LICENSE file in the root directory of the project for copyright and license information.
 

data/app/controllers/fcrepo_admin/datastreams_controller.rb

@@ -13,15 +13,6 @@ module FcrepoAdmin
     before_filter :load_and_authorize_object
     before_filter :load_datastream, :except => :index
 
-    helper_method :ds_is_current_version?
-    helper_method :ds_content_is_text?
-    helper_method :ds_content_is_editable?
-    helper_method :ds_content_is_uploadable?
-
-    # TODO Migrate to config initializer
-    EXTRA_TEXT_MIME_TYPES = ['application/xml', 'application/rdf+xml', 'application/json']
-    MAX_EDITABLE_SIZE = 1024 * 64
-
     def index
     end
 
@@ -29,6 +20,9 @@ module FcrepoAdmin
     end
 
     def content
+      unless @datastream.content_is_text?
+        render :text => "Datastream content is not text.", :status => 403
+      end
     end
 
     def history
@@ -41,10 +35,13 @@ module FcrepoAdmin
     end
 
     def edit
+      unless @datastream.content_is_editable?
+        render :text => "Datastream content is not editable", :status => 403
+      end
     end
 
     def upload
-      unless ds_content_is_uploadable?
+      unless @datastream.content_is_uploadable?
         render :text => "This datstream does not support file content", :status => 403
       end
     end
@@ -57,7 +54,7 @@ module FcrepoAdmin
       end
       @object.save
       flash[:notice] = "Datastream content updated." # i18n
-      redirect_to fcrepo_admin.object_datastream_url(@object, @datastream.dsid)
+      redirect_to fcrepo_admin.object_datastream_url(@object, @datastream)
     end
 
     private
@@ -67,41 +64,6 @@ module FcrepoAdmin
       @datastream = @datastream.asOfDateTime(params[:asOfDateTime]) if params[:asOfDateTime]
     end
 
-    protected
-
-    # XXX Use Rubydora::Datastream#current_version? when it becomes available
-    # https://github.com/projecthydra/rubydora/pull/25
-    def ds_is_current_version?
-      @current_version ||= (@datastream.new? || @datastream.dsVersionID == @datastream.versions.first.dsVersionID)
-    end
-
-    def ds_content_is_url?
-      @datastream.external? || @datastream.redirect?
-    end
-
-    def ds_content_is_editable?
-      !ds_content_is_url? && ds_content_is_text? && ds_editable_content_size_ok?
-    end
-
-    def ds_editable_content_size_ok?
-      @datastream.dsSize <= MAX_EDITABLE_SIZE
-    end
-
-    def ds_content_is_uploadable?
-      @datastream.managed? || @datastream.inline?
-    end
-
-    private
-
-    def ds_content_is_text?
-      mimetype_is_text(@datastream.mimeType)
-    end
-
-    def mimetype_is_text(mimetype)
-      return false if mimetype.blank?
-      mimetype.start_with?('text/') || EXTRA_TEXT_MIME_TYPES.include?(mimetype)
-    end
-
   end
 end
 

data/app/controllers/fcrepo_admin/objects_controller.rb

@@ -13,7 +13,7 @@ module FcrepoAdmin
     end
 
     def audit_trail
-      if object_is_auditable?
+      if @object.auditable?
         if params[:download] # TODO use format instead download param
           send_data @object.audit_trail.to_xml, :disposition => 'inline', :type => 'text/xml'
         end

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

@@ -0,0 +1,4 @@
+<%= content_tag :div, :class => css_class do %>
+  <% if caution %><strong><%= t("fcrepo_admin.datastream.alerts.caution") %></strong><% end %> 
+  <%= t("fcrepo_admin.datastream.alerts.#{alert}") %>
+<% end %>

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

@@ -1,5 +1,5 @@
 <h4>Content</h4>
-<% if ds_content_is_text? %>
+<% if datastream.content_is_text? %>
   <pre class="prettyprint pre-scrollable"><%= datastream.content %></pre>
 <% else %>
   <div class="alert">

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

@@ -3,7 +3,7 @@
     <tr>
 	  <th scope="col"><%= t("fcrepo_admin.datastreams.header.id") %></th>
 	  <% 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>
@@ -11,12 +11,12 @@
     <% object.datastreams.each do |dsid, ds| %>
       <tr>
 	    <td>
-		  <%= link_to dsid, fcrepo_admin.object_datastream_path(object, dsid) %>
+		  <%= link_to dsid, fcrepo_admin.object_datastream_path(object, ds) %>
 		</td>
 	    <% unless ds.new? %>
 	      <% columns.each do |col| %>
 	        <td>
-			  <%= format_ds_profile_value ds, col %>
+			  <%= format_datastream_profile_value ds, col %>
 			</td>
 	      <% end %>
         <% else %>

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

@@ -1,16 +1,15 @@
 <% unless datastream.new? %>
   <h4><%= t("fcrepo_admin.datastream.profile.title") %></h4>
-
   <table class="table table-bordered table-condensed table-striped" style="width: auto">
-	<% datastream.profile.each_key do |key| %>
+	<% datastream_show_profile_keys.each do |key| %>
 	<tr>
-	  <th scope="row"><%= t("fcrepo_admin.datastream.profile.#{key}") %></th>
-	  <td><%= format_ds_profile_value datastream, key %></td>
+	  <th scope="row"><%= t("fcrepo_admin.datastream.profile.keys.#{key}") %></th>
+	  <td><%= format_datastream_profile_value datastream, key %></td>
 	</tr>
 	<% end %>
   </table>  
 <% else %>
   <div class="alert alert-info">
-	This datastream has not been persisted to Fedora.
+	<%= t("fcrepo_admin.datastream.alerts.not_persisted") %>
   </div>
 <% end %>

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

@@ -1 +1,2 @@
-<%= render :partial => 'content', :locals => {:datastream => @datastream} %>
+<h4><%= t("fcrepo_admin.datastream.content.title") %></h4>
+<pre class="prettyprint pre-scrollable"><%= @datastream.content %></pre>

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

@@ -1,9 +1,10 @@
-<h4><%= t("fcrepo_admin.datastream.edit.header") %></h4>
-<%= form_tag fcrepo_admin.object_datastream_path(@datastream.pid, @datastream.dsid), :method => :put do %>
+<h4><%= t("fcrepo_admin.datastream.edit.title") %></h4>
+<%= datastream_alerts :system_managed, :not_versionable %>
+<%= form_tag fcrepo_admin.object_datastream_path(@object, @datastream), :method => :put do %>
 <div>
   <%= text_area_tag "content", @datastream.content, :size => "50x20", :class => "field", :style => "width: 100%" %>
 </div>
 <p>
-  <%= submit_tag t("fcrepo_admin.datastream.edit.submit"), :confirm => t("fcrepo_admin.datastream.edit.confirm"), :class => "btn btn-primary" %>
+  <%= submit_tag t("fcrepo_admin.datastream.edit.form.submit"), :confirm => t("fcrepo_admin.datastream.edit.form.confirm"), :class => "btn btn-primary" %>
 </p>
 <% end %>

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

@@ -9,16 +9,11 @@
 	</tr>
   </thead>
   <tbody>
-	<% @datastream.versions.each_with_index do |ds, i| %>
+	<% @datastream.versions.each do |dsVersion| %>
 	<tr>
-	  <td><%= 
-			 link_to_unless i == 0, ds.profile["dsVersionID"], "#{fcrepo_admin.object_datastream_path(@object, ds.dsid)}?asOfDateTime=#{ds.asOfDateTime}" do |name|
-			   "#{name} (current version)"
-			 end
-			 -%>
-	  </td>
+	  <td><%= link_to_datastream_version dsVersion %></td>
 	  <% datastream_history_columns.each do |col| %>
-	  <td><%= ds.profile[col] %></td>
+	  <td><%= dsVersion.profile[col] %></td>
 	  <% end %>
 	<% end %>
   </tbody>

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

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

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

@@ -1,10 +1,11 @@
-<h4><%= t("fcrepo_admin.datastream.upload.header") %></h4>
-<%= form_tag fcrepo_admin.object_datastream_path(@datastream.pid, @datastream.dsid), :method => :put, :multipart => true do %>
+<h4><%= t("fcrepo_admin.datastream.upload.title") %></h4>
+<%= datastream_alerts :system_managed, :not_versionable %>
+<%= form_tag fcrepo_admin.object_datastream_path(@object, @datastream), :method => :put, :multipart => true do %>
 <div>
   <%= file_field_tag "file" %>
 </div>
 <p>
-  <%= submit_tag t("fcrepo_admin.datastream.upload.submit"), :confirm => t("fcrepo_admin.datastream.upload.confirm"), :class => "btn btn-primary" %>
+  <%= submit_tag t("fcrepo_admin.datastream.upload.form.submit"), :confirm => t("fcrepo_admin.datastream.upload.form.confirm"), :class => "btn btn-primary" %>
 </p>
 <% end %>
 

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

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

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

@@ -3,7 +3,7 @@
 	<%= t("fcrepo_admin.object.permissions.no_permissions") %>
   </div>
 <% else %>
-  <table class="table table-bordered table-condensed table-autowidth" style="width: auto">
+  <table class="table table-bordered table-condensed">
 	<thead>
 	  <tr>
 		<th scope="col"><%= t("fcrepo_admin.object.permissions.header.type") %></th>

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

@@ -1,5 +1,11 @@
 <h3><%= t("fcrepo_admin.object.permissions.title") %></h3>
-<%= render :partial => 'direct_permissions', :locals => {:object => @object} %>
-<%= render 'inherited_permissions' %>
+<div class="row">
+  <div class="span4">
+	<%= render :partial => 'direct_permissions', :locals => {:object => @object} %>
+  </div>
+  <div class="span5">
+	<%= render 'inherited_permissions' %>
+  </div>
+</div>
 
 

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

@@ -3,9 +3,9 @@
 	<li class="nav-header">
 	  <%= header %>
 	</li>
-	<% items.each do |label, path| %>
+	<% items.each do |item| %>
 	<li>
-	  <%= link_to_unless_current label, path %>
+	  <%= item %>
 	</li>
 	<% end %>
   </ul>