Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samvera-deprecated/curation_concerns
A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) objects (based on Hydra::Works) and providing a generator for defining object types with custom workflows, views, access controls, etc.
https://github.com/samvera-deprecated/curation_concerns
Last synced: about 2 months ago
JSON representation
A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) objects (based on Hydra::Works) and providing a generator for defining object types with custom workflows, views, access controls, etc.
- Host: GitHub
- URL: https://github.com/samvera-deprecated/curation_concerns
- Owner: samvera-deprecated
- License: other
- Created: 2015-05-13T17:17:45.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-02-22T19:14:52.000Z (over 5 years ago)
- Last Synced: 2024-04-22T01:21:45.414Z (5 months ago)
- Language: Ruby
- Homepage:
- Size: 4.65 MB
- Stars: 15
- Watchers: 27
- Forks: 27
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-starred - samvera-deprecated/curation_concerns - A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) objects (based on Hydra::Works) and providing a generator for defining object type (others)
README
# CurationConcerns
Code: [](http://badge.fury.io/rb/curation_concerns)
[](https://travis-ci.org/samvera/curation_concerns)
[](https://coveralls.io/r/samvera/curation_concerns?branch=master)
[](https://codeclimate.com/github/samvera/curation_concerns)
Docs: [](./LICENSE.txt)
[](./CONTRIBUTING.md)
[](http://rubydoc.info/gems/curation_concerns)
Join in: [](http://slack.projecthydra.org/) [](http://waffle.io/samvera/curation_concerns)
# Shift in Community Focus
During 2017, the [Samvera community](http://samvera.org/) consolidated [Sufia](https://github.com/samvera/sufia) and [CurationConcerns](https://github.com/samvera/curation_concerns) into [Hyrax](https://github.com/samvera/hyrax):
* [planning notes on consolidation](https://wiki.duraspace.org/pages/viewpage.action?pageId=87461232))
* [release notes on the bridge of Sufia to Hyrax](https://github.com/samvera/hyrax/releases/tag/v1.0.1)
* [release notes on the bridge of CurationConcerns to Hyrax](https://github.com/samvera/hyrax/releases/tag/v2.0.0)
* [Samvera documentation for developers and managers](https://samvera.github.io)
The Samvera Community effort has shifted its attention to developing out Hyrax.
A Hydra-based Rails Engine that extends an application, adding the ability to Create, Read, Update and Destroy (CRUD) objects (based on [Hydra::Works](http://github.com/samvera/hydra-works)) and providing a generator for defining object types with custom workflows, views, access controls, etc.
## Prerequisites
Curation Concerns requires the following software to work:
1. Solr
1. [Fedora Commons](http://www.fedora-commons.org/) digital repository
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/), a key-value store. The `redlock` gem requires Redis >= 2.6.
1. [ImageMagick](http://www.imagemagick.org/) with JPEG-2000 support.
1. [LibreOffice](https://www.libreoffice.org/download/libreoffice-fresh/)
1. [FITS](#fits) version 0.8.5.
1. [FFMPEG](#ffmpeg)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'curation_concerns'
```
Then execute:
```bash
bundle install
```
Then run the install generator. You will be prompted if you want to overwrite the default `app/controllers/catalog_controller.rb`, to which you should type `Y` (yes). If you don't want to be prompted on overwrite, you may run the generator with the `-f` (force) option.
```bash
rails generate curation_concerns:install
rake db:migrate
```
### FITS
To install FITS 0.8.5:
* Download [fits-0.8.5.zip](http://projects.iq.harvard.edu/files/fits/files/fits-0.8.5.zip) or possibly newer from the [project page](http://projects.iq.harvard.edu/fits/downloads). Unpack it somewhere on your machine. Alternatively, use homebrew on OSX: `brew install fits` (you may also have to create a symlink from fits.sh -> fits in the next step).
* Mark fits.sh as executable (`chmod a+x fits.sh`)
* Run `fits.sh -h` from the command line and see a help message to ensure FITS is properly installed
* Give your app access to FITS by:
* Adding the full **fits.sh** path to your PATH (e.g., in your **.bash_profile**), OR
* Changing **config/initializers/sufia.rb** to point to your FITS location: `config.fits_path = "//fits.sh"`
## FFMPEG
Curation Concerns includes support for transcoding audio and video files with ffmpeg > 1.0 installed.
On OSX, you can use homebrew:
```bash
brew install ffmpeg --with-fdk-aac --with-libvpx --with-libvorbis
```
Otherwise, to compile ffmpeg yourself, see the [CompilationGuide](https://trac.ffmpeg.org/wiki/CompilationGuide).
## Usage
### Generator
To generate a new object type, use the `curation_concerns:work` Rails generator. Follow the usage instructions provided on the command line when you run:
```bash
rails generate curation_concerns:work
```
### Virus Detection
To turn on virus detection, install clamav on your system and add the `clamav` gem to your Gemfile:
```ruby
gem 'clamav'
```
## Testing
If you are modifying the curation_concerns gem and want to run the test suite, follow these steps to set up the test environment.
```bash
rake ci
```
Or you can do all the steps manually:
```bash
solr_wrapper -p 8985 -d solr/config/ --collection_name hydra-test
# in another window
fcrepo_wrapper -p 8986 --no-jms
# in another window
rake engine_cart:generate
rake curation_concerns:spec
```
### Workflow
Load the workflows, workflow states, transitions and user roles:
```
$ rails curation_concerns:workflow:load
```
Now that the Roles are loaded, grant the appropriate roles to the users by visiting the "Workflow Roles" section of the admin dashboard
[Further documentation](https://github.com/samvera/curation_concerns/wiki/Defining-a-Workflow) for defining and customizing workflows.
_Something about notification should go here._
### Adding Sample Data to Test Application
Sometimes when working with the test application, it can be helpful to have a repository populated with some number of objects. Rather than having to create them all through the user interface, which can be timely, the test application bundled with CurationConcerns provides a rake task that automatically creates 24 objects in the test application repository with different titles, levels of visibility, embargoes, and leases:
``` bash
cd .internal_test_app
rake db:seed
```
### Configuring the Administration Panel
To configure the Administration Pane see [Admin Menu Guide](https://github.com/samvera/curation_concerns/wiki/Admin-Menu)
## Help
If you have questions or need help, please email the [Hydra community tech list](mailto:[email protected]) or stop by the [Hydra community IRC channel](irc://irc.freenode.net/projecthydra).