arclight 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (153) hide show
  1. checksums.yaml +4 -4
  2. data/.all-contributorsrc +450 -0
  3. data/.babelrc +3 -0
  4. data/.codeclimate.yml +5 -0
  5. data/.eslintrc +3 -0
  6. data/.rubocop.yml +19 -0
  7. data/.rubocop_todo.yml +15 -135
  8. data/.travis.yml +2 -2
  9. data/CONTRIBUTORS.md +79 -0
  10. data/README.md +21 -24
  11. data/Rakefile +0 -1
  12. data/app/assets/images/blacklight/bookmark.svg +1 -0
  13. data/app/assets/images/blacklight/collection.svg +5 -0
  14. data/app/assets/images/blacklight/compact.svg +1 -25
  15. data/app/assets/images/blacklight/container.svg +5 -0
  16. data/app/assets/images/blacklight/ead.svg +1 -0
  17. data/app/assets/images/blacklight/file.svg +5 -0
  18. data/app/assets/images/blacklight/folder.svg +1 -0
  19. data/app/assets/images/blacklight/list.svg +1 -0
  20. data/app/assets/images/blacklight/minus.svg +1 -0
  21. data/app/assets/images/blacklight/online.svg +5 -0
  22. data/app/assets/images/blacklight/pdf.svg +1 -0
  23. data/app/assets/images/blacklight/plus.svg +1 -0
  24. data/app/assets/images/blacklight/repository.svg +1 -0
  25. data/app/assets/javascripts/arclight/arclight.js +1 -3
  26. data/app/assets/javascripts/arclight/collection_navigation.js +36 -53
  27. data/app/assets/javascripts/arclight/collection_scrollspy.js +1 -1
  28. data/app/assets/javascripts/arclight/context_navigation.js +374 -0
  29. data/app/assets/javascripts/arclight/truncator.js.erb +8 -2
  30. data/app/assets/stylesheets/arclight/application.scss +3 -1
  31. data/app/assets/stylesheets/arclight/bootstrap_overrides.scss +23 -0
  32. data/app/assets/stylesheets/arclight/modules/context_navigation.scss +75 -0
  33. data/app/assets/stylesheets/arclight/modules/hierarchy_and_online_contents.scss +28 -35
  34. data/app/assets/stylesheets/arclight/modules/highlights.scss +2 -1
  35. data/app/assets/stylesheets/arclight/modules/layout.scss +128 -14
  36. data/app/assets/stylesheets/arclight/modules/mastheads.scss +27 -5
  37. data/app/assets/stylesheets/arclight/modules/repositories.scss +1 -5
  38. data/app/assets/stylesheets/arclight/modules/repository_card.scss +6 -7
  39. data/app/assets/stylesheets/arclight/modules/search_results.scss +145 -24
  40. data/app/assets/stylesheets/arclight/modules/show_collection.scss +38 -59
  41. data/app/assets/stylesheets/arclight/responsive.scss +13 -0
  42. data/app/assets/stylesheets/arclight/variables.scss +21 -1
  43. data/app/controllers/concerns/arclight/ead_format_helpers.rb +225 -0
  44. data/app/controllers/concerns/arclight/field_config_helpers.rb +23 -7
  45. data/app/factories/blacklight_field_configuration_factory.rb +1 -0
  46. data/app/helpers/arclight_helper.rb +197 -35
  47. data/app/models/arclight/document_downloads.rb +125 -0
  48. data/app/models/arclight/parent.rb +4 -2
  49. data/app/models/arclight/parents.rb +6 -4
  50. data/app/models/arclight/requests/aeon_external_request.rb +42 -0
  51. data/app/models/arclight/requests/aeon_web_ead.rb +47 -0
  52. data/app/models/arclight/requests/google_form.rb +2 -2
  53. data/app/models/concerns/arclight/catalog.rb +14 -2
  54. data/app/models/concerns/arclight/search_behavior.rb +27 -12
  55. data/app/models/concerns/arclight/solr_document.rb +29 -7
  56. data/app/views/arclight/_requests.html.erb +7 -0
  57. data/app/views/arclight/repositories/_in_person_repository.html.erb +1 -1
  58. data/app/views/arclight/repositories/_repository.html.erb +2 -2
  59. data/app/views/arclight/repositories/_repository_contact.html.erb +9 -0
  60. data/app/views/arclight/repositories/index.html.erb +3 -0
  61. data/app/views/arclight/repositories/show.html.erb +5 -4
  62. data/app/views/arclight/requests/_aeon_external_request_endpoint.html.erb +9 -0
  63. data/app/views/arclight/requests/_aeon_web_ead.html.erb +7 -0
  64. data/app/views/arclight/requests/_google_form.html.erb +2 -1
  65. data/app/views/arclight/viewers/_oembed.html.erb +2 -1
  66. data/app/views/catalog/_access_contents.html.erb +15 -0
  67. data/app/views/catalog/_arclight_abstract_or_scope.html.erb +5 -0
  68. data/app/views/catalog/_arclight_bookmark_control.html.erb +38 -0
  69. data/app/views/catalog/_arclight_document_header_icon.html.erb +1 -0
  70. data/app/views/catalog/_arclight_index_compact_default.html.erb +18 -11
  71. data/app/views/catalog/_arclight_index_default.html.erb +45 -0
  72. data/app/views/catalog/_arclight_index_group_document_compact_default.html.erb +19 -0
  73. data/app/views/catalog/_arclight_index_group_document_default.html.erb +18 -0
  74. data/app/views/catalog/_arclight_online_content_indicator.html.erb +1 -3
  75. data/app/views/catalog/_collection_contents.html.erb +2 -10
  76. data/app/views/catalog/_collection_context.html.erb +15 -0
  77. data/app/views/catalog/_collection_context_nav.html.erb +12 -0
  78. data/app/views/catalog/_collection_online_contents.html.erb +3 -3
  79. data/app/views/catalog/_component_context.html.erb +5 -0
  80. data/app/views/catalog/_containers.html.erb +3 -0
  81. data/app/views/catalog/_context_sidebar.html.erb +2 -2
  82. data/app/views/catalog/_document_downloads.html.erb +14 -0
  83. data/app/views/catalog/_group.html.erb +21 -0
  84. data/app/views/catalog/_group_header_compact_default.html.erb +15 -0
  85. data/app/views/catalog/_group_header_default.html.erb +20 -0
  86. data/app/views/catalog/_group_toggle.html.erb +10 -0
  87. data/app/views/catalog/_home.html.erb +1 -1
  88. data/app/views/catalog/_index_breadcrumb_default.html.erb +5 -2
  89. data/app/views/catalog/_index_collection_context_default.html.erb +53 -0
  90. data/app/views/catalog/_index_header.html.erb +3 -3
  91. data/app/views/catalog/_index_online_contents_default.html.erb +1 -1
  92. data/app/views/catalog/_online_content_label.html.erb +5 -0
  93. data/app/views/catalog/_search_form.html.erb +34 -0
  94. data/app/views/catalog/_search_results.html.erb +1 -4
  95. data/app/views/catalog/_show_actions_box_default.html.erb +27 -0
  96. data/app/views/catalog/_show_breadcrumbs_default.html.erb +5 -20
  97. data/app/views/catalog/_show_collection.html.erb +42 -24
  98. data/app/views/catalog/_show_default.html.erb +63 -35
  99. data/app/views/catalog/_show_upper_metadata_default.html.erb +1 -1
  100. data/app/views/catalog/_sort_and_per_page.html.erb +8 -0
  101. data/app/views/catalog/_within_collection_dropdown.html.erb +26 -0
  102. data/app/views/shared/_breadcrumbs.html.erb +4 -4
  103. data/app/views/shared/_context_sidebar.html.erb +2 -2
  104. data/app/views/shared/_header_navbar.html.erb +13 -17
  105. data/app/views/shared/_show_breadcrumbs.html.erb +27 -0
  106. data/arclight.gemspec +5 -6
  107. data/config/i18n-tasks.yml +2 -1
  108. data/config/locales/arclight.en.yml +54 -21
  109. data/config/repositories.yml +0 -0
  110. data/lib/arclight/engine.rb +22 -12
  111. data/lib/arclight/hash_absolute_xpath.rb +11 -7
  112. data/lib/arclight/level_label.rb +46 -0
  113. data/lib/arclight/normalized_date.rb +2 -2
  114. data/lib/arclight/normalized_id.rb +1 -0
  115. data/lib/arclight/normalized_title.rb +1 -0
  116. data/lib/arclight/repository.rb +58 -5
  117. data/lib/arclight/traject/ead2_config.rb +178 -159
  118. data/lib/arclight/traject/nokogiri_namespaceless_reader.rb +22 -0
  119. data/lib/arclight/version.rb +1 -1
  120. data/lib/arclight/viewers/oembed.rb +1 -0
  121. data/lib/arclight/year_range.rb +9 -1
  122. data/lib/generators/arclight/install_generator.rb +5 -1
  123. data/lib/generators/arclight/templates/catalog_controller.rb +128 -100
  124. data/lib/generators/arclight/templates/config/downloads.yml +12 -0
  125. data/lib/generators/arclight/templates/config/repositories.yml +20 -2
  126. data/lib/generators/arclight/update_generator.rb +1 -1
  127. data/lib/tasks/index.rake +18 -20
  128. data/package.json +8 -1
  129. data/solr/conf/schema.xml +51 -292
  130. data/solr/conf/solrconfig.xml +40 -125
  131. data/tasks/arclight.rake +1 -0
  132. data/vendor/assets/javascripts/responsiveTruncator.js +2 -2
  133. metadata +71 -44
  134. data/app/assets/javascripts/arclight/collection_context.js +0 -18
  135. data/app/assets/javascripts/arclight/component_ancestors.js +0 -56
  136. data/app/assets/javascripts/arclight/search_results.js +0 -15
  137. data/app/assets/stylesheets/arclight/modules/sidebar.scss +0 -21
  138. data/app/views/catalog/_collection_count.html.erb +0 -7
  139. data/app/views/catalog/_collection_downloads.html.erb +0 -15
  140. data/app/views/catalog/_collection_overview.html.erb +0 -7
  141. data/app/views/catalog/_component_contents.html.erb +0 -16
  142. data/app/views/catalog/_component_overview.html.erb +0 -40
  143. data/app/views/catalog/_index_header_hierarchy_default.html.erb +0 -42
  144. data/app/views/catalog/_index_hierarchy_default.html.erb +0 -28
  145. data/app/views/catalog/_results_histogram.html.erb +0 -15
  146. data/app/views/catalog/_show_component_sidebar.html.erb +0 -12
  147. data/app/views/catalog/_show_sidebar.html.erb +0 -22
  148. data/lib/arclight/custom_component.rb +0 -99
  149. data/lib/arclight/custom_document.rb +0 -93
  150. data/lib/arclight/indexer.rb +0 -9
  151. data/lib/arclight/shared_indexing_behavior.rb +0 -97
  152. data/lib/arclight/shared_terminology_behavior.rb +0 -65
  153. data/lib/arclight/solr_ead_indexer_ext.rb +0 -155
data/.babelrc ADDED
@@ -0,0 +1,3 @@
1
+ {
2
+ "presets": ["@babel/preset-env"]
3
+ }
data/.codeclimate.yml ADDED
@@ -0,0 +1,5 @@
1
+ version: "2"
2
+ exclude_patterns:
3
+ - "app/assets/javascripts/arclight/context_navigation.js"
4
+ - "vendor/assets/javascripts/**/*.js"
5
+ - "spec/**/*.rb"
data/.eslintrc CHANGED
@@ -1,4 +1,7 @@
1
1
  {
2
+ "env": {
3
+ "es6": true
4
+ },
2
5
  "extends": "airbnb-base/legacy",
3
6
  "globals": {
4
7
  "jQuery": true,
data/.rubocop.yml CHANGED
@@ -10,16 +10,35 @@ AllCops:
10
10
  - 'db/**/*'
11
11
  - 'lib/generators/arclight/templates/**/*'
12
12
  - 'vendor/**/*'
13
+ - 'node_modules/**/*'
13
14
  TargetRubyVersion: 2.4
14
15
  DisplayCopNames: true
15
16
 
17
+ Metrics/ModuleLength:
18
+ Exclude:
19
+ - 'app/helpers/arclight_helper.rb'
20
+ - 'app/models/concerns/arclight/solr_document.rb'
21
+
16
22
  Metrics/BlockLength:
17
23
  Exclude:
24
+ - 'arclight.gemspec'
25
+ - 'lib/arclight/traject/ead2_config.rb'
26
+ - 'lib/tasks/**/*'
18
27
  - 'spec/features/traject/ead2_indexing_spec.rb'
28
+ - 'spec/helpers/arclight_helper_spec.rb'
29
+ - 'spec/features/collection_page_spec.rb'
30
+ - 'spec/**/*'
31
+ - 'tasks/**/*'
19
32
 
33
+ Metrics/LineLength:
34
+ Max: 160
20
35
 
21
36
  Rails:
22
37
  Enabled: true
23
38
 
24
39
  Bundler/DuplicatedGem:
25
40
  Enabled: false
41
+
42
+ Style/FormatStringToken:
43
+ Exclude:
44
+ - 'spec/test_app_templates/lib/generators/test_app_generator.rb'
data/.rubocop_todo.yml CHANGED
@@ -1,106 +1,35 @@
1
1
  # This configuration was generated by
2
2
  # `rubocop --auto-gen-config`
3
- # on 2019-08-21 15:42:57 -0600 using RuboCop version 0.74.0.
3
+ # on 2019-09-05 15:26:25 -0600 using RuboCop version 0.74.0.
4
4
  # The point is for the user to remove these configuration records
5
5
  # one by one as the offenses are removed from the code base.
6
6
  # Note that changes in the inspected code, or installation of new
7
7
  # versions of RuboCop, may require this file to be generated again.
8
8
 
9
- # Offense count: 1
10
- # Cop supports --auto-correct.
11
- # Configuration parameters: EnabledMethods.
12
- Capybara/FeatureMethods:
13
- Exclude:
14
- - 'spec/features/compact_search_results_spec.rb'
15
-
16
- # Offense count: 1
17
- # Cop supports --auto-correct.
18
- # Configuration parameters: TreatCommentsAsGroupSeparators, Include.
19
- # Include: **/*.gemspec
20
- Gemspec/OrderedDependencies:
21
- Exclude:
22
- - 'arclight.gemspec'
23
-
24
9
  # Offense count: 3
25
- # Cop supports --auto-correct.
26
- # Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
27
- # SupportedHashRocketStyles: key, separator, table
28
- # SupportedColonStyles: key, separator, table
29
- # SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
30
- Layout/AlignHash:
31
- Exclude:
32
- - 'lib/arclight/solr_ead_indexer_ext.rb'
33
-
34
- # Offense count: 29
35
- # Cop supports --auto-correct.
36
- Layout/EmptyLineAfterGuardClause:
37
- Exclude:
38
- - 'app/factories/blacklight_field_configuration_factory.rb'
39
- - 'app/helpers/arclight_helper.rb'
40
- - 'app/models/arclight/parent.rb'
41
- - 'app/models/concerns/arclight/catalog.rb'
42
- - 'app/models/concerns/arclight/solr_document.rb'
43
- - 'lib/arclight/normalized_date.rb'
44
- - 'lib/arclight/normalized_id.rb'
45
- - 'lib/arclight/normalized_title.rb'
46
- - 'lib/arclight/repository.rb'
47
- - 'lib/arclight/shared_indexing_behavior.rb'
48
- - 'lib/arclight/viewers/oembed.rb'
49
- - 'lib/arclight/year_range.rb'
50
- - 'lib/tasks/index.rake'
51
- - 'tasks/arclight.rake'
52
-
53
- # Offense count: 1
54
- # Cop supports --auto-correct.
55
- # Configuration parameters: AllowInHeredoc.
56
- Layout/TrailingWhitespace:
57
- Exclude:
58
- - 'lib/tasks/index.rake'
59
-
60
- # Offense count: 1
61
10
  Lint/AmbiguousBlockAssociation:
62
11
  Exclude:
63
12
  - 'lib/arclight/traject/ead2_config.rb'
64
13
 
65
- # Offense count: 1
66
- # Configuration parameters: IgnoreImplicitReferences.
67
- Lint/ShadowedArgument:
68
- Exclude:
69
- - 'lib/arclight/solr_ead_indexer_ext.rb'
70
-
71
- # Offense count: 1
72
- # Cop supports --auto-correct.
73
- Lint/UnneededCopDisableDirective:
74
- Exclude:
75
- - 'lib/arclight/shared_indexing_behavior.rb'
76
-
77
14
  # Offense count: 1
78
15
  # Configuration parameters: CheckForMethodsWithNoSideEffects.
79
16
  Lint/Void:
80
17
  Exclude:
81
18
  - 'lib/arclight/year_range.rb'
82
19
 
83
- # Offense count: 1
84
- Metrics/AbcSize:
85
- Max: 16
86
-
87
- # Offense count: 70
20
+ # Offense count: 68
88
21
  # Configuration parameters: CountComments, ExcludedMethods.
89
- # ExcludedMethods: refine
90
22
  Metrics/BlockLength:
91
23
  Max: 278
92
24
  Exclude:
93
- - 'spec/features/traject/ead2_indexing_spec.rb'
94
-
25
+ - 'spec/features/collection_page_spec.rb'
26
+
95
27
  # Offense count: 1
96
28
  # Configuration parameters: CountComments, ExcludedMethods.
97
29
  Metrics/MethodLength:
98
30
  Max: 11
99
-
100
- # Offense count: 2
101
- # Configuration parameters: CountComments.
102
- Metrics/ModuleLength:
103
- Max: 113
31
+ Exclude:
32
+ - 'app/helpers/arclight_helper.rb'
104
33
 
105
34
  # Offense count: 1
106
35
  # Configuration parameters: Blacklist.
@@ -109,14 +38,7 @@ Naming/HeredocDelimiterNaming:
109
38
  Exclude:
110
39
  - 'spec/features/autocomplete_spec.rb'
111
40
 
112
- # Offense count: 4
113
- # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
114
- # AllowedNames: io, id, to, by, on, in, at, ip, db
115
- Naming/UncommunicativeMethodParamName:
116
- Exclude:
117
- - 'lib/arclight/shared_terminology_behavior.rb'
118
-
119
- # Offense count: 97
41
+ # Offense count: 91
120
42
  # Configuration parameters: Prefixes.
121
43
  # Prefixes: when, with, without
122
44
  RSpec/ContextWording:
@@ -130,12 +52,12 @@ RSpec/DescribedClass:
130
52
  Exclude:
131
53
  - 'spec/presenters/arclight/show_presenter_spec.rb'
132
54
 
133
- # Offense count: 58
55
+ # Offense count: 61
134
56
  # Cop supports --auto-correct.
135
57
  RSpec/EmptyLineAfterExampleGroup:
136
58
  Enabled: false
137
59
 
138
- # Offense count: 8
60
+ # Offense count: 12
139
61
  # Cop supports --auto-correct.
140
62
  RSpec/EmptyLineAfterHook:
141
63
  Exclude:
@@ -152,11 +74,10 @@ RSpec/EmptyLineAfterHook:
152
74
  RSpec/ExampleLength:
153
75
  Enabled: false
154
76
 
155
- # Offense count: 3
77
+ # Offense count: 2
156
78
  RSpec/ExpectInHook:
157
79
  Exclude:
158
80
  - 'spec/helpers/arclight_helper_spec.rb'
159
- - 'spec/lib/arclight/indexer_spec.rb'
160
81
  - 'spec/presenters/arclight/index_presenter_spec.rb'
161
82
 
162
83
  # Offense count: 1
@@ -165,16 +86,16 @@ RSpec/FilePath:
165
86
  Exclude:
166
87
  - 'spec/lib/arclight/viewers/oembed_spec.rb'
167
88
 
168
- # Offense count: 108
89
+ # Offense count: 107
169
90
  # Configuration parameters: AggregateFailuresByDefault.
170
91
  RSpec/MultipleExpectations:
171
- Max: 28
92
+ Max: 26
172
93
 
173
- # Offense count: 22
94
+ # Offense count: 8
174
95
  RSpec/NestedGroups:
175
96
  Max: 4
176
97
 
177
- # Offense count: 5
98
+ # Offense count: 7
178
99
  # Cop supports --auto-correct.
179
100
  # Configuration parameters: Strict, EnforcedStyle.
180
101
  # SupportedStyles: inflected, explicit
@@ -183,11 +104,6 @@ RSpec/PredicateMatcher:
183
104
  - 'spec/helpers/arclight_helper_spec.rb'
184
105
  - 'spec/lib/arclight/year_range_spec.rb'
185
106
 
186
- # Offense count: 1
187
- RSpec/SubjectStub:
188
- Exclude:
189
- - 'spec/lib/arclight/indexer_spec.rb'
190
-
191
107
  # Offense count: 1
192
108
  Security/Open:
193
109
  Exclude:
@@ -204,10 +120,9 @@ Style/BlockDelimiters:
204
120
  Exclude:
205
121
  - 'lib/tasks/index.rake'
206
122
 
207
- # Offense count: 2
123
+ # Offense count: 1
208
124
  Style/CommentedKeyword:
209
125
  Exclude:
210
- - 'lib/arclight/shared_terminology_behavior.rb'
211
126
  - 'lib/arclight/year_range.rb'
212
127
 
213
128
  # Offense count: 1
@@ -217,43 +132,8 @@ Style/Documentation:
217
132
  - 'test/**/*'
218
133
  - 'lib/arclight.rb'
219
134
 
220
- # Offense count: 1
221
- # Cop supports --auto-correct.
222
- Style/Encoding:
223
- Exclude:
224
- - 'arclight.gemspec'
225
-
226
- # Offense count: 3
227
- # Cop supports --auto-correct.
228
- Style/ExpandPathArguments:
229
- Exclude:
230
- - 'arclight.gemspec'
231
- - 'lib/generators/arclight/install_generator.rb'
232
- - 'lib/generators/arclight/update_generator.rb'
233
-
234
135
  # Offense count: 1
235
136
  # Cop supports --auto-correct.
236
137
  Style/IfUnlessModifier:
237
138
  Exclude:
238
139
  - 'app/models/concerns/arclight/search_behavior.rb'
239
-
240
- # Offense count: 1
241
- # Cop supports --auto-correct.
242
- Style/MinMax:
243
- Exclude:
244
- - 'lib/arclight/year_range.rb'
245
-
246
- # Offense count: 1
247
- # Cop supports --auto-correct.
248
- # Configuration parameters: EnforcedStyle.
249
- # SupportedStyles: implicit, explicit
250
- Style/RescueStandardError:
251
- Exclude:
252
- - 'lib/arclight/shared_indexing_behavior.rb'
253
-
254
- # Offense count: 457
255
- # Cop supports --auto-correct.
256
- # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
257
- # URISchemes: http, https
258
- Metrics/LineLength:
259
- Max: 153
data/.travis.yml CHANGED
@@ -6,7 +6,7 @@ rvm:
6
6
  - 2.5.5
7
7
  - 2.6.3
8
8
  jdk:
9
- - oraclejdk9
9
+ - openjdk11
10
10
 
11
11
  before_script:
12
12
  - find spec/fixtures/ead -name '*.xml' | xargs xmllint --noout --schema spec/fixtures/xsd/ead.xsd
@@ -22,7 +22,7 @@ addons:
22
22
 
23
23
  env:
24
24
  global:
25
- - CC_TEST_REPORTER_ID=65288e8c489d9d571730d098a9e7ec951e286f7d8ca3d728f4bb812dd7eeb46d
25
+ - CC_TEST_REPORTER_ID=0bbc7b5fd7f6bab0c0517183ae34a4d2f6010ca1ef2d1c7c3ccdec55ea823115
26
26
 
27
27
  after_script:
28
28
  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
data/CONTRIBUTORS.md ADDED
@@ -0,0 +1,79 @@
1
+ ## Contributors ✨
2
+
3
+ ArcLight is a cross-institutional project led by Stanford University, with contributions from Duke University, Georgia Tech, Indiana University, LYRASIS, the National Library of Medicine, University of Michigan, Princeton University, and Rockefeller Archive Center.
4
+
5
+ Individual project contributors include ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
6
+
7
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
8
+ <!-- prettier-ignore-start -->
9
+ <!-- markdownlint-disable -->
10
+ <table>
11
+ <tr>
12
+ <td align="center"><a href="https://github.com/seanaery"><img src="https://avatars3.githubusercontent.com/u/3933756?v=4" width="125px;" alt="Sean Aery"/><br /><sub><b>Sean Aery</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=seanaery" title="Code">đŸ’ģ</a></td>
13
+ <td align="center"><a href="http://hillelarnold.com"><img src="https://avatars0.githubusercontent.com/u/607621?v=4" width="125px;" alt="Hillel Arnold"/><br /><sub><b>Hillel Arnold</b></sub></a><br /><a href="#analysis-helrond" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#userTesting-helrond" title="User Testing">📓</a></td>
14
+ <td align="center"><a href="http://cbeer.info"><img src="https://avatars1.githubusercontent.com/u/111218?v=4" width="125px;" alt="Chris Beer"/><br /><sub><b>Chris Beer</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=cbeer" title="Code">đŸ’ģ</a> <a href="https://github.com/projectblacklight/arclight/commits?author=cbeer" title="Documentation">📖</a></td>
15
+ <td align="center"><a href="http://leaannbradford.com"><img src="https://avatars3.githubusercontent.com/u/18175797?v=4" width="125px;" alt="Lea Ann Bradford"/><br /><sub><b>Lea Ann Bradford</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=labradford" title="Code">đŸ’ģ</a></td>
16
+ <td align="center"><a href="http://actspatial.com"><img src="https://avatars0.githubusercontent.com/u/9905193?v=4" width="125px;" alt="Christina Chortaria"/><br /><sub><b>Christina Chortaria</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=christinach" title="Code">đŸ’ģ</a></td>
17
+ </tr>
18
+ <tr>
19
+ <td align="center"><a href="https://github.com/mark-cooper"><img src="https://avatars1.githubusercontent.com/u/551470?v=4" width="125px;" alt="Mark Cooper"/><br /><sub><b>Mark Cooper</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=mark-cooper" title="Code">đŸ’ģ</a> <a href="#plugin-mark-cooper" title="Plugin/utility libraries">🔌</a></td>
20
+ <td align="center"><a href="http://knittles.ticklefish.org/"><img src="https://avatars3.githubusercontent.com/u/856924?v=4" width="125px;" alt="EsmÊ Cowles"/><br /><sub><b>EsmÊ Cowles</b></sub></a><br /><a href="#business-escowles" title="Business development">đŸ’ŧ</a> <a href="#analysis-escowles" title="Functional requirements and related research">đŸ”Ŧ</a></td>
21
+ <td align="center"><a href="https://github.com/tomcramer"><img src="https://avatars3.githubusercontent.com/u/1054837?v=4" width="125px;" alt="Tom Cramer"/><br /><sub><b>Tom Cramer</b></sub></a><br /><a href="#business-tomcramer" title="Business development">đŸ’ŧ</a></td>
22
+ <td align="center"><a href="https://github.com/mdalmau"><img src="https://avatars0.githubusercontent.com/u/573273?v=4" width="125px;" alt="Michelle Dalmau"/><br /><sub><b>Michelle Dalmau</b></sub></a><br /><a href="#business-mdalmau" title="Business development">đŸ’ŧ</a></td>
23
+ <td align="center"><a href="http://robotlibrarian.billdueber.com/"><img src="https://avatars0.githubusercontent.com/u/114006?v=4" width="125px;" alt="Bill Dueber"/><br /><sub><b>Bill Dueber</b></sub></a><br /><a href="#analysis-billdueber" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="https://github.com/projectblacklight/arclight/commits?author=billdueber" title="Code">đŸ’ģ</a></td>
24
+ </tr>
25
+ <tr>
26
+ <td align="center"><a href="https://github.com/jwd"><img src="https://avatars1.githubusercontent.com/u/842343?v=4" width="125px;" alt="Jon Dunn"/><br /><sub><b>Jon Dunn</b></sub></a><br /><a href="#business-jwd" title="Business development">đŸ’ŧ</a></td>
27
+ <td align="center"><a href="https://github.com/eckardm"><img src="https://avatars1.githubusercontent.com/u/7072443?v=4" width="125px;" alt="Max Eckard"/><br /><sub><b>Max Eckard</b></sub></a><br /><a href="#analysis-eckardm" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#productOwner-eckardm" title="Product owner">đŸ—ē</a> <a href="#userTesting-eckardm" title="User Testing">📓</a></td>
28
+ <td align="center"><a href="https://github.com/jrgriffiniii"><img src="https://avatars0.githubusercontent.com/u/1443986?v=4" width="125px;" alt="James R. Griffin III"/><br /><sub><b>James R. Griffin III</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=jrgriffiniii" title="Code">đŸ’ģ</a></td>
29
+ <td align="center"><a href="https://github.com/p-galligan"><img src="https://avatars2.githubusercontent.com/u/2585069?v=4" width="125px;" alt="Patrick Galligan"/><br /><sub><b>Patrick Galligan</b></sub></a><br /><a href="#userTesting-p-galligan" title="User Testing">📓</a></td>
30
+ <td align="center"><a href="http://ggeisler.com"><img src="https://avatars1.githubusercontent.com/u/101482?v=4" width="125px;" alt="Gary Geisler"/><br /><sub><b>Gary Geisler</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=ggeisler" title="Code">đŸ’ģ</a> <a href="#design-ggeisler" title="Design">🎨</a></td>
31
+ </tr>
32
+ <tr>
33
+ <td align="center"><a href="https://github.com/bonniegee"><img src="https://avatars3.githubusercontent.com/u/8737364?v=4" width="125px;" alt="Bonnie Gordon"/><br /><sub><b>Bonnie Gordon</b></sub></a><br /><a href="#userTesting-bonniegee" title="User Testing">📓</a></td>
34
+ <td align="center"><a href="https://github.com/mswendyh"><img src="https://avatars1.githubusercontent.com/u/7033667?v=4" width="125px;" alt="Wendy Hagenmaier"/><br /><sub><b>Wendy Hagenmaier</b></sub></a><br /><a href="#analysis-mswendyh" title="Functional requirements and related research">đŸ”Ŧ</a></td>
35
+ <td align="center"><img src="http://gravatar.com/avatar/8b53dcb509d4b1fe8dd74da6a94395ef.jpg?d=retro" width="125px;" alt="Jim Halliday"/><br /><sub><b>Jim Halliday</b></sub><br /><a href="#business" title="Business development">đŸ’ŧ</a></td>
36
+ <td align="center"><a href="https://github.com/jlhardes"><img src="https://avatars1.githubusercontent.com/u/3440166?v=4" width="125px;" alt="Julie Hardesty"/><br /><sub><b>Julie Hardesty</b></sub></a><br /><a href="#analysis-jlhardes" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#productOwner-jlhardes" title="Product owner">đŸ—ē</a></td>
37
+ <td align="center"><a href="http://stanford.edu/~drh"><img src="https://avatars3.githubusercontent.com/u/1861171?v=4" width="125px;" alt="Darren Hardy"/><br /><sub><b>Darren Hardy</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=drh-stanford" title="Code">đŸ’ģ</a> <a href="https://github.com/projectblacklight/arclight/commits?author=drh-stanford" title="Documentation">📖</a></td>
38
+ </tr>
39
+ <tr>
40
+ <td align="center"><a href="https://github.com/drhardy"><img src="https://avatars3.githubusercontent.com/u/25580222?v=4" width="125px;" alt="Darren Hardy"/><br /><sub><b>Darren Hardy</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=drhardy" title="Code">đŸ’ģ</a></td>
41
+ <td align="center"><a href="https://github.com/regineheberlein"><img src="https://avatars1.githubusercontent.com/u/5940563?v=4" width="125px;" alt="Regine Heberlein"/><br /><sub><b>Regine Heberlein</b></sub></a><br /><a href="#analysis-regineheberlein" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#productOwner-regineheberlein" title="Product owner">đŸ—ē</a></td>
42
+ <td align="center"><a href="https://github.com/noahgh221"><img src="https://avatars3.githubusercontent.com/u/7328518?v=4" width="125px;" alt="Noah Huffman"/><br /><sub><b>Noah Huffman</b></sub></a><br /><a href="#analysis-noahgh221" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#productOwner-noahgh221" title="Product owner">đŸ—ē</a></td>
43
+ <td align="center"><a href="https://github.com/njaffer"><img src="https://avatars0.githubusercontent.com/u/12487929?v=4" width="125px;" alt="Nabeela Jaffer"/><br /><sub><b>Nabeela Jaffer</b></sub></a><br /><a href="#analysis-njaffer" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#business-njaffer" title="Business development">đŸ’ŧ</a></td>
44
+ <td align="center"><a href="https://github.com/jkeck"><img src="https://avatars0.githubusercontent.com/u/96776?v=4" width="125px;" alt="Jessie Keck"/><br /><sub><b>Jessie Keck</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=jkeck" title="Code">đŸ’ģ</a> <a href="https://github.com/projectblacklight/arclight/commits?author=jkeck" title="Documentation">📖</a></td>
45
+ </tr>
46
+ <tr>
47
+ <td align="center"><a href="https://github.com/gordonleacock"><img src="https://avatars3.githubusercontent.com/u/12927191?v=4" width="125px;" alt="Gordon Leacock"/><br /><sub><b>Gordon Leacock</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=gordonleacock" title="Code">đŸ’ģ</a> <a href="https://github.com/projectblacklight/arclight/commits?author=gordonleacock" title="Documentation">📖</a></td>
48
+ <td align="center"><a href="https://matienzo.org/"><img src="https://avatars0.githubusercontent.com/u/73732?v=4" width="125px;" alt="Mark A. Matienzo"/><br /><sub><b>Mark A. Matienzo</b></sub></a><br /><a href="#projectManagement-anarchivist" title="Project Management">📆</a> <a href="#business-anarchivist" title="Business development">đŸ’ŧ</a> <a href="#analysis-anarchivist" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#productOwner-anarchivist" title="Product owner">đŸ—ē</a></td>
49
+ <td align="center"><a href="https://github.com/archivistsarah"><img src="https://avatars0.githubusercontent.com/u/25084902?v=4" width="125px;" alt="Sarah Newhouse"/><br /><sub><b>Sarah Newhouse</b></sub></a><br /><a href="#analysis-archivistsarah" title="Functional requirements and related research">đŸ”Ŧ</a></td>
50
+ <td align="center"><a href="https://github.com/grepcats"><img src="https://avatars0.githubusercontent.com/u/7513448?v=4" width="125px;" alt="Kayla Ondracek"/><br /><sub><b>Kayla Ondracek</b></sub></a><br /><a href="#analysis-grepcats" title="Functional requirements and related research">đŸ”Ŧ</a></td>
51
+ <td align="center"><a href="https://github.com/djpillen"><img src="https://avatars3.githubusercontent.com/u/11635158?v=4" width="125px;" alt="Dallas Pillen"/><br /><sub><b>Dallas Pillen</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=djpillen" title="Code">đŸ’ģ</a> <a href="#userTesting-djpillen" title="User Testing">📓</a></td>
52
+ </tr>
53
+ <tr>
54
+ <td align="center"><a href="https://github.com/cmkpowell"><img src="https://avatars1.githubusercontent.com/u/16540397?v=4" width="125px;" alt="Chris Powell"/><br /><sub><b>Chris Powell</b></sub></a><br /><a href="#analysis-cmkpowell" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#productOwner-cmkpowell" title="Product owner">đŸ—ē</a></td>
55
+ <td align="center"><a href="https://www.jack-reed.com/"><img src="https://avatars0.githubusercontent.com/u/1656824?v=4" width="125px;" alt="Jack Reed"/><br /><sub><b>Jack Reed</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=mejackreed" title="Code">đŸ’ģ</a> <a href="https://github.com/projectblacklight/arclight/commits?author=mejackreed" title="Documentation">📖</a></td>
56
+ <td align="center"><a href="https://github.com/John-Rees"><img src="https://avatars1.githubusercontent.com/u/29233549?v=4" width="125px;" alt="John Rees"/><br /><sub><b>John Rees</b></sub></a><br /><a href="#analysis-John-Rees" title="Functional requirements and related research">đŸ”Ŧ</a></td>
57
+ <td align="center"><a href="https://github.com/joshschneider"><img src="https://avatars3.githubusercontent.com/u/12468197?v=4" width="125px;" alt="Josh Schneider"/><br /><sub><b>Josh Schneider</b></sub></a><br /><a href="#analysis-joshschneider" title="Functional requirements and related research">đŸ”Ŧ</a> <a href="#productOwner-joshschneider" title="Product owner">đŸ—ē</a></td>
58
+ <td align="center"><a href="https://github.com/willsexton"><img src="https://avatars2.githubusercontent.com/u/1359320?v=4" width="125px;" alt="Will Sexton"/><br /><sub><b>Will Sexton</b></sub></a><br /><a href="#business-willsexton" title="Business development">đŸ’ŧ</a></td>
59
+ </tr>
60
+ <tr>
61
+ <td align="center"><a href="https://github.com/shallcro"><img src="https://avatars2.githubusercontent.com/u/43279347?v=4" width="125px;" alt="Mike Shallcross"/><br /><sub><b>Mike Shallcross</b></sub></a><br /><a href="#analysis-shallcro" title="Functional requirements and related research">đŸ”Ŧ</a></td>
62
+ <td align="center"><a href="https://github.com/remocrevo"><img src="https://avatars1.githubusercontent.com/u/8701105?v=4" width="125px;" alt="Remington Steed"/><br /><sub><b>Remington Steed</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=remocrevo" title="Code">đŸ’ģ</a></td>
63
+ <td align="center"><a href="https://github.com/tampakis"><img src="https://avatars2.githubusercontent.com/u/4650153?v=4" width="125px;" alt="Nikitas Tampakis"/><br /><sub><b>Nikitas Tampakis</b></sub></a><br /><a href="#analysis-tampakis" title="Functional requirements and related research">đŸ”Ŧ</a></td>
64
+ <td align="center"><a href="https://github.com/estelendur"><img src="https://avatars0.githubusercontent.com/u/10409866?v=4" width="125px;" alt="Esty Thomas"/><br /><sub><b>Esty Thomas</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=estelendur" title="Code">đŸ’ģ</a></td>
65
+ <td align="center"><a href="http://camillevilla.github.io"><img src="https://avatars2.githubusercontent.com/u/5402927?v=4" width="125px;" alt="Camille Villa"/><br /><sub><b>Camille Villa</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=camillevilla" title="Code">đŸ’ģ</a> <a href="https://github.com/projectblacklight/arclight/commits?author=camillevilla" title="Documentation">📖</a></td>
66
+ </tr>
67
+ <tr>
68
+ <td align="center"><a href="https://github.com/jvine"><img src="https://avatars0.githubusercontent.com/u/6945691?v=4" width="125px;" alt="Jennifer Vine"/><br /><sub><b>Jennifer Vine</b></sub></a><br /><a href="#design-jvine" title="Design">🎨</a></td>
69
+ <td align="center"><a href="https://github.com/jweise"><img src="https://avatars2.githubusercontent.com/u/114413?v=4" width="125px;" alt="John Weise"/><br /><sub><b>John Weise</b></sub></a><br /><a href="#business-jweise" title="Business development">đŸ’ŧ</a></td>
70
+ <td align="center"><a href="https://github.com/gwiedeman"><img src="https://avatars0.githubusercontent.com/u/10030353?v=4" width="125px;" alt="Gregory Wiedeman"/><br /><sub><b>Gregory Wiedeman</b></sub></a><br /><a href="https://github.com/projectblacklight/arclight/commits?author=gwiedeman" title="Code">đŸ’ģ</a> <a href="https://github.com/projectblacklight/arclight/issues?q=author%3Agwiedeman" title="Bug reports">🐛</a> <a href="#userTesting-gwiedeman" title="User Testing">📓</a> <a href="#inProduction-gwiedeman" title="Has a production implementation">🏆</a></td>
71
+ <td align="center"><a href="https://github.com/lauraw15"><img src="https://avatars2.githubusercontent.com/u/6343788?v=4" width="125px;" alt="Laura Wilsey"/><br /><sub><b>Laura Wilsey</b></sub></a><br /><a href="#analysis-lauraw15" title="Functional requirements and related research">đŸ”Ŧ</a></td>
72
+ </tr>
73
+ </table>
74
+
75
+ <!-- markdownlint-enable -->
76
+ <!-- prettier-ignore-end -->
77
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
78
+
79
+ This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
data/README.md CHANGED
@@ -1,15 +1,16 @@
1
1
  [![Build Status](https://travis-ci.org/projectblacklight/arclight.svg?branch=master)](https://travis-ci.org/projectblacklight/arclight)
2
- [![Code Climate Test Coverage](https://codeclimate.com/github/sul-dlss/arclight/badges/coverage.svg)](https://codeclimate.com/github/sul-dlss/arclight/coverage)
2
+ [![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](CONTRIBUTORS.md)
3
+ [![Code Climate Test Coverage](https://codeclimate.com/github/projectblacklight/arclight/badges/coverage.svg)](https://codeclimate.com/github/projectblacklight/arclight/coverage)
3
4
 
4
5
  # ArcLight
5
6
 
6
- A Rails engine supporting discovery of archival materials.
7
+ A Rails engine supporting discovery of archival materials, based on [Blacklight](https://projectblacklight.org/)
7
8
 
8
- During April - June 2017, ArcLight underwent its initial development as a Minimally Viable Product (MVP). The MVP is targeted for content that is described in the [Encoded Archival Description](http://eadiva.com/2/) (EAD) format. Future development is in the planning phase with no definitive timeline as yet.
9
+ > ℹī¸ From August-October 2019, Stanford University, University of Michigan, Indiana University, Princeton University, and Duke University are collaborating on a second phase of ArcLight! See the [project board](https://github.com/projectblacklight/arclight/projects/2) or our [demo videos](https://www.youtube.com/playlist?list=PLMdUaIJ0G8QiIXZ_SFHASJErD14CJW-p5) to follow our work.
9
10
 
10
11
  ## Requirements
11
12
 
12
- * [Ruby](https://www.ruby-lang.org/en/) 2.2 or later
13
+ * [Ruby](https://www.ruby-lang.org/en/) 2.5 or later
13
14
  * [Rails](http://rubyonrails.org) 5.0 or later
14
15
 
15
16
  ## Installation
@@ -51,41 +52,35 @@ See the [ArcLight demo](https://arclight-demo.projectblacklight.org/) and [ArcLi
51
52
  See [Arclight Major Features](https://github.com/sul-dlss/arclight/wiki/Arclight-Major-Features) for a list of features.
52
53
 
53
54
  ### Traject indexing of EAD content
54
- [Traject](https://github.com/traject/traject) is a proposed way forward for migrating indexing. An EAD2 can be indexed by doing the following:
55
+ [Traject](https://github.com/traject/traject) is a high performance way of transforming documents for indexing into Solr and how ArcLight does indexing. An EAD2 can be indexed by doing the following:
55
56
 
56
57
  ```sh
57
58
  bundle exec traject -u http://127.0.0.1:8983/solr/blacklight-core -i xml -c lib/arclight/traject/ead2_config.rb spec/fixtures/ead/sample/large-components-list.xml
58
59
  ```
59
60
 
60
- Or pass the `TRAJECT=true` env variable to current indexing tasks.
61
+ Or
61
62
 
62
63
  ```sh
63
- TRAJECT=true bundle exec rake arclight:seed
64
- end
64
+ bundle exec rake arclight:seed
65
+ ```
65
66
 
66
67
  ## Resources
67
68
 
68
69
  * General
69
- * [ArcLight team wiki](https://wiki.duraspace.org/display/hydra/ArcLight): includes design process documentation
70
- * Use the [ArcLight Google Group](http://groups.google.com/d/forum/arclight-community) to contact us with questions
71
- * MVP Implementation:
72
70
  * [ArcLight demo site](https://arclight-demo.projectblacklight.org/)
73
- * [YouTube channel](https://www.youtube.com/channel/UCbSaP93HdypsW6hXy7V1nFQ): MVP sprint demo videos
74
- * [ArcLight MVP Wiki](https://github.com/sul-dlss/arclight/wiki)
71
+ * [ArcLight project wiki](https://bit.ly/arclightproject): includes design process documentation
72
+ * [ArcLight Github Wiki](https://github.com/sul-dlss/arclight/wiki): developer/implementor documentation
75
73
  * [Blacklight wiki](https://github.com/projectblacklight/blacklight/wiki)
74
+ * Use the [ArcLight Google Group](http://groups.google.com/d/forum/arclight-community) to contact us with questions
75
+ * ArcLight Phase II:
76
+ * [Project overview](https://wiki.duraspace.org/display/samvera/ArcLight+Phase+II)
77
+ * ArcLight MVP:
78
+ * [MVP sprint demo videos](https://www.youtube.com/playlist?list=PLMdUaIJ0G8QgbuDCUVvFhTSTO96N37lRA)
79
+ * [Project overview](https://wiki.duraspace.org/display/samvera/ArcLight+MVP)
76
80
 
77
- ## ArcLight MVP Development team
81
+ ## Contributors
78
82
 
79
- * Stanford University
80
- * [Camille Villa](https://github.com/camillevilla)
81
- * [Darren Hardy](https://github.com/drh-stanford)
82
- * [Gary Geisler](https://github.com/ggeisler)
83
- * [Jack Reed](https://github.com/mejackreed)
84
- * [Jennifer Vine](https://github.com/jvine)
85
- * [Jessie Keck](https://github.com/jkeck)
86
- * [Mark Matienzo](https://github.com/anarchivist)
87
- * University of Michigan
88
- * [Gordon Leacock](https://github.com/gordonleacock)
83
+ See the [CONTRIBUTORS](CONTRIBUTORS.md) file.
89
84
 
90
85
  ## Development
91
86
 
@@ -125,3 +120,5 @@ To release a new version:
125
120
  ## License
126
121
 
127
122
  The gem is available as open source under the terms of the [Apache 2 License](https://opensource.org/licenses/Apache-2.0).
123
+
124
+ ArcLight also uses embedded SVG icons from the [FontAwesome](https://fontawesome.com) project. These icons are unmodified and licensed [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). All of these icons have the license and attribution embedded in them.