Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samvera/hydra-works
A ruby gem implementation of the PCDM Works domain model based on the Samvera software stack
https://github.com/samvera/hydra-works
core-components pcdm ruby samvera-community
Last synced: about 2 months ago
JSON representation
A ruby gem implementation of the PCDM Works domain model based on the Samvera software stack
- Host: GitHub
- URL: https://github.com/samvera/hydra-works
- Owner: samvera
- License: other
- Created: 2014-10-07T01:09:07.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-02-14T21:19:40.000Z (11 months ago)
- Last Synced: 2024-04-26T14:21:55.000Z (8 months ago)
- Topics: core-components, pcdm, ruby, samvera-community
- Language: Ruby
- Homepage:
- Size: 1.57 MB
- Stars: 24
- Watchers: 62
- Forks: 14
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Hydra::Works
Code:
[](http://badge.fury.io/rb/hydra-works)
[](https://circleci.com/gh/samvera/hydra-works)
[](https://coveralls.io/r/samvera/hydra-works?branch=main)
[](https://codeclimate.com/github/samvera/hydra-works)
Docs:
[](./CONTRIBUTING.md)
[](./LICENSE)
[](http://rubydoc.info/gems/hydra-works)
Community Support: [](http://slack.samvera.org/)
# What is hydra-works?
The Hydra::Works gem implements the [PCDM](https://github.com/duraspace/pcdm/wiki) [Works](https://github.com/duraspace/pcdm/blob/main/pcdm-ext/works.rdf) data model using ActiveFedora-based models. In addition to the models, Hydra::Works includes associated behaviors around the broad concept of describable "works" or intellectual entities, the need for which was expressed by a variety of [Samvera community use cases](https://github.com/samvera/hydra-works/tree/main/use-cases).
## Product Owner & Maintenance
`hydra-works` was a Core Component of the Samvera Community. Given a decline in available labor required for maintenance, this project no longer has a dedicated Product Owner. The documentation for what this means can be found [here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
### Product Owner
**Vacant**
_Until a Product Owner has been identified, we ask that you please direct all requests for support, bug reports, and general questions to the [`#dev` Channel on the Samvera Slack](https://samvera.slack.com/app_redirect?channel=dev)._
# Help
The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).
# Getting Started
The PCDM Works domain model includes the following high-level entities:
* **Collection**: a *pcdm:Collection* that indirectly contains zero or more **Works** and zero or more **Collection**s
* **Work**: a *pcdm:Object* that holds zero or more **FileSets** and zero or more **Works**
* **FileSet**: a *pcdm:Object* that groups one or more related *pcdm:Files*, such as an original file (e.g., PDF document), its derivatives (e.g., a thumbnail), and extracted full-text
View [a diagram of the Hydra::Works domain model](https://docs.google.com/drawings/d/1if47TYgEhqDLPh3D0026B_cBLa0BEAOpWPs8AqoQMZE/edit).
Behaviors included in the model include:
* Characterization of original files within FileSets
* Generation of derivatives from original files
* Virus checking of original files
* Full-text extraction from original files
## Dependencies
Check out the [Hydra::Derivatives README](https://github.com/samvera/hydra-derivatives#dependencies) for dependencies.
## Additional dependencies required for specs
#### ClamAV
* Mac installation
```
$ brew install clamav
$ cp /usr/local/etc/clamav/freshclam.conf.sample /usr/local/etc/clamav/freshclam.conf
$ freshclam
```
## Installation
Add these lines to your application's Gemfile:
gem 'hydra-works', '~> 0.15'
And then execute:
$ bundle install
Or install it yourself:
$ gem install hydra-works
## Usage
Usage involves extending the behavior provided by this gem. In your application, you can create Hydra::Works-based models like so:
```ruby
class Collection < ActiveFedora::Base
include Hydra::Works::CollectionBehavior
end
class Book < ActiveFedora::Base
include Hydra::Works::WorkBehavior
end
class Page < ActiveFedora::Base
include Hydra::Works::FileSetBehavior
end
collection = Collection.create
book = Book.create
page = Page.create
collection.members << book
collection.save
book.members << page
book.save
file = page.files.build
file.content = "The quick brown fox jumped over the lazy dog."
page.save
```
## Virus Detection
To turn on virus detection, install [ClamAV](https://www.clamav.net/documents/installing-clamav) on your system and add the `clamby` gem to your Gemfile
```ruby
gem 'clamby'
```
Then include the `VirusCheck` module in your `FileSet` class:
```ruby
class Page < ActiveFedora::Base
include Hydra::Works::FileSetBehavior
include Hydra::Works::VirusCheck
end
```
## Access controls
We are using [Web ACL](http://www.w3.org/wiki/WebAccessControl) as implemented by [hydra-access-controls](https://github.com/samvera/hydra-head/tree/main/hydra-access-controls).
## How to contribute
If you'd like to contribute to this effort, please check out the [contributing guidelines](CONTRIBUTING.md)
## Development
### Testing with the continuous integration server
You can test Hydra::Works using the same process as our continuous
integration server. To do that, run the default rake task which will download Solr and Fedora, start them,
and run the tests for you.
```bash
rake
```
### Testing manually
If you want to run the tests manually, first run solr and FCRepo. To start solr:
```bash
solr_wrapper -v -d solr/config/ -n hydra-test -p 8985
```
To start FCRepo, open another shell and run:
```bash
fcrepo_wrapper -v -p 8986 --no-jms
```
Note you won't find these ports mentioned in this codebase, as testing behavior is inherited from ActiveFedora.
Now you’re ready to run the tests. In the directory where hydra-works
is installed, run:
```bash
rake works:spec
```
# Acknowledgments
This software has been developed by and is brought to you by the Samvera community. Learn more at the
[Samvera website](http://samvera.org/).
