fcrepo_admin 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73679eaaaef9b035662e7ec5f145669cb75240ad
-  data.tar.gz: 2b63f18ebb6bf30df57796c87c071d2cf0d51d57
+  metadata.gz: 9e26f1848c179673df8ef4efefa687c718365bcb
+  data.tar.gz: ba0010feb90c17d3853f647f0f9a0cd1b2ea8e30
 SHA512:
-  metadata.gz: 47491368bb3881dd03ba9adbce428d4a5858d031dde0bbc8b16163a5026b1ed2d2fad997d11a51bb3101bcc06b312fb9c0268d335a0198a12bf8610255e3ced3
-  data.tar.gz: 07a9a3c5fd32920518feaf74375dc799e6cd0b53a82141c494ee6ff049cd5c4947131f2745e55cb6faca15b06dac72b77fcf77eb4cd24fa9c9fa1cdb5be5d04c
+  metadata.gz: 7a47b722727bc7eb6f4518a425fc050752585b9ec1493901ef7ee84db04a9c7fc9f30d715841180a53aa4163dc7c20d7864f95b9748b337ef8db5e2a881b88f1
+  data.tar.gz: 3c5218ad09ed98edae213f2fa179b7b92f1c09c9c25e106d4f83b2a83b137923318ab35886929dc0c53a42c9834da8703bf010c32ac6bc0cdc3eab3f9e6428f4

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,38 +1,42 @@
-==== 0.5.2 (2013-05-22)
+#### 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.
+
+#### 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).
 
-==== 0.5.1 (2013-05-21)
+#### 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.
 
-=== 0.5.0 (2013-05-17)
+### 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)
+#### 0.4.1 (2013-05-14)
 
 * 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)
+### 0.4.0 (2013-05-03)
 
 * 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 (2013-04-30)
+#### 0.3.5 (2013-04-30)
 
 * Requires active-fedora 6.1.
 
-==== 0.3.4 (2013-04-29)
+#### 0.3.4 (2013-04-29)
 
 * Moved FcrepoAdmin::BlacklightHelperBehavior to FcrepoAdmin::Helpers::BlacklightHelperBehavior.
 * FcrepoAdmin::ObjectsHelper methods can now be easily overridden.
@@ -41,29 +45,29 @@
 * Objects and datastreams controller behaviors are now easily overrideable.
 * Refactored object and datastream context navs for greater reusability.
 
-==== 0.3.3 (2013-04-25)
+#### 0.3.3 (2013-04-25)
 
 * Audit trail functionality fails gracefully (i.e., if object does not implement ActiveFedora::Auditable)
 
-==== 0.3.2 (2013-04-19)
+#### 0.3.2 (2013-04-19)
 
 * Separated datastream and object context navigation menus.
 * Added object helpers.
 
-==== 0.3.1 (2013-04-18)
+#### 0.3.1 (2013-04-18)
 
 * Object and datastream context nav menus added.
 * Audit trail moved into objects controller.
 
-=== 0.3.0 (2013-04-16)
+### 0.3.0 (2013-04-16)
 
 * Feature: Permissions and inherited permissions added to object show view.
 
-=== 0.2.0 (2013-04-12)
+### 0.2.0 (2013-04-12)
 
 * Feature: Datastream content editing.
 
-=== 0.1.0 (2013-04-11)
+### 0.1.0 (2013-04-11)
 
 Initial release to RubyGems.
 

data/README.md

@@ -0,0 +1,208 @@
+## 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
+
+This project should be considered *experimental*. Versions earlier than 1.0 may change API and/or UI without notice 
+or regard for backward compatibility.
+
+### 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
+
+**Add to Gemfile**
+
+```
+gem 'fcrepo_admin'
+```
+
+Then `bundle install`
+
+**Run the Blacklight and Hydra generators** (if this is a new Rails app, not an existing Hydra head)
+
+```
+rails g blacklight --devise
+rails g hydra:head -f
+rake db:migrate
+rails g hydra:jetty  # if you need a development copy of jetty with solr and fedora
+```
+
+**Mount the engine**
+
+In `config/routes.rb` add this line:
+
+```ruby
+mount FcrepoAdmin::Engine => '/', :as=> 'fcrepo_admin'
+```
+
+You may use any mount point.  All routes include `objects` as a subpath.
+
+**Add CanCan action aliases** (fcrepo_admin >= 0.4.0)
+
+In your Ability class (`app/models/ability.rb`) include the `FcrepoAdmin::Ability` module, for example:
+
+```ruby
+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.
+
+**Customize catalog search results** (optional)
+
+If you would like catalog search results items to link to the fcrepo_admin object show view
+instead of the catalog show view, create `app/helpers/blacklight_helper.rb` with this content:
+
+```ruby
+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, include the 
+`ActiveFedora::Auditable` mixin in your ActiveFedora models:
+
+```ruby
+include ActiveFedora::Auditable
+```
+
+### Overriding fcrepo_admin behaviors
+
+#### Configurable settings (fcrepo_admin >= 0.5.0)
+
+To override default configurable settings for fcrepo_admin, create an initializer at `config/initializers/fcrepo_admin.rb`.
+You should start with this content:
+
+```ruby
+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/configurable.rb.
+
+All configuration options are set by module methods prefixed by `FcrepoAdmin`, for example:
+
+```ruby
+FcrepoAdmin.read_only = true
+```
+
+#### Helpers
+
+Override objects helpers by creating `app/helpers/fcrepo_admin/objects_helper.rb` with this content:
+
+```ruby
+module FcrepoAdmin::ObjectsHelper
+  include FcrepoAdmin::Helpers::ObjectsHelperBehavior
+  # override methods here
+end
+```
+
+In particular you may want to override `object_title`.
+
+Override datastreams helpers by creating `app/helpers/fcrepo_admin/datastreams_helper.rb` with this content:
+
+```ruby
+module FcrepoAdmin::DatastreamsHelper
+  include FcrepoAdmin::Helpers::DatastreamsHelperBehavior
+  # override methods here
+end
+```    
+
+#### Context Navigation Menus
+
+##### fcrepo_admin >= 0.5.0
+
+The configuration settings that control the items on the context menus are:
+
+```ruby
+FcrepoAdmin.object_nav_items = [:pid, :summary, :datastreams, :permissions, :associations, :audit_trail, :object_xml]
+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`.
+
+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
+
+To override or extend controller behaviors, please consult Rails engine documentation and guides, such as 
+http://edgeguides.rubyonrails.org/engines.html.
+
+IMPORTANT: If you add a non-RESTful action to a controller, you will probably have to add a CanCan action alias
+to your Ability class.  For this, you can use Hydra's `custom_permissions` callback:
+
+```ruby
+class Ability
+  include Hydra::Ability
+  include Hydra::PolicyAwareAbility
+  include FcrepoAdmin::Ability
+
+  def custom_permissions
+    alias_action :my_method, :to => :read
+  end
+end
+```  
+
+#### Read-only mode
+
+To suppress mutating behaviors (i.e, routes, nav items, etc.) regardless of user permissions, 
+add this configuration setting:
+
+```ruby
+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
+
+* 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.
+
+Licenses for code copied from other projects will be included in source files as required.

data/app/controllers/fcrepo_admin/associations_controller.rb

@@ -44,6 +44,9 @@ module FcrepoAdmin
       rows = FcrepoAdmin.associated_objects_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
+      end
       apply_gated_discovery(args, nil) # add args to enforce Hydra access controls
       args
     end

data/fcrepo_admin.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.files      = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- spec/*`.split("\n")
 
-  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "HISTORY.rdoc"]
+  s.extra_rdoc_files = ["LICENSE", "README.md", "HISTORY.md"]
 
   s.require_paths = ["lib"]
 

data/lib/fcrepo_admin/configurable.rb

@@ -47,9 +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 object associations show view
+    # Number of objects to display per page on associations show view
     mattr_accessor :associated_objects_per_page
     self.associated_objects_per_page = 10
+
+    # Solr sort param added to association collection query
+    mattr_accessor :associated_objects_sort_param
+    self.associated_objects_sort_param = nil
   end
 
 end

data/lib/fcrepo_admin/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fcrepo_admin
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - David Chandek-Stark
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hydra-head
@@ -231,15 +231,15 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
-- HISTORY.rdoc
+- README.md
+- HISTORY.md
 files:
 - .gitignore
 - .rspec
 - Gemfile
-- HISTORY.rdoc
+- HISTORY.md
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/controllers/fcrepo_admin/associations_controller.rb
 - app/controllers/fcrepo_admin/datastreams_controller.rb

data/README.rdoc

@@ -1,190 +0,0 @@
-== 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
-
-This project should be considered *experimental*. Versions earlier than 1.0 may change API and/or UI without notice 
-or regard for backward compatibility.
-
-=== 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
-
-(In the future, we hope to automate some of these tasks with a generator.)
-
-* Add to gemfile
-
-    gem 'fcrepo_admin'
-
-  Then <code>bundle install</code>
-
-* Run the Blacklight and Hydra generators (if this is a new Rails app, not an existing Hydra head)
-
-    rails g blacklight --devise
-    rails g hydra:head -f
-    rake db:migrate
-    rails g hydra:jetty  # if you need a development copy of jetty with solr and fedora
-
-* Mount the engine
-
-  In config/routes.rb add this line:
-
-    mount FcrepoAdmin::Engine => '/', :as=> 'fcrepo_admin'
-
-  You may use any mount point (except perhaps <code>'/catalog'</code>).
-  All routes include <code>objects</code> as a subpath.
-
-* Add CanCan action aliases (fcrepo_admin >= 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 (fcrepo_admin < 0.4.0)
-  
-  In app/assets/javascripts/application.js add:
-
-    //= require bootstrap-tab
-
-* Customize catalog search results (optional)
-
-  If you would like catalog search results items to link to the fcrepo_admin object show view
-  instead of the catalog show view, create app/helpers/blacklight_helper.rb with this content:
-
-    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, include the 
-  ActiveFedora::Auditable mixin in your ActiveFedora models:
-
-    include ActiveFedora::Auditable
-
-=== Overriding fcrepo_admin behaviors
-
-==== Configurable settings (fcrepo_admin >= 0.5.0)
-
-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/configurable.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:
-
-    module FcrepoAdmin::ObjectsHelper
-      include FcrepoAdmin::Helpers::ObjectsHelperBehavior
-      # override methods here
-    end
-
-In particular you may want to override #object_title.
-
-Override datastreams helpers by creating app/helpers/fcrepo_admin/datastreams_helper.rb with this content:
-
-    module FcrepoAdmin::DatastreamsHelper
-      include FcrepoAdmin::Helpers::DatastreamsHelperBehavior
-      # override methods here
-    end    
-
-==== 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, :object_xml]
-  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.
-
-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
-
-To override or extend controller behaviors, please consult Rails engine documentation and guides, such as 
-http://edgeguides.rubyonrails.org/engines.html.
-
-IMPORTANT: If you add a non-RESTful action to a controller, you will probably have to add a CanCan action alias
-to your Ability class.  For this, you can use Hydra's #custom_permissions callback:
-
-    class Ability
-      include Hydra::Ability
-      include Hydra::PolicyAwareAbility
-      include FcrepoAdmin::Ability
-
-      def custom_permissions
-        alias_action :my_method, :to => :read
-      end
-
-    end  
-
-==== 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
-
-* 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.
-
-Licenses for code copied from other projects will be included in source files as required.