sufia 6.0.0.rc4 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e0e2744f7b799d2b4a2d090e260e66c6ed2cc5d
-  data.tar.gz: 142e115791a129a7b013773cd20993909f4e3f86
+  metadata.gz: 2796b98ae30851164de5f1e0c2e39dcc91dda839
+  data.tar.gz: f4e1fa1b7eebf06bfca330f1f08373cd2931142b
 SHA512:
-  metadata.gz: 15e992259c723cf8cd267b89e1a3a1008650a009165cf8490d0cdb7c86bd577e6db0c298e7b7ea99301af325a7f76925e4339724ee015c2fda6c1457ba51b2c2
-  data.tar.gz: 12b7cbf716a772af91f4740064cf148f6aac7726d4d6ac3f5fdb4d01aad12f30c378bd4393834f55d0f63e9407755a3395a26ba6f1b82b412ae6d468c68da849
+  metadata.gz: 2e10c49d8a7e0b075abdff71ca943189497c6c7dce4746dfc418604777405dd78d56e4142c0de6e261e2997c98e94630ca246d59ae2b5af8331ec15eea216d02
+  data.tar.gz: b135eb633c321d549b2b510e66a68cc814a45ff5d3ed19b6b3f7f0b216ebd7c95dded451bdb4728ab35309bf1afc5da46f374302501917792529e3c75eed6d79

data/.travis.yml

@@ -13,7 +13,7 @@ env:
 
   matrix:
     - "RAILS_VERSION=4.1.8"
-    - "RAILS_VERSION=4.2.0"
+    - "RAILS_VERSION=4.2.1"
 
 notifications:
   email:

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 # Required for doing pagination inside an engine. See https://github.com/amatsuda/kaminari/pull/322
-gem 'kaminari', github: 'harai/kaminari', branch: 'route_prefix_prototype'
+gem 'kaminari', github: 'jcoyne/kaminari', branch: 'sufia'
 gem 'sufia-models', path: './sufia-models'
 gem 'slop', '~> 3.6.0' # This just helps us generate a valid Gemfile.lock when Rails 4.2 is installed (which requires byebug which has a dependency on slop)
 

data/History.md

@@ -1,5 +1,285 @@
 # History of Sufia releases
 
+## 6.0.0
+
+* Replace pid with id in config [Adam Wead]
+* Rename pid columns to generic_file_id [Justin Coyne]
+* Remove unused default edit partial [Justin Coyne]
+* Remove pid from TransfersControllerBehavior [Justin Coyne]
+* add waffle.io badge [waffle-iron]
+* Updating view test, fixes #991 [Adam Wead]
+* Upgrade generator for 6.0 [Justin Coyne]
+* Upgrade to Blacklight 5.12.1 [Justing Coyne]
+* Update test grid to Rails 4.2.1 [Justin Coyne]
+* In ContentDepositoryChangeEventJob change pid -> id [Justin Coyne]
+* ActiveFedoraIdBasedJobs should use id instead of pid [Justin Coyne]
+* Use the label instead of the file_name, #981 [Adam Wead]
+* Rename ActiveFedoraPidBasedJob to ActiveFedoraIdBasedJob [Justin Coyne]
+* Reconfigure and update blacklight_advanced_search [Adam Wead]
+* Use Sufia::SearchBuilder; update hydra-collections [Adam Wead]
+* Updating methods to remove deprecation warnings [Adam Wead]
+* Only display upload link if you have permission [Trey Terrell]
+* Replaces redundant title attribute with more beneficial text for all users [mtribone]
+* Separate button viewing for files and collections. [Trey Terrell]
+* Rename permission to view share work button [Trey Terrell]
+* Allowing transfers of a file after original transfer has been closed. fixes #972 [Carolyn Cole]
+* Use Net::HTTP to download full-text jar files [Adam Wead]
+* Migrate pids in audit logs and proxy requests, fixes #853 [Adam Wead]
+* Update FITS URL in README [Michael J. Giarlo]
+* Delay creation of batch until the user actually submits files. This will reduce the number of orphan batches created since we won't create a new batch when the user issues an HTTP GET on the page, rather we will wait until the user issues an HTTP POST to the page [Hector Correa]
+* Removes title attribute and adds sr-only span for better accessibility compliance [mtribone]
+* Hide dashboard buttons if appropriate. [Trey Terrell]
+* Only display upload if you can. [Trey Terrell]
+* Removes old 1.0 background graphics [mtribone]
+* Add link to metadata customization documentation. [Michael J. Giarlo]
+* Fix search builder compatibility [Adam Wead]
+* Use real objects for view test [Adam Wead]
+* Update CollectionsControllerBehavior [Adam Wead]
+* Upgrade hydra-collections to ~> 5.0 [Adam Wead]
+* Fix generator for blacklight 5.10 [Adam Wead]
+* Update to Blacklight 5.10 [Adam Wead]
+* as an admin user, I can edit another user's profile fixes #923 [Tricia Jenkins]
+* Dashboard controller should display incoming and outgoing transfers. [Michael J. Giarlo]
+* Added delay to stats import. Allow for new users to be picked up first [Hector Correa]
+* Rake task for deleting empty batches [Adam Wead]
+* Adding a i18n warning to the user on cloud provider upload page to let the user know the uploading is time sensitive. [Adam Wead]
+* Adds icons and labels for upload and create collection buttons to translation file. [mtribone]
+* Use the latest Blaklight 5.9 version [Adam Wead]
+* Reorganize and generate a TOC for the README [Michael J. Giarlo]
+* Remove blank strings from Collection & GenericFile Remove blank strings from params when creating or updating a collection. Trim FitsDatastream xml template to avoid blanks in GenericFile: Newly initialized GenericFile would end up with ""' or[""]' in place of most characterization attributes because the blank XML template in FitsDatastream generated them. Fixes #941 [Piotr Hebal]
+* Replaces icon font with default SVG graphic [mtribone]
+* Updating to use the new blacklight partial instead of defining in-line [Carolyn Cole]
+* Add auto-link to description, in #942 [Adam Wead]
+* Adds CSS two column to match file show [mtribone]
+* Use hasSize to calculate collection size [Adam Wead]
+* Remove arrow in relevance sorting label [Adam Wead]
+* Makes sure resource type is not a require field in GenericFile edit form. [Hector Correa]
+* Moving alerts above the tabs so that it is not replicated on each tab. fixes #929 [Carolyn Cole]
+* Replaces tables for description list and adds CSS column-count, refs #9133 [mtribone]
+* Download aspectjrt jar to support m4a files [Adam Wead]
+* README should be clearer w/r/t Solr/Fedora requirements [Michael J. Giarlo]
+* Keep FFmpeg instructions together [Collin Brittle]
+* Changing to use the latest jquery hide show instead of the old style class name. fixes #916 [Carolyn Cole]
+* Remove the duplicate showing of title and move the description up above the table to match collection show view. [Carolyn Cole]
+* Preparing for 6.0.0.rc4 release [Michael J. Giarlo]
+* add class accessors for presenter and form class for batch form and single use link view - follow up to #906 [root]
+* Adding a rescue for a TimeoutError as we are seeing those in production [Michael J. Giarlo]
+* Updates hover states for better feedback and interaction, refs #9772 [mtribone]
+* Fixes button stacking to display inline, refs #9771 [mtribone]
+* Generate the necessary asset changes [Justin Coyne]
+* Add accessors for presenter and form class This makes overriding the presenter and form easier and avoids all the overriding necessary in something like #904 [Justin Coyne]
+* Fixes the save button alignment in batches and generic files, refs #9719 [mtribone]
+* If RAILS_VERSION is not set use sass-rails 5 [Justin Coyne]
+* Move blacklight-gallery generator from sufia-models generator to the sufia generator [Justin Coyne]
+* GenericFile title should render in heading of show view [Michael J. Giarlo]
+* Fixes the responsive overflow which hides the dropdown near the bottom of the listing table, refs #9718 [mtribone]
+* Overrides Bootstrap button colors, updates button class names to match, variables for style sheet [mtribone]
+* refactoring batch_controller to behavior for downstream overridding [Weiwei Shi]
+* Hooked up select2 to autocomplete user key. Redmine story #9146 [val99erie]
+* refactoring single_use_links_controller and single_use_links_viewer_controller [Weiwei Shi]
+* Preparing for 6.0.0.rc3 [Justin Coyne]
+* Index page for featured researchers. Redmine story #9666 [val99erie]
+* Use released versions of the dependencies [Justin Coyne]
+* IngestLocalFileJob should use the GenericFile::Actor. Fixes #885 [Justin Coyne]
+* Added autocommit to solr config So you won't lose the docs when you restart Solr Changes from projecthydra/active_fedora@c9733e3#diff-a34e883c5c6fbed341364fc259dc854cR19 Fixes #889 [Justin Coyne]
+* Move tweeter and itemtype to the presenter This prevents a null pointer error if the depositor can not be found Fixes #883 [Justin Coyne]
+* Condense tests to speed up the build [Justin Coyne]
+* Use the latest versions of hydra-head [Justin Coyne]
+* Store old entries for featured researcher. Redmine story #9146 [val99erie]
+* Redirects to 'my shares' when submiting files on behalf of somebody else [Hector Correa]
+* Remove nested anchor tag Previously was generating HTML like this: html <a aria-hidden="true" href="/files/d5a64948-966c-497e-830d-87f01887cbe1"> <a data-context-href="/catalog/d5a64948-966c-497e-830d-87f01887cbe1/track?search_id=21" href="/files/d5a64948-966c-497e-830d-87f01887cbe1"> <img alt="D5a64948 966c 497e 830d 87f01887cbe1?datastream id=thumbnail" src="/downloads/d5a64948-966c-497e-830d-87f01887cbe1?datastream_id=thumbnail" width="90" /> </a> </a> This pull request removes the outer anchor. [Justin Coyne]
+* Don't show update order button unless there are featured works. Fixes #865 [Justin Coyne]
+* Preserve original creation date in date_uploaded field. Redmine story #9728 [val99erie]
+* Resource type should not be required It was not required in previous versions of sufia, so this ensures it doesn't change [Justin Coyne]
+* Noids should not be second-class citizens. [Michael J. Giarlo]
+* Enable browser validations. Fixes #868 [Justin Coyne]
+* Removed a script that moved to hydra-editor [Justin Coyne]
+* Set a DateTime for date_uploaded and date_modified [Justin Coyne]
+* Remove PSU group management. Fixes #864 [Justin Coyne]
+* Refactor to encapsulate the PSU stuff into one view [Justin Coyne]
+* Deliver mail in a rails 4.2 way [Justin Coyne]
+* Pair back the number of builds [Justin Coyne]
+* Refactor batch methods [Justin Coyne]
+* Sufia should work under Ruby 2.2 [Michael J. Giarlo]
+* Disabled invalid option in the form. Story 9717 [val99erie]
+* Sufia should not override EngineCart's tasks. [Michael J. Giarlo]
+* Bumping to require the latest version of hydra-collections to get the depositor indexed into the collection [Carolyn Cole]
+* Changing to use symbol instead of searchable so that a fuzzy search is not used for the depositor [Carolyn Cole]
+* Don't allow rails 4.2 to fail [ci skip] [Justin Coyne]
+* Updating to allow the forms sent together to be properly enabled after the update [Carolyn Cole]
+* CollectionPresenter should handle title, description, size and total_items [Justin Coyne]
+* Fixed error when user submits upload with no file. Issue 9713 [val99erie]
+* Making test more flexible so it should work with different version of rails [Carolyn Cole]
+* Removed a rescue block Reasoning: * It was an untyped, so it's hard to say which conditions might be expected. This means it was obfuscating errors we should be solving like * It was untested * It didn't work. It didn't set the correct ivars to render the edit view [Justin Coyne]
+* Converted spec file to to 'let' syntax. This is syntax changes only, no code changes. [val99erie]
+* Permit the parameters that allow you to remove a permission Previously, attempting to remove a permission would fail because permissions_attributes id and _destroy were not permitted [Justin Coyne]
+* Preparing for 5.0.0.rc1 release [Carolyn Cole]
+* Preparing for 5.0.0.rc1 release [Carolyn Cole]
+* Bumping for release canidate [cam156]
+* Label and icon for 'My Computer' in upload screen should be separated by a space [Michael J. Giarlo]
+* Don't show collections in shared files list. Story scholarsphere#48 [val99erie]
+* Make sure versions are sorted by the created field (rather than the old date field) [Hector Correa]
+* Preparing for 6.0.0.rc2 release [Michael J. Giarlo]
+* Point at updated HH and JW which specify the FCR4-containing version of hydra-jetty [Michael J. Giarlo]
+* Update README to be more specific about dependency versions [Michael J. Giarlo]
+* Fix malformatted README [Michael J. Giarlo]
+* Update README to point at recommended Rails version and FCR4-compatible Sufia release [Michael J. Giarlo]
+* Clarify recommended Ruby and Rails versions in README [Michael J. Giarlo]
+* Pulled in code from curate to manage add/remove fields on edit forms. Also story #3978 [Carolyn Cole]
+* Changing the file query to be a solr query for loading the file id, so we do not wait lareg file content to load. This speed up the runs significantly on systems with large files or large numbers of files [Carolyn Cole]
+* ORCIDs should allow the final character to be 'X' [Michael J. Giarlo]
+* Update Copyright to 2015 and use i18n [Justin Coyne]
+* Users controller should not call an undefined method. Fixes #532. [Michael J. Giarlo]
+* Fix problem where batch edit forms weren't expanding. Fixes #820 [Carolyn Cole]
+* Rename #initialize_fields_for_edit to #form on Sufia::CollectionsControllerBehavior This is a more descriptive name for what's being done Fixes #834 [Justin Coyne]
+* Upgrade to Bootstrap 3.2 way of doing media elements. the "media-object" class is removed in Bootstrap 3. Attempting to extend the nonexistent class raises an error in sass-rails 3.0 (Rails 4.2) Fixes #813 See http://getbootstrap.com/components/#media [Justin Coyne]
+* CollectionsController should be overrideable by downstream applications [Michael J. Giarlo]
+* Preparing for 6.0.0.rc1 release [Michael J. Giarlo]
+* Update and rename LICENSE.md to LICENSE per community convention. [Michael J. Giarlo]
+* Setup the autocomplete when creating adding a new field with the newest hydra-editor [Justin Coyne]
+* Refactored batch edit javascript. [Justin Coyne]
+* Fix problem where batch edit forms weren't expanding. Fixes #820 [Justin Coyne]
+* Brings some of the fixes in fedora-4/master into master. [Michael J. Giarlo]
+* Fixes endnote export functionality and adds a test [Michael J. Giarlo]
+* Adds production block to generated redis config. [Michael J. Giarlo]
+* Point back at HEAD for hydra-editor [Michael J. Giarlo]
+* Use the curate inspired hydra-editor [Justin Coyne]
+* Adds condition to make the version of sass-rails dependent on the value of RAILS_VERSION [Michael J. Giarlo]
+* Added row class to permission form This makes the wrapping well contain these rows. Otherwise they overflow [Justin Coyne]
+* Remove value_to_boolean which is removed in Rails 4.2 [Justin Coyne]
+* Added a presenter for collections [Justin Coyne]
+* Added PresenterRenderer for displaying GF show view [Justin Coyne]
+* Remove methods that exist in hydra-editor [Justin Coyne]
+* There's no need to pass the record because it's held by the form in f.object. Fixes #761 [Justin Coyne]
+* Put responsibility for protecting attributes into the UserController [Justin Coyne]
+* Removed duplicate declaration of more_or_less_button. Fixes #795 [Justin Coyne]
+* Remove an unused view [Justin Coyne]
+* Moved presenter and forms into hydra-editor [Justin Coyne]
+* Override indexing services rather than to_solr [Justin Coyne]
+* Test rails 4.1 and 4.2 [Justin Coyne]
+* Label and title should use different predicates. Fixes #801 [Justin Coyne]
+* Support for rails 4.2 [Justin Coyne]
+* Use permitted parameters [Justin Coyne]
+* Remove accessible attributes [Justin Coyne]
+* Reverted route helper name change. Fixes #798 [Justin Coyne]
+* Use jbuilder for jQuery upload response [Justin Coyne]
+* Extract form objects from the persistence objects [Justin Coyne]
+* Adding the browse view link into the bread crumbs so it shows on both the edit and the stats page. [Carolyn Cole]
+* Use travis' new container based arch [Justin Coyne]
+* More facets modal defaults to numerical sort [Adam Wead]
+* Upgrade to Blacklight 5.8 [Adam Wead]
+* Faster feature tests by using rack_test driver when possible [Justin Coyne]
+* Upgrade to Blacklight 5.8 [Justin Coyne]
+* Unpend one test, remove another pending test. Fixes #783 The removed test was checking that the batch represented by the passed batch_id was created after the file was uploaded. But Fcrepo4 prevents us from referencing a URI that doesn't have an existing object, so the batches had earlier been set to create immediately. [Justin Coyne]
+* Complete componentizing GenericFile [Justin Coyne]
+* Extract Audit concern into GenericFileAuditService [Justin Coyne]
+* Update visibility without params[:generic_file] [Adam Wead]
+* Ensure we return only GenericFile objects [Adam Wead]
+* Move RepositoryAuditService to the Sufia namespace [Justin Coyne]
+* Added RepositoryAuditService [Justin Coyne]
+* Removed audit! methods. They were never used [Justin Coyne]
+* Restore the audit tests [Justin Coyne]
+* Makes sure empty element is not inserted as an option for the rights dropdown list [Hector Correa]
+* field_form partial does not need generic_file [Justin Coyne]
+* Batch edit only needs one GenericFile to draw the form [Justin Coyne]
+* remove form-horizontal. Fixes #763 [Justin Coyne]
+* Update the edit page to work with the new ActiveFedora versions api [Justin Coyne]
+* Refactored users controller spec [Justin Coyne]
+* Refactor the user model spec [Justin Coyne]
+* remove .tap from the files controller spec [Justin Coyne]
+* Refactor Files controller specs for create [Justin Coyne]
+* Moves GenericFile::Content behaviors out of GenericFile::Metadata and into a separate module [Adam Wead]
+* Post-rebase adjustments [Adam Wead]
+* Bump to version 5.0.0.beta1 [Adam Wead]
+* The rights select box on the form should send an array [Adam Wead]
+* Remove unused css_head and js_head yields [Adam Wead]
+* Check for uniqueness of the field by using the existing class method [Adam Wead]
+* Run audits on ResourceVersion instead of uris [Adam Wead]
+* Bump to active-fedora beta 6 [Adam Wead]
+* Using new versions interface [Adam Wead]
+* Update to hydra-jetty 8.1.1 [Adam Wead]
+* Set multiple to false for on_behalf_of and proxy_depositor [Adam Wead]
+* Adjust string/arrayness of properties [Adam Wead]
+* Handle the more restrictive singular/multiple fields [Adam Wead]
+* Make some properties single valued. Fixes #706 [Adam Wead]
+* Remove audit logic from the view This correctly causes an error which should be resolved by #722 Fixes #734 [Adam Wead]
+* Audit tests updated to tests files with multiple versions. Updated code in ChecksumAuditLog to remove calls to deprecated properties [Adam Wead]
+* Audit_each was missing path argument when calling logs. [Adam Wead]
+* Update hydra-collections to hydra-collections 4.0.0.beta1 [Adam Wead]
+* Audit_job and checksum_audit_logs updated to account for changes in Fedora 4. [Adam Wead]
+* More bootstrap styling fixes [Adam Wead]
+* Use fields_for to handle the permissions form. Fixes #742 [Adam Wead]
+* Update the style on the batch edit page. Fixes #737 [Adam Wead]
+* Versions returns uris and not labels [Adam Wead]
+* Depends on hydra-head 9.0.0.beta1 [Adam Wead]
+* Use hydra-collections 3.0.0.beta1 [Adam Wead]
+* Use hydra-derivatives 1.0.0.beta1 [Adam Wead]
+* Update to active-fedora beta 3 [Adam Wead]
+* Batch Update job should set an array of titles. Fixes #729 [Adam Wead]
+* Restore loading from solr Fixes #711 [Adam Wead]
+* Removed deprecated methods/options [Adam Wead]
+* Use active-fedora from master [Adam Wead]
+* Update dependency to beta2 in the sufia-models gemspec [Adam Wead]
+* Update to AF 9.0.0.beta2 and Sufia 4.2 [Adam Wead]
+* Using ::RDF [Adam Wead]
+* Update to AF 9 beta1 [Adam Wead]
+* Updating tests with ActiveFedora [Adam Wead]
+* on stub_models stub the datastream rather than set it. [Adam Wead]
+* Remove invalid property 'versionable' for contains association [Adam Wead]
+* Fixed a test. Pass an AF::Base object when creating a file [ci skip] [Adam Wead]
+* Update to latest API changes in ActiveFedora [Adam Wead]
+* Switched to use fcrepo4 beta 4 [Adam Wead]
+* Set the content in the test setup before trying to retrieve it [Adam Wead]
+* Use += instead of <<, or change tracking won't work [Adam Wead]
+* Revert changes from #705 The changes only set permission related attributes, but we also need to set the descriptive metadata too. [Adam Wead]
+* Use person instead of user in the spec to avoid a deprecation [Adam Wead]
+* Removed unnecessary delete/destroy in after hooks [Adam Wead]
+* Use a real batch id in GenericFilesController test Otherwhise Fedora will raise a 409 error because it can't find the "batch" resource the predicate points at. [Adam Wead]
+* Restore changes originally made in #688, which were overwritten [Adam Wead]
+* Removed deprecation warnings from job specs [Adam Wead]
+* Remove shift operator An issue with ActiveModel::Dirty is affecting the shift operator in ActiveFedora. Until projecthydra/active_fedora#540 is resolved, we should avoid using it. [Adam Wead]
+* Fixes bug in BatchUpdateJob::update_file by changing how params used to set permissions, conforming to the new way of using #permissions_attributes= instad of #attribures= [Adam Wead]
+* Use the new Permission accessors. Fixes projecthydra/activefedora#547 Depends on projecthydra/hydra-head#215 [Adam Wead]
+* Switch to using index_collection_ids which removes a deprecation [Adam Wead]
+* Fixed error in Collections feature test [Adam Wead]
+* Fixed tests for file usage [Adam Wead]
+* Updated more deprecated methods [Adam Wead]
+* Removed test for reload_on_save [Adam Wead]
+* Update test for accessible attributes to include permissions_attributes [Adam Wead]
+* Look for the correct exception when a file is deleted [Adam Wead]
+* Set permissions in BatchEditsController [Adam Wead]
+* Replaced deprecated method transform_datastream with transform_file [Adam Wead]
+* Removed deprecation warnings [Adam Wead]
+* Removed deprecation warnings [Adam Wead]
+* Use id instead of pid to avoid deprecation [Adam Wead]
+* Use id instead of pid to avoid deprecation [Adam Wead]
+* Remove the properties datastream from Collection [Adam Wead]
+* Remove deprecation by switching pid to id [Adam Wead]
+* Get rid of the properties datastream [Adam Wead]
+* Whitelist permissions_attributes parameter. Fixes projecthydra/active_fedora#550 [Adam Wead]
+* Fixing Sufia's version control [Adam Wead]
+* Don't namespaceize pids. Capture just AccessDenied Errors. Ref projecthydra/active_fedora#546 [Adam Wead]
+* Update tests to show new permissions_attributes usage [Adam Wead]
+* Remove useage of deprecated method datastreams [Adam Wead]
+* Using hydra-jetty/fedora-4/edge [Adam Wead]
+* Update to the latest version of ActiveFedora alpha [Adam Wead]
+* Don't namespace ids [Adam Wead]
+* Refactor spec file to remove some rspec deprecations [Adam Wead]
+* Fix test for characterization [Adam Wead]
+* Spec for file usage should expect escaped slashes [Adam Wead]
+* Featured works shoudn't have namespaces [Adam Wead]
+* Fixed loading trophies [Adam Wead]
+* Fixed GenericFileRdfDatastream spec [Adam Wead]
+* Refactor properties_datastream_spec [Adam Wead]
+* Skip checksum audit log tests [Adam Wead]
+* Fixing file content datastream spec [Adam Wead]
+* Fix batch spec [Adam Wead]
+* Removed the label setter [Adam Wead]
+* Removed Persistence module from spec directory [Adam Wead]
+* No need for fedora 3 namespaces [Adam Wead]
+* Make datastreams versionable [Adam Wead]
+* Upgrading to Fedora 4 [Adam Wead]
+
 ## 5.0.0
 
 * Update README to be more specific about dependency versions [Michael J. Giarlo]

data/README.md

@@ -1,8 +1,50 @@
-# Sufia [![Version](https://badge.fury.io/rb/sufia.png)](http://badge.fury.io/rb/sufia) [![Build Status](https://travis-ci.org/projecthydra/sufia.png?branch=master)](https://travis-ci.org/projecthydra/sufia) [![Dependency Status](https://gemnasium.com/projecthydra/sufia.png)](https://gemnasium.com/projecthydra/sufia)
-
-## What is Sufia?
-Sufia is a component that adds self-deposit institutional repository features to a Rails app.
-Sufia is created with Ruby on Rails and builds on the Hydra Framework.
+[![Stories in Ready](https://badge.waffle.io/projecthydra/sufia.png?label=ready&title=Ready)](https://waffle.io/projecthydra/sufia)
+# Sufia
+
+[![Version](https://badge.fury.io/rb/sufia.png)](http://badge.fury.io/rb/sufia)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/sufia)
+[![Build Status](https://travis-ci.org/projecthydra/sufia.png?branch=master)](https://travis-ci.org/projecthydra/sufia)
+[![Dependency Status](https://gemnasium.com/projecthydra/sufia.png)](https://gemnasium.com/projecthydra/sufia)
+[![Coverage Status](https://img.shields.io/coveralls/projecthydra/sufia.svg)](https://coveralls.io/r/projecthydra/sufia?branch=master)
+
+# Table of Contents
+
+  * [What is Sufia?](#what-is-sufia)
+  * [Help](#help)
+  * [Creating a Sufia-based app](#creating-a-sufia-based-app)
+    * [Prerequisites](#prerequisites)
+      * [Characterization](#characterization)
+    * [Environments](#environments)
+    * [Ruby](#ruby)
+    * [Rails](#rails)
+    * [Sufia-related dependencies](#sufia-related-dependencies)
+      * [Pagination](#pagination)
+    * [Install Sufia](#install-sufia)
+    * [Database tables and indexes](#database-tables-and-indexes)
+    * [Solr and Fedora](#solr-and-fedora)
+    * [Start background workers](#start-background-workers)
+    * [Audiovisual transcoding](#audiovisual-transcoding)
+    * [User interface](#user-interface)
+    * [Integration with Dropbox, Box, etc.](#integration-with-dropbox-box-etc)
+    * [Analytics and usage statistics](#analytics-and-usage-statistics)
+      * [Capturing usage](#capturing-usage)
+      * [Displaying usage in the UI](#displaying-usage-in-the-ui)
+    * [Tag Cloud](#tag-cloud)
+    * [Customizing metadata](#customizing-metadata)
+    * [Proxies and Transfers (Sufia 4.x only)](#proxies-and-transfers-sufia-4x-only)
+  * [License](#license)
+  * [Contributing](#contributing)
+  * [Development](#development)
+    * [Regenerating the README TOC](#regenerating-the-readme-toc)
+    * [Run the test suite](#run-the-test-suite)
+    * [Change validation behavior](#change-validation-behavior)
+  * [Acknowledgments](#acknowledgments)
+
+# What is Sufia?
+
+Sufia is a component that adds self-deposit institutional repository features to a Rails app. Sufia builds on the [Hydra framework](http://projecthydra.org/).
 
 Sufia has the following features:
 
@@ -34,96 +76,167 @@ Sufia has the following features:
 * Dynamically configurable featured works and researchers on homepage
 * Proxy deposit and transfers of ownership
 
-## License
+# Help
 
-Sufia is available under [the Apache 2.0 license](LICENSE.md).
+If you have questions or need help, please email [the Hydra community tech list](mailto:hydra-tech@googlegroups.com) or stop by [the Hydra community IRC channel](irc://irc.freenode.net/projecthydra).
 
-## Contributing
+# Creating a Sufia-based app
 
-We'd love to accept your contributions.  Please see our guide to [contributing to Sufia](CONTRIBUTING.md).
+## Prerequisites
+
+Sufia requires the following software to work:
 
-## Sufia needs the following software to work:
 1. Solr
 1. [Fedora Commons](http://www.fedora-commons.org/) digital repository
-1. A SQL RDBMS (MySQL, SQLite)
+1. A SQL RDBMS (MySQL, PostgreSQL), though **note** that SQLite will be used by default if you're looking to get up and running quickly
 1. [Redis](http://redis.io/) key-value store
 1. [ImageMagick](http://www.imagemagick.org/)
-1. Ruby (*latest 2.1 recommended*)
-2. Rails (*latest 4.1 recommended*)
+1. [FITS](#characterization)
+
+**NOTE: If you do not already have Solr and Fedora instances you can use in your development environment, you may use hydra-jetty (instructions are provided below to get you up and running quickly and with minimal hassle).**
+
+### Characterization
+
+1. Go to http://projects.iq.harvard.edu/fits/downloads and download a copy of FITS & unpack it somewhere on your machine.  You can also install FITS on OSX with homebrew `brew install fits` (you may also have to create a symlink from `fits.sh -> fits` in the next step).
+1. Mark fits.sh as executable (`chmod a+x fits.sh`)
+1. Run "fits.sh -h" from the command line and see a help message to ensure FITS is properly installed
+1. Give your Sufia app access to FITS by:
+    1. Adding the full fits.sh path to your PATH (e.g., in your .bash_profile), **OR**
+    1. Changing `config/initializers/sufia.rb` to point to your FITS location:  `config.fits_path = "/<your full path>/fits.sh"`
 
-#### !! Ensure that you have all of the above components installed before you continue. !!
+## Environments
 
-## Need Help?
+Note here that the following commands assume you're setting up Sufia in a development environment (using the Rails built-in development environment). If you're setting up a production or production-like environment, you may wish to tell Rails that by prepending `RAILS_ENV=production` to the commands that follow, e.g., `rails`, `rake`, `bundle`, and so on.
 
-If you have questions or need help, please email [the Hydra community development list](mailto:hydra-tech@googlegroups.com).
+## Ruby
 
-## Creating an application
+First, you'll need a working Ruby installation. You can install this via your operating system's package manager -- you are likely to get farther with OSX, Linux, or UNIX than Windows but your mileage may vary -- but we recommend using a Ruby version manager such as [RVM](https://rvm.io/) or [rbenv](https://github.com/sstephenson/rbenv).
 
-### Generate base Rails install
+We recommend either Ruby 2.2 or the latest 2.1 version.
+
+## Rails
+
+Generate a new Rails application.  We recommend either Rails 4.2 or the latest 4.1 version.
 
 ```
 gem install rails -v 4.1.8
 rails new my_app
 ```
 
-### Add gems to Gemfile
+## Sufia-related dependencies
+
+Add the following lines to your application's Gemfile.
 
 ```
-gem 'sufia', '6.0.0.rc1'
-gem 'kaminari', github: 'harai/kaminari', branch: 'route_prefix_prototype'  # required to handle pagination properly in dashboard. See https://github.com/amatsuda/kaminari/pull/322
+gem 'sufia', '6.0.0.rc4'
+gem 'kaminari', github: 'jcoyne/kaminari', branch: 'sufia'  # required to handle pagination properly in dashboard. See https://github.com/amatsuda/kaminari/pull/322
 ```
 
-Then `bundle install`
+Then install Sufia as a dependency of your app via `bundle install`
+
+### Pagination
+
+The line with kaminari -- a Ruby library that helps build pagination into applications -- listed as a dependency in the Gemfile is a temporary fix to address a
+[known problem](https://github.com/amatsuda/kaminari/pull/322) in the current release of kaminari.
+
+## Install Sufia
+
+Install Sufia into your app using its built-in install generator. This step adds a number of files that Sufia requires within your Rails app, including e.g. a number of database migrations.
 
-### Run the sufia generator
 ```
 rails generate sufia:install -f
 ```
 
-### Run the migrations
+## Database tables and indexes
+
+Now that Sufia's required database migrations have been generated into your app, you'll need to load them into your application's database.
 
 ```
 rake db:migrate
 ```
 
-### Get a copy of jetty (Solr and Fedora)
+## Solr and Fedora
+
+If you already have instances of Solr and Fedora that you would like to use, you may skip this step. Otherwise feel free to use the bundled copy of Jetty, a Java servlet container that is configured to run versions of Solr and Fedora that are known to work with Sufia.
+
 ```
 rake jetty:clean
 rake sufia:jetty:config
 rake jetty:start
 ```
 
-### To use the CSS and JavaScript and other assets that ship with Sufia...
+## Start background workers
+
+Sufia uses a queuing system named Resque to manage long-running or slow processes. Resque relies on the [redis](http://redis.io/) key-value store, so [redis](http://redis.io/) must be installed *and running* on your system in order for background workers to pick up jobs.
+
+Unless redis has already been started, you will want to start it up. You can do this either by calling the `redis-server` command, or if you're on certain Linuxes, you can do this via `sudo service redis-server start`.
+
+Next you will need to spawn Resque's workers. The following command will run until you stop it, so you may want to do this in a dedicated terminal.
+
+```
+QUEUE=* rake environment resque:work
+```
+
+Or, if you prefer (e.g., in production-like environments), you may want to set up a `config/resque-pool.yml` -- [here is a simple example](https://github.com/projecthydra/sufia/blob/master/sufia-models/lib/generators/sufia/models/templates/config/resque-pool.yml) -- and run resque-pool which will manage your background workers in a dedicated process.
+
+```
+resque-pool --daemon --environment development start
+```
+
+See https://github.com/defunkt/resque for more options. If you do wind up using resque-pool, you might also be interested in a shell script to help manage it. [Here is an example](https://github.com/psu-stewardship/scholarsphere/blob/develop/script/restart_resque.sh) which you can adapt for your needs.
+
+## Audiovisual transcoding
+
+Sufia includes support for transcoding audio and video files.  To enable this, make sure to have ffmpeg > 1.0 installed.
+
+On OSX, you can use homebrew for this.
+
+```
+brew install ffmpeg --with-fdk-aac --with-libvpx --with-libvorbis
+```
+
+To compile ffmpeg yourself, see https://trac.ffmpeg.org/wiki/CompilationGuide
+
+## User interface
+
+**Remove** turbolinks support from `app/assets/stylesheets/application.css` if present:
 
-#### Modify app/assets/stylesheets/application.css
-**Remove** this line, if present:
 ```
 //= require turbolinks
 ```
 
-Turbolinks causes the TinyMCE editor to not load.
+Turbolinks causes the dynamic content editor not to load.
 
-### Install Notes
+## Integration with Dropbox, Box, etc.
 
-#### Kaminari
+Sufia provides built-in support for the [browse-everything](https://github.com/projecthydra/browse-everything) gem, which provides a consolidated file picker experience for selecting files from [DropBox](http://www.dropbox.com),
+[Skydrive](https://skydrive.live.com/), [Google Drive](http://drive.google.com),
+[Box](http://www.box.com), and a server-side directory share.
 
-The line with kaminari listed as a dependency in Gemfile is a temporary fix to address a
-[problem](https://github.com/amatsuda/kaminari/pull/322) in the current release of kaminari.
-Technically you should not have to list kaminari, which is a dependency of blacklight and sufia.
+To activate browse-everything in your sufia app, run the browse-everything config generator
 
-### Proxies and Transfers
+```
+rails g browse_everything:config
+```
 
-To add proxies and transfers to your Sufia 4-based app, run the 'sufia:models:proxies' generator and then run 'rake db:migrate'.
+This will generate a file at _config/browse_everything_providers.yml_. Open that file and enter the API keys for the providers that you want to support in your app.  For more info on configuring browse-everything, go to the [project page](https://github.com/projecthydra/browse-everything) on github.
 
-### Analytics
+After running the browse-everything config generator and setting the API keys for the desired providers, an extra tab will appear in your app's Upload page allowing users to pick files from those providers and submit them into your app's repository.
+
+**If your config/initializers/sufia.rb was generated with sufia 3.7.2 or earlier**, then you need to add this line to an initializer (probably _config/initializers/sufia.rb _):
+```ruby
+config.browse_everything = BrowseEverything.config
+```
+
+## Analytics and usage statistics
 
 Sufia provides support for capturing usage information via Google Analytics and for displaying usage stats in the UI.
 
-#### Capturing usage
+### Capturing usage
 
 To enable the Google Analytics javascript snippet, make sure that `config.google_analytics_id` is set in your app within the `config/initializers/sufia.rb` file. A Google Analytics ID typically looks like _UA-99999999-1_.
 
-#### Displaying usage
+### Displaying usage in the UI
 
 To display data from Google Analytics in the UI, first head to the Google Developers Console and create a new project:
 
@@ -157,84 +270,53 @@ Lastly, you will need to set `config.analytics = true` and `config.analytic_star
 has the proper access within your Google Analyics account.  To do so, go to the _Admin_ tab for your Google Analytics account.
 Click on _User Management_, in the _Account_ column, and add "Read & Analyze" permissions for the OAuth client email address.
 
-### To use browse-everything
+## Tag Cloud
 
-Sufia provides built-in support for the [browse-everything](https://github.com/projecthydra/browse-everything) gem, which provides a consolidated file picker experience for selecting files from [DropBox](http://www.dropbox.com),
-[Skydrive](https://skydrive.live.com/), [Google Drive](http://drive.google.com),
-[Box](http://www.box.com), and a server-side directory share.
+Sufia provides a tag cloud on the home page.  To change which field is displayed in that cloud, change the value of `config.tag_cloud_field_name` in the `blacklight_config` section of your CatalogController.  For example:
 
-To activate browse-everything in your sufia app, run the browse-everything config generator
+```ruby
+configure_blacklight do |config|
+  ...
 
-```
-rails g browse_everything:config
+  # Specify which field to use in the tag cloud on the homepage.
+  # To disable the tag cloud, comment out this line.
+  config.tag_cloud_field_name = Solrizer.solr_name("tag", :facetable)
+end
 ```
 
-This will generate a file at _config/browse_everything_providers.yml_. Open that file and enter the API keys for the providers that you want to support in your app.  For more info on configuring browse-everything, go to the [project page](https://github.com/projecthydra/browse-everything) on github.
+If your CatalogController was generated by a version of Sufia older than 3.7.3 you need to add that line to the Nlacklight configuration in order to make the tag cloud appear.
 
-After running the browse-everything config generator and setting the API keys for the desired providers, an extra tab will appear in your app's Upload page allowing users to pick files from those providers and submit them into your app's repository.
+The contents of the cloud are retrieved as JSON from Blacklight's CatalogController#facet method.  If you need to change how that content is returned (ie. if you need to limit the number of results), override the `render_facet_list_as_json` method in your CatalogController.
 
-*Note*: If you want to use the built-in browse-everything support, _you need to include the browse-everything css and javascript files_. If you already included the sufia css and javascript (see [above](#if-you-want-to-use-the-css-and-javascript-and-other-assets-that-ship-with-sufia)), then you don't need to do anything.  Otherwise, follow the instructions in the [browse-everything README page](https://github.com/projecthydra/browse-everything)
+## Customizing metadata
 
-*If your config/initializers/sufia.rb was generated with sufia 3.7.2 or older*, then you need to add this line to an initializer (probably _config/initializers/sufia.rb _):
-```ruby
-config.browse_everything = BrowseEverything.config
-```
+Chances are you will want to customize the default metadata provided by Sufia.  Here's [a guide](https://github.com/projecthydra/sufia/wiki/Customizing-Metadata) to help you with that
 
-### Install Fits.sh
-1. Go to http://code.google.com/p/fits/downloads/list and download a copy of fits & unpack it somewhere on your machine.  You can also install fits on OSX with homebrew `brew install fits` (you may also have to create a symlink from `fits.sh -> fits` in the next step).
-1. Give your system access to fits
-    1. By adding the path to fits.sh to your excutable PATH. (ex. in your .bashrc)
-        * OR
-    1. By adding/changing config/initializers/sufia.rb to point to your fits location:   `config.fits_path = "/<your full path>/fits.sh"`
-1. You may additionally need to chmod the fits.sh (chmod a+x fits.sh)
-1. You may need to restart your shell to pick up the changes to your path
-1. You should be able to run "fits.sh" from the command line and see a help message
+## Proxies and Transfers (Sufia 4.x only)
 
-### Start background workers
-**Note:** Resque relies on the [redis](http://redis.io/) key-value store.  You must install [redis](http://redis.io/) on your system and *have redis running* in order for this command to work.
-To start redis, you usually want to call the `redis-server` command.
+To add proxies and transfers to your **Sufia 4**-based app, run the 'sufia:models:proxies' generator and then run 'rake db:migrate'.  If you're already running Sufia 5 or 6, this is already added and you may skip this step.
 
-```
-QUEUE=* rake environment resque:work
-```
+# License
 
-For production you may want to set up a config/resque-pool.yml and run resque pool in daemon mode
+Sufia is available under [the Apache 2.0 license](LICENSE.md).
 
-```
-resque-pool --daemon --environment development start
-```
+# Contributing
 
-See https://github.com/defunkt/resque for more options
+We'd love to accept your contributions.  Please see our guide to [contributing to Sufia](CONTRIBUTING.md).
 
-### If you want to enable transcoding of video, install ffmpeg version 1.0+
-#### On a mac
-Use homebrew:
-```
-brew install ffmpeg --with-fdk-aac --with-libvpx --with-libvorbis
-```
-### Tag Cloud
-Sufia provides a tag cloud on the home page.  To change which field is displayed in that cloud, change the value of `config.tag_cloud_field_name` in the `blacklight_config` section of your CatalogController.  For example:
-```ruby
-configure_blacklight do |config|
-  ...
+# Development
 
-  # Specify which field to use in the tag cloud on the homepage.
-  # To disable the tag cloud, comment out this line.
-  config.tag_cloud_field_name = Solrizer.solr_name("tag", :facetable)
-end
-```
+This information is for people who want to modify the engine itself, not an application that uses the engine:
 
-If your CatalogController was generated by a version of sufia older than 3.7.3 you need to add that line to the blacklight configuration in order to make the tag cloud appear.
+## Regenerating the README TOC
 
-The contents of the cloud are retrieved as JSON from Blacklight's CatalogController#facet method.  If you need to change how that content is returned (ie. if you need to limit the number of results), override the `render_facet_list_as_json` method in your CatalogController.
+[Install the gh-md-toc tool](https://github.com/ekalinin/github-markdown-toc/blob/master/README.md#installation), then ensure your README changes are up on GitHub, and then run:
 
-#### On Ubuntu Linux
-See https://ffmpeg.org/trac/ffmpeg/wiki/UbuntuCompilationGuide
+`gh-md-toc https://github.com/USERNAME/sufia/blog/BRANCH/README.md`
 
-## Developers:
-This information is for people who want to modify the engine itself, not an application that uses the engine:
+That will print to stdout the new TOC, which you can copy into `README.md`, commit, and push.
 
-### run the tests
+## Run the test suite
 
 ```
 rake jetty:start
@@ -244,7 +326,7 @@ rake engine_cart:generate
 rake spec
 ```
 
-### Change validation behavior
+## Change validation behavior
 
 To change what happens to files that fail validation add an after_validation hook
 ```
@@ -258,7 +340,7 @@ To change what happens to files that fail validation add an after_validation hoo
     end
 ```
 
-## Acknowledgments
+# Acknowledgments
 
 This software has been developed by and is brought to you by the Hydra community.  Learn more at the
 [Project Hydra website](http://projecthydra.org)