Join the Samvera Slack channel
Provides a wrapper for file characterization.
This software is currently tested against:
- FITS 1.4.1
- Ruby 2.6, 2.7, and 3.0
- Rails 5.2, 6.0, 6.1, and 7.0
hydra-file_characterization is a Core Component of the Samvera community. The documentation for what this means can be found here.
The Samvera community is here to help. Please see our support guide.
If you are using Rails add the following to an initializer (./config/initializers/hydra-file_characterization_config.rb):
Hydra::FileCharacterization.configure do |config|
config.tool_path(:fits, '/path/to/fits')
end
Hydra::FileCharacterization.characterize(File.read(filename), File.basename(filename), :fits)
- Why
file.read
? To highlight that we want a string. In the case of ActiveFedora, we have a StringIO instead of a file. - Why
file.basename
? In the case of Fits, the characterization takes cues from the extension name.
You can call a single characterizer...
xml_string = Hydra::FileCharacterization.characterize(File.read("/path/to/my/file.rb"), 'file.rb', :fits)
...for this particular call, you can specify custom fits path...
xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits) do |config|
config[:fits] = './really/custom/path/to/fits'
end
...or even make the path callable...
xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits) do |config|
config[:fits] = lambda {|filename| … }
end
...or even create your custom characterizer on the file...
xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :my_characterizer) do |config|
config[:my_characterizer] = lambda {|filename| … }
end
You can also call multiple characterizers at the same time.
fits_xml, ffprobe_xml = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits, :ffprobe)
This is possible by adding a characterizer to the Hydra::FileCharacterization::Characterizers
namespace.
Running the tests:
- Install FITS v1.4.1, which is the most recent version we've tested against.
mkdir ~/fits
wget "https://github.com/harvard-lts/fits/releases/download/1.4.1/fits-1.4.1.zip"
unzip -d ~/fits/ "fits-1.4.1.zip"
chmod a+x ~/fits/fits.sh
ln -s ~/fits/fits.sh ~/fits/fits
rm "fits-1.4.1.zip"
- Once FITS is installed, you should be able to run the tests with:
rspec spec
If you're working on PR for this project, create a feature branch off of main
.
This repository follows the Samvera Community Code of Conduct and language recommendations. Please do not create a branch called master
for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.
bundle install
- Increase the version number in
lib/hydra/file_characterization/version.rb
- Increase the same version number in
.github_changelog_generator
- Update
CHANGELOG.md
by running this command:
github_changelog_generator --user samvera --project hydra-file_characterization --token YOUR_GITHUB_TOKEN_HERE
- Commit these changes to the master branch
- Run
rake release
This software has been developed by and is brought to you by the Samvera community. Learn more at the Samvera website.