hydra-file_characterization 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.circleci/config.yml +90 -0
- data/.github_changelog_generator +2 -0
- data/CHANGELOG.md +180 -0
- data/Gemfile +8 -0
- data/README.md +27 -17
- data/hydra-file_characterization.gemspec +4 -2
- data/lib/hydra/file_characterization/version.rb +1 -1
- data/spec/lib/hydra/file_characterization_spec.rb +7 -2
- data/spec/spec_helper.rb +2 -1
- metadata +41 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 45f7b237836fc29047cfa5977c7a2644f5789059c846da12316f3ddd7aaa881c
|
|
4
|
+
data.tar.gz: 2c3e32837e473c11ef863993aa87c7874e07cf41504690bda7adc94e5c443341
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3fcd0bee8d7b702a15a207a0ca07f65d7dc05e00ad1d13c537c1072fa12ded45236e2f301d89dd6eea74ec0b9260bc075e5bf340cce81e1f3eb886978ee5cb78
|
|
7
|
+
data.tar.gz: 8edf19cab005e79a44b18edc1e4a6b086c30ac20d4fa251fdf036b95660d13d055cf17f2fa37cac7040314c7790f277bb37e45af2463bcd91d7dc2c6857c1bad
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
---
|
|
2
|
+
version: 2.1
|
|
3
|
+
orbs:
|
|
4
|
+
samvera: samvera/circleci-orb@0
|
|
5
|
+
jobs:
|
|
6
|
+
test:
|
|
7
|
+
parameters:
|
|
8
|
+
ruby_version:
|
|
9
|
+
type: string
|
|
10
|
+
bundler_version:
|
|
11
|
+
type: string
|
|
12
|
+
default: 1.17.3
|
|
13
|
+
rails_version:
|
|
14
|
+
type: string
|
|
15
|
+
executor:
|
|
16
|
+
name: 'samvera/ruby_fcrepo_solr'
|
|
17
|
+
ruby_version: << parameters.ruby_version >>
|
|
18
|
+
environment:
|
|
19
|
+
RAILS_VERSION: << parameters.rails_version >>
|
|
20
|
+
NOKOGIRI_USE_SYSTEM_LIBRARIES: true
|
|
21
|
+
steps:
|
|
22
|
+
- run:
|
|
23
|
+
name: Install the FITS
|
|
24
|
+
command: |
|
|
25
|
+
mkdir ~/fits
|
|
26
|
+
wget "https://github.com/harvard-lts/fits/releases/download/1.4.1/fits-1.4.1.zip"
|
|
27
|
+
unzip -d ~/fits/ "fits-1.4.1.zip"
|
|
28
|
+
chmod a+x ~/fits/fits.sh
|
|
29
|
+
ln -s ~/fits/fits.sh ~/fits/fits
|
|
30
|
+
rm "fits-1.4.1.zip"
|
|
31
|
+
- samvera/cached_checkout
|
|
32
|
+
- samvera/bundle_for_gem:
|
|
33
|
+
ruby_version: << parameters.ruby_version >>
|
|
34
|
+
bundler_version: << parameters.bundler_version >>
|
|
35
|
+
project: hydra-file_characterization
|
|
36
|
+
- run:
|
|
37
|
+
name: Update the PATH env. variable
|
|
38
|
+
command: |
|
|
39
|
+
echo "export PATH=$HOME/fits:$PATH" >> $BASH_ENV
|
|
40
|
+
source $BASH_ENV
|
|
41
|
+
- samvera/parallel_rspec
|
|
42
|
+
|
|
43
|
+
workflows:
|
|
44
|
+
version: 2
|
|
45
|
+
ci:
|
|
46
|
+
jobs:
|
|
47
|
+
- test:
|
|
48
|
+
name: ruby2-7_rails6-0
|
|
49
|
+
ruby_version: 2.7.0
|
|
50
|
+
rails_version: 6.0.2
|
|
51
|
+
- test:
|
|
52
|
+
name: ruby2-6_rails6-0
|
|
53
|
+
ruby_version: 2.6.5
|
|
54
|
+
rails_version: 6.0.2
|
|
55
|
+
- test:
|
|
56
|
+
name: ruby2-5_rails6-0
|
|
57
|
+
ruby_version: 2.5.7
|
|
58
|
+
rails_version: 6.0.2
|
|
59
|
+
- test:
|
|
60
|
+
name: ruby2-7_rails5-2
|
|
61
|
+
ruby_version: 2.7.0
|
|
62
|
+
rails_version: 5.2.4
|
|
63
|
+
- test:
|
|
64
|
+
name: ruby2-6_rails5-2
|
|
65
|
+
ruby_version: 2.6.5
|
|
66
|
+
rails_version: 5.2.4
|
|
67
|
+
- test:
|
|
68
|
+
name: ruby2-5_rails5-2
|
|
69
|
+
ruby_version: 2.5.7
|
|
70
|
+
rails_version: 5.2.4
|
|
71
|
+
- test:
|
|
72
|
+
name: ruby2-4_rails5-2
|
|
73
|
+
ruby_version: 2.4.9
|
|
74
|
+
rails_version: 5.2.4
|
|
75
|
+
- test:
|
|
76
|
+
name: ruby2-7_rails5-1
|
|
77
|
+
ruby_version: 2.7.0
|
|
78
|
+
rails_version: 5.1.7
|
|
79
|
+
- test:
|
|
80
|
+
name: ruby2-6_rails5-1
|
|
81
|
+
ruby_version: 2.6.5
|
|
82
|
+
rails_version: 5.1.7
|
|
83
|
+
- test:
|
|
84
|
+
name: ruby2-5_rails5-1
|
|
85
|
+
ruby_version: 2.5.7
|
|
86
|
+
rails_version: 5.1.7
|
|
87
|
+
- test:
|
|
88
|
+
name: ruby2-4_rails5-1
|
|
89
|
+
ruby_version: 2.4.9
|
|
90
|
+
rails_version: 5.1.7
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [1.1.1](https://github.com/samvera/hydra-file_characterization/tree/1.1.1) (2020-06-10)
|
|
4
|
+
|
|
5
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v1.1.0...1.1.1)
|
|
6
|
+
|
|
7
|
+
**Closed issues:**
|
|
8
|
+
|
|
9
|
+
- Add support for Ruby 2.7.z releases [\#44](https://github.com/samvera/hydra-file_characterization/issues/44)
|
|
10
|
+
- Test against Rails release 5.1.7 and Ruby releases 2.6.3, 2.5.5, and 2.4.6 [\#41](https://github.com/samvera/hydra-file_characterization/issues/41)
|
|
11
|
+
- Use CircleCI for continuous integration [\#39](https://github.com/samvera/hydra-file_characterization/issues/39)
|
|
12
|
+
|
|
13
|
+
**Merged pull requests:**
|
|
14
|
+
|
|
15
|
+
- Adding Ruby 2.7.z and Rails 6.y.z releases to the CircleCI build configuration [\#46](https://github.com/samvera/hydra-file_characterization/pull/46) ([jrgriffiniii](https://github.com/jrgriffiniii))
|
|
16
|
+
- Update CircleCI Ruby and Rails versions [\#43](https://github.com/samvera/hydra-file_characterization/pull/43) ([botimer](https://github.com/botimer))
|
|
17
|
+
- Updates the CircleCI configuration to test against Rails release 5.1.7 and Ruby releases 2.6.3, 2.5.5, and 2.4.6 [\#42](https://github.com/samvera/hydra-file_characterization/pull/42) ([jrgriffiniii](https://github.com/jrgriffiniii))
|
|
18
|
+
- Integrates CircleCI for continuous integration [\#40](https://github.com/samvera/hydra-file_characterization/pull/40) ([jrgriffiniii](https://github.com/jrgriffiniii))
|
|
19
|
+
|
|
20
|
+
## [v1.1.0](https://github.com/samvera/hydra-file_characterization/tree/v1.1.0) (2019-05-01)
|
|
21
|
+
|
|
22
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v1.0.0...v1.1.0)
|
|
23
|
+
|
|
24
|
+
**Closed issues:**
|
|
25
|
+
|
|
26
|
+
- Release version 1.0.0 [\#31](https://github.com/samvera/hydra-file_characterization/issues/31)
|
|
27
|
+
|
|
28
|
+
**Merged pull requests:**
|
|
29
|
+
|
|
30
|
+
- Allow usage of FITS Servlet [\#38](https://github.com/samvera/hydra-file_characterization/pull/38) ([little9](https://github.com/little9))
|
|
31
|
+
|
|
32
|
+
## [v1.0.0](https://github.com/samvera/hydra-file_characterization/tree/v1.0.0) (2018-08-21)
|
|
33
|
+
|
|
34
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.3...v1.0.0)
|
|
35
|
+
|
|
36
|
+
**Closed issues:**
|
|
37
|
+
|
|
38
|
+
- Remove the Gemnasium badge from README [\#32](https://github.com/samvera/hydra-file_characterization/issues/32)
|
|
39
|
+
- Integrate code coverage analysis [\#30](https://github.com/samvera/hydra-file_characterization/issues/30)
|
|
40
|
+
- Update README badges to point to samvera/hydra-file\_characterization [\#29](https://github.com/samvera/hydra-file_characterization/issues/29)
|
|
41
|
+
- Largest width / height should be used [\#28](https://github.com/samvera/hydra-file_characterization/issues/28)
|
|
42
|
+
- Cut new gem version [\#24](https://github.com/samvera/hydra-file_characterization/issues/24)
|
|
43
|
+
|
|
44
|
+
**Merged pull requests:**
|
|
45
|
+
|
|
46
|
+
- Release version 1.0.0 [\#37](https://github.com/samvera/hydra-file_characterization/pull/37) ([tpendragon](https://github.com/tpendragon))
|
|
47
|
+
- Use CCMWG templates for documentation. [\#36](https://github.com/samvera/hydra-file_characterization/pull/36) ([tpendragon](https://github.com/tpendragon))
|
|
48
|
+
- Resolve \#30; Add coveralls reporting [\#35](https://github.com/samvera/hydra-file_characterization/pull/35) ([botimer](https://github.com/botimer))
|
|
49
|
+
- Resolve \#29; Fix Travis badge links [\#34](https://github.com/samvera/hydra-file_characterization/pull/34) ([botimer](https://github.com/botimer))
|
|
50
|
+
- Resolve \#32; Remove Gemnasium badge [\#33](https://github.com/samvera/hydra-file_characterization/pull/33) ([botimer](https://github.com/botimer))
|
|
51
|
+
- Update travis build matrix [\#27](https://github.com/samvera/hydra-file_characterization/pull/27) ([cbeer](https://github.com/cbeer))
|
|
52
|
+
- Make it clear what contents\_of\_file mean. It wasn't clear to me upon … [\#26](https://github.com/samvera/hydra-file_characterization/pull/26) ([bess](https://github.com/bess))
|
|
53
|
+
|
|
54
|
+
## [v0.3.3](https://github.com/samvera/hydra-file_characterization/tree/v0.3.3) (2015-10-15)
|
|
55
|
+
|
|
56
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.2...v0.3.3)
|
|
57
|
+
|
|
58
|
+
**Merged pull requests:**
|
|
59
|
+
|
|
60
|
+
- Add .travis.yml [\#23](https://github.com/samvera/hydra-file_characterization/pull/23) ([jcoyne](https://github.com/jcoyne))
|
|
61
|
+
- Handle non-xml output from FITS [\#22](https://github.com/samvera/hydra-file_characterization/pull/22) ([jcoyne](https://github.com/jcoyne))
|
|
62
|
+
|
|
63
|
+
## [v0.3.2](https://github.com/samvera/hydra-file_characterization/tree/v0.3.2) (2015-08-31)
|
|
64
|
+
|
|
65
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.1...v0.3.2)
|
|
66
|
+
|
|
67
|
+
**Merged pull requests:**
|
|
68
|
+
|
|
69
|
+
- Remove non-xml output when Fits is called on a jp2 [\#20](https://github.com/samvera/hydra-file_characterization/pull/20) ([jcoyne](https://github.com/jcoyne))
|
|
70
|
+
- Update to rspec 3 syntax [\#19](https://github.com/samvera/hydra-file_characterization/pull/19) ([jcoyne](https://github.com/jcoyne))
|
|
71
|
+
|
|
72
|
+
## [v0.3.1](https://github.com/samvera/hydra-file_characterization/tree/v0.3.1) (2013-10-25)
|
|
73
|
+
|
|
74
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.3.0...v0.3.1)
|
|
75
|
+
|
|
76
|
+
**Merged pull requests:**
|
|
77
|
+
|
|
78
|
+
- Handle File and string filename passed to characterize. [\#17](https://github.com/samvera/hydra-file_characterization/pull/17) ([jcoyne](https://github.com/jcoyne))
|
|
79
|
+
|
|
80
|
+
## [v0.3.0](https://github.com/samvera/hydra-file_characterization/tree/v0.3.0) (2013-10-23)
|
|
81
|
+
|
|
82
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.9...v0.3.0)
|
|
83
|
+
|
|
84
|
+
**Closed issues:**
|
|
85
|
+
|
|
86
|
+
- There should be away to pass a existing file for characterization [\#14](https://github.com/samvera/hydra-file_characterization/issues/14)
|
|
87
|
+
- Convention over configuration. [\#12](https://github.com/samvera/hydra-file_characterization/issues/12)
|
|
88
|
+
|
|
89
|
+
**Merged pull requests:**
|
|
90
|
+
|
|
91
|
+
- Allow characterize to use an existing file, not just a string. [\#15](https://github.com/samvera/hydra-file_characterization/pull/15) ([jcoyne](https://github.com/jcoyne))
|
|
92
|
+
- Fall back to convention for toolname [\#13](https://github.com/samvera/hydra-file_characterization/pull/13) ([jeremyf](https://github.com/jeremyf))
|
|
93
|
+
|
|
94
|
+
## [v0.2.9](https://github.com/samvera/hydra-file_characterization/tree/v0.2.9) (2013-10-12)
|
|
95
|
+
|
|
96
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.8...v0.2.9)
|
|
97
|
+
|
|
98
|
+
## [v0.2.8](https://github.com/samvera/hydra-file_characterization/tree/v0.2.8) (2013-10-11)
|
|
99
|
+
|
|
100
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.7...v0.2.8)
|
|
101
|
+
|
|
102
|
+
## [v0.2.7](https://github.com/samvera/hydra-file_characterization/tree/v0.2.7) (2013-10-11)
|
|
103
|
+
|
|
104
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.6...v0.2.7)
|
|
105
|
+
|
|
106
|
+
## [v0.2.6](https://github.com/samvera/hydra-file_characterization/tree/v0.2.6) (2013-10-11)
|
|
107
|
+
|
|
108
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.5...v0.2.6)
|
|
109
|
+
|
|
110
|
+
## [v0.2.5](https://github.com/samvera/hydra-file_characterization/tree/v0.2.5) (2013-10-10)
|
|
111
|
+
|
|
112
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.4...v0.2.5)
|
|
113
|
+
|
|
114
|
+
## [v0.2.4](https://github.com/samvera/hydra-file_characterization/tree/v0.2.4) (2013-10-10)
|
|
115
|
+
|
|
116
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.3...v0.2.4)
|
|
117
|
+
|
|
118
|
+
## [v0.2.3](https://github.com/samvera/hydra-file_characterization/tree/v0.2.3) (2013-10-10)
|
|
119
|
+
|
|
120
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.2...v0.2.3)
|
|
121
|
+
|
|
122
|
+
## [v0.2.2](https://github.com/samvera/hydra-file_characterization/tree/v0.2.2) (2013-10-10)
|
|
123
|
+
|
|
124
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.1...v0.2.2)
|
|
125
|
+
|
|
126
|
+
## [v0.2.1](https://github.com/samvera/hydra-file_characterization/tree/v0.2.1) (2013-10-10)
|
|
127
|
+
|
|
128
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.2.0...v0.2.1)
|
|
129
|
+
|
|
130
|
+
## [v0.2.0](https://github.com/samvera/hydra-file_characterization/tree/v0.2.0) (2013-09-19)
|
|
131
|
+
|
|
132
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.3...v0.2.0)
|
|
133
|
+
|
|
134
|
+
## [v0.1.3](https://github.com/samvera/hydra-file_characterization/tree/v0.1.3) (2013-09-19)
|
|
135
|
+
|
|
136
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.2...v0.1.3)
|
|
137
|
+
|
|
138
|
+
## [v0.1.2](https://github.com/samvera/hydra-file_characterization/tree/v0.1.2) (2013-09-19)
|
|
139
|
+
|
|
140
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.1...v0.1.2)
|
|
141
|
+
|
|
142
|
+
## [v0.1.1](https://github.com/samvera/hydra-file_characterization/tree/v0.1.1) (2013-09-19)
|
|
143
|
+
|
|
144
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.1.0...v0.1.1)
|
|
145
|
+
|
|
146
|
+
## [v0.1.0](https://github.com/samvera/hydra-file_characterization/tree/v0.1.0) (2013-09-19)
|
|
147
|
+
|
|
148
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.0.2...v0.1.0)
|
|
149
|
+
|
|
150
|
+
**Merged pull requests:**
|
|
151
|
+
|
|
152
|
+
- Adding characterizer lookup by tool name [\#11](https://github.com/samvera/hydra-file_characterization/pull/11) ([jeremyf](https://github.com/jeremyf))
|
|
153
|
+
- Renaming Characterizer to Characterizers::Fits [\#10](https://github.com/samvera/hydra-file_characterization/pull/10) ([jeremyf](https://github.com/jeremyf))
|
|
154
|
+
|
|
155
|
+
## [v0.0.2](https://github.com/samvera/hydra-file_characterization/tree/v0.0.2) (2013-09-18)
|
|
156
|
+
|
|
157
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/v0.0.1...v0.0.2)
|
|
158
|
+
|
|
159
|
+
**Closed issues:**
|
|
160
|
+
|
|
161
|
+
- Tests fails as my fits is known as fits.sh [\#5](https://github.com/samvera/hydra-file_characterization/issues/5)
|
|
162
|
+
- File characterization for analysing a compressed file [\#4](https://github.com/samvera/hydra-file_characterization/issues/4)
|
|
163
|
+
- File Characterization for file that confuses fits [\#3](https://github.com/samvera/hydra-file_characterization/issues/3)
|
|
164
|
+
- File Characterization for a missing file on file system [\#2](https://github.com/samvera/hydra-file_characterization/issues/2)
|
|
165
|
+
- File Characterization for file on file system [\#1](https://github.com/samvera/hydra-file_characterization/issues/1)
|
|
166
|
+
|
|
167
|
+
**Merged pull requests:**
|
|
168
|
+
|
|
169
|
+
- Adding next steps to the README [\#9](https://github.com/samvera/hydra-file_characterization/pull/9) ([jeremyf](https://github.com/jeremyf))
|
|
170
|
+
- Adding fits command output [\#8](https://github.com/samvera/hydra-file_characterization/pull/8) ([jeremyf](https://github.com/jeremyf))
|
|
171
|
+
- Verifying characterization of zip file [\#7](https://github.com/samvera/hydra-file_characterization/pull/7) ([jeremyf](https://github.com/jeremyf))
|
|
172
|
+
- Custom exception [\#6](https://github.com/samvera/hydra-file_characterization/pull/6) ([rbalekai](https://github.com/rbalekai))
|
|
173
|
+
|
|
174
|
+
## [v0.0.1](https://github.com/samvera/hydra-file_characterization/tree/v0.0.1) (2013-09-17)
|
|
175
|
+
|
|
176
|
+
[Full Changelog](https://github.com/samvera/hydra-file_characterization/compare/2e61599ffbe12cb13dd1d3f575716507bdaac7d1...v0.0.1)
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
|
data/Gemfile
CHANGED
|
@@ -2,3 +2,11 @@ source 'https://rubygems.org'
|
|
|
2
2
|
|
|
3
3
|
# Specify your gem's dependencies in hydra/file_characterization.gemspec
|
|
4
4
|
gemspec
|
|
5
|
+
|
|
6
|
+
if ENV['RAILS_VERSION']
|
|
7
|
+
if ENV['RAILS_VERSION'] == 'edge'
|
|
8
|
+
gem 'rails', github: 'rails/rails'
|
|
9
|
+
else
|
|
10
|
+
gem 'rails', ENV['RAILS_VERSION']
|
|
11
|
+
end
|
|
12
|
+
end
|
data/README.md
CHANGED
|
@@ -1,11 +1,8 @@
|
|
|
1
1
|
# hydra-file_characterization
|
|
2
2
|
|
|
3
|
-
Code: [](http://badge.fury.io/rb/hydra-file_characterization)
|
|
4
|
-
[](https://travis-ci.org/samvera/hydra-file_characterization)
|
|
5
|
-
[](https://coveralls.io/github/samvera/hydra-file_characterization?branch=master)
|
|
3
|
+
Code: [](http://badge.fury.io/rb/hydra-file_characterization) [](https://circleci.com/gh/samvera/hydra-file_characterization) [](https://coveralls.io/github/samvera/hydra-file_characterization?branch=master)
|
|
6
4
|
|
|
7
|
-
Docs: [](./CONTRIBUTING.md)
|
|
8
|
-
[](./LICENSE)
|
|
5
|
+
Docs: [](./CONTRIBUTING.md) [](./LICENSE)
|
|
9
6
|
|
|
10
7
|
Jump in: [](http://slack.samvera.org/)
|
|
11
8
|
|
|
@@ -15,9 +12,7 @@ Provides a wrapper for file characterization.
|
|
|
15
12
|
|
|
16
13
|
## Product Owner & Maintenance
|
|
17
14
|
|
|
18
|
-
hydra-file_characterization is a Core Component of the Samvera community. The documentation for
|
|
19
|
-
what this means can be found
|
|
20
|
-
[here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
|
|
15
|
+
hydra-file_characterization is a Core Component of the Samvera community. The documentation for what this means can be found [here](http://samvera.github.io/core_components.html#requirements-for-a-core-component).
|
|
21
16
|
|
|
22
17
|
### Product Owner
|
|
23
18
|
|
|
@@ -36,19 +31,21 @@ Hydra::FileCharacterization.configure do |config|
|
|
|
36
31
|
config.tool_path(:fits, '/path/to/fits')
|
|
37
32
|
end
|
|
38
33
|
```
|
|
34
|
+
|
|
39
35
|
```ruby
|
|
40
|
-
Hydra::FileCharacterization.characterize(File.read(filename), File.basename(filename), :fits)
|
|
36
|
+
Hydra::FileCharacterization.characterize(File.read(filename), File.basename(filename), :fits)
|
|
37
|
+
```
|
|
41
38
|
|
|
42
|
-
|
|
43
|
-
|
|
39
|
+
- Why `file.read`? To highlight that we want a string. In the case of ActiveFedora, we have a StringIO instead of a file.
|
|
40
|
+
- Why `file.basename`? In the case of Fits, the characterization takes cues from the extension name.
|
|
44
41
|
|
|
45
|
-
You can call a single characterizer
|
|
42
|
+
You can call a single characterizer...
|
|
46
43
|
|
|
47
44
|
```ruby
|
|
48
45
|
xml_string = Hydra::FileCharacterization.characterize(File.read("/path/to/my/file.rb"), 'file.rb', :fits)
|
|
49
46
|
```
|
|
50
47
|
|
|
51
|
-
|
|
48
|
+
...for this particular call, you can specify custom fits path...
|
|
52
49
|
|
|
53
50
|
```ruby
|
|
54
51
|
xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits) do |config|
|
|
@@ -56,7 +53,7 @@ xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.
|
|
|
56
53
|
end
|
|
57
54
|
```
|
|
58
55
|
|
|
59
|
-
|
|
56
|
+
...or even make the path callable...
|
|
60
57
|
|
|
61
58
|
```ruby
|
|
62
59
|
xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :fits) do |config|
|
|
@@ -64,7 +61,7 @@ xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.
|
|
|
64
61
|
end
|
|
65
62
|
```
|
|
66
63
|
|
|
67
|
-
|
|
64
|
+
...or even create your custom characterizer on the file...
|
|
68
65
|
|
|
69
66
|
```ruby
|
|
70
67
|
xml_string = Hydra::FileCharacterization.characterize(contents_of_a_file, 'file.rb', :my_characterizer) do |config|
|
|
@@ -82,9 +79,22 @@ fits_xml, ffprobe_xml = Hydra::FileCharacterization.characterize(contents_of_a_f
|
|
|
82
79
|
|
|
83
80
|
This is possible by adding a characterizer to the `Hydra::FileCharacterization::Characterizers`' namespace.
|
|
84
81
|
|
|
82
|
+
## Releasing
|
|
83
|
+
|
|
84
|
+
1. `bundle install`
|
|
85
|
+
2. Increase the version number in `lib/hydra/file_characterization/version.rb`
|
|
86
|
+
3. Increase the same version number in `.github_changelog_generator`
|
|
87
|
+
4. Update `CHANGELOG.md` by running this command:
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
github_changelog_generator --user samvera --project hydra-file_characterization --token YOUR_GITHUB_TOKEN_HERE
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
5. Commit these changes to the master branch
|
|
94
|
+
6. Run `rake release`
|
|
95
|
+
|
|
85
96
|
# Acknowledgments
|
|
86
97
|
|
|
87
|
-
This software has been developed by and is brought to you by the Samvera community.
|
|
88
|
-
[Samvera website](http://samvera.org/).
|
|
98
|
+
This software has been developed by and is brought to you by the Samvera community. Learn more at the [Samvera website](http://samvera.org/).
|
|
89
99
|
|
|
90
100
|

|
|
@@ -30,8 +30,10 @@ Gem::Specification.new do |gem|
|
|
|
30
30
|
|
|
31
31
|
gem.add_dependency "activesupport", ">= 3.0.0"
|
|
32
32
|
gem.add_development_dependency 'coveralls'
|
|
33
|
-
gem.add_development_dependency
|
|
34
|
-
gem.add_development_dependency "rspec"
|
|
33
|
+
gem.add_development_dependency 'github_changelog_generator'
|
|
35
34
|
gem.add_development_dependency "guard"
|
|
36
35
|
gem.add_development_dependency 'guard-rspec'
|
|
36
|
+
gem.add_development_dependency "rake"
|
|
37
|
+
gem.add_development_dependency "rspec"
|
|
38
|
+
gem.add_development_dependency 'rspec_junit_formatter'
|
|
37
39
|
end
|
|
@@ -18,10 +18,15 @@ module Hydra
|
|
|
18
18
|
end
|
|
19
19
|
|
|
20
20
|
describe 'with configured path' do
|
|
21
|
+
let(:tool_path) do
|
|
22
|
+
`which fits || which fits.sh`.strip
|
|
23
|
+
end
|
|
24
|
+
|
|
21
25
|
it {
|
|
22
26
|
response = Hydra::FileCharacterization.characterize(content, filename, :fits) do |config|
|
|
23
|
-
config[:fits] =
|
|
27
|
+
config[:fits] = tool_path
|
|
24
28
|
end
|
|
29
|
+
|
|
25
30
|
expect(response).to match(/#{'<identity format="Plain text" mimetype="text/plain"'}/)
|
|
26
31
|
}
|
|
27
32
|
end
|
|
@@ -89,7 +94,7 @@ module Hydra
|
|
|
89
94
|
Hydra::FileCharacterization::Characterizers::Fits.tool_path = old_tool_path
|
|
90
95
|
end
|
|
91
96
|
|
|
92
|
-
it 'without configuration', unless: ENV['
|
|
97
|
+
it 'without configuration', unless: ENV['CI'] do
|
|
93
98
|
Hydra::FileCharacterization.configure do |config|
|
|
94
99
|
config.tool_path(:fits, nil)
|
|
95
100
|
end
|
data/spec/spec_helper.rb
CHANGED
|
@@ -30,6 +30,7 @@ RSpec.configure do |config|
|
|
|
30
30
|
# --seed 1234
|
|
31
31
|
config.order = 'random'
|
|
32
32
|
config.before(:suite) do
|
|
33
|
-
|
|
33
|
+
tool_path = `which fits || which fits.sh`.strip
|
|
34
|
+
Hydra::FileCharacterization::Characterizers::Fits.tool_path = tool_path
|
|
34
35
|
end
|
|
35
36
|
end
|
metadata
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: hydra-file_characterization
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- James Treacy
|
|
8
8
|
- Jeremy Friesen
|
|
9
9
|
- Sue Richeson
|
|
10
10
|
- Rajesh Balekai
|
|
11
|
-
autorequire:
|
|
11
|
+
autorequire:
|
|
12
12
|
bindir: bin
|
|
13
13
|
cert_chain: []
|
|
14
|
-
date:
|
|
14
|
+
date: 2020-06-10 00:00:00.000000000 Z
|
|
15
15
|
dependencies:
|
|
16
16
|
- !ruby/object:Gem::Dependency
|
|
17
17
|
name: activesupport
|
|
@@ -42,7 +42,7 @@ dependencies:
|
|
|
42
42
|
- !ruby/object:Gem::Version
|
|
43
43
|
version: '0'
|
|
44
44
|
- !ruby/object:Gem::Dependency
|
|
45
|
-
name:
|
|
45
|
+
name: github_changelog_generator
|
|
46
46
|
requirement: !ruby/object:Gem::Requirement
|
|
47
47
|
requirements:
|
|
48
48
|
- - ">="
|
|
@@ -56,7 +56,7 @@ dependencies:
|
|
|
56
56
|
- !ruby/object:Gem::Version
|
|
57
57
|
version: '0'
|
|
58
58
|
- !ruby/object:Gem::Dependency
|
|
59
|
-
name:
|
|
59
|
+
name: guard
|
|
60
60
|
requirement: !ruby/object:Gem::Requirement
|
|
61
61
|
requirements:
|
|
62
62
|
- - ">="
|
|
@@ -70,7 +70,7 @@ dependencies:
|
|
|
70
70
|
- !ruby/object:Gem::Version
|
|
71
71
|
version: '0'
|
|
72
72
|
- !ruby/object:Gem::Dependency
|
|
73
|
-
name: guard
|
|
73
|
+
name: guard-rspec
|
|
74
74
|
requirement: !ruby/object:Gem::Requirement
|
|
75
75
|
requirements:
|
|
76
76
|
- - ">="
|
|
@@ -84,7 +84,35 @@ dependencies:
|
|
|
84
84
|
- !ruby/object:Gem::Version
|
|
85
85
|
version: '0'
|
|
86
86
|
- !ruby/object:Gem::Dependency
|
|
87
|
-
name:
|
|
87
|
+
name: rake
|
|
88
|
+
requirement: !ruby/object:Gem::Requirement
|
|
89
|
+
requirements:
|
|
90
|
+
- - ">="
|
|
91
|
+
- !ruby/object:Gem::Version
|
|
92
|
+
version: '0'
|
|
93
|
+
type: :development
|
|
94
|
+
prerelease: false
|
|
95
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
96
|
+
requirements:
|
|
97
|
+
- - ">="
|
|
98
|
+
- !ruby/object:Gem::Version
|
|
99
|
+
version: '0'
|
|
100
|
+
- !ruby/object:Gem::Dependency
|
|
101
|
+
name: rspec
|
|
102
|
+
requirement: !ruby/object:Gem::Requirement
|
|
103
|
+
requirements:
|
|
104
|
+
- - ">="
|
|
105
|
+
- !ruby/object:Gem::Version
|
|
106
|
+
version: '0'
|
|
107
|
+
type: :development
|
|
108
|
+
prerelease: false
|
|
109
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
110
|
+
requirements:
|
|
111
|
+
- - ">="
|
|
112
|
+
- !ruby/object:Gem::Version
|
|
113
|
+
version: '0'
|
|
114
|
+
- !ruby/object:Gem::Dependency
|
|
115
|
+
name: rspec_junit_formatter
|
|
88
116
|
requirement: !ruby/object:Gem::Requirement
|
|
89
117
|
requirements:
|
|
90
118
|
- - ">="
|
|
@@ -107,9 +135,12 @@ executables: []
|
|
|
107
135
|
extensions: []
|
|
108
136
|
extra_rdoc_files: []
|
|
109
137
|
files:
|
|
138
|
+
- ".circleci/config.yml"
|
|
139
|
+
- ".github_changelog_generator"
|
|
110
140
|
- ".gitignore"
|
|
111
141
|
- ".rspec"
|
|
112
142
|
- ".travis.yml"
|
|
143
|
+
- CHANGELOG.md
|
|
113
144
|
- CODE_OF_CONDUCT.md
|
|
114
145
|
- CONTRIBUTING.md
|
|
115
146
|
- Gemfile
|
|
@@ -147,7 +178,7 @@ homepage: https://github.com/projecthydra/hydra-file_characterization
|
|
|
147
178
|
licenses:
|
|
148
179
|
- APACHE2
|
|
149
180
|
metadata: {}
|
|
150
|
-
post_install_message:
|
|
181
|
+
post_install_message:
|
|
151
182
|
rdoc_options: []
|
|
152
183
|
require_paths:
|
|
153
184
|
- lib
|
|
@@ -162,9 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
162
193
|
- !ruby/object:Gem::Version
|
|
163
194
|
version: '0'
|
|
164
195
|
requirements: []
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
signing_key:
|
|
196
|
+
rubygems_version: 3.1.0.pre1
|
|
197
|
+
signing_key:
|
|
168
198
|
specification_version: 4
|
|
169
199
|
summary: To provide a wrapper for file characterization
|
|
170
200
|
test_files:
|